ansible-doc(1) ============== :doctype: manpage :man source: Ansible :man version: %VERSION% :man manual: System administration commands NAME ---- ansible-doc - show documentation on Ansible plugins SYNOPSIS -------- ansible-doc [-M plugin_path] [-l] [-s] [-t ] [plugin...] DESCRIPTION ----------- *ansible-doc* displays information on modules installed in Ansible libraries. It displays a terse listing of plugins 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', *--plugin-path=*'DIRECTORY':: The 'DIRECTORY' search path to load plugins from. If not specified Ansbile uses it's normal search path and configuration. *-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 plugins and a short description of each. *-t*, *--type=*:: Specify the type of plugin to target, default is 'module'. Other choices are 'cache', 'callback', 'connection', 'lookup' and 'strategy'. ENVIRONMENT ----------- ANSIBLE_CONFIG -- Configuration file to use ANSIBLE_LIBRARY -- Override the default ansible module library path ANSIBLE_CACHE_PLUGINS -- Override the default ansible cache plugin path ANSIBLE_CALLBACK_PLUGINS -- Override the default ansible callback plugin path ANSIBLE_CONNECTION_PLUGINS -- Override the default ansible connection plugin path ANSIBLE_LOOKUP_PLUGINS -- Override the default ansible lookup plugin path ANSIBLE_STRATEGY_PLUGINS -- Override the default ansible strategy plugin path FILES ----- /etc/ansible/ansible.cfg -- Config file, used if present ~/.ansible.cfg -- User config file, overrides the default config if present 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), *ansible-pull*(1), *ansible-vault*(1), *ansible-galaxy*(1) Extensive documentation is available in the documentation site: . IRC and mailing list info can be found in file CONTRIBUTING.md, available in: