Skip to content
CA Release Automation - Integrations
Documentation powered by DocOps

CA Release Automation Connector for z/OS

Last update December 13, 2016

The CA Release Automation Connector for z/OS enables you to interact with IBM z/OS and the subsystems executing on it. You can submit and manipulate jobs, allocate and maintain data sets, and control CICS and DB2 regions and WebSphere application servers. The connector interacts with an IBM mainframe through the IBM z/OS Management Facility (z/OSMF) REST Services installed as part of z/OS.

The CA Release Automation Connector for z/OS is a separately licensed option of CA Release Automation.

Actions Help

For a description and for input and output parameters for deployed actions, refer to:

  • Mainframe Actions in this documentation

  • The embedded actions help that is available in your installation at: http://<yourdeployment>/nolio-app/actionshelp.jsp

Supported Platforms

The target z/OS system must have active IBM z/OS Management Facility v2.2 with applied maintenance RSU1606.

You must install the connector on your CA Release Automation Management Server. The actions in this connector are designed to be executed on any CA Release Automation Agent that has TCP/IP connectivity to the target IBM z/OS system. For more information about supported platforms, see System Requirements.

z/OSMF Configuration

One z/OSMF instance can control jobs on all z/OS systems which are part of the same JES Multi-Access Spool (MAS) as the system with IBM z/OSMF. If you want to control jobs on a z/OS system other than those in the JES MAS where the z/OSMF instance resides, set up a separate z/OSMF instance that runs within that JES MAS. For instructions and additional considerations, see Using z/OSMF in a multi-system environment in the IBM z/OSMF documentation.

In each z/OSMF instance, assign security permissions according to the requirements specified in the IBM z/OSMF REST API documentation for operations with jobs and files.


We recommend the use of CA Release Automation Agents electronically close to the target z/OS system, for example, running on z/Linux. Recommended deployment model is one CA Release Automation Execution Server for each mainframe and one Agent for each LPAR. For a detailed description of the CA Release Automation components and their interaction, see Install for a Distributed Environment.

The following diagram shows the recommended deployment model: 

RA Mainframe Deployment Architecture

If you are executing many concurrent action executions on any one Agent, you can deploy Agents to manage particular subsystems; for example, have one Agent for each CICS region.

For more information about providing high availability, see Install to Provide High Availability.


Obtain the Install Media

Download the CA Release Automation Connector for z/OS installation media from CA Support.


CA Release Automation Connector for z/OS has to be installed on the machine that hosts your CA Release Automation Management Server and the management server must be running.

CA Release Automation Connector for z/OS can be installed on the same set of platforms that are supported by CA Release Automation server components, as described in System Requirements.

When installing on a Linux platform, a Java runtime environment version 1.6 or newer has to be available.

Installation Considerations


Part of the automated install process relies on the CA Release Automation JMX interface being enabled. If the interface has been disabled, part of the installation process must be completed using the steps described in Manual Deployment.

Interactive Installation

To start the installation process in interactive mode, execute one of the following binaries from the installation media, depending on the target platform:

  • ca-ra-zos-connector_windows-x64_<version>.exe for Microsoft Windows operating systems
  • ca-ra-zos-connector_linux-x64_<version>.sh for Linux operating systems

Depending on the platform and environment, the installer uses a graphical or console-based user interface that guides you through the process.

If the deployment phase of the process fails, follow the manual deployment instructions within the installer or refer to the Manual Deployment instructions that follow.

Unattended Installation

The readme.txt file that is located in the unattended directory on the installation media outlines the procedures necessary to run an unattended installation.

Also, sample scripts that show how to execute an unattended client installation are available in the unattended/samples directory on the installation media. Read the readme.txt file first, before using the samples.

On Linux platforms, the installer generates information and error messages about the process on standard output. On all platforms these messages are included in the generated log file.

On all platforms, you can use the return value from the installer process to determine its result:

  • 0 indicates that the installation was successful.
  • Values from 1 through 100 indicate a problem with the provided parameter values or the environment. See the messages on standard output on Linux platforms, or the log file for more details.
  • 201 indicates that the deployment portion of the installation has failed. In this case, you must follow the instructions in the Manual Deployment section to finish the installation.
  • Any other value indicates a failure of the installation. 

Manual Deployment

In situations where the installer is unable to deploy CA Release Automation Connector for z/OS into a CA Release Automation server instance, the extracted product files remain in the uploadActions subdirectory of the CA Release Automation server installation (for example, C:\Program Files\CA\ReleaseAutomationServer\uploadActions).

Follow these steps to manually deploy the product files:

  1. Run and log in to the Automation Studio application.
  2. Go to the Action Management screen available from the Administration menu entry.
  3. Click the Import Action Package icon.
  4. Browse to the directory that contains the product files and select them all.
  5. Select the Import button and wait for the process to finish.

Note: If you are running Automation Studio from a host other than the one where the installer has extracted the product files, you must copy the files over first.

Log File

On Microsoft Windows operating systems, the log file is saved in the temporary directory of the user running the installer process. This directory can be generally accessed using the TEMP environment variable.

On Linux operating systems, the log file is saved in the /tmp directory.

The name of the log file has the following format: i4j_log_ca-ra-zos-connector_<unique-id>.log


Use one of the CA Release Automation user interfaces to uninstall CA Release Automation Connector for z/OS.

If you are using Automation Studio:

  1. Go to the Action Management screen available from the Administration menu entry.
  2. Select the ca-ra-zos-connector entry in the list of installed packages.
  3. Click the Remove Selected Action Package icon.

If you are using Release Operations Center:

  1. Go to the Action Management screen available from the Administration menu entry.
  2. Switch to the Installed Packs tab.
  3. Locate the ca-ra-zos-connector entry in the list and select the associated checkbox.
  4. Click Delete.
Was this helpful?

Please log in to post comments.