ansible-config(1)

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

NAME

6       ansible-config - View ansible configuration.
7

SYNOPSIS

9       usage: ansible-config [-h] [--version] [-v] {list,dump,view,init} ...
10

DESCRIPTION

12       Config command line class
13

COMMON OPTIONS

15       --version
16          show program's version number, config file location, configured mod‐
17          ule search path, module location, executable location and exit
18
19       -h, --help
20          show this help message and exit
21
22       -v, --verbose
23          Causes Ansible to print more debug messages. Adding multiple -v will
24          increase the verbosity, the builtin plugins currently evaluate up to
25          -vvvvvv. A reasonable level to start is -vvv,  connection  debugging
26          might require -vvvv.
27

ACTIONS

29       list   list and output available configs
30
31              --format 'FORMAT',   -f 'FORMAT'
32                 Output format for list
33
34              -c 'CONFIG_FILE',   --config 'CONFIG_FILE'
35                 path  to  configuration file, defaults to first file found in
36                 precedence.
37
38              -t 'TYPE',   --type 'TYPE'
39                 Filter down to a specific plugin type.
40
41       dump   Shows the current settings, merges ansible.cfg if specified
42
43              --format 'FORMAT',   -f 'FORMAT'
44                 Output format for dump
45
46              --only-changed,   --changed-only
47                 Only show configurations that have changed from the default
48
49              -c 'CONFIG_FILE',   --config 'CONFIG_FILE'
50                 path to configuration file, defaults to first file  found  in
51                 precedence.
52
53              -t 'TYPE',   --type 'TYPE'
54                 Filter down to a specific plugin type.
55
56       view   Displays the current config file
57
58              -c 'CONFIG_FILE',   --config 'CONFIG_FILE'
59                 path  to  configuration file, defaults to first file found in
60                 precedence.
61
62              -t 'TYPE',   --type 'TYPE'
63                 Filter down to a specific plugin type.
64
65       init
66          --disabled
67              Prefixes all entries with a comment character to disable them
68
69          --format 'FORMAT',   -f 'FORMAT'
70              Output format for init
71
72          -c 'CONFIG_FILE',   --config 'CONFIG_FILE'
73              path to configuration file, defaults  to  first  file  found  in
74              precedence.
75
76          -t 'TYPE',   --type 'TYPE'
77              Filter down to a specific plugin type.
78

ENVIRONMENT

80       The following environment variables may be specified.
81
82       ANSIBLE_CONFIG -- Specify override location for the ansible config file
83
84       Many more are available for most options in ansible.cfg
85
86       For  a  full  list  check  https://docs.ansible.com/.  or use the ansi‐
87       ble-config command.
88

FILES

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

AUTHOR

102       Ansible was originally written by Michael DeHaan.
103

COPYRIGHT

105       Copyright © 2018 Red Hat, Inc | Ansible.  Ansible is released under the
106       terms of the GPLv3 license.
107