Ansible Z Playbook Repository

This repository provides playbooks that can be tailored to automate often repeated IBM Z tasks, links to blogs, and other related media.

An Ansible® playbook consists of organized instructions that define work for a managed node to be automated with Ansible. The playbooks in this repository are written using the collections from Red Hat® Ansible® Certified Content for IBM Z® offering. For a detailed overview of the collections, refer to the documentation.

The collections can be found on Ansible Galaxy and Automation Hub. For additional content, review our community page.

This repository is frequently updated to refresh content. We recommend that you clone the repository and configure your GitHub notifications and subscriptions to receive ongoing updates about specific activity on GitHub.

Contribute Ansible Playbooks

We are accepting Ansible playbooks from the community. These playbooks should relate to IBM Z, and should either leverage the Red Hat Ansible Certified Content for IBM Z collections, or highlight additional capabilities and use-cases for Z automation. Check out the contribution guidelines for more information.

Playbooks

Playbooks are organized by topics that align to tasks and use cases that are often repeated and in need of automation.

Z Topics

• Infrastructure Provisioning
  • IBM Cloud Infrastructure Center
    • Installing Red Hat OpenShift Container Platform
• Systems Administration
  • zHMC
    • Gather facts for CPC and its adapters and partitions
    • zHMC Concepts

z/OS® Topics

• Administration
  • Set Up Ansible Host Variables for Python and ZOAU
  • Manage z/OS Users Using Ansible - [Playback]
  • Ansible Fact Gathering for z/OS
  • Unarchive Pax and Set Custom Facts
  • Synchronize APF authorized libraries from a configuration cloned from GitHub - [Playback]
  • Manage z/OS Certificates
• Basic Operations
  • Data Set Basics
  • Copy Directory to PDS, Edit member and Submit Job
  • Operator Basics
  • Convert Encoding
  • Job Submit Response Parsing and Constructs
  • Initialize DASD volume, Copy JCL to PDS, and Submit Job
• Concepts
  • Copy and Fetch Data sets
  • Copy, Edit and Fetch Generation Data Groups
  • Copy, Sort and Fetch Data Sets on z/OS using Ansible- [Playback]
  • Create, Copy and Submit Generation Data Groups
  • Terse Data Set and Fetch
  • Dump, Archive, Fetch, Copy and Unarchive Data Sets
  • Transfer, Dump and Unpack Data Sets
  • Grow ZFS aggregates
  • Copy templates to z/OS
  • Use templated job cards and JCL to submit jobs
  • Use templates for compiling and linking libraries
  • Run local and remote scripts inside Unix System Services in z/OS
  • Run REXX scripts and CLISTs with TSO commands
• Integrating Existing Automation
  • Job Control Language (JCL)
    • Submit Batch Jobs, Query and Retrieve Job Output
  • z/OSMF Workflows
  • System Automation
    • Managing Dynamic Resources
  • Invoking REST APIs using the URI module
• Provisioning
  • IMS
    • Deploy an IMS Cobol App
    • Provision a new IMS TMDB subsystem
    • Provision a new IMS TMDB subsystem for Wazi
  • ZCEE
    • Provision a new z/OS Connect EE subsystem
  • WLP
    • Provision a new Websphere Application Server Liberty Profile
  • z/OSMF Cloud Provisioning and Management
• Application & Service Deployment
  • ZCEE
    • Generate and deploy z/OS Connect EE API, service, and API requester artifacts
• Subsystems
  • CICS
    • Retrieve operational data from running CICS regions
    • Deploy a program to a CICS region
    • Customize when a CMCI module should fail
    • Resource life cycle and CSD
    • Using module_defaults
  • MQ
    • Interacting with local queues
    • Backing up an application structure
  • Db2
    • Provision a Db2 schema instance
    • Discover registered Db2 applications
    • Discover registered Db2 subsystems
  • IMS
    • Enable IMS catalog and managed ACBs
• Software Installation
  • SMP/E Playbooks
• Security
  • Security validation
  • Security audit
  • Security provision

Blogs

Don't have time to explore a collection, particular module or a playbook?
Learn all about the offerings from our blogs.
Don't know which one to read first? Well, here is a list of some of our recent blogs:

• Job Submission on z/OS Made Easy with Ansible - [Playbook]
• Running Batch Jobs on z/OS using Ansible - [Playbook]
• Simplified Approach to Copying Data Between z/OS and Local Machine Using Ansible - [Playbook]
• z/OS User Management With Ansible - [Playbook]

Playbacks

Want to experience Z automation with Ansible without rolling up your sleeves? Take a look at some of our playbacks using our own playbooks available in this repository.

• Copy, Sort and Fetch Data Sets on z/OS using Ansible
• Manage z/OS Users Using Ansible
• Synchronize APF authorized libraries from a configuration cloned from GitHub

How playbooks are organized in this repository

All playbooks in this repository can run independently from any other playbook. Each playbook in this repository includes a README with a brief description, licensing and instructions on how to configure the playbook. If configuration is required, a default configuration will be included with the playbook.

For further reading on how playbook projects are organized in this repository, review the following documentation.

Copyright

© Copyright IBM Corporation 2020 - 2024

License

Licensed under Apache License, Version 2.0.

Support

This project is supported by the community though Git issues.

The repository admins and content owners will engage directly with users on issues reported.

Playbooks are contributed by IBM and the broader Ansible Z community. Therefore, it may be helpful to review who contributed a playbook as well as its requirements before opening a Git issue. You can view who the contributor was by looking at the playbooks commit history as well as notes in the playbook.