archive_copy_unarchive_restore

Transfer Data Sets Using Ansible

This project provides sample playbooks and roles which can be used to transfer data sets between z/OS systems using Red Hat Ansible Certified Content for IBM Z.

The following core modules are used to accomplish this set of tasks:

This playbook uses:

• collection:
  • ibm.ibm_zos_core
• modules:
  • zos_archive
  • zos_unarchive
  • zos_data_set

It is a good practice to review the playbook contents before executing them. It will help you understand the requirements in terms of space, location, names, authority, and the artifacts that will be created and cleaned up.

Playbooks Summary

• archive_fetch_data_sets.yml - Dumps and archive of data sets.
• unarchive_data_sets.yml - Transfers, unarchives, and restores the target data set archive.

Important

The release of ibm_zos_core collection version 1.10.0 introduced case-sensitive changes to modules, specifically that module choices must be lower case. See the porting guide in the release notes (here) to understand the full scope of these changes.

These changes are not compatible with earlier versions of the ibm_zos_core collection, and since the earlier versions do not reach their end of life until April 2025, the sample playbook compatible with the older versions will remain available.

To support both the latest and prior versions of the collection:

• The main branch will reflect playbooks compatible with ibm_zos_core version 1.10.0 or later.
  • Find this playbook on the main branch: here.
• The ibm_zos_core-v1.9.x-samples branch will reflect playbooks compatible with ibm_zos_core version 1.9.x or earlier.
  • Find this playbook on the ibm_zos_core-v1.9.x-samples branch: here.

The ibm_zos_core-v1.9.x-samples branch will remain available until April 2025 but will not receive updates.

Playbook Requirements

This playbook requires:

• IBM® z/OS® core collection 1.7.0 or later
• Ansible® 2.9 to 2.15

Configuration

• Configure the included inventory.yml with the information from the managed z/OS host.
  • Review inventory documentation
• Configure the included host_vars zos_host.yml with the information from your z/OS system.
  • Review host_vars documentation and any additional noted variables in the configuration.

Run the playbook

This project has included a site.yml playbook that serves as the primary playbook that provides additional prerequisite checks then it invokes archive_fetch_data_sets.yml playbook and then unarchive_data_sets.yml.

If you want to run the primary playbook site.yml it will check that your environment has the correct version of Ansible as well as the collection needed to execute correctly. To run the primary playbook, use command:

ansible-playbook -i inventories site.yml

You can skip the prerequisite check and run the archive_fetch_data_sets.yml or unarchive_data_sets.yml with command:

ansible-playbook -i inventories archive_fetch_data_sets.yml
ansible-playbook -i inventories unarchive_data_sets.yml

Changelog

All changes are maintained chronologically by date found in the changelog.

Copyright

© Copyright IBM Corporation 2023

License

Licensed under Apache License, Version 2.0

Support

Please refer to the support section for more details.