UECLoad Configuration Options

UECLoad Configuration Options

This page provides links to detailed information on the configuration options available for use with the UECLoad utility.

The options are listed alphabetically, without regard to any specific operating system.

For Information on how these options are used, see UECLoad Utility.

Configuration Options Information

For each configuration option, the following information is provided.

Description

Describes the configuration option and how it is used.

Usage

Provides a table of the following information:

Method

Syntax

IBM i

HP NonStop

UNIX

Windows

z/OS

Command Line, Short Form

<Format / Value>






Command Line, Long Form

<Format / Value>






Environment Variable

<Format / Value>






Definition File Keyword

<Format / Value>






Method

Identifies the different methods used to specify UECLoad configuration options:

  • Command Line Option, Short Form
  • Command Line Option, Long Form
  • Environment Variable
  • Definition File Keyword

Note

Each option can be specified using one or more methods.

Syntax

Identifies the syntax of each method that can be used to specify the option:

  • Format: Specific characters that identify the option.
  • Value: Type of value(s) to be supplied for this method.

Note

If a Method is not valid for specifying the option, the Syntax field contains n/a.

(Operating System)

Identifies (with a ?) the operating systems for which each method of specifying the option is valid:

  • IBM i
  • HP NonStop
  • UNIX
  • Windows
  • z/OS

Values

Identifies all possible values for the specified value type.

Defaults are identified in bold type.

<Additional Information>

Identifies any additional information specific to the option.

Configuration Options List

The following table identifies all UECLoad configuration options.

Option

Description

ADD

Add Agent definitions to UEC or to specified group(s) if the GROUPS option is used on the command line.

ARCFILE

Archived file to retrieve for export.

BROKER_DEFFILE

File containing multiple broker definitions to be added or deleted in the UEC database.

BROKER_DESCRIPTION

Description of the defined Universal Broker.

BROKER_HOST

TCP/IP host name of the defined Universal Broker.

BROKER_NAME

Unique name of the defined Universal Broker.

BROKER_PORT

TCP/IP port number of the defined Universal Broker.

CODE_PAGE

Code page used for text translation.

COMMAND_FILE_ENCRYPTED

Encrypted command file.

COMMAND_FILE_PLAIN

Plain text command file.

DELETE

Delete Agent definitions from UEC or from specified group(s) if the GROUPS options is used on the command line.

ENCRYPTION_KEY

Encryption key used to decrypt an encrypted command file specified by COMMAND_FILE_ENCRYPTED.

END_TIME

End time of exported data

EVENT_TYPE

Event types to be exported.

EXPORT

Output the described broker definition in a format to be used by a broker definition file.

EXPORT_DELETE

Specification that the exported records from the UEC events database table are to be deleted upon -export EVENTS action.

FORMAT

Format of the output from the -export EVENTS action

GROUPS

Group(s) in which the defined Universal Broker is a member. When this option is used on the command line with the ADD or DELETE option, the Universal Broker(s) will be added or deleted to the Group(s).

HELP

Displays command line options description and format.

LIST

Output the described broker definition in a user-friendly format.

MESSAGE_LEVEL

Level of messages written.

START_TIME

Start time of exported data.

UEC_PORT

TCP/IP port number of the UEC.

USER_ID

UEC user ID/account with which Brokers will be modified.

USER_PASSWORD

Password associated with USER_ID.

VERSION

Writes program version.