Versions Compared

Old Version 15

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

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


Panel
Table of Contents
maxlevel2

...

The Universal Controller Command Line Interface (CLI) is implemented as a set of functions that functions that perform specific actions in a Universal Controller. The results of the actions are written to the CLI standard output.

The CLI command, uagcmd, executes a function according to information specified in its required and optional Global parameters and function-specific parameters.

Anchor
Functions
Functions
CLI Functions

...

The CLI command, uagcmd, can execute functions on any system that has TCP/IP connectivity to the Universal Message Service (OMS).

The 9863189 for command line syntax for each execution of uagcmd must specify a single CLI function, required / optional 9863189 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 (9863189 User ID and 9863189Password).

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

function

CLI function that performs a specific action in a Universal Controller.

Global parameters

CLI parameters (required and optional) available for all functions.

function-specific parameter(s)

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
titleNote

For backward-compatibility, you can exclude uagcmd from the command line for all pre-6.2.0.0 CLI functions.

Anchor
Special Characters Restrictions
Special Characters Restrictions
Special Characters Restrictions

...

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

...

Note
titleNote

Password expiration is not applicable to LDAP authenticated users.

Anchor
Global Parameters
Global Parameters

Global Parameters

The CLI provides the following Global parameters for use with any CLI function:

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:

...

Three methods are available for specifying Global parameters:

  1. Command line switches
  2. Configuration file entries
  3. Environment variables

...

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”

...

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

Function-Specific Parameters

Most functions contain one or more required and/or optional parameters that are specific to one or more functions.

...

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:

...