Installation

Always check that your control node has met the Requirements before you install the IBM® z/OS® CICS® collection.

Then, follow the guidance to install the collection from Ansible® Galaxy or from a custom Galaxy server. More ways to install an Ansible collection are documented in Installing collections.

Installing from Ansible Galaxy

This is the quickest way to install the CICS collection. From your CLI, enter the following command:

$ ansible-galaxy collection install ibm.ibm_zos_cics

By default, collections are installed in ~/.ansible/collections. After installation, the collection content will resemble this hierarchy: :

├── collections/
│  ├── ansible_collections/
│      ├── ibm/
│          ├── ibm_zos_cics/
│              ├── docs/
│              ├── plugins/
│                  ├── action/
│                  ├── module_utils/
│                  ├── modules/

To install with customization, such as specifying another installation path or using a playbook, see Installing collections.

Installing from a custom Galaxy server

By default, the ansible-galaxy command is configured to access https://galaxy.ansible.com as the server when you install a collection. The ansible-galaxy client can be configured to point to other servers, such as a privately running Galaxy server, by configuring the server list in the ansible.cfg file.

Ansible searches for ansible.cfg in the following locations in this order:

  • ANSIBLE_CONFIG (environment variable if set)

  • ansible.cfg (in the current directory)

  • ~/.ansible.cfg (in the home directory)

  • /etc/ansible/ansible.cfg

Instructions on how to configure the server list in ansible.cfg can be found in Configuring the ansible-galaxy client. Available options in the Ansible configuration file can be found in Ansible Configuration Settings.

Note

When hosting a private Galaxy server, available content is not always consistent with what is available on the community Galaxy server.