UIM OC list of all Alarm Policy variables

Products

• DX Unified Infrastructure Management (Nimsoft / UIM)

Issue/Introduction

I want to add thresholds to the alarm policy, alarm message. What variables may I use in alarm policy messages.

 

Environment

Release : 20.4

Resolution

As of 22 May 2023, UIM 20.4CU7. Here is the official document link and the information. This url may change at any time. If it does not work, start at techdocs.broadcom.com and work your way through to the UIM docs.

https://techdocs.broadcom.com/us/en/ca-enterprise-software/it-operations-management/ca-unified-infrastructure-management-probes/GA/monitoring/infrastructure-core-components/spooler/plugin-metric.html

 

 

Supported Alarm Policy Message Variables

plugin_metric supports the following alarm policy message variables:

• ${metric_value}

   

   

  The current sample value for a metric.
• ${qos_name}

   

  The name of the QoS metric.
• ${metric_name}

   

  The name of a metric.
• ${met_id}

   

  The ID of a metric.
• ${component_name}

   

  The name of the component being monitored. For example: C:/ or CPU-0.
• ${device_name}

   

  The name of a device being monitored.
• ${device_target}

   

  The target of the QoS metric that generated an alarm.
• ${probe_name}

   

  The name of a probe; for example, cdm.
• ${threshold_type}

   

  The localized threshold type: static or dynamic %
• ${threshold_sign}

   

  Use this variable before the ${threshold} variable. The ${threshold_sign} variable generates a + (plus) sign when the threshold is a positive integer.
• ${threshold_symbol}

   

  Use this variable after the ${threshold} variable. The ${threshold_symbol} variable generates a percent symbol for dynamic percentage thresholds or a sigma symbol for dynamic standard deviation thresholds.
• ${threshold_value}

   

  For static alarms, it is the configured threshold value. For dynamic alarms, it is the calculated threshold. For example, if the threshold is 5 percent of a baseline of 10, then the evaluated threshold value is 0.5.
• ${policy_id}

   

  The ID of an alarm policy.
• ${alarm_level}

   

  The numeric severity of an alarm. The severities are displayed as: 5 (critical), 4 (major), 3 (minor), 2 (warning), 1 (information), or 0 (clear).
• ${threshold_operator}

   

  The operator that is configured with the alarm threshold. The operators are: >, >=, <, <=, ==, or !=
• ${alarm_severity}

   

  The localized alarm severity. The levels are critical (5), major (4), minor (3), warning (2), information (1), or clear (0).
• ${tot_time_window}

   

  The total window of time for which alarms are collected.
• ${tot_sliding_window}

   

  The accumulated amount of time the metric needs to be over the threshold value within the total window ($tot_time_window} before for an alarm is issued.
• ${tot_slider_window}

   

  The 'Time over' duration to calculate the time over threshold.

   
• ${tot_time_window_unit}

   

  The localized measure of time: mins, hours, days.
• ${tot_sliding_window_unit}

   

  The localized measure of time: mins, hours, days.
• ${tot_slider_window_unit}

   

  The localized measure of time in mins, hours, days for 'Time over' duration to calculate the time over threshold.

   
• ${metric_unit_short}

   

  The metric unit of metric_value in short format.
• ${metric_unit}

   

  The localized unit of measure for a metric value. For example, 50 MHz.
• ${metric_unit_long}

   

  The metric unit of metric_value in long format.
• ${metric_baseline}

   

  The computed baseline value. 

   

   We recommend that you use the metric_baseline variable for dynamic threshold conditions because baseline is calculated for dynamic alarms.
• ${origin}

   

  The origin that a probe publishes with each device. The published origin typically matches the origin of the robot where the probe is running.
• ${subsys}

   

  The subsystem ID of the message.