CIM_AlertIndication class

Article
05/31/2018

A concrete superclass for CIM alert notifications. CIM_AlertIndication is a specialized type of CIM_Indication class that contains information about the severity, cause, recommended actions, and other data for a real world event. This event and its data may or may not be modeled in the CIM class hierarchy.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Indication, Version("2.22.0"), UMLPackagePath("CIM::Event")]
class CIM_AlertIndication : CIM_ProcessIndication
{
  uint8    SECURITY_DESCRIPTOR[];
  uint64   TIME_CREATED;
  string   IndicationIdentifier;
  string   CorrelatedIndications[];
  datetime IndicationTime;
  string   OtherSeverity;
  string   IndicationFilterName;
  string   SequenceContext;
  sint64   SequenceNumber;
  string   Description;
  string   AlertingManagedElement;
  uint16   AlertingElementFormat;
  string   OtherAlertingElementFormat;
  uint16   AlertType;
  string   OtherAlertType;
  uint16   PerceivedSeverity;
  uint16   ProbableCause;
  string   ProbableCauseDescription;
  uint16   Trending;
  string   RecommendedActions[];
  string   EventID;
  datetime EventTime;
  string   SystemCreationClassName;
  string   SystemName;
  string   ProviderName;
  string   Message;
  string   MessageArguments[];
  string   MessageID;
  string   OwningEntity;
};

Members

The CIM_AlertIndication class has these types of members:

Properties

Properties

The CIM_AlertIndication class has these properties.

AlertingElementFormat

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_AlertIndication.AlertingManagedElement", "CIM_AlertIndication.OtherAlertingElementFormat")

The format of the AlertingManagedElement property.

Unknown (0)

The format is unknown.

Other (1)

The format is defined by the value of the OtherAlertingElementFormat property.

CIMObjectPath (2)

A CIMObjectPath, with the format: <NamespacePath>:<ClassName>.<Prop1>="<Value1>", <Prop2>="<Value2>", . . . an instance in the CIM Schema.

AlertingManagedElement

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_AlertIndication.AlertingElementFormat")

The identifying information of the entity (ie, the instance) for which this Indication is generated. The property contains the path of an instance, encoded as a string parameter - if the instance is modeled in the CIM Schema. If not a CIM instance, the property contains some identifying string that names the entity for which the Alert is generated. The path or identifying string is formatted per the AlertingElementFormat property.

AlertType

Data type: uint16
Access type: Read-only
Qualifiers: Required, MappingStrings ("Recommendation.ITU|X733.Event type")

The primary classification of the indication.

Other (1)

Communications Alert (2)

Quality of Service Alert (3)

Processing Error (4)

Device Alert (5)

Environmental Alert (6)

Model Change (7)

Security Alert (8)

CorrelatedIndications

Data type: string array
Access type: Read-only
Qualifiers: MappingStrings ("Recommendation.ITU|X733.Correlated notifications"), ModelCorrespondence ("CIM_Indication.IndicationIdentifier")

A array that contains IndicationIdentifier values of notifications that are related this one.

This property is inherited from CIM_Indication.

Description

Data type: string
Access type: Read-only
Qualifiers: MappingStrings ("Recommendation.ITU|X733.Additional text")

A short description of the Indication.

EventID

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_AlertIndication.ProbableCause")

An instrumentation or provider specific value that describes the underlying real-world event represented by the indication. Indications with the same non-NULL EventID value are considered, by the creating entity, to represent the same event. The comparison of two EventID values is only defined for alert indications with identical, non-NULL values of SystemCreateClassName, SystemName and ProviderName properties.

EventTime

Data type: datetime
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_AlertIndication.ProbableCause")

The time and date that indicates when the underlying event was first detected. If this values is specified and the creating entity is not capable of providing this information, this property must be set to NULL. This value is based on the notion of the local date and time of the CIM_ManageSystemElement object that generated the indication.

IndicationFilterName

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_IndicationFilter.Name")

The identifier of the indication filter that processes the indication. The sending service sets this property. This property correlates with the Name property of the CIM_IndicationFilter object. The value of IndicationFilterName should use the following format:

<OrgID>:<LocalID>
<OrgID> must include a copyrighted, trademarked, or unique name that is owned by the business entity that owns the object.
<OrgID> must not contain a colon (:)
<LocalID> a unique identifier chosen by the business entity that owns the object.

This property is inherited from CIM_Indication.

IndicationIdentifier

Data type: string
Access type: Read-only
Qualifiers: MappingStrings ("Recommendation.ITU|X733.Notification identifier")

An identifier of the indication. This property can be used as a key value in the CorrelatedIndications property array. Therefore, IndicationIdentifier should be a unique value within the namespace of this class instance.

To ensure that IndicationIdentifier is unique, it should use the following format:

<OrgID>:<LocalID>
<OrgID> must include a copyrighted, trademarked, or unique name that is owned by the business entity that owns the object.
<OrgID> must not contain a colon (:)
<LocalID> a unique identifier chosen by the business entity that owns the object.
For DMTF-defined instances, <OrgID> should be set to "CIM".

