ansible/docs/man/man1/ansible.1.asciidoc

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
--------
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-pattern*::

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.


OPTIONS
-------


*-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.


*-m* 'NAME', *--module-name=*'NAME'::

Execute the module called 'NAME'.


*-M* 'DIRECTORY', *--module-path=*'DIRECTORY'::

The 'DIRECTORY' to load modules from. The default is '/usr/share/ansible'.


*-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.


*-o*, *--one-line*::

Try to output everything on one line.


*-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', *--remote-user=*'USERNAME'::

Use this remote 'USERNAME' instead of root.


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.

FILES
-----

/etc/ansible/hosts -- Default inventory file

/usr/share/ansible/ -- Default module library


ENVIRONMENT
-----------

The following environment variables may specified.

ANSIBLE_HOSTS  -- Override the default ansible hosts file

ANSIBLE_LIBRARY -- Override the default ansible module library path


AUTHOR
------

Ansible was originally written by Michael DeHaan. See the AUTHORS file
for a complete list of contributors.


COPYRIGHT
---------

Copyright © 2012, Michael DeHaan

Ansible is released under the terms of the GPLv3 License.


SEE ALSO
--------

*ansible-playbook*(1)

Extensive documentation as well as IRC and mailing list info
is available on the ansible home page: <https://ansible.github.com/>
Because everything should have a man page 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`
			`--------`
-p has been replaced by a required option. Various docs changes. 2012-03-02 04:10:47 +01:00			`ansible <host-pattern> [-f forks] [-m module_name] [-a args]`
Because everything should have a man page 2012-02-25 02:05:05 +01:00

			`DESCRIPTION`
			`-----------`

Manpage and doc updates 2012-02-28 08:51:19 +01:00			`Ansible is an extra-simple tool/framework/API for doing \'remote things' over`
Because everything should have a man page 2012-02-25 02:05:05 +01:00			`SSH.`


-p has been replaced by a required option. Various docs changes. 2012-03-02 04:10:47 +01:00			`ARGUMENTS`
			`---------`

Update constants.py to pull module path and the hosts file from the environment (ANSIBLE_{LIBRARY,HOSTS}) if defined. Update manpages to represent this. Also update the env-setup script to set ANSIBLE_{LIBRARY,HOSTS}. 2012-03-05 22:06:02 +01:00			`host-pattern::`
-p has been replaced by a required option. Various docs changes. 2012-03-02 04:10:47 +01:00
Show when options require arguments in the man pages. 2012-03-24 03:29:51 +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 separated by`
			`semicolons.`
-p has been replaced by a required option. Various docs changes. 2012-03-02 04:10:47 +01:00

Because everything should have a man page 2012-02-25 02:05:05 +01:00			`OPTIONS`
			`-------`


Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`-i 'PATH', --inventory='PATH'::`
Because everything should have a man page 2012-02-25 02:05:05 +01:00
Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`The 'PATH' to the inventory hosts file, which defaults to '/etc/ansible/hosts'.`
Because everything should have a man page 2012-02-25 02:05:05 +01:00

Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`-f 'NUM', --forks='NUM'::`
Because everything should have a man page 2012-02-25 02:05:05 +01:00
Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`Level of parallelism. 'NUM' is specified as an integer, the default is 5.`
Because everything should have a man page 2012-02-25 02:05:05 +01:00

Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`-m 'NAME', --module-name='NAME'::`
Because everything should have a man page 2012-02-25 02:05:05 +01:00
Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`Execute the module called 'NAME'.`
Because everything should have a man page 2012-02-25 02:05:05 +01:00

Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`-M 'DIRECTORY', --module-path='DIRECTORY'::`
Because everything should have a man page 2012-02-25 02:05:05 +01:00
Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`The 'DIRECTORY' to load modules from. The default is '/usr/share/ansible'.`
Because everything should have a man page 2012-02-25 02:05:05 +01:00

Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`-a \'_ARGUMENTS_', --args=\'_ARGUMENTS_'::`
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site. 2012-03-10 04:06:44 +01:00
Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`The 'ARGUMENTS' to pass to the module.`
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site. 2012-03-10 04:06:44 +01:00

			`-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.`


Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`-t 'DIRECTORY', --tree='DIRECTORY'::`
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site. 2012-03-10 04:06:44 +01:00
Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`Save contents in this output 'DIRECTORY', with the results saved in a`
			`file named after each host.`
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site. 2012-03-10 04:06:44 +01:00

Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`-T 'SECONDS', --timeout='SECONDS'::`
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site. 2012-03-10 04:06:44 +01:00
Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`Connection timeout to use when trying to talk to hosts, in 'SECONDS'.`
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site. 2012-03-10 04:06:44 +01:00

Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`-B 'NUM', --background='NUM'::`
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site. 2012-03-10 04:06:44 +01:00
Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`Run commands in the background, killing the task after 'NUM' seconds.`
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site. 2012-03-10 04:06:44 +01:00

Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`-P 'NUM', --poll='NUM'::`
add polling info to manpage 2012-03-12 02:09:44 +01:00
Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`Poll a background job every 'NUM' seconds. Requires -B.`
add polling info to manpage 2012-03-12 02:09:44 +01:00

Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`-u 'USERNAME', --remote-user='USERNAME'::`
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site. 2012-03-10 04:06:44 +01:00
Show when options require arguments in the man pages. 2012-03-24 03:29:51 +01:00			`Use this remote 'USERNAME' instead of root.`
Because everything should have a man page 2012-02-25 02:05:05 +01:00

			`INVENTORY`
			`---------`

			`Ansible stores the hosts it can potentially operate on in an inventory`
README/doc/example updates to go with group support and CLI option changes. Minimizing manpage until CLI options stabilize. 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.`
Because everything should have a man page 2012-02-25 02:05:05 +01:00
			`FILES`
			`-----`

Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site. 2012-03-10 04:06:44 +01:00			`/etc/ansible/hosts -- Default inventory file`
Because everything should have a man page 2012-02-25 02:05:05 +01:00
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site. 2012-03-10 04:06:44 +01:00			`/usr/share/ansible/ -- Default module library`
Because everything should have a man page 2012-02-25 02:05:05 +01:00

Update constants.py to pull module path and the hosts file from the environment (ANSIBLE_{LIBRARY,HOSTS}) if defined. Update manpages to represent this. Also update the env-setup script to set ANSIBLE_{LIBRARY,HOSTS}. 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`


Because everything should have a man page 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`

Relicensing to GPLv3, all previous committers ok'd on mailing list. 2012-02-29 01:08:09 +01:00			`Ansible is released under the terms of the GPLv3 License.`
Because everything should have a man page 2012-02-25 02:05:05 +01:00

			`SEE ALSO`
			`--------`

Fixup RPM building: Makefile, Spec File, .gitignore Fixup distutils: setup.py Clean old cruft: section 5 man pages 2012-03-10 20:02:25 +01:00			`ansible-playbook(1)`

Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site. 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/>`