Browse Source

ansible-doc: add page (#4843)

Natechawin Suthison 4 years ago
parent
commit
7fe92893a1
1 changed files with 29 additions and 0 deletions
  1. 29 0
      pages/common/ansible-doc.md

+ 29 - 0
pages/common/ansible-doc.md

@@ -0,0 +1,29 @@
+# ansible-doc
+
+> Display information on modules installed in Ansible libraries.
+> Display a terse listing of plugins and their short descriptions.
+> More information: <https://docs.ansible.com/ansible/latest/cli/ansible-doc.html>.
+
+- List available action plugins (modules):
+
+`ansible-doc --list`
+
+- List available plugins of a specific type:
+
+`ansible-doc --type {{plugin_type}} --list`
+
+- Show information about a specific action plugin (module):
+
+`ansible-doc {{plugin_name}}`
+
+- Show information about a plugin with a specific type:
+
+`ansible-doc --type {{plugin_type}} {{plugin_name}}`
+
+- Show the playbook snippet for action plugin (modules):
+
+`ansible-doc --snippet {{plugin_name}}`
+
+- Show information about an action plugin (module) as JSON:
+
+`ansible-doc --json {{plugin_name}}`