2012-03-31 17:08:42 +02:00
'\" t
. \" Title: ansible-playbook
. \" Author: [see the "AUTHOR" section]
2012-03-24 03:29:51 +01:00
. \" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
2012-04-03 15:51:05 +02:00
. \" Date: 04/03/2012
2012-03-31 17:08:42 +02:00
. \" Manual: System administration commands
2012-04-03 15:51:05 +02:00
. \" Source: Ansible 0.0.2
2012-03-31 17:08:42 +02:00
. \" Language: English
. \"
2012-04-03 15:51:05 +02:00
.TH "ANSIBLE\-PLAYBOOK" "1" "04/03/2012" "Ansible 0\&.0\&.2" "System administration commands"
2012-03-24 03:29:51 +01:00
. \" -----------------------------------------------------------------
. \" * Define some portability stuff
. \" -----------------------------------------------------------------
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
. \" http://bugs.debian.org/507673
. \" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n (.g .ds Aq \(aq
.el .ds Aq '
2012-03-31 17:08:42 +02:00
. \" -----------------------------------------------------------------
. \" * set default formatting
. \" -----------------------------------------------------------------
. \" disable hyphenation
.nh
. \" disable justification (adjust text to left margin only)
.ad l
. \" -----------------------------------------------------------------
. \" * MAIN CONTENT STARTS HERE *
. \" -----------------------------------------------------------------
.SH "NAME"
ansible-playbook \- run an ansible playbook
.SH "SYNOPSIS"
.sp
ansible\- playbook <filename\& .yml> \& ... [options]
.SH "DESCRIPTION"
.sp
\fB Ansible playbooks\fR 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\& .
.SH "ARGUMENTS"
.PP
\fB filename\& .yml\fR
.RS 4
The names of one or more YAML format files to run as ansible playbooks\& .
.RE
.SH "OPTIONS"
.PP
2012-03-24 03:29:51 +01:00
\fB \- i\fR \fI PATH\fR , \fB \- \- inventory=\fR \fI PATH\fR
2012-03-31 17:08:42 +02:00
.RS 4
2012-03-24 03:29:51 +01:00
The
\fI PATH\fR
to the inventory hosts file, which defaults to
\fI /etc/ansible/hosts\fR \& .
2012-03-31 17:08:42 +02:00
.RE
.PP
2012-03-24 03:29:51 +01:00
\fB \- M\fR \fI DIRECTORY\fR , \fB \- \- module\- path=\fR \fI DIRECTORY\fR
2012-03-31 17:08:42 +02:00
.RS 4
2012-03-24 03:29:51 +01:00
The
\fI DIRECTORY\fR
to load modules from\& . The default is
\fI /usr/share/ansible\fR \& .
2012-03-31 17:08:42 +02:00
.RE
.PP
2012-03-24 03:29:51 +01:00
\fB \- f\fR \fI NUM\fR , \fB \- \- forks=\fR \fI NUM\fR
2012-03-31 17:08:42 +02:00
.RS 4
2012-03-24 03:29:51 +01:00
Level of parallelism\& .
\fI NUM\fR
is specified as an integer, the default is 5\& .
2012-03-31 17:08:42 +02:00
.RE
.PP
\fB \- k\fR , \fB \- \- ask\- pass\fR
.RS 4
Prompt for the SSH password instead of assuming key\- based authentication with ssh\- agent\& .
.RE
.PP
2012-03-24 03:29:51 +01:00
\fB \- T\fR \fI SECONDS\fR , \fB \- \- timeout=\fR \fI SECONDS\fR
2012-03-31 17:08:42 +02:00
.RS 4
2012-03-24 03:29:51 +01:00
Connection timeout to use when trying to talk to hosts, in
\fI SECONDS\fR \& .
2012-03-31 17:08:42 +02:00
.RE
.SH "ENVIRONMENT"
.sp
The following environment variables may specified\& .
.sp
ANSIBLE_HOSTS \(em Override the default ansible hosts file
.sp
ANSIBLE_LIBRARY \(em Override the default ansible module library path
.SH "AUTHOR"
.sp
Ansible was originally written by Michael DeHaan\& . See the AUTHORS file for a complete list of contributors\& .
.SH "COPYRIGHT"
.sp
Copyright \(co 2012, Michael DeHaan
.sp
Ansible is released under the terms of the GPLv3 License\& .
.SH "SEE ALSO"
.sp
\fB ansible\fR (1)
.sp
Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\& .github\& .com/