mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
152 lines
4.7 KiB
Groff
152 lines
4.7 KiB
Groff
'\" t
|
|
.\" Title: ansible
|
|
.\" Author: [see the "AUTHOR" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
|
|
.\" Date: 04/17/2012
|
|
.\" Manual: System administration commands
|
|
.\" Source: Ansible 0.0.2
|
|
.\" Language: English
|
|
.\"
|
|
.TH "ANSIBLE" "1" "04/17/2012" "Ansible 0\&.0\&.2" "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 \- 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 \*(Aqremote things\*(Aq 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 \*(Aq\fIARGUMENTS\fR\*(Aq, \fB\-\-args=\fR\*(Aq\fIARGUMENTS\fR\*(Aq
|
|
.RS 4
|
|
The
|
|
\fIARGUMENTS\fR
|
|
to pass to the module\&.
|
|
.RE
|
|
.sp
|
|
\fB\-D\fR, \fB\-\-debug\fR
|
|
.sp
|
|
Print any messages the remote module sends to standard error to the console
|
|
.sp
|
|
\fB\-k\fR, \fB\-\-ask\-pass\fR
|
|
.sp
|
|
Prompt for the SSH password instead of assuming key\-based authentication with ssh\-agent\&.
|
|
.sp
|
|
\fB\-K\fR, \fB\-\-ask\-sudo\-pass\fR
|
|
.sp
|
|
Prompt for the password to use with \-\-sudo, if any
|
|
.sp
|
|
\fB\-o\fR, \fB\-\-one\-line\fR
|
|
.sp
|
|
Try to output everything on one line\&.
|
|
.sp
|
|
\fB\-s\fR, \fB\-\-sudo\fR
|
|
.sp
|
|
Run the command as the user given by \-u and sudo to root\&.
|
|
.sp
|
|
\fB\-t\fR \fIDIRECTORY\fR, \fB\-\-tree=\fR\fIDIRECTORY\fR
|
|
.sp
|
|
Save contents in this output \fIDIRECTORY\fR, with the results saved in a file named after each host\&.
|
|
.sp
|
|
\fB\-T\fR \fISECONDS\fR, \fB\-\-timeout=\fR\fISECONDS\fR
|
|
.sp
|
|
Connection timeout to use when trying to talk to hosts, in \fISECONDS\fR\&.
|
|
.sp
|
|
\fB\-B\fR \fINUM\fR, \fB\-\-background=\fR\fINUM\fR
|
|
.sp
|
|
Run commands in the background, killing the task after \fINUM\fR seconds\&.
|
|
.sp
|
|
\fB\-P\fR \fINUM\fR, \fB\-\-poll=\fR\fINUM\fR
|
|
.sp
|
|
Poll a background job every \fINUM\fR seconds\&. Requires \fB\-B\fR\&.
|
|
.sp
|
|
\fB\-u\fR \fIUSERNAME\fR, \fB\-\-remote\-user=\fR\fIUSERNAME\fR
|
|
.sp
|
|
Use this remote \fIUSERNAME\fR instead of root\&.
|
|
.sp
|
|
\fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR
|
|
.sp
|
|
Connection type to use\&. Possible options are \fIparamiko\fR (SSH) and \fIlocal\fR\&. Local is mostly useful for crontab or kickstarts\&.
|
|
.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/
|