2012-02-25 02:05:05 +01:00
|
|
|
ansible(1)
|
|
|
|
|
=========
|
|
|
|
|
:doctype:manpage
|
|
|
|
|
:man source: Ansible
|
|
|
|
|
:man version: 0.0.1
|
|
|
|
|
:man manual: System administration commands
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
|
|
|
|
ansible - run a command somewhere else
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2012-03-02 04:10:47 +01:00
|
|
|
ansible <host-pattern> [-f forks] [-m module_name] [-a args]
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
|
2012-02-28 08:51:19 +01:00
|
|
|
*Ansible* is an extra-simple tool/framework/API for doing \'remote things' over
|
2012-02-25 02:05:05 +01:00
|
|
|
SSH.
|
|
|
|
|
|
|
|
|
|
|
2012-03-02 04:10:47 +01:00
|
|
|
ARGUMENTS
|
|
|
|
|
---------
|
|
|
|
|
|
2012-03-05 22:06:02 +01:00
|
|
|
*host-pattern*::
|
2012-03-02 04:10:47 +01: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 seperated by semicolons.
|
|
|
|
|
|
|
|
|
|
|
2012-02-25 02:05:05 +01:00
|
|
|
OPTIONS
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
|
2012-03-02 03:18:32 +01:00
|
|
|
*-i*, *--inventory*::
|
2012-02-25 02:05:05 +01:00
|
|
|
|
2012-03-02 03:18:32 +01:00
|
|
|
Path to the inventory hosts file, which defaults to /etc/ansible/hosts.
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
*-f*, *--forks*::
|
|
|
|
|
|
2012-03-02 03:18:32 +01:00
|
|
|
Level of parallelism. Specify as an integer, the default is 5.
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
|
2012-03-02 04:10:47 +01:00
|
|
|
*-m*, *--module-name*::
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
Module name to execute.
|
|
|
|
|
|
|
|
|
|
|
2012-03-10 04:06:44 +01:00
|
|
|
*-M*, *--module-path*::
|
2012-02-25 02:05:05 +01:00
|
|
|
|
2012-03-10 04:06:44 +01:00
|
|
|
Where to load modules from. The default is /usr/share/ansible
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
|
2012-03-10 04:06:44 +01:00
|
|
|
*-a*, *--args*::
|
|
|
|
|
|
|
|
|
|
Arguments to pass to the module
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*-k*, *--ask-pass*::
|
|
|
|
|
|
|
|
|
|
Prompt for the SSH password instead of assuming key-based authentication with ssh-agent.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*-o*, *--one-line*::
|
|
|
|
|
|
|
|
|
|
Try to output everything on one line.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*-t*, *--tree*::
|
|
|
|
|
|
|
|
|
|
Save contents in this output directory, with the results named in a file named after each host.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*-T*, *--timeout*::
|
|
|
|
|
|
|
|
|
|
Connection timeout to use when trying to talk to hosts, in seconds.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*-B*, *--background*::
|
|
|
|
|
|
|
|
|
|
Runs commands in the background, killing the task after N seconds.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*-u*, *--remote-user*::
|
|
|
|
|
|
|
|
|
|
Use this remote username instead of root
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
INVENTORY
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
Ansible stores the hosts it can potentially operate on in an inventory
|
2012-03-02 03:18:32 +01:00
|
|
|
file. The syntax is one host per line. Groups headers are allowed and
|
|
|
|
|
are included on their own line, enclosed in square brackets.
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
FILES
|
|
|
|
|
-----
|
|
|
|
|
|
2012-03-10 04:06:44 +01:00
|
|
|
/etc/ansible/hosts -- Default inventory file
|
2012-02-25 02:05:05 +01:00
|
|
|
|
2012-03-10 04:06:44 +01:00
|
|
|
/usr/share/ansible/ -- Default module library
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
|
2012-03-05 22:06:02 +01:00
|
|
|
ENVIRONMENT
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
The following environment variables may specified.
|
|
|
|
|
|
|
|
|
|
ANSIBLE_HOSTS -- Override the default ansible hosts file
|
|
|
|
|
|
|
|
|
|
ANSIBLE_LIBRARY -- Override the default ansible module library path
|
|
|
|
|
|
|
|
|
|
|
2012-02-25 02:05:05 +01: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 01:08:09 +01:00
|
|
|
Ansible is released under the terms of the GPLv3 License.
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
|
|
|
|
|
2012-03-10 20:02:25 +01:00
|
|
|
*ansible-playbook*(1)
|
|
|
|
|
|
2012-03-10 04:06:44 +01:00
|
|
|
Extensive documentation as well as IRC and mailing list info
|
|
|
|
|
is available on the ansible home page: <https://ansible.github.com/>
|
