|
|
|
|
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
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*-i* 'PATH', *--inventory=*'PATH'::
|
|
|
|
|
|
|
|
|
|
The 'PATH' to the inventory hosts file, which defaults to '/etc/ansible/hosts'.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*-f* 'NUM', *--forks=*'NUM'::
|
|
|
|
|
|
|
|
|
|
Level of parallelism. 'NUM' is specified as an integer, the default is 5.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*-m* 'NAME', *--module-name=*'NAME'::
|
|
|
|
|
|
|
|
|
|
Execute the module called 'NAME'.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*-M* 'DIRECTORY', *--module-path=*'DIRECTORY'::
|
|
|
|
|
|
|
|
|
|
The 'DIRECTORY' to load modules from. The default is '/usr/share/ansible'.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*-a* \'_ARGUMENTS_', *--args=*\'_ARGUMENTS_'::
|
|
|
|
|
|
|
|
|
|
The 'ARGUMENTS' to pass to the module.
|
|
|
|
|
|
|
|
|
|
*-k*, *--ask-pass*::
|
|
|
|
|
|
|
|
|
|
Prompt for the SSH password instead of assuming key-based authentication with ssh-agent.
|
|
|
|
|
|
|
|
|
|
*-K*, *--ask-sudo-pass*::
|
|
|
|
|
|
|
|
|
|
Prompt for the password to use with --sudo, if any
|
|
|
|
|
|
|
|
|
|
*-o*, *--one-line*::
|
|
|
|
|
|
|
|
|
|
Try to output everything on one line.
|
|
|
|
|
|
|
|
|
|
*-s*, *--sudo*::
|
|
|
|
|
|
|
|
|
|
Run the command as the user given by -u and sudo to root.
|
|
|
|
|
|
|
|
|
|
*-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'.
|
|
|
|
|
|
|
|
|
|
*-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', *--remote-user=*'USERNAME'::
|
|
|
|
|
|
|
|
|
|
Use this remote 'USERNAME' instead of root.
|
|
|
|
|
|
|
|
|
|
*-U* 'SUDO_USERNAME', *--sudo-user=*'SUDO_USERNAME'::
|
|
|
|
|
|
|
|
|
|
Sudo to 'SUDO_USERNAME' instead of root. Implies --sudo.
|
|
|
|
|
|
|
|
|
|
*-c* 'CONNECTION', *--connection=*'CONNECTION'::
|
|
|
|
|
|
|
|
|
|
Connection type to use. Possible options are 'paramiko' (SSH) and 'local'.
|
|
|
|
|
Local is mostly useful for crontab or kickstarts.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
FILES
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
/etc/ansible/hosts -- Default inventory file
|
|
|
|
|
|
|
|
|
|
/usr/share/ansible/ -- Default module library
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ENVIRONMENT
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
The following environment variables may specified.
|
|
|
|
|
|
|
|
|
|
ANSIBLE_HOSTS -- Override the default ansible hosts file
|
|
|
|
|
|
|
|
|
|
ANSIBLE_LIBRARY -- Override the default ansible module library path
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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)
|
|
|
|
|
|
|
|
|
|
Extensive documentation as well as IRC and mailing list info
|
|
|
|
|
is available on the ansible home page: <https://ansible.github.com/>
|
