...

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

<pre>
uagcmd <i>function</i> <i>Global parameters</i> <i>function-specific parameter(s)</i>
</pre>

For example:
 

<pre>
uagcmd ops-task-launch 

...

 -x encryptedfile.txt task-type=unix task-name=task01
</pre>

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

...

<ul>
<li> <code>/CLI_HOME/bin</code>
</ul>

<ul>
<li> <code>DRIVE:\CLI_HOME\bin</code>
</ul>
Replace:
<ul>
<li> <code>DRIVE</code> 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.
<li> <code>CLI_HOME</code> with the directory in which the Agent components are installed.
</ul>

Anchor
CLI Login CLI Login

CLI Login

...

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

<pre>
User &lt;your user name&gt; not permitted to use the command line interface. Please check with your administrator.
</pre>

To remove the restriction, the system administrator must either:

...

Anchor
OMS Servers OMS Servers

OMS Servers

...

<ul>
<li> PORT is the TCP 

 on which the OMS server is listening. The OMS default port is 7878.
<li> HOST is the host name or IP address of the OMS server.
</ul>

Anchor
Password Password

Password

...

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

Command Line Options

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

For example:

...

<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

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.

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):

<pre>
 //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 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
Issuing CLI Functions under TSO Issuing CLI Functions under TSO

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:

<pre>
 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:

<pre>
 Agentname                       AgentType     Status
 agent-sys00101                  Windows       Active
 agent-sys00201                  Windows       Offline
 opscmd-complete
</pre>

Anchor
Issuing CLI Functions as a Batch TSO Issuing CLI Functions as a Batch TSO

Issuing CLI Functions as a Batch TSO

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

Example One

<pre>
 //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

<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):

<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>