mirror of
https://github.com/ivuorinen/cheatsheet-tldr.git
synced 2026-01-26 03:24:04 +00:00
35 lines
948 B
Plaintext
35 lines
948 B
Plaintext
---
|
|
syntax: markdown
|
|
tags: [tldr, common]
|
|
source: https://github.com/tldr-pages/tldr.git
|
|
---
|
|
# 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`
|
|
|
|
- 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}}`
|
|
|
|
- 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}}`
|