This documentation supports the releases of BMC Helix Operations Management up to December 31, 2021.

To view the documentation for the latest version, select 23.1 from the Product version picker.

Alarm event class

The Alarm (or ALARM) event class is a subclass of the base Event class.

This class represents slots for Alarm events that have a severity of Critical, Major, or Minor.

Hidden slots

The hidden slots are internal slots that must not be changed.

To understand the list of slots that are used to determine duplicate events, see Slot facets.

Slot nameSlot display nameTypeDescriptionHidden?
al_alarm_idAlarm IDStringInternal ID for an alarm.No
al_end_time

End Time

Date (Epoch milliseconds)

Time when the alarm gets closed automatically.

Yes
al_highest_severity

Alarm Highest Severity

SeverityHighest severity of the event.Yes
al_last_time

Last Time

Date (Epoch milliseconds)

Timestamp of the last data point that triggered the alarm.

Yes
al_old_severityAlarm Old SeveritySeverityOld severity of the event.Yes
al_parameter_thresholdParameter ThresholdString

Threshold value that was crossed to cause generation of the event.

No
al_parameter_nameMetricString

Name of the metric or property that went into the alarm or that triggered the event.

No
al_parameter_unit

Parameter Unit

String

Unit description of the metric.

No

al_parameter_value

Parameter Value

String

Actual value of the parameter.

No
al_thresh_above

Threshold Above

Boolean

Indicates whether the threshold is configured with a greater than condition. If the greater than condition is selected, the value of this slot is set to true, otherwise it is set to false.

Example: Suppose you configured to raise an alarm when CPU utilization is greater than 75%. In this scenario, the value of this slot is set to true.

Yes
al_thresh_durationThreshold DurationInteger

Violation duration (in minutes) that data points must meet before the event is created.

Yes
al_thresh_id

Threshold ID

String

System generated unique ID for a threshold object. It is a combination of the monitor type, monitor type ID, monitor instance name, attribute (or metric) ID, severity, and tenant name.

Example: NUK_FileSystem:nuk:FreeInodes:Major:HP

Yes
al_thresh_typeThreshold TypeStringIndicates that the threshold is user defined.Yes
objectObjectStringSub-component of the host to which the event is related.
For example, it could be the name of the disk on which the event is reporting the problem.
No
object_classObject ClassStringIdentifies the class of an object. If the object class cannot be derived from the original event, it must be filled in during enrichment.No
object_idObject IDString

It is a combination of Agent guid, Monitor type, and Instance name.

No
al_agent_nameAgent NameString

Name of the agent.

No
al_agent_portAgent PortStringAgent port number.No
al_agent_os

Agent OS

StringOperating system of the agent.No
al_device_ipaddressAgent IPAddressStringIP address of the agent device.Yes
incident_category

Incident Category

StringCategory of the related incident event.No
incident_typeIncident TypeStringType of the related incident event.No
incident_itemIncident ItemStringItem attribute of the related incident event.No
incident_operational_category1Incident Operational Category1String

Operational Categorization 1 value for the specified event. The same gets populated into Op cat 1 for the incident.

No
incident_operational_category2

Incident Operational Category2

StringOperational Categorization 2 value for the specified event. The same gets populated into Op cat 2 for the incident.No
incident_operational_category3

Incident Operational Category3

StringOperational Categorization 3 value for the specified event. The same gets populated into Op cat 3 for the incident.No
cross_launch_uri

Cross Launch URI

StringAddress used to cross-launch directly to the component.No

Was this page helpful? Yes No Submitting... Thank you

Comments