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,shell,module,strategy,vars}]
12              [-j] [-F | -l | -s | --metadata-dump] [plugin [plugin ...]]
13

DESCRIPTION

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

COMMON OPTIONS

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

ENVIRONMENT

65       The following environment variables may be specified.
66
67       ANSIBLE_CONFIG -- Specify override location for the ansible config file
68
69       Many more are available for most options in ansible.cfg
70
71       For a full list  check  https://docs.ansible.com/.  or  use  the  ansi‐
72       ble-config command.
73

FILES

75       /etc/ansible/ansible.cfg -- Config file, used if present
76
77       ~/.ansible.cfg  --  User  config  file, overrides the default config if
78       present
79
80       ./ansible.cfg -- Local  config  file  (in  current  working  directory)
81       assumed to be 'project specific' and overrides the rest if present.
82
83       As  mentioned above, the ANSIBLE_CONFIG environment variable will over‐
84       ride all others.
85

AUTHOR

87       Ansible was originally written by Michael DeHaan.
88

COPYRIGHT

90       Copyright © 2018 Red Hat, Inc | Ansible.  Ansible is released under the
91       terms of the GPLv3 license.
92