The purpose of this action is to send an event report to Operations Sentinel about a significant event on a managed host. Once the report is received, Operations Sentinel Console may indicate the alert to the operator by changing the color or shape of an Alert icon or system icon in a cluster.
Event Report Action-Text Format
"TYPE=AL | CLASS=[owner-class-name . ] ... class " \ " | INSTANCE=[owner-object-name . ] ... object-name " \ " | SEV=severity | APPL=application-name" \ " [| APPLQUAL=application-qualifier] " \ " | ALERTID=alert-identifier [| ALERTQUAL=alert-qualifier ]" \ " [| HELP=help-file] [| TEXT=alert-text] " \ " [| EXT_ACTION_LIST=action-list]" \ " [| _LOG=name ] "
See the Operations Sentinel Administration and Configuration Guide for an explanation of event report attribute pairs.
Examples [SP-AMS]
This example demonstrates how to raise an alert in Operations Sentinel. The alert changes the color of an Alert icon and places the message specified for the TEXT attribute in an Alerts window. The use of \ _HOSTID\ in the following example applies to SP-AMS only. To raise an alert using CP-AMS, set INSTANCE=$HOST$ or specify the actual host name.
ACTION EVENT-REPORT "TYPE = AL │ CLASS = host │" \ "INSTANCE = \_HOSTID\ │ SEV = major │" \ "APPL = sp-ams-db │ APPLQUAL = \_DBNAME\ │ ALERTID = alert1│" \ "TEXT = Alert from the \_DBNAME\ database"
This pattern uses the predefined variables _HOSTID and _DBNAME in the EVENT-REPORT action. The variable _HOSTID supplies the value of the INSTANCE attribute for the EVENT-REPORT. The variable _DBNAME supplies the database name as the application qualifier and inserts the database name into the alert text.
The following example demonstrates how to clear an alert in Operations Sentinel. It clears the alert raised by the previous example.
ACTION EVENT-REPORT "TYPE = AL │ CLASS = host │" \ "INSTANCE = \_HOSTID\ │ SEV = clear │" \ "APPL = sp-ams-db │ APPLQUAL = \_DBNAME\ │ ALERTID = alert1"
Required Attribute Value Pairs
Table 4–2 lists the attribute value pairs required for raising, clearing, or acknowledging an alert.
Table 6. Attribute Value Pairs for Alert Event Reports
Attribute | Description |
---|---|
TYPE | Has the value AL for raising, acknowledging, or clearing an alert |
CLASS | The object class within an Operations Sentinel configuration along with the qualifiers for any object that is not a system or server |
INSTANCE | The name of the object along with the qualifiers for any object that is not a system or server |
SEV | The severity of an alert to be raised; or an indication that an alert is to be cleared or acknowledged |
APPL | The source of the event |
ALERTID | The identifier of the alert to be raised, cleared, or acknowledged |
Optional Attribute Value Pairs
Table 4–3 lists the optional attribute value pairs.
Table 7. Optional Attribute Value Pairs for Alert Event Reports
Attribute | Description |
---|---|
APPLQUAL | Identifies a secondary trait about the source of the event |
ALERTQUAL | Further identifies each instance of an alert indicated by the same alert id (ALERTID) |
HELP | The name of a text file with further information about the alert, or the actual help text |
TEXT | The text of the alert, which appears in an Alerts window of Operations Sentinel Console This attribute is required for raising an alert, but optional for clearing or acknowledging an alert. |
EXT_ACTION_LIST | Identifies an action list in an alert policy |
_LOG | The name of the log to which information about the event report is written. |