ansible-doc

all

Display information on modules installed in Ansible libraries. Display a terse listing of plugins and their short descriptions.

Options (4)

-l, --listboolean

List available action plugins (modules)

Example: ansible-doc {{[-l|--list]}}

-t, --typeboolean

List available plugins of a specific type

Example: ansible-doc {{[-t|--type]}} {{become|cache|callback|cliconf|connection|...}} {{[-l|--list]}}

-s, --snippetboolean

Show the playbook snippet for action plugin (modules)

Example: ansible-doc {{[-s|--snippet]}} {{plugin_name}}

-j, --jsonboolean

Show information about an action plugin (module) as JSON

Example: ansible-doc {{[-j|--json]}} {{plugin_name}}

List available action plugins (modules)

ansible-doc [-l|--list]

List available plugins of a specific type

Show information about a specific action plugin (module)

ansible-doc plugin_name

Show information about a plugin with a specific type

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