mirror of https://github.com/ansible/ansible.git
Docs rebuild
Michael DeHaan
13 years ago
parent
2b1a7dacc9
commit
e5baf5a926
@ -1,97 +0,0 @@
|
|||||||
ansible-playbook(1)
|
|
||||||
===================
|
|
||||||
:doctype:manpage
|
|
||||||
:man source: Ansible
|
|
||||||
:man version: 0.0.1
|
|
||||||
:man manual: System administration commands
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
ansible-playbook - run an ansible playbook
|
|
||||||
|
|
||||||
|
|
||||||
SYNOPSIS
|
|
||||||
--------
|
|
||||||
ansible-playbook <filename.yml> ... [options]
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
|
|
||||||
*Ansible playbooks* are a configuration and multinode deployment
|
|
||||||
system. Ansible-playbook is the tool used to run them. See the
|
|
||||||
project home page (link below) for more information.
|
|
||||||
|
|
||||||
|
|
||||||
ARGUMENTS
|
|
||||||
---------
|
|
||||||
|
|
||||||
*filename.yml*::
|
|
||||||
|
|
||||||
The names of one or more YAML format files to run as ansible playbooks.
|
|
||||||
|
|
||||||
|
|
||||||
OPTIONS
|
|
||||||
-------
|
|
||||||
|
|
||||||
|
|
||||||
*-i* 'PATH', *--inventory=*'PATH'::
|
|
||||||
|
|
||||||
The 'PATH' to the inventory hosts file, which defaults to '/etc/ansible/hosts'.
|
|
||||||
|
|
||||||
|
|
||||||
*-M* 'DIRECTORY', *--module-path=*'DIRECTORY'::
|
|
||||||
|
|
||||||
The 'DIRECTORY' to load modules from. The default is '/usr/share/ansible'.
|
|
||||||
|
|
||||||
|
|
||||||
*-f* 'NUM', *--forks=*'NUM'::
|
|
||||||
|
|
||||||
Level of parallelism. 'NUM' is specified as an integer, the default is 5.
|
|
||||||
|
|
||||||
|
|
||||||
*-k*, *--ask-pass*::
|
|
||||||
|
|
||||||
Prompt for the SSH password instead of assuming key-based authentication with ssh-agent.
|
|
||||||
|
|
||||||
|
|
||||||
*-T* 'SECONDS', *--timeout=*'SECONDS'::
|
|
||||||
|
|
||||||
Connection timeout to use when trying to talk to hosts, in 'SECONDS'.
|
|
||||||
|
|
||||||
|
|
||||||
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*(1)
|
|
||||||
|
|
||||||
Extensive documentation as well as IRC and mailing list info
|
|
||||||
is available on the ansible home page: <https://ansible.github.com/>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -1,146 +0,0 @@
|
|||||||
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/>
|
|
||||||
@ -1,31 +0,0 @@
|
|||||||
.. _man:
|
|
||||||
|
|
||||||
Man Pages
|
|
||||||
=========
|
|
||||||
|
|
||||||
Ansible's man pages list available command line options. See the rest of the web site for
|
|
||||||
examples of these tools in use.
|
|
||||||
|
|
||||||
ansible(1)
|
|
||||||
----------
|
|
||||||
|
|
||||||
* `View ansible.1 <man/ansible.1.html>`_
|
|
||||||
|
|
||||||
ansible-playbook(1)
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
* `View ansible-playbook.1 <man/ansible-playbook.1.html>`_
|
|
||||||
|
|
||||||
.. seealso::
|
|
||||||
|
|
||||||
:doc:`examples`
|
|
||||||
Examples of basic commands
|
|
||||||
:doc:`modules`
|
|
||||||
List of built-in modules
|
|
||||||
:doc:`playbooks`
|
|
||||||
Learning ansible's configuration management language
|
|
||||||
`Mailing List <http://groups.google.com/group/ansible-project>`_
|
|
||||||
Questions? Help? Ideas? Stop by the list on Google Groups
|
|
||||||
`irc.freenode.net <http://irc.freenode.net>`_
|
|
||||||
#ansible IRC chat channel
|
|
||||||
|
|
||||||
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue