Home
Alarm macros are available for use when defining alarm action settings on the DCE server.
| Macro | Definition | Example |
|---|---|---|
| ${ALERTTYPE} | The type of alarm. | HIGHERR |
| ${ALERTTYPENAME} | The ${ALERTTYPE} value, displayed in the language appropriate for the Data Center Expert server locale. | Value Too High |
| ${SENSORTYPE} | The type of sensor generating the alarm. | TEMP |
| ${SENSORVAL} | The value reported by the sensor that is generating the alarm. | 60 |
| ${ALERTTIME} | The date and time at which the alarm notification was generated. | Apr 2, 2009 13:01:45 |
| ${ALERTSEV} |
The severity value reported by the sensor that is generating the alarm (such as ERR, WARN, INFO). If the alarm state has returned to normal, the severity value will be followed by "-RTN" (for example WARN-RTN). |
ERR, WARN-RTN |
| ${ALERTSEVNAME} |
The ${ALERTSEV} value, displayed in the language appropriate for the Data Center Expert server locale. |
ERROR, WARN (returned to normal) |
| ${SENSORNAME} | The name of the sensor associated with the alarm. | Bldg. 3 Door |
| ${NOTIFPOLICY} | The name of the notification policy that was used to generate the alarm. | Default, Policy #1 |
| ${ALERTTITLE} | The alarm title. | Replacement Battery Needed |
| ${ALERTDESC} | The description, and recommended action, if any, for the alarm. | At least one faulty battery exists.
Recommended Action: Replace all faulty batteries. You can use the APC Selectors (http://www.apc.com/go/direct/index.cfm?tag=selectors) page to order new batteries. |
| ${ISACTIVE?yes?no} |
Specifies custom active vs. return to normal text. The strings “yes” and “no” can be replaced with user-specified strings. For example, if you specify “active” and “cleared” for the “yes” and “no” values and the macro is translated, if the alert is still active the word "active" would appear. When it has returned to normal, the word "cleared" would appear. |
“active” and “cleared” |
| ${USERURL} | The user-specified URL that can be defined within the threshold configuration. | http://www.mysite.com |
| ${USERDESC} | The user-specified description value which can be defined within the threshold configuration. | “Too high” |
| ${START_TIME} | The time at which the alarm condition was initially detected. | 13:01:45 |
| ${RESOLVE_TIME} | The time at which the alarm condition returned to normal. | 13:07:13 |
| ${SENSORLUID} | The locally unique ID of the sensor generating the alarm. | TEMP1 |
| ${SENSORGUID} | The globally unique ID of the sensor generating the alarm. | B000113_TEMP1 |
| ${EVENTID} |
The unique 16 character identifier shared by all messages generated as a result of a single alarm notification event. For example, if an appliance generates an alarm notification when the internal temperature sensor threshold is exceeded, and then generates a "return to normal" message when the temperature drops below the high threshold, both of these messages will have the same Event ID number. However, if the temperature rises again and a second threshold exceeded alarm is generated, the second alarm will have a new Event ID. |
3E4512C0FE03440F |
| ${DEVICELABEL} | The label of value of the device that either contains the sensor that reported the alarm or to which the sensor is connected. | My Device |
| ${ALERTPOD} | The label of value of the pod that either contains the sensor that reported the alarm or to which the sensor is connected. | My Pod |
| ${ALERTPODSERIAL} | The serial number of the pod that either contains the sensor that reported the alarm or to which the sensor is connected. | NB007100730114 |
| ${ALERTPORT} | The label value for the external sensor port to which the external sensor that reported the alarm is connected. | Ext1 |
| ${CURRENT_ALERT_NUM} | The number of times the alarm action has been repeated, from 0 up to the Repeats value for the alarm action. | 0, 1, 2 |
| ${RESOLVEUSERID} | The user ID that is responsible for manually resolving an alarm (when this option applies). | joeuser |
| ${RESOLVECOMMENT} | The text entered into the user-specified description field whenever an alarm needs to be manually returned to normal (an option which can be selected whenever a threshold is configured). | “Turned on the A/C”; “Fixed the leak” |
0 comments
Please sign in to leave a comment.