Alarm macros for SMS email alarm action settings on the DCE server

[JLehr]

Three basic types of macros can be used for Send Short Message Email and Send Data
to FTP Server alarm action settings: Location, Identification, and Alarm.

Location macros

One location macro is available for use when defining alarm action settings for SNMP and
Modbus devices monitored by the Data Center Expert server.

Macro	Definition	Example
${LOCATION}	The location for a Data Center Expert SNMP or Modbus device.	Test Lab

Identification macros

Identification macros are available for use when defining alarm action settings for SNMP
and Modbus devices monitored by the Data Center Expert server.

Macro	Definition	Example
${SERIAL}	The serial number of the device	WA0450123456
${IP}	The dotted-decimal IP address of the device	192.168.2.23
${HOSTNAME}	The hostname of the device	device.apc.com
${MODEL}	The model of the device	Symmetra 80K
${SERVERIP}	The dotted-decimal IP address of the Data Center Expert server	92.168.2.10
${SERVERHOSTNAME}	The hostname of the Data Center Expert server	dce.apc.com
${SERVERMODEL}	The model of the Data Center Expert server	Data Center Expert
${TIMESTAMP}	The current UTC time (seconds since 1/1/1970)	998885130
${DATE}	The current date (year-month-day)	2024-01-31
${YEAR}	The current year	2024
${MONTH}	The current month (2-digit number, January=01).	01
${DAY}	The current day of the month (2-digit number).	31
${TIME}	The current time (24-hour, hour-minute-second	23-30-01
${HOUR}	The current hour of the day (2- digit, 24-hour time)	23
${MIN}	The current minute of the hour	30
${SEC}	The current second of the minute	01

Alarm macros

Alarm macros are available for use when defining alarm action settings on the Data Center
Expert server.

Macro	Definition	Example
${ALERTTYPE}	The type of alert	HIGHERR
${SENSORTYPE}	The type of sensor generating the alert	TEMP
${SENSORVAL}	The value reported by the sensor generating the alert	60
${SENSORVAL_NOLABEL}	The value reported by the sensor generating the alarm, excluding special characters	81.2 rather than 81.2 ° F
${ALERTTIME}	The date and time the alert notification was generated	Jan 12, 2024 13:01:45
${ALERTSEV}	The severity value reported by the sensor that is generating the alert (such as ERR, WARN, INFO). If the alert 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 alert	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 UPS Replacement Battery Selector 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 “active” and “cleared” 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 and 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 that can be defined within the threshold configuration	“Too high”
${START_TIME}	The time the alarm condition was initially detected.	13:01:45
${RESOLVE_TIME}	The time 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 or 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 or 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 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 that can be selected whenever a threshold is configured)	“Turned on the A/C”; “Fixed the leak”