mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
181 lines
5.6 KiB
Groff
181 lines
5.6 KiB
Groff
'\" t
|
|
.\" Title: ansible-galaxy
|
|
.\" Author: [see the "AUTHOR" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
|
|
.\" Date: 05/26/2014
|
|
.\" Manual: System administration commands
|
|
.\" Source: Ansible 1.7
|
|
.\" Language: English
|
|
.\"
|
|
.TH "ANSIBLE\-GALAXY" "1" "05/26/2014" "Ansible 1\&.7" "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-galaxy \- manage roles using galaxy\&.ansible\&.com
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
ansible\-galaxy [init|info|install|list|remove] [\-\-help] [options] \&...
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
\fBAnsible Galaxy\fR is a shared repository for Ansible roles (added in ansible version 1\&.2)\&. The ansible\-galaxy command can be used to manage these roles, or by creating a skeleton framework for roles you\(cqd like to upload to Galaxy\&.
|
|
.SH "COMMON OPTIONS"
|
|
.PP
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
.RS 4
|
|
Show a help message related to the given sub\-command\&.
|
|
.RE
|
|
.SH "INSTALL"
|
|
.sp
|
|
The \fBinstall\fR sub\-command is used to install roles\&.
|
|
.SS "USAGE"
|
|
.sp
|
|
$ ansible\-galaxy install [options] [\-r FILE | role_name(s)[,version] | tar_file(s)]
|
|
.sp
|
|
Roles can be installed in several different ways:
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
A username\&.rolename[,version] \- this will install a single role\&. The Galaxy API will be contacted to provide the information about the role, and the corresponding \&.tar\&.gz will be downloaded from
|
|
\fBgithub\&.com\fR\&. If the version is omitted, the most recent version available will be installed\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
A file name, using
|
|
\fB\-r\fR
|
|
\- this will install multiple roles listed one per line\&. The format of each line is the same as above: username\&.rolename[,version]
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
A \&.tar\&.gz of a valid role you\(cqve downloaded directly from
|
|
\fBgithub\&.com\fR\&. This is mainly useful when the system running Ansible does not have access to the Galaxy API, for instance when behind a firewall or proxy\&.
|
|
.RE
|
|
.SS "OPTIONS"
|
|
.PP
|
|
\fB\-f\fR, \fB\-\-force\fR
|
|
.RS 4
|
|
Force overwriting an existing role\&.
|
|
.RE
|
|
.PP
|
|
\fB\-i\fR, \fB\-\-ignore\-errors\fR
|
|
.RS 4
|
|
Ignore errors and continue with the next specified role\&.
|
|
.RE
|
|
.PP
|
|
\fB\-n\fR, \fB\-\-no\-deps\fR
|
|
.RS 4
|
|
Don\(cqt download roles listed as dependencies\&.
|
|
.RE
|
|
.PP
|
|
\fB\-p\fR \fIROLES_PATH\fR, \fB\-\-roles\-path=\fR\fIROLES_PATH\fR
|
|
.RS 4
|
|
The path to the directory containing your roles\&. The default is the
|
|
\fBroles_path\fR
|
|
configured in your
|
|
\fBansible\&.cfg\fR
|
|
file (/etc/ansible/roles if not configured)
|
|
.RE
|
|
.PP
|
|
\fB\-r\fR \fIROLE_FILE\fR, \fB\-\-role\-file=\fR\fIROLE_FILE\fR
|
|
.RS 4
|
|
A file containing a list of roles to be imported, as specified above\&. This option cannot be used if a rolename or \&.tar\&.gz have been specified\&.
|
|
.RE
|
|
.SH "REMOVE"
|
|
.sp
|
|
The \fBremove\fR sub\-command is used to remove one or more roles\&.
|
|
.SS "USAGE"
|
|
.sp
|
|
$ ansible\-galaxy remove role1 role2 \&...
|
|
.SS "OPTIONS"
|
|
.PP
|
|
\fB\-p\fR \fIROLES_PATH\fR, \fB\-\-roles\-path=\fR\fIROLES_PATH\fR
|
|
.RS 4
|
|
The path to the directory containing your roles\&. The default is the
|
|
\fBroles_path\fR
|
|
configured in your
|
|
\fBansible\&.cfg\fR
|
|
file (/etc/ansible/roles if not configured)
|
|
.RE
|
|
.SH "INIT"
|
|
.sp
|
|
The \fBinit\fR command is used to create an empty role suitable for uploading to https://galaxy\&.ansible\&.com (or for roles in general)\&.
|
|
.SS "USAGE"
|
|
.sp
|
|
$ ansible\-galaxy init [options] role_name
|
|
.SS "OPTIONS"
|
|
.PP
|
|
\fB\-f\fR, \fB\-\-force\fR
|
|
.RS 4
|
|
Force overwriting an existing role\&.
|
|
.RE
|
|
.PP
|
|
\fB\-p\fR \fIINIT_PATH\fR, \fB\-\-init\-path=\fR\fIINIT_PATH\fR
|
|
.RS 4
|
|
The path in which the skeleton role will be created\&.The default is the current working directory\&.
|
|
.RE
|
|
.SH "LIST"
|
|
.sp
|
|
The \fBlist\fR sub\-command is used to show what roles are currently instaled\&. You can specify a role name, and if installed only that role will be shown\&.
|
|
.SS "USAGE"
|
|
.sp
|
|
$ ansible\-galaxy list [role_name]
|
|
.SS "OPTIONS"
|
|
.PP
|
|
\fB\-p\fR \fIROLES_PATH\fR, \fB\-\-roles\-path=\fR\fIROLES_PATH\fR
|
|
.RS 4
|
|
The path to the directory containing your roles\&. The default is the
|
|
\fBroles_path\fR
|
|
configured in your
|
|
\fBansible\&.cfg\fR
|
|
file (/etc/ansible/roles if not configured)
|
|
.RE
|
|
.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 2014, Michael DeHaan
|
|
.sp
|
|
Ansible is released under the terms of the GPLv3 License\&.
|
|
.SH "SEE ALSO"
|
|
.sp
|
|
\fBansible\fR(1), \fBansible\-pull\fR(1), \fBansible\-doc\fR(1)
|
|
.sp
|
|
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
|