Versions Compared

Old Version 2

changes.mady.by.user Stonebranch (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user Alec Berger

Saved on

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

...

Supported Platforms

For all supported platforms, the CLI is included in the Universal Agent 7.2.x package.
 

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 for detailed information on using the CLI in a z/OS environment.

...

  1. The system level default for CLI access, specified by the System Default Command Line Access Universal Controller system property, has been set to No, and the Command Line Access field in the User Details for your user account is set to -- System Default --."
  2. The Command Line Access field in the User Details for your user account is set to No, which overrides the System Default Command Line Access value.

...

Password Expiration

While a password is expired, CLI access will be prohibited until the password has been changed.

...

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 1.3 Cipher Suites
(tick)
SSL/TLS Implementation
(tick)
SSL/TLS Minimum Protocol Version
(tick)
SSL/TLS Maximum Protocol Version
(tick)

Timeout


(tick)

User ID

(tick)


Version


(tick)

...

Description

Complete path to a file encrypted with the Universal Encrypt utility that contains encrypted user credentials.
 
This file can be used to store encrypted Controller credentials that would otherwise be specified using the User ID or Password parameters. One or both of these parameters can be encrypted and stored in this file. Any other parameters stored in the encrypted file are ignored.
 
Any values specified by User ID or Password on the command line and/or in the Configuration File will override values stored in this file.
 

Note
titleNote

Universal Encrypt is included in every Agent installation package.


PlatformsAll

Configuration File Entry

n/a

Command Line Switch

-x

Environment Variable

n/a

Required

No

Default

(none)

Example

UNIX

  • /opt/encfile/fname.enc

Windows

  • c:\encfile\fname.enc

z/OS

  • -x dd:fname
  • -x fname
  • -x “//’fname’”
  • -x “//’fname(mbr)’”
  • -x “/path/to/encfile/fname”

...

Description

Optional key that was passed to the Universal Encrypt utility when the encrypted file specified by -x was created.

PlatformsAll

Configuration File Entry

n/a

Command Line Switch

-k

Environment Variable

n/a

Required

No

Default

(none)

Example


...

Note
titleNote

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

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

...