ansible-doc(1) - Linux man page

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

-M directory, --module-path=directory

Add an additional directory to the default path for finding module libraries.

-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.

Author

ansible-doc was originally written by Jan-Piet Mens. See the AUTHORS file for a complete list of contributors.

Copyright

Copyright © 2012, Jan-Piet Mens

Ansible is released under the terms of the GPLv3 License.

See Also

ansible-playbook(1), ansible(1)

Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible.github.com/