5
:man version: %VERSION%
6
:man manual: System administration commands
10
ansible-galaxy - manage roles using galaxy.ansible.com
15
ansible-galaxy [init|info|install|list|remove] [--help] [options] ...
21
*Ansible Galaxy* is a shared repository for Ansible roles (added in
22
ansible version 1.2). The ansible-galaxy command can be used to manage
23
these roles, or by creating a skeleton framework for roles you'd like
31
Show a help message related to the given sub-command.
37
The *install* sub-command is used to install roles.
42
$ ansible-galaxy install [options] [-r FILE | role_name(s)[,version] | tar_file(s)]
44
Roles can be installed in several different ways:
46
* A username.rolename[,version] - this will install a single role. The Galaxy
47
API will be contacted to provide the information about the role, and the
48
corresponding .tar.gz will be downloaded from *github.com*. If the version
49
is omitted, the most recent version available will be installed.
51
* A file name, using *-r* - this will install multiple roles listed one per
52
line. The format of each line is the same as above: username.rolename[,version]
54
* A .tar.gz of a valid role you've downloaded directly from *github.com*. This
55
is mainly useful when the system running Ansible does not have access to
56
the Galaxy API, for instance when behind a firewall or proxy.
64
Force overwriting an existing role.
66
*-i*, *--ignore-errors*::
68
Ignore errors and continue with the next specified role.
72
Don't download roles listed as dependencies.
74
*-p* 'ROLES_PATH', *--roles-path=*'ROLES_PATH'::
76
The path to the directory containing your roles. The default is the *roles_path*
77
configured in your *ansible.cfg* file (/etc/ansible/roles if not configured)
79
*-r* 'ROLE_FILE', *--role-file=*'ROLE_FILE'::
81
A file containing a list of roles to be imported, as specified above. This
82
option cannot be used if a rolename or .tar.gz have been specified.
87
The *remove* sub-command is used to remove one or more roles.
92
$ ansible-galaxy remove role1 role2 ...
97
*-p* 'ROLES_PATH', *--roles-path=*'ROLES_PATH'::
99
The path to the directory containing your roles. The default is the *roles_path*
100
configured in your *ansible.cfg* file (/etc/ansible/roles if not configured)
105
The *init* command is used to create an empty role suitable for uploading
106
to https://galaxy.ansible.com (or for roles in general).
111
$ ansible-galaxy init [options] role_name
118
Force overwriting an existing role.
120
*-p* 'INIT_PATH', *--init-path=*'INIT_PATH'::
122
The path in which the skeleton role will be created.The default is the current
128
The *list* sub-command is used to show what roles are currently instaled.
129
You can specify a role name, and if installed only that role will be shown.
134
$ ansible-galaxy list [role_name]
139
*-p* 'ROLES_PATH', *--roles-path=*'ROLES_PATH'::
141
The path to the directory containing your roles. The default is the *roles_path*
142
configured in your *ansible.cfg* file (/etc/ansible/roles if not configured)
148
Ansible was originally written by Michael DeHaan. See the AUTHORS file
149
for a complete list of contributors.
155
Copyright © 2014, Michael DeHaan
157
Ansible is released under the terms of the GPLv3 License.
163
*ansible*(1), *ansible-pull*(1), *ansible-doc*(1)
165
Extensive documentation is available in the documentation site:
166
<http://docs.ansible.com>. IRC and mailing list info can be found
167
in file CONTRIBUTING.md, available in: <https://github.com/ansible/ansible>
added
removed
docs/man/man1/ansible-galaxy.1.asciidoc.in
