UECLoad Configuration
Overview
Configuration consists of:
- Setting default options and preferences for all executions of UECLoad.
- Setting options and preferences for a single execution of UECLoad.
Configuration Source
Configuration options are read from the following sources:
- Command line
- Command file
- Environment variables
- Definition file
The order of precedence is the same as the list above; command line being the highest, and definition file being the lowest. That is, options specified via a command line override options specified via a command file, and so on.
Configuration Option Categories
The following table categorizes the configuration options that are used to execute UECLoad into logical areas of application.
Category | Description |
---|---|
Action being taken on the specified Agent definition. | |
Definition of the Agent being modified in the UEC database. | |
Options available when using the action --export EVENTS | |
UEC connection options. | |
Options used to display command help and program versions. | |
Alternative methods to specify configuration options. | |
User account that UECLoad executes with in UEC. |
The UECLoad options for each category are summarized in the following tables.
Each Option Name is a link to detailed information about that option in UECLoad Configuration Options.
Action Category Options
Option Name | Description |
---|---|
Specification to add Agent definitions to UEC or to specified group(s) if the GROUPS option is used on the command line. | |
Specification to delete Agent definitions from UEC or from specified group(s) if the GROUPS option is used on the command line. | |
Specification to output the described agent definitions in a format to be used by an Agent definition file. | |
Specification to output the described Agent definitions in a user-friendly format. |
Definitions Category Options
Option Name | Description |
---|---|
Description of the defined Universal Broker. | |
TCP/IP host name of the defined Universal Broker. | |
Unique name of the defined Universal Broker. | |
TCP/IP port number of the defined Universal Broker. | |
Group(s) in which the defined Universal Broker is a member. When this option is used on the command line with the ADD or DELETEoption, the Universal Broker(s) will be added or deleted to the Group(s). |
Events Category Options
Option Name | Description |
---|---|
Archived file to retrieve for export. | |
End time of exported data. | |
Event types to be exported. | |
Delete records in Events database. | |
Output format of event report (formats supported are CSV, XML, and ARC). | |
Start time of exported data. |
Host Category Options
Option Name | Description |
---|---|
TCP/IP port number of UEC. |
Miscellaneous Category Options
Options Category Options
Option Name | Description |
---|---|
File containing multiple Broker definitions to be added or deleted in the UEC database. | |
Code page used for text translation. | |
Encrypted command file. | |
Plain text command file. | |
Encryption key used to decrypt an encrypted command file specified by the COMMAND_FILE_ENCRYPTED option. | |
Level of messages written. |
User Category Options
Option Name | Description |
---|---|
UEC user ID or account with which brokers will be modified. | |
Password associated with USER_ID. |