UECLoad 7.3.x Quick Reference Guide
- Former user (Deleted)
- Stonebranch (Deactivated)
Usage
uecload {ACTION} [EVENTS] USER HOST [OPTIONS] [DEFINITIONS]
uecload { -help | -version }
Format
There is a long form and, for most options, a short form available for specifying each option on the command line. The long form is not case-sensitive; the short form is case-sensitive.
Options must be prefixed with a dash ( - ) character. If an option value is specified, the option and its value must be separated by at least one space.
ACTION {-add | -delete | -list | -export}
Long Form | Short Form | Description |
|---|---|---|
-add | n/a | Add agent definitions to the UEC. |
-delete | n/a | Delete agent definitions to the UEC. |
-export | n/a | Output the described agent definitions in a format to be used by a agent definition file. |
-list | n/a | Output the described agent definitions in a user-friendly format. |
EVENTS [-arcfile] [-format] [-event_type] [-export_delete] [-stime] [-etime]
The following parameters are used when using the -export EVENTS action.
Long Form | Short Form | Description |
|---|---|---|
-arcfile filename | n/a | Name of an archived file to retrieve for export. |
-etime enddate[,endtime] | -s enddate [,endtime] | Ending date and time selection criteria of the export of the UEC events database table, which is required for the -export EVENTS action. |
-event_type | n/a | Event types to be exported. |
-export_delete | n/a | Specification to delete exported records from the UEC events database table upon -export EVENTS action. |
-format format | n/a | Format of the output file from the -export EVENTS action. |
-stime startdate[,starttime] | -s startdate [,starttime] | Starting date and time selection criteria of the export of the UEC events database table, which is required for the -export EVENTS action. |
USER [-userid [-pwd] ] [-port]
Long Form | Short Form | Description |
|---|---|---|
-port port | -p port | TCP port on which to send the command. |
-pwd password | -w password | Password for the user identifier specified by -userid. |
-userid user | -u user | User identifier that is used to sign on to the UEC. |
HOST [-port]
Long Form | Short Form | Description |
|---|---|---|
-port port | -p port | TCP port on which to send the command. |
OPTIONS [-broker_desc] [-broker_host] [-broker_name] [broker_port] [-codepage] [-level] [-deffile] [-file | -encryptedfile] [ { -help | -version } ]
Long Form | Short Form | Description |
|---|---|---|
-broker_desc description | n/a | Description of the Broker being added or deleted in the UEC database. |
-broker_host address | n/a | Host network address of the Broker being added, deleted, or viewed in the UEC database. |
-broker_name name | n/a | Unique name of a Broker being added, deleted, or viewed in the UEC database. |
-broker_port port | n/a | TCP/IP port of the Broker being added, deleted, or viewed in the UEC database. |
-codepage codepage | -t codepage | Character code page that is used to translate text data received and transmitted over the network. |
-deffile filename | n/a | Broker definition file (deffile), which is used to specify multiple Broker definitions to be added or deleted to the UEC. When used with the -export option, this is the name of the output file. |
-encryptedfile filename / ddname | -x filename / ddname | File name / ddname of a file / data set containing encrypted values for command line option parameters. |
-file filename / ddname | -f filename / ddname | File name / ddname of a file / data set containing plain text values for command line option parameters. |
-help | -h | Writes help file. |
-level level | -l level | Level of messages to write. |
-port port | -p port | TCP port on which to send the command. |
-pwd password | -w password | Password for the user identifier specified by -userid. |
-userid user | -u user | User identifier that is used to sign on to the UEC. |
-version | -v | Writes program version information and copyright. |
DEFINITIONS [-broker_desc] [-broker_host] [-broker_name] [broker_port] [-groups]
Long Form | Short Form | Description |
|---|---|---|
-broker_desc description | n/a | Description of the Broker being added or deleted in the UEC database. |
-broker_host address | n/a | Host network address of the Broker being added, deleted, or viewed in the UEC database. |
-broker_name name | n/a | Unique name of a Broker being added, deleted, or viewed in the UEC database. |
-broker_port port | n/a | TCP/IP port of the Broker being added, deleted, or viewed in the UEC database. |
-groups | n/a | List of groups to which an ADD or DELETE option will be applied. |