From the course: Ansible: From Basics to Guru by Pearson

Unlock this course with a free trial

Join today to access over 25,200 courses taught by industry experts.

Using module documentation

Using module documentation - Ansible Tutorial

From the course: Ansible: From Basics to Guru by Pearson

Start my 1-month free trial Buy for my team

Using module documentation

“

In this video, we'll talk about module documentation. So that would be Ansible doc. Ansible doc provides information about modules and much more. It doesn't only provide information about modules. It also provides information about other items in Ansible. We'll check them out later. Now if you go into the specific documentation for a module, you will find that it lists all the different module arguments, as well as some examples of how to use the modules in a playbook. And that's very convenient. Use ansible-doc-l for a list of all the modules. And ansible-doc-module-name for all information about module name, when module name obviously is the name of the module that you want to check out. You can also use ansible-doc-s which is giving you a subset, just the arguments that can be used. Honestly, I never use it. I want to see everything in Ansible doc module name. And Ansible doc minus T is giving you documentation for different Ansible features like keywords and plugins and filters…

Contents