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-02-28 08:51:19 +01:00
|
|
|
ansible [-f forks] [-p pattern ] [-u remote_user]
|
|
|
|
|
[-n module_name] [-a [args1 [args2 ...]]]
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
OPTIONS
|
|
|
|
|
-------
|
|
|
|
|
|
2012-02-28 08:51:19 +01:00
|
|
|
*-k*, *--ask-pass*::
|
2012-02-25 02:05:05 +01:00
|
|
|
|
2012-02-28 08:51:19 +01:00
|
|
|
Ask the user to input the ssh password for connecting. Generally using
|
|
|
|
|
ssh-agent instead is preferred.
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
|
2012-02-28 08:51:19 +01:00
|
|
|
*-l*, *--host-list*::
|
2012-02-25 02:05:05 +01:00
|
|
|
|
2012-02-28 08:51:19 +01:00
|
|
|
Path to hosts list, which defaults to /etc/ansible/hosts. Users can use
|
|
|
|
|
multiple files to emulate groups of systems.
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
|
2012-02-28 08:51:19 +01:00
|
|
|
*-m*, *--module-path*::
|
2012-02-25 02:05:05 +01:00
|
|
|
|
2012-02-28 08:51:19 +01:00
|
|
|
Override the path to module library, which defaults to /usr/share/ansible.
|
|
|
|
|
The module library contains runnable modules that do 'things' to remote
|
|
|
|
|
hosts. See ansible-modules(5) for a list of those that bundled with
|
|
|
|
|
Ansible.
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
*-f*, *--forks*::
|
|
|
|
|
|
2012-02-28 08:51:19 +01:00
|
|
|
Level of parallelism. Specify as an integer, the default is 3. If set to "1"
|
|
|
|
|
debugging for certain classes of internal errors may become easier.
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
*-n*, *--name*::
|
|
|
|
|
|
|
|
|
|
Module name to execute.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*-a*, *--args*::
|
|
|
|
|
|
2012-02-28 08:51:19 +01:00
|
|
|
Arguments to module, as a single string. Be sure to observe proper shell quoting rules.
|
|
|
|
|
How these are handled are up to the module, but most modules take "key=value" pairs
|
|
|
|
|
delimited by spaces.
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
*-p*, *--pattern*::
|
|
|
|
|
|
2012-02-28 08:51:19 +01:00
|
|
|
Hostname pattern. Accepts shell-like globs which can be seperated with ";"
|
|
|
|
|
The default is "*" which matches all hosts in the ansible hosts file.
|
2012-02-25 02:05:05 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
*-u*, *--remote-user*::
|
|
|
|
|
|
|
|
|
|
Remote user to connect as. Uses __root__ by default.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
INVENTORY
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
Ansible stores the hosts it can potentially operate on in an inventory
|
|
|
|
|
file. The syntax is simple: one host per line. Organize your hosts
|
|
|
|
|
into multiple groups by separating them into multiple inventory files.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
FILES
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
/etc/ansible/hosts -- Default hosts file
|
|
|
|
|
|
|
|
|
|
/usr/share/ansible -- Default module library
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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-02-28 08:51:19 +01:00
|
|
|
*ansible-modules*(5),
|
|
|
|
|
|
|
|
|
|
*ansible-playbook*(5),
|
2012-02-27 02:48:10 +01:00
|
|
|
|
2012-02-25 02:05:05 +01:00
|
|
|
Ansible home page: <https://github.com/mpdehaan/ansible/>
|
