Installation

Collections are a distribution format for prepackaged Ansible content including playbooks, roles, modules, and plugins that enable you to quickly set up your automation project. Collections are hosted and available for installation from Ansible Galaxy.

Before you install a collection, review the requirements to learn about any dependencies and determine the appropriate installation option.

You can install a Broadcom Ansible collection for mainframe using Ansible Galaxy.

For more information on installing collections, see Using collections in Ansible documentation.

Ansible Galaxy

Ansible Galaxy enables you to quickly configure your automation project with content from the Ansible community. Ansible Galaxy provides prepackaged units of work known as collections. You can use the ansible-galaxy command with the install option to install a collection on your system, also referred to as the control node.

Broadcom collections are installed using the broadcom namespace followed by the collection name. For example, endevor, file_master_plus, and sysview are collection names and the installation command would follow this syntax:

$ ansible-galaxy collection install broadcom.<collection name>

By default, the ansible-galaxy command installs the latest available collection. If you would like to install a previous version of a collection or if the installation is unsuccessful, use the --force option to override an existing installation or use a range identifier to install a specific version.

Overriding an existing installation

If you want to override a previously installed version of a collection, use the --force option.

Use this command to override an existing version by another one:

$ ansible-galaxy collection install --force broadcom.<collection name>:<version>

Collection location

By default, all collections are installed in ~/.ansible/collections. You can use the -p option with ansible-galaxy to specify an installation path such as:

$ ansible-galaxy collection install broadcom.<collection name> -p /home/ansible/collections

The progress of the installation is printed to the console:

Process install dependency map
Starting collection install process
Installing 'broadcom.endevor:5.7.5' to '/home/user/.ansible/collections/ansible_collections/broadcom/endevor'

For more information on installing collections with Ansible Galaxy, see installing collections.