ServerAcademy.com - Master Server Administration

In this lesson, we'll explore how to use the ansible-doc command to access and understand the documentation of Ansible modules and plugins. This is an invaluable tool for any Ansible user, as it provides quick and easy access to the specific usage, parameters, and examples for modules and plugins directly from the command line.

The ansible-doc Command

What is ansible-doc?

ansible-doc is a command-line utility included with Ansible that allows you to view documentation about modules and plugins. This documentation includes details about what the module or plugin does, the parameters it accepts, the return values it produces, and often includes practical examples.

Benefits of ansible-doc

Quick Access : Get information directly from your command line without needing to search online.
Up-to-date Information : Since it's part of your Ansible installation, the documentation you access is always in sync with your Ansible version.
Convenience : Helps in writing playbooks by providing syntax references and parameter options for modules and plugins.

Using ansible-doc

Viewing Documentation for a Module

To view documentation for a specific module, use the following command:

ansible-doc <module_name>

For example, to view documentation for the file module:

ansible-doc file

This will display detailed information about the file module, including its purpose, parameters, and return values.

Searching for Modules

If you're not sure about the exact name of a module, you can search for it using a keyword. For example, use the code below to see all Windows related modules:

ansible-doc -l | grep windows

This command lists all modules (-l) and then filters the results using grep for the specified keyword.