ansible/docs/man/man1/ansible-playbook.1

'\" t
.\"     Title: ansible-playbook
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 04/03/2012
.\"    Manual: System administration commands
.\"    Source: Ansible 0.0.2
.\"  Language: English
.\"
.TH "ANSIBLE\-PLAYBOOK" "1" "04/03/2012" "Ansible 0\&.0\&.2" "System administration commands"
.\" -----------------------------------------------------------------
.\" * 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 '
.\" -----------------------------------------------------------------
.\" * 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
\fBAnsible 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
\fBfilename\&.yml\fR
.RS 4
The names of one or more YAML format files to run as ansible playbooks\&.
.RE
.SH "OPTIONS"
.PP
\fB\-i\fR \fIPATH\fR, \fB\-\-inventory=\fR\fIPATH\fR
.RS 4
The
\fIPATH\fR
to the inventory hosts file, which defaults to
\fI/etc/ansible/hosts\fR\&.
.RE
.PP
\fB\-M\fR \fIDIRECTORY\fR, \fB\-\-module\-path=\fR\fIDIRECTORY\fR
.RS 4
The
\fIDIRECTORY\fR
to load modules from\&. The default is
\fI/usr/share/ansible\fR\&.
.RE
.PP
\fB\-f\fR \fINUM\fR, \fB\-\-forks=\fR\fINUM\fR
.RS 4
Level of parallelism\&.
\fINUM\fR
is specified as an integer, the default is 5\&.
.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
\fB\-T\fR \fISECONDS\fR, \fB\-\-timeout=\fR\fISECONDS\fR
.RS 4
Connection timeout to use when trying to talk to hosts, in
\fISECONDS\fR\&.
.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
\fBansible\fR(1)
.sp
Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/
host file must be marked config(noreplace), update rpm build to use checked in manpage src 13 years ago			`'\" t`
			`.\" Title: ansible-playbook`
			`.\" Author: [see the "AUTHOR" section]`
Show when options require arguments in the man pages. 13 years ago			`.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>`
Bump release to 0.0.2 13 years ago			`.\" Date: 04/03/2012`
host file must be marked config(noreplace), update rpm build to use checked in manpage src 13 years ago			`.\" Manual: System administration commands`
Bump release to 0.0.2 13 years ago			`.\" Source: Ansible 0.0.2`
host file must be marked config(noreplace), update rpm build to use checked in manpage src 13 years ago			`.\" Language: English`
			`.\"`
Bump release to 0.0.2 13 years ago			`.TH "ANSIBLE\-PLAYBOOK" "1" "04/03/2012" "Ansible 0\&.0\&.2" "System administration commands"`
Show when options require arguments in the man pages. 13 years ago			`.\" -----------------------------------------------------------------`
			`.\" * 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 '`
host file must be marked config(noreplace), update rpm build to use checked in manpage src 13 years ago			`.\" -----------------------------------------------------------------`
			`.\" * 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`
			`\fBAnsible 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`
			`\fBfilename\&.yml\fR`
			`.RS 4`
			`The names of one or more YAML format files to run as ansible playbooks\&.`
			`.RE`
			`.SH "OPTIONS"`
			`.PP`
Show when options require arguments in the man pages. 13 years ago			`\fB\-i\fR \fIPATH\fR, \fB\-\-inventory=\fR\fIPATH\fR`
host file must be marked config(noreplace), update rpm build to use checked in manpage src 13 years ago			`.RS 4`
Show when options require arguments in the man pages. 13 years ago			`The`
			`\fIPATH\fR`
			`to the inventory hosts file, which defaults to`
			`\fI/etc/ansible/hosts\fR\&.`
host file must be marked config(noreplace), update rpm build to use checked in manpage src 13 years ago			`.RE`
			`.PP`
Show when options require arguments in the man pages. 13 years ago			`\fB\-M\fR \fIDIRECTORY\fR, \fB\-\-module\-path=\fR\fIDIRECTORY\fR`
host file must be marked config(noreplace), update rpm build to use checked in manpage src 13 years ago			`.RS 4`
Show when options require arguments in the man pages. 13 years ago			`The`
			`\fIDIRECTORY\fR`
			`to load modules from\&. The default is`
			`\fI/usr/share/ansible\fR\&.`
host file must be marked config(noreplace), update rpm build to use checked in manpage src 13 years ago			`.RE`
			`.PP`
Show when options require arguments in the man pages. 13 years ago			`\fB\-f\fR \fINUM\fR, \fB\-\-forks=\fR\fINUM\fR`
host file must be marked config(noreplace), update rpm build to use checked in manpage src 13 years ago			`.RS 4`
Show when options require arguments in the man pages. 13 years ago			`Level of parallelism\&.`
			`\fINUM\fR`
			`is specified as an integer, the default is 5\&.`
host file must be marked config(noreplace), update rpm build to use checked in manpage src 13 years ago			`.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`
Show when options require arguments in the man pages. 13 years ago			`\fB\-T\fR \fISECONDS\fR, \fB\-\-timeout=\fR\fISECONDS\fR`
host file must be marked config(noreplace), update rpm build to use checked in manpage src 13 years ago			`.RS 4`
Show when options require arguments in the man pages. 13 years ago			`Connection timeout to use when trying to talk to hosts, in`
			`\fISECONDS\fR\&.`
host file must be marked config(noreplace), update rpm build to use checked in manpage src 13 years ago			`.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`
			`\fBansible\fR(1)`
			`.sp`
			`Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/`