System Grab Bag

View all TLDR pages from common (or from all pages)

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}}

License and Disclaimer

The content on this page is copyright © 2014—present the tldr-pages team and contributors.
This page is used with permission under Creative Commons Attribution 4.0 International License.

While we do attempt to make sure content is accurate, there isn't a warranty of any kind.