16.10 - Alerts - Teradata Ecosystem Manager

Teradata Ecosystem Manager API Reference

prodname
Teradata Ecosystem Manager
vrm_release
16.10
created_date
June 2017
category
Programming Reference
featnum
B035-3204-067K

Alerts can be sent using the sendevent command.

Syntax

Sendevent [-a Alert Code] [--tds TDPID] [-e Ecosystem] [-r Resource] [-t Resource Type] [-s System Identifier] [-j JobName] [-l Severity] [-m Message] [-wde UOW Description] [--wss UOW Source System] [--wdb UOW Database] [--wtb UOW table name] [--wnm UOW Name] [–w UOW ID] [--o1 Arg1] [--o2 Arg2] [--o3 Arg3]

where

Argument Description
-a (Required) Alert Code. Specific alert number.
--tds TDPID
-e Ecosystem
-r Resource identifier
-t Resource type
-s Source system identifier
-l (Required) Severity where 1 is normal, 5 is warning, and 10 is critical
-m Message. The maximum length is 1000 characters.
--wde Unit of work description
--wts Unit of work time stamp
--wdt Unit of work date marker
--wss Unit of work source system. For reporting purposes only.
-w Unit of work identifier
--o1 [Optional] Arg 1. Optional argument with implementation-specific data. The maximum length is 50 characters.
--o2 [Optional] Arg 2. Optional argument with implementation-specific data. The maximum length is 50 characters.
--o3 [Optional] Arg 3. Optional argument with implementation-specific data. The maximum length is 50 characters.
--wdb Affected database name. The maximum length is 128 characters.
--wtb Affected table name. The maximum length is 128 characters.
--wnm Unit of work name. The maximum length is 30 characters.
-j Job step name. Identifies an individual jobstep within a job where the job is identified by -r or --jid and -t flags. Use of this flag is optional as it is only needed when using STEP events to identify a second level of granularity within a job. The maximum length is 255 characters.
--js [Optional] Job sub-step name. Step within a multiple step load stream used to identify distinct steps within a job. Use this flag when using STEP events to identify a third level of granularity within a job. The maximum length is 255 characters.
-d Data Manipulation Language (DML) code. Values: INSERT, DELETE, and UPDATE. This value is used in conjunction with --wdb and --wtb to report on individual table change activity. This flag identifies the type of change to the database table. The maximum length is 50 characters.