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       usage: ansible-doc [-h] [--version] [-v] [-M MODULE_PATH]
10              [--playbook-dir BASEDIR] [-t {become,cache,callback,cliconf,con‐
11              nection,httpapi,inventory,lookup,netconf,shell,vars,mod‐
12              ule,strategy,test,filter,role,keyword}] [-j] [-r ROLES_PATH] [-e
13              ENTRY_POINT | -s | -F | -l | --metadata-dump]  [--no-fail-on-er‐
14              rors] [plugin ...]
15

DESCRIPTION

17       displays  information  on  modules  installed in Ansible libraries.  It
18       displays a terse listing of plugins and their short descriptions,  pro‐
19       vides  a  printout  of their DOCUMENTATION strings, and it can create a
20       short "snippet" which can be pasted into a playbook.
21

COMMON OPTIONS

23          Plugin
24
25       --metadata-dump
26          For internal use only Dump json metadata for  all  entries,  ignores
27          other options.
28
29       --no-fail-on-errors
30          For  internal use only Only used for --metadata-dump. Do not fail on
31          errors. Report the error message in the JSON instead.
32
33       --playbook-dir 'BASEDIR'
34          Since this tool does not use playbooks, use  this  as  a  substitute
35          playbook  directory.  This  sets the relative path for many features
36          including roles/ group_vars/ etc.
37
38       --version
39          show program's version number, config file location, configured mod‐
40          ule search path, module location, executable location and exit
41
42       -F, --list_files
43          Show  plugin names and their source files without summaries (implies
44          --list). A supplied argument will be used for filtering,  can  be  a
45          namespace or full collection name.
46
47       -M, --module-path
48          prepend  colon-separated path(s) to module library (default={{ ANSI‐
49          BLE_HOME   ~   "/plugins/modules:/usr/share/ansible/plugins/modules"
50          }}). This argument may be specified multiple times.
51
52       -e 'ENTRY_POINT', --entry-point 'ENTRY_POINT'
53          Select the entry point for role(s).
54
55       -h, --help
56          show this help message and exit
57
58       -j, --json
59          Change output into json format.
60
61       -l, --list
62          List available plugins. A supplied argument will be used for filter‐
63          ing, can be a namespace or full collection name.
64
65       -r, --roles-path
66          The path to the directory containing your roles. This  argument  may
67          be specified multiple times.
68
69       -s, --snippet
70          Show  playbook  snippet  for  these plugin types: inventory, lookup,
71          module
72
73       -t 'TYPE', --type 'TYPE'
74          Choose which plugin type (defaults to  "module").  Available  plugin
75          types are : ('become', 'cache', 'callback', 'cliconf', 'connection',
76          'httpapi', 'inventory', 'lookup', 'netconf', 'shell', 'vars',  'mod‐
77          ule', 'strategy', 'test', 'filter', 'role', 'keyword')
78
79       -v, --verbose
80          Causes Ansible to print more debug messages. Adding multiple -v will
81          increase the verbosity, the builtin plugins currently evaluate up to
82          -vvvvvv.  A  reasonable level to start is -vvv, connection debugging
83          might require -vvvv. This argument may be specified multiple times.
84

ENVIRONMENT

86       The following environment variables may be specified.
87
88       ANSIBLE_LIBRARY -- Override the default ansible module library path
89
90       ANSIBLE_CONFIG -- Specify override location for the ansible config file
91
92       Many more are available for most options in ansible.cfg
93
94       For a full list  check  https://docs.ansible.com/.  or  use  the  ansi‐
95       ble-config command.
96

FILES

98       /etc/ansible/ansible.cfg -- Config file, used if present
99
100       ~/.ansible.cfg  --  User  config  file, overrides the default config if
101       present
102
103       ./ansible.cfg -- Local config file (in current working  directory)  as‐
104       sumed to be 'project specific' and overrides the rest if present.
105
106       As  mentioned above, the ANSIBLE_CONFIG environment variable will over‐
107       ride all others.
108

AUTHOR

110       Ansible was originally written by Michael DeHaan.
111

COPYRIGHT

113       Copyright © 2018 Red Hat, Inc | Ansible.  Ansible is released under the
114       terms of the GPLv3 license.
115