Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
Table of Contents
maxlevel2

...

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 9863189 for each execution of uagcmd must specify a single CLI function, required / optional Global parameters 9863189, 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 9863189 and Password 9863189).

(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.)

...

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:

  • /CLI_HOME/bin

Replace CLI_HOME with the directory in which the Agent components are installed.

Windows

The CLI functions are installed in the following directory:

  • DRIVE:\CLI_HOME\bin

Replace:

  • DRIVE 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.
  • CLI_HOME with the directory in which the Agent components are installed.
Note
titleNote

Do not use fully qualified file names (that is, with the .exe extension) in CLI for Windows parameters; an error will occur.


z/OS

The CLI is implemented with a single program, UAGCMDZ. UAGCMDZ (with alias OPSCMDZ) is installed in the SUNVLOAD library as part of the Universal Agent for z/OS Installation package.
 
See Using the CLI for z/OS 9863189 for detailed information on using the CLI in a z/OS environment.

...

Parameter

Required

Optional

CA Certificate List


(tick)

Configuration File


(tick)

CRL File


(tick)

Encrypted File


(tick)

Encrypted File Key


(tick)

Help


(tick)

Message Level
(tick)

OMS NFT


(tick)

OMS Servers

(tick)


Password

(tick)


Queue Name


(tick)

SSL/TLS


(tick)

SSL/TLS Cipher List
(tick)
SSL/TLS Implementation
(tick)
SSL/TLS Minimum Protocol Version
(tick)

Timeout


(tick)

User ID

(tick)


Version


(tick)

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.

PlatformsAll

Configuration File Entry

ssl.certstore=

Command Line Switch

-a

Environment Variable

n/a

Required

No

Default

(none)

Example

  • UNIX
    • /opt/cert/ca.pem
  • Windows
    • c:\cert\ca.pem
  • z/OS:
    • -a dd:CACERTS
    • -a CACERTS
    • -a “//’CACERTS’”
    • -a “//’CACERTS(mbr)’”
    • -a “/path/to/file/CACERTS

Anchor
Configuration File
Configuration File

Configuration File

Description

Configuration file containing one or more Global parameters. It can include the required User ID, Password, and OMS Servers Global parameters.

Note
titleNote

The configuration file syntax is cfggroup.cfgopt=cfgval, where cfggroup is the group to which the option belongs, cfgopt is the option name, and cfgval is the option value. 

For example:

security.userid=ops.admin
security.password=abc123
network.omsservers=7878@dallas01.acme.com,7878@dallas02.acme.com
network.omsnft=yes
config.timeout=60


You also can specify individual Global parameters (required and optional) on the command line.


Note
titleNote

A sample CLI configuration file, cmdtools.props, is created during the installation of the CLI (an optionally installed component of Universal Agent). However, you can create a configuration file with any name; it must exist in the directory from where you are issuing the uagcmd command.


PlatformsAll

Configuration File Entry

n/a

Command Line Switch

-c

Environment Variable

n/a

Required

No

Default

(none)

Example

  • UNIX
    • /opt/cfgopt/cfgval.pem
  • Windows
    • c:\cfgopt\cfgval.pem
  • z/OS:
    • -c dd:cfgval
    • -c cfgval
    • -c “//’cfgval’”
    • -c “//’cfgval(mbr)’”
    • -c “/path/to/file/cfgval

...

Note
titleNote

If this parameter is specified, all other parameters (except Help) are ignored.

Anchor
Function-Specific Parameters
Function-Specific Parameters
Function-Specific Parameters

...

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.

...