archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update ansible man1

Browse Source
pull/11703/head
snetting 9 years ago
parent 6971e92f39
commit 4693531851
6 changed files with 520 additions and 217 deletions
Show Stats Download Patch File Download Diff File

163
docs/man/man1/ansible-playbook.1
Unescape Escape View File

@ -43,117 +43,170 @@ The names of one or more YAML format files to run as ansible playbooks\&.
.RE .RE
.SH "OPTIONS" .SH "OPTIONS"
.PP .PP
\fB\-v\fR, \fB\-\-verbose\fR
.PP
\fB\-k\fR, \fB\-\-ask\-pass\fR
.RS 4 .RS 4
Verbose mode, more output from successful actions will be shown\&. Give up to three times for more output\&. Prompt for the SSH password instead of assuming key\-based authentication with ssh\-agent\&.
.RE .RE
.PP .PP
\fB\-i\fR \fIPATH\fR, \fB\-\-inventory=\fR\fIPATH\fR
\fB\-K\fR, \fB\-\-ask\-sudo\-pass\fR
.RS 4 .RS 4
The Prompt for the password to use for playbook plays that request sudo access, if any\&.
\fIPATH\fR
to the inventory hosts file, which defaults to
\fI/etc/ansible/hosts\fR\&.
.RE .RE
.PP .PP
\fB\-M\fR \fIDIRECTORY\fR, \fB\-\-module\-path=\fR\fIDIRECTORY\fR
\fB\-U\fR, \fISUDO_USER\fR, \fB\-\-sudo\-user=\fR\fISUDO_USER\fR
.RS 4 .RS 4
The Desired sudo user (default=root)\&.
\fIDIRECTORY\fR
search path to load modules from\&. The default is
\fI/usr/share/ansible\fR\&. This can also be set with the ANSIBLE_LIBRARY environment variable\&.
.RE .RE
.PP
\fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR
.RS 4
Connection type to use\&. Possible options are
\fIparamiko\fR
(SSH),
\fIssh\fR, and
\fIlocal\fR\&.
\fIlocal\fR
is mostly useful for crontab or kickstarts\&.
.RE
.PP
\fB\-\-check\fR
.RS 4
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\&.
.RE
.PP
\fB\-\-diff\fR
.RS 4
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\&.
.RE
.PP
.PP .PP
\fB\-e\fR \fIVARS\fR, \fB\-\-extra\-vars=\fR\fIVARS\fR \fB\-e\fR \fIVARS\fR, \fB\-\-extra\-vars=\fR\fIVARS\fR
.RS 4 .RS 4
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)\&. 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)\&.
.RE .RE
.PP .PP
\fB\-f\fR \fINUM\fR, \fB\-\-forks=\fR\fINUM\fR \fB\-f\fR \fINUM\fR, \fB\-\-forks=\fR\fINUM\fR
.RS 4 .RS 4
Level of parallelism\&. Level of parallelism\&.
\fINUM\fR \fINUM\fR
is specified as an integer, the default is 5\&. is specified as an integer, the default is 5\&.
.RE .RE
.PP
\fB\-k\fR, \fB\-\-ask\-pass\fR
\fB\-i\fR \fIPATH\fR, \fB\-\-inventory=\fR\fIPATH\fR
.RS 4 .RS 4
Prompt for the SSH password instead of assuming key\-based authentication with ssh\-agent\&. The
\fIPATH\fR
to the inventory hosts file, which defaults to
\fI/etc/ansible/hosts\fR\&.
.RE .RE
.PP .PP
\fB\-K\fR, \fB\-\-ask\-sudo\-pass\fR
\fB\-l\fR \fISUBSET\fR, \fB\-\-limit=\fR\fISUBSET\fR
.RS 4 .RS 4
Prompt for the password to use for playbook plays that request sudo access, if any\&. Further limits the selected host/group patterns\&.
.RE .RE
.PP .PP
\fB\-U\fR, \fISUDO_USER\fR, \fB\-\-sudo\-user=\fR\fISUDO_USER\fR
\fB\-\-list\-hosts\fR
.RS 4 .RS 4
Desired sudo user (default=root)\&. Outputs a list of matching hosts; does not execute anything else\&.
.RE .RE
.PP .SH "ENVIRONMENT"
\fB\-t\fR, \fITAGS\fR, \fB\-\-tags=\fR\fITAGS\fR .sp
\fB\-\-list\-tasks\fR
.RS 4 .RS 4
Only run plays and tasks tagged with these values\&. List all tasks that would be executed\&.
.RE
.SH "ENVIRONMENT"
.sp
\fB\-M\fR \fIDIRECTORY\fR, \fB\-\-module\-path=\fR\fIDIRECTORY\fR
.RS 4
The
\fIDIRECTORY\fR
search path to load modules from\&. The default is
\fI/usr/share/ansible\fR\&. This can also be set with the ANSIBLE_LIBRARY environment variable\&.
.RE
\fB\-u\fR \fIUSERNAME\fR, \fB\-\-user=\fR\fIUSERNAME\fR
.RS 4
Use this remote user name on playbook steps that do not indicate a user name to run as\&.
.RE .RE
.PP .PP
\fB\-\-skip\-tags=\fR\fISKIP_TAGS\fR \fB\-\-skip\-tags=\fR\fISKIP_TAGS\fR
.RS 4 .RS 4
Only run plays and tasks whose tags do not match these values\&. Only run plays and tasks whose tags do not match these values\&.
.RE .RE
.PP .PP
\fB\-\-syntax\-check\fR \fB\-\-syntax\-check\fR
.RS 4 .RS 4
Look for syntax errors in the playbook, but don\(cqt run anything Look for syntax errors in the playbook, but don\(cqt run anything
.RE .RE
.PP .PP
\fB\-\-check\fR
\fB\-s\fR, \fB\-\-sudo\fR
.RS 4 .RS 4
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\&. Force all plays to use sudo, even if not marked as such\&.
.RE .RE
.PP .PP
\fB\-\-diff\fR
\fB\-t\fR, \fITAGS\fR, \fB\-\-tags=\fR\fITAGS\fR
.RS 4 .RS 4
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\&. Only run plays and tasks tagged with these values\&.
.RE .RE
.PP .PP
\fB\-T\fR \fISECONDS\fR, \fB\-\-timeout=\fR\fISECONDS\fR \fB\-T\fR \fISECONDS\fR, \fB\-\-timeout=\fR\fISECONDS\fR
.RS 4 .RS 4
Connection timeout to use when trying to talk to hosts, in Connection timeout to use when trying to talk to hosts, in
\fISECONDS\fR\&. \fISECONDS\fR\&.
.RE .RE
.PP .PP
\fB\-s\fR, \fB\-\-sudo\fR
.RS 4
Force all plays to use sudo, even if not marked as such\&. \fB\-v\fR, \fB\-\-verbose\fR
.RE
.PP
\fB\-u\fR \fIUSERNAME\fR, \fB\-\-user=\fR\fIUSERNAME\fR
.RS 4
Use this remote user name on playbook steps that do not indicate a user name to run as\&.
.RE
.PP
\fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR
.RS 4
Connection type to use\&. Possible options are
\fIparamiko\fR
(SSH),
\fIssh\fR, and
\fIlocal\fR\&.
\fIlocal\fR
is mostly useful for crontab or kickstarts\&.
.RE
.PP
\fB\-l\fR \fISUBSET\fR, \fB\-\-limit=\fR\fISUBSET\fR
.RS 4 .RS 4
Further limits the selected host/group patterns\&. Verbose mode, more output from successful actions will be shown\&. Give up to three times for more output\&.
.RE .RE
.PP .PP
\fB\-\-list\-hosts\fR
.RS 4
Outputs a list of matching hosts; does not execute anything else\&.
.RE
.SH "ENVIRONMENT"
.sp
The following environment variables may be specified\&. The following environment variables may be specified\&.
.sp .sp
ANSIBLE_INVENTORY \(em Override the default ansible inventory file ANSIBLE_INVENTORY \(em Override the default ansible inventory file

143
docs/man/man1/ansible-playbook.1.asciidoc.in
Unescape Escape View File

@ -34,22 +34,44 @@ The names of one or more YAML format files to run as ansible playbooks.
OPTIONS OPTIONS
------- -------
*-v*, *--verbose*:: *-k*, *--ask-pass*::
Verbose mode, more output from successful actions will be shown. Give Prompt for the SSH password instead of assuming key-based
up to three times for more output. authentication with ssh-agent.
*-i* 'PATH', *--inventory=*'PATH':: *-K*, *--ask-sudo-pass*::
The 'PATH' to the inventory hosts file, which defaults to Prompt for the password to use for playbook plays that request sudo
'/etc/ansible/hosts'. access, if any.
*-b*, *--become*::
*-M* 'DIRECTORY', *--module-path=*'DIRECTORY':: Run operations with become (nopasswd implied)
The 'DIRECTORY' search path to load modules from. The default is *--become-method=BECOME_METHOD*::
'/usr/share/ansible'. This can also be set with the ANSIBLE_LIBRARY
environment variable. Privilege escalation method to use (default=sudo),
valid choices: [ sudo | su | pbrun | pfexec | runas ]
*--become-user=BECOME_USER*::
Run operations as this user (default=None).
*-C*, *--check*::
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.
*-c* 'CONNECTION', *--connection=*'CONNECTION'::
Connection type to use. Possible options are 'paramiko' (SSH), 'ssh',
and 'local'. 'local' is mostly useful for crontab or kickstarts.
*-D*, *--diff*::
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.
*-e* 'VARS', *--extra-vars=*'VARS':: *-e* 'VARS', *--extra-vars=*'VARS'::
@ -57,76 +79,115 @@ 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 as quoted JSON (hashes and arrays). To load variables from a file, specify
the file preceded by @ (e.g. @vars.yml). the file preceded by @ (e.g. @vars.yml).
*--flush-cache*::
Clear the fact cache.
*--force-handlers*::
Run handlers even if a task fails.
*-f* 'NUM', *--forks=*'NUM':: *-f* 'NUM', *--forks=*'NUM'::
Level of parallelism. 'NUM' is specified as an integer, the default is 5. Level of parallelism. 'NUM' is specified as an integer, the default is 5.
*-h*, *--help*::
*-k*, *--ask-pass*:: Show help page and exit
Prompt for the SSH password instead of assuming key-based *-i* 'PATH', *--inventory=*'PATH'::
authentication with ssh-agent.
The 'PATH' to the inventory hosts file, which defaults to
'/etc/ansible/hosts'.
*-K*, *--ask-sudo-pass*:: *-l* 'SUBSET', *--limit=*'SUBSET'::
Prompt for the password to use for playbook plays that request sudo Further limits the selected host/group patterns.
access, if any.
*-U*, 'SUDO_USER', *--sudo-user=*'SUDO_USER':: *--list-hosts*::
Outputs a list of matching hosts; does not execute anything else.
Desired sudo user (default=root). *--list-tags*::
*-t*, 'TAGS', *--tags=*'TAGS':: List all available tags.
Only run plays and tasks tagged with these values. *--list-tasks*::
*--skip-tags=*'SKIP_TAGS':: List all tasks that would be executed
Only run plays and tasks whose tags do not match these values. *-M* 'DIRECTORY', *--module-path=*'DIRECTORY'::
*--syntax-check*:: The 'DIRECTORY' search path to load modules from. The default is
'/usr/share/ansible'. This can also be set with the ANSIBLE_LIBRARY
environment variable.
Look for syntax errors in the playbook, but don't run anything *--private-key=*'PRIVATE_KEY_FILE'::
*--check*:: Use this file to authenticate the connection
Do not make any changes on the remote system, but test resources to see what might *--skip-tages=*'SKIP_TAGS'::
have changed. Note this can not scan all possible resource types and is only
a simulation.
*--diff*:: Only run plays and tasks whose tags do not match these values.
When changing any templated files, show the unified diffs of how they changed. When *--start-at-task=*'START_AT'::
used with --check, shows how the files would have changed if --check were not used.
*-T* 'SECONDS', *--timeout=*'SECONDS':: Start the playbook at the task matching this name.
Connection timeout to use when trying to talk to hosts, in 'SECONDS'. *--step*::
One-step-at-a-time: confirm each task before running.
*-S*, --su*::
Run operations with su (deprecated, use become)
*-R SU-USER*, *--su-user=*'SU_USER'::
run operations with su as this user (default=root)
(deprecated, use become)
*-s*, *--sudo*:: *-s*, *--sudo*::
Force all plays to use sudo, even if not marked as such. Run operations with sudo (nopasswd) (deprecated, use become)
*-U*, 'SUDO_USER', *--sudo-user=*'SUDO_USER'::
Desired sudo user (default=root) (deprecated, use become).
*--skip-tags=*'SKIP_TAGS'::
Only run plays and tasks whose tags do not match these values.
*--syntax-check*::
Look for syntax errors in the playbook, but don't run anything
*-t*, 'TAGS', *--tags=*'TAGS'::
Only run plays and tasks tagged with these values.
*-T* 'SECONDS', *--timeout=*'SECONDS'::
Connection timeout to use when trying to talk to hosts, in 'SECONDS'.
*-u* 'USERNAME', *--user=*'USERNAME':: *-u* 'USERNAME', *--user=*'USERNAME'::
Use this remote user name on playbook steps that do not indicate a Use this remote user name on playbook steps that do not indicate a
user name to run as. user name to run as.
*-c* 'CONNECTION', *--connection=*'CONNECTION':: *--vault-password-file=*'VAULT_PASSWORD_FILE'::
Connection type to use. Possible options are 'paramiko' (SSH), 'ssh', Vault password file.
and 'local'. 'local' is mostly useful for crontab or kickstarts.
*-l* 'SUBSET', *--limit=*'SUBSET':: *-v*, *--verbose*::
Further limits the selected host/group patterns. Verbose mode, more output from successful actions will be shown. Give
up to three times for more output.
*--list-hosts*:: *--version*::
Outputs a list of matching hosts; does not execute anything else. Show program's version number and exit.
ENVIRONMENT ENVIRONMENT
----------- -----------

67
docs/man/man1/ansible-pull.1
Unescape Escape View File

@ -2,12 +2,12 @@
.\" Title: ansible .\" Title: ansible
.\" Author: :doctype:manpage .\" Author: :doctype:manpage
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 05/05/2015 .\" Date: 07/22/2015
.\" Manual: System administration commands .\" Manual: System administration commands
.\" Source: Ansible 2.0.0 .\" Source: Ansible %VERSION%
.\" Language: English .\" Language: English
.\" .\"
.TH "ANSIBLE" "1" "05/05/2015" "Ansible 2\&.0\&.0" "System administration commands" .TH "ANSIBLE" "1" "07/22/2015" "Ansible %VERSION%" "System administration commands"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -50,14 +50,14 @@ The name of one the YAML format files to run as an ansible playbook\&. This can
.RE .RE
.SH "OPTIONS" .SH "OPTIONS"
.PP .PP
\fB\-d\fR \fIDEST\fR, \fB\-\-directory=\fR\fIDEST\fR \fB\-\-accept\-host\-key\fR
.RS 4 .RS 4
Directory to checkout repository into\&. If not provided, a subdirectory of ~/\&.ansible/pull/ will be used\&. Adds the hostkey for the repo URL if not already added\&.
.RE .RE
.PP .PP
\fB\-U\fR \fIURL\fR, \fB\-\-url=\fR\fIURL\fR \fB\-K\fR, \fB\-\-ask\-sudo\-pass\fR
.RS 4 .RS 4
URL of the playbook repository to checkout\&. Ask for sudo password\&.
.RE .RE
.PP .PP
\fB\-C\fR \fICHECKOUT\fR, \fB\-\-checkout=\fR\fICHECKOUT\fR \fB\-C\fR \fICHECKOUT\fR, \fB\-\-checkout=\fR\fICHECKOUT\fR
@ -65,11 +65,26 @@ URL of the playbook repository to checkout\&.
Branch/Tag/Commit to checkout\&. If not provided, uses default behavior of module used to check out playbook repository\&. Branch/Tag/Commit to checkout\&. If not provided, uses default behavior of module used to check out playbook repository\&.
.RE .RE
.PP .PP
\fB\-d\fR \fIDEST\fR, \fB\-\-directory=\fR\fIDEST\fR
.RS 4
Directory to checkout repository into\&. If not provided, a subdirectory of ~/\&.ansible/pull/ will be used\&.
.RE
.PP
\fB\-e\fR \fIEXTRA_VARS\fR, \fB\-\-extra\-vars=\fR\*(AqEXTRA_VARS*
.RS 4
Set additional variables as key=value or YAML/JSON
.RE
.PP
\fB\-f\fR, \fB\-\-force\fR \fB\-f\fR, \fB\-\-force\fR
.RS 4 .RS 4
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\&. 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\&.
.RE .RE
.PP .PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Show the help message and exit\&.
.RE
.PP
\fB\-i\fR \fIPATH\fR, \fB\-\-inventory=\fR\fIPATH\fR \fB\-i\fR \fIPATH\fR, \fB\-\-inventory=\fR\fIPATH\fR
.RS 4 .RS 4
The The
@ -77,9 +92,11 @@ The
to the inventory hosts file\&. This can be a relative path within the checkout\&. to the inventory hosts file\&. This can be a relative path within the checkout\&.
.RE .RE
.PP .PP
\fB\-\-purge\fR \fB\-\-key\-file=\fR\fIKEYFILE\fR
.RS 4 .RS 4
Purge the checkout after the playbook is run\&. Pass
\fI\-i <key_file>\fR
to the SSH arguments used by git\&.
.RE .RE
.PP .PP
\fB\-m\fR \fINAME\fR, \fB\-\-module\-name=\fR\fINAME\fR \fB\-m\fR \fINAME\fR, \fB\-\-module\-name=\fR\fINAME\fR
@ -89,7 +106,37 @@ Module used to checkout playbook repository\&. Defaults to git\&.
.PP .PP
\fB\-o\fR, \fB\-\-only\-if\-changed\fR \fB\-o\fR, \fB\-\-only\-if\-changed\fR
.RS 4 .RS 4
Run the playbook only if the repository has changed Only run the playbook if the repository has been updated\&.
.RE
.PP
\fB\-\-purge\fR
.RS 4
Purge the checkout after the playbook is run\&.
.RE
.PP
\fB\-s\fR \fISLEEP\fR, \fB\-\-sleep=\fR\fISLEEP\fR
.RS 4
Sleep for random interval (between 0 and SLEEP number of seconds) before starting\&. This is a useful way ot disperse git requests\&.
.RE
.PP
\fB\-t\fR \fITAGS\fR, \fB\-\-tags=\fR\fITAGS\fR
.RS 4
Only run plays and tasks tagged with these values\&.
.RE
.PP
\fB\-U\fR \fIURL\fR, \fB\-\-url=\fR\fIURL\fR
.RS 4
URL of the playbook repository to checkout\&.
.RE
.PP
\fB\-\-vault\-password\-file=\fR\fIVAULT_PASSWORD_FILE\fR
.RS 4
Vault password file\&.
.RE
.PP
\fB\-v\fR, \fB\-\-verbose\fR
.RS 4
Pass \-vvv to ansible\-playbook\&.
.RE .RE
.SH "AUTHOR" .SH "AUTHOR"
.sp .sp

59
docs/man/man1/ansible-pull.1.asciidoc.in
Unescape Escape View File

@ -50,19 +50,26 @@ host hostname and finally a playbook named *local.yml*.
OPTIONS OPTIONS
------- -------
*--accept-host-key*::
Adds the hostkey for the repo URL if not already added.
*-K*, *--ask-sudo-pass*::
Ask for sudo password.
*-C* 'CHECKOUT', *--checkout=*'CHECKOUT'::
Branch/Tag/Commit to checkout. If not provided, uses default behavior of module used to check out playbook repository.
*-d* 'DEST', *--directory=*'DEST':: *-d* 'DEST', *--directory=*'DEST'::
Directory to checkout repository into. If not provided, a subdirectory of Directory to checkout repository into. If not provided, a subdirectory of
~/.ansible/pull/ will be used. ~/.ansible/pull/ will be used.
*-U* 'URL', *--url=*'URL':: *-e* 'EXTRA_VARS', *--extra-vars=*'EXTRA_VARS*::
URL of the playbook repository to checkout.
*-C* 'CHECKOUT', *--checkout=*'CHECKOUT'::
Branch/Tag/Commit to checkout. If not provided, uses default behavior Set additional variables as key=value or YAML/JSON
of module used to check out playbook repository.
*-f*, *--force*:: *-f*, *--force*::
@ -70,14 +77,17 @@ 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 can be useful, for example, to enforce run-time state when a network
connection may not always be up or possible. connection may not always be up or possible.
*-h*, *--help*::
Show the help message and exit.
*-i* 'PATH', *--inventory=*'PATH':: *-i* 'PATH', *--inventory=*'PATH'::
The 'PATH' to the inventory hosts file. This can be a relative path within The 'PATH' to the inventory hosts file. This can be a relative path within the checkout.
the checkout.
*--purge*:: *--key-file=*'KEYFILE'::
Purge the checkout after the playbook is run. Pass '-i <key_file>' to the SSH arguments used by git.
*-m* 'NAME', *--module-name=*'NAME':: *-m* 'NAME', *--module-name=*'NAME'::
@ -85,7 +95,32 @@ Module used to checkout playbook repository. Defaults to git.
*-o*, *--only-if-changed*:: *-o*, *--only-if-changed*::
Run the playbook only if the repository has changed Only run the playbook if the repository has been updated.
*--purge*::
Purge the checkout after the playbook is run.
*-s* 'SLEEP', *--sleep=*'SLEEP'::
Sleep for random interval (between 0 and SLEEP number of seconds) before starting. This is a useful way ot disperse git requests.
*-t* 'TAGS', *--tags=*'TAGS'::
Only run plays and tasks tagged with these values.
*-U* 'URL', *--url=*'URL'::
URL of the playbook repository to checkout.
*--vault-password-file=*'VAULT_PASSWORD_FILE'::
Vault password file.
*-v*, *--verbose*::
Pass -vvv to ansible-playbook.
AUTHOR AUTHOR
------ ------

180
docs/man/man1/ansible.1
Unescape Escape View File

@ -2,12 +2,12 @@
.\" Title: ansible .\" Title: ansible
.\" Author: :doctype:manpage .\" Author: :doctype:manpage
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 05/05/2015 .\" Date: 07/15/2015
.\" Manual: System administration commands .\" Manual: System administration commands
.\" Source: Ansible 2.0.0 .\" Source: Ansible %VERSION%
.\" Language: English .\" Language: English
.\" .\"
.TH "ANSIBLE" "1" "05/05/2015" "Ansible 2\&.0\&.0" "System administration commands" .TH "ANSIBLE" "1" "07/15/2015" "Ansible %VERSION%" "System administration commands"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -43,9 +43,86 @@ A name of a group in the inventory file, a shell\-like glob selecting hosts in i
.RE .RE
.SH "OPTIONS" .SH "OPTIONS"
.PP .PP
\fB\-v\fR, \fB\-\-verbose\fR \fB\-a\fR \*(Aq\fIARGUMENTS\fR\*(Aq, \fB\-\-args=\fR\*(Aq\fIARGUMENTS\fR\*(Aq
.RS 4 .RS 4
Verbose mode, more output from successful actions will be shown\&. Give up to three times for more output\&. The
\fIARGUMENTS\fR
to pass to the module\&.
.RE
.PP
\fB\-\-ask\-become\-pass\fR
.RS 4
Ask for privilege escalation password\&.
.RE
.PP
\fB\-k\fR, \fB\-\-ask\-pass\fR
.RS 4
Prompt for the SSH password instead of assuming key\-based authentication with ssh\-agent\&.
.RE
.PP
\fB\-\-ask\-su\-pass\fR
.RS 4
Prompt for su password (deprecated, use become)\&.
.RE
.PP
\fB\-K\fR, \fB\-\-ask\-sudo\-pass\fR
.RS 4
Prompt for the password to use with \-\-sudo, if any\&.
.RE
.PP
\fB\-\-ask\-vault\-pass\fR
.RS 4
Prompt for vault password\&.
.RE
.PP
\fB\-B\fR \fINUM\fR, \fB\-\-background=\fR\fINUM\fR
.RS 4
Run commands in the background, killing the task after
\fINUM\fR
seconds\&.
.RE
.PP
\fB\-\-become\-method=\fR\fIBECOME_METHOD\fR
.RS 4
Privilege escalation method to use (default=sudo), valid choices: [ sudo | su | pbrun | pfexec | runas ]
.RE
.PP
\fB\-\-become\-user=\fR\fIBECOME_USER\fR
.RS 4
Run operations as this user (default=None)\&.
.RE
.PP
\fB\-C\fR, \fB\-\-check\fR
.RS 4
Don\(cqt make any changes; instead try to predict some of the changes that may occur\&.
.RE
.PP
\fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR
.RS 4
Connection type to use\&. Possible options are
\fIparamiko\fR
(SSH),
\fIssh\fR, and
\fIlocal\fR\&.
\fIlocal\fR
is mostly useful for crontab or kickstarts\&.
.RE
.PP
\fB\-e\fR \fIEXTRA_VARS*, \fR\fI\fB\-\-extra\-vars=\fR\fR\fI\*(AqEXTRA_VARS\fR
.RS 4
Set additional variables as key=value or YAML/JSON\&.
.RE
.PP
\fB\-f\fR \fINUM\fR, \fB\-\-forks=\fR\fINUM\fR
.RS 4
Level of parallelism\&.
\fINUM\fR
is specified as an integer, the default is 5\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Show help message and exit\&.
.RE .RE
.PP .PP
\fB\-i\fR \fIPATH\fR, \fB\-\-inventory=\fR\fIPATH\fR \fB\-i\fR \fIPATH\fR, \fB\-\-inventory=\fR\fIPATH\fR
@ -56,16 +133,19 @@ to the inventory hosts file, which defaults to
\fI/etc/ansible/hosts\fR\&. \fI/etc/ansible/hosts\fR\&.
.RE .RE
.PP .PP
\fB\-f\fR \fINUM\fR, \fB\-\-forks=\fR\fINUM\fR \fB\-l\fR \fISUBSET\fR, \fB\-\-limit=\fR\fISUBSET\fR
.RS 4 .RS 4
Level of parallelism\&. Further limits the selected host/group patterns\&.
\fINUM\fR
is specified as an integer, the default is 5\&.
.RE .RE
.PP .PP
\fB\-\-private\-key=\fR\fIPRIVATE_KEY_FILE\fR \fB\-l\fR \fI~REGEX\fR, \fB\-\-limit=\fR\fI~REGEX\fR
.RS 4 .RS 4
Use this file to authenticate the connection\&. Further limits hosts with a regex pattern\&.
.RE
.PP
\fB\-\-list\-hosts\fR
.RS 4
Outputs a list of matching hosts; does not execute anything else\&.
.RE .RE
.PP .PP
\fB\-m\fR \fINAME\fR, \fB\-\-module\-name=\fR\fINAME\fR \fB\-m\fR \fINAME\fR, \fB\-\-module\-name=\fR\fINAME\fR
@ -82,26 +162,32 @@ search path to load modules from\&. The default is
\fI/usr/share/ansible\fR\&. This can also be set with the ANSIBLE_LIBRARY environment variable\&. \fI/usr/share/ansible\fR\&. This can also be set with the ANSIBLE_LIBRARY environment variable\&.
.RE .RE
.PP .PP
\fB\-a\fR \*(Aq\fIARGUMENTS\fR\*(Aq, \fB\-\-args=\fR\*(Aq\fIARGUMENTS\fR\*(Aq \fB\-o\fR, \fB\-\-one\-line\fR
.RS 4 .RS 4
The Try to output everything on one line\&.
\fIARGUMENTS\fR
to pass to the module\&.
.RE .RE
.PP .PP
\fB\-k\fR, \fB\-\-ask\-pass\fR \fB\-P\fR \fINUM\fR, \fB\-\-poll=\fR\fINUM\fR
.RS 4 .RS 4
Prompt for the SSH password instead of assuming key\-based authentication with ssh\-agent\&. Poll a background job every
\fINUM\fR
seconds\&. Requires
\fB\-B\fR\&.
.RE .RE
.PP .PP
\fB\-K\fR, \fB\-\-ask\-sudo\-pass\fR \fB\-\-private\-key=\fR\fIPRIVATE_KEY_FILE\fR
.RS 4 .RS 4
Prompt for the password to use with \-\-sudo, if any Use this file to authenticate the connection\&.
.RE .RE
.PP .PP
\fB\-o\fR, \fB\-\-one\-line\fR \fB\-S\fR, \fB\-\-su\fR
.RS 4 .RS 4
Try to output everything on one line\&. Run operations with su (deprecated, use become)\&.
.RE
.PP
\fB\-R\fR \fISU_USER\fR, \fB\-\-se\-user=\fR\fISUDO_USER\fR
.RS 4
Run operations with su as this user (default=root) (deprecated, use become)
.RE .RE
.PP .PP
\fB\-s\fR, \fB\-\-sudo\fR \fB\-s\fR, \fB\-\-sudo\fR
@ -109,6 +195,13 @@ Try to output everything on one line\&.
Run the command as the user given by \-u and sudo to root\&. Run the command as the user given by \-u and sudo to root\&.
.RE .RE
.PP .PP
\fB\-U\fR \fISUDO_USERNAME\fR, \fB\-\-sudo\-user=\fR\fISUDO_USERNAME\fR
.RS 4
Sudo to
\fISUDO_USERNAME\fR
instead of root\&. Implies \-\-sudo\&.
.RE
.PP
\fB\-t\fR \fIDIRECTORY\fR, \fB\-\-tree=\fR\fIDIRECTORY\fR \fB\-t\fR \fIDIRECTORY\fR, \fB\-\-tree=\fR\fIDIRECTORY\fR
.RS 4 .RS 4
Save contents in this output Save contents in this output
@ -121,21 +214,6 @@ Connection timeout to use when trying to talk to hosts, in
\fISECONDS\fR\&. \fISECONDS\fR\&.
.RE .RE
.PP .PP
\fB\-B\fR \fINUM\fR, \fB\-\-background=\fR\fINUM\fR
.RS 4
Run commands in the background, killing the task after
\fINUM\fR
seconds\&.
.RE
.PP
\fB\-P\fR \fINUM\fR, \fB\-\-poll=\fR\fINUM\fR
.RS 4
Poll a background job every
\fINUM\fR
seconds\&. Requires
\fB\-B\fR\&.
.RE
.PP
\fB\-u\fR \fIUSERNAME\fR, \fB\-\-user=\fR\fIUSERNAME\fR \fB\-u\fR \fIUSERNAME\fR, \fB\-\-user=\fR\fIUSERNAME\fR
.RS 4 .RS 4
Use this remote Use this remote
@ -143,37 +221,19 @@ Use this remote
instead of the current user\&. instead of the current user\&.
.RE .RE
.PP .PP
\fB\-U\fR \fISUDO_USERNAME\fR, \fB\-\-sudo\-user=\fR\fISUDO_USERNAME\fR \fB\-\-vault\-password\-file=\fR\fIVAULT_PASSWORD_FILE\fR
.RS 4 .RS 4
Sudo to Vault password file\&.
\fISUDO_USERNAME\fR
instead of root\&. Implies \-\-sudo\&.
.RE .RE
.PP .PP
\fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR \fB\-v\fR, \fB\-\-verbose\fR
.RS 4
Connection type to use\&. Possible options are
\fIparamiko\fR
(SSH),
\fIssh\fR, and
\fIlocal\fR\&.
\fIlocal\fR
is mostly useful for crontab or kickstarts\&.
.RE
.PP
\fB\-l\fR \fISUBSET\fR, \fB\-\-limit=\fR\fISUBSET\fR
.RS 4
Further limits the selected host/group patterns\&.
.RE
.PP
\fB\-l\fR \fI~REGEX\fR, \fB\-\-limit=\fR\fI~REGEX\fR
.RS 4 .RS 4
Further limits hosts with a regex pattern\&. Verbose mode, more output from successful actions will be shown\&. Give up to three times for more output\&.
.RE .RE
.PP .PP
\fB\-\-list\-hosts\fR \fB\-\-version\fR
.RS 4 .RS 4
Outputs a list of matching hosts; does not execute anything else\&. Show program version number and exit\&.
.RE .RE
.SH "INVENTORY" .SH "INVENTORY"
.sp .sp

125
docs/man/man1/ansible.1.asciidoc.in
Unescape Escape View File

@ -34,56 +34,119 @@ semicolons.
OPTIONS OPTIONS
------- -------
*-v*, *--verbose*:: *-a* \'_ARGUMENTS_', *--args=*\'_ARGUMENTS_'::
Verbose mode, more output from successful actions will be shown. Give The 'ARGUMENTS' to pass to the module.
up to three times for more output.
*-i* 'PATH', *--inventory=*'PATH':: *--ask-become-pass*::
The 'PATH' to the inventory hosts file, which defaults to '/etc/ansible/hosts'. Ask for privilege escalation password.
*-k*, *--ask-pass*::
Prompt for the SSH password instead of assuming key-based authentication with ssh-agent.
*--ask-su-pass*::
Prompt for su password (deprecated, use become).
*-K*, *--ask-sudo-pass*::
Prompt for the password to use with --sudo, if any.
*--ask-vault-pass*::
Prompt for vault password.
*-B* 'NUM', *--background=*'NUM'::
Run commands in the background, killing the task after 'NUM' seconds.
*--become-method=*'BECOME_METHOD'::
Privilege escalation method to use (default=sudo),
valid choices: [ sudo | su | pbrun | pfexec | runas ]
*--become-user=*'BECOME_USER'::
Run operations as this user (default=None).
*-C*, *--check*::
Don't make any changes; instead try to predict some of the changes that may occur.
*-c* 'CONNECTION', *--connection=*'CONNECTION'::
Connection type to use. Possible options are 'paramiko' (SSH), 'ssh',
and 'local'. 'local' is mostly useful for crontab or kickstarts.
*-e* 'EXTRA_VARS*, *--extra-vars=*'EXTRA_VARS'::
Set additional variables as key=value or YAML/JSON.
*-f* 'NUM', *--forks=*'NUM':: *-f* 'NUM', *--forks=*'NUM'::
Level of parallelism. 'NUM' is specified as an integer, the default is 5. Level of parallelism. 'NUM' is specified as an integer, the default is 5.
*--private-key=*'PRIVATE_KEY_FILE':: *-h*, *--help*::
Use this file to authenticate the connection. Show help message and exit.
*-i* 'PATH', *--inventory=*'PATH'::
The 'PATH' to the inventory hosts file, which defaults to '/etc/ansible/hosts'.
*-l* 'SUBSET', *--limit=*'SUBSET'::
Further limits the selected host/group patterns.
*-l* '\~REGEX', *--limit=*'~REGEX'::
Further limits hosts with a regex pattern.
*--list-hosts*::
Outputs a list of matching hosts; does not execute anything else.
*-m* 'NAME', *--module-name=*'NAME':: *-m* 'NAME', *--module-name=*'NAME'::
Execute the module called 'NAME'. Execute the module called 'NAME'.
*-M* 'DIRECTORY', *--module-path=*'DIRECTORY':: *-M* 'DIRECTORY', *--module-path=*'DIRECTORY'::
The 'DIRECTORY' search path to load modules from. The default is The 'DIRECTORY' search path to load modules from. The default is
'/usr/share/ansible'. This can also be set with the ANSIBLE_LIBRARY '/usr/share/ansible'. This can also be set with the ANSIBLE_LIBRARY
environment variable. environment variable.
*-a* \'_ARGUMENTS_', *--args=*\'_ARGUMENTS_':: *-o*, *--one-line*::
The 'ARGUMENTS' to pass to the module. Try to output everything on one line.
*-k*, *--ask-pass*:: *-P* 'NUM', *--poll=*'NUM'::
Prompt for the SSH password instead of assuming key-based authentication with ssh-agent. Poll a background job every 'NUM' seconds. Requires *-B*.
*-K*, *--ask-sudo-pass*:: *--private-key=*'PRIVATE_KEY_FILE'::
Prompt for the password to use with --sudo, if any Use this file to authenticate the connection.
*-o*, *--one-line*:: *-S*, *--su*::
Try to output everything on one line. Run operations with su (deprecated, use become).
*-R* 'SU_USER', *--se-user=*'SUDO_USER'::
Run operations with su as this user (default=root)
(deprecated, use become)
*-s*, *--sudo*:: *-s*, *--sudo*::
Run the command as the user given by -u and sudo to root. Run the command as the user given by -u and sudo to root.
*-U* 'SUDO_USERNAME', *--sudo-user=*'SUDO_USERNAME'::
Sudo to 'SUDO_USERNAME' instead of root. Implies --sudo.
*-t* 'DIRECTORY', *--tree=*'DIRECTORY':: *-t* 'DIRECTORY', *--tree=*'DIRECTORY'::
Save contents in this output 'DIRECTORY', with the results saved in a Save contents in this output 'DIRECTORY', with the results saved in a
@ -93,38 +156,22 @@ file named after each host.
Connection timeout to use when trying to talk to hosts, in 'SECONDS'. Connection timeout to use when trying to talk to hosts, in 'SECONDS'.
*-B* 'NUM', *--background=*'NUM'::
Run commands in the background, killing the task after 'NUM' seconds.
*-P* 'NUM', *--poll=*'NUM'::
Poll a background job every 'NUM' seconds. Requires *-B*.
*-u* 'USERNAME', *--user=*'USERNAME':: *-u* 'USERNAME', *--user=*'USERNAME'::
Use this remote 'USERNAME' instead of the current user. Use this remote 'USERNAME' instead of the current user.
*-U* 'SUDO_USERNAME', *--sudo-user=*'SUDO_USERNAME':: *--vault-password-file=*'VAULT_PASSWORD_FILE'::
Sudo to 'SUDO_USERNAME' instead of root. Implies --sudo.
*-c* 'CONNECTION', *--connection=*'CONNECTION'::
Connection type to use. Possible options are 'paramiko' (SSH), 'ssh',
and 'local'. 'local' is mostly useful for crontab or kickstarts.
*-l* 'SUBSET', *--limit=*'SUBSET'::
Further limits the selected host/group patterns. Vault password file.
*-l* '\~REGEX', *--limit=*'~REGEX':: *-v*, *--verbose*::
Further limits hosts with a regex pattern. Verbose mode, more output from successful actions will be shown. Give
up to three times for more output.
*--list-hosts*:: *--version*::
Outputs a list of matching hosts; does not execute anything else. Show program version number and exit.
INVENTORY INVENTORY
--------- ---------

Write Preview
Loading…
Cancel
Save