Introduction

The Universal Controller Command Line Interface (CLI) is implemented as a set of functions that perform specific actions in a Universal Controller. The results of the actions are written to the CLI standard output.

The CLI command, uagcmd, executes a function according to information specified in its required and optional Global parameters and function-specific parameters.

CLI Functions

CLI functions perform specific actions in a Universal Controller.

The CLI command, uagcmd, can execute functions on any system that has TCP/IP connectivity to the Universal Message Service (OMS).

The command line syntax for each execution of uagcmd must specify a single CLI function, required / optional Global parameters, and required / optional function-specific parameters. You must use the required Global parameters to connect to OMS Servers and to log on to a Controller (User ID and Password).

(See Pre-6.2.0.0 CLI Functions for a backward-compatible version of this syntax that can be used for pre-6.2.0.0 CLI functions.)

The following information is provided for each CLI Function:

Description
Command line syntax
Function-specific parameters
Example

Functions are listed alphabetically, by category, on the following pages:

Agent Functions	Delete Agent List Agents Status Resume Agent Resume Agent Cluster Resume Agent Cluster Membership Set Agent Cluster Task Execution Limit Set Agent Task Execution Limit Suspend Agent Suspend Agent Cluster Suspend Agent Cluster Membership
Bundle Functions	Schedule Bundle Promotion
Import and Export Functions	Export Bulk Export Trigger Import Bulk Import Trigger
OMS Server Functions	List OMS Servers
Password Functions	Change User Password Change Credentials Password
Resource Functions	List Virtual Resources Update Resource Limit
Task Functions	Cancel Task Clear All Dependencies Clear Virtual Resource Dependencies Clear Exclusive Dependencies Clear Time Dependency Display All Tasks Display Task Instance Status Force Finish a Task Launch a Task Put Task on Hold Release a Task from Hold Rerun a Task Set Manual Task to Started Set Manual Task to Success Set or Modify Wait Time for a Task Instance Set Task Priority Skip a Task
Tasks in Workflow Functions	Clear Predecessor Dependencies Insert a Task into a Workflow Instance with Dependencies List Predecessors / Successors of a Task Instance in a Workflow
Trigger Functions	Disable a Trigger Enable a Trigger Launch Trigger Tasks Now List Triggers Status Modify Time of a Time Trigger
Variable Functions	List Variables Set Variables

Command Line Syntax

The following command line syntax is used for issuing the CLI command, uagcmd:

uagcmd function Global parameters function-specific parameter(s)

Command Line Entry	Description
uagcmd	CLI command that executes all CLI functions.
function	CLI function that performs a specific action in a Universal Controller.
Global parameters	CLI parameters (required and optional) available for all functions.
function-specific parameter(s)	CLI parameters (required and optional) specific to one or more functions.

For example:

uagcmd ops-task-launch -c config.cfg -x encryptedfile.txt task-type=unix task-name=task01

In this example, the required Global Parameters are contained in the config.cfg configuration file.

Note

For backward-compatibility, you can exclude uagcmd from the command line for all pre-6.2.0.0 CLI functions.

Special Characters Restrictions

The following restrictions apply to the use of special characters in CLI function parameters.

