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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*-p*, *--pattern*::
|
|
|
|
|
|
2012-02-28 08:51:19 +01:00
|
|
|
Hostname pattern. Accepts shell-like globs which can be seperated with ";"
|
2012-03-02 03:18:32 +01:00
|
|
|
The default is "*" which matches all hosts in the ansible hosts file. Group
|
|
|
|
|
names from the ansible inventory file can also be used.
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
|
2012-03-02 03:18:32 +01:00
|
|
|
See ansible --help for additional options.
|
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
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
/etc/ansible/hosts -- Default hosts file
|
|
|
|
|
|
|
|
|
|
/usr/share/ansible -- Default module library
|
|
|
|
|
|
|
|
|
|
|
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-02 04:10:47 +01:00
|
|
|
Ansible home page: <https://github.com/mpdehaan/ansible/>
|
|
|
|
|
|
2012-03-05 22:06:02 +01:00
|
|
|
*ansible-modules*(5)
|
2012-02-28 08:51:19 +01:00
|
|
|
|
2012-03-05 22:06:02 +01:00
|
|
|
*ansible-playbook*(5)
|
2012-02-27 02:48:10 +01:00
|
|
|
|