This property is inherited from CIM_Indication.

IndicationTime

Data type: datetime
Access type: Read-only

The time and date when the indication was created. The property can be set to NULL if the entity that created the indication is not capable of determining this information.

Note

The IndicationTime value can be the same for indications that are generated in rapid succession.

This property is inherited from CIM_Indication.

Message

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_AlertIndication.MessageID", "CIM_AlertIndication.MessageArguments")

The formatted message for the alert indication. This message is formatted by combining one or more of the dynamic elements specified in the MessageArguments property, and with the static elements uniquely identified by the MessageID property.

MessageArguments

Data type: string array
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_AlertIndication.Message", "CIM_AlertIndication.MessageID")

An array that contains the dynamic content of the message for the alert indication.

MessageID

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_AlertIndication.Message", "CIM_AlertIndication.MessageArguments")

The unique ID of the message format, withing the scope of the organization specified in OwningEntity.

OtherAlertingElementFormat

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_AlertIndication.AlertingElementFormat")

Defines the format of the AlertingManagedElement property when the AlertingElementFormat property is set to "1" (other); otherwise, this value must be set to NULL.

OtherAlertType

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_AlertIndication.AlertType")

A string that describes the AlertType value when the AlertType property is set to "1" (Other State Change).

OtherSeverity

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_AlertIndication.PerceivedSeverity")

The severity of the indication from the notifier's point of view when PerceivedSeverity is set to "1" (Other).

This property is inherited from CIM_Indication.

OwningEntity

Data type: string
Access type: Read-only

The unique ID of the organization that owns the definition of the format of theMessage property. OwningEntity must include a copyrighted, trademarked, or unique name that is owned by the business entity or standards body that defined the message format.

PerceivedSeverity

Data type: uint16
Access type: Read-only
Qualifiers: Required, Override ("PerceivedSeverity"), MappingStrings ("Recommendation.ITU|X733.Perceived severity")

The severity of the alert indication from the point of view of the element that raised the alert.

Unknown (0)

Other (1)

Information (2)

Degraded/Warning (3)

Minor (4)

Major (5)

Critical (6)

"Critical"

Fatal/NonRecoverable (7)

ProbableCause

Data type: uint16
Access type: Read-only
Qualifiers: Required, MappingStrings ("Recommendation.ITU|X733.Probable cause", "Recommendation.ITU|M3100.probableCause", "ITU-IANA-ALARM-TC"), ModelCorrespondence ("CIM_AlertIndication.ProbableCauseDescription", "CIM_AlertIndication.EventID", "CIM_AlertIndication.EventTime")

The probable cause of the situation which resulted in the alert indication.

Unknown (0)

Other (1)

Adapter/Card Error (2)

Application Subsystem Failure (3)

Bandwidth Reduced (4)

Connection Establishment Error (5)

Communications Protocol Error (6)

Communications Subsystem Failure (7)

Configuration/Customization Error (8)

Congestion (9)

Corrupt Data (10)

CPU Cycles Limit Exceeded (11)

Dataset/Modem Error (12)

Degraded Signal (13)

DTE-DCE Interface Error (14)

Enclosure Door Open (15)

Equipment Malfunction (16)

Excessive Vibration (17)

File Format Error (18)

Fire Detected (19)

Flood Detected (20)

Framing Error (21)

HVAC Problem (22)

Humidity Unacceptable (23)

I/O Device Error (24)

Input Device Error (25)

LAN Error (26)

Non-Toxic Leak Detected (27)

Local Node Transmission Error (28)

Loss of Frame (29)

Loss of Signal (30)

Material Supply Exhausted (31)

Multiplexer Problem (32)

Out of Memory (33)

Output Device Error (34)

Performance Degraded (35)

Power Problem (36)

Pressure Unacceptable (37)

Processor Problem (Internal Machine Error) (38)

Pump Failure (39)

Queue Size Exceeded (40)

Receive Failure (41)

Receiver Failure (42)

Remote Node Transmission Error (43)

Resource at or Nearing Capacity (44)

Response Time Excessive (45)

Retransmission Rate Excessive (46)

Software Error (47)

Software Program Abnormally Terminated (48)

Software Program Error (Incorrect Results) (49)

Storage Capacity Problem (50)

Temperature Unacceptable (51)

Threshold Crossed (52)

Timing Problem (53)

Toxic Leak Detected (54)

Transmit Failure (55)

Transmitter Failure (56)

Underlying Resource Unavailable (57)

Version MisMatch (58)

Previous Alert Cleared (59)

Login Attempts Failed (60)

Software Virus Detected (61)

Hardware Security Breached (62)

Denial of Service Detected (63)

Security Credential MisMatch (64)

Unauthorized Access (65)

Alarm Received (66)

Loss of Pointer (67)

Payload Mismatch (68)

Transmission Error (69)

Excessive Error Rate (70)

Trace Problem (71)

