Bootstrap FreeKB - Ansible - Getting Started with the ansible-doc command
Ansible - Getting Started with the ansible-doc command

Updated:   |  Ansible articles

The ansible-doc command is used to display information on various Ansible components, such as:

The ansible-doc command without any options or flags will display the basic usage of the ansible-doc command.


Usage: ansible-doc [-l|-s] [options] [-t <plugin type] [plugin]

plugin documentation tool

  -a, --all             **For internal testing only** Show documentation for
                        all plugins.
  -h, --help            show this help message and exit
  -l, --list            List available plugins
  -M MODULE_PATH, --module-path=MODULE_PATH
                        prepend colon-separated path(s) to module library
  -s, --snippet         Show playbook snippet for specified plugin(s)
  -t TYPE, --type=TYPE  Choose which plugin type (defaults to "module")
  -v, --verbose         verbose mode (-vvv for more, -vvvv to enable
                        connection debugging)
  --version             show program's version number and exit

See man pages for Ansible CLI options or website for tutorials


Did you find this article helpful?

If so, consider buying me a coffee over at Buy Me A Coffee


Add a Comment

Please enter 0a8811 in the box below so that we can be sure you are a human.