Share via

CIM_Indication class

  • Article

CIM_Indication is the abstract base class for all notifications about changes in schema objects, and schema object data, events detected by providers and instrumentation. Subclasses of CIM_Indication represent specific types of notifications.

To receive an indication, a subscriber must create the following instances for the notification:

  • CIM_IndicationFilter
  • CIM_ListenerDestination
  • CIM_IndicationSubscription

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

[Indication, Version("2.24.0"), UMLPackagePath("CIM::Event"), AMENDMENT]
class CIM_Indication : __ExtrinsicEvent
{
  uint8    SECURITY_DESCRIPTOR[];
  uint64   TIME_CREATED;
  string   IndicationIdentifier;
  string   CorrelatedIndications[];
  datetime IndicationTime;
  uint16   PerceivedSeverity;
  string   OtherSeverity;
  string   IndicationFilterName;
  string   SequenceContext;
  sint64   SequenceNumber;
};

Members

The CIM_Indication class has these types of members:

Properties

The CIM_Indication class has these properties.

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.

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.

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".

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.

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).

PerceivedSeverity

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("Recommendation.ITU|X733.Perceived severity")

The severity of the indication from the notifier's point of view.

Unknown (0)

The severity is unknown.

Other (1)

The OtherSeverity property indicates the severity.

Information (2)

The indication is only informational.

Degraded/Warning (3)

The user should decide if action is needed.

Minor (4)

Action is needed, but the situation is not serious at this time.

Major (5)

Immediate action is needed.

Critical (6)

Immediate action is needed, otherwise a critical resource may shut down.

Fatal/NonRecoverable (7)

An error occurred, but it's too late to take remedial action.

DMTF Reserved

Reserved

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.

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 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.

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.

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.

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

See also

__ExtrinsicEvent

Failover Clustering Hyper-V WMI Provider