Versions Compared

Key

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

...

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 Command Line Interface (CLI)#OMS OMS Servers and to log on to a Controller (Command Line Interface (CLI)#User User ID and Command Line Interface (CLI)#Password) Password).

(See Command Line Interface (CLI)#Pre 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 Command Line Interface (CLI)#Special Special Characters Restrictions - =, |, +, and ~ - can be use in a task-variables= parameter.

...

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

UNIX

The CLI functions are installed in the following directory:

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

Windows

The CLI functions are installed in the following directory:

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 Command Line Interface (CLI)#Using 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.

If either restriction is in place, the following error message will display when you issue a CLI command:

...

Password Expiration

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

...

Parameter

Required

Optional

Command Line Interface (CLI)#CA CA Certificate List


(tick)

Command Line Interface (CLI)#Configuration Configuration File


(tick)

Command Line Interface (CLI)#CRL CRL File


(tick)

Command Line Interface (CLI)#Encrypted Encrypted File


(tick)

Command Line Interface (CLI)#Encrypted Encrypted File Key


(tick)

Command Line Interface (CLI)#HelpHelp


(tick)

Command Line Interface (CLI)#Message Message Level
(tick)

Command Line Interface (CLI)#OMS OMS NFT


(tick)

Command Line Interface (CLI)#OMS OMS Servers

(tick)


Command Line Interface (CLI)#PasswordPassword

(tick)


Command Line Interface (CLI)#Queue Queue Name


(tick)

SSL/TLS


(tick)

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

Command Line Interface (CLI)#TimeoutTimeout


(tick)

Command Line Interface (CLI)#User User ID

(tick)


Command Line Interface (CLI)#VersionVersion


(tick)

The following information is provided below for each Global parameter:

...

Description

Configuration file containing one or more Global parameters. It can include the required Command Line Interface (CLI)#User User ID, Command Line Interface (CLI)#Password Password, and Command Line Interface (CLI)#OMS 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 Command Line Interface (CLI)#User User ID or Command Line Interface (CLI)#Password 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 Command Line Interface (CLI)#User User ID or Command Line Interface (CLI)#Password Password on the command line and/or in the Command Line Interface (CLI)#Configuration 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

...

Note
titleNote

If this parameter is specified, all other parameters (except Command Line Interface (CLI)#Help Help) are ignored.

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

...