179 lines
5.2 KiB
Groff
179 lines
5.2 KiB
Groff
'\" t
|
|
.\" Title: ansible-playbook
|
|
.\" Author: :doctype:manpage
|
|
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
|
|
.\" Date: 11/18/2013
|
|
.\" Manual: System administration commands
|
|
.\" Source: Ansible 1.4
|
|
.\" Language: English
|
|
.\"
|
|
.TH "ANSIBLE\-PLAYBOOK" "1" "11/18/2013" "Ansible 1\&.4" "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\-v\fR, \fB\-\-verbose\fR
|
|
.RS 4
|
|
Verbose mode, more output from successful actions will be shown\&. Give up to three times for more output\&.
|
|
.RE
|
|
.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
|
|
search path to load modules from\&. The default is
|
|
\fI/usr/share/ansible\fR\&. This can also be set with the ANSIBLE_LIBRARY environment variable\&.
|
|
.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 or as quoted JSON (hashes and arrays)\&.
|
|
.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\-U\fR, \fISUDO_USER\fR, \fB\-\-sudo\-user=\fR\fISUDO_USER\fR
|
|
.RS 4
|
|
Desired sudo user (default=root)\&.
|
|
.RE
|
|
.PP
|
|
\fB\-\-tags\fR
|
|
.RS 4
|
|
Run only these tags from the playbook
|
|
.RE
|
|
.PP
|
|
\fB\-\-syntax\-check\fR
|
|
.RS 4
|
|
Look for syntax errors in the playbook, but don\(cqt run anything
|
|
.RE
|
|
.PP
|
|
\fB\-\-check\fR
|
|
.RS 4
|
|
Do not make any changes on the remote system, but test resources to see what might have changed\&. Note this can not scan all possible resource types and is only a simulation\&.
|
|
.RE
|
|
.PP
|
|
\fB\-\-diff\fR
|
|
.RS 4
|
|
When changing any templated files, show the unified diffs of how they changed\&. When used with \-\-check, shows how the files would have changed if \-\-check were not used\&.
|
|
.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\-\-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
|
|
.PP
|
|
\fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR
|
|
.RS 4
|
|
Connection type to use\&. Possible options are
|
|
\fIparamiko\fR
|
|
(SSH),
|
|
\fIssh\fR, and
|
|
\fIlocal\fR\&.
|
|
\fIlocal\fR
|
|
is mostly useful for crontab or kickstarts\&.
|
|
.RE
|
|
.PP
|
|
\fB\-l\fR \fISUBSET\fR, \fB\-\-limit=\fR\fISUBSET\fR
|
|
.RS 4
|
|
Further limits the selected host/group patterns\&.
|
|
.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 "FILES"
|
|
.sp
|
|
/etc/ansible/hosts \(em Default inventory file
|
|
.sp
|
|
/usr/share/ansible/ \(em Default module library
|
|
.sp
|
|
/etc/ansible/ansible\&.cfg \(em Config file, used if present
|
|
.sp
|
|
~/\&.ansible\&.cfg \(em User config file, overrides the default config if present
|
|
.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), \fBansible\-pull\fR(1), \fBansible\-doc\fR(1)
|
|
.sp
|
|
Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/
|
|
.SH "AUTHOR"
|
|
.PP
|
|
\fB:doctype:manpage\fR
|
|
.RS 4
|
|
Author.
|
|
.RE
|