ansible-core/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,role,keyword}] [-j] [-r ROLES_PATH] [-F | -l | -s |
13              --metadata-dump | -e ENTRY_POINT] [plugin [plugin ...]]
14

DESCRIPTION

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

COMMON OPTIONS

22          Plugin
23
24       --metadata-dump
25          For internal testing only Dump json metadata for all plugins.
26
27       --playbook-dir 'BASEDIR'
28          Since  this  tool  does  not use playbooks, use this as a substitute
29          playbook directory.This sets the relative path for many features in‐
30          cluding roles/ group_vars/ etc.
31
32       --version
33          show program's version number, config file location, configured mod‐
34          ule search path, module location, executable location and exit
35
36       -F, --list_files
37          Show plugin names and their source files without summaries  (implies
38          --list).  A  supplied  argument will be used for filtering, can be a
39          namespace or full collection name.
40
41       -M, --module-path
42          prepend colon-separated path(s) to module library  (default=~/.ansi‐
43          ble/plugins/modules:/usr/share/ansible/plugins/modules)
44
45       -e 'ENTRY_POINT', --entry-point 'ENTRY_POINT'
46          Select the entry point for role(s).
47
48       -h, --help
49          show this help message and exit
50
51       -j, --json
52          Change output into json format.
53
54       -l, --list
55          List available plugins. A supplied argument will be used for filter‐
56          ing, can be a namespace or full collection name.
57
58       -r, --roles-path
59          The path to the directory containing your roles.
60
61       -s, --snippet
62          Show playbook snippet for specified plugin(s)
63
64       -t 'TYPE', --type 'TYPE'
65          Choose which plugin type (defaults to  "module").  Available  plugin
66          types are : ('become', 'cache', 'callback', 'cliconf', 'connection',
67          'httpapi', 'inventory', 'lookup', 'netconf', 'shell', 'vars',  'mod‐
68          ule', 'strategy', 'role', 'keyword')
69
70       -v, --verbose
71          verbose mode (-vvv for more, -vvvv to enable connection debugging)
72

ENVIRONMENT

74       The following environment variables may be specified.
75
76       ANSIBLE_CONFIG -- Specify override location for the ansible config file
77
78       Many more are available for most options in ansible.cfg
79
80       For  a  full  list  check  https://docs.ansible.com/.  or use the ansi‐
81       ble-config command.
82

FILES

84       /etc/ansible/ansible.cfg -- Config file, used if present
85
86       ~/.ansible.cfg -- User config file, overrides  the  default  config  if
87       present
88
89       ./ansible.cfg  --  Local config file (in current working directory) as‐
90       sumed to be 'project specific' and overrides the rest if present.
91
92       As mentioned above, the ANSIBLE_CONFIG environment variable will  over‐
93       ride all others.
94

AUTHOR

96       Ansible was originally written by Michael DeHaan.
97

COPYRIGHT

99       Copyright © 2018 Red Hat, Inc | Ansible.  Ansible is released under the
100       terms of the GPLv3 license.
101