summaryrefslogtreecommitdiffstats
path: root/docs/man/man1/ansible-config.1
blob: 28b88cde7f0498218e731b4ac9275b63bf0fb8d7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "ANSIBLE-CONFIG" 1 "" "Ansible 2.14.3" "System administration commands"
.SH NAME
ansible-config \- View ansible configuration.
.SH SYNOPSIS
.sp
usage: ansible\-config [\-h] [\-\-version] [\-v] {list,dump,view,init} ...
.SH DESCRIPTION
.sp
Config command line class
.SH COMMON OPTIONS
.sp
\fB\-\-version\fP
.INDENT 0.0
.INDENT 3.5
show program\(aqs version number, config file location, configured module search path, module location, executable location and exit
.UNINDENT
.UNINDENT
.sp
\fB\-h\fP, \fB\-\-help\fP
.INDENT 0.0
.INDENT 3.5
show this help message and exit
.UNINDENT
.UNINDENT
.sp
\fB\-v\fP, \fB\-\-verbose\fP
.INDENT 0.0
.INDENT 3.5
Causes Ansible to print more debug messages. Adding multiple \-v will increase the verbosity, the builtin plugins currently evaluate up to \-vvvvvv. A reasonable level to start is \-vvv, connection debugging might require \-vvvv.
.UNINDENT
.UNINDENT
.SH ACTIONS
.INDENT 0.0
.TP
.B \fBlist\fP
list and output available configs
.sp
\fB\-\-format\fP \(aqFORMAT\(aq,   \fB\-f\fP \(aqFORMAT\(aq
.INDENT 7.0
.INDENT 3.5
Output format for list
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP \(aqCONFIG_FILE\(aq,   \fB\-\-config\fP \(aqCONFIG_FILE\(aq
.INDENT 7.0
.INDENT 3.5
path to configuration file, defaults to first file found in precedence.
.UNINDENT
.UNINDENT
.sp
\fB\-t\fP \(aqTYPE\(aq,   \fB\-\-type\fP \(aqTYPE\(aq
.INDENT 7.0
.INDENT 3.5
Filter down to a specific plugin type.
.UNINDENT
.UNINDENT
.TP
.B \fBdump\fP
Shows the current settings, merges ansible.cfg if specified
.sp
\fB\-\-format\fP \(aqFORMAT\(aq,   \fB\-f\fP \(aqFORMAT\(aq
.INDENT 7.0
.INDENT 3.5
Output format for dump
.UNINDENT
.UNINDENT
.sp
\fB\-\-only\-changed\fP,   \fB\-\-changed\-only\fP
.INDENT 7.0
.INDENT 3.5
Only show configurations that have changed from the default
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP \(aqCONFIG_FILE\(aq,   \fB\-\-config\fP \(aqCONFIG_FILE\(aq
.INDENT 7.0
.INDENT 3.5
path to configuration file, defaults to first file found in precedence.
.UNINDENT
.UNINDENT
.sp
\fB\-t\fP \(aqTYPE\(aq,   \fB\-\-type\fP \(aqTYPE\(aq
.INDENT 7.0
.INDENT 3.5
Filter down to a specific plugin type.
.UNINDENT
.UNINDENT
.TP
.B \fBview\fP
Displays the current config file
.sp
\fB\-c\fP \(aqCONFIG_FILE\(aq,   \fB\-\-config\fP \(aqCONFIG_FILE\(aq
.INDENT 7.0
.INDENT 3.5
path to configuration file, defaults to first file found in precedence.
.UNINDENT
.UNINDENT
.sp
\fB\-t\fP \(aqTYPE\(aq,   \fB\-\-type\fP \(aqTYPE\(aq
.INDENT 7.0
.INDENT 3.5
Filter down to a specific plugin type.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBinit\fP
.INDENT 0.0
.INDENT 3.5
\fB\-\-disabled\fP
.INDENT 0.0
.INDENT 3.5
Prefixes all entries with a comment character to disable them
.UNINDENT
.UNINDENT
.sp
\fB\-\-format\fP \(aqFORMAT\(aq,   \fB\-f\fP \(aqFORMAT\(aq
.INDENT 0.0
.INDENT 3.5
Output format for init
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP \(aqCONFIG_FILE\(aq,   \fB\-\-config\fP \(aqCONFIG_FILE\(aq
.INDENT 0.0
.INDENT 3.5
path to configuration file, defaults to first file found in precedence.
.UNINDENT
.UNINDENT
.sp
\fB\-t\fP \(aqTYPE\(aq,   \fB\-\-type\fP \(aqTYPE\(aq
.INDENT 0.0
.INDENT 3.5
Filter down to a specific plugin type.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SH ENVIRONMENT
.sp
The following environment variables may be specified.
.sp
ANSIBLE_CONFIG \-\- Specify override location for the ansible config file
.sp
Many more are available for most options in ansible.cfg
.sp
For a full list check \fI\%https://docs.ansible.com/\fP\&. or use the \fIansible\-config\fP command.
.SH FILES
.sp
/etc/ansible/ansible.cfg \-\- Config file, used if present
.sp
~/.ansible.cfg \-\- User config file, overrides the default config if present
.sp
\&./ansible.cfg \-\- Local config file (in current working directory) assumed to be \(aqproject specific\(aq and overrides the rest if present.
.sp
As mentioned above, the ANSIBLE_CONFIG environment variable will override all others.
.SH AUTHOR
.sp
Ansible was originally written by Michael DeHaan.
.SH COPYRIGHT
.sp
Copyright © 2018 Red Hat, Inc | Ansible.
Ansible is released under the terms of the GPLv3 license.
.SH SEE ALSO
.sp
\fBansible\fP (1), \fBansible\-console\fP (1), \fBansible\-doc\fP (1), \fBansible\-galaxy\fP (1), \fBansible\-inventory\fP (1), \fBansible\-playbook\fP (1), \fBansible\-pull\fP (1), \fBansible\-vault\fP (1)
.sp
Extensive documentation is available in the documentation site:
<\fI\%https://docs.ansible.com\fP>.
IRC and mailing list info can be found in file CONTRIBUTING.md,
available in: <\fI\%https://github.com/ansible/ansible\fP>
.\" Generated by docutils manpage writer.
.