...
...
Panel | ||||
---|---|---|---|---|
|
...
The following command line syntax is used for issuing the CLI command, uagcmd:
Panel |
---|
uagcmd function Global parameters function-specific parameter(s) |
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. |
For example:
Panel |
---|
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.
...
UNIX | The CLI functions are installed in the following directory:
Replace | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Windows | The CLI functions are installed in the following directory: Note |
Replace:
| ||||||||
z/OS | The CLI is implemented with a single program, |
...
If either restriction is in place, the following error message will display when you issue a CLI command:
Panel |
---|
...
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:
...
Description | Specifies one or more OMS server addresses used for network communication.
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 |
...
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 |
---|
...
//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.
...
The following example illustrates running UAGCMDZ as a batch job to request the status of all Windows Agents.
Panel |
---|
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.
...
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:
...
This function will return data similar to the sample below:
...
The following two examples show how to issue a CLI function in a batch TSO.
Example One
...
Output will be in SYSTSPRT.
Example Two
...
The following REXX EXEC must be located in USER.REXX(OUTTRAP1):
//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.
Anchor | ||||
---|---|---|---|---|
|
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:
Panel |
---|
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:
Panel |
---|
Agentname AgentType Status
agent-sys00101 Windows Active
agent-sys00201 Windows Offline
opscmd-complete |
Anchor | ||||
---|---|---|---|---|
|
The following two examples show how to issue a CLI function in a batch TSO.
Example One
Panel |
---|
//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
Panel |
---|
//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):
Panel |
---|
/**************************** 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') |