OnCallReady

Commands

ansible-doc - plugin documentation tool

ansible-doc [-t TYPE] [-l | -s | -F] [PLUGIN ...]

Options you will use

-l, --list
List available plugins (modules by default).
-s, --snippet
Show a playbook snippet for the module.
-F, --list_files
Show plugin names and their source files.
-t, --type TYPE
Plugin type: module (default), lookup, filter, test, become, connection, callback, inventory ...
-j, --json
Change output into JSON.

Examples

$ ansible-doc ansible.builtin.lineinfile

options, examples, return values

$ ansible-doc -s apt

a task skeleton

$ ansible-doc -l | grep ansible.posix

what a collection brings

$ ansible-doc -t lookup -l

the lookup plugins

Taught in

Try ansible-doc in a real terminal Free, in your browser - a real Ubuntu terminal to try it in, with missions that check your work.