ansible-doc(1)

1ANSIBLE-DOC(1)          System administration commands          ANSIBLE-DOC(1)
2
3
4

NAME

6       ansible-doc - plugin documentation tool
7

SYNOPSIS

9       ansible-doc [-l|-F|-s] [options] [-t <plugin type> ] [plugin]
10

DESCRIPTION

12       displays  information  on  modules  installed in Ansible libraries.  It
13       displays a terse listing of plugins and their short descriptions,  pro‐
14       vides  a  printout  of their DOCUMENTATION strings, and it can create a
15       short "snippet" which can be pasted into a playbook.
16

COMMON OPTIONS

18       --version
19          show program's version number, config file location, configured mod‐
20          ule search path, module location, executable location and exit
21
22       -F, --list_files
23          Show  plugin names and their source files without summaries (implies
24          --list)
25
26       -M, --module-path
27          prepend colon-separated path(s) to module library  (default=~/.ansi‐
28          ble/plugins/modules:/usr/share/ansible/plugins/modules)
29
30       -h, --help
31          show this help message and exit
32
33       -j, --json
34          For internal testing only Dump json metadata for all plugins.
35
36       -l, --list
37          List available plugins
38
39       -s, --snippet
40          Show playbook snippet for specified plugin(s)
41
42       -t 'TYPE', --type 'TYPE'
43          Choose  which  plugin  type (defaults to "module"). Available plugin
44          types are : ('become', 'cache', 'callback', 'cliconf', 'connection',
45          'httpapi',  'inventory',  'lookup',  'shell',  'module', 'strategy',
46          'vars')
47
48       -v, --verbose
49          verbose mode (-vvv for more, -vvvv to enable connection debugging)
50

ENVIRONMENT

52       The following environment variables may be specified.
53
54       ANSIBLE_CONFIG -- Specify override location for the ansible config file
55
56       Many more are available for most options in ansible.cfg
57
58       For a full list  check  https://docs.ansible.com/.  or  use  the  ansi‐
59       ble-config command.
60

FILES

62       /etc/ansible/ansible.cfg -- Config file, used if present
63
64       ~/.ansible.cfg  --  User  config  file, overrides the default config if
65       present
66
67       ./ansible.cfg -- Local  config  file  (in  current  working  directory)
68       assumed to be 'project specific' and overrides the rest if present.
69
70       As  mentioned above, the ANSIBLE_CONFIG environment variable will over‐
71       ride all others.
72

AUTHOR

74       Ansible was originally written by Michael DeHaan.
75

COPYRIGHT

77       Copyright © 2018 Red Hat, Inc | Ansible.  Ansible is released under the
78       terms of the GPLv3 license.
79