Alert Actions Macros

A macro is a variable whose value is replaced when an Alert Action is triggered. Macros can be used to customize the content of each Alert Action. For example: %{VALUE} is replaced by the actual current value of the parameter that triggered the alert. When used in the text field for a PATROL event Alert Action, the percentage value is replaced by the actual current value of the parameter that triggered the alert.

Each macro listed in the table below contains information about what triggered the PATROL alert.

Macros Description
%{/...} Recommended for advanced users only. Provides an internal instance variable name to be inserted. The path is relative to the object triggering the alert.
%{ALARM_TYPE} Type of alert triggered (ALARM, WARN or INFORMATION).
%{ASCTIME:...} Current date and time formatted as specified in the macro.
%{CONTEXT} Path of parent instances up to the root path.
%{DATE} Current date in the YYYY-MM-DD format.
%{HOSTNAME} Hostname of the storage system which triggered the alert. If the alert is triggered on the main instance, the hostname of the PATROL Agent is returned.
%{IP_ADDRESS} IP Address of the storage system which triggered the alert. If the alert is triggered on the main instance, the IP address of the PATROL Agent is returned.
%{NEWLINE} Linefeed. This is useful to produce multi-line information.
%{OBJECT_CLASS} Class of the instance that triggered the alert.
%{OBJECT_ID} PATROL internal ID of the instance that triggered the alert.
%{OBJECT_LABEL} Display name of the instance that triggered the alert.
%{OBJECT_TYPE} Type of the instance (Fiber Port, Ethernet Port, Storage System, … ).
%{PARAMETER_NAME} Name of the parameter that triggered the alert.
%{PARENT_...} Get the object of a macro that the faulty instance is attached to
%{PARENT_CLASS} Class of the object that the faulty instance is attached to.
%{PARENT_ID} PATROL internal ID of the object that the faulty instance is attached to.
%{PARENT_LABEL} Display name of the object that the faulty instance is attached to.
%{PROBLEM} Displays the nature of the problem in plain English including the following information: Problem detected with <OBJECT_TYPE> <OBJECT_NAME>: <PARAMETER_NAME> = <PARAMETER_VALUE> <PARAMETER_UNIT> ==> <PARAMETER_STATE>.
%{TIME} Current time in the HH:MM:SS format.
%{VALUE} Formatted value (with unit) of the parameter that triggered the alert.