Special Characters	Restrictions	Examples
\|	Can be used only if enclosed in double quotation marks.	C:\Program Files\Universal\OpsCli\bin>uagcmd.exe ops-task-launch -c c.cfg task-name=A\|B 'B' is not recognized as an internal or external command, operable program or batch file. C:\Program Files\Universal\OpsCli\bin>uagcmd.exe ops-task-launch -c c.cfg task-name="A\|B" Task Type parameter not specified, defaulting to ALL. Successfully launched the Manual task "A\|B" with task instance sys_id 14503847946836221302J1Y7WPIV75YF. opscmd-complete
~	Cannot be used, even if enclosed in double quotation marks.	C:\Program Files\Universal\OpsCli\bin>uagcmd.exe ops-task-launch -c c.cfg task-name="A~B" Parameter CMDVERB contains malformed name/value pair(s). opscmd-complete
=	Cannot be used, even if enclosed in double quotation marks; prevents a CLI function from running.	C:\Program Files\Universal\OpsCli\bin>uagcmd.exe ops-task-launch -c c.cfg task-name="A=B" uagcmd ops-task-launch usage: uagcmd ops-task-launch [options] [command_parameters]
+	Can be used with or without double quotation marks.	C:\Program Files\Universal\OpsCli\bin>uagcmd.exe ops-task-launch -c c.cfg task-name="A+B" Task Type parameter not specified, defaulting to ALL. Successfully launched the Manual task "A+B" with task instance sys_id 14503847946836441301OS0WDEQOH7Y1. opscmd-complete C:\Program Files\Universal\OpsCli\bin>uagcmd.exe ops-task-launch -c c.cfg task-name=A+B Task Type parameter not specified, defaulting to ALL. Successfully launched the Manual task "A+B" with task instance sys_id 14503847946836541302LCVCMLXWPSO0. opscmd-complete

Restrictions for `task-variables=` Parameter

None of these special characters identified in Special Characters Restrictions - =, |, +, and ~ - can be use in a task-variables= parameter.

Examples

C:\Program Files\Universal\OpsCli\bin>uagcmd.exe ops-task-launch -c c.cfg task-name=AB task-variables={variable1="V=1" variable2=V2}
Valid format for variables: {variable=value}.
opscmd-complete

C:\Program Files\Universal\OpsCli\bin>uagcmd.exe ops-task-launch -c c.cfg task-name=AB task-variables={variable1="V|1" variable2=V2}
Valid format for variables: {variable=value}.
opscmd-complete

C:\Program Files\Universal\OpsCli\bin>uagcmd.exe ops-task-launch -c c.cfg task-name=AB task-variables={variable1="V+1" variable2=V2}
Valid format for variables: {variable=value}.
opscmd-complete

C:\Program Files\Universal\OpsCli\bin>uagcmd.exe ops-task-launch -c c.cfg task-name=AB task-variables={variable1="V~1" variable2=V2}
Parameter CMDVERB contains malformed name/value pair(s).
opscmd-complete

Pre-6.2.0.0 CLI Functions

For backward-compatibility, you can exclude uagcmd from the command line for all pre-6.2.0.0 CLI functions:

Agent Functions	List Agents Status Resume Agent Resume Agent Cluster Resume Agent Cluster Membership Set Agent Cluster Task Execution Limit Set Agent Task Execution Limit Suspend Agent Suspend Agent Cluster Suspend Agent Cluster Membership
Import and Export Functions	Export Bulk Export Trigger Import Bulk Import Trigger
Password Functions	Change User Password Change Credentials Password
Resource Functions	Update Resource Limit
Task Functions	Cancel Task Display All Tasks Display Task Instance Status Force Finish a Task Launch a Task Put Task on Hold Release a Task from Hold Rerun a Task Set Manual Task to Started Set Manual Task to Success Set Task Priority Skip a Task
Trigger Functions	Disable a Trigger Enable a Trigger Launch Trigger Tasks Now List Triggers Status
Variable Functions	List Variables Set Variables

Return Codes

The following table identifies all return codes that can be returned in response to a function:

Return Code	Description
0	Completed successfully.
1	Configuration error (incorrect command line or configuration file entries).
2	Error processing the request.

Supported Platforms

For all supported platforms, the CLI is included in the Universal Agent 7.2.x package.

