mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-25 14:20:22 -07:00
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site.
This commit is contained in:
parent
1699013fbd
commit
209760f8f6
6 changed files with 135 additions and 216 deletions
89
docs/man/man1/ansible-playbook.1.asciidoc
Normal file
89
docs/man/man1/ansible-playbook.1.asciidoc
Normal file
|
@ -0,0 +1,89 @@
|
|||
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
|
||||
--------
|
||||
|
||||
Extensive documentation as well as IRC and mailing list info
|
||||
is available on the ansible home page: <https://ansible.github.com/>
|
||||
|
||||
|
||||
|
|
@ -50,14 +50,44 @@ Level of parallelism. Specify as an integer, the default is 5.
|
|||
Module name to execute.
|
||||
|
||||
|
||||
*-p*, *--pattern*::
|
||||
*-M*, *--module-path*::
|
||||
|
||||
Hostname pattern. Accepts shell-like globs which can be seperated with ";"
|
||||
The default is "*" which matches all hosts in the ansible hosts file. Group
|
||||
names from the ansible inventory file can also be used.
|
||||
Where to load modules from. The default is /usr/share/ansible
|
||||
|
||||
|
||||
See ansible --help for additional options.
|
||||
*-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.
|
||||
|
||||
|
||||
*-u*, *--remote-user*::
|
||||
|
||||
Use this remote username instead of root
|
||||
|
||||
|
||||
INVENTORY
|
||||
|
@ -70,9 +100,9 @@ are included on their own line, enclosed in square brackets.
|
|||
FILES
|
||||
-----
|
||||
|
||||
/etc/ansible/hosts -- Default hosts file
|
||||
/etc/ansible/hosts -- Default inventory file
|
||||
|
||||
/usr/share/ansible -- Default module library
|
||||
/usr/share/ansible/ -- Default module library
|
||||
|
||||
|
||||
ENVIRONMENT
|
||||
|
@ -103,6 +133,8 @@ Ansible is released under the terms of the GPLv3 License.
|
|||
SEE ALSO
|
||||
--------
|
||||
|
||||
Ansible home page: <https://ansible.github.com/>
|
||||
Extensive documentation as well as IRC and mailing list info
|
||||
is available on the ansible home page: <https://ansible.github.com/>
|
||||
|
||||
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue