You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

Using Ansible collections

Note

Making Open Source More Inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. We ask that you open an issue or pull request if you come upon a term that we have missed. For more details, see our CTO Chris Wright’s message.

Welcome to the Ansible guide for working with collections.

Collections are a distribution format for Ansible content that can include playbooks, roles, modules, and plugins. You can install and use collections through a distribution server, such as Ansible Galaxy, or a Pulp 3 Galaxy server.

• Installing collections
  • Installing collections with ansible-galaxy
  • Installing collections with signature verification
  • Installing an older version of a collection
  • Install multiple collections with a requirements file
  • Downloading a collection for offline use
  • Installing a collection from source files
  • Installing a collection from a git repository
  • Configuring the ansible-galaxy client
• Removing a collection
• Downloading collections
• Listing collections
• Verifying collections
  • Verifying collections with ansible-galaxy
  • Verifying signed collections
• Using collections in a playbook
  • Simplifying module names with the collections keyword
  • Using collections in roles
  • Using collections in playbooks
  • Using a playbook from a collection
• Collections index