'\" t .\" Title: ansible-playbook .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 .\" Date: 07/24/2012 .\" Manual: System administration commands .\" Source: Ansible 0.6 .\" Language: English .\" .TH "ANSIBLE\-PLAYBOOK" "1" "07/24/2012" "Ansible 0\&.6" "System administration commands" .\" ----------------------------------------------------------------- .\" * 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 \&... [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" .sp \fB\-v\fR, \fB\-\-verbose\fR .sp Verbose mode, more output from successful actions will be shown .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\-e\fR \fIVARS\fR, \fB\-\-extra\-vars=\fR\fIVARS\fR .RS 4 Extra variables to inject into a playbook, in key=value key=value format\&. .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\-K\fR, \fB\-\-ask\-sudo\-pass\fR .RS 4 Prompt for the password to use for playbook plays that request sudo access, if any .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 .PP \fB\-s\fR, \fB\-\-sudo\fR .RS 4 Force all plays to use sudo, even if not marked as such\&. .RE .PP \fB\-u\fR \fIUSERNAME\fR, \fB\-\-remote\-user=\fR\fIUSERNAME\fR .RS 4 Use this remote user name on playbook steps that do not indicate a user name to run as\&. .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/