wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ansible/docs/man/man1/ansible-playbook.1

184 lines
5.5 KiB
Groff
Raw Normal View History

host file must be marked config(noreplace), update rpm build to use checked in manpage src
2012-03-31 15:08:42 +00:00
'\" t
.\" Title: ansible-playbook
Add reference to Guru to sidebar.
2014-01-30 17:32:05 +00:00
.\" Author: :doctype:manpage
Document the --offline parameter to galaxy init Fixes #9758
2014-12-09 18:49:05 +00:00
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 12/09/2014
host file must be marked config(noreplace), update rpm build to use checked in manpage src
2012-03-31 15:08:42 +00:00
.\" Manual: System administration commands
Document the --offline parameter to galaxy init Fixes #9758
2014-12-09 18:49:05 +00:00
.\" Source: Ansible 1.9
host file must be marked config(noreplace), update rpm build to use checked in manpage src
2012-03-31 15:08:42 +00:00
.\" Language: English
.\"
Document the --offline parameter to galaxy init Fixes #9758
2014-12-09 18:49:05 +00:00
.TH "ANSIBLE\-PLAYBOOK" "1" "12/09/2014" "Ansible 1\&.9" "System administration commands"
Add reference to Guru to sidebar.
2014-01-30 17:32:05 +00: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 '
host file must be marked config(noreplace), update rpm build to use checked in manpage src
2012-03-31 15:08:42 +00: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
\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"
Fully document the -v option.
2012-08-15 14:13:38 +00:00
.PP
Remove the -D module debug flag, which no longer is functional due to sudo pty requirements, and replace with -v/--verbose. This flag will show playbook output from non-failing commands. -v is also added to /usr/bin/ansible, but not yet used. I also gutted some internals code dealing with 'invocations' which allowed the callback to know what module invoked it. This is not something 0.5 does or needed, so callbacks have been simplified.
2012-06-20 01:55:57 +00:00
\fB\-v\fR, \fB\-\-verbose\fR
Fully document the -v option.
2012-08-15 14:13:38 +00:00
.RS 4
Verbose mode, more output from successful actions will be shown\&. Give up to three times for more output\&.
.RE
host file must be marked config(noreplace), update rpm build to use checked in manpage src
2012-03-31 15:08:42 +00:00
.PP
Show when options require arguments in the man pages.
2012-03-24 02:29:51 +00:00
\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
2012-03-31 15:08:42 +00:00
.RS 4
Show when options require arguments in the man pages.
2012-03-24 02:29:51 +00:00
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
2012-03-31 15:08:42 +00:00
.RE
.PP
Show when options require arguments in the man pages.
2012-03-24 02:29:51 +00:00
\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
2012-03-31 15:08:42 +00:00
.RS 4
Show when options require arguments in the man pages.
2012-03-24 02:29:51 +00:00
The
\fIDIRECTORY\fR
Manpage tweaks, docs rebuild
2013-05-29 14:30:04 +00:00
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\&.
host file must be marked config(noreplace), update rpm build to use checked in manpage src
2012-03-31 15:08:42 +00:00
.RE
.PP
Reinstate --extra-vars, which can do things in playbooks like: ansible-playbook release-my-app.yml --extra-vars="version=123" And make $version available in the playbook without re-editing the file
2012-04-26 23:56:10 +00:00
\fB\-e\fR \fIVARS\fR, \fB\-\-extra\-vars=\fR\fIVARS\fR
.RS 4
Disable inventory test
2013-06-03 15:52:42 +00:00
Extra variables to inject into a playbook, in key=value key=value format or as quoted JSON (hashes and arrays)\&.
Reinstate --extra-vars, which can do things in playbooks like: ansible-playbook release-my-app.yml --extra-vars="version=123" And make $version available in the playbook without re-editing the file
2012-04-26 23:56:10 +00:00
.RE
.PP
Show when options require arguments in the man pages.
2012-03-24 02:29:51 +00:00
\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
2012-03-31 15:08:42 +00:00
.RS 4
Show when options require arguments in the man pages.
2012-03-24 02:29:51 +00:00
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
2012-03-31 15:08:42 +00: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
manpage updates
2012-04-13 23:40:40 +00:00
\fB\-K\fR, \fB\-\-ask\-sudo\-pass\fR
.RS 4
Add some docs/examples Add a basic ansible-pull man page. Add the example playbooks/scripts to the RPM package. Closes #841
2012-08-14 14:46:16 +00:00
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)\&.
manpage updates
2012-04-13 23:40:40 +00:00
.RE
.PP
Update test strategies guide.
2014-05-26 12:12:39 +00:00
\fB\-t\fR, \fITAGS\fR, \fB\-\-tags=\fR\fITAGS\fR
Add reference to Guru to sidebar.
2014-01-30 17:32:05 +00:00
.RS 4
Only run plays and tasks tagged with these values\&.
.RE
.PP
Update test strategies guide.
2014-05-26 12:12:39 +00:00
\fB\-\-skip\-tags=\fR\fISKIP_TAGS\fR
update manpage for new options.
2013-02-16 20:38:59 +00:00
.RS 4
Add reference to Guru to sidebar.
2014-01-30 17:32:05 +00:00
Only run plays and tasks whose tags do not match these values\&.
update manpage for new options.
2013-02-16 20:38:59 +00:00
.RE
.PP
align manpages with actual code for --syntax-check
2013-03-05 23:42:53 +00:00
\fB\-\-syntax\-check\fR
update manpage for new options.
2013-02-16 20:38:59 +00:00
.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
Show when options require arguments in the man pages.
2012-03-24 02:29:51 +00:00
\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
2012-03-31 15:08:42 +00:00
.RS 4
Show when options require arguments in the man pages.
2012-03-24 02:29:51 +00:00
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
2012-03-31 15:08:42 +00:00
.RE
manpage updates
2012-04-13 23:40:40 +00:00
.PP
Update docs to reflect --port going away and --sudo and --remote-user being added to ansible-playbook
2012-04-17 02:22:37 +00:00
\fB\-s\fR, \fB\-\-sudo\fR
Fix man page option description indentation.
2012-04-17 15:39:51 +00:00
.RS 4
Update docs to reflect --port going away and --sudo and --remote-user being added to ansible-playbook
2012-04-17 02:22:37 +00:00
Force all plays to use sudo, even if not marked as such\&.
Fix man page option description indentation.
2012-04-17 15:39:51 +00:00
.RE
.PP
Add version_added to all modules missing version_added information, the docs formatter will now raise errors when omitted, updated changelog with new modules.
2013-11-18 23:55:49 +00:00
\fB\-u\fR \fIUSERNAME\fR, \fB\-\-user=\fR\fIUSERNAME\fR
Fix man page option description indentation.
2012-04-17 15:39:51 +00:00
.RS 4
Update docs to reflect --port going away and --sudo and --remote-user being added to ansible-playbook
2012-04-17 02:22:37 +00:00
Use this remote user name on playbook steps that do not indicate a user name to run as\&.
Fix man page option description indentation.
2012-04-17 15:39:51 +00:00
.RE
Add some docs/examples Add a basic ansible-pull man page. Add the example playbooks/scripts to the RPM package. Closes #841
2012-08-14 14:46:16 +00:00
.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
Add --limit to manpage
2012-09-06 22:42:18 +00:00
.PP
\fB\-l\fR \fISUBSET\fR, \fB\-\-limit=\fR\fISUBSET\fR
.RS 4
Further limits the selected host/group patterns\&.
.RE
Add --list-hosts to man pages. Fixes #9574
2015-02-27 13:38:45 +00:00
.PP
\fB\-\-list\-hosts\fR
.RS 4
Outputs a list of matching hosts; does not execute anything else\&.
.RE
host file must be marked config(noreplace), update rpm build to use checked in manpage src
2012-03-31 15:08:42 +00:00
.SH "ENVIRONMENT"
.sp
Minor grammar fix in manpages
2014-02-11 15:50:10 +00:00
The following environment variables may be specified\&.
host file must be marked config(noreplace), update rpm build to use checked in manpage src
2012-03-31 15:08:42 +00:00
.sp
ANSIBLE_HOSTS \(em Override the default ansible hosts file
.sp
ANSIBLE_LIBRARY \(em Override the default ansible module library path
HP and vsphere modules are crazy awesome but I am thinking these belong in contrib not core.
2012-10-12 21:49:48 +00:00
.SH "FILES"
.sp
/etc/ansible/hosts \(em Default inventory file
.sp
/usr/share/ansible/ \(em Default module library
.sp
Manpage documentation ALSO should be sorted
2012-11-03 22:54:38 +00:00
/etc/ansible/ansible\&.cfg \(em Config file, used if present
HP and vsphere modules are crazy awesome but I am thinking these belong in contrib not core.
2012-10-12 21:49:48 +00:00
.sp
Manpage documentation ALSO should be sorted
2012-11-03 22:54:38 +00:00
~/\&.ansible\&.cfg \(em User config file, overrides the default config if present
host file must be marked config(noreplace), update rpm build to use checked in manpage src
2012-03-31 15:08:42 +00:00
.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
Update release version.
2013-04-03 00:47:57 +00:00
\fBansible\fR(1), \fBansible\-pull\fR(1), \fBansible\-doc\fR(1)
host file must be marked config(noreplace), update rpm build to use checked in manpage src
2012-03-31 15:08:42 +00:00
.sp
Updated footer date and adding in misc. file generated by earlier doc update
2014-02-12 22:14:41 +00:00
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
Reference in a new issue Copy permalink