Element Unavailable (72)

Element Missing (73)

Loss of Multi Frame (74)

Broadcast Channel Failure (75)

Invalid Message Received (76)

Routing Failure (77)

Backplane Failure (78)

Identifier Duplication (79)

Protection Path Failure (80)

Sync Loss or Mismatch (81)

Terminal Problem (82)

Real Time Clock Failure (83)

Antenna Failure (84)

Battery Charging Failure (85)

Disk Failure (86)

Frequency Hopping Failure (87)

Loss of Redundancy (88)

Power Supply Failure (89)

Signal Quality Problem (90)

Battery Discharging (91)

Battery Failure (92)

Commercial Power Problem (93)

Fan Failure (94)

Engine Failure (95)

Sensor Failure (96)

Fuse Failure (97)

Generator Failure (98)

Low Battery (99)

Low Fuel (100)

Low Water (101)

Explosive Gas (102)

High Winds (103)

Ice Buildup (104)

Smoke (105)

Memory Mismatch (106)

Out of CPU Cycles (107)

Software Environment Problem (108)

Software Download Failure (109)

Element Reinitialized (110)

Timeout (111)

Logging Problems (112)

Leak Detected (113)

Protection Mechanism Failure (114)

Protecting Resource Failure (115)

Database Inconsistency (116)

Authentication Failure (117)

Breach of Confidentiality (118)

Cable Tamper (119)

Delayed Information (120)

Duplicate Information (121)

Information Missing (122)

Information Modification (123)

Information Out of Sequence (124)

Key Expired (125)

Non-Repudiation Failure (126)

Out of Hours Activity (127)

Out of Service (128)

Procedural Error (129)

Unexpected Information (130)

ProbableCauseDescription

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_AlertIndication.ProbableCause")

Additional information related to the ProbableCause property.

ProviderName

Data type: string
Access type: Read-only
Qualifiers: MaxLen (256)

The name of the provider that generated the indication.

RecommendedActions

Data type: string array
Access type: Read-only
Qualifiers: MappingStrings ("Recommendation.ITU|X733.Proposed repair actions")

Free form descriptions of the recommended actions to take to resolve the cause of the notification.

SECURITY_DESCRIPTOR

Data type: uint8 array
Access type: Read-only

Descriptor used by the event provider to determine which users can receive the event. This property is inherited from __Event. For more information about constants used to set this security descriptor, see WMI Security Constants.

SequenceContext

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_Indication.SequenceNumber")

The sequence context of the sequence identifier for the indication. If a service does not support sequence identifiers for indications, this property should be set to NULL. If the indication is redelivered, this property remains the same.

Note

The sequence identifier for the indication enables a listener to identify duplicate indications when the service attempts to redeliver indications, reorder indications that arrive out of order, and detect lost indications.

To ensure that SequenceContext is unique, it should use the following format:

indication-service-name#cim-service-start-id #listener-destination-creation-time
indication-service-name is the value of the Name property of the CIM_IndicationService instance that delivers the indication.
cim-service-start-id is an identifier that uniquely identifies the start operation of a service. For example, this could be a timestamp of the start time, or a counter that increases for each start or restart of the service.
listener-destination-creation-time is a timestamp of the creation time of the CIM_ListenerDestination instance representing the listener destination.nSince this format is only a recommendation, CIM clients shall treat the value as an opaque identifier for the sequence context and shall not rely on this format.

This property is inherited from CIM_Indication.

SequenceNumber

Data type: sint64
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_Indication.SequenceContext")

The sequence number of the sequence identifier for the indication.

Note

The sequence number has the following characteristics:

The sequence number is reset to "0" whenever the SequenceContext value changes.
Whenever the listener destination receives a new indication, the sequence number is increased by "1".
The sequence number wraps to "0" when the value range is exceeded.
If the indication is redelivered, the SequenceNumber remains the same.

This property is inherited from CIM_Indication.

SystemCreationClassName

Data type: string
Access type: Read-only
Qualifiers: MaxLen (256)

The CreationClassName value of the scoping system for the provider that generated the indication.

SystemName

Data type: string
Access type: Read-only
Qualifiers: MaxLen (256)

The scoping system name for the provider that generated the indication.

TIME_CREATED

Data type: uint64
Access type: Read-only

Unique value that indicates the time at which the event was generated. This is a 64-bit value that represents the number of 100-nanosecond intervals after January 1, 1601. The information is in the Coordinated Universal Times (UTC) format. This property is inherited from __Event.

For more information about using uint64 values in scripts, see Scripting in WMI.

Trending

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("Recommendation.ITU|X733.TrendIndication")

Provides information on trending - trending up, down or no change.

Unknown (0)

Not Applicable (1)

Trending Up (2)

Trending Down (3)

No Change (4)

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2016
Namespace	Root\HyperVCluster\v2
MOF	WindowsHyperVCluster.V2.mof
DLL	VMMS.exe

CIM_AlertIndication class

Syntax

Members

Properties

Requirements

See also

Additional resources