mirror of https://github.com/ansible/ansible.git
Docs rebuild, removing submodule because it was causing build problems and I don't quite grok them :)
parent
884d8af759
commit
3f834cfe3e
@ -1,3 +0,0 @@
|
||||
[submodule "ansible"]
|
||||
path = ansible
|
||||
url = git://github.com/ansible/ansible.git
|
@ -1 +0,0 @@
|
||||
Subproject commit 328f58479dc2d0ed5d22cbfeaac060c59eb901dc
|
@ -0,0 +1,91 @@
|
||||
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*, *--inventory*::
|
||||
|
||||
Path to the inventory hosts file, which defaults to /etc/ansible/hosts.
|
||||
|
||||
|
||||
*-M*, *--module-path*::
|
||||
|
||||
Where to load modules from. The default is /usr/share/ansible
|
||||
|
||||
|
||||
*-f*, *--forks*::
|
||||
|
||||
Desired level of parallelism. Default 5.
|
||||
|
||||
|
||||
*-k*, *--ask-pass*::
|
||||
|
||||
Prompt for the SSH password instead of assuming key-based authentication with ssh-agent.
|
||||
|
||||
|
||||
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/>
|
||||
|
||||
|
||||
|
@ -0,0 +1,144 @@
|
||||
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 seperated by semicolons.
|
||||
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
|
||||
|
||||
*-i*, *--inventory*::
|
||||
|
||||
Path to the inventory hosts file, which defaults to /etc/ansible/hosts.
|
||||
|
||||
|
||||
*-f*, *--forks*::
|
||||
|
||||
Level of parallelism. Specify as an integer, the default is 5.
|
||||
|
||||
|
||||
*-m*, *--module-name*::
|
||||
|
||||
Module name to execute.
|
||||
|
||||
|
||||
*-M*, *--module-path*::
|
||||
|
||||
Where to load modules from. The default is /usr/share/ansible
|
||||
|
||||
|
||||
*-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.
|
||||
|
||||
|
||||
*-P*, *--poll*::
|
||||
|
||||
Poll a background job every (this many) seconds. Requires -B.
|
||||
|
||||
|
||||
*-u*, *--remote-user*::
|
||||
|
||||
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/>
|
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue