... | ... |
@@ -19,6 +19,12 @@ rpm-build |
19 | 19 |
# Mac OS X stuff... |
20 | 20 |
.DS_Store |
21 | 21 |
# manpage build stuff... |
22 |
+docs/man/man1/ansible.1 |
|
23 |
+docs/man/man1/ansible-doc.1 |
|
24 |
+docs/man/man1/ansible-galaxy.1 |
|
25 |
+docs/man/man1/ansible-playbook.1 |
|
26 |
+docs/man/man1/ansible-pull.1 |
|
27 |
+docs/man/man1/ansible-vault.1 |
|
22 | 28 |
docs/man/man3/* |
23 | 29 |
# Sublime stuff |
24 | 30 |
*.sublime-project |
25 | 31 |
deleted file mode 100644 |
... | ... |
@@ -1,66 +0,0 @@ |
1 |
-'\" t |
|
2 |
-.\" Title: ansible-doc |
|
3 |
-.\" Author: :doctype:manpage |
|
4 |
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> |
|
5 |
-.\" Date: 12/09/2014 |
|
6 |
-.\" Manual: System administration commands |
|
7 |
-.\" Source: Ansible 1.9 |
|
8 |
-.\" Language: English |
|
9 |
-.\" |
|
10 |
-.TH "ANSIBLE\-DOC" "1" "12/09/2014" "Ansible 1\&.9" "System administration commands" |
|
11 |
-.\" ----------------------------------------------------------------- |
|
12 |
-.\" * Define some portability stuff |
|
13 |
-.\" ----------------------------------------------------------------- |
|
14 |
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
15 |
-.\" http://bugs.debian.org/507673 |
|
16 |
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
|
17 |
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
18 |
-.ie \n(.g .ds Aq \(aq |
|
19 |
-.el .ds Aq ' |
|
20 |
-.\" ----------------------------------------------------------------- |
|
21 |
-.\" * set default formatting |
|
22 |
-.\" ----------------------------------------------------------------- |
|
23 |
-.\" disable hyphenation |
|
24 |
-.nh |
|
25 |
-.\" disable justification (adjust text to left margin only) |
|
26 |
-.ad l |
|
27 |
-.\" ----------------------------------------------------------------- |
|
28 |
-.\" * MAIN CONTENT STARTS HERE * |
|
29 |
-.\" ----------------------------------------------------------------- |
|
30 |
-.SH "NAME" |
|
31 |
-ansible-doc \- show documentation on Ansible modules |
|
32 |
-.SH "SYNOPSIS" |
|
33 |
-.sp |
|
34 |
-ansible\-doc [\-M module_path] [\-l] [\-s] [module\&...] |
|
35 |
-.SH "DESCRIPTION" |
|
36 |
-.sp |
|
37 |
-\fBansible\-doc\fR displays information on modules installed in Ansible libraries\&. It displays a terse listing of modules and their short descriptions, provides a printout of their DOCUMENTATION strings, and it can create a short "snippet" which can be pasted into a playbook\&. |
|
38 |
-.SH "OPTIONS" |
|
39 |
-.PP |
|
40 |
-\fB\-M\fR \fIdirectory\fR, \fB\-\-module\-path=\fR\fIdirectory\fR |
|
41 |
-.RS 4 |
|
42 |
-Add an additional directory to the default path for finding module libraries\&. |
|
43 |
-.RE |
|
44 |
-.PP |
|
45 |
-\fB\-s\fR, \fB\-\-snippet=\fR |
|
46 |
-.RS 4 |
|
47 |
-Produce a snippet which can be copied into a playbook for modification, like a kind of task template\&. |
|
48 |
-.RE |
|
49 |
-.PP |
|
50 |
-\fB\-l\fR, \fB\-\-list=\fR |
|
51 |
-.RS 4 |
|
52 |
-Produce a terse listing of modules and a short description of each\&. |
|
53 |
-.RE |
|
54 |
-.SH "AUTHOR" |
|
55 |
-.sp |
|
56 |
-ansible\-doc was originally written by Jan\-Piet Mens\&. See the AUTHORS file for a complete list of contributors\&. |
|
57 |
-.SH "COPYRIGHT" |
|
58 |
-.sp |
|
59 |
-Copyright \(co 2012, Jan\-Piet Mens |
|
60 |
-.sp |
|
61 |
-Ansible is released under the terms of the GPLv3 License\&. |
|
62 |
-.SH "SEE ALSO" |
|
63 |
-.sp |
|
64 |
-\fBansible\-playbook\fR(1), \fBansible\fR(1), \fBansible\-pull\fR(1) |
|
65 |
-.sp |
|
66 |
-Extensive documentation is available in the documentation site: http://docs\&.ansible\&.com\&. IRC and mailing list info can be found in file CONTRIBUTING\&.md, available in: https://github\&.com/ansible/ansible |
... | ... |
@@ -28,9 +28,11 @@ playbook. |
28 | 28 |
OPTIONS |
29 | 29 |
------- |
30 | 30 |
|
31 |
-*-M* 'directory', *--module-path=*'directory':: |
|
31 |
+*-M* 'DIRECTORY', *--module-path=*'DIRECTORY':: |
|
32 | 32 |
|
33 |
-Add an additional directory to the default path for finding module libraries. |
|
33 |
+the 'DIRECTORY' search path to load modules from. The default is |
|
34 |
+'/usr/share/ansible'. This can also be set with the ANSIBLE_LIBRARY |
|
35 |
+environment variable. |
|
34 | 36 |
|
35 | 37 |
*-s*, *--snippet=*:: |
36 | 38 |
|
... | ... |
@@ -41,6 +43,24 @@ a kind of task template. |
41 | 41 |
|
42 | 42 |
Produce a terse listing of modules and a short description of each. |
43 | 43 |
|
44 |
+ |
|
45 |
+ENVIRONMENT |
|
46 |
+----------- |
|
47 |
+ |
|
48 |
+ANSIBLE_LIBRARY -- Override the default ansible module library path |
|
49 |
+ |
|
50 |
+ |
|
51 |
+FILES |
|
52 |
+----- |
|
53 |
+ |
|
54 |
+/usr/share/ansible/ -- Default module library |
|
55 |
+ |
|
56 |
+/etc/ansible/ansible.cfg -- Config file, used if present |
|
57 |
+ |
|
58 |
+~/.ansible.cfg -- User config file, overrides the default config if present |
|
59 |
+ |
|
60 |
+ |
|
61 |
+ |
|
44 | 62 |
AUTHOR |
45 | 63 |
------ |
46 | 64 |
|
... | ... |
@@ -59,7 +79,7 @@ Ansible is released under the terms of the GPLv3 License. |
59 | 59 |
SEE ALSO |
60 | 60 |
-------- |
61 | 61 |
|
62 |
-*ansible-playbook*(1), *ansible*(1), *ansible-pull*(1) |
|
62 |
+*ansible-playbook*(1), *ansible*(1), *ansible-pull*(1), *ansible-vault*(1), *ansible-galaxy*(1) |
|
63 | 63 |
|
64 | 64 |
Extensive documentation is available in the documentation site: |
65 | 65 |
<http://docs.ansible.com>. IRC and mailing list info can be found |
66 | 66 |
deleted file mode 100644 |
... | ... |
@@ -1,185 +0,0 @@ |
1 |
-'\" t |
|
2 |
-.\" Title: ansible-galaxy |
|
3 |
-.\" Author: [see the "AUTHOR" section] |
|
4 |
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> |
|
5 |
-.\" Date: 05/05/2015 |
|
6 |
-.\" Manual: System administration commands |
|
7 |
-.\" Source: Ansible 2.0.0 |
|
8 |
-.\" Language: English |
|
9 |
-.\" |
|
10 |
-.TH "ANSIBLE\-GALAXY" "1" "05/05/2015" "Ansible 2\&.0\&.0" "System administration commands" |
|
11 |
-.\" ----------------------------------------------------------------- |
|
12 |
-.\" * Define some portability stuff |
|
13 |
-.\" ----------------------------------------------------------------- |
|
14 |
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
15 |
-.\" http://bugs.debian.org/507673 |
|
16 |
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
|
17 |
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
18 |
-.ie \n(.g .ds Aq \(aq |
|
19 |
-.el .ds Aq ' |
|
20 |
-.\" ----------------------------------------------------------------- |
|
21 |
-.\" * set default formatting |
|
22 |
-.\" ----------------------------------------------------------------- |
|
23 |
-.\" disable hyphenation |
|
24 |
-.nh |
|
25 |
-.\" disable justification (adjust text to left margin only) |
|
26 |
-.ad l |
|
27 |
-.\" ----------------------------------------------------------------- |
|
28 |
-.\" * MAIN CONTENT STARTS HERE * |
|
29 |
-.\" ----------------------------------------------------------------- |
|
30 |
-.SH "NAME" |
|
31 |
-ansible-galaxy \- manage roles using galaxy\&.ansible\&.com |
|
32 |
-.SH "SYNOPSIS" |
|
33 |
-.sp |
|
34 |
-ansible\-galaxy [init|info|install|list|remove] [\-\-help] [options] \&... |
|
35 |
-.SH "DESCRIPTION" |
|
36 |
-.sp |
|
37 |
-\fBAnsible Galaxy\fR is a shared repository for Ansible roles (added in ansible version 1\&.2)\&. The ansible\-galaxy command can be used to manage these roles, or by creating a skeleton framework for roles you\(cqd like to upload to Galaxy\&. |
|
38 |
-.SH "COMMON OPTIONS" |
|
39 |
-.PP |
|
40 |
-\fB\-h\fR, \fB\-\-help\fR |
|
41 |
-.RS 4 |
|
42 |
-Show a help message related to the given sub\-command\&. |
|
43 |
-.RE |
|
44 |
-.SH "INSTALL" |
|
45 |
-.sp |
|
46 |
-The \fBinstall\fR sub\-command is used to install roles\&. |
|
47 |
-.SS "USAGE" |
|
48 |
-.sp |
|
49 |
-$ ansible\-galaxy install [options] [\-r FILE | role_name(s)[,version] | tar_file(s)] |
|
50 |
-.sp |
|
51 |
-Roles can be installed in several different ways: |
|
52 |
-.sp |
|
53 |
-.RS 4 |
|
54 |
-.ie n \{\ |
|
55 |
-\h'-04'\(bu\h'+03'\c |
|
56 |
-.\} |
|
57 |
-.el \{\ |
|
58 |
-.sp -1 |
|
59 |
-.IP \(bu 2.3 |
|
60 |
-.\} |
|
61 |
-A username\&.rolename[,version] \- this will install a single role\&. The Galaxy API will be contacted to provide the information about the role, and the corresponding \&.tar\&.gz will be downloaded from |
|
62 |
-\fBgithub\&.com\fR\&. If the version is omitted, the most recent version available will be installed\&. |
|
63 |
-.RE |
|
64 |
-.sp |
|
65 |
-.RS 4 |
|
66 |
-.ie n \{\ |
|
67 |
-\h'-04'\(bu\h'+03'\c |
|
68 |
-.\} |
|
69 |
-.el \{\ |
|
70 |
-.sp -1 |
|
71 |
-.IP \(bu 2.3 |
|
72 |
-.\} |
|
73 |
-A file name, using |
|
74 |
-\fB\-r\fR |
|
75 |
-\- this will install multiple roles listed one per line\&. The format of each line is the same as above: username\&.rolename[,version] |
|
76 |
-.RE |
|
77 |
-.sp |
|
78 |
-.RS 4 |
|
79 |
-.ie n \{\ |
|
80 |
-\h'-04'\(bu\h'+03'\c |
|
81 |
-.\} |
|
82 |
-.el \{\ |
|
83 |
-.sp -1 |
|
84 |
-.IP \(bu 2.3 |
|
85 |
-.\} |
|
86 |
-A \&.tar\&.gz of a valid role you\(cqve downloaded directly from |
|
87 |
-\fBgithub\&.com\fR\&. This is mainly useful when the system running Ansible does not have access to the Galaxy API, for instance when behind a firewall or proxy\&. |
|
88 |
-.RE |
|
89 |
-.SS "OPTIONS" |
|
90 |
-.PP |
|
91 |
-\fB\-f\fR, \fB\-\-force\fR |
|
92 |
-.RS 4 |
|
93 |
-Force overwriting an existing role\&. |
|
94 |
-.RE |
|
95 |
-.PP |
|
96 |
-\fB\-i\fR, \fB\-\-ignore\-errors\fR |
|
97 |
-.RS 4 |
|
98 |
-Ignore errors and continue with the next specified role\&. |
|
99 |
-.RE |
|
100 |
-.PP |
|
101 |
-\fB\-n\fR, \fB\-\-no\-deps\fR |
|
102 |
-.RS 4 |
|
103 |
-Don\(cqt download roles listed as dependencies\&. |
|
104 |
-.RE |
|
105 |
-.PP |
|
106 |
-\fB\-p\fR \fIROLES_PATH\fR, \fB\-\-roles\-path=\fR\fIROLES_PATH\fR |
|
107 |
-.RS 4 |
|
108 |
-The path to the directory containing your roles\&. The default is the |
|
109 |
-\fBroles_path\fR |
|
110 |
-configured in your |
|
111 |
-\fBansible\&.cfg\fR |
|
112 |
-file (/etc/ansible/roles if not configured) |
|
113 |
-.RE |
|
114 |
-.PP |
|
115 |
-\fB\-r\fR \fIROLE_FILE\fR, \fB\-\-role\-file=\fR\fIROLE_FILE\fR |
|
116 |
-.RS 4 |
|
117 |
-A file containing a list of roles to be imported, as specified above\&. This option cannot be used if a rolename or \&.tar\&.gz have been specified\&. |
|
118 |
-.RE |
|
119 |
-.SH "REMOVE" |
|
120 |
-.sp |
|
121 |
-The \fBremove\fR sub\-command is used to remove one or more roles\&. |
|
122 |
-.SS "USAGE" |
|
123 |
-.sp |
|
124 |
-$ ansible\-galaxy remove role1 role2 \&... |
|
125 |
-.SS "OPTIONS" |
|
126 |
-.PP |
|
127 |
-\fB\-p\fR \fIROLES_PATH\fR, \fB\-\-roles\-path=\fR\fIROLES_PATH\fR |
|
128 |
-.RS 4 |
|
129 |
-The path to the directory containing your roles\&. The default is the |
|
130 |
-\fBroles_path\fR |
|
131 |
-configured in your |
|
132 |
-\fBansible\&.cfg\fR |
|
133 |
-file (/etc/ansible/roles if not configured) |
|
134 |
-.RE |
|
135 |
-.SH "INIT" |
|
136 |
-.sp |
|
137 |
-The \fBinit\fR command is used to create an empty role suitable for uploading to https://galaxy\&.ansible\&.com (or for roles in general)\&. |
|
138 |
-.SS "USAGE" |
|
139 |
-.sp |
|
140 |
-$ ansible\-galaxy init [options] role_name |
|
141 |
-.SS "OPTIONS" |
|
142 |
-.PP |
|
143 |
-\fB\-f\fR, \fB\-\-force\fR |
|
144 |
-.RS 4 |
|
145 |
-Force overwriting an existing role\&. |
|
146 |
-.RE |
|
147 |
-.PP |
|
148 |
-\fB\-p\fR \fIINIT_PATH\fR, \fB\-\-init\-path=\fR\fIINIT_PATH\fR |
|
149 |
-.RS 4 |
|
150 |
-The path in which the skeleton role will be created\&.The default is the current working directory\&. |
|
151 |
-.RE |
|
152 |
-.PP |
|
153 |
-\fB\-\-offline\fR |
|
154 |
-.RS 4 |
|
155 |
-Don\(cqt query the galaxy API when creating roles |
|
156 |
-.RE |
|
157 |
-.SH "LIST" |
|
158 |
-.sp |
|
159 |
-The \fBlist\fR sub\-command is used to show what roles are currently instaled\&. You can specify a role name, and if installed only that role will be shown\&. |
|
160 |
-.SS "USAGE" |
|
161 |
-.sp |
|
162 |
-$ ansible\-galaxy list [role_name] |
|
163 |
-.SS "OPTIONS" |
|
164 |
-.PP |
|
165 |
-\fB\-p\fR \fIROLES_PATH\fR, \fB\-\-roles\-path=\fR\fIROLES_PATH\fR |
|
166 |
-.RS 4 |
|
167 |
-The path to the directory containing your roles\&. The default is the |
|
168 |
-\fBroles_path\fR |
|
169 |
-configured in your |
|
170 |
-\fBansible\&.cfg\fR |
|
171 |
-file (/etc/ansible/roles if not configured) |
|
172 |
-.RE |
|
173 |
-.SH "AUTHOR" |
|
174 |
-.sp |
|
175 |
-Ansible was originally written by Michael DeHaan\&. See the AUTHORS file for a complete list of contributors\&. |
|
176 |
-.SH "COPYRIGHT" |
|
177 |
-.sp |
|
178 |
-Copyright \(co 2014, Michael DeHaan |
|
179 |
-.sp |
|
180 |
-Ansible is released under the terms of the GPLv3 License\&. |
|
181 |
-.SH "SEE ALSO" |
|
182 |
-.sp |
|
183 |
-\fBansible\fR(1), \fBansible\-pull\fR(1), \fBansible\-doc\fR(1) |
|
184 |
-.sp |
|
185 |
-Extensive documentation is available in the documentation site: http://docs\&.ansible\&.com\&. IRC and mailing list info can be found in file CONTRIBUTING\&.md, available in: https://github\&.com/ansible/ansible |
... | ... |
@@ -18,10 +18,9 @@ ansible-galaxy [init|info|install|list|remove] [--help] [options] ... |
18 | 18 |
DESCRIPTION |
19 | 19 |
----------- |
20 | 20 |
|
21 |
-*Ansible Galaxy* is a shared repository for Ansible roles (added in |
|
22 |
-ansible version 1.2). The ansible-galaxy command can be used to manage |
|
23 |
-these roles, or by creating a skeleton framework for roles you'd like |
|
24 |
-to upload to Galaxy. |
|
21 |
+*Ansible Galaxy* is a shared repository for Ansible roles. |
|
22 |
+The ansible-galaxy command can be used to manage these roles, |
|
23 |
+or by creating a skeleton framework for roles you'd like to upload to Galaxy. |
|
25 | 24 |
|
26 | 25 |
COMMON OPTIONS |
27 | 26 |
-------------- |
... | ... |
@@ -43,16 +42,16 @@ $ ansible-galaxy install [options] [-r FILE | role_name(s)[,version] | tar_file( |
43 | 43 |
|
44 | 44 |
Roles can be installed in several different ways: |
45 | 45 |
|
46 |
-* A username.rolename[,version] - this will install a single role. The Galaxy |
|
47 |
- API will be contacted to provide the information about the role, and the |
|
48 |
- corresponding .tar.gz will be downloaded from *github.com*. If the version |
|
46 |
+* A username.rolename[,version] - this will install a single role. The Galaxy |
|
47 |
+ API will be contacted to provide the information about the role, and the |
|
48 |
+ corresponding .tar.gz will be downloaded from *github.com*. If the version |
|
49 | 49 |
is omitted, the most recent version available will be installed. |
50 | 50 |
|
51 | 51 |
* A file name, using *-r* - this will install multiple roles listed one per |
52 | 52 |
line. The format of each line is the same as above: username.rolename[,version] |
53 | 53 |
|
54 | 54 |
* A .tar.gz of a valid role you've downloaded directly from *github.com*. This |
55 |
- is mainly useful when the system running Ansible does not have access to |
|
55 |
+ is mainly useful when the system running Ansible does not have access to |
|
56 | 56 |
the Galaxy API, for instance when behind a firewall or proxy. |
57 | 57 |
|
58 | 58 |
|
... | ... |
@@ -164,7 +163,7 @@ Ansible is released under the terms of the GPLv3 License. |
164 | 164 |
SEE ALSO |
165 | 165 |
-------- |
166 | 166 |
|
167 |
-*ansible*(1), *ansible-pull*(1), *ansible-doc*(1) |
|
167 |
+*ansible*(1), *ansible-pull*(1), *ansible-doc*(1), *ansible-playbook*(1), *ansible-vault*(1) |
|
168 | 168 |
|
169 | 169 |
Extensive documentation is available in the documentation site: |
170 | 170 |
<http://docs.ansible.com>. IRC and mailing list info can be found |
171 | 171 |
deleted file mode 100644 |
... | ... |
@@ -1,269 +0,0 @@ |
1 |
-'\" t |
|
2 |
-.\" Title: ansible-playbook |
|
3 |
-.\" Author: :doctype:manpage |
|
4 |
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> |
|
5 |
-.\" Date: 07/23/2015 |
|
6 |
-.\" Manual: System administration commands |
|
7 |
-.\" Source: Ansible %VERSION% |
|
8 |
-.\" Language: English |
|
9 |
-.\" |
|
10 |
-.TH "ANSIBLE\-PLAYBOOK" "1" "07/23/2015" "Ansible %VERSION%" "System administration commands" |
|
11 |
-.\" ----------------------------------------------------------------- |
|
12 |
-.\" * Define some portability stuff |
|
13 |
-.\" ----------------------------------------------------------------- |
|
14 |
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
15 |
-.\" http://bugs.debian.org/507673 |
|
16 |
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
|
17 |
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
18 |
-.ie \n(.g .ds Aq \(aq |
|
19 |
-.el .ds Aq ' |
|
20 |
-.\" ----------------------------------------------------------------- |
|
21 |
-.\" * set default formatting |
|
22 |
-.\" ----------------------------------------------------------------- |
|
23 |
-.\" disable hyphenation |
|
24 |
-.nh |
|
25 |
-.\" disable justification (adjust text to left margin only) |
|
26 |
-.ad l |
|
27 |
-.\" ----------------------------------------------------------------- |
|
28 |
-.\" * MAIN CONTENT STARTS HERE * |
|
29 |
-.\" ----------------------------------------------------------------- |
|
30 |
-.SH "NAME" |
|
31 |
-ansible-playbook \- run an ansible playbook |
|
32 |
-.SH "SYNOPSIS" |
|
33 |
-.sp |
|
34 |
-ansible\-playbook <filename\&.yml> \&... [options] |
|
35 |
-.SH "DESCRIPTION" |
|
36 |
-.sp |
|
37 |
-\fBAnsible playbooks\fR are a configuration and multinode deployment system\&. Ansible\-playbook is the tool used to run them\&. See the project home page (link below) for more information\&. |
|
38 |
-.SH "ARGUMENTS" |
|
39 |
-.PP |
|
40 |
-\fBfilename\&.yml\fR |
|
41 |
-.RS 4 |
|
42 |
-The names of one or more YAML format files to run as ansible playbooks\&. |
|
43 |
-.RE |
|
44 |
-.SH "OPTIONS" |
|
45 |
-.PP |
|
46 |
-\fB\-k\fR, \fB\-\-ask\-pass\fR |
|
47 |
-.RS 4 |
|
48 |
-Prompt for the SSH password instead of assuming key\-based authentication with ssh\-agent\&. |
|
49 |
-.RE |
|
50 |
-.PP |
|
51 |
-\fB\-K\fR, \fB\-\-ask\-sudo\-pass\fR |
|
52 |
-.RS 4 |
|
53 |
-Prompt for the password to use for playbook plays that request sudo access, if any\&. |
|
54 |
-.RE |
|
55 |
-.PP |
|
56 |
-\fB\-b\fR, \fB\-\-become\fR |
|
57 |
-.RS 4 |
|
58 |
-Run operations with become (nopasswd implied) |
|
59 |
-.RE |
|
60 |
-.PP |
|
61 |
-\fB\-\-become\-method=BECOME_METHOD\fR |
|
62 |
-.RS 4 |
|
63 |
-Privilege escalation method to use (default=sudo), valid choices: [ sudo | su | pbrun | pfexec | runas | doas ] |
|
64 |
-.RE |
|
65 |
-.PP |
|
66 |
-\fB\-\-become\-user=BECOME_USER\fR |
|
67 |
-.RS 4 |
|
68 |
-Run operations as this user (default=None)\&. |
|
69 |
-.RE |
|
70 |
-.PP |
|
71 |
-\fB\-C\fR, \fB\-\-check\fR |
|
72 |
-.RS 4 |
|
73 |
-Do not make any changes on the remote system, but test resources to see what might have changed\&. Note this can not scan all possible resource types and is only a simulation\&. |
|
74 |
-.RE |
|
75 |
-.PP |
|
76 |
-\fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR |
|
77 |
-.RS 4 |
|
78 |
-Connection type to use\&. Possible options are |
|
79 |
-\fIparamiko\fR |
|
80 |
-(SSH), |
|
81 |
-\fIssh\fR, and |
|
82 |
-\fIlocal\fR\&. |
|
83 |
-\fIlocal\fR |
|
84 |
-is mostly useful for crontab or kickstarts\&. |
|
85 |
-.RE |
|
86 |
-.PP |
|
87 |
-\fB\-D\fR, \fB\-\-diff\fR |
|
88 |
-.RS 4 |
|
89 |
-When changing any templated files, show the unified diffs of how they changed\&. When used with \-\-check, shows how the files would have changed if \-\-check were not used\&. |
|
90 |
-.RE |
|
91 |
-.PP |
|
92 |
-\fB\-e\fR \fIVARS\fR, \fB\-\-extra\-vars=\fR\fIVARS\fR |
|
93 |
-.RS 4 |
|
94 |
-Extra variables to inject into a playbook, in key=value key=value format or as quoted JSON (hashes and arrays)\&. To load variables from a file, specify the file preceded by @ (e\&.g\&. @vars\&.yml)\&. |
|
95 |
-.RE |
|
96 |
-.PP |
|
97 |
-\fB\-\-flush\-cache\fR |
|
98 |
-.RS 4 |
|
99 |
-Clear the fact cache\&. |
|
100 |
-.RE |
|
101 |
-.PP |
|
102 |
-\fB\-\-force\-handlers\fR |
|
103 |
-.RS 4 |
|
104 |
-Run handlers even if a task fails\&. |
|
105 |
-.RE |
|
106 |
-.PP |
|
107 |
-\fB\-f\fR \fINUM\fR, \fB\-\-forks=\fR\fINUM\fR |
|
108 |
-.RS 4 |
|
109 |
-Level of parallelism\&. |
|
110 |
-\fINUM\fR |
|
111 |
-is specified as an integer, the default is 5\&. |
|
112 |
-.RE |
|
113 |
-.PP |
|
114 |
-\fB\-h\fR, \fB\-\-help\fR |
|
115 |
-.RS 4 |
|
116 |
-Show help page and exit |
|
117 |
-.RE |
|
118 |
-.PP |
|
119 |
-\fB\-i\fR \fIPATH\fR, \fB\-\-inventory=\fR\fIPATH\fR |
|
120 |
-.RS 4 |
|
121 |
-The |
|
122 |
-\fIPATH\fR |
|
123 |
-to the inventory hosts file, which defaults to |
|
124 |
-\fI/etc/ansible/hosts\fR\&. |
|
125 |
-.RE |
|
126 |
-.PP |
|
127 |
-\fB\-l\fR \fISUBSET\fR, \fB\-\-limit=\fR\fISUBSET\fR |
|
128 |
-.RS 4 |
|
129 |
-Further limits the selected host/group patterns\&. |
|
130 |
-.RE |
|
131 |
-.PP |
|
132 |
-\fB\-\-list\-hosts\fR |
|
133 |
-.RS 4 |
|
134 |
-Outputs a list of matching hosts; does not execute anything else\&. |
|
135 |
-.RE |
|
136 |
-.PP |
|
137 |
-\fB\-\-list\-tags\fR |
|
138 |
-.RS 4 |
|
139 |
-List all available tags\&. |
|
140 |
-.RE |
|
141 |
-.PP |
|
142 |
-\fB\-\-list\-tasks\fR |
|
143 |
-.RS 4 |
|
144 |
-List all tasks that would be executed |
|
145 |
-.RE |
|
146 |
-.PP |
|
147 |
-\fB\-M\fR \fIDIRECTORY\fR, \fB\-\-module\-path=\fR\fIDIRECTORY\fR |
|
148 |
-.RS 4 |
|
149 |
-The |
|
150 |
-\fIDIRECTORY\fR |
|
151 |
-search path to load modules from\&. The default is |
|
152 |
-\fI/usr/share/ansible\fR\&. This can also be set with the ANSIBLE_LIBRARY environment variable\&. |
|
153 |
-.RE |
|
154 |
-.PP |
|
155 |
-\fB\-\-private\-key=\fR\fIPRIVATE_KEY_FILE\fR |
|
156 |
-.RS 4 |
|
157 |
-Use this file to authenticate the connection |
|
158 |
-.RE |
|
159 |
-.PP |
|
160 |
-\fB\-\-skip\-tages=\fR\fISKIP_TAGS\fR |
|
161 |
-.RS 4 |
|
162 |
-Only run plays and tasks whose tags do not match these values\&. |
|
163 |
-.RE |
|
164 |
-.PP |
|
165 |
-\fB\-\-start\-at\-task=\fR\fISTART_AT\fR |
|
166 |
-.RS 4 |
|
167 |
-Start the playbook at the task matching this name\&. |
|
168 |
-.RE |
|
169 |
-.PP |
|
170 |
-\fB\-\-step\fR |
|
171 |
-.RS 4 |
|
172 |
-One\-step\-at\-a\-time: confirm each task before running\&. |
|
173 |
-.RE |
|
174 |
-.PP |
|
175 |
-\fB\-S\fR, \-\-su* |
|
176 |
-.RS 4 |
|
177 |
-Run operations with su (deprecated, use become) |
|
178 |
-.RE |
|
179 |
-.PP |
|
180 |
-\fB\-R SU\-USER\fR, \fB\-\-su\-user=\fR\fISU_USER\fR |
|
181 |
-.RS 4 |
|
182 |
-run operations with su as this user (default=root) (deprecated, use become) |
|
183 |
-.RE |
|
184 |
-.PP |
|
185 |
-\fB\-s\fR, \fB\-\-sudo\fR |
|
186 |
-.RS 4 |
|
187 |
-Run operations with sudo (nopasswd) (deprecated, use become) |
|
188 |
-.RE |
|
189 |
-.PP |
|
190 |
-\fB\-U\fR, \fISUDO_USER\fR, \fB\-\-sudo\-user=\fR\fISUDO_USER\fR |
|
191 |
-.RS 4 |
|
192 |
-Desired sudo user (default=root) (deprecated, use become)\&. |
|
193 |
-.RE |
|
194 |
-.PP |
|
195 |
-\fB\-\-skip\-tags=\fR\fISKIP_TAGS\fR |
|
196 |
-.RS 4 |
|
197 |
-Only run plays and tasks whose tags do not match these values\&. |
|
198 |
-.RE |
|
199 |
-.PP |
|
200 |
-\fB\-\-syntax\-check\fR |
|
201 |
-.RS 4 |
|
202 |
-Look for syntax errors in the playbook, but don\(cqt run anything |
|
203 |
-.RE |
|
204 |
-.PP |
|
205 |
-\fB\-t\fR, \fITAGS\fR, \fB\-\-tags=\fR\fITAGS\fR |
|
206 |
-.RS 4 |
|
207 |
-Only run plays and tasks tagged with these values\&. |
|
208 |
-.RE |
|
209 |
-.PP |
|
210 |
-\fB\-T\fR \fISECONDS\fR, \fB\-\-timeout=\fR\fISECONDS\fR |
|
211 |
-.RS 4 |
|
212 |
-Connection timeout to use when trying to talk to hosts, in |
|
213 |
-\fISECONDS\fR\&. |
|
214 |
-.RE |
|
215 |
-.PP |
|
216 |
-\fB\-u\fR \fIUSERNAME\fR, \fB\-\-user=\fR\fIUSERNAME\fR |
|
217 |
-.RS 4 |
|
218 |
-Use this remote user name on playbook steps that do not indicate a user name to run as\&. |
|
219 |
-.RE |
|
220 |
-.PP |
|
221 |
-\fB\-\-vault\-password\-file=\fR\fIVAULT_PASSWORD_FILE\fR |
|
222 |
-.RS 4 |
|
223 |
-Vault password file\&. |
|
224 |
-.RE |
|
225 |
-.PP |
|
226 |
-\fB\-v\fR, \fB\-\-verbose\fR |
|
227 |
-.RS 4 |
|
228 |
-Verbose mode, more output from successful actions will be shown\&. Give up to three times for more output\&. |
|
229 |
-.RE |
|
230 |
-.PP |
|
231 |
-\fB\-\-version\fR |
|
232 |
-.RS 4 |
|
233 |
-Show program\(cqs version number and exit\&. |
|
234 |
-.RE |
|
235 |
-.SH "ENVIRONMENT" |
|
236 |
-.sp |
|
237 |
-The following environment variables may be specified\&. |
|
238 |
-.sp |
|
239 |
-ANSIBLE_INVENTORY \(em Override the default ansible inventory file |
|
240 |
-.sp |
|
241 |
-ANSIBLE_LIBRARY \(em Override the default ansible module library path |
|
242 |
-.SH "FILES" |
|
243 |
-.sp |
|
244 |
-/etc/ansible/hosts \(em Default inventory file |
|
245 |
-.sp |
|
246 |
-/usr/share/ansible/ \(em Default module library |
|
247 |
-.sp |
|
248 |
-/etc/ansible/ansible\&.cfg \(em Config file, used if present |
|
249 |
-.sp |
|
250 |
-~/\&.ansible\&.cfg \(em User config file, overrides the default config if present |
|
251 |
-.SH "AUTHOR" |
|
252 |
-.sp |
|
253 |
-Ansible was originally written by Michael DeHaan\&. See the AUTHORS file for a complete list of contributors\&. |
|
254 |
-.SH "COPYRIGHT" |
|
255 |
-.sp |
|
256 |
-Copyright \(co 2012, Michael DeHaan |
|
257 |
-.sp |
|
258 |
-Ansible is released under the terms of the GPLv3 License\&. |
|
259 |
-.SH "SEE ALSO" |
|
260 |
-.sp |
|
261 |
-\fBansible\fR(1), \fBansible\-pull\fR(1), \fBansible\-doc\fR(1) |
|
262 |
-.sp |
|
263 |
-Extensive documentation is available in the documentation site: http://docs\&.ansible\&.com\&. IRC and mailing list info can be found in file CONTRIBUTING\&.md, available in: https://github\&.com/ansible/ansible |
|
264 |
-.SH "AUTHOR" |
|
265 |
-.PP |
|
266 |
-\fB:doctype:manpage\fR |
|
267 |
-.RS 4 |
|
268 |
-Author. |
|
269 |
-.RE |
... | ... |
@@ -34,28 +34,26 @@ The names of one or more YAML format files to run as ansible playbooks. |
34 | 34 |
OPTIONS |
35 | 35 |
------- |
36 | 36 |
|
37 |
-*-k*, *--ask-pass*:: |
|
37 |
+*--ask-become-pass*:: |
|
38 | 38 |
|
39 |
-Prompt for the SSH password instead of assuming key-based |
|
40 |
-authentication with ssh-agent. |
|
39 |
+Ask for privilege escalation password. |
|
41 | 40 |
|
42 |
-*-K*, *--ask-sudo-pass*:: |
|
41 |
+*-k*, *--ask-pass*:: |
|
43 | 42 |
|
44 |
-Prompt for the password to use for playbook plays that request sudo |
|
45 |
-access, if any. |
|
43 |
+Prompt for the connection password, if it is needed for the transport used. |
|
44 |
+For example, using ssh and not having a key-based authentication with ssh-agent. |
|
46 | 45 |
|
47 |
-*-b*, *--become*:: |
|
46 |
+*--ask-su-pass*:: |
|
48 | 47 |
|
49 |
-Run operations with become (nopasswd implied) |
|
48 |
+Prompt for su password, used with --su (deprecated, use become). |
|
50 | 49 |
|
51 |
-*--become-method=BECOME_METHOD*:: |
|
50 |
+*-K*, *--ask-sudo-pass*:: |
|
52 | 51 |
|
53 |
-Privilege escalation method to use (default=sudo), |
|
54 |
-valid choices: [ sudo | su | pbrun | pfexec | runas | doas ] |
|
52 |
+Prompt for the password to use with --sudo, if any (deprecated, use become). |
|
55 | 53 |
|
56 |
-*--become-user=BECOME_USER*:: |
|
54 |
+*--ask-vault-pass*:: |
|
57 | 55 |
|
58 |
-Run operations as this user (default=None). |
|
56 |
+Prompt for vault password. |
|
59 | 57 |
|
60 | 58 |
*-C*, *--check*:: |
61 | 59 |
|
... | ... |
@@ -65,7 +63,7 @@ a simulation. |
65 | 65 |
|
66 | 66 |
*-c* 'CONNECTION', *--connection=*'CONNECTION':: |
67 | 67 |
|
68 |
-Connection type to use. Possible options are 'paramiko' (SSH), 'ssh', |
|
68 |
+Connection type to use. Most common options are 'paramiko' (SSH), 'ssh', 'winrm' |
|
69 | 69 |
and 'local'. 'local' is mostly useful for crontab or kickstarts. |
70 | 70 |
|
71 | 71 |
*-D*, *--diff*:: |
... | ... |
@@ -73,10 +71,10 @@ and 'local'. 'local' is mostly useful for crontab or kickstarts. |
73 | 73 |
When changing any templated files, show the unified diffs of how they changed. When |
74 | 74 |
used with --check, shows how the files would have changed if --check were not used. |
75 | 75 |
|
76 |
-*-e* 'VARS', *--extra-vars=*'VARS':: |
|
76 |
+*-e* 'EXTRA_VARS', *--extra-vars=*'EXTRA_VARS':: |
|
77 | 77 |
|
78 | 78 |
Extra variables to inject into a playbook, in key=value key=value format or |
79 |
-as quoted JSON (hashes and arrays). To load variables from a file, specify |
|
79 |
+as quoted YAML/JSON (hashes and arrays). To load variables from a file, specify |
|
80 | 80 |
the file preceded by @ (e.g. @vars.yml). |
81 | 81 |
|
82 | 82 |
*--flush-cache*:: |
... | ... |
@@ -97,12 +95,13 @@ Show help page and exit |
97 | 97 |
|
98 | 98 |
*-i* 'PATH', *--inventory=*'PATH':: |
99 | 99 |
|
100 |
-The 'PATH' to the inventory hosts file, which defaults to |
|
101 |
-'/etc/ansible/hosts'. |
|
100 |
+The 'PATH' to the inventory, which defaults to '/etc/ansible/hosts'. |
|
101 |
+Alternatively you can use a comma separated list of hosts or single host with traling comma 'host,'. |
|
102 | 102 |
|
103 | 103 |
*-l* 'SUBSET', *--limit=*'SUBSET':: |
104 | 104 |
|
105 | 105 |
Further limits the selected host/group patterns. |
106 |
+You can prefix it with '~' to indicate that the patter in a regex. |
|
106 | 107 |
|
107 | 108 |
*--list-hosts*:: |
108 | 109 |
|
... | ... |
@@ -110,11 +109,11 @@ Outputs a list of matching hosts; does not execute anything else. |
110 | 110 |
|
111 | 111 |
*--list-tags*:: |
112 | 112 |
|
113 |
-List all available tags. |
|
113 |
+List all available tags; does not execute anything else. |
|
114 | 114 |
|
115 | 115 |
*--list-tasks*:: |
116 | 116 |
|
117 |
-List all tasks that would be executed |
|
117 |
+List all tasks that would be executed; does not execute anything else. |
|
118 | 118 |
|
119 | 119 |
*-M* 'DIRECTORY', *--module-path=*'DIRECTORY':: |
120 | 120 |
|
... | ... |
@@ -144,12 +143,11 @@ Run operations with su (deprecated, use become) |
144 | 144 |
|
145 | 145 |
*-R SU-USER*, *--su-user=*'SU_USER':: |
146 | 146 |
|
147 |
-run operations with su as this user (default=root) |
|
148 |
-(deprecated, use become) |
|
147 |
+run operations with su as this user (default=root) (deprecated, use become) |
|
149 | 148 |
|
150 | 149 |
*-s*, *--sudo*:: |
151 | 150 |
|
152 |
-Run operations with sudo (nopasswd) (deprecated, use become) |
|
151 |
+Run the command as the user given by -u and sudo to root (deprecated, use become). |
|
153 | 152 |
|
154 | 153 |
*--ssh-common-args=*''-o ProxyCommand="ssh -W %h:%p ..." ...'':: |
155 | 154 |
|
... | ... |
@@ -169,9 +167,9 @@ Add the specified arguments to any scp command-line. |
169 | 169 |
|
170 | 170 |
Add the specified arguments to any ssh command-line. |
171 | 171 |
|
172 |
-*-U*, 'SUDO_USER', *--sudo-user=*'SUDO_USER':: |
|
172 |
+*-U* 'SUDO_USERNAME', *--sudo-user=*'SUDO_USERNAME':: |
|
173 | 173 |
|
174 |
-Desired sudo user (default=root) (deprecated, use become). |
|
174 |
+Sudo to 'SUDO_USERNAME' deafult is root. (deprecated, use become). |
|
175 | 175 |
|
176 | 176 |
*--skip-tags=*'SKIP_TAGS':: |
177 | 177 |
|
... | ... |
@@ -191,8 +189,7 @@ Connection timeout to use when trying to talk to hosts, in 'SECONDS'. |
191 | 191 |
|
192 | 192 |
*-u* 'USERNAME', *--user=*'USERNAME':: |
193 | 193 |
|
194 |
-Use this remote user name on playbook steps that do not indicate a |
|
195 |
-user name to run as. |
|
194 |
+Use this 'USERNAME' to login to the target host, instead of the current user. |
|
196 | 195 |
|
197 | 196 |
*--vault-password-file=*'VAULT_PASSWORD_FILE':: |
198 | 197 |
|
... | ... |
@@ -207,6 +204,7 @@ up to three times for more output. |
207 | 207 |
|
208 | 208 |
Show program's version number and exit. |
209 | 209 |
|
210 |
+ |
|
210 | 211 |
ENVIRONMENT |
211 | 212 |
----------- |
212 | 213 |
|
... | ... |
@@ -216,6 +214,11 @@ ANSIBLE_INVENTORY -- Override the default ansible inventory file |
216 | 216 |
|
217 | 217 |
ANSIBLE_LIBRARY -- Override the default ansible module library path |
218 | 218 |
|
219 |
+ANSIBLE_CONFIG -- Override the default ansible config file |
|
220 |
+ |
|
221 |
+Many more are available for most options in ansible.cfg |
|
222 |
+ |
|
223 |
+ |
|
219 | 224 |
FILES |
220 | 225 |
----- |
221 | 226 |
|
... | ... |
@@ -227,6 +230,7 @@ FILES |
227 | 227 |
|
228 | 228 |
~/.ansible.cfg -- User config file, overrides the default config if present |
229 | 229 |
|
230 |
+ |
|
230 | 231 |
AUTHOR |
231 | 232 |
------ |
232 | 233 |
|
... | ... |
@@ -245,7 +249,7 @@ Ansible is released under the terms of the GPLv3 License. |
245 | 245 |
SEE ALSO |
246 | 246 |
-------- |
247 | 247 |
|
248 |
-*ansible*(1), *ansible-pull*(1), *ansible-doc*(1) |
|
248 |
+*ansible*(1), *ansible-pull*(1), *ansible-doc*(1), *ansible-vault*(1), *ansible-galaxy*(1) |
|
249 | 249 |
|
250 | 250 |
Extensive documentation is available in the documentation site: |
251 | 251 |
<http://docs.ansible.com>. IRC and mailing list info can be found |
252 | 252 |
deleted file mode 100644 |
... | ... |
@@ -1,159 +0,0 @@ |
1 |
-'\" t |
|
2 |
-.\" Title: ansible |
|
3 |
-.\" Author: :doctype:manpage |
|
4 |
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> |
|
5 |
-.\" Date: 07/22/2015 |
|
6 |
-.\" Manual: System administration commands |
|
7 |
-.\" Source: Ansible %VERSION% |
|
8 |
-.\" Language: English |
|
9 |
-.\" |
|
10 |
-.TH "ANSIBLE" "1" "07/22/2015" "Ansible %VERSION%" "System administration commands" |
|
11 |
-.\" ----------------------------------------------------------------- |
|
12 |
-.\" * Define some portability stuff |
|
13 |
-.\" ----------------------------------------------------------------- |
|
14 |
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
15 |
-.\" http://bugs.debian.org/507673 |
|
16 |
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
|
17 |
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
18 |
-.ie \n(.g .ds Aq \(aq |
|
19 |
-.el .ds Aq ' |
|
20 |
-.\" ----------------------------------------------------------------- |
|
21 |
-.\" * set default formatting |
|
22 |
-.\" ----------------------------------------------------------------- |
|
23 |
-.\" disable hyphenation |
|
24 |
-.nh |
|
25 |
-.\" disable justification (adjust text to left margin only) |
|
26 |
-.ad l |
|
27 |
-.\" ----------------------------------------------------------------- |
|
28 |
-.\" * MAIN CONTENT STARTS HERE * |
|
29 |
-.\" ----------------------------------------------------------------- |
|
30 |
-.SH "NAME" |
|
31 |
-ansible-pull \- set up a remote copy of ansible on each managed node |
|
32 |
-.SH "SYNOPSIS" |
|
33 |
-.sp |
|
34 |
-ansible\-pull \-d DEST \-U URL [options] [ <filename\&.yml> ] |
|
35 |
-.SH "DESCRIPTION" |
|
36 |
-.sp |
|
37 |
-\fBAnsible\fR is an extra\-simple tool/framework/API for doing \*(Aqremote things\*(Aq over SSH\&. |
|
38 |
-.sp |
|
39 |
-Use ansible\-pull to set up a remote copy of ansible on each managed node, each set to run via cron and update playbook source via a source repository\&. This inverts the default \fBpush\fR architecture of ansible into a \fBpull\fR architecture, which has near\-limitless scaling potential\&. |
|
40 |
-.sp |
|
41 |
-The setup playbook can be tuned to change the cron frequency, logging locations, and parameters to ansible\-pull\&. |
|
42 |
-.sp |
|
43 |
-This is useful both for extreme scale\-out as well as periodic remediation\&. Usage of the \fIfetch\fR module to retrieve logs from ansible\-pull runs would be an excellent way to gather and analyze remote logs from ansible\-pull\&. |
|
44 |
-.SH "OPTIONAL ARGUMENT" |
|
45 |
-.PP |
|
46 |
-\fBfilename\&.yml\fR |
|
47 |
-.RS 4 |
|
48 |
-The name of one the YAML format files to run as an ansible playbook\&. This can be a relative path within the checkout\&. If not provided, ansible\-pull will look for a playbook based on the host\(cqs fully\-qualified domain name, on the host hostname and finally a playbook named |
|
49 |
-\fBlocal\&.yml\fR\&. |
|
50 |
-.RE |
|
51 |
-.SH "OPTIONS" |
|
52 |
-.PP |
|
53 |
-\fB\-\-accept\-host\-key\fR |
|
54 |
-.RS 4 |
|
55 |
-Adds the hostkey for the repo URL if not already added\&. |
|
56 |
-.RE |
|
57 |
-.PP |
|
58 |
-\fB\-K\fR, \fB\-\-ask\-sudo\-pass\fR |
|
59 |
-.RS 4 |
|
60 |
-Ask for sudo password\&. |
|
61 |
-.RE |
|
62 |
-.PP |
|
63 |
-\fB\-C\fR \fICHECKOUT\fR, \fB\-\-checkout=\fR\fICHECKOUT\fR |
|
64 |
-.RS 4 |
|
65 |
-Branch/Tag/Commit to checkout\&. If not provided, uses default behavior of module used to check out playbook repository\&. |
|
66 |
-.RE |
|
67 |
-.PP |
|
68 |
-\fB\-d\fR \fIDEST\fR, \fB\-\-directory=\fR\fIDEST\fR |
|
69 |
-.RS 4 |
|
70 |
-Directory to checkout repository into\&. If not provided, a subdirectory of ~/\&.ansible/pull/ will be used\&. |
|
71 |
-.RE |
|
72 |
-.PP |
|
73 |
-\fB\-e\fR \fIEXTRA_VARS\fR, \fB\-\-extra\-vars=\fR\*(AqEXTRA_VARS* |
|
74 |
-.RS 4 |
|
75 |
-Set additional variables as key=value or YAML/JSON |
|
76 |
-.RE |
|
77 |
-.PP |
|
78 |
-\fB\-f\fR, \fB\-\-force\fR |
|
79 |
-.RS 4 |
|
80 |
-Force running of playbook even if unable to update playbook repository\&. This can be useful, for example, to enforce run\-time state when a network connection may not always be up or possible\&. |
|
81 |
-.RE |
|
82 |
-.PP |
|
83 |
-\fB\-h\fR, \fB\-\-help\fR |
|
84 |
-.RS 4 |
|
85 |
-Show the help message and exit\&. |
|
86 |
-.RE |
|
87 |
-.PP |
|
88 |
-\fB\-i\fR \fIPATH\fR, \fB\-\-inventory=\fR\fIPATH\fR |
|
89 |
-.RS 4 |
|
90 |
-The |
|
91 |
-\fIPATH\fR |
|
92 |
-to the inventory hosts file\&. This can be a relative path within the checkout\&. |
|
93 |
-.RE |
|
94 |
-.PP |
|
95 |
-\fB\-\-key\-file=\fR\fIKEYFILE\fR |
|
96 |
-.RS 4 |
|
97 |
-Pass |
|
98 |
-\fI\-i <key_file>\fR |
|
99 |
-to the SSH arguments used by git\&. |
|
100 |
-.RE |
|
101 |
-.PP |
|
102 |
-\fB\-m\fR \fINAME\fR, \fB\-\-module\-name=\fR\fINAME\fR |
|
103 |
-.RS 4 |
|
104 |
-Module used to checkout playbook repository\&. Defaults to git\&. |
|
105 |
-.RE |
|
106 |
-.PP |
|
107 |
-\fB\-o\fR, \fB\-\-only\-if\-changed\fR |
|
108 |
-.RS 4 |
|
109 |
-Only run the playbook if the repository has been updated\&. |
|
110 |
-.RE |
|
111 |
-.PP |
|
112 |
-\fB\-\-purge\fR |
|
113 |
-.RS 4 |
|
114 |
-Purge the checkout after the playbook is run\&. |
|
115 |
-.RE |
|
116 |
-.PP |
|
117 |
-\fB\-s\fR \fISLEEP\fR, \fB\-\-sleep=\fR\fISLEEP\fR |
|
118 |
-.RS 4 |
|
119 |
-Sleep for random interval (between 0 and SLEEP number of seconds) before starting\&. This is a useful way ot disperse git requests\&. |
|
120 |
-.RE |
|
121 |
-.PP |
|
122 |
-\fB\-t\fR \fITAGS\fR, \fB\-\-tags=\fR\fITAGS\fR |
|
123 |
-.RS 4 |
|
124 |
-Only run plays and tasks tagged with these values\&. |
|
125 |
-.RE |
|
126 |
-.PP |
|
127 |
-\fB\-U\fR \fIURL\fR, \fB\-\-url=\fR\fIURL\fR |
|
128 |
-.RS 4 |
|
129 |
-URL of the playbook repository to checkout\&. |
|
130 |
-.RE |
|
131 |
-.PP |
|
132 |
-\fB\-\-vault\-password\-file=\fR\fIVAULT_PASSWORD_FILE\fR |
|
133 |
-.RS 4 |
|
134 |
-Vault password file\&. |
|
135 |
-.RE |
|
136 |
-.PP |
|
137 |
-\fB\-v\fR, \fB\-\-verbose\fR |
|
138 |
-.RS 4 |
|
139 |
-Pass \-vvv to ansible\-playbook\&. |
|
140 |
-.RE |
|
141 |
-.SH "AUTHOR" |
|
142 |
-.sp |
|
143 |
-Ansible was originally written by Michael DeHaan\&. See the AUTHORS file for a complete list of contributors\&. |
|
144 |
-.SH "COPYRIGHT" |
|
145 |
-.sp |
|
146 |
-Copyright \(co 2012, Michael DeHaan |
|
147 |
-.sp |
|
148 |
-Ansible is released under the terms of the GPLv3 License\&. |
|
149 |
-.SH "SEE ALSO" |
|
150 |
-.sp |
|
151 |
-\fBansible\fR(1), \fBansible\-playbook\fR(1), \fBansible\-doc\fR(1) |
|
152 |
-.sp |
|
153 |
-Extensive documentation is available in the documentation site: http://docs\&.ansible\&.com\&. IRC and mailing list info can be found in file CONTRIBUTING\&.md, available in: https://github\&.com/ansible/ansible |
|
154 |
-.SH "AUTHOR" |
|
155 |
-.PP |
|
156 |
-\fB:doctype:manpage\fR |
|
157 |
-.RS 4 |
|
158 |
-Author. |
|
159 |
-.RE |
... | ... |
@@ -5,9 +5,10 @@ ansible(1) |
5 | 5 |
:man version: %VERSION% |
6 | 6 |
:man manual: System administration commands |
7 | 7 |
|
8 |
+ |
|
8 | 9 |
NAME |
9 | 10 |
---- |
10 |
-ansible-pull - set up a remote copy of ansible on each managed node |
|
11 |
+ansible-pull - pull playbooks from VCS server and run them using this machine as the target. |
|
11 | 12 |
|
12 | 13 |
|
13 | 14 |
SYNOPSIS |
... | ... |
@@ -18,8 +19,7 @@ ansible-pull -d DEST -U URL [options] [ <filename.yml> ] |
18 | 18 |
DESCRIPTION |
19 | 19 |
----------- |
20 | 20 |
|
21 |
-*Ansible* is an extra-simple tool/framework/API for doing \'remote things' over |
|
22 |
-SSH. |
|
21 |
+*Ansible* is an extra-simple tool/framework/API for doing \'remote things'. |
|
23 | 22 |
|
24 | 23 |
Use ansible-pull to set up a remote copy of ansible on each managed |
25 | 24 |
node, each set to run via cron and update playbook source via |
... | ... |
@@ -54,22 +54,40 @@ OPTIONS |
54 | 54 |
|
55 | 55 |
Adds the hostkey for the repo URL if not already added. |
56 | 56 |
|
57 |
+*--ask-become-pass*:: |
|
58 |
+ |
|
59 |
+Ask for privilege escalation password. |
|
60 |
+ |
|
61 |
+*-k*, *--ask-pass*:: |
|
62 |
+ |
|
63 |
+Prompt for the connection password, if it is needed for the transport used. |
|
64 |
+For example, using ssh and not having a key-based authentication with ssh-agent. |
|
65 |
+ |
|
66 |
+*--ask-su-pass*:: |
|
67 |
+ |
|
68 |
+Prompt for su password, used with --su (deprecated, use become). |
|
69 |
+ |
|
57 | 70 |
*-K*, *--ask-sudo-pass*:: |
58 | 71 |
|
59 |
-Ask for sudo password. |
|
60 |
- |
|
72 |
+Prompt for the password to use with --sudo, if any (deprecated, use become). |
|
73 |
+ |
|
74 |
+*--ask-vault-pass*:: |
|
75 |
+ |
|
76 |
+Prompt for vault password. |
|
77 |
+ |
|
61 | 78 |
*-C* 'CHECKOUT', *--checkout=*'CHECKOUT':: |
62 | 79 |
|
63 | 80 |
Branch/Tag/Commit to checkout. If not provided, uses default behavior of module used to check out playbook repository. |
64 | 81 |
|
65 | 82 |
*-d* 'DEST', *--directory=*'DEST':: |
66 | 83 |
|
67 |
-Directory to checkout repository into. If not provided, a subdirectory of |
|
68 |
-~/.ansible/pull/ will be used. |
|
84 |
+Directory to checkout repository into. If not provided, a subdirectory of ~/.ansible/pull/ will be used. |
|
69 | 85 |
|
70 |
-*-e* 'EXTRA_VARS', *--extra-vars=*'EXTRA_VARS*:: |
|
86 |
+*-e* 'EXTRA_VARS', *--extra-vars=*'EXTRA_VARS:: |
|
71 | 87 |
|
72 |
-Set additional variables as key=value or YAML/JSON |
|
88 |
+Extra variables to inject into a playbook, in key=value key=value format or |
|
89 |
+as quoted YAML/JSON (hashes and arrays). To load variables from a file, specify |
|
90 |
+the file preceded by @ (e.g. @vars.yml). |
|
73 | 91 |
|
74 | 92 |
*-f*, *--force*:: |
75 | 93 |
|
... | ... |
@@ -83,11 +101,12 @@ Show the help message and exit. |
83 | 83 |
|
84 | 84 |
*-i* 'PATH', *--inventory=*'PATH':: |
85 | 85 |
|
86 |
-The 'PATH' to the inventory hosts file. This can be a relative path within the checkout. |
|
86 |
+The 'PATH' to the inventory, which defaults to '/etc/ansible/hosts'. |
|
87 |
+Alternatively you can use a comma separated list of hosts or single host with traling comma 'host,'. |
|
87 | 88 |
|
88 |
-*--key-file=*'KEYFILE':: |
|
89 |
+*--private-key=*'PRIVATE_KEY_FILE':: |
|
89 | 90 |
|
90 |
-Pass '-i <key_file>' to the SSH arguments used by git. |
|
91 |
+Use this file to authenticate the connection. |
|
91 | 92 |
|
92 | 93 |
*-m* 'NAME', *--module-name=*'NAME':: |
93 | 94 |
|
... | ... |
@@ -140,25 +159,62 @@ Vault password file. |
140 | 140 |
Pass -vvv to ansible-playbook. |
141 | 141 |
|
142 | 142 |
|
143 |
+INVENTORY |
|
144 |
+--------- |
|
145 |
+ |
|
146 |
+Ansible stores the hosts it can potentially operate on in an inventory. |
|
147 |
+This can be an ini-like file, a script, directory or a list. |
|
148 |
+The ini syntax is one host per line. Groups headers are allowed and |
|
149 |
+are included on their own line, enclosed in square brackets that start the line. |
|
150 |
+ |
|
151 |
+Ranges of hosts are also supported. For more information and |
|
152 |
+additional options, see the documentation on http://docs.ansible.com/. |
|
153 |
+ |
|
154 |
+ |
|
155 |
+ENVIRONMENT |
|
156 |
+----------- |
|
157 |
+ |
|
158 |
+The following environment variables may be specified. |
|
159 |
+ |
|
160 |
+ANSIBLE_INVENTORY -- Override the default ansible inventory file |
|
161 |
+ |
|
162 |
+ANSIBLE_LIBRARY -- Override the default ansible module library path |
|
163 |
+ |
|
164 |
+ANSIBLE_CONFIG -- Override the default ansible config file |
|
165 |
+ |
|
166 |
+Many more are available for most options in ansible.cfg |
|
167 |
+ |
|
168 |
+ |
|
169 |
+FILES |
|
170 |
+----- |
|
171 |
+ |
|
172 |
+/etc/ansible/hosts -- Default inventory file |
|
173 |
+ |
|
174 |
+/usr/share/ansible/ -- Default module library |
|
175 |
+ |
|
176 |
+/etc/ansible/ansible.cfg -- Config file, used if present |
|
177 |
+ |
|
178 |
+~/.ansible.cfg -- User config file, overrides the default config if present |
|
179 |
+ |
|
180 |
+ |
|
143 | 181 |
AUTHOR |
144 | 182 |
------ |
145 | 183 |
|
146 |
-Ansible was originally written by Michael DeHaan. See the AUTHORS file |
|
147 |
-for a complete list of contributors. |
|
184 |
+Ansible was originally written by Michael DeHaan. |
|
185 |
+See the AUTHORS file for a complete list of contributors. |
|
148 | 186 |
|
149 | 187 |
|
150 | 188 |
COPYRIGHT |
151 | 189 |
--------- |
152 | 190 |
|
153 | 191 |
Copyright © 2012, Michael DeHaan |
154 |
- |
|
155 | 192 |
Ansible is released under the terms of the GPLv3 License. |
156 | 193 |
|
157 | 194 |
|
158 | 195 |
SEE ALSO |
159 | 196 |
-------- |
160 | 197 |
|
161 |
-*ansible*(1), *ansible-playbook*(1), *ansible-doc*(1) |
|
198 |
+*ansible*(1) *ansible-playbook*(1), *ansible-doc*(1), *ansible-vault*(1), *ansible-galaxy*(1) |
|
162 | 199 |
|
163 | 200 |
Extensive documentation is available in the documentation site: |
164 | 201 |
<http://docs.ansible.com>. IRC and mailing list info can be found |
165 | 202 |
deleted file mode 100644 |
... | ... |
@@ -1,124 +0,0 @@ |
1 |
-'\" t |
|
2 |
-.\" Title: ansible-vault |
|
3 |
-.\" Author: [see the "AUTHOR" section] |
|
4 |
-.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> |
|
5 |
-.\" Date: 08/27/2015 |
|
6 |
-.\" Manual: System administration commands |
|
7 |
-.\" Source: Ansible 2.0.0 |
|
8 |
-.\" Language: English |
|
9 |
-.\" |
|
10 |
-.TH "ANSIBLE\-VAULT" "1" "08/27/2015" "Ansible 2\&.0\&.0" "System administration commands" |
|
11 |
-.\" ----------------------------------------------------------------- |
|
12 |
-.\" * Define some portability stuff |
|
13 |
-.\" ----------------------------------------------------------------- |
|
14 |
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
15 |
-.\" http://bugs.debian.org/507673 |
|
16 |
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
|
17 |
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
18 |
-.ie \n(.g .ds Aq \(aq |
|
19 |
-.el .ds Aq ' |
|
20 |
-.\" ----------------------------------------------------------------- |
|
21 |
-.\" * set default formatting |
|
22 |
-.\" ----------------------------------------------------------------- |
|
23 |
-.\" disable hyphenation |
|
24 |
-.nh |
|
25 |
-.\" disable justification (adjust text to left margin only) |
|
26 |
-.ad l |
|
27 |
-.\" ----------------------------------------------------------------- |
|
28 |
-.\" * MAIN CONTENT STARTS HERE * |
|
29 |
-.\" ----------------------------------------------------------------- |
|
30 |
-.SH "NAME" |
|
31 |
-ansible-vault \- manage encrypted YAML data\&. |
|
32 |
-.SH "SYNOPSIS" |
|
33 |
-.sp |
|
34 |
-ansible\-vault [create|decrypt|edit|encrypt|rekey] [\-\-help] [options] file_name |
|
35 |
-.SH "DESCRIPTION" |
|
36 |
-.sp |
|
37 |
-\fBansible\-vault\fR can encrypt any structured data file used by Ansible\&. This can include \fBgroup_vars/\fR or \fBhost_vars/\fR inventory variables, variables loaded by \fBinclude_vars\fR or \fBvars_files\fR, or variable files passed on the ansible\-playbook command line with \fB\-e @file\&.yml\fR or \fB\-e @file\&.json\fR\&. Role variables and defaults are also included! |
|
38 |
-.sp |
|
39 |
-Because Ansible tasks, handlers, and so on are also data, these can also be encrypted with vault\&. If you\(cqd like to not betray what variables you are even using, you can go as far to keep an individual task file entirely encrypted\&. |
|
40 |
-.SH "COMMON OPTIONS" |
|
41 |
-.sp |
|
42 |
-The following options are available to all sub\-commands: |
|
43 |
-.PP |
|
44 |
-\fB\-\-vault\-password\-file=\fR\fIFILE\fR |
|
45 |
-.RS 4 |
|
46 |
-A file containing the vault password to be used during the encryption/decryption steps\&. Be sure to keep this file secured if it is used\&. If the file is executable, it will be run and its standard output will be used as the password\&. |
|
47 |
-.RE |
|
48 |
-.PP |
|
49 |
-\fB\-\-new\-vault\-password\-file=\fR\fIFILE\fR |
|
50 |
-.RS 4 |
|
51 |
-A file containing the new vault password to be used when rekeying a file\&. Be sure to keep this file secured if it is used\&. If the file is executable, it will be run and its standard output will be used as the password\&. |
|
52 |
-.RE |
|
53 |
-.PP |
|
54 |
-\fB\-h\fR, \fB\-\-help\fR |
|
55 |
-.RS 4 |
|
56 |
-Show a help message related to the given sub\-command\&. |
|
57 |
-.RE |
|
58 |
-.PP |
|
59 |
-\fB\-\-debug\fR |
|
60 |
-.RS 4 |
|
61 |
-Enable debugging output for troubleshooting\&. |
|
62 |
-.RE |
|
63 |
-.SH "CREATE" |
|
64 |
-.sp |
|
65 |
-\fB$ ansible\-vault create [options] FILE\fR |
|
66 |
-.sp |
|
67 |
-The \fBcreate\fR sub\-command is used to initialize a new encrypted file\&. |
|
68 |
-.sp |
|
69 |
-First you will be prompted for a password\&. The password used with vault currently must be the same for all files you wish to use together at the same time\&. |
|
70 |
-.sp |
|
71 |
-After providing a password, the tool will launch whatever editor you have defined with $EDITOR, and defaults to vim\&. Once you are done with the editor session, the file will be saved as encrypted data\&. |
|
72 |
-.sp |
|
73 |
-The default cipher is AES (which is shared\-secret based)\&. |
|
74 |
-.SH "EDIT" |
|
75 |
-.sp |
|
76 |
-\fB$ ansible\-vault edit [options] FILE\fR |
|
77 |
-.sp |
|
78 |
-The \fBedit\fR sub\-command is used to modify a file which was previously encrypted using ansible\-vault\&. |
|
79 |
-.sp |
|
80 |
-This command will decrypt the file to a temporary file and allow you to edit the file, saving it back when done and removing the temporary file\&. |
|
81 |
-.SH "REKEY" |
|
82 |
-.sp |
|
83 |
-\fB$ ansible\-vault rekey [options] FILE_1 [FILE_2, \&..., FILE_N]\fR |
|
84 |
-.sp |
|
85 |
-The \fBrekey\fR command is used to change the password on a vault\-encrypted files\&. This command can update multiple files at once, and will prompt for both the old and new passwords before modifying any data\&. |
|
86 |
-.SH "ENCRYPT" |
|
87 |
-.sp |
|
88 |
-\fB$ ansible\-vault encrypt [options] FILE_1 [FILE_2, \&..., FILE_N]\fR |
|
89 |
-.sp |
|
90 |
-The \fBencrypt\fR sub\-command is used to encrypt pre\-existing data files\&. As with the \fBrekey\fR command, you can specify multiple files in one command\&. |
|
91 |
-.sp |
|
92 |
-Starting with version 2\&.0, the \fBencrypt\fR command accepts an \fB\-\-output FILENAME\fR option to determine where encrypted output is stored\&. With this option, input is read from the (at most one) filename given on the command line; if no input file is given, input is read from stdin\&. Either the input or the output file may be given as \fI\-\fR for stdin and stdout respectively\&. If neither input nor output file is given, the command acts as a filter, reading plaintext from stdin and writing it to stdout\&. |
|
93 |
-.sp |
|
94 |
-Thus any of the following invocations can be used: |
|
95 |
-.sp |
|
96 |
-\fB$ ansible\-vault encrypt\fR |
|
97 |
-.sp |
|
98 |
-\fB$ ansible\-vault encrypt \-\-output OUTFILE\fR |
|
99 |
-.sp |
|
100 |
-\fB$ ansible\-vault encrypt INFILE \-\-output OUTFILE\fR |
|
101 |
-.sp |
|
102 |
-\fB$ echo secret|ansible\-vault encrypt \-\-output OUTFILE\fR |
|
103 |
-.sp |
|
104 |
-Reading from stdin and writing only encrypted output is a good way to prevent sensitive data from ever hitting disk (either interactively or from a script)\&. |
|
105 |
-.SH "DECRYPT" |
|
106 |
-.sp |
|
107 |
-\fB$ ansible\-vault decrypt [options] FILE_1 [FILE_2, \&..., FILE_N]\fR |
|
108 |
-.sp |
|
109 |
-The \fBdecrypt\fR sub\-command is used to remove all encryption from data files\&. The files will be stored as plain\-text YAML once again, so be sure that you do not run this command on data files with active passwords or other sensitive data\&. In most cases, users will want to use the \fBedit\fR sub\-command to modify the files securely\&. |
|
110 |
-.sp |
|
111 |
-As with \fBencrypt\fR, the \fBdecrypt\fR subcommand also accepts the \fB\-\-output FILENAME\fR option to specify where plaintext output is stored, and stdin/stdout is handled as described above\&. |
|
112 |
-.SH "AUTHOR" |
|
113 |
-.sp |
|
114 |
-Ansible was originally written by Michael DeHaan\&. See the AUTHORS file for a complete list of contributors\&. |
|
115 |
-.SH "COPYRIGHT" |
|
116 |
-.sp |
|
117 |
-Copyright \(co 2014, Michael DeHaan |
|
118 |
-.sp |
|
119 |
-Ansible is released under the terms of the GPLv3 License\&. |
|
120 |
-.SH "SEE ALSO" |
|
121 |
-.sp |
|
122 |
-\fBansible\fR(1), \fBansible\-pull\fR(1), \fBansible\-doc\fR(1) |
|
123 |
-.sp |
|
124 |
-Extensive documentation is available in the documentation site: http://docs\&.ansible\&.com\&. IRC and mailing list info can be found in file CONTRIBUTING\&.md, available in: https://github\&.com/ansible/ansible |
... | ... |
@@ -7,7 +7,7 @@ ansible-vault(1) |
7 | 7 |
|
8 | 8 |
NAME |
9 | 9 |
---- |
10 |
-ansible-vault - manage encrypted YAML data. |
|
10 |
+ansible-vault - manage encrypted ansible vars files (YAML). |
|
11 | 11 |
|
12 | 12 |
|
13 | 13 |
SYNOPSIS |
... | ... |
@@ -18,15 +18,16 @@ ansible-vault [create|decrypt|edit|encrypt|rekey] [--help] [options] file_name |
18 | 18 |
DESCRIPTION |
19 | 19 |
----------- |
20 | 20 |
|
21 |
-*ansible-vault* can encrypt any structured data file used by Ansible. This can include |
|
22 |
-*group_vars/* or *host_vars/* inventory variables, variables loaded by *include_vars* or |
|
23 |
-*vars_files*, or variable files passed on the ansible-playbook command line with |
|
24 |
-*-e @file.yml* or *-e @file.json*. Role variables and defaults are also included! |
|
21 |
+*ansible-vault* can encrypt any structured data file used by Ansible. |
|
22 |
+This can include *group_vars/* or *host_vars/* inventory variables, |
|
23 |
+variables loaded by *include_vars* or *vars_files*, or variable files |
|
24 |
+passed on the ansible-playbook command line with *-e @file.yml* or *-e @file.json*. |
|
25 |
+Role variables and defaults are also included! |
|
25 | 26 |
|
26 |
-Because Ansible tasks, handlers, and so on are also data, these can also be encrypted with |
|
27 |
-vault. If you’d like to not betray what variables you are even using, you can go as far to |
|
28 |
-keep an individual task file entirely encrypted. |
|
27 |
+Because Ansible tasks, handlers, and so on are also data, these can also be encrypted with vault. |
|
28 |
+If you’d like to not betray what variables you are even using, you can go as far to keep an individual task file entirely encrypted. |
|
29 | 29 |
|
30 |
+The password used with vault currently must be the same for all files you wish to use together at the same time. |
|
30 | 31 |
|
31 | 32 |
COMMON OPTIONS |
32 | 33 |
-------------- |
... | ... |
@@ -50,22 +51,19 @@ the password. |
50 | 50 |
|
51 | 51 |
Show a help message related to the given sub-command. |
52 | 52 |
|
53 |
-*--debug*:: |
|
54 | 53 |
|
55 |
-Enable debugging output for troubleshooting. |
|
54 |
+If '--valut-password-file' is not supplied ansib-vault will automatically prompt for passwords as required. |
|
55 |
+ |
|
56 | 56 |
|
57 | 57 |
CREATE |
58 | 58 |
------ |
59 | 59 |
|
60 | 60 |
*$ ansible-vault create [options] FILE* |
61 | 61 |
|
62 |
-The *create* sub-command is used to initialize a new encrypted file. |
|
63 |
- |
|
64 |
-First you will be prompted for a password. The password used with vault currently |
|
65 |
-must be the same for all files you wish to use together at the same time. |
|
62 |
+The *create* sub-command is used to initialize a new encrypted file. |
|
66 | 63 |
|
67 |
-After providing a password, the tool will launch whatever editor you have defined |
|
68 |
-with $EDITOR, and defaults to vim. Once you are done with the editor session, the |
|
64 |
+After providing a password, the tool will launch whatever editor you have defined |
|
65 |
+with $EDITOR, and defaults to vim. Once you are done with the editor session, the |
|
69 | 66 |
file will be saved as encrypted data. |
70 | 67 |
|
71 | 68 |
The default cipher is AES (which is shared-secret based). |
... | ... |
@@ -75,11 +73,11 @@ EDIT |
75 | 75 |
|
76 | 76 |
*$ ansible-vault edit [options] FILE* |
77 | 77 |
|
78 |
-The *edit* sub-command is used to modify a file which was previously encrypted |
|
79 |
-using ansible-vault. |
|
78 |
+The *edit* sub-command is used to modify a file which was previously encrypted using ansible-vault. |
|
79 |
+ |
|
80 |
+This command will decrypt the file to a temporary file and allow you to edit the file, |
|
81 |
+saving it back when done and removing the temporary file. |
|
80 | 82 |
|
81 |
-This command will decrypt the file to a temporary file and allow you to edit the |
|
82 |
-file, saving it back when done and removing the temporary file. |
|
83 | 83 |
|
84 | 84 |
REKEY |
85 | 85 |
----- |
... | ... |
@@ -87,24 +85,23 @@ REKEY |
87 | 87 |
*$ ansible-vault rekey [options] FILE_1 [FILE_2, ..., FILE_N]* |
88 | 88 |
|
89 | 89 |
The *rekey* command is used to change the password on a vault-encrypted files. |
90 |
-This command can update multiple files at once, and will prompt for both the |
|
91 |
-old and new passwords before modifying any data. |
|
90 |
+This command can update multiple files at once. |
|
91 |
+ |
|
92 | 92 |
|
93 | 93 |
ENCRYPT |
94 | 94 |
------- |
95 | 95 |
|
96 | 96 |
*$ ansible-vault encrypt [options] FILE_1 [FILE_2, ..., FILE_N]* |
97 | 97 |
|
98 |
-The *encrypt* sub-command is used to encrypt pre-existing data files. As with the |
|
99 |
-*rekey* command, you can specify multiple files in one command. |
|
98 |
+The *encrypt* sub-command is used to encrypt pre-existing data files. |
|
99 |
+As with the *rekey* command, you can specify multiple files in one command. |
|
100 | 100 |
|
101 |
-Starting with version 2.0, the *encrypt* command accepts an *--output FILENAME* |
|
102 |
-option to determine where encrypted output is stored. With this option, input is |
|
103 |
-read from the (at most one) filename given on the command line; if no input file |
|
104 |
-is given, input is read from stdin. Either the input or the output file may be |
|
105 |
-given as '-' for stdin and stdout respectively. If neither input nor output file |
|
106 |
-is given, the command acts as a filter, reading plaintext from stdin and writing |
|
107 |
-it to stdout. |
|
101 |
+The *encrypt* command accepts an *--output FILENAME* option to determine where |
|
102 |
+encrypted output is stored. With this option, input is read from the (at most one) |
|
103 |
+filename given on the command line; if no input file is given, input is read from stdin. |
|
104 |
+Either the input or the output file may be given as '-' for stdin and stdout respectively. |
|
105 |
+If neither input nor output file is given, the command acts as a filter, |
|
106 |
+reading plaintext from stdin and writing it to stdout. |
|
108 | 107 |
|
109 | 108 |
Thus any of the following invocations can be used: |
110 | 109 |
|
... | ... |
@@ -124,10 +121,10 @@ DECRYPT |
124 | 124 |
|
125 | 125 |
*$ ansible-vault decrypt [options] FILE_1 [FILE_2, ..., FILE_N]* |
126 | 126 |
|
127 |
-The *decrypt* sub-command is used to remove all encryption from data files. The files |
|
128 |
-will be stored as plain-text YAML once again, so be sure that you do not run this |
|
129 |
-command on data files with active passwords or other sensitive data. In most cases, |
|
130 |
-users will want to use the *edit* sub-command to modify the files securely. |
|
127 |
+The *decrypt* sub-command is used to remove all encryption from data files. |
|
128 |
+The files will be stored as plain-text YAML once again, so be sure that you do not run this |
|
129 |
+command on data files with active passwords or other sensitive data. |
|
130 |
+In most cases, users will want to use the *edit* sub-command to modify the files securely. |
|
131 | 131 |
|
132 | 132 |
As with *encrypt*, the *decrypt* subcommand also accepts the *--output FILENAME* |
133 | 133 |
option to specify where plaintext output is stored, and stdin/stdout is handled |
... | ... |
@@ -151,7 +148,7 @@ Ansible is released under the terms of the GPLv3 License. |
151 | 151 |
SEE ALSO |
152 | 152 |
-------- |
153 | 153 |
|
154 |
-*ansible*(1), *ansible-pull*(1), *ansible-doc*(1) |
|
154 |
+*ansible*(1), *ansible-pull*(1), *ansible-doc*(1), *ansible-playbook*(1), *ansible-galaxy*(1) |
|
155 | 155 |
|
156 | 156 |
Extensive documentation is available in the documentation site: |
157 | 157 |
<http://docs.ansible.com>. IRC and mailing list info can be found |
158 | 158 |
deleted file mode 100644 |
... | ... |
@@ -1,279 +0,0 @@ |
1 |
-'\" t |
|
2 |
-.\" Title: ansible |
|
3 |
-.\" Author: :doctype:manpage |
|
4 |
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> |
|
5 |
-.\" Date: 07/15/2015 |
|
6 |
-.\" Manual: System administration commands |
|
7 |
-.\" Source: Ansible %VERSION% |
|
8 |
-.\" Language: English |
|
9 |
-.\" |
|
10 |
-.TH "ANSIBLE" "1" "07/15/2015" "Ansible %VERSION%" "System administration commands" |
|
11 |
-.\" ----------------------------------------------------------------- |
|
12 |
-.\" * Define some portability stuff |
|
13 |
-.\" ----------------------------------------------------------------- |
|
14 |
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
15 |
-.\" http://bugs.debian.org/507673 |
|
16 |
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
|
17 |
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
18 |
-.ie \n(.g .ds Aq \(aq |
|
19 |
-.el .ds Aq ' |
|
20 |
-.\" ----------------------------------------------------------------- |
|
21 |
-.\" * set default formatting |
|
22 |
-.\" ----------------------------------------------------------------- |
|
23 |
-.\" disable hyphenation |
|
24 |
-.nh |
|
25 |
-.\" disable justification (adjust text to left margin only) |
|
26 |
-.ad l |
|
27 |
-.\" ----------------------------------------------------------------- |
|
28 |
-.\" * MAIN CONTENT STARTS HERE * |
|
29 |
-.\" ----------------------------------------------------------------- |
|
30 |
-.SH "NAME" |
|
31 |
-ansible \- run a command somewhere else |
|
32 |
-.SH "SYNOPSIS" |
|
33 |
-.sp |
|
34 |
-ansible <host\-pattern> [\-f forks] [\-m module_name] [\-a args] |
|
35 |
-.SH "DESCRIPTION" |
|
36 |
-.sp |
|
37 |
-\fBAnsible\fR is an extra\-simple tool/framework/API for doing \*(Aqremote things\*(Aq over SSH\&. |
|
38 |
-.SH "ARGUMENTS" |
|
39 |
-.PP |
|
40 |
-\fBhost\-pattern\fR |
|
41 |
-.RS 4 |
|
42 |
-A name of a group in the inventory file, a shell\-like glob selecting hosts in inventory file, or any combination of the two separated by semicolons\&. |
|
43 |
-.RE |
|
44 |
-.SH "OPTIONS" |
|
45 |
-.PP |
|
46 |
-\fB\-a\fR \*(Aq\fIARGUMENTS\fR\*(Aq, \fB\-\-args=\fR\*(Aq\fIARGUMENTS\fR\*(Aq |
|
47 |
-.RS 4 |
|
48 |
-The |
|
49 |
-\fIARGUMENTS\fR |
|
50 |
-to pass to the module\&. |
|
51 |
-.RE |
|
52 |
-.PP |
|
53 |
-\fB\-\-ask\-become\-pass\fR |
|
54 |
-.RS 4 |
|
55 |
-Ask for privilege escalation password\&. |
|
56 |
-.RE |
|
57 |
-.PP |
|
58 |
-\fB\-k\fR, \fB\-\-ask\-pass\fR |
|
59 |
-.RS 4 |
|
60 |
-Prompt for the SSH password instead of assuming key\-based authentication with ssh\-agent\&. |
|
61 |
-.RE |
|
62 |
-.PP |
|
63 |
-\fB\-\-ask\-su\-pass\fR |
|
64 |
-.RS 4 |
|
65 |
-Prompt for su password (deprecated, use become)\&. |
|
66 |
-.RE |
|
67 |
-.PP |
|
68 |
-\fB\-K\fR, \fB\-\-ask\-sudo\-pass\fR |
|
69 |
-.RS 4 |
|
70 |
-Prompt for the password to use with \-\-sudo, if any\&. |
|
71 |
-.RE |
|
72 |
-.PP |
|
73 |
-\fB\-\-ask\-vault\-pass\fR |
|
74 |
-.RS 4 |
|
75 |
-Prompt for vault password\&. |
|
76 |
-.RE |
|
77 |
-.PP |
|
78 |
-\fB\-B\fR \fINUM\fR, \fB\-\-background=\fR\fINUM\fR |
|
79 |
-.RS 4 |
|
80 |
-Run commands in the background, killing the task after |
|
81 |
-\fINUM\fR |
|
82 |
-seconds\&. |
|
83 |
-.RE |
|
84 |
-.PP |
|
85 |
-\fB\-\-become\-method=\fR\fIBECOME_METHOD\fR |
|
86 |
-.RS 4 |
|
87 |
-Privilege escalation method to use (default=sudo), valid choices: [ sudo | su | pbrun | pfexec | runas | doas ] |
|
88 |
-.RE |
|
89 |
-.PP |
|
90 |
-\fB\-\-become\-user=\fR\fIBECOME_USER\fR |
|
91 |
-.RS 4 |
|
92 |
-Run operations as this user (default=None)\&. |
|
93 |
-.RE |
|
94 |
-.PP |
|
95 |
-\fB\-C\fR, \fB\-\-check\fR |
|
96 |
-.RS 4 |
|
97 |
-Don\(cqt make any changes; instead try to predict some of the changes that may occur\&. |
|
98 |
-.RE |
|
99 |
-.PP |
|
100 |
-\fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR |
|
101 |
-.RS 4 |
|
102 |
-Connection type to use\&. Possible options are |
|
103 |
-\fIparamiko\fR |
|
104 |
-(SSH), |
|
105 |
-\fIssh\fR, and |
|
106 |
-\fIlocal\fR\&. |
|
107 |
-\fIlocal\fR |
|
108 |
-is mostly useful for crontab or kickstarts\&. |
|
109 |
-.RE |
|
110 |
-.PP |
|
111 |
-\fB\-e\fR \fIEXTRA_VARS*, \fR\fI\fB\-\-extra\-vars=\fR\fR\fI\*(AqEXTRA_VARS\fR |
|
112 |
-.RS 4 |
|
113 |
-Set additional variables as key=value or YAML/JSON\&. |
|
114 |
-.RE |
|
115 |
-.PP |
|
116 |
-\fB\-f\fR \fINUM\fR, \fB\-\-forks=\fR\fINUM\fR |
|
117 |
-.RS 4 |
|
118 |
-Level of parallelism\&. |
|
119 |
-\fINUM\fR |
|
120 |
-is specified as an integer, the default is 5\&. |
|
121 |
-.RE |
|
122 |
-.PP |
|
123 |
-\fB\-h\fR, \fB\-\-help\fR |
|
124 |
-.RS 4 |
|
125 |
-Show help message and exit\&. |
|
126 |
-.RE |
|
127 |
-.PP |
|
128 |
-\fB\-i\fR \fIPATH\fR, \fB\-\-inventory=\fR\fIPATH\fR |
|
129 |
-.RS 4 |
|
130 |
-The |
|
131 |
-\fIPATH\fR |
|
132 |
-to the inventory hosts file, which defaults to |
|
133 |
-\fI/etc/ansible/hosts\fR\&. |
|
134 |
-.RE |
|
135 |
-.PP |
|
136 |
-\fB\-l\fR \fISUBSET\fR, \fB\-\-limit=\fR\fISUBSET\fR |
|
137 |
-.RS 4 |
|
138 |
-Further limits the selected host/group patterns\&. |
|
139 |
-.RE |
|
140 |
-.PP |
|
141 |
-\fB\-l\fR \fI~REGEX\fR, \fB\-\-limit=\fR\fI~REGEX\fR |
|
142 |
-.RS 4 |
|
143 |
-Further limits hosts with a regex pattern\&. |
|
144 |
-.RE |
|
145 |
-.PP |
|
146 |
-\fB\-\-list\-hosts\fR |
|
147 |
-.RS 4 |
|
148 |
-Outputs a list of matching hosts; does not execute anything else\&. |
|
149 |
-.RE |
|
150 |
-.PP |
|
151 |
-\fB\-m\fR \fINAME\fR, \fB\-\-module\-name=\fR\fINAME\fR |
|
152 |
-.RS 4 |
|
153 |
-Execute the module called |
|
154 |
-\fINAME\fR\&. |
|
155 |
-.RE |
|
156 |
-.PP |
|
157 |
-\fB\-M\fR \fIDIRECTORY\fR, \fB\-\-module\-path=\fR\fIDIRECTORY\fR |
|
158 |
-.RS 4 |
|
159 |
-The |
|
160 |
-\fIDIRECTORY\fR |
|
161 |
-search path to load modules from\&. The default is |
|
162 |
-\fI/usr/share/ansible\fR\&. This can also be set with the ANSIBLE_LIBRARY environment variable\&. |
|
163 |
-.RE |
|
164 |
-.PP |
|
165 |
-\fB\-o\fR, \fB\-\-one\-line\fR |
|
166 |
-.RS 4 |
|
167 |
-Try to output everything on one line\&. |
|
168 |
-.RE |
|
169 |
-.PP |
|
170 |
-\fB\-P\fR \fINUM\fR, \fB\-\-poll=\fR\fINUM\fR |
|
171 |
-.RS 4 |
|
172 |
-Poll a background job every |
|
173 |
-\fINUM\fR |
|
174 |
-seconds\&. Requires |
|
175 |
-\fB\-B\fR\&. |
|
176 |
-.RE |
|
177 |
-.PP |
|
178 |
-\fB\-\-private\-key=\fR\fIPRIVATE_KEY_FILE\fR |
|
179 |
-.RS 4 |
|
180 |
-Use this file to authenticate the connection\&. |
|
181 |
-.RE |
|
182 |
-.PP |
|
183 |
-\fB\-S\fR, \fB\-\-su\fR |
|
184 |
-.RS 4 |
|
185 |
-Run operations with su (deprecated, use become)\&. |
|
186 |
-.RE |
|
187 |
-.PP |
|
188 |
-\fB\-R\fR \fISU_USER\fR, \fB\-\-se\-user=\fR\fISUDO_USER\fR |
|
189 |
-.RS 4 |
|
190 |
-Run operations with su as this user (default=root) (deprecated, use become) |
|
191 |
-.RE |
|
192 |
-.PP |
|
193 |
-\fB\-s\fR, \fB\-\-sudo\fR |
|
194 |
-.RS 4 |
|
195 |
-Run the command as the user given by \-u and sudo to root\&. |
|
196 |
-.RE |
|
197 |
-.PP |
|
198 |
-\fB\-U\fR \fISUDO_USERNAME\fR, \fB\-\-sudo\-user=\fR\fISUDO_USERNAME\fR |
|
199 |
-.RS 4 |
|
200 |
-Sudo to |
|
201 |
-\fISUDO_USERNAME\fR |
|
202 |
-instead of root\&. Implies \-\-sudo\&. |
|
203 |
-.RE |
|
204 |
-.PP |
|
205 |
-\fB\-t\fR \fIDIRECTORY\fR, \fB\-\-tree=\fR\fIDIRECTORY\fR |
|
206 |
-.RS 4 |
|
207 |
-Save contents in this output |
|
208 |
-\fIDIRECTORY\fR, with the results saved in a file named after each host\&. |
|
209 |
-.RE |
|
210 |
-.PP |
|
211 |
-\fB\-T\fR \fISECONDS\fR, \fB\-\-timeout=\fR\fISECONDS\fR |
|
212 |
-.RS 4 |
|
213 |
-Connection timeout to use when trying to talk to hosts, in |
|
214 |
-\fISECONDS\fR\&. |
|
215 |
-.RE |
|
216 |
-.PP |
|
217 |
-\fB\-u\fR \fIUSERNAME\fR, \fB\-\-user=\fR\fIUSERNAME\fR |
|
218 |
-.RS 4 |
|
219 |
-Use this remote |
|
220 |
-\fIUSERNAME\fR |
|
221 |
-instead of the current user\&. |
|
222 |
-.RE |
|
223 |
-.PP |
|
224 |
-\fB\-\-vault\-password\-file=\fR\fIVAULT_PASSWORD_FILE\fR |
|
225 |
-.RS 4 |
|
226 |
-Vault password file\&. |
|
227 |
-.RE |
|
228 |
-.PP |
|
229 |
-\fB\-v\fR, \fB\-\-verbose\fR |
|
230 |
-.RS 4 |
|
231 |
-Verbose mode, more output from successful actions will be shown\&. Give up to three times for more output\&. |
|
232 |
-.RE |
|
233 |
-.PP |
|
234 |
-\fB\-\-version\fR |
|
235 |
-.RS 4 |
|
236 |
-Show program version number and exit\&. |
|
237 |
-.RE |
|
238 |
-.SH "INVENTORY" |
|
239 |
-.sp |
|
240 |
-Ansible stores the hosts it can potentially operate on in an inventory file\&. The syntax is one host per line\&. Groups headers are allowed and are included on their own line, enclosed in square brackets that start the line\&. |
|
241 |
-.sp |
|
242 |
-Ranges of hosts are also supported\&. For more information and additional options, see the documentation on http://docs\&.ansible\&.com/\&. |
|
243 |
-.SH "FILES" |
|
244 |
-.sp |
|
245 |
-/etc/ansible/hosts \(em Default inventory file |
|
246 |
-.sp |
|
247 |
-/usr/share/ansible/ \(em Default module library |
|
248 |
-.sp |
|
249 |
-/etc/ansible/ansible\&.cfg \(em Config file, used if present |
|
250 |
-.sp |
|
251 |
-~/\&.ansible\&.cfg \(em User config file, overrides the default config if present |
|
252 |
-.SH "ENVIRONMENT" |
|
253 |
-.sp |
|
254 |
-The following environment variables may be specified\&. |
|
255 |
-.sp |
|
256 |
-ANSIBLE_INVENTORY \(em Override the default ansible inventory file |
|
257 |
-.sp |
|
258 |
-ANSIBLE_LIBRARY \(em Override the default ansible module library path |
|
259 |
-.sp |
|
260 |
-ANSIBLE_CONFIG \(em Override the default ansible config file |
|
261 |
-.SH "AUTHOR" |
|
262 |
-.sp |
|
263 |
-Ansible was originally written by Michael DeHaan\&. See the AUTHORS file for a complete list of contributors\&. |
|
264 |
-.SH "COPYRIGHT" |
|
265 |
-.sp |
|
266 |
-Copyright \(co 2012, Michael DeHaan |
|
267 |
-.sp |
|
268 |
-Ansible is released under the terms of the GPLv3 License\&. |
|
269 |
-.SH "SEE ALSO" |
|
270 |
-.sp |
|
271 |
-\fBansible\-playbook\fR(1), \fBansible\-pull\fR(1), \fBansible\-doc\fR(1) |
|
272 |
-.sp |
|
273 |
-Extensive documentation is available in the documentation site: http://docs\&.ansible\&.com\&. IRC and mailing list info can be found in file CONTRIBUTING\&.md, available in: https://github\&.com/ansible/ansible |
|
274 |
-.SH "AUTHOR" |
|
275 |
-.PP |
|
276 |
-\fB:doctype:manpage\fR |
|
277 |
-.RS 4 |
|
278 |
-Author. |
|
279 |
-.RE |
... | ... |
@@ -7,19 +7,19 @@ ansible(1) |
7 | 7 |
|
8 | 8 |
NAME |
9 | 9 |
---- |
10 |
-ansible - run a command somewhere else |
|
10 |
+ansible - run a task on a target host(s) |
|
11 | 11 |
|
12 | 12 |
|
13 | 13 |
SYNOPSIS |
14 | 14 |
-------- |
15 |
-ansible <host-pattern> [-f forks] [-m module_name] [-a args] |
|
15 |
+ansible <host-pattern> [-m module_name] [-a args] [options] |
|
16 | 16 |
|
17 | 17 |
|
18 | 18 |
DESCRIPTION |
19 | 19 |
----------- |
20 | 20 |
|
21 |
-*Ansible* is an extra-simple tool/framework/API for doing \'remote things' over |
|
22 |
-SSH. |
|
21 |
+*Ansible* is an extra-simple tool/framework/API for doing \'remote things'. |
|
22 |
+This is the adhoc command that allows for a \'single task playbook' run. |
|
23 | 23 |
|
24 | 24 |
|
25 | 25 |
ARGUMENTS |
... | ... |
@@ -27,9 +27,8 @@ ARGUMENTS |
27 | 27 |
|
28 | 28 |
*host-pattern*:: |
29 | 29 |
|
30 |
-A name of a group in the inventory file, a shell-like glob selecting |
|
31 |
-hosts in inventory file, or any combination of the two separated by |
|
32 |
-semicolons. |
|
30 |
+A name of a group in the inventory, a shell-like glob selecting |
|
31 |
+hosts in inventory or any combination of the two separated by commas. |
|
33 | 32 |
|
34 | 33 |
OPTIONS |
35 | 34 |
------- |
... | ... |
@@ -40,19 +39,20 @@ The 'ARGUMENTS' to pass to the module. |
40 | 40 |
|
41 | 41 |
*--ask-become-pass*:: |
42 | 42 |
|
43 |
-Ask for privilege escalation password. |
|
43 |
+Ask for privilege escalation password. |
|
44 | 44 |
|
45 | 45 |
*-k*, *--ask-pass*:: |
46 | 46 |
|
47 |
-Prompt for the SSH password instead of assuming key-based authentication with ssh-agent. |
|
47 |
+Prompt for the connection password, if it is needed for the transport used. |
|
48 |
+For example, using ssh and not having a key-based authentication with ssh-agent. |
|
48 | 49 |
|
49 | 50 |
*--ask-su-pass*:: |
50 | 51 |
|
51 |
-Prompt for su password (deprecated, use become). |
|
52 |
+Prompt for su password, used with --su (deprecated, use become). |
|
52 | 53 |
|
53 | 54 |
*-K*, *--ask-sudo-pass*:: |
54 | 55 |
|
55 |
-Prompt for the password to use with --sudo, if any. |
|
56 |
+Prompt for the password to use with --sudo, if any (deprecated, use become). |
|
56 | 57 |
|
57 | 58 |
*--ask-vault-pass*:: |
58 | 59 |
|
... | ... |
@@ -69,20 +69,24 @@ valid choices: [ sudo | su | pbrun | pfexec | runas | doas ] |
69 | 69 |
|
70 | 70 |
*--become-user=*'BECOME_USER':: |
71 | 71 |
|
72 |
-Run operations as this user (default=None). |
|
72 |
+Run operations as this user (default=root). |
|
73 | 73 |
|
74 | 74 |
*-C*, *--check*:: |
75 | 75 |
|
76 |
-Don't make any changes; instead try to predict some of the changes that may occur. |
|
76 |
+Do not make any changes on the remote system, but test resources to see what might |
|
77 |
+have changed. Note this can not scan all possible resource types and is only |
|
78 |
+a simulation. |
|
77 | 79 |
|
78 | 80 |
*-c* 'CONNECTION', *--connection=*'CONNECTION':: |
79 | 81 |
|
80 |
-Connection type to use. Possible options are 'paramiko' (SSH), 'ssh', |
|
82 |
+Connection type to use. Most common options are 'paramiko' (SSH), 'ssh', 'winrm' |
|
81 | 83 |
and 'local'. 'local' is mostly useful for crontab or kickstarts. |
82 | 84 |
|
83 |
-*-e* 'EXTRA_VARS*, *--extra-vars=*'EXTRA_VARS':: |
|
85 |
+*-e* 'EXTRA_VARS, *--extra-vars=*'EXTRA_VARS':: |
|
84 | 86 |
|
85 |
-Set additional variables as key=value or YAML/JSON. |
|
87 |
+Extra variables to inject into a playbook, in key=value key=value format or |
|
88 |
+as quoted YAML/JSON (hashes and arrays). To load variables from a file, specify |
|
89 |
+the file preceded by @ (e.g. @vars.yml). |
|
86 | 90 |
|
87 | 91 |
*-f* 'NUM', *--forks=*'NUM':: |
88 | 92 |
|
... | ... |
@@ -94,15 +98,13 @@ Show help message and exit. |
94 | 94 |
|
95 | 95 |
*-i* 'PATH', *--inventory=*'PATH':: |
96 | 96 |
|
97 |
-The 'PATH' to the inventory hosts file, which defaults to '/etc/ansible/hosts'. |
|
97 |
+The 'PATH' to the inventory, which defaults to '/etc/ansible/hosts'. |
|
98 |
+Alternatively you can use a comma separated list of hosts or single host with traling comma 'host,'. |
|
98 | 99 |
|
99 | 100 |
*-l* 'SUBSET', *--limit=*'SUBSET':: |
100 | 101 |
|
101 | 102 |
Further limits the selected host/group patterns. |
102 |
- |
|
103 |
-*-l* '\~REGEX', *--limit=*'~REGEX':: |
|
104 |
- |
|
105 |
-Further limits hosts with a regex pattern. |
|
103 |
+You can prefix it with '~' to indicate that the patter in a regex. |
|
106 | 104 |
|
107 | 105 |
*--list-hosts*:: |
108 | 106 |
|
... | ... |
@@ -136,12 +138,11 @@ Run operations with su (deprecated, use become). |
136 | 136 |
|
137 | 137 |
*-R* 'SU_USER', *--se-user=*'SUDO_USER':: |
138 | 138 |
|
139 |
-Run operations with su as this user (default=root) |
|
140 |
-(deprecated, use become) |
|
139 |
+Run operations with su as this user (default=root) (deprecated, use become). |
|
141 | 140 |
|
142 | 141 |
*-s*, *--sudo*:: |
143 | 142 |
|
144 |
-Run the command as the user given by -u and sudo to root. |
|
143 |
+Run the command as the user given by -u and sudo to root (deprecated, use become). |
|
145 | 144 |
|
146 | 145 |
*--ssh-common-args=*''-o ProxyCommand="ssh -W %h:%p ..." ...'':: |
147 | 146 |
|
... | ... |
@@ -163,7 +164,7 @@ Add the specified arguments to any ssh command-line. |
163 | 163 |
|
164 | 164 |
*-U* 'SUDO_USERNAME', *--sudo-user=*'SUDO_USERNAME':: |
165 | 165 |
|
166 |
-Sudo to 'SUDO_USERNAME' instead of root. Implies --sudo. |
|
166 |
+Sudo to 'SUDO_USERNAME' default is root. (deprecated, use become). |
|
167 | 167 |
|
168 | 168 |
*-t* 'DIRECTORY', *--tree=*'DIRECTORY':: |
169 | 169 |
|
... | ... |
@@ -176,16 +177,18 @@ Connection timeout to use when trying to talk to hosts, in 'SECONDS'. |
176 | 176 |
|
177 | 177 |
*-u* 'USERNAME', *--user=*'USERNAME':: |
178 | 178 |
|
179 |
-Use this remote 'USERNAME' instead of the current user. |
|
179 |
+Use this 'USERNAME' to login to the target host, instead of the current user. |
|
180 | 180 |
|
181 | 181 |
*--vault-password-file=*'VAULT_PASSWORD_FILE':: |
182 | 182 |
|
183 |
-Vault password file. |
|
183 |
+A file containing the vault password to be used during the decryption of vault encrypted files. |
|
184 |
+Be sure to keep this file secured if it is used. If the file is executable, |
|
185 |
+it will be run and its standard output will be used as the password. |
|
184 | 186 |
|
185 | 187 |
*-v*, *--verbose*:: |
186 | 188 |
|
187 |
-Verbose mode, more output from successful actions will be shown. Give |
|
188 |
-up to three times for more output. |
|
189 |
+Verbose mode, more output from successful actions will be shown. |
|
190 |
+Give up to three times for more output. |
|
189 | 191 |
|
190 | 192 |
*--version*:: |
191 | 193 |
|
... | ... |
@@ -194,24 +197,14 @@ Show program version number and exit. |
194 | 194 |
INVENTORY |
195 | 195 |
--------- |
196 | 196 |
|
197 |
-Ansible stores the hosts it can potentially operate on in an inventory |
|
198 |
-file. The syntax is one host per line. Groups headers are allowed and |
|
199 |
-are included on their own line, enclosed in square brackets that |
|
200 |
-start the line. |
|
197 |
+Ansible stores the hosts it can potentially operate on in an inventory. |
|
198 |
+This can be an ini-like file, a script, directory or a list. |
|
199 |
+The ini syntax is one host per line. Groups headers are allowed and |
|
200 |
+are included on their own line, enclosed in square brackets that start the line. |
|
201 | 201 |
|
202 | 202 |
Ranges of hosts are also supported. For more information and |
203 | 203 |
additional options, see the documentation on http://docs.ansible.com/. |
204 | 204 |
|
205 |
-FILES |
|
206 |
- |
|
207 |
-/etc/ansible/hosts -- Default inventory file |
|
208 |
- |
|
209 |
-/usr/share/ansible/ -- Default module library |
|
210 |
- |
|
211 |
-/etc/ansible/ansible.cfg -- Config file, used if present |
|
212 |
- |
|
213 |
-~/.ansible.cfg -- User config file, overrides the default config if present |
|
214 | 205 |
|
215 | 206 |
ENVIRONMENT |
216 | 207 |
----------- |
... | ... |
@@ -224,26 +217,39 @@ ANSIBLE_LIBRARY -- Override the default ansible module library path |
224 | 224 |
|
225 | 225 |
ANSIBLE_CONFIG -- Override the default ansible config file |
226 | 226 |
|
227 |
+Many more are available for most options in ansible.cfg |
|
228 |
+ |
|
229 |
+ |
|
230 |
+FILES |
|
231 |
+----- |
|
232 |
+ |
|
233 |
+/etc/ansible/hosts -- Default inventory file |
|
234 |
+ |
|
235 |
+/usr/share/ansible/ -- Default module library |
|
236 |
+ |
|
237 |
+/etc/ansible/ansible.cfg -- Config file, used if present |
|
238 |
+ |
|
239 |
+~/.ansible.cfg -- User config file, overrides the default config if present |
|
240 |
+ |
|
227 | 241 |
|
228 | 242 |
AUTHOR |
229 | 243 |
------ |
230 | 244 |
|
231 |
-Ansible was originally written by Michael DeHaan. See the AUTHORS file |
|
232 |
-for a complete list of contributors. |
|
245 |
+Ansible was originally written by Michael DeHaan. |
|
246 |
+See the AUTHORS file for a complete list of contributors. |
|
233 | 247 |
|
234 | 248 |
|
235 | 249 |
COPYRIGHT |
236 | 250 |
--------- |
237 | 251 |
|
238 | 252 |
Copyright © 2012, Michael DeHaan |
239 |
- |
|
240 | 253 |
Ansible is released under the terms of the GPLv3 License. |
241 | 254 |
|
242 | 255 |
|
243 | 256 |
SEE ALSO |
244 | 257 |
-------- |
245 | 258 |
|
246 |
-*ansible-playbook*(1), *ansible-pull*(1), *ansible-doc*(1) |
|
259 |
+*ansible-playbook*(1), *ansible-pull*(1), *ansible-doc*(1), *ansible-vault*(1), *ansible-galaxy*(1) |
|
247 | 260 |
|
248 | 261 |
Extensive documentation is available in the documentation site: |
249 | 262 |
<http://docs.ansible.com>. IRC and mailing list info can be found |