summaryrefslogtreecommitdiffstats
path: root/docs/templates/playbooks_keywords.rst.j2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-14 20:03:01 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-14 20:03:01 +0000
commita453ac31f3428614cceb99027f8efbdb9258a40b (patch)
treef61f87408f32a8511cbd91799f9cececb53e0374 /docs/templates/playbooks_keywords.rst.j2
parentInitial commit. (diff)
downloadansible-a453ac31f3428614cceb99027f8efbdb9258a40b.tar.xz
ansible-a453ac31f3428614cceb99027f8efbdb9258a40b.zip
Adding upstream version 2.10.7+merged+base+2.10.8+dfsg.upstream/2.10.7+merged+base+2.10.8+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/templates/playbooks_keywords.rst.j2')
-rw-r--r--docs/templates/playbooks_keywords.rst.j233
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/templates/playbooks_keywords.rst.j2 b/docs/templates/playbooks_keywords.rst.j2
new file mode 100644
index 00000000..4ce19aaa
--- /dev/null
+++ b/docs/templates/playbooks_keywords.rst.j2
@@ -0,0 +1,33 @@
+.. _playbook_keywords:
+
+Playbook Keywords
+=================
+
+These are the keywords available on common playbook objects. Keywords are one of several sources for configuring Ansible behavior. See :ref:`general_precedence_rules` for details on the relative precedence of each source.
+
+
+.. note:: Please note:
+
+ * Aliases for the directives are not reflected here, nor are mutable one. For example,
+ :term:`action` in task can be substituted by the name of any Ansible module.
+ * The keywords do not have ``version_added`` information at this time
+ * Some keywords set defaults for the objects inside of them rather than for the objects
+ themselves
+
+
+.. contents::
+ :local:
+ :depth: 1
+
+{% for name in playbook_class_names %}
+
+{{ name }}
+{{ '-' * name|length }}
+.. glossary::
+
+{% for attribute in pb_keywords[name]|sort %}
+ {{ attribute }}
+ {{ pb_keywords[name][attribute] |indent(8) }}
+
+{% endfor %}
+{% endfor %}