.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "ANSIBLE-GALAXY" 1 "" "Ansible 2.16.6" "System administration commands"
.SH NAME
ansible-galaxy \- Perform various Role and Collection related operations.
.SH SYNOPSIS
.sp
usage: ansible\-galaxy [\-h] [\-\-version] [\-v] TYPE ...
.SH DESCRIPTION
.sp
Command to manage Ansible roles and collections.
.sp
None of the CLI tools are designed to run concurrently with themselves.
Use an external scheduler and/or locking to ensure there are no clashing
operations.
.SH COMMON OPTIONS
.sp
\fB\-\-version\fP
.INDENT 0.0
.INDENT 3.5
show program\(aqs version number, config file location, configured module search path, module location, executable location and exit
.UNINDENT
.UNINDENT
.sp
\fB\-h\fP, \fB\-\-help\fP
.INDENT 0.0
.INDENT 3.5
show this help message and exit
.UNINDENT
.UNINDENT
.sp
\fB\-v\fP, \fB\-\-verbose\fP
.INDENT 0.0
.INDENT 3.5
Causes Ansible to print more debug messages. Adding multiple \-v will increase the verbosity, the builtin plugins currently evaluate up to \-vvvvvv. A reasonable level to start is \-vvv, connection debugging might require \-vvvv. This argument may be specified multiple times.
.UNINDENT
.UNINDENT
.SH ACTIONS
.INDENT 0.0
.TP
.B \fBcollection\fP
Perform the action on an Ansible Galaxy collection. Must be combined with a further action like init/install as listed below.
.TP
.B \fBcollection download\fP
Download collections and their dependencies as a tarball for an offline install.
.sp
\fB\-\-clear\-response\-cache\fP
.INDENT 7.0
.INDENT 3.5
Clear the existing server response cache.
.UNINDENT
.UNINDENT
.sp
\fB\-\-no\-cache\fP
.INDENT 7.0
.INDENT 3.5
Do not use the server response cache.
.UNINDENT
.UNINDENT
.sp
\fB\-\-pre\fP
.INDENT 7.0
.INDENT 3.5
Include pre\-release versions. Semantic versioning pre\-releases are ignored by default
.UNINDENT
.UNINDENT
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-n\fP,   \fB\-\-no\-deps\fP
.INDENT 7.0
.INDENT 3.5
Don\(aqt download collection(s) listed as dependencies.
.UNINDENT
.UNINDENT
.sp
\fB\-p\fP \(aqDOWNLOAD_PATH\(aq,   \fB\-\-download\-path\fP \(aqDOWNLOAD_PATH\(aq
.INDENT 7.0
.INDENT 3.5
The directory to download the collections to.
.UNINDENT
.UNINDENT
.sp
\fB\-r\fP \(aqREQUIREMENTS\(aq,   \fB\-\-requirements\-file\fP \(aqREQUIREMENTS\(aq
.INDENT 7.0
.INDENT 3.5
A file containing a list of collections to be downloaded.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.TP
.B \fBcollection init\fP
Creates the skeleton framework of a role or collection that complies with the Galaxy metadata format. Requires a role or collection name. The collection name must be in the format \fB<namespace>.<collection>\fP\&.
.sp
\fB\-\-collection\-skeleton\fP \(aqCOLLECTION_SKELETON\(aq
.INDENT 7.0
.INDENT 3.5
The path to a collection skeleton that the new collection should be based upon.
.UNINDENT
.UNINDENT
.sp
\fB\-\-init\-path\fP \(aqINIT_PATH\(aq
.INDENT 7.0
.INDENT 3.5
The path in which the skeleton collection will be created. The default is the current working directory.
.UNINDENT
.UNINDENT
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-f\fP,   \fB\-\-force\fP
.INDENT 7.0
.INDENT 3.5
Force overwriting an existing role or collection
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.TP
.B \fBcollection build\fP
Build an Ansible Galaxy collection artifact that can be stored in a central repository like Ansible Galaxy. By default, this command builds from the current working directory. You can optionally pass in the collection input path (where the \fBgalaxy.yml\fP file is).
.sp
\fB\-\-output\-path\fP \(aqOUTPUT_PATH\(aq
.INDENT 7.0
.INDENT 3.5
The path in which the collection is built to. The default is the current working directory.
.UNINDENT
.UNINDENT
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-f\fP,   \fB\-\-force\fP
.INDENT 7.0
.INDENT 3.5
Force overwriting an existing role or collection
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.TP
.B \fBcollection publish\fP
Publish a collection into Ansible Galaxy. Requires the path to the collection tarball to publish.
.sp
\fB\-\-import\-timeout\fP \(aqIMPORT_TIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for the collection import process to finish.
.UNINDENT
.UNINDENT
.sp
\fB\-\-no\-wait\fP
.INDENT 7.0
.INDENT 3.5
Don\(aqt wait for import validation results.
.UNINDENT
.UNINDENT
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.TP
.B \fBcollection install\fP
Install one or more roles(\fBansible\-galaxy role install\fP), or one or more collections(\fBansible\-galaxy collection install\fP). You can pass in a list (roles or collections) or use the file option listed below (these are mutually exclusive). If you pass in a list, it can be a name (which will be downloaded via the galaxy API and github), or it can be a local tar archive file.
.sp
\fB\-\-clear\-response\-cache\fP
.INDENT 7.0
.INDENT 3.5
Clear the existing server response cache.
.UNINDENT
.UNINDENT
.sp
\fB\-\-disable\-gpg\-verify\fP
.INDENT 7.0
.INDENT 3.5
Disable GPG signature verification when installing collections from a Galaxy server
.UNINDENT
.UNINDENT
.sp
\fB\-\-force\-with\-deps\fP
.INDENT 7.0
.INDENT 3.5
Force overwriting an existing collection and its dependencies.
.UNINDENT
.UNINDENT
.sp
\fB\-\-ignore\-signature\-status\-code\fP
.INDENT 7.0
.INDENT 3.5
==SUPPRESS==. This argument may be specified multiple times.
.UNINDENT
.UNINDENT
.sp
\fB\-\-ignore\-signature\-status\-codes\fP
.INDENT 7.0
.INDENT 3.5
A space separated list of status codes to ignore during signature verification (for example, NO_PUBKEY FAILURE). Descriptions for the choices can be seen at L(\fI\%https://github.com/gpg/gnupg/blob/master/doc/DETAILS#general\-status\-codes).Note\fP: specify these after positional arguments or use \-\- to separate them. This argument may be specified multiple times.
.UNINDENT
.UNINDENT
.sp
\fB\-\-keyring\fP \(aqKEYRING\(aq
.INDENT 7.0
.INDENT 3.5
The keyring used during signature verification
.UNINDENT
.UNINDENT
.sp
\fB\-\-no\-cache\fP
.INDENT 7.0
.INDENT 3.5
Do not use the server response cache.
.UNINDENT
.UNINDENT
.sp
\fB\-\-offline\fP
.INDENT 7.0
.INDENT 3.5
Install collection artifacts (tarballs) without contacting any distribution servers. This does not apply to collections in remote Git repositories or URLs to remote tarballs.
.UNINDENT
.UNINDENT
.sp
\fB\-\-pre\fP
.INDENT 7.0
.INDENT 3.5
Include pre\-release versions. Semantic versioning pre\-releases are ignored by default
.UNINDENT
.UNINDENT
.sp
\fB\-\-required\-valid\-signature\-count\fP \(aqREQUIRED_VALID_SIGNATURE_COUNT\(aq
.INDENT 7.0
.INDENT 3.5
The number of signatures that must successfully verify the collection. This should be a positive integer or \-1 to signify that all signatures must be used to verify the collection. Prepend the value with + to fail if no valid signatures are found for the collection (e.g. +all).
.UNINDENT
.UNINDENT
.sp
\fB\-\-signature\fP
.INDENT 7.0
.INDENT 3.5
An additional signature source to verify the authenticity of the MANIFEST.json before installing the collection from a Galaxy server. Use in conjunction with a positional collection name (mutually exclusive with \-\-requirements\-file). This argument may be specified multiple times.
.UNINDENT
.UNINDENT
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-U\fP,   \fB\-\-upgrade\fP
.INDENT 7.0
.INDENT 3.5
Upgrade installed collection artifacts. This will also update dependencies unless \-\-no\-deps is provided
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-f\fP,   \fB\-\-force\fP
.INDENT 7.0
.INDENT 3.5
Force overwriting an existing role or collection
.UNINDENT
.UNINDENT
.sp
\fB\-i\fP,   \fB\-\-ignore\-errors\fP
.INDENT 7.0
.INDENT 3.5
Ignore errors during installation and continue with the next specified collection. This will not ignore dependency conflict errors.
.UNINDENT
.UNINDENT
.sp
\fB\-n\fP,   \fB\-\-no\-deps\fP
.INDENT 7.0
.INDENT 3.5
Don\(aqt download collections listed as dependencies.
.UNINDENT
.UNINDENT
.sp
\fB\-p\fP \(aqCOLLECTIONS_PATH\(aq,   \fB\-\-collections\-path\fP \(aqCOLLECTIONS_PATH\(aq
.INDENT 7.0
.INDENT 3.5
The path to the directory containing your collections.
.UNINDENT
.UNINDENT
.sp
\fB\-r\fP \(aqREQUIREMENTS\(aq,   \fB\-\-requirements\-file\fP \(aqREQUIREMENTS\(aq
.INDENT 7.0
.INDENT 3.5
A file containing a list of collections to be installed.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.TP
.B \fBcollection list\fP
List installed collections or roles
.sp
\fB\-\-format\fP \(aqOUTPUT_FORMAT\(aq
.INDENT 7.0
.INDENT 3.5
Format to display the list of collections in.
.UNINDENT
.UNINDENT
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-p\fP,   \fB\-\-collections\-path\fP
.INDENT 7.0
.INDENT 3.5
One or more directories to search for collections in addition to the default COLLECTIONS_PATHS. Separate multiple paths with \(aq:\(aq. This argument may be specified multiple times.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.TP
.B \fBcollection verify\fP
Compare checksums with the collection(s) found on the server and the installed copy. This does not verify dependencies.
.sp
\fB\-\-ignore\-signature\-status\-code\fP
.INDENT 7.0
.INDENT 3.5
==SUPPRESS==. This argument may be specified multiple times.
.UNINDENT
.UNINDENT
.sp
\fB\-\-ignore\-signature\-status\-codes\fP
.INDENT 7.0
.INDENT 3.5
A space separated list of status codes to ignore during signature verification (for example, NO_PUBKEY FAILURE). Descriptions for the choices can be seen at L(\fI\%https://github.com/gpg/gnupg/blob/master/doc/DETAILS#general\-status\-codes).Note\fP: specify these after positional arguments or use \-\- to separate them. This argument may be specified multiple times.
.UNINDENT
.UNINDENT
.sp
\fB\-\-keyring\fP \(aqKEYRING\(aq
.INDENT 7.0
.INDENT 3.5
The keyring used during signature verification
.UNINDENT
.UNINDENT
.sp
\fB\-\-offline\fP
.INDENT 7.0
.INDENT 3.5
Validate collection integrity locally without contacting server for canonical manifest hash.
.UNINDENT
.UNINDENT
.sp
\fB\-\-required\-valid\-signature\-count\fP \(aqREQUIRED_VALID_SIGNATURE_COUNT\(aq
.INDENT 7.0
.INDENT 3.5
The number of signatures that must successfully verify the collection. This should be a positive integer or all to signify that all signatures must be used to verify the collection. Prepend the value with + to fail if no valid signatures are found for the collection (e.g. +all).
.UNINDENT
.UNINDENT
.sp
\fB\-\-signature\fP
.INDENT 7.0
.INDENT 3.5
An additional signature source to verify the authenticity of the MANIFEST.json before using it to verify the rest of the contents of a collection from a Galaxy server. Use in conjunction with a positional collection name (mutually exclusive with \-\-requirements\-file). This argument may be specified multiple times.
.UNINDENT
.UNINDENT
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-i\fP,   \fB\-\-ignore\-errors\fP
.INDENT 7.0
.INDENT 3.5
Ignore errors during verification and continue with the next specified collection.
.UNINDENT
.UNINDENT
.sp
\fB\-p\fP,   \fB\-\-collections\-path\fP
.INDENT 7.0
.INDENT 3.5
One or more directories to search for collections in addition to the default COLLECTIONS_PATHS. Separate multiple paths with \(aq:\(aq. This argument may be specified multiple times.
.UNINDENT
.UNINDENT
.sp
\fB\-r\fP \(aqREQUIREMENTS\(aq,   \fB\-\-requirements\-file\fP \(aqREQUIREMENTS\(aq
.INDENT 7.0
.INDENT 3.5
A file containing a list of collections to be verified.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.TP
.B \fBrole\fP
Perform the action on an Ansible Galaxy role. Must be combined with a further action like delete/install/init as listed below.
.TP
.B \fBrole init\fP
Creates the skeleton framework of a role or collection that complies with the Galaxy metadata format. Requires a role or collection name. The collection name must be in the format \fB<namespace>.<collection>\fP\&.
.sp
\fB\-\-init\-path\fP \(aqINIT_PATH\(aq
.INDENT 7.0
.INDENT 3.5
The path in which the skeleton role will be created. The default is the current working directory.
.UNINDENT
.UNINDENT
.sp
\fB\-\-offline\fP
.INDENT 7.0
.INDENT 3.5
Don\(aqt query the galaxy API when creating roles
.UNINDENT
.UNINDENT
.sp
\fB\-\-role\-skeleton\fP \(aqROLE_SKELETON\(aq
.INDENT 7.0
.INDENT 3.5
The path to a role skeleton that the new role should be based upon.
.UNINDENT
.UNINDENT
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-\-type\fP \(aqROLE_TYPE\(aq
.INDENT 7.0
.INDENT 3.5
Initialize using an alternate role type. Valid types include: \(aqcontainer\(aq, \(aqapb\(aq and \(aqnetwork\(aq.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-f\fP,   \fB\-\-force\fP
.INDENT 7.0
.INDENT 3.5
Force overwriting an existing role or collection
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.TP
.B \fBrole remove\fP
removes the list of roles passed as arguments from the local system.
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-p\fP,   \fB\-\-roles\-path\fP
.INDENT 7.0
.INDENT 3.5
The path to the directory containing your roles. The default is the first writable one configured via DEFAULT_ROLES_PATH: {{ ANSIBLE_HOME ~ \(dq/roles:/usr/share/ansible/roles:/etc/ansible/roles\(dq }} . This argument may be specified multiple times.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.TP
.B \fBrole delete\fP
Delete a role from Ansible Galaxy.
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.TP
.B \fBrole list\fP
List installed collections or roles
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-p\fP,   \fB\-\-roles\-path\fP
.INDENT 7.0
.INDENT 3.5
The path to the directory containing your roles. The default is the first writable one configured via DEFAULT_ROLES_PATH: {{ ANSIBLE_HOME ~ \(dq/roles:/usr/share/ansible/roles:/etc/ansible/roles\(dq }} . This argument may be specified multiple times.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.TP
.B \fBrole search\fP
searches for roles on the Ansible Galaxy server
.sp
\fB\-\-author\fP \(aqAUTHOR\(aq
.INDENT 7.0
.INDENT 3.5
GitHub username
.UNINDENT
.UNINDENT
.sp
\fB\-\-galaxy\-tags\fP \(aqGALAXY_TAGS\(aq
.INDENT 7.0
.INDENT 3.5
list of galaxy tags to filter by
.UNINDENT
.UNINDENT
.sp
\fB\-\-platforms\fP \(aqPLATFORMS\(aq
.INDENT 7.0
.INDENT 3.5
list of OS platforms to filter by
.UNINDENT
.UNINDENT
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.TP
.B \fBrole import\fP
used to import a role into Ansible Galaxy
.sp
\fB\-\-branch\fP \(aqREFERENCE\(aq
.INDENT 7.0
.INDENT 3.5
The name of a branch to import. Defaults to the repository\(aqs default branch (usually master)
.UNINDENT
.UNINDENT
.sp
\fB\-\-no\-wait\fP
.INDENT 7.0
.INDENT 3.5
Don\(aqt wait for import results.
.UNINDENT
.UNINDENT
.sp
\fB\-\-role\-name\fP \(aqROLE_NAME\(aq
.INDENT 7.0
.INDENT 3.5
The name the role should have, if different than the repo name
.UNINDENT
.UNINDENT
.sp
\fB\-\-status\fP
.INDENT 7.0
.INDENT 3.5
Check the status of the most recent import request for given github_user/github_repo.
.UNINDENT
.UNINDENT
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.TP
.B \fBrole setup\fP
Setup an integration from Github or Travis for Ansible Galaxy roles
.sp
\fB\-\-list\fP
.INDENT 7.0
.INDENT 3.5
List all of your integrations.
.UNINDENT
.UNINDENT
.sp
\fB\-\-remove\fP \(aqREMOVE_ID\(aq
.INDENT 7.0
.INDENT 3.5
Remove the integration matching the provided ID value. Use \-\-list to see ID values.
.UNINDENT
.UNINDENT
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-p\fP,   \fB\-\-roles\-path\fP
.INDENT 7.0
.INDENT 3.5
The path to the directory containing your roles. The default is the first writable one configured via DEFAULT_ROLES_PATH: {{ ANSIBLE_HOME ~ \(dq/roles:/usr/share/ansible/roles:/etc/ansible/roles\(dq }} . This argument may be specified multiple times.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.TP
.B \fBrole info\fP
prints out detailed information about an installed role as well as info available from the galaxy API.
.sp
\fB\-\-offline\fP
.INDENT 7.0
.INDENT 3.5
Don\(aqt query the galaxy API when creating roles
.UNINDENT
.UNINDENT
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-p\fP,   \fB\-\-roles\-path\fP
.INDENT 7.0
.INDENT 3.5
The path to the directory containing your roles. The default is the first writable one configured via DEFAULT_ROLES_PATH: {{ ANSIBLE_HOME ~ \(dq/roles:/usr/share/ansible/roles:/etc/ansible/roles\(dq }} . This argument may be specified multiple times.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.TP
.B \fBrole install\fP
Install one or more roles(\fBansible\-galaxy role install\fP), or one or more collections(\fBansible\-galaxy collection install\fP). You can pass in a list (roles or collections) or use the file option listed below (these are mutually exclusive). If you pass in a list, it can be a name (which will be downloaded via the galaxy API and github), or it can be a local tar archive file.
.sp
\fB\-\-force\-with\-deps\fP
.INDENT 7.0
.INDENT 3.5
Force overwriting an existing role and its dependencies.
.UNINDENT
.UNINDENT
.sp
\fB\-\-timeout\fP \(aqTIMEOUT\(aq
.INDENT 7.0
.INDENT 3.5
The time to wait for operations against the galaxy server, defaults to 60s.
.UNINDENT
.UNINDENT
.sp
\fB\-\-token\fP \(aqAPI_KEY\(aq,   \fB\-\-api\-key\fP \(aqAPI_KEY\(aq
.INDENT 7.0
.INDENT 3.5
The Ansible Galaxy API key which can be found at \fI\%https://galaxy.ansible.com/me/preferences\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP,   \fB\-\-ignore\-certs\fP
.INDENT 7.0
.INDENT 3.5
Ignore SSL certificate validation errors.
.UNINDENT
.UNINDENT
.sp
\fB\-f\fP,   \fB\-\-force\fP
.INDENT 7.0
.INDENT 3.5
Force overwriting an existing role or collection
.UNINDENT
.UNINDENT
.sp
\fB\-g\fP,   \fB\-\-keep\-scm\-meta\fP
.INDENT 7.0
.INDENT 3.5
Use tar instead of the scm archive option when packaging the role.
.UNINDENT
.UNINDENT
.sp
\fB\-i\fP,   \fB\-\-ignore\-errors\fP
.INDENT 7.0
.INDENT 3.5
Ignore errors and continue with the next specified role.
.UNINDENT
.UNINDENT
.sp
\fB\-n\fP,   \fB\-\-no\-deps\fP
.INDENT 7.0
.INDENT 3.5
Don\(aqt download roles listed as dependencies.
.UNINDENT
.UNINDENT
.sp
\fB\-p\fP,   \fB\-\-roles\-path\fP
.INDENT 7.0
.INDENT 3.5
The path to the directory containing your roles. The default is the first writable one configured via DEFAULT_ROLES_PATH: {{ ANSIBLE_HOME ~ \(dq/roles:/usr/share/ansible/roles:/etc/ansible/roles\(dq }} . This argument may be specified multiple times.
.UNINDENT
.UNINDENT
.sp
\fB\-r\fP \(aqREQUIREMENTS\(aq,   \fB\-\-role\-file\fP \(aqREQUIREMENTS\(aq
.INDENT 7.0
.INDENT 3.5
A file containing a list of roles to be installed.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \(aqAPI_SERVER\(aq,   \fB\-\-server\fP \(aqAPI_SERVER\(aq
.INDENT 7.0
.INDENT 3.5
The Galaxy API server URL
.UNINDENT
.UNINDENT
.UNINDENT
.SH ENVIRONMENT
.sp
The following environment variables may be specified.
.sp
ANSIBLE_CONFIG \-\- Specify override location for the ansible config file
.sp
Many more are available for most options in ansible.cfg
.sp
For a full list check \fI\%https://docs.ansible.com/\fP\&. or use the \fIansible\-config\fP command.
.SH FILES
.sp
/etc/ansible/ansible.cfg \-\- Config file, used if present
.sp
~/.ansible.cfg \-\- User config file, overrides the default config if present
.sp
\&./ansible.cfg \-\- Local config file (in current working directory) assumed to be \(aqproject specific\(aq and overrides the rest if present.
.sp
As mentioned above, the ANSIBLE_CONFIG environment variable will override all others.
.SH AUTHOR
.sp
Ansible was originally written by Michael DeHaan.
.SH COPYRIGHT
.sp
Copyright © 2018 Red Hat, Inc | Ansible.
Ansible is released under the terms of the GPLv3 license.
.SH SEE ALSO
.sp
\fBansible\fP (1), \fBansible\-config\fP (1), \fBansible\-console\fP (1), \fBansible\-doc\fP (1), \fBansible\-inventory\fP (1), \fBansible\-playbook\fP (1), \fBansible\-pull\fP (1), \fBansible\-vault\fP (1)
.sp
Extensive documentation is available in the documentation site:
<\fI\%https://docs.ansible.com\fP>.
IRC and mailing list info can be found in file CONTRIBUTING.md,
available in: <\fI\%https://github.com/ansible/ansible\fP>
.\" Generated by docutils manpage writer.
.