NAME

ansible-doc - show documentation on Ansible modules

SYNOPSIS

ansible-doc [-M module_path] [-l] [-s] [module...]

DESCRIPTION

ansible-doc displays information on modules installed in Ansible libraries. It displays a
terse listing of modules and their short descriptions, provides a printout of their
DOCUMENTATION strings, and it can create a short "snippet" which can be pasted into a
playbook.

OPTIONS

-MDIRECTORY, --module-path=DIRECTORY
the DIRECTORY search path to load modules from. The default is /usr/share/ansible.
This can also be set with the ANSIBLE_LIBRARY environment variable.
-s, --snippet=
Produce a snippet which can be copied into a playbook for modification, like a kind of
task template.
-l, --list=
Produce a terse listing of modules and a short description of each.