Share via

Msvm_FailoverIndication class

  • Article

Represents information about a failover.

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

Syntax

[Indication, AMENDMENT]
class Msvm_FailoverIndication : CIM_ProcessIndication
{
  uint8    SECURITY_DESCRIPTOR[];
  uint64   TIME_CREATED;
  string   IndicationIdentifier;
  string   CorrelatedIndications[];
  datetime IndicationTime;
  string   OtherSeverity;
  string   IndicationFilterName;
  string   SequenceContext;
  sint64   SequenceNumber;
  string   HostedElement;
  uint16   HostedElementFormat;
  string   OtherHostedElementFormat;
  string   HostingSystem;
  uint16   HostingSystemFormat;
  string   OtherHostingSystemFormat;
  string   PreviousHostingSystem;
  uint16   PreviousHostingSystemFormat;
  string   OtherPreviousHostingSystemFormat;
  uint16   FailoverType;
  string   OtherFailoverType;
  uint16   PerceivedSeverity;
  string   OtherPerceivedSeverity;
};

Members

The Msvm_FailoverIndication class has these types of members:

Properties

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

This property is inherited from CIM_Indication.

FailoverType

Data type: uint16

Access type: Read-only

The type of failover.

The possible values are:

Unknown (0)

The failover type is unknown.

Other (1)

The type is defined by the OtherFailoverType property.

Unplanned (2)

The failover resulted from the failure of the element referenced by the PreviousHostingSystem property.

HostedElement

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("Msvm_FailoverIndication.HostedElementFormat")

The identifying information of the instance that has failed over from one hosting system to another. This property contains the path of the instance, encoded as a string if the instance is modeled in the CIM Schema. If the instance is not a CIM instance, this property contains the name of the entity. The path or name is formatted according the HostedElementFormat property.

HostedElementFormat

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("Msvm_FailoverIndication.HostedElement", "Msvm_FailoverIndication.OtherHostedElementFormat")

The format of the HostedElement property.

The possible values are:

Unknown (0)

The format is unknown.

Other (1)

The format is defined by the OtherHostedElementFormat property.

CIMObjectPath (2)

This format is <ClassName>.<Prop1>="<Value1>",<Prop2>="<Value2>",....

HostingSystem

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("Msvm_FailoverIndication.HostingSystemFormat")

The identifying information of the instance that hosts the element referenced by HostedElement. This property contains the path of the instance, encoded as a string if the instance is modeled in the CIM Schema. If the instance is not a CIM instance, this property contains the name of the entity. The path or name is formatted according the HostingSystemFormat property.

HostingSystemFormat

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("Msvm_FailoverIndication.HostingSystem", "Msvm_FailoverIndication.OtherHostingSystemFormat")

The format of the PreviousHostingSystem property.

The possible values are:

Unknown (0)

The format is unknown.

Other (1)

The format is defined by the OtherHostingSystemFormat property.

CIMObjectPath (2)

This format is <ClassName>.<Prop1>="<Value1>",<Prop2>="<Value2>",....

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.

OtherFailoverType

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("Msvm_FailoverIndication.PreviousHostingSystemFormat")

A description of the value for the FailoverType property when it is set to "1" (other). For other values of FailoverType, OtherFailoverType must be set to NULL.

OtherHostedElementFormat

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("Msvm_FailoverIndication.HostedElementFormat")

A description of the value for the HostedElementFormat property when it is set to "1" (other). For other values of HostedElementFormat, OtherHostedElementFormat must be set to NULL.

OtherHostingSystemFormat

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("Msvm_FailoverIndication.HostingSystemFormat")

A description of the value for the HostingSystemFormat property when it is set to "1" (other). For other values of HostingSystemFormat, OtherHostingSystemFormat must be set to NULL.

OtherPerceivedSeverity

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("Msvm_FailoverIndication.PerceivedSeverity")

A description of the value for the PerceivedSeverity property when it is set to "1" (other). For other values of PerceivedSeverity, OtherPerceivedSeverity must be set to NULL.

OtherPreviousHostingSystemFormat

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("Msvm_FailoverIndication.PreviousHostingSystemFormat")

A description of the value for the PreviousHostingSystemFormat property when it is set to "1" (other). For other values of PreviousHostingSystemFormat, OtherPreviousHostingSystemFormat must be set to NULL.

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.

PerceivedSeverity

Data type: uint16

Access type: Read-only

Qualifiers: Required, Override ("PerceivedSeverity")

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

The possible values are:

Unknown (0)

Other (1)

Information (2)

Degraded/Warning (3)

Minor (4)

Major (5)

Critical (6)

Fatal/NonRecoverable (7)

PreviousHostingSystem

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("Msvm_FailoverIndication.HostingSystemFormat")

The identifying information of the instance that hosts the element referenced by HostedElement. This property contains the path of the instance, encoded as a string if the instance is modeled in the CIM Schema. If the instance is not a CIM instance, this property contains the name of the entity. The path or name is formatted according the PreviousHostingSystemFormat property.

PreviousHostingSystemFormat

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("Msvm_FailoverIndication.PreviousHostingSystem", "Msvm_FailoverIndication.OtherPreviousHostingSystemFormat")

The format of the PreviousHostingSystem property.

The possible values are:

Unknown (0)

The format is unknown.

Other (1)

The format is defined by the OtherPreviousHostingSystemFormat property.

CIMObjectPath (2)

This format is <ClassName>.<Prop1>="<Value1>",<Prop2>="<Value2>",....

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

This property is inherited from CIM_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.

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

CIM_ProcessIndication

Failover Clustering Hyper-V WMI Provider