When creating and editing alerts, set the custom Trigger Message and Clear Message to include any custom variables you’d like to receive in your notifications. The Trigger Message will appear in the initial alert trigger notifications and the Clear Message will appear in the alert clear notifications.

You can craft these trigger and clear messages to be similar in nature, or they can contain completely different information depending on what you want to see. You are not limited by the type of trigger conditions in your alert as to what variables you can use in your message. For example, if your trigger conditions are around memory utilization, you can refer to the CPU utilization, device serial number, or the firmware version if desired.

Currently, we can only specify Collector, Device & VMware properties in the Trigger/Clear Message. Interface, Service & other properties will be available before Commercial Availability.

Examples

Trigger Message

Let’s use the device’s name, vendor and model in the trigger message to say the device has gone offline.

“The device $system.hostname ($system.vendor/$system.model) has gone offline.”

Let’s use the device’s name and serial number in the trigger message, along with the last update time of the memory, to say the device has exceeded the target memory utilization. We’ll also throw in the device’s current memory, CPU and storage values for more context.

“Device $system.hostname (SN - $system.serialNo) has exceeded 80% memory utilization as of $deviceWithStats.memory.lastUpdated (Memory/CPU/Storge: $deviceWithStats.memory.totalUtilizationAvg5Min / $deviceWithStats.cpu.totalUtilizationAvg5Min / $deviceWithStats.storage.totalUtilizationAvg5Min)“

Clear Message

Let’s use the device’s name, vendor and model in the clear message to say the device is now online.

“The device $system.hostname ($system.vendor/$system.model) is now online.”

Let’s use the last update time of the memory and the device’s name and serial number to say the device’s memory utilization has returned to normal.

“As of $deviceWithStats.memory.lastUpdated, the device $system.hostname (SN - $system.serialNo) has returned to normal memory utilization.“

How to enter variables

When you add a variable to an trigger message or clear message, you must enter it exactly as shown below including the '$'. If you enter the variable without the dollar sign, for example, you’ll receive the plain text of the variable (e.g., “system.operStatus”) rather than the appropriate dynamic value (e.g. “online”) in your alert notification.

Collector

Variable Values	Description
`$collector.uuid`	Identifier of the collector.
`$collector.hostname`	hostname of the collector.
`$collector.connectionState`	Current connection state of the collector
`$collector.approvalState`	Current approval state of the collector.
`$collector.buildVersion`	Software build version of the collector.
`$collector.collectorType`	Type of the collector.
`$collector.osVersion`	OS version that the collector is running on.
`$collector.publicIPAddress`	The public IP address of the collector.
`$collector.privateIPAddress`	The private IP address of the collector.

Device

Variable Values	Description
`$system.name`	The name of the device.
`$system.serialNo`	Serial number of the system.
`$system.vendor`	The manufacturer of the device.
`$system.model`	The model of the device.
`$system.deviceClass`	The deviceClass of the device.
`$system.operStatus`	The current operational status of the entity.
`$system.description`	A description of the system.
`$system.firmwareVersion`	The version of firmware or BIOS running on the system.
`$system.softwareVersion`	The version of the operating system or other system software.
`$previousFirmwareVersion`	The previous version of the firmware or BIOS running on the system.
`$previousSoftwareVersion`	The previous version of the operating system or other system software.
`$deviceWithStats.cpu.totalUtilizationAvg5Min`	The total utilization of CPUs aggregated over 5mn.
`$deviceWithStats.cpu.lastUpdated`	This timestamp indicates the time we last received the device CPU stats.
`$deviceWithStats.memory.totalUtilizationAvg5Min`	The total utilization of memory aggregated over 5mn.
`$deviceWithStats.memory.lastUpdated`	The timestamp indicates the time we last received the memory stats.
`$deviceWithStats.storage.totalUtilizationAvg5Min`	The total utilization of storage aggregated over 5mn.
`$deviceWithStats.storage.lastUpdated`	The timestamp indicates the time we last received the storage stats.
`$icmpDescription`	This is based on the ICMP response code and will determine if the host is unavailable or unreachable.
$uptimeDurationDays	This is the uptime for a device in days.
$vpnClientConnections.currentSessionUtilization	This is the current session utilization of client VPN connections.
$vpnClientConnections.currentAvailableSessions	The number of VPN available sessions for a client.
$vpnClientConnections.currentConnectionCount	The current VPN connection count for a client.
$printer.outputTrayMissing	The printer output tray is missing.
$printer.inputTrayMissing	The printer input tray is missing.
$printer.jammed	The printer is jammed.
$printer.lowPaper	The printer is low on paper.
$printer.outOfPaper	The printer is out of paper.
$ups.status	This is the current status of the UPS.
$ups.capacity	This is the capacity of the UPS.
$ups.replaceIndicator	This indicates if the UPS needs to be replaced.
$ups.actualVoltage	This indicates the actual voltage of the UPS.
$ups.inputLineVoltage	This indicates the input line voltage of the UPS.
$ups.outputVoltage	This indicates the output voltage of the UPS.
$ups.currentLineFailCause	This indicates the cause of the current line failure of the UPS.
$monitors.cloudpingcheck.name	This indicates the name of the device that the cloud ping check is checking.
$monitors.cloudpingcheck.ipaddress	This is the ip address of the device that the cloud ping check is checking.
$monitors.monitorstatus.serviceOnlinestatus	This indicates the status of the service being monitored (on/off).

VMware

Variable Values	Description
`$relationships.toVirtualMachines`	A list of objects - requires subitems handling to use it.
`$virtualMachine.vmData.maximumMemory`	The maximum memory used of a virtual machine.
`$virtualMachine.vmData.minimumMemory`	The minimum memory used of a virtual machine.
`$virtualMachine.vmData.startUpMemory`	The memory usage at startup of a virtual machine.
`$virtualMachine.vmData.allocatedMemory`	The memory allocated for the virtual machine.
`$virtualMachine.vmData.connectionStatus`	The virtual machine connection status.
`$virtualMachine.vmData.snapshotCount`	The number of snapshots for the virtual machine.
`$virtualMachine.vmData.lastSnapshot`	The timestamp the last snapshot was taken at.
`$virtualMachine.vmData.lastSnapshotAgeInDays`	Age of the Last Snapshot (in Days).
`$virtualMachine.vmData.powerStatus`	The power status of the virtual machine: online, offline.
`$virtualMachine.vmData.snapshotSizeGB`	The size of the latest snapshot (in Gigabytes).
`$virtualMachine.vmData.lastSnapshotSizeGB`	The size of the snapshot previously taken (in Gigabytes).
`$virtualMachine.vmData.vCpu`	The virtual CPU usage.
`$virtualMachine.vmData.vDisk`	The virtual Disk usage.
`$virtualMachine.vmData.vDiskCapacity`	The virtual Disk capacity.

How can we help?

Alerting 2.0: Notification Variables

Examples

Trigger Message

Clear Message

How to enter variables

Collector

Device

VMware

Auvik System Status

Need help?

How can we help?

Examples

Trigger Message

Clear Message

How to enter variables

Collector

Device

VMware

Auvik System Status

Need help?

Related articles