Skip to main content

Universal Agent for z/OS Quick Start Guide

Objective​

This Universal Agent 8.0.x for z/OS Quick Start Guide provides a short summary on how to install Universal Agent on a z/OS system and run a few simple batch jobs demonstrating Universal Agent on z/OS. For a complete description of the installation process, see Universal Agent 8.0.x Installation, Upgrade, and Applying Maintenance.

The following information is provided:

  • Installation Requirements
  • Downloading the Universal Agent 8.0.x for z/OS distribution file.
  • Installing Universal Agent 8.0.x on z/OS.
  • Licensing Universal Agent components.
  • Encrypting passwords to be used in Universal Agent jobs.
  • Executing a Universal Command job.
  • Executing a Universal Data Mover job.
  • Executing a Universal Broker query job.

Installation Requirements​

For System Requirements, Data Set Space Requirements, and Platform Requirements, see z/OS Installation - Installation Requirements.

Downloading the Universal Agent 8.0.x for z/OS Distribution File​

The Universal Agent 8.0.x for z/OS product distribution file - sb-8.0.x.x-zos.tar.gz - is available for download from the Stonebranch Customer Portal.

A customer user name and password - provided by Stonebranch, Inc. - are required to access the Customer Portal.

Installing Universal Agent 8.0.x for z/OS​

For a summary of installation steps, see the Installation Checklist on the z/OS Installation page.

Licensing your Universal Agent 8.0.x for z/OS Components​

info

A Universal Agent eventually will be required to obtain its license information from a Universal Controller or UCAM installation. Support for locally-configured license information will be removed at that time.

After Universal Agent 8.0.x for z/OS has been installed, you must configure the following Universal Agent components with product licenses before they can be used:

  • Universal Command Manager
  • Universal Connector
  • Universal Data Mover Manager

For each component, product license information (license parameter keywords and their values) is contained in a separate text file provided by your Stonebranch, Inc. account representative.

The format of a product license file name is: <component name>_<customer name>_<operating system>_<schedule or solution>.txt. For example: Agent_Stonebranch_MVS_A1.txt.

Universal Command Manager License File​

For Universal Command Manager, Agent is used as the <component name> in the product license file name and as the name of the product in the file itself - see below.)

The following is a sample Universal Command Manager for z/OS product license file:

License_Product "AGENT"
License_Customer "STONEBRANCH"
License_OS_Type "MVS"
License_Type "PERPETUAL"
License_Expiration_Date 2030.12.31          YYYY.MM.DD
License_NT_Servers 100
License_UNIX_Servers 100
License_OS400_Servers 10000
License_OS390_Servers 10000
License_Tandem_Servers 10000
License_OS390_Unix_Servers 10000
License_Key ABCD-1234-EFGH-5678-IJKL-MNOP-9999

Universal Data Mover Manager License File​

For Universal Data Mover Manager, MFT is used as the <component name> in the product license file name and as the name of the product in the file itself - see below.)

The following is a sample Universal Data Mover Manager for z/OS product license file:

License_Product "MFT"
License_Customer "STONEBRANCH"
License_OS_Type "MVS"
License_Type "PERPETUAL"
License_Expiration_Date 2030.12.31          YYYY.MM.DD
License_NT_Servers 100
License_UNIX_Servers 100
License_OS400_Servers 10000
License_OS390_Servers 10000
License_OS390_Unix_Servers 10000
License_Key ABCD-1234-EFGH-5678-IJKL-MNOP-9999

UNVCONF Product Library​

In the UNVCONF product library:

  • Enter the Universal Command Manager license parameters into the Universal Command Manager configuration file, member UCMCFG00.
  • Enter the Universal Connector license parameters into the Universal Connector configuration file, member USPCFG00.
  • Enter the Universal Data Mover Manager license parameters into the Universal Data Mover Manager configuration file, member UDMCFG00.

It is recommended that you enter license information at the end of the file. (The values are specified in the same syntax as all other configuration options.)

Restart Universal Broker​

For Universal Broker to read the license information, you must stop and restart it.

Stop Universal Broker

STOP UBROKER

Start Universal Broker

START UBROKER[,UPARM='options']

Encrypting User ID and Password for Job Execution​

Universal Command and Universal Data Mover typically require user credentials to execute work on a remote host. The user credentials can be stored in an encrypted format for privacy reasons. Read access to the file should be restricted to authorized users even though the contents are encrypted. Universal Command and Universal Data Mover will read user credentials in the encrypted format.

The following JCL example executes the UENCRYPT utility that encrypts command options it reads from the UNVIN ddname and writes them to the UNVOUT ddname in the form of an encrypted command file. This example creates member DALLAS in the PDS/E PROD.UNV.USERS. The DALLAS member will contain the user ID and password options specified in the UNVIN ddname in a UENCRYPT format.

//jobname  JOB CLASS=A,MSGCLASS=X,NOTIFY=&SYSUID
//STEP1    EXEC PGM=UENCRYPT
//STEPLIB  DD  DISP=SHR,DSN=#SHLQ.UNV.SUNVLOAD
//UNVIN    DD  *
 -USERID USR100 -PWD ABCDEF
/*
//UNVOUT   DD  DSN=PROD.UNV.USERS(DALLAS),DISP=SHR
//SYSPRINT DD  SYSOUT=*
//SYSOUT   DD  SYSOUT=*
//SYSIN    DD  DUMMY

Executing a Universal Command Job​

The following JCL example executes the UNIX command "ls -l" on remote host DALLAS using the encrypted command file created above.

//jobname  JOB CLASS=A,MSGCLASS=X,NOTIFY=&SYSUID
//*
//         JCLLIB ORDER=#SHLQ.UNV.SUNVSAMP
//*
//STEP1    EXEC UCMDPRC
//USER     DD  DSN=PROD.UNV.USERS(DALLAS),DISP=SHR
//SYSIN    DD  *
-cmd 'ls -l' -host dallas -encryptedfile user
/*

Executing a Universal Data Mover Job​

Universal Data Mover execution is driven by an easy to use scripting language. The Universal Data Mover script controls the transfer sessions established with remote hosts and the file and transfer operations performed on the host's file systems.

The following JCL example executes Universal Data Mover. Universal Data Mover always reads the script from the UNVSCR ddname. In this example, the script establishes a session with remote host DALLAS and transfers the data set allocated to ddname DATA to file app.data on the remote host. The default transfer mode of binary is used for transferring the data.

//jobname  JOB CLASS=A,MSGCLASS=X,NOTIFY=&SYSUID
//STEP1    EXEC UDMPRC
//DATA     DD  DSN=APP.DATA,DISP=SHR
//USER     DD  DSN=PROD.UNV.USERS(DALLAS),DISP=SHR
//UNVSCR   DD  *
set echo=yes halton=warn
open dest=dallas xfile=user
filesys local=dd
copy local=data dest=app.data
quit
/*

Running a System Query​

Use the Universal Query utility to query the Universal Broker for Broker and active component information. Universal Query returns information about the Universal Broker, as specified by configuration options, as well as information regarding the components managed by Universal Broker.

The following JCL example executes the UQUERY utility. In this example, UQUERY will query the Broker running on host DALLAS.

//jobname  JOB CLASS=A,MSGCLASS=X,NOTIFY=&SYSUID
//*
//         JCLLIB ORDER=#SHLQ.UNV.SUNVSAMP
//*
//STEP1    EXEC UQRYPRC
//SYSIN    DD  *
-host dallas
/*