If you choose to have an alarm automatically generate an e-mail message, you can use the macros in the table below to create a message that can be generated for many different alarms. Alarm macros are brief commands that allow you to substitute specific information about the generated alarm. Instead of typing a message for each alarm for which you wish to receive e-mail notification, you can type a macro that would address any alarms or devices, as well as additional information such as the date and time the alarm was generated.
For example, if you wished to receive an e-mail that provides the alarm text, severity, device ID, and date and time for each alarm, you can type the following macro in the Message field of the Add Alarm Actions window:
Alarm: $message Severity: $severity was received for device $source at time
$createTime.An example of an e-mail message using this macro is displayed below:
Alarm: No command waiting Severity: Critical was received for device IRT01 at time 12/1/04 12:30.Macro | Description |
|---|---|
$category | The category name to which the alert object belongs. |
$createTime | The time when the alert was created. |
$entity | The entity (or failure object) value of the alert. |
$managementGroup | The group name of the alert. |
hid | The ID of the last event that updated the alert. |
$message | The message string value of the alert. |
$modTime | The time of last modification of the alert. |
$previousSeverity | The previous severity value (for example, 1, 2, etc.) of the alert. |
$severity | The present severity value (for example, 1, 2, etc.) of the alert. |
$shortDescription | The short description of the alert. |
$stringcreatetime | This is the human readable time when the alarm was created (for example, Jun 12, 2006 08:25:08 AM). |
$stringmodtime | This is the human readable time when the alarm was last modified (for example, Jun 13, 2006 09:15:18 AM). |
$stringpreviousseverity | The previous severity value in string format (for example, major, clear, etc.) of the alert. |
$stringseverity | The string severity (for example, major, clear, etc.) of the alert. |
$source | The source of the alert. |
$who | The name of the user who most recently picked up the alert. |