ansible-doc
Display documentation for Ansible modules and plugins
TLDR
SYNOPSIS
ansible-doc [-l] [-s] [-t type] [module]
DESCRIPTION
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.
PARAMETERS
-l [filter], --list [filter]
List available plugins; optional filter can be a namespace or collection name-s, --snippet
Show a playbook snippet (for inventory, lookup, and module plugin types)-t type, --type type
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-F, --list_files
Show plugin names and their source files (implies --list)-e entrypoint, **--entry-point** entrypoint
Select the entry point for a role (with -t role)-j, --json
Change output into JSON format-M path, --module-path path
Prepend colon-separated path(s) to the module library
CONFIGURATION
ansible.cfg
Main Ansible configuration file, searched in current directory, ~/.ansible.cfg, or /etc/ansible/ansible.cfg.ANSIBLE_CONFIG
Environment variable to specify an alternate configuration file path.
CAVEATS
Documentation quality varies between core and community modules. Some modules may have outdated documentation. Collection modules use fully qualified names.
HISTORY
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.
SEE ALSO
ansible(1), ansible-galaxy(1), ansible-playbook(1)
