Alert Actions Macro Variables

Home  Previous  Next

Macro variables can be used in the Alert Actions to customize a string with information related to the encountered hardware failure (display name of the faulty object, value of the parameter, description of the problem, etc.).

Example

You can configure Hardware Sentry to trigger a PATROL event containing the display name of the faulty object by entering something like "Hardware problem with %{ OBJECT_NAME}" in the "Trigger a PATROL Event" dialog box.

NoteYou can use several macros at one time.

The table below recapitulates the available macros in the Alert Actions.

Macro

Description

%{PARAMETER_NAME}

Name of the parameter that triggered the alert
Example: PredictedFailure

%{VALUE}

Formatted value (with unit) of the parameter that triggered the alert
Example: 67.3 °C

%{RAW_VALUE}

Raw value of the parameter that triggered the alert
Example: 67.30000

%{ALARM_TYPE}

Alarm type (INFORMATION, WARNING or ALARM)
Example: ALARM

%{PROBLEM}

Description of the problem encountered by the monitored device
Example: The speed of this fan is critically low (1503 rpm).

%{CONSEQUENCE}

Description of the possible consequence of the detected problem
Example: The temperature of the chip, component or device that was cooled by this fan should grow quickly. This can lead to severe hardware damage and system crashes.

%{RECOMMENDED_ACTION}

Recommended action to solve the problem
Example: Check if the fan is really no more cooling the system. If so, replace the fan.

%{OBJECT_ID}

PATROL internal ID of the instance that triggered the alert
Example: MS_HW_DellOpenManagehdf_11

%{OBJECT_LABEL}

Display name of the instance that triggered the alert
Example: Fan: 1.1 (CPU 1)

%{OBJECT_CLASS}

Class of the instance that triggered the alert
Example: MS_HW_FAN

%{OBJECT_TYPE}

Type of the device that triggered the alert
Example: Fan

%{OBJECT_DEVICEID}

Hardware Sentry internal device ID of the instance that triggered the alert
Example: 1.1

%{PARENT_ID}

PATROL internal ID of the object that the faulty instance is attached to
Example: MS_HW_DellOpenManagehdf_1

%{PARENT_LABEL}

Display name of the object that the faulty instance is attached to
Example: Computer: Dell PowerEdge 1600SC

%{PARENT_CLASS}

Class of the object that the faulty instance is attached to
Example: MS_HW_ENCLOSURE

%{PARENT_TYPE}

Type of the object that the faulty instance is attached to
Example: Computer enclosure

%{PARENT_DEVICEID}

Hardware Sentry internal device ID of the object that the faulty instance is attached to
Example: 1

%{HOSTNAME}

Name of the computer monitored with the PATROL Agent
Example: SENTRYTEST003

%{DATE}

Current date in the YYYY-MM-dd format
Example: 2005-6-23

%{TIME}

Current time in the HH:MM:SS format
Example: 11:14:53

%{ASCTIME:…}

Current date and time formatted as specified in the macro
Example: %{ASCTIME:%m %d %T %Y} will produce Jun 6 11:14:53 2005
The available formats for the %{ASCTIME:…} macro are listed in the asctime() description of the PSL Reference Guide (Book 2).

%{/variable_name}

Value of the variable_name instance variable
Example: %{/worstParam} will give the name of the "worst parameter" of the instance that triggered the alert.
This feature is recommended for advanced users only!

%{NEWLINE}, %{\n}

Linefeed.
This is useful to produce multi-line information.

%{FULLREPORT}

Full hardware health report about the instance that triggered the alert
Example: see the output of the "Instant Hardware Health Report" Menu command

 


See Also

Thresholds, Alerts and Notifications

Alert Actions

Editing Alert Actions