Email Action Variables

The following are the Email Action variables you can use in customizing the content of action e-mail. These appear classified as follows:

Basic Variables

Managed Equipment Variables

Entity Type: Port

Entity Type: Interface, Logical interface

To successfully retrieve Custom attributes in e-mail, you must first create them. See Edit Custom Attributes.

You can also configure more limited variables that are slightly more efficient in performance, if not as detailed as those described in the following section.

For example, you can retrieve the following attributes:

{RedCell.Config.EquipmentManager_Custom1}

{RedCell.Config.EquipmentManager_Custom2}

{RedCell.Config.EquipmentManager_LastBackup}

{RedCell.Config.EquipmentManager_LastConfigChange} and

{RedCell.Config.EquipmentManager_HealthStatus}

If the entity does not contain/return these values, then the message [No data for <attribute name>] appears in the email instead.

Basic Variables

Attribute

Description

Email Action Variable

Name

The event / alarm name

{Name}

Message

Description from the event

{Message}

Entity Name

The entity (interface, card...) name

{EntityName}

Equipment Manager Name

The name of the equipment, parent or chassis.

{EquipMgrName}

Device IP address

the IP of the device in alarm

{DeviceIP}

Entity Type

Type of entity (Router, and so on)

{EntityType}

Instance ID

An identifier for the event

{InstanceID}

Protocol Type

Of originating alarm (SNMP, syslog, etc.)

{ProtocolType}

Protocol Sub Type

Inform, Trap, [blank] (for internal events)

{ProtocolSubType}

Receive Time

 

{RecvTime}

Region

The mediation server partition name.

{Region}

Severity

0 - cleared, through 6 - critical, from Alarm Definition

{Severity}

Source IP address

The IP of the component sending the alarm

{SourceIP}

The following section describe variables whose use may have a performance impact.

Managed Equipment Variables

Attribute

Description

Email Action Variable

Custom 1

Note that although you can re-name any Custom attribute, you must use the variable’s original name. For example here, that is {RedCell.Config.Equipment­Manager_Custom1}

{RedCell.Config.EquipmentManager_Custom1}

Custom 2

 

{RedCell.Config.EquipmentManager_Custom2}

Custom 3

 

{RedCell.Config.EquipmentManager_Custom3}

Custom 4

 

{RedCell.Config.EquipmentManager_Custom4}

Custom 5

 

{RedCell.Config.EquipmentManager_Custom5}

Custom 6

 

{RedCell.Config.EquipmentManager_Custom6}

Custom 7

 

{RedCell.Config.EquipmentManager_Custom7}

Custom 8

 

{RedCell.Config.EquipmentManager_Custom8}

Custom 9

 

{RedCell.Config.EquipmentManager_Custom9}

Custom 10

 

{RedCell.Config.EquipmentManager_Custom10}

Custom 11

 

{RedCell.Config.EquipmentManager_Custom11}

Custom 12

 

{RedCell.Config.EquipmentManager_Custom12}

Custom 13

 

{RedCell.Config.EquipmentManager_Custom13}

Description

Description of the equipment

{RedCell.Config.EquipmentManager_DeviceDescription}

DNS Hostname

Hostname of equipment

{RedCell.Config.EquipmentManager_Hostname}

Equipment Type

Equipment Type

{RedCell.Config.EquipmentManager_CommonType}

Firmware Version

Version of the equipment’s firmware

{RedCell.Config.EquipmentManager_FirmwareVersion}

Hardware Version

Version of the equipment’s hardware

{RedCell.Config.EquipmentManager_HardwareVersion}

Last Backup

Last Backup

{RedCell.Config.EquipmentManager_LastBackup}

Last Configuration Change

Last Configuration Change

{RedCell.Config.EquipmentManager_LastConfigChange}

Last Modified

Timestamp of Last Modified

{RedCell.Config.EquipmentManager_LastModified}

Model

Model number of the equipment

{RedCell.Config.EquipmentManager_Model}

Name

Component name

{RedCell.Config.EquipmentManager_Name}

Network Status

Network Status

{RedCell.Config.EquipmentManager_HealthStatus}

Notes

Equipment Notes

{RedCell.Config.EquipmentManager_Notes}

OSVersion

OSVersion

{RedCell.Config.EquipmentManager_OSVersion}

Serial Number

Unique identifier for the equipment

{RedCell.Config.EquipmentManager_SerialNumber}

Software Version

Version of the equipment’s software

{RedCell.Config.EquipmentManager_SoftwareVersion}

System Object Id

SNMP based system object identifier

{RedCell.Config.EquipmentManager_SysObjectID}

Entity Type: Port

Attribute

Description

Email Action Variable

Custom 1

Note that although you can re-name any Custom attribute, you must use the variable’s original name. For example here, that is {RedCell.Config.Equipment­Manager_Custom1}

{RedCell.Config.Port_Custom1}

Custom 2

 

{RedCell.Config.Port_Custom2}

Custom 3

 

{RedCell.Config.Port_Custom3}

Custom 4

 

{RedCell.Config.Port_Custom4}

Encapsulation

Encapsulation

{RedCell.Config.Port_Encapsulation}

Hardware Version

Version of the port’s hardware

{RedCell.Config.Port_HardwareVersion}

If Index

SNMP If Index

{RedCell.Config.Port_IfIndex}

MAC Address

“Typically a MAC Address, with the octets separated by a space, colon or dash depending upon the device. Note that the separator is relative when used as part of a query.”

{RedCell.Config.Port_UniqueAddress}

Model

Model number of the port

{RedCell.Config.Port_Model}

MTU

Maximum Transmission Unit

{RedCell.Config.Port_Mtu}

Name

Port name

{RedCell.Config.Port_Name}

Notes

Port Notes

{RedCell.Config.Port_Notes}

Port Description

Description of the port

{RedCell.Config.Port_DeviceDescription}

Port Number

Port Number

{RedCell.Config.Port_PortNumber}

Slot Number

Slot Number

{RedCell.Config.Port_SlotNumber}

Speed

Speed

{RedCell.Config.Port_Speed}

Subnet Mask

SubMask

{RedCell.Config.Port_SubMask}

Entity Type: Interface, Logical interface

Attribute

Description

Redcell Email Action variable

Custom 1

Note that although you can re-name any Custom attribute, you must use the variable’s original name. For example here, that is {RedCell.Config.Equipment­Manager_Custom1}

{RedCell.Config.Interface_Custom1}

Custom 2

 

{RedCell.Config.Interface_Custom2}

Custom 3

 

{RedCell.Config.Interface_Custom3}

Custom 4

 

{RedCell.Config.Interface_Custom4}

Encapsulation

Encapsulation

{RedCell.Config.Interface_Encapsulation}

IfIndex

SNMP Interface Index

{RedCell.Config.Interface_IfIndex}

Interface Description

Description of the Interface

{RedCell.Config.Interface_DeviceDescription}

Interface Number

Interface Number

{RedCell.Config.Interface_InterfaceNumber}

Interface Type

Common Interface Type

{RedCell.Config.Interface_CommonType}

MTU

Maximum Transmission Unit

{RedCell.Config.Interface_Mtu}

Name

Interface name

{RedCell.Config.Interface_Name}

Notes

Interface Notes

{RedCell.Config.Interface_Notes}

Port Number

Port Number

{RedCell.Config.Interface_PortNumber}

Slot Number

Slot Number

{RedCell.Config.Interface_SlotNumber}

Subnet Mask

Subnet Mask of the Interface

{RedCell.Config.Interface_SubMask}

Best practice is to clarify such attributes by combining them with others that spell out their source.