ansible-galaxy

ansible-galaxy [role|collection] command [options]

ansible-galaxy manages Ansible roles and collections from Ansible Galaxy and other sources. Galaxy is a public repository of community-contributed content, providing reusable automation components.The tool can install, create, and manage roles (traditional content) and collections (bundled content including modules, plugins, and roles). Subcommands are grouped by content type as ansible-galaxy role command and ansible-galaxy collection command; if the type is omitted, role is assumed (for example, "ansible-galaxy install" is equivalent to "ansible-galaxy role install").

install name

Install a role (or use "collection install" for a collection)

Create a new role or collection scaffold

List installed roles or collections

Search Galaxy for roles

Show detailed information about a role or collection

Remove an installed role or collection

Build a collection artifact (collection only)

Publish a collection to a Galaxy server (collection only)

Install items listed in a YAML requirements file

Installation path for roles (--collections-path for collections)

Force overwrite of an existing role or collection

Galaxy API server URL

Work offline (init/install/verify, using installed content only)

/etc/ansible/ansible.cfg

System-wide Ansible configuration, including Galaxy server URL and roles path.

Per-user Ansible configuration overriding system defaults.

Project-level configuration in the current directory, highest priority.

Galaxy content is community-maintained; review before use in production. Collection names are namespaced (namespace.collection). Roles and collections have different installation paths.

ansible-galaxy was introduced with Ansible Galaxy in 2013 to share and distribute roles. Collections support was added in Ansible 2.9 (2019) as a new content distribution format.

ansible(1), ansible-playbook(1), ansible-doc(1)

Source code · Documentation