UNIX	The CLI functions are installed in the following directory: `/CLI_HOME/bin` Replace `CLI_HOME` with the directory in which the Agent components are installed.
Windows	The CLI functions are installed in the following directory: `DRIVE:\CLI_HOME\bin` Replace: `DRIVE` with the drive they are installed on. Add the appropriate directory for your O/S to your PATH environment variable in order to execute the functions without specifying their full path name. `CLI_HOME` with the directory in which the Agent components are installed. Note Do not use fully qualified file names (that is, with the .exe extension) in CLI for Windows parameters; an error will occur.
z/OS	The CLI is implemented with a single program, `UAGCMDZ`. `UAGCMDZ` (with alias `OPSCMDZ)` is installed in the SUNVLOAD library as part of the Universal Agent for z/OS Installation package. See Using the CLI for z/OS for detailed information on using the CLI in a z/OS environment.

CLI Login

User Restriction

You can be restricted from logging in to the CLI either of two ways:

The system level default for CLI access, specified by the System Default Command Line Access Universal Controller system property, has been set to No, and the Command Line Access field in the User Details for your user account is set to -- System Default --."
The Command Line Access field in the User Details for your user account is set to No, which overrides the System Default Command Line Access value.

If either restriction is in place, the following error message will display when you issue a CLI command:

User <your user name> not permitted to use the command line interface. Please check with your administrator.

To remove the restriction, the system administrator must either:

Set the System Default Command Line Access property to Yes and set the Command Line access field on the User Definition screen for your user account to -- System Default --.
Set the Command Line access field on the User Definition screen for your user account to Yes.

Password Expiration

While a password is expired, CLI access will be prohibited until the password has been changed.

Note

Password expiration is not applicable to LDAP authenticated users.

Global Parameters

The CLI provides the following Global parameters for use with any CLI function:

Parameter	Required	Optional
CA Certificate List
Configuration File
CRL File
Encrypted File
Encrypted File Key
Help
Message Level
OMS NFT
OMS Servers
Password
Queue Name
SSL/TLS
SSL/TLS Cipher List
SSL/TLS 1.3 Cipher Suites
SSL/TLS Implementation
SSL/TLS Minimum Protocol Version
SSL/TLS Maximum Protocol Version
Timeout
User ID
Version

The following information is provided below for each Global parameter:

Description
Syntax for specifying the parameter.
Requirement to use the parameter.
Default value (if any).
Example

Specifying Global Parameters

Three methods are available for specifying Global parameters:

Command line switches
Configuration file entries
Environment variables

Note

Each method is available only for some Global parameters; only a command line switch is available for each Global parameter.

CA Certificate List

Description	Trusted CA certificate list in PEM format. DD Name / Dataset Name / HFS File Name for z/OS; file path for other platforms.
Platforms	All
Configuration File Entry	ssl.certstore=
Command Line Switch	-a
Environment Variable	n/a
Required	No
Default	(none)
Example	UNIX `/opt/cert/ca.pem` Windows `c:\cert\ca.pem` z/OS: `-a dd:CACERTS` `-a CACERTS` `-a “//’CACERTS’”` `-a “//’CACERTS(mbr)’”` `-a “/path/to/file/CACERTS”`

Configuration File

Description	Configuration file containing one or more Global parameters. It can include the required User ID, Password, and OMS Servers Global parameters. Note The configuration file syntax is cfggroup.cfgopt=cfgval, where cfggroup is the group to which the option belongs, cfgopt is the option name, and cfgval is the option value. For example: `security.userid=ops.adminsecurity.password=abc123network.omsservers=7878@dallas01.acme.com,7878@dallas02.acme.comnetwork.omsnft=yesconfig.timeout=60` You also can specify individual Global parameters (required and optional) on the command line. Note A sample CLI configuration file, cmdtools.props, is created during the installation of the CLI (an optionally installed component of Universal Agent). However, you can create a configuration file with any name; it must exist in the directory from where you are issuing the uagcmd command.
Platforms	All
Configuration File Entry	n/a
Command Line Switch	-c
Environment Variable	n/a
Required	No
Default	(none)
Example	UNIX `/opt/cfgopt/cfgval.pem` Windows `c:\cfgopt\cfgval.pem` z/OS: `-c dd:cfgval` `-c cfgval` `-c “//’cfgval’”` `-c “//’cfgval(mbr)’”` `-c “/path/to/file/cfgval”`

CRL File

Description	CRL file in PEM format. DD Name / Dataset Name / HFS File Name for z/OS; file path for other platforms.
Platforms	All
Configuration File Entry	ssl.crlfile=
Command Line Switch	-e
Environment Variable	n/a
Required	No
Default	(none)
Example	UNIX `/opt/cert/crl.pem` Windows `c:\cert\crl.pem` z/OS `-e dd:CRL` `-e CRL` `-e “//’CRL’”` `-e “//’CRL(mbr)’”` `-e “/path/to/file/CRL”`

Encrypted File

Description	Complete path to a file encrypted with the Universal Encrypt utility that contains encrypted user credentials. This file can be used to store encrypted Controller credentials that would otherwise be specified using the User ID or Password parameters. One or both of these parameters can be encrypted and stored in this file. Any other parameters stored in the encrypted file are ignored. Any values specified by User ID or Password on the command line and/or in the Configuration File will override values stored in this file. Note Universal Encrypt is included in every Agent installation package.
Platforms	All
Configuration File Entry	n/a
Command Line Switch	-x
Environment Variable	n/a
Required	No
Default	(none)
Example	UNIX `/opt/encfile/fname.enc` Windows `c:\encfile\fname.enc` z/OS `-x dd:fname` `-x fname` `-x “//’fname’”` `-x “//’fname(mbr)’”` `-x “/path/to/encfile/fname”`

Encrypted File Key

Description	Optional key that was passed to the Universal Encrypt utility when the encrypted file specified by -x was created.
Platforms	All
Configuration File Entry	n/a
Command Line Switch	-k
Environment Variable	n/a
Required	No
Default	(none)
Example

Help

Description	Provides help information for any function.
Platforms	All
Configuration File Entry	n/a
Command Line Switch	-h \| -?
Environment Variable	n/a
Required	No
Default	(none)
Example	-h

Note

This parameter is exclusive; do not use it with any other parameter. If you do, only the Help information will be returned.

Message Level

Description	Message level to use. The only supported value is: trace (which turns on debug messages)
Platforms	All
Configuration File Entry	-
Command Line Switch	-l value
Environment Variable	n/a
Required	No
Default	Do not use trace.
Example	-l trace

OMS NFT

Description	Specification (yes or no) for whether or not to use NFT (network fault tolerance) for OMS. If NFT is not used: A uagcmd command execution will attempt to connect to each specified OMS Server. If no connection can be made, uagcmd will fail with a non-zero exit code (2). If a network error occurs after a connection to an OMS server is made, the uagcmd will fail with a non-zero exit code (2).
Platforms	All
Configuration File Entry	network.omsnft=
Command Line Switch	-f
Environment Variable	OMSNFT
Required	No
Default	yes
Example

OMS Servers

Description	Specifies one or more OMS server addresses used for network communication. The syntax of the value is PORT@HOST[:SNI][,PORT@HOST[:SNI]...], where: PORT is the TCP port on which the OMS server is listening. The OMS default port is 7878. HOST is the host name or IP address of the OMS server. SNI is the TLS SNI Hostname to be sent in the TLS ClientHello packet. The value is optional. If not specified, the TLS SNI extension is not included in the TLS ClientHello packet. If TLS SNI Hostname is specified, the Agent will not be able to connect to OMS Servers of versions lower than 7.8.0.0. Note If TLS SNI is specified on a z/OS Agent that is configured to use SystemSSL, then only one host can be configured. If multiple OMS servers are specified, they must be comma-separated.
Platforms	All
Configuration File Entry	network.omsservers=
Command Line Switch	-m
Environment Variable	OMSSERVERS
Required	Yes
Default
Example	network.omsservers=7878@dallas01.acme.com,7878@dallas02.acme.com

Password

Description	Password that the CLI will use to log into the Controller. Must be a valid password for this user.
Platforms	All
Configuration File Entry	security.password=
Command Line Switch	-p
Environment Variable	n/a
Required	Yes
Default	(none)
Example	o

Queue Name

Description	Controller queue name. Must be default for normal set-up.
Platforms	All
Configuration File Entry	network.core=
Command Line Switch	-n
Environment Variable	HUBNAME
Required	No
Default	ops.controller.queue
Example	queue02

SSL/TLS

Description	Specification (by its inclusion on the command line) for whether or not to enable SSL/TLS. Valid values for the configuration file entry are: yes no
Platforms	All
Configuration File Entry	ssl.enable=
Command Line Switch	-s
Environment Variable	n/a
Required	No
Default	no
Example	-s

SSL/TLS Cipher List

Description	Colon-separated or comma-separated list of allowed SSL/TLS ciphers. The ciphers below are valid only for TLS 1.2 and earlier versions. See the `ssl.cipher_suites` option for configuring TLS 1.3 specific ciphers. The following ciphers are allowed: AES256-GCM-SHA384 AES256-SHA AES128-GCM-SHA256 AES128-SHA RC4-SHA RC4-MD5 DES-CBC3-SHA NULL-SHA NULL-SHA256 NULL-MD5
Platforms	All
Configuration File Entry	ssl.ciphers=
Command Line Switch	-g value
Environment Variable	n/a
Required	No
Default	no
Example	-g AES256-SHA,AES128-SHA

SSL/TLS 1.3 Cipher Suites

Description	Colon-separated or comma-separated list of allowed SSL/TLS 1.3 ciphers. The following ciphers are allowed: TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256
Platforms	All
Configuration File Entry	ssl.cipher_suites=
Command Line Switch	-q value
Environment Variable	n/a
Required	No
Default	no
Example	-g TLS_AES_128_GCM_SHA256,TLS_CHACHA20_POLY1305_SHA256

SSL/TLS Implementation

Description	Specification for which SSL/TLS implementation to use on z/OS. Supported values are: openssl system
Platforms	z/OS
Configuration File Entry	ssl.implementation=
Command Line Switch	-i value
Environment Variable	n/a
Required	No
Default	(none)
Example	-i openssl

SSL/TLS Minimum Protocol Version

Description	Restricts the minimal SSL/TLS protocol version allowed in SSL/TLS session negotiation to the value specified. Supported values are : tls1_0 tls1_2 tls1_3
Platforms	All
Configuration File Entry	ssl.min_protocol=
Command Line Switch	-d value
Environment Variable	n/a
Required	No
Default	tls1_2
Example	-d tls1_0

SSL/TLS Maximum Protocol Version

Description	Restricts the maximum SSL/TLS protocol version allowed in SSL/TLS session negotiation to the value specified. Supported values are : tls1_2 tls1_3
Platforms	All
Configuration File Entry	ssl.max_protocol=
Command Line Switch	-d value
Environment Variable	n/a
Required	No
Default	tls1_2
Example	-d tls1_3

Timeout

Description	Time (in seconds) that the CLI will wait before it reports an error.
Platforms	All
Configuration File Entry	config.timeout=
Command Line Switch	-o
Environment Variable	n/a
Required	No
Default	60
Example	10

User ID

Description	User ID that the CLI will use to log into the Controller. Must be a valid user with the appropriate permissions defined in the Controller database using the Controller Security module.
Platforms	All
Configuration File Entry	security.userid=
Command Line Switch	-u
Environment Variable	n/a
Required	Yes
Default	(none)
Example	ops.admin

Version

Description	Displays version information for the CLI.
Platforms	All
Configuration File Entry	n/a
Command Line Switch	-v
Environment Variable	n/a
Required	No
Default	(none)
Example	-v

Note

If this parameter is specified, all other parameters (except Help) are ignored.

Function-Specific Parameters

Most functions contain one or more required and/or optional parameters that are specific to one or more functions.

Modifying Variables

Some function-specific parameters let you modify variables.

Currently, the CLI only supports the modification of User-Defined Variables: global variables, trigger variables, and task/workflow variables.

Modifying a task variable does not impact any existing task instances of that task. When the next task instance is created from the updated task, the new task instance will use the updated variable.

To modify a variable in a task or workflow, you can create a Set Variable action.

Using the CLI for z/OS

All CLI functions are supported in the z/OS environment. They are managed and executed by the program UAGCMDZ (with alias OPSCMDZ), which may execute as either a command processor or a standard z/OS batch job. UAGCMDZ is installed with the z/OS agent in library SUNVLOAD.

z/OS-Specific Syntax Requirements

The functions and syntax requirements for the z/OS environment are very similar to the other supported platforms with a few exceptions described below.

IBM’s z/OS Language Environment (LE) interprets the first forward slash (/) in a parameter string as a separator between parameters meant for LE and parameters meant for the program being executed. To avoid confusion, parameters which contain a forward slash should be enclosed in double quotes. For instance agent-type=z/OS should be agent-type=”z/OS”.

Command Line Options

When UAGCMDZ is executed as a batch program, command line parameters are specified with the step PARM keyword.

For example:

 //STEP01   EXEC PGM=UAGCMDZ,
 //  PARM='ops-agent-status -c dd:CMDOPTS agent-type=windows'

Syntax for Options That Accept File Names: -a, -c, -e, and -x

If you use the -a, -c, -e, and -x command line switches for specifying a file on the command line, you must use one of the following formats for the file name.

For example, for the -c (Configuration File) command line switch:

Format	Syntax	Description
DD Name	`-c dd:ddname`	`ddname` references a DD statement that exists in your batch JCL.
Dataset Name	`-c "//'dsname'"` `-c "//'pdsname(mbr)'"`	`dsname` is a fully-qualified dataset name which may be a partitioned dataset with a member name.
HFS File Name	`-c “/path/to/file/fname”`	A fully-qualified path to a file located on the hierarchical z/OS Unix File System, where `/path/to/file` is the complete path to the file and `fname` is the name of the file.

Format

Syntax

Description

DD Name

-c dd:ddname

ddname references a DD statement that exists in your batch JCL.

Dataset Name

-c "//'dsname'"

-c "//'pdsname(mbr)'"

dsname is a fully-qualified dataset name which may be a partitioned dataset with a member name.

HFS File Name

-c “/path/to/file/fname”

A fully-qualified path to a file located on the hierarchical z/OS Unix File System, where /path/to/file is the complete path to the file and fname is the name of the file.

Line Numbers in Configuration File

Do not place line numbers in columns 73-80. The entire 80-byte record is read and processed as input.

Methods for Issuing CLI Functions in z/OS

Three methods are available for running UAGCMDZ and executing CLI functions:

Using a batch job.
Under a TSO session.
Using a batch TSO Terminal Monitor Program (TMP).

In each example where data sets are specified, we use:

UNV.SUNVLOAD	Library containing the CLI programs UAGCMDZ (and OPSCMDZ alias).
USER.PARM	Data set containing command options.
USER.REXX	Data set containing user REXX EXECs.

Running OCLI Functions in a Batch Job

The CLI program UAGCMDZ executes a single function as a JCL batch job step. If multiple functions are to be executed, run each one as an individual job step.

The following example illustrates running UAGCMDZ as a batch job to request the status of all Windows Agents.

 //jobname  JOB (acctg-info),'your name',MSGCLASS=X,MSGLEVEL=(1,1),
 //             CLASS=A,NOTIFY=&SYSUID
 //*
 //STEP01   EXEC PGM=UAGCMDZ,
 // PARM='ops-agent-status -c dd:CMDOPTS agent-type=windows'
 //STEPLIB  DD DISP=SHR,DSN=UNV.SUNVLOAD
 //SYSPRINT DD SYSOUT=*
 //SYSOUT   DD SYSOUT=*
 //CMDOPTS  DD DSN=USER.PARM(CMDOPTS),DISP=SHR
 //CEEDUMP  DD SYSOUT=*

In this example:

The step PARM value specifies the CLI function and its options.

The job step can include only one function.

The STEPLIB points to the z/OS Agent load library.

The output will be in SYSPRINT.

CMDOPTS is a DDNAME that references the location of the function parameters.

Issuing CLI Functions under TSO

You can also issue CLI functions under a TSO session.

The sample command string below shows a CLI function issued from an ISPF Command Shell prompt:

 Enter TSO or Workstation functions below:
 ===> uagcmdz ops-agent-status -c "//'USER.PARM(CMDOPTS)'" agent-type=windows

This function will return data similar to the sample below:

 Agentname                       AgentType     Status
 agent-sys00101                  Windows       Active
 agent-sys00201                  Windows       Offline
 opscmd-complete

Issuing CLI Functions as a Batch TSO

The following two examples show how to issue a CLI function in a batch TSO.

Example One

//CMDZBAT  JOB (acctg-info),'your name',MSGCLASS=X,MSGLEVEL=(1,1),
 //             CLASS=A,NOTIFY=&SYSUID,TIME=5
 //*
 //STEP01   EXEC PGM=IKJEFT01,DYNAMNBR=200,REGION=40M
 //STEPLIB  DD DISP=SHR,DSN=UNV.SUNVLOAD
 //SYSPRINT DD SYSOUT=*
 //SYSOUT   DD SYSOUT=*
 //SYSTSPRT DD SYSOUT=*
 //CMDOPTS  DD DSN=USER.PARM(CMDOPTS),DISP=SHR
 //SYSTSIN DD *
 uagcmdz ops-agent-status -c dd:CMDOPTS agent-type=windows
 /*

Output will be in SYSTSPRT.

Example Two

 //REXXAGNT JOB (acctg-info),'your name',MSGCLASS=X,MSGLEVEL=(1,1),
 //             CLASS=A,NOTIFY=&SYSUID,TIME=5
 //*
 //STEP01   EXEC PGM=IKJEFT01,DYNAMNBR=200,REGION=40M
 //STEPLIB  DD DISP=SHR,DSN=UNV.SUNVLOAD
 //SYSEXEC  DD DSN=USER.REXX,DISP=SHR
 //SYSPRINT DD SYSOUT=*
 //SYSTSPRT DD SYSOUT=*
 //CMDOPTS  DD DSN=USER.PARM(CMDOPTS),DISP=SHR
 //SYSTSIN DD *
   %OUTTRAP1
 /*

The following REXX EXEC must be located in USER.REXX(OUTTRAP1):

 /**************************** REXX *********************************/
 /* Using OUTTRAP to                                                */
 /*         (1) Obtain z/OS agent status                            */
 /*         (2) Test status from the response               */
 /*         (3) Launch a task if the agent status is Active         */
 /*******************************************************************/
 x = OUTTRAP('OPS.')
  uagcmdz "ops-agent-status -c dd:CMDOPTS agent-type=""z/OS"""
 SAY 'RC is:' RC
 SAY OPS.0 'records were read.'
 launch = 'NO'
 DO i = 1 to OPS.0 WHILE launch = 'NO'
  IF SUBSTR(OPS.i,61,6) = 'Active' THEN
   DO
    launch = 'YES'
    uagcmdz "ops-task-launch -c dd:CMDOPTS task-name=DUMPT"
   END
 END
 DO i = 1 to OPS.0
   SAY OPS.i
 END
 y = OUTTRAP('OFF')

Introduction

CLI Functions

Command Line Syntax

Special Characters Restrictions

Restrictions for task-variables= Parameter

Examples

Pre-6.2.0.0 CLI Functions

Return Codes

Supported Platforms

CLI Login

User Restriction

Password Expiration

Global Parameters

Specifying Global Parameters

CA Certificate List

Configuration File

CRL File

Encrypted File

Encrypted File Key

Help

Message Level

OMS NFT

OMS Servers

Password

Queue Name

SSL/TLS

SSL/TLS Cipher List

SSL/TLS 1.3 Cipher Suites

SSL/TLS Implementation

SSL/TLS Minimum Protocol Version

SSL/TLS Maximum Protocol Version

Timeout

User ID

Version

Function-Specific Parameters

Modifying Variables

Using the CLI for z/OS

z/OS-Specific Syntax Requirements

Command Line Options

Syntax for Options That Accept File Names: -a, -c, -e, and -x

Line Numbers in Configuration File

Methods for Issuing CLI Functions in z/OS

Running OCLI Functions in a Batch Job

Issuing CLI Functions under TSO

Issuing CLI Functions as a Batch TSO

Example One

Example Two

Restrictions for `task-variables=` Parameter

Browser not supported