81adae619a
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.
168 lines
4.4 KiB
Groff
168 lines
4.4 KiB
Groff
'\" t
|
|
.\" Title: ansible
|
|
.\" Author: [see the "AUTHOR" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
|
|
.\" Date: 06/19/2012
|
|
.\" Manual: System administration commands
|
|
.\" Source: Ansible 0.5
|
|
.\" Language: English
|
|
.\"
|
|
.TH "ANSIBLE" "1" "06/19/2012" "Ansible 0\&.5" "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 \- run a command somewhere else
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
ansible <host\-pattern> [\-f forks] [\-m module_name] [\-a args]
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
\fBAnsible\fR is an extra\-simple tool/framework/API for doing \'remote things\' over SSH\&.
|
|
.SH "ARGUMENTS"
|
|
.PP
|
|
\fBhost\-pattern\fR
|
|
.RS 4
|
|
A name of a group in the inventory file, a shell\-like glob selecting hosts in inventory file, or any combination of the two separated by semicolons\&.
|
|
.RE
|
|
.SH "OPTIONS"
|
|
.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\-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\-m\fR \fINAME\fR, \fB\-\-module\-name=\fR\fINAME\fR
|
|
.RS 4
|
|
Execute the module called
|
|
\fINAME\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\-a\fR \'\fIARGUMENTS\fR\', \fB\-\-args=\fR\'\fIARGUMENTS\fR\'
|
|
.RS 4
|
|
The
|
|
\fIARGUMENTS\fR
|
|
to pass to the module\&.
|
|
.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 with \-\-sudo, if any
|
|
.RE
|
|
.PP
|
|
\fB\-o\fR, \fB\-\-one\-line\fR
|
|
.RS 4
|
|
Try to output everything on one line\&.
|
|
.RE
|
|
.PP
|
|
\fB\-s\fR, \fB\-\-sudo\fR
|
|
.RS 4
|
|
Run the command as the user given by \-u and sudo to root\&.
|
|
.RE
|
|
.PP
|
|
\fB\-t\fR \fIDIRECTORY\fR, \fB\-\-tree=\fR\fIDIRECTORY\fR
|
|
.RS 4
|
|
Save contents in this output
|
|
\fIDIRECTORY\fR, with the results saved in a file named after each host\&.
|
|
.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\-B\fR \fINUM\fR, \fB\-\-background=\fR\fINUM\fR
|
|
.RS 4
|
|
Run commands in the background, killing the task after
|
|
\fINUM\fR
|
|
seconds\&.
|
|
.RE
|
|
.PP
|
|
\fB\-P\fR \fINUM\fR, \fB\-\-poll=\fR\fINUM\fR
|
|
.RS 4
|
|
Poll a background job every
|
|
\fINUM\fR
|
|
seconds\&. Requires
|
|
\fB\-B\fR\&.
|
|
.RE
|
|
.PP
|
|
\fB\-u\fR \fIUSERNAME\fR, \fB\-\-remote\-user=\fR\fIUSERNAME\fR
|
|
.RS 4
|
|
Use this remote
|
|
\fIUSERNAME\fR
|
|
instead of root\&.
|
|
.RE
|
|
.PP
|
|
\fB\-U\fR \fISUDO_USERNAME\fR, \fB\-\-sudo\-user=\fR\fISUDO_USERNAME\fR
|
|
.RS 4
|
|
Sudo to
|
|
\fISUDO_USERNAME\fR
|
|
instead of root\&. Implies \-\-sudo\&.
|
|
.RE
|
|
.PP
|
|
\fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR
|
|
.RS 4
|
|
Connection type to use\&. Possible options are
|
|
\fIparamiko\fR
|
|
(SSH) and
|
|
\fIlocal\fR\&. Local is mostly useful for crontab or kickstarts\&.
|
|
.RE
|
|
.SH "INVENTORY"
|
|
.sp
|
|
Ansible stores the hosts it can potentially operate on in an inventory file\&. The syntax is one host per line\&. Groups headers are allowed and are included on their own line, enclosed in square brackets\&.
|
|
.SH "FILES"
|
|
.sp
|
|
/etc/ansible/hosts \(em Default inventory file
|
|
.sp
|
|
/usr/share/ansible/ \(em Default module library
|
|
.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\-playbook\fR(1)
|
|
.sp
|
|
Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/
|