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

140 lines
4.1 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 17:08:42 +02:00
'\" t
.\" Title: ansible-playbook
.\" Author: [see the "AUTHOR" section]
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 16:46:16 +02:00
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
Fully document the -v option.
2012-08-15 16:13:38 +02:00
.\" Date: 08/15/2012
host file must be marked config(noreplace), update rpm build to use checked in manpage src
2012-03-31 17:08:42 +02:00
.\" Manual: System administration commands
docs build
2012-08-07 01:57:23 +02:00
.\" Source: Ansible 0.7
host file must be marked config(noreplace), update rpm build to use checked in manpage src
2012-03-31 17:08:42 +02:00
.\" Language: English
.\"
Fully document the -v option.
2012-08-15 16:13:38 +02:00
.TH "ANSIBLE\-PLAYBOOK" "1" "08/15/2012" "Ansible 0\&.7" "System administration commands"
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 16:46:16 +02: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 17:08:42 +02: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 16:13:38 +02: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 03:55:57 +02:00
\fB\-v\fR, \fB\-\-verbose\fR
Fully document the -v option.
2012-08-15 16:13:38 +02: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 17:08:42 +02:00
.PP
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01: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 17:08:42 +02:00
.RS 4
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01: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 17:08:42 +02:00
.RE
.PP
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01: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 17:08:42 +02:00
.RS 4
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01:00
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
2012-03-31 17:08:42 +02: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-27 01:56:10 +02:00
\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
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01: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 17:08:42 +02:00
.RS 4
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01: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 17:08:42 +02: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-14 01:40:40 +02: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 16:46:16 +02: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-14 01:40:40 +02:00
.RE
.PP
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01: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 17:08:42 +02:00
.RS 4
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01: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 17:08:42 +02:00
.RE
manpage updates
2012-04-14 01:40:40 +02:00
.PP
Update docs to reflect --port going away and --sudo and --remote-user being added to ansible-playbook
2012-04-17 04:22:37 +02:00
\fB\-s\fR, \fB\-\-sudo\fR
Fix man page option description indentation.
2012-04-17 17:39:51 +02:00
.RS 4
Update docs to reflect --port going away and --sudo and --remote-user being added to ansible-playbook
2012-04-17 04:22:37 +02:00
Force all plays to use sudo, even if not marked as such\&.
Fix man page option description indentation.
2012-04-17 17:39:51 +02:00
.RE
.PP
Update docs to reflect --port going away and --sudo and --remote-user being added to ansible-playbook
2012-04-17 04:22:37 +02:00
\fB\-u\fR \fIUSERNAME\fR, \fB\-\-remote\-user=\fR\fIUSERNAME\fR
Fix man page option description indentation.
2012-04-17 17:39:51 +02:00
.RS 4
Update docs to reflect --port going away and --sudo and --remote-user being added to ansible-playbook
2012-04-17 04:22:37 +02: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 17:39:51 +02: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 16:46:16 +02: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
host file must be marked config(noreplace), update rpm build to use checked in manpage src
2012-03-31 17:08:42 +02:00
.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
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 16:46:16 +02:00
\fBansible\fR(1), \fBansible\-pull\fR(1)
host file must be marked config(noreplace), update rpm build to use checked in manpage src
2012-03-31 17:08:42 +02:00
.sp
Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/
Reference in a new issue Copy permalink