On this page you find all important commands for the CLI tool ansible-doc. If the
command you are looking for is missing please ask our AI.
ansible-doc
displays information on modules installed in Ansible libraries. It displays a terse listing of plugins and their short descriptions, provides a printout of their DOCUMENTATION strings, and it can create a short “snippet” which can be pasted into a playbook.
List of commands for ansible-doc:
-
ansible-doc:tldr:07d70 ansible-doc: Show information about a specific action plugin (module).$ ansible-doc ${plugin_name}try on your machineexplain this command
-
ansible-doc:tldr:272b0 ansible-doc: Show the playbook snippet for action plugin (modules).$ ansible-doc --snippet ${plugin_name}try on your machineexplain this command
-
ansible-doc:tldr:49564 ansible-doc: Show information about a plugin with a specific type.$ ansible-doc --type ${select} ${plugin_name}try on your machineexplain this command
-
ansible-doc:tldr:6ee80 ansible-doc: List available action plugins (modules).$ ansible-doc --listtry on your machineexplain this command
-
ansible-doc:tldr:ca8ff ansible-doc: Show information about an action plugin (module) as JSON.$ ansible-doc --json ${plugin_name}try on your machineexplain this command
-
ansible-doc:tldr:f77df ansible-doc: List available plugins of a specific type.$ ansible-doc --type ${select} --listtry on your machineexplain this command