3ad9b4cba6
Now we have the following ways to set additional arguments:
1. [ssh_connection]ssh_args in ansible.cfg: global setting, prepended to
every command line for ssh/scp/sftp. Overrides default ControlPersist
settings.
2. ansible_ssh_common_args inventory variable. Appended to every command
line for ssh/scp/sftp. Used in addition to ssh_args, if set above, or
the default settings.
3. ansible_{sftp,scp,ssh}_extra_args inventory variables. Appended to
every command line for the relevant binary only. Used in addition to
#1 and #2, if set above, or the default settings.
3. Using the --ssh-common-args or --{sftp,scp,ssh}-extra-args command
line options (which are overriden by #2 and #3 above).
This preserves backwards compatibility (for ssh_args in ansible.cfg),
but also permits global settings (e.g. ProxyCommand via _common_args) or
ssh-specific options (e.g. -R via ssh_extra_args).
Fixes #12576
251 lines
5.6 KiB
Plaintext
251 lines
5.6 KiB
Plaintext
ansible(1)
|
|
=========
|
|
:doctype:manpage
|
|
:man source: Ansible
|
|
:man version: %VERSION%
|
|
:man manual: System administration commands
|
|
|
|
NAME
|
|
----
|
|
ansible - run a command somewhere else
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
ansible <host-pattern> [-f forks] [-m module_name] [-a args]
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
*Ansible* is an extra-simple tool/framework/API for doing \'remote things' over
|
|
SSH.
|
|
|
|
|
|
ARGUMENTS
|
|
---------
|
|
|
|
*host-pattern*::
|
|
|
|
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.
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
*-a* \'_ARGUMENTS_', *--args=*\'_ARGUMENTS_'::
|
|
|
|
The 'ARGUMENTS' to pass to the module.
|
|
|
|
*--ask-become-pass*::
|
|
|
|
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 | doas ]
|
|
|
|
*--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'::
|
|
|
|
Level of parallelism. 'NUM' is specified as an integer, the default is 5.
|
|
|
|
*-h*, *--help*::
|
|
|
|
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'::
|
|
|
|
Execute the module called 'NAME'.
|
|
|
|
*-M* 'DIRECTORY', *--module-path=*'DIRECTORY'::
|
|
|
|
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.
|
|
|
|
*-o*, *--one-line*::
|
|
|
|
Try to output everything on one line.
|
|
|
|
*-P* 'NUM', *--poll=*'NUM'::
|
|
|
|
Poll a background job every 'NUM' seconds. Requires *-B*.
|
|
|
|
*--private-key=*'PRIVATE_KEY_FILE'::
|
|
|
|
Use this file to authenticate the connection.
|
|
|
|
*-S*, *--su*::
|
|
|
|
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*::
|
|
|
|
Run the command as the user given by -u and sudo to root.
|
|
|
|
*--ssh-common-args=*''-o ProxyCommand="ssh -W %h:%p ..." ...''::
|
|
|
|
Add the specified arguments to any sftp/scp/ssh command-line. Useful to
|
|
set a ProxyCommand to use a jump host, but any arguments that are
|
|
accepted by all three programs may be specified.
|
|
|
|
*--sftp-extra-args=*''-f ...''::
|
|
|
|
Add the specified arguments to any sftp command-line.
|
|
|
|
*--scp-extra-args=*''-l ...''::
|
|
|
|
Add the specified arguments to any scp command-line.
|
|
|
|
*--ssh-extra-args=*''-R ...''::
|
|
|
|
Add the specified arguments to any ssh command-line.
|
|
|
|
*-U* 'SUDO_USERNAME', *--sudo-user=*'SUDO_USERNAME'::
|
|
|
|
Sudo to 'SUDO_USERNAME' instead of root. Implies --sudo.
|
|
|
|
*-t* 'DIRECTORY', *--tree=*'DIRECTORY'::
|
|
|
|
Save contents in this output 'DIRECTORY', with the results saved in a
|
|
file named after each host.
|
|
|
|
*-T* 'SECONDS', *--timeout=*'SECONDS'::
|
|
|
|
Connection timeout to use when trying to talk to hosts, in 'SECONDS'.
|
|
|
|
*-u* 'USERNAME', *--user=*'USERNAME'::
|
|
|
|
Use this remote 'USERNAME' instead of the current user.
|
|
|
|
*--vault-password-file=*'VAULT_PASSWORD_FILE'::
|
|
|
|
Vault password file.
|
|
|
|
*-v*, *--verbose*::
|
|
|
|
Verbose mode, more output from successful actions will be shown. Give
|
|
up to three times for more output.
|
|
|
|
*--version*::
|
|
|
|
Show program version number and exit.
|
|
|
|
INVENTORY
|
|
---------
|
|
|
|
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.
|
|
|
|
Ranges of hosts are also supported. For more information and
|
|
additional options, see the documentation on http://docs.ansible.com/.
|
|
|
|
FILES
|
|
-----
|
|
|
|
/etc/ansible/hosts -- Default inventory file
|
|
|
|
/usr/share/ansible/ -- Default module library
|
|
|
|
/etc/ansible/ansible.cfg -- Config file, used if present
|
|
|
|
~/.ansible.cfg -- User config file, overrides the default config if present
|
|
|
|
ENVIRONMENT
|
|
-----------
|
|
|
|
The following environment variables may be specified.
|
|
|
|
ANSIBLE_INVENTORY -- Override the default ansible inventory file
|
|
|
|
ANSIBLE_LIBRARY -- Override the default ansible module library path
|
|
|
|
ANSIBLE_CONFIG -- Override the default ansible config file
|
|
|
|
|
|
AUTHOR
|
|
------
|
|
|
|
Ansible was originally written by Michael DeHaan. See the AUTHORS file
|
|
for a complete list of contributors.
|
|
|
|
|
|
COPYRIGHT
|
|
---------
|
|
|
|
Copyright © 2012, Michael DeHaan
|
|
|
|
Ansible is released under the terms of the GPLv3 License.
|
|
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
*ansible-playbook*(1), *ansible-pull*(1), *ansible-doc*(1)
|
|
|
|
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>
|