| Panel | ||||
|---|---|---|---|---|
|
...
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.)
...
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. |
...
| Panel |
|---|
uagcmd ops-task-launch -c config.cfg -x encryptedfile.txt task-type=unix task-name=task01 |
...
| Note | ||
|---|---|---|
| ||
For backward-compatibility, you can exclude |
| Anchor | ||||
|---|---|---|---|---|
|
...
None of these special characters identified in Special Characters Restrictions - =, |, +, and ~ - can be use in a task-variables= parameter.
...
UNIX | The CLI functions are installed in the following directory:
Replace | |||||
|---|---|---|---|---|---|---|
Windows | The CLI functions are installed in the following directory:
Replace:
| |||||
z/OS | The CLI is implemented with a single program, |
...
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
- Syntax for specifying the parameter.
- Requirement to use the parameter.
- Default value (if any).
- Example
...
Three methods are available for specifying Global parameters:
- Command line switches
- Configuration file entries
- Environment variables
...
Description | Complete path to a file encrypted with the Universal Encrypt utility that contains encrypted user credentials.
| |||||
|---|---|---|---|---|---|---|
| Platforms | All | |||||
Configuration File Entry | n/a | |||||
Command Line Switch | -x | |||||
Environment Variable | n/a | |||||
Required | No | |||||
Default | (none) | |||||
Example | UNIX
Windows
z/OS
|
...
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 | ||||
|---|---|---|---|---|
|
...
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.
...
Three methods are available for running UAGCMDZ and executing CLI functions:
In each example where data sets are specified, we use:
...