mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
270 lines
7.2 KiB
Groff
270 lines
7.2 KiB
Groff
'\" t
|
|
.\" Title: ansible-playbook
|
|
.\" Author: :doctype:manpage
|
|
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
|
|
.\" Date: 07/23/2015
|
|
.\" Manual: System administration commands
|
|
.\" Source: Ansible %VERSION%
|
|
.\" Language: English
|
|
.\"
|
|
.TH "ANSIBLE\-PLAYBOOK" "1" "07/23/2015" "Ansible %VERSION%" "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\-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\-b\fR, \fB\-\-become\fR
|
|
.RS 4
|
|
Run operations with become (nopasswd implied)
|
|
.RE
|
|
.PP
|
|
\fB\-\-become\-method=BECOME_METHOD\fR
|
|
.RS 4
|
|
Privilege escalation method to use (default=sudo), valid choices: [ sudo | su | pbrun | pfexec | runas | doas ]
|
|
.RE
|
|
.PP
|
|
\fB\-\-become\-user=BECOME_USER\fR
|
|
.RS 4
|
|
Run operations as this user (default=None)\&.
|
|
.RE
|
|
.PP
|
|
\fB\-C\fR, \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\-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\-D\fR, \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\-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)\&. To load variables from a file, specify the file preceded by @ (e\&.g\&. @vars\&.yml)\&.
|
|
.RE
|
|
.PP
|
|
\fB\-\-flush\-cache\fR
|
|
.RS 4
|
|
Clear the fact cache\&.
|
|
.RE
|
|
.PP
|
|
\fB\-\-force\-handlers\fR
|
|
.RS 4
|
|
Run handlers even if a task fails\&.
|
|
.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\-h\fR, \fB\-\-help\fR
|
|
.RS 4
|
|
Show help page and exit
|
|
.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\-l\fR \fISUBSET\fR, \fB\-\-limit=\fR\fISUBSET\fR
|
|
.RS 4
|
|
Further limits the selected host/group patterns\&.
|
|
.RE
|
|
.PP
|
|
\fB\-\-list\-hosts\fR
|
|
.RS 4
|
|
Outputs a list of matching hosts; does not execute anything else\&.
|
|
.RE
|
|
.PP
|
|
\fB\-\-list\-tags\fR
|
|
.RS 4
|
|
List all available tags\&.
|
|
.RE
|
|
.PP
|
|
\fB\-\-list\-tasks\fR
|
|
.RS 4
|
|
List all tasks that would be executed
|
|
.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\-\-private\-key=\fR\fIPRIVATE_KEY_FILE\fR
|
|
.RS 4
|
|
Use this file to authenticate the connection
|
|
.RE
|
|
.PP
|
|
\fB\-\-skip\-tages=\fR\fISKIP_TAGS\fR
|
|
.RS 4
|
|
Only run plays and tasks whose tags do not match these values\&.
|
|
.RE
|
|
.PP
|
|
\fB\-\-start\-at\-task=\fR\fISTART_AT\fR
|
|
.RS 4
|
|
Start the playbook at the task matching this name\&.
|
|
.RE
|
|
.PP
|
|
\fB\-\-step\fR
|
|
.RS 4
|
|
One\-step\-at\-a\-time: confirm each task before running\&.
|
|
.RE
|
|
.PP
|
|
\fB\-S\fR, \-\-su*
|
|
.RS 4
|
|
Run operations with su (deprecated, use become)
|
|
.RE
|
|
.PP
|
|
\fB\-R SU\-USER\fR, \fB\-\-su\-user=\fR\fISU_USER\fR
|
|
.RS 4
|
|
run operations with su as this user (default=root) (deprecated, use become)
|
|
.RE
|
|
.PP
|
|
\fB\-s\fR, \fB\-\-sudo\fR
|
|
.RS 4
|
|
Run operations with sudo (nopasswd) (deprecated, use become)
|
|
.RE
|
|
.PP
|
|
\fB\-U\fR, \fISUDO_USER\fR, \fB\-\-sudo\-user=\fR\fISUDO_USER\fR
|
|
.RS 4
|
|
Desired sudo user (default=root) (deprecated, use become)\&.
|
|
.RE
|
|
.PP
|
|
\fB\-\-skip\-tags=\fR\fISKIP_TAGS\fR
|
|
.RS 4
|
|
Only run plays and tasks whose tags do not match these values\&.
|
|
.RE
|
|
.PP
|
|
\fB\-\-syntax\-check\fR
|
|
.RS 4
|
|
Look for syntax errors in the playbook, but don\(cqt run anything
|
|
.RE
|
|
.PP
|
|
\fB\-t\fR, \fITAGS\fR, \fB\-\-tags=\fR\fITAGS\fR
|
|
.RS 4
|
|
Only run plays and tasks tagged with these values\&.
|
|
.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\-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\-\-vault\-password\-file=\fR\fIVAULT_PASSWORD_FILE\fR
|
|
.RS 4
|
|
Vault password file\&.
|
|
.RE
|
|
.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\-\-version\fR
|
|
.RS 4
|
|
Show program\(cqs version number and exit\&.
|
|
.RE
|
|
.SH "ENVIRONMENT"
|
|
.sp
|
|
The following environment variables may be specified\&.
|
|
.sp
|
|
ANSIBLE_INVENTORY \(em Override the default ansible inventory 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 is available in the documentation site: http://docs\&.ansible\&.com\&. IRC and mailing list info can be found in file CONTRIBUTING\&.md, available in: https://github\&.com/ansible/ansible
|
|
.SH "AUTHOR"
|
|
.PP
|
|
\fB:doctype:manpage\fR
|
|
.RS 4
|
|
Author.
|
|
.RE
|