Versions Compared

Key

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

...

...


Panel
Table of Contents
maxlevel2

...

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.

For example:
 

html-bobswift
 -x encryptedfile.txt task-type=unix task-name=task01
</pre>



Panel
<pre>
uagcmd ops-task-launch 
-c config.cfg
Html bobswift

In this example, the required Global Parameters are contained in the config.cfg configuration file.
 

...

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

<ul> <li> <code>DRIVE
  • DRIVE:\CLI_HOME\
bin</code> </ul> Replace: <ul> <li> <code>DRIVE</code> 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. <li> <code>CLI_HOME</code> with the directory in which the Agent components are installed. </ul>
  • 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.

UNIX

The CLI functions are installed in the following directory:

html-bobswift

<ul> <li> <code>

  • /CLI_HOME/
bin</code> </ul>
  • bin

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

Windows

The CLI functions are installed in the following directory:

Html bobswift
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.

...

Anchor
OMS Servers
OMS Servers
OMS Servers

<ul> <li>
  • PORT
  • is
  • the
  • TCP

port

on which the OMS server is listening. The OMS default port is 7878. <li> HOST is the host name or IP address of the OMS server. </ul>
  • port on which the OMS server is listening. The OMS default port is 7878.
  • HOST is the host name or IP address of the OMS server.

If multiple OMS servers are specified, they must be comma-separated.

Description

Specifies one or more OMS server addresses used for network communication.
 
The syntax of the value is PORT@HOST[,PORT@HOST...], where:

Html bobswift
Html bobswift
PlatformsAll

Configuration File Entry

network.omsservers=

Command Line Switch

-m

Environment Variable

OMSSERVERS

Required

Yes

Default


Example

network.omsservers=7878@dallas01.acme.com,7878@dallas02.acme.com

...

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.

...