Using Macros to Customize PATROL Event Alert Actions

How to customize the PATROL Event Alert Action with macros.

Related Topics


This article explains how to use macros to customize the "PATROL Event" Alert Action. It will more especially present the use of the following macros:

  • %{PROBLEM}: Displays the following information: Problem detected with <OBJECT_TYPE> <OBJECT_NAME>: <PARAMETER_NAME> = <PARAMETER_VALUE> <PARAMETER_UNIT> ==> <PARAMETER_STATE>.
  • %{CONTEXT}: Displays the path of the parent instances up to the root path (e.g.: /ARRAY NAME/volumes/VOLUME NAME).
  • %{HOSTNAME}: Displays the hostname of the storage system which is in abnormal state.
  • %{IP_ADDRESS}: Displays the IP Address of the storage system which is in an abnormal state.
  • %{NEWLINE}: Linefeed. This macro can be used to produce multi-line message.


To customize the "PATROL Event" Alert Action:

  1. In the PATROL console, right-click the KM main icon and click KM Commands > KM Settings > Alert Actions…
  2. Check the Trigger a PATROL Event box and click Next to continue.
  3. Copy the following text in the Event message field:
  4. Click Next and Finish to save your changes.
  5. Open the Event Manager and double-click the event that was triggered by the Alert Action you have just set up. The Event Description should show the generic message for a problem detection, the context, the hostname and IP address of the storage system.

Please note that the information displayed in the Event Description field may differ whether the alert is triggered on the SMI-S provider, on the storage system, or on the component (e.g.: the Ethernet port).

If the alert is triggered:

  • On the SMI-S provider, the hostname of the SMI-S Provider will be displayed.
  • On the main instance, the PATROL Agent hostname will be displayed.
  • On the component instance, the storage system hostname will be displayed.