Panel | ||||
---|---|---|---|---|
|
...
The Universal Controller Command Line Interface (CLI) is implemented as a set of functions that 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 function according to information specified in its required and optional Global parameters and function-specific parameters.
...
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 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 command line syntax is used for issuing the CLI command, uagcmd:
Panel |
---|
<pre>
uagcmd <i>function</i>function<i>Global Globalparameters</i> parameters<i>function function-specific parameter(s)</i> </pre> |
Command Line Entry | Description |
---|---|
uagcmd | CLI command that executes all CLI functions. |
CLI function that performs a specific action in a Universal Controller. | |
CLI parameters (required and optional) available for all functions. | |
CLI parameters (required and optional) specific to one or more functions. |
...
None of these special characters identified in Special Characters Restrictions - =, |, +, and ~ - can be use in a task-variables=
parameter.
...
If either restriction is in place, the following error message will display when you issue a CLI command:
Panel | |
---|---|
Html bobswift | User <your<your username> name> not permitted to use the command line interface. Please check with your administrator.</pre> |
To remove the restriction, the system administrator must either:
...
Note | ||
---|---|---|
| ||
Password expiration is not applicable to LDAP authenticated users. |
Anchor | ||||
---|---|---|---|---|
|
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 Implementation | ![]() | |
SSL/TLS Minimum Protocol Version | ![]() | |
Timeout | | |
User ID | | |
Version | |
The following information is provided below for each Global parameter:
...
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 |
|
Anchor | ||||
---|---|---|---|---|
|
Configuration File
Description | Configuration file containing one or more Global parameters. It can include the required required User ID, Password, and OMS Servers Global Global parameters.
| ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Platforms | All | ||||||||||
Configuration File Entry | n/a | ||||||||||
Command Line Switch | -c | ||||||||||
Environment Variable | n/a | ||||||||||
Required | No | ||||||||||
Default | (none) | ||||||||||
Example |
|
...
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 |
...
Note | ||
---|---|---|
| ||
If this parameter is specified, all other parameters (except Help) are ignored. |
Anchor | ||||
---|---|---|---|---|
|
Function-Specific Parameters
Most functions contain one or more required and/or optional parameters that are specific to one or more functions.
...
The functions and syntax requirements for the z/OS environment are very similar to the other supported platforms with a few exceptions described below.
Note |
---|
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:
Panel |
---|
<pre> //STEP01 EXEC PGM=UAGCMDZ,
// PARM='ops-agent-status -c dd:CMDOPTS agent-type=windows'
</pre> |
Syntax for Options That Accept File Names: -a, -c, -e, and -x
...
The following example illustrates running UAGCMDZ as a batch job to request the status of all Windows Agents.
Panel | |
---|---|
Html bobswift | //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=*
</pre> |
In this example:
The step PARM value specifies the CLI function and its options.
...
The sample command string below shows a CLI function issued from an ISPF Command Shell prompt:
Panel | |
---|---|
Html bobswift | Enter TSO or Workstation functions below:
===> uagcmdz ops-agent-status -c "//'USER.PARM(CMDOPTS)'" agent-type=windows
</pre> |
This function will return data similar to the sample below:
Panel |
---|
<pre>
Agentname AgentType Status
agent-sys00101 Windows Active
agent-sys00201 Windows Offline
opscmd-complete
</pre> |
Anchor | ||||
---|---|---|---|---|
|
The following two examples show how to issue a CLI function in a batch TSO.
Example One
Panel | |
---|---|
Html bobswift | //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
/*
</pre> |
Output will be in SYSTSPRT.
Example Two
Panel |
---|
<pre>
//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
/*
</pre> |
The following REXX EXEC must be located in USER.REXX(OUTTRAP1):
Panel |
---|
<pre>
/**************************** 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')
</pre> |