Red Hat Ansible Certified Content for IBM Z Everything you need to get started quickly. Get started

Welcome to the Red Hat Ansible Certified Content for IBM® Z® content solution, your homepage for technical resources.

Red Hat® Ansible Certified Content for IBM Z helps you connect IBM zSystems™ to your wider enterprise automation strategy through the Ansible Automation Platform ecosystem. The Red Hat Ansible Certified Content available in Ansible Automation Hub and Galaxy provides a wide range of Ansible collections that enables development and operations automation on z/OS®, z/OS middleware products, and other IBM Z systems and resources. The collections offer seamless, unified workflow orchestration with configuration management, provisioning, and application deployment in one easy-to-use platform.

Today, we offer collections for z/OS core, IBM IMS, IBM Z System Automation, IBM CICS, z/OS Management Facility and System Z Hardware Management Console that can be readily used. We are actively expanding our collections to automate other common configuration and management tasks for software in the broader IBM zSystems community.

All the collections we offer today can be used with all the other collections contributed in the Ansible community (Jenkins, ServiceNow, DS8000, AWS, etc.) for any automation use-case you are interested in.

Find more information about Red Hat Ansible Certified Content for IBM Z Join our Ansible for IBM zSystems Community
Big picture 1. Make sure you have the right software for your z/OS system. 2. Install Red Hat Ansible Certified Content for IBM Z Collections. 3. Start your automation journey by writing and executing Ansible playbooks. How to get started

Setting up z/OS to be an Ansible-managed node is simple. Ansible is an agentless architecture, which means that there’s no server-side component that needs to be installed on any managed node.

All you'll need is SSH enabled, z/OS Unix System Services enabled, Python, and IBM Z Open Automation Utilities.

After you’ve done that, any machine you are using as your Ansible control node will be able to connect to z/OS and drive the automation of your choosing.

IBM Z Open Automation Utilities (ZOA Utilities) helps z/OS developers automate tasks that access MVS™ resources. It enables easier calling of MVS utilities compared with JCL by providing a natural coding experience on z/OS UNIX System Services and interfaces in modern programming languages.

This support requires z/OS V2R3 or later.

Steps for the system programmer

Follow these steps to set up your z/OS server, which is the managed (target) node:

  1. Enable OpenSSH and perform ssh-keys setup.
  2. Install IBM Open Enterprise SDK for Python.
  3. Install IBM Z Open Automation Utilities (ZOAU).

For detailed version number requirements read the requirements documentation.

Overview Decide how you want to install the Red Hat Ansible Certified collection.
Ansible Galaxy

If your organization has access to Ansible Galaxy or Ansible Automation Hub, you can install directly from the public repositories.

Use the following ansible-galaxy command to install a collection hosted in Galaxy on your control node:

$ ansible-galaxy collection install ibm.<collection>

Find the correct installation command for the Red Hat Ansible Certified Content for IBM Z collection you are interested in on that respective collection's Ansible Galaxy page.

Ansible Galaxy install
Automation Hub and Private Galaxy server

If your organization does not allow access to Ansible Galaxy or Automation Hub, then you might set up an internal Galaxy server and pull the approved content to share internally so that you can host a subset of content. You can modify the configuration to point to your internal Galaxy server.

To configure access to Automation Hub and Private Galaxy server, use the same instructions that you use to configure your client to point to Automation Hub. When hosting a private Galaxy server or pointing to Hub, the available content is not always consistent with what is available on the community Galaxy server.

Galaxy contains our community editions which represent our latest features and their progression to becoming certified in Automation Hub. Populating a private Galaxy repository depends on your particular scanning and content cloning process.

Private Galaxy server install
Local installation

You can use the ansible-galaxy collection install command to install a collection built from source. To build your own collection, you must clone the Git repository, build the collection archive, and install the collection. The ansible-galaxy collection build command packages the collection into an archive that can later be installed locally without having to use Hub or Galaxy.

Local installation

Follow these steps to install or update Ansible on your Automation Controller. Then install the z/OS core collection from Ansible Galaxy.

Install Ansible
  1. Install Python 3.5 or later.
  2. Install Ansible on your local machine.

    $ sudo pip3 install ansible

  3. Verify that Ansible is installed on your machine.

    $ ansible --version

Example output:

ansible 2.9.6 config file = None configured module search path = ['/Users/<username>/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules'] ansible python module location = /usr/local/lib/python3.7/site-packages/ansible executable location = user/local/bin/ansible python version = 3.7.4 (default, Sep 7 2019, 18:27:02) [Clang 10.0.1 (clang-1001.0.46.4)]

Updating Ansible

If you already have Ansible installed on the Automation Controller, you can update it to the latest version.

  1. Update Ansible.
    $ sudo pip3 install ansible –upgrade
  2. Verify that Ansible is updated.

    $ ansible --version

Install the z/OS core collection

Once you have Ansible installed, use the following command to install the Red Hat Ansible Certified collection:

$ ansible-galaxy collection install ibm.<collection>


Use Red Hat Ansible Certified Content for IBM Z collections to automate tasks on your zSystems environments. Start by referring to the included module documentation and examples provided with each of our modules. Use the ansible-doc command to view the documentation to learn about each of the modules, such as zos_data_set, by issuing ansible-doc ibm.ibm_zos_core.zos_data_set or by visiting the module documentation page.

With Red Hat Ansible Certified Content for IBM Z, documentation for all of your collections are in a single unified place. Explore documentation content across all IBM zSystems collections, including getting started and troubleshooting information specific to IBM zSystems environments.

An Ansible playbook consists of organized instructions, referred to as tasks and roles, that define work for a managed node (host) to be automated using Ansible.

