tldr/pages/common/ansible-doc.md

30 lines
855 B
Markdown
Raw Normal View History

2020-10-31 20:44:34 +00:00
# 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 {{become|cache|callback|cliconf|connection|...}} --list`
2020-10-31 20:44:34 +00:00
- Show information about a specific action plugin (module):
`ansible-doc {{plugin_name}}`
- Show information about a plugin with a specific type:
`ansible-doc --type {{become|cache|callback|cliconf|connection|...}} {{plugin_name}}`
2020-10-31 20:44:34 +00:00
- 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}}`