other versions
- wheezy-backports 1.7.2+dfsg-2~bpo70+1
- jessie 1.7.2+dfsg-2
- jessie-backports 2.2.1.0-2~bpo8+1
- testing 2.2.1.0-2
- unstable 2.2.1.0-2
ANSIBLE(1) | System administration commands | ANSIBLE(1) |
NAME¶
ansible - run a command somewhere elseSYNOPSIS¶
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-patternA 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¶
-v, --verboseVerbose mode, more output from successful
actions will be shown. Give up to three times for more output.
-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.
--private-key=PRIVATE_KEY_FILE
Use this file to authenticate the
connection.
-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.
-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, --user=USERNAME
Use this remote USERNAME instead of the
current user.
-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), ssh, and local. local is mostly
useful for crontab or kickstarts.
-l SUBSET, --limit=SUBSET
Further limits the selected host/group
patterns.
-l ~REGEX, --limit=~REGEX
Further limits hosts with a regex
pattern.
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.FILES¶
/etc/ansible/hosts — Default inventory fileENVIRONMENT¶
The following environment variables may be specified.AUTHOR¶
Ansible was originally written by Michael DeHaan. See the AUTHORS file for a complete list of contributors.COPYRIGHT¶
Copyright © 2012, Michael DeHaanSEE ALSO¶
ansible-playbook(1), ansible-pull(1), ansible-doc(1)AUTHOR¶
:doctype:manpageAuthor.
05/26/2014 | Ansible 1.7 |