To get started automating on IBM zSystems with playbooks tailored to many IBM zSystems use cases, there is the Ansible content for IBM zSystems sample playbook repository. Users can then edit these samples to fit their own needs, accelerating use and adoption of ansible amongst teams. You can also contribute playbooks to the sample playbook repository to help the community learn Ansible.

Let's start with this sample playbook from the Ansible for IBM zSystems sample playbooks repository as an example. This playbook performs the following steps:

  1. Create a data set and populate with JCL on the target z/OS system
  2. Submit job on z/OS
  3. Query job submission and review output
  4. Delete data set to clean up the z/OS system

Follow these steps to run a playbook:

  1. Edit the ansible.cfg file to include pipelining = true.
  2. Modify the sample inventory to add the z/OS host, user, and Python location.
  3. Update the host_vars in the zos_host.yml file to point to locations on ZOAU and Python on z/OS.
  4. Run the Ansible playbook using the following command:

    ansible-playbook -i inventory <sample>.yaml

You've just run your first Ansible playbook for IBM zSystems!

Frequently asked questions Q: What are the benefits of using the Ansible for IBM Z collections?

A: Users are able to:
• Integrate IBM zSystems into an enterprise automation strategy in a consistent way
• Enable a common approach for hybrid applications and infrastructure management
• Enable transparent visibility of IBM zSystems automation when orchestrated by Ansible
• Drive best practices to manage automation in source control to move towards infrastructure as code
• Leverage Ansible and Python skills, which are readily available in the marketplace and can be applied to z/OS
• Use modules to codify key maintenance and operational tasks for IBM zSystems software so that you can focus on what you’re trying to accomplish, rather than worry about how to write JCL, for example

Q: Where do I get support for the Red Hat Ansible Certified Content for IBM Z?

A: Red Hat® Ansible Certified Content for IBM Z collections will be developed in the open, and when content is ready for use it is released to Ansible Galaxy for community adoption. Content in Ansible Galaxy is supported by the robust open source community who recognizes Ansible as a leader in automation. Once contributors review community usage, feedback, and are satisfied with the content published, the collection will then be released to Ansible Automation Hub as certified and IBM supported for Red Hat® Ansible Automation Platform subscribers.

Q: Will more collections be available?

A: Absolutely! More collection and content will be made available in support of middleware provisioning, middleware configuration, middleware management, and application deployment, to name a few. The collections are starting with a focus on z/OS but are intended to expand more broadly to the IBM Z ecosystem over time. Ansible Galaxy contains the complete list of collections.

These content collections are accelerators to make automating z/OS with Ansible even easier. Ansible is a powerful tool, that can be used out of the box to build your own automation. With Python as the core language for Ansible modules, it's easy for developers to build and contribute their own modules in support of any automation strategy.

Q: Do I need to be an Ansible expert to use Ansible for IBM Z collections?

A: Ansible is a powerful IT automation tool that is quick and easy to learn. Get started by checking out Ansible's Getting Started website.

Q: Is there an easy way to get started working with the collections?

A: Yes, use the sample playbooks in the sample playbooks repository that leverage IBM Z collections. Consider contributing playbooks to the repository to help the Ansible for IBM zSystems community grow.
z/OS core
IBM Z Hardware Management Console
IBM Z System Automation

Q: Ansible can cover a lot of use cases: some of which I already have some technology solutions for. Does Ansible replace any existing technologies I already use?

A: It is up to each enterprise to determine its strategy for how it evolves the set of tools and technologies that it uses. The good news with Ansible is that it integrates with a wide range of technologies across the hybrid multicloud landscape, and across IBM zSystems. You can use Ansible automation to integrate with what you have or build new playbooks with certified collections to create something new.

Leverage your existing JCL, REXX, and z/OSMF assets or most anything else using Ansible as the driver to automate Z. The choice is yours.

Learn more about Ansible Orchestration
Technical resources Learn more about Ansible Automation with IBM z/OS Find more info at Red Hat Explore z/OS collections from IBM in Ansible Galaxy Explore the collections Learn about Ansible Automation Hub and certified content Check out the webinar Getting started with Ansible Get started now Ansible for IBM zSystems: User Spotlight Series New Check out the blog Explore Ansible for z/OS through IBM Z Trial Get hands on z/OS user management with Ansible Read the blog Red Hat Ansible Automation Platform Self-guided labs New Get hands on z/OS Certificate Management automation with Ansible New Watch the video Ansible NPS survey New Fill out the survey What's new

• Updates to the introduction, including more information about collections, and changes and additions to the Technical resources section.

• Minor updates to the introduction, including the addition of z/OSMF to the list of collections.
• Updated documentation link to point to the sample playbook for z/OSMF

• Major content update with additional technical resources and link to IBM Z Trial
• Updated documentation links to point to the sample playbook for
• Released the IBM Z System Automation Collection, IBM z/OS CICS Collection, IBM Z Hardware Management Console Collection

• Updated the Ansible prerequisites section to include IBM Python
• Introduced a What’s New section
• Included a link to a Terminal Talk Podcast “Ansible for z/OS”

Released IBM z/OS IMS collection v1.0.0-beta1 and beta2 to automate routine system operation tasks with Ansible. The IMS collection facilitates database administration tasks and integrates application changes into a CI/CD pipeline for application deployment and delivery and more.
Read the blog

Released IBM z/OS core collection v1.1.0-beta1 to extend the library of Ansible modules to provide the ability to automate several operations including data access, encode data on z/OS and more.
Read the blog

Released of IBM z/OS core collection v1.0.0, as part of the Red Hat Ansible Certified content for IBM Z. IBM z/OS core collection enables automating development and deployment of your new applications and features in z/OS.
Read the blog

Rate this content solution