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,module,strat‐
12              egy,vars}] [-j] [-F | -l | -s | --metadata-dump] [plugin [plugin
13              ...]]
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
30          including 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)
39
40       -M, --module-path
41          prepend  colon-separated path(s) to module library (default=~/.ansi‐
42          ble/plugins/modules:/usr/share/ansible/plugins/modules)
43
44       -h, --help
45          show this help message and exit
46
47       -j, --json
48          Change output into json format.
49
50       -l, --list
51          List available plugins
52
53       -s, --snippet
54          Show playbook snippet for specified plugin(s)
55
56       -t 'TYPE', --type 'TYPE'
57          Choose which plugin type (defaults to  "module").  Available  plugin
58          types are : ('become', 'cache', 'callback', 'cliconf', 'connection',
59          'httpapi',  'inventory',  'lookup',  'netconf',  'shell',  'module',
60          'strategy', 'vars')
61
62       -v, --verbose
63          verbose mode (-vvv for more, -vvvv to enable connection debugging)
64

ENVIRONMENT

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

FILES

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

AUTHOR

88       Ansible was originally written by Michael DeHaan.
89

COPYRIGHT

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