ansible-doc

ansible-doc [-l] [-s] [-t type] [module]

ansible-doc displays documentation for Ansible modules, plugins, and collections. It shows module parameters, return values, examples, and notes, serving as a quick reference without needing to access online documentation.The tool can list all available modules and filter by plugin type, making it useful for discovering available automation options.

-l [filter], --list [filter]

List available plugins; optional filter can be a namespace or collection name

Show a playbook snippet (for inventory, lookup, and module plugin types)

Plugin type to look up (default: module). Choices include module, become, cache, callback, cliconf, connection, httpapi, inventory, lookup, netconf, shell, vars, strategy, test, filter, role, keyword

Show plugin names and their source files (implies --list)

Select the entry point for a role (with -t role)

Change output into JSON format

Prepend colon-separated path(s) to the module library

ansible.cfg

Main Ansible configuration file, searched in current directory, ~/.ansible.cfg, or /etc/ansible/ansible.cfg.

Environment variable to specify an alternate configuration file path.

Documentation quality varies between core and community modules. Some modules may have outdated documentation. Collection modules use fully qualified names.

ansible-doc has been part of Ansible since early versions, providing offline access to module documentation. Collections support was added with Ansible 2.9 in 2019.

ansible(1), ansible-galaxy(1), ansible-playbook(1)

Source code · Documentation