Ansible - Getting Started with the ansible-doc command

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


Add a Comment

We will never share your name or email with anyone. Enter your email if you would like to be notified when we respond to your comment.

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


Web design by yours truely - me, myself, and I   |   |