Panel | ||||
---|---|---|---|---|
|
...
The following command line syntax is used for issuing the CLI command, uagcmd:
Panel | ||
---|---|---|
|
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 | ||
---|---|---|
|
...
|
In this example, the required Global Parameters are contained in the config.cfg
configuration file.
Note | ||
---|---|---|
| ||
For backward-compatibility, you can exclude |
...
UNIX | The CLI functions are installed in the following directory:
Replace | ||||||
---|---|---|---|---|---|---|---|
Windows | The CLI functions are installed in the following directory:
| ||||||
z/OS | The CLI is implemented with a single program, | ||||||
| |||||||
z/OS | The CLI is implemented with a single program, |
Anchor | ||||
---|---|---|---|---|
|
...
If either restriction is in place, the following error message will display when you issue a CLI command:
Panel | ||
---|---|---|
|
To remove the restriction, the system administrator must either:
...
Anchor | ||||
---|---|---|---|---|
|
Description | Description | Password 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 |
...
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 |
Anchor | ||||
---|---|---|---|---|
|
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 |
...
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 |
---|
...
|
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):
|
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 | ||
---|---|---|
|
This function will return data similar to the sample below:
Panel | ||
---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
The following two examples show how to issue a CLI function in a batch TSO.
Example One
Panel | ||
---|---|---|
|
Output will be in SYSTSPRT.
Example Two
Panel | ||
---|---|---|
|
The following REXX EXEC must be located in USER.REXX(OUTTRAP1):
Panel | ||
---|---|---|
|