mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
96 lines
3.1 KiB
Groff
96 lines
3.1 KiB
Groff
'\" t
|
|
.\" Title: ansible
|
|
.\" Author: [see the "AUTHOR" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
|
|
.\" Date: 02/28/2012
|
|
.\" Manual: System administration commands
|
|
.\" Source: Ansible 0.0.1
|
|
.\" Language: English
|
|
.\"
|
|
.TH "ANSIBLE" "1" "02/28/2012" "Ansible 0\&.0\&.1" "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 [\-f forks] [\-p pattern ] [\-u remote_user] [\-n module_name] [\-a [args1 [args2 \&...]]]
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
\fBAnsible\fR is an extra\-simple tool/framework/API for doing \'remote things\' over SSH\&.
|
|
.SH "OPTIONS"
|
|
.PP
|
|
\fB\-k\fR, \fB\-\-ask\-pass\fR
|
|
.RS 4
|
|
Ask the user to input the ssh password for connecting\&. Generally using ssh\-agent instead is preferred\&.
|
|
.RE
|
|
.PP
|
|
\fB\-l\fR, \fB\-\-host\-list\fR
|
|
.RS 4
|
|
Path to hosts list, which defaults to /etc/ansible/hosts\&. Users can use multiple files to emulate groups of systems\&.
|
|
.RE
|
|
.PP
|
|
\fB\-m\fR, \fB\-\-module\-path\fR
|
|
.RS 4
|
|
Override the path to module library, which defaults to /usr/share/ansible\&. The module library contains runnable modules that do
|
|
\fIthings\fR
|
|
to remote hosts\&. See ansible\-modules(5) for a list of those that bundled with Ansible\&.
|
|
.RE
|
|
.PP
|
|
\fB\-f\fR, \fB\-\-forks\fR
|
|
.RS 4
|
|
Level of parallelism\&. Specify as an integer, the default is 3\&. If set to "1" debugging for certain classes of internal errors may become easier\&.
|
|
.RE
|
|
.PP
|
|
\fB\-n\fR, \fB\-\-name\fR
|
|
.RS 4
|
|
Module name to execute\&.
|
|
.RE
|
|
.PP
|
|
\fB\-a\fR, \fB\-\-args\fR
|
|
.RS 4
|
|
Arguments to module, as a single string\&. Be sure to observe proper shell quoting rules\&. How these are handled are up to the module, but most modules take "key=value" pairs delimited by spaces\&.
|
|
.RE
|
|
.PP
|
|
\fB\-p\fR, \fB\-\-pattern\fR
|
|
.RS 4
|
|
Hostname pattern\&. Accepts shell\-like globs which can be seperated with ";" The default is "*" which matches all hosts in the ansible hosts file\&.
|
|
.RE
|
|
.PP
|
|
\fB\-u\fR, \fB\-\-remote\-user\fR
|
|
.RS 4
|
|
Remote user to connect as\&. Uses
|
|
\fIroot\fR
|
|
by default\&.
|
|
.RE
|
|
.SH "INVENTORY"
|
|
.sp
|
|
Ansible stores the hosts it can potentially operate on in an inventory file\&. The syntax is simple: one host per line\&. Organize your hosts into multiple groups by separating them into multiple inventory files\&.
|
|
.SH "FILES"
|
|
.sp
|
|
/etc/ansible/hosts \(em Default hosts file
|
|
.sp
|
|
/usr/share/ansible \(em Default module library
|
|
.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\-modules\fR(5),
|
|
.sp
|
|
\fBansible\-playbook\fR(5),
|
|
.sp
|
|
Ansible home page: https://github\&.com/mpdehaan/ansible/
|