Network Management

Commonly Used Alert Email Variables in Orion Platform

Variables are commonly used in alerting and change depending on the type of alert that used. This lists variables for nodes, volumes, components, applications, custom pollers (UnDP's), and interfaces. Orion alerting.

First published date

11/2/2019 1:36 PM

Last published date

2/4/2025 10:47 AM

Overview

This article describes some of the most commonly used alerting variables that can be used for alert emails. The variables change depending on the property type of the alert. The goal of this article is to provide some useful variables that may be difficult to find among the available choices.

Note: For all Orion Platform variables, go to this topic and select a category from the menu in the left pane: Variables and examples used in the Orion Platform.

 

Product section

Orion Platform

Resolution

The following alert variables are separated into the property type of the alert. This is determined on the Trigger Conditions tab in the top drop-down.


Node
    Node name: ${N=SwisEntity;M=Node.Caption}
    Node IP: ${N=SwisEntity;M=IP_Address}
    Custom Properties: ${N=SwisEntity;M=CustomProperties.CpName}

     Note: must change CpName to the actual custom property name.
    Engine: ${N=SwisEntity;M=Engine.ServerName} or ${N=SwisEntity;M=Engine.DisplayName}
 

Volume
    Parent Node Name: ${N=SwisEntity;M=Node.Caption}
    Volume Name: ${N=SwisEntity;M=Caption}
    Percent Used: ${N=SwisEntity;M=VolumePercentUsed}
    Volume size: ${N=SwisEntity;M=VolumeSize}
    Volume Name (includes node name): ${N=SwisEntity;M=FullName}
    Volume Space Percent Used: ${N=SwisEntity;M=VolumePercentUsed}


Component
    Component Name: ${N=SwisEntity;M=ComponentAlert.ComponentName}
    Component Status: ${N=SwisEntity;M=ComponentAlert.ComponentAvailability}
    Component Statistic Data: ${N=SwisEntity;M=ComponentAlert.StatisticData}
    Component Message: ${N=SwisEntity;M=ComponentAlert.ComponentMessage}
    Application Name: ${N=SwisEntity;M=Application.ApplicationAlert.ApplicationName}
    Application Status: ${N=SwisEntity;M=Application.ApplicationAlert.ApplicationAvailability}
    Node Name/Caption: ${N=SwisEntity;M=Application.Node.Caption}

Note: used in script monitors, etc.

    Node-based Custom Property: ${N=SwisEntity;M=Application.Node.CustomProperties.email}

Note: this example is for a custom property named "email" modify this value to your custom property value.   

    Parent Application Name: ${N=SwisEntity;M=Application.ApplicationAlert.ApplicationName}
    Windows Event Message: ${N=SwisEntity;M=ComponentAlert.WindowsEventMessages}
    Multi Script Component Name: ${N=SwisEntity;M=MultipleStatisticData}
    Multi Script Numeric Data: ${N=SwisEntity;M=ComponentAlert.MultiValueStatistics}
    Multi Script Message Data: ${N=SwisEntity;M=ComponentAlert.MultiValueMessages}


Application
    Application Name: ${N=SwisEntity;M=ApplicationAlert.ApplicationName}
    Application Status: ${N=SwisEntity;M=ApplicationAlert.ApplicationAvailability}
    All Components with Issues: ${N=SwisEntity;M=ApplicationAlert.ComponentsWithProblemsFormatted} 
    Components listed with status: ${N=SwisEntity;M=Application.ApplicationAlert.ComponentsWithStatus}
    Node Name/Caption: ${N=SwisEntity;M=Node.Caption}
    Node-based Custom Property: ${N=SwisEntity;M=Node.CustomProperties.email}

Note: this example is for a custom property named "email" modify this value to your custom property value.
 
Interfaces
    Interface Name: ${N=SwisEntity;M=InterfaceName} OR ${N=SwisEntity;M=Name}
    Node Name: ${N=SwisEntity;M=Node.Caption}
                         OR
                         ${N=SwisEntity;M=Node.DisplayName}
    Interface Type: ${N=SwisEntity;M=TypeName}
    Full Name (Node+Interface name): ${N=SwisEntity;M=FullName}
    Status: ${N=SwisEntity;M=Status}

Custom Node Poller (Universal Device Poller)
    Poller Unique Name: ${N=SwisEntity;M=CustomPoller.UniqueName}
    Poller Display Name: ${N=SwisEntity;M=CustomPollerStatusScalar.DisplayName}
    Poller Current Value: ${N=SwisEntity;M=CustomPollerStatusScalar.Status}
    Poller Current Numeric Value: ${N=SwisEntity;M=CustomPollerStatusScalar.RawStatus}
    Node Name: ${N=SwisEntity;M=Node.Caption} 

Custom Table Node Poller Current Status (Universal Device Poller)
    Poller Table Unique Name: ${N=SwisEntity;M=CustomPollerAssignment.CustomPoller.UniqueName}
    Poller Table Display Name: ${N=SwisEntity;M=CustomPollerAssignment.CustomPollerStatusScalar.DisplayName}
    Poller Table Current Value: ${N=SwisEntity;M=Status}
    Poller Table Current Numeric Value: ${N=SwisEntity;M=CustomPollerAssignment.CustomPollerStatusScalar.RawStatus}
    Node Name: ${N=SwisEntity;M=CustomPollerAssignment.Node.Caption} 

Hardware Health Sensor
    Sensor Name: ${N=SwisEntity;M=Name}
    Node Name: {N=SwisEntity;M=HardwareInfo.Node.DisplayName}
    Status: ${N=SwisEntity;M=HardwareCategoryStatus.StatusDescription}


If custom variables or custom mapping is needed, please see: Map integer values to text values in alert variables

See also: 
• Disk read and Disk Write latency for Virtual Machines - VM Disk Latency Alert Variables