Edit Action Overrides

This window lets you override the default content contained in an alarm action message. For example, if you are creating an email action, you can customize the information contained in the email subject line and body. If you are creating a syslog or trap notification action, you can specify certain information that you want contained in the syslog or trap message.

The default message content that displays in the window is defined in the Alarm Action Defaults options (Administration > Options > Alarm > Alarm Action Defaults). Any overrides of the default content that you make here will only affect the specific alarm action that you are editing.

The message content is configured as a template, with the content passed directly as typed, except for the variable information which is specified by $keyword. The variable information ($keyword) is replaced with information from the alarm when the alarm action is executed. See below for a list of available keywords, along with their definitions.

The Custom Arguments field is used to specify the arguments passed to a program. Each argument is delimited by spaces. An argument can be a literal, passed to the program exactly as typed, or a variable, specified as $keyword. A group of literals and variables can be combined into a single argument by using double quotes. The value "all" is a special value that tells ExtremeCloud IQ Site Engine to pass all variable values to the program as individual arguments.

To access this window, select the Override Content checkbox in the Actions subtab in the Create/Edit Alarm Definition window.

Keyword Definitions

There are certain $keywords that you can use as variables in your alarm action messages. These $keywords are replaced with information from the alarm when the alarm action is executed. Following is a list of available $keywords, along with the value the $keyword will return.


Alarm Keywords  
$alarmName The name of the alarm.
$alarmSource The component (such as a device) that raised the alarm.
$alarmSourceName

The value varies depending on the alarm source:

  • For a device or entity with an IP address, it will be the resolved host name of the alarm source. The ExtremeCloud IQ Site Engine Server must be able to resolve the alarm source IP address to a host name (DNS, hosts file) and the Alarm/Event Logs and Tables > Resolve source host names option must be enabled in the Suite-Wide options (Tools > Options).
  • For an AP serial number, it can be the AP name.
  • Other alarm sources can provide different source names.
  • If no alarm source name is available, the string will be empty (blank).
$alarmSubcomponent The subcomponent (such as an interface) that raised the alarm.
$severity The alarm severity.
$type The value returned is always "Alarm".
$trigger Indicates whether the trigger was a trap or event.
$server The ExtremeCloud IQ Site Engine server IP address.
$time The date and time when the event or trap occurred.
$message The event message.
$eventType The event type (event or trap).
$eventSeverity The event severity.
$eventCategory The event category.
$eventTitle The event message.
$eventUser The event user identifier.
$eventClient The event client identifier.
$deviceIP The IP address of the device that is the source of the alarm.
$deviceIpCtx The device IP and Context.
$deviceNickName The device nickname.
$deviceBootProm The BootProm version on the device.
$deviceFirmware The firmware version on the device.
$deviceStatus The device status.
$snmp The device SNMP credentials
$sysName The system name.
$sysLocation The system location.
$sysContact The system contact.
$sysDescr The system description
$sysUpTime The system uptime.
$chassisId The chassis ID.
$chassisType The chassis type.
$trapName The trap name.
$trapEnterprise The Enterprise for this trap (Extreme, snmpTraps, rmonEventsV2, dot1dBridge) as defined in the trapd.conf file.
$trapOid The trap OID.
$trapArgs The trap arguments.
$trapArg{1-8} Nth Trap argument.

Related Information

For information on related help topics: