ansible-doc

List available action plugins (modules)

$ ansible-doc [[-l|--list]]

$ ansible-doc [[-t|--type]] [become|cache|callback|cliconf|connection|...] [[-l|--list]]

$ ansible-doc [plugin_name]

$ ansible-doc [[-t|--type]] [become|cache|callback|cliconf|connection|...] [plugin_name]

$ ansible-doc [[-s|--snippet]] [plugin_name]

$ ansible-doc [[-j|--json]] [plugin_name]

ansible-doc [-l] [-s] [-t ] [module_or_plugin_name ...]
ansible-doc --version
ansible-doc --help

-l, --list
    Lists all available Ansible modules and plugins that can be documented.

-s, --snippet
    Displays a short usage snippet for the specified module or plugin, showing common parameters.

-t , --type
    Specifies the type of plugin to document. Common types include module (default), lookup, filter, connection, and inventory.

-v, --verbose
    Enables verbose output, which can provide more detailed information during execution.

--version
    Shows the program's version number and exits.

--help
    Displays a help message for the ansible-doc command and exits.

ansible-doc is a command-line utility used to display documentation for Ansible modules, plugins, and lookups. It provides detailed information including module parameters, examples, return values, and common usage patterns. This tool is invaluable for Ansible users and developers to quickly understand how to use various components without needing internet access or searching external documentation. It retrieves the documentation directly from the installed Ansible libraries, ensuring accuracy for your specific Ansible version. Users can either query specific module or plugin names or list all available modules to explore Ansible's vast capabilities. It significantly aids in playbook development and debugging by providing immediate access to critical module specifications.

ansible-doc relies on an installed Ansible environment, meaning it will not function without a proper Ansible installation. The documentation it provides is specific to the version of Ansible currently installed on your system; it may not reflect the latest or oldest versions available online. Furthermore, it focuses exclusively on modules and plugins, and does not provide documentation for general Ansible concepts, playbook syntax, or best practices.

To view documentation for a specific module, such as the yum module, you would run:
ansible-doc yum

To see a brief snippet for the shell module's common parameters:
ansible-doc -s shell

To list all available modules:
ansible-doc -l

To view documentation for a lookup plugin, such as file:
ansible-doc -t lookup file

One of the key benefits of ansible-doc is its ability to provide comprehensive module and plugin documentation without requiring an active internet connection. This makes it an ideal tool for use in isolated or air-gapped environments where external documentation resources are not readily available.

ansible-doc has been a fundamental part of the Ansible project since its early stages. It was introduced to provide an on-demand, offline documentation source for the ever-growing collection of Ansible modules. As Ansible evolved, ansible-doc adapted to support new plugin types (like lookups, filters, and inventory plugins) and underwent continuous improvements in its output formatting and search capabilities. Its core purpose of being an accessible, quick reference for module and plugin usage remains unchanged, making it an indispensable tool for Ansible users.

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