2012-02-25 01:05:05 +00:00
|
|
|
ansible(1)
|
|
|
|
=========
|
|
|
|
:doctype:manpage
|
|
|
|
:man source: Ansible
|
2012-04-17 14:31:29 +00:00
|
|
|
:man version: %VERSION%
|
2012-02-25 01:05:05 +00:00
|
|
|
:man manual: System administration commands
|
|
|
|
|
|
|
|
NAME
|
|
|
|
----
|
|
|
|
ansible - run a command somewhere else
|
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
2012-03-02 03:10:47 +00:00
|
|
|
ansible <host-pattern> [-f forks] [-m module_name] [-a args]
|
2012-02-25 01:05:05 +00:00
|
|
|
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
|
|
|
|
2012-02-28 07:51:19 +00:00
|
|
|
*Ansible* is an extra-simple tool/framework/API for doing \'remote things' over
|
2012-02-25 01:05:05 +00:00
|
|
|
SSH.
|
|
|
|
|
|
|
|
|
2012-03-02 03:10:47 +00:00
|
|
|
ARGUMENTS
|
|
|
|
---------
|
|
|
|
|
2012-03-05 21:06:02 +00:00
|
|
|
*host-pattern*::
|
2012-03-02 03:10:47 +00:00
|
|
|
|
2012-03-24 02:29:51 +00:00
|
|
|
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.
|
2012-03-02 03:10:47 +00:00
|
|
|
|
2012-02-25 01:05:05 +00:00
|
|
|
OPTIONS
|
|
|
|
-------
|
|
|
|
|
2012-08-15 14:13:38 +00:00
|
|
|
*-v*, *--verbose*::
|
|
|
|
|
|
|
|
Verbose mode, more output from successful actions will be shown. Give
|
|
|
|
up to three times for more output.
|
2012-02-25 01:05:05 +00:00
|
|
|
|
2012-03-24 02:29:51 +00:00
|
|
|
*-i* 'PATH', *--inventory=*'PATH'::
|
2012-02-25 01:05:05 +00:00
|
|
|
|
2012-03-24 02:29:51 +00:00
|
|
|
The 'PATH' to the inventory hosts file, which defaults to '/etc/ansible/hosts'.
|
2012-02-25 01:05:05 +00:00
|
|
|
|
|
|
|
|
2012-03-24 02:29:51 +00:00
|
|
|
*-f* 'NUM', *--forks=*'NUM'::
|
2012-02-25 01:05:05 +00:00
|
|
|
|
2012-03-24 02:29:51 +00:00
|
|
|
Level of parallelism. 'NUM' is specified as an integer, the default is 5.
|
2012-02-25 01:05:05 +00:00
|
|
|
|
2012-07-06 02:21:57 +00:00
|
|
|
*--private-key=*'PRIVATE_KEY_FILE'::
|
|
|
|
|
|
|
|
Use this file to authenticate the connection.
|
|
|
|
|
2012-02-25 01:05:05 +00:00
|
|
|
|
2012-03-24 02:29:51 +00:00
|
|
|
*-m* 'NAME', *--module-name=*'NAME'::
|
2012-02-25 01:05:05 +00:00
|
|
|
|
2012-03-24 02:29:51 +00:00
|
|
|
Execute the module called 'NAME'.
|
2012-02-25 01:05:05 +00:00
|
|
|
|
|
|
|
|
2012-03-24 02:29:51 +00:00
|
|
|
*-M* 'DIRECTORY', *--module-path=*'DIRECTORY'::
|
2012-02-25 01:05:05 +00:00
|
|
|
|
2013-05-23 19:34:33 +00:00
|
|
|
The 'DIRECTORY' search path to load modules from. The default is
|
2013-05-25 06:53:20 +00:00
|
|
|
'/usr/share/ansible'. This can also be set with the ANSIBLE_LIBRARY
|
|
|
|
environment variable.
|
2012-02-25 01:05:05 +00:00
|
|
|
|
2012-03-24 02:29:51 +00:00
|
|
|
*-a* \'_ARGUMENTS_', *--args=*\'_ARGUMENTS_'::
|
2012-03-10 03:06:44 +00:00
|
|
|
|
2012-03-24 02:29:51 +00:00
|
|
|
The 'ARGUMENTS' to pass to the module.
|
2012-03-10 03:06:44 +00:00
|
|
|
|
2012-04-17 15:39:51 +00:00
|
|
|
*-k*, *--ask-pass*::
|
2012-03-10 03:06:44 +00:00
|
|
|
|
|
|
|
Prompt for the SSH password instead of assuming key-based authentication with ssh-agent.
|
|
|
|
|
2012-04-17 15:39:51 +00:00
|
|
|
*-K*, *--ask-sudo-pass*::
|
2012-04-13 23:33:19 +00:00
|
|
|
|
|
|
|
Prompt for the password to use with --sudo, if any
|
2012-03-10 03:06:44 +00:00
|
|
|
|
2012-04-17 15:39:51 +00:00
|
|
|
*-o*, *--one-line*::
|
2012-03-10 03:06:44 +00:00
|
|
|
|
|
|
|
Try to output everything on one line.
|
|
|
|
|
2012-04-17 15:39:51 +00:00
|
|
|
*-s*, *--sudo*::
|
2012-04-13 23:33:19 +00:00
|
|
|
|
|
|
|
Run the command as the user given by -u and sudo to root.
|
2012-03-10 03:06:44 +00:00
|
|
|
|
2012-04-17 15:39:51 +00:00
|
|
|
*-t* 'DIRECTORY', *--tree=*'DIRECTORY'::
|
2012-03-10 03:06:44 +00:00
|
|
|
|
2012-03-24 02:29:51 +00:00
|
|
|
Save contents in this output 'DIRECTORY', with the results saved in a
|
|
|
|
file named after each host.
|
2012-03-10 03:06:44 +00:00
|
|
|
|
2012-04-17 15:39:51 +00:00
|
|
|
*-T* 'SECONDS', *--timeout=*'SECONDS'::
|
2012-03-10 03:06:44 +00:00
|
|
|
|
2012-03-24 02:29:51 +00:00
|
|
|
Connection timeout to use when trying to talk to hosts, in 'SECONDS'.
|
2012-03-10 03:06:44 +00:00
|
|
|
|
2012-04-17 15:39:51 +00:00
|
|
|
*-B* 'NUM', *--background=*'NUM'::
|
2012-03-10 03:06:44 +00:00
|
|
|
|
2012-03-24 02:29:51 +00:00
|
|
|
Run commands in the background, killing the task after 'NUM' seconds.
|
2012-03-10 03:06:44 +00:00
|
|
|
|
2012-04-17 15:39:51 +00:00
|
|
|
*-P* 'NUM', *--poll=*'NUM'::
|
2012-03-12 01:09:44 +00:00
|
|
|
|
2012-03-24 02:29:51 +00:00
|
|
|
Poll a background job every 'NUM' seconds. Requires *-B*.
|
2012-03-12 01:09:44 +00:00
|
|
|
|
2013-10-31 22:56:52 +00:00
|
|
|
*-u* 'USERNAME', *--user=*'USERNAME'::
|
2012-03-10 03:06:44 +00:00
|
|
|
|
2013-02-10 03:24:53 +00:00
|
|
|
Use this remote 'USERNAME' instead of the current user.
|
2012-02-25 01:05:05 +00:00
|
|
|
|
2012-05-06 22:32:43 +00:00
|
|
|
*-U* 'SUDO_USERNAME', *--sudo-user=*'SUDO_USERNAME'::
|
|
|
|
|
|
|
|
Sudo to 'SUDO_USERNAME' instead of root. Implies --sudo.
|
|
|
|
|
2012-04-17 15:39:51 +00:00
|
|
|
*-c* 'CONNECTION', *--connection=*'CONNECTION'::
|
2012-04-11 16:32:29 +00:00
|
|
|
|
2012-07-06 02:21:57 +00:00
|
|
|
Connection type to use. Possible options are 'paramiko' (SSH), 'ssh',
|
|
|
|
and 'local'. 'local' is mostly useful for crontab or kickstarts.
|
2012-04-11 16:32:29 +00:00
|
|
|
|
2012-09-06 22:42:18 +00:00
|
|
|
*-l* 'SUBSET', *--limit=*'SUBSET'::
|
|
|
|
|
|
|
|
Further limits the selected host/group patterns.
|
2012-02-25 01:05:05 +00:00
|
|
|
|
2012-12-04 20:08:29 +00:00
|
|
|
*-l* '\~REGEX', *--limit=*'~REGEX'::
|
|
|
|
|
|
|
|
Further limits hosts with a regex pattern.
|
|
|
|
|
2015-02-27 13:38:45 +00:00
|
|
|
*--list-hosts*::
|
|
|
|
|
|
|
|
Outputs a list of matching hosts; does not execute anything else.
|
|
|
|
|
2012-02-25 01:05:05 +00:00
|
|
|
INVENTORY
|
|
|
|
---------
|
|
|
|
|
|
|
|
Ansible stores the hosts it can potentially operate on in an inventory
|
2012-03-02 02:18:32 +00:00
|
|
|
file. The syntax is one host per line. Groups headers are allowed and
|
2012-07-25 00:10:05 +00:00
|
|
|
are included on their own line, enclosed in square brackets that
|
|
|
|
start the line.
|
|
|
|
|
|
|
|
Ranges of hosts are also supported. For more information and
|
2014-02-11 15:55:10 +00:00
|
|
|
additional options, see the documentation on http://docs.ansible.com/.
|
2012-02-25 01:05:05 +00:00
|
|
|
|
|
|
|
FILES
|
|
|
|
-----
|
|
|
|
|
2012-03-10 03:06:44 +00:00
|
|
|
/etc/ansible/hosts -- Default inventory file
|
2012-02-25 01:05:05 +00:00
|
|
|
|
2012-03-10 03:06:44 +00:00
|
|
|
/usr/share/ansible/ -- Default module library
|
2012-02-25 01:05:05 +00:00
|
|
|
|
2012-10-30 16:08:12 +00:00
|
|
|
/etc/ansible/ansible.cfg -- Config file, used if present
|
2012-10-12 21:31:13 +00:00
|
|
|
|
2012-10-30 16:08:12 +00:00
|
|
|
~/.ansible.cfg -- User config file, overrides the default config if present
|
2012-02-25 01:05:05 +00:00
|
|
|
|
2012-03-05 21:06:02 +00:00
|
|
|
ENVIRONMENT
|
|
|
|
-----------
|
|
|
|
|
2014-02-11 15:50:10 +00:00
|
|
|
The following environment variables may be specified.
|
2012-03-05 21:06:02 +00:00
|
|
|
|
2015-05-05 13:22:44 +00:00
|
|
|
ANSIBLE_INVENTORY -- Override the default ansible inventory file
|
2012-03-05 21:06:02 +00:00
|
|
|
|
|
|
|
ANSIBLE_LIBRARY -- Override the default ansible module library path
|
|
|
|
|
2012-10-30 16:08:12 +00:00
|
|
|
ANSIBLE_CONFIG -- Override the default ansible config file
|
|
|
|
|
2012-03-05 21:06:02 +00:00
|
|
|
|
2012-02-25 01:05:05 +00:00
|
|
|
AUTHOR
|
|
|
|
------
|
|
|
|
|
|
|
|
Ansible was originally written by Michael DeHaan. See the AUTHORS file
|
|
|
|
for a complete list of contributors.
|
|
|
|
|
|
|
|
|
|
|
|
COPYRIGHT
|
|
|
|
---------
|
|
|
|
|
|
|
|
Copyright © 2012, Michael DeHaan
|
|
|
|
|
2012-02-29 00:08:09 +00:00
|
|
|
Ansible is released under the terms of the GPLv3 License.
|
2012-02-25 01:05:05 +00:00
|
|
|
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
--------
|
|
|
|
|
2013-03-19 02:31:42 +00:00
|
|
|
*ansible-playbook*(1), *ansible-pull*(1), *ansible-doc*(1)
|
2012-03-10 19:02:25 +00:00
|
|
|
|
2014-02-11 15:59:40 +00:00
|
|
|
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>
|