cfstruct

Using the z/OS collection to interact with MQ for z/OS coupling facility structures

This sample playbook demonstrates how to use the zos_operator module from the ibm_zos_core collection to run MQSC commands against an MQ for z/OS queue manager.

The sample shows how to perform a backup of an MQ for z/OS coupling facility structure.

As MQSC commands follow a common format, this sample could easily be modified for other purposes. For example, to recover an MQ for z/OS coupling facility structure.

Requirements

• Python 2.7+
• Ansible 2.9+

Getting Started

If you are unfamiliar with playbooks, you can review our detailed configuration guide or continue with getting started below.

Optionally, you can use the sample host_setup to discover and create your inventory and host_vars artifacts. It should be noted that when you use the host_setup it will generate a configuration for the most common dependencies, some playbooks require more customized configurations, in this case, you can review the sample documentation and add the additional required variables.

Update inventory.yml with the information about your system(s)

# the target z/OS system
source_system:
  hosts:
    zos_host:
      ansible_host: zos_target_address
      ansible_user: zos_target_username
      ansible_python_interpreter: path_to_python_interpreter_binary_on_zos_target

Update the environment variables for each z/OS system in host_vars/zos_host.yml

# the path to the root of IBM python installation
PYZ: "/python/v3r8"

# the path to root of ZOAU installation
ZOAU: "/usr/lpp/IBM/zoautil"

Update the host variables for which queue manager and coupling facility structure to interact with

# Queue manager command prefix
mq_cpf: "!MQ21"

# Structure to be backed up. Wildcards shouldn't be used to backup multiple structures
# as the error checking logic assumes a single structure is backed up
mq_structure_name: APPLICATION1

# Amount of time to pause, in seconds, while waiting for backup to complete
mq_pause_time: 10

Run the sample

For example:

ansible-playbook -i inventory.yml mq_backup_cfstruct.yml

What next?

Look at the other samples to find examples of what else you can do with MQSC commands.

Support

Please refer to the support section for more details.

License

Licensed under Apache License, Version 2.0.

Copyright

© Copyright IBM Corporation 2021.