Msvm_HeartbeatComponent class

Article
05/31/2018

Represents the state of the heartbeat service, which is responsible for monitoring the state of a virtual machine by reporting a heartbeat at regular intervals.

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

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_HeartbeatComponent : CIM_LogicalDevice
{
  string   Caption = "Heartbeat";
  string   Description = "Microsoft Heartbeat Service";
  string   ElementName = "Heartbeat";
  string   Name = "Heartbeat";
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState = 5;
  uint16   EnabledState;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 7;
  datetime TimeOfLastStateChange;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_HeartbeatComponent";
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  uint64   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[] = 6;
  uint64   MaxQuiesceTime;
  uint16   LocationIndicator = 4;
  datetime InstallDate;
  string   DeviceID = "Microsoft:VMGUID\GUID";
  boolean  ErrorCleared;
  string   OtherIdentifyingInfo[];
  uint64   PowerOnHours;
};

Members

The Msvm_HeartbeatComponent class has these types of members:

Methods
Properties

Methods

The Msvm_HeartbeatComponent class has these methods.

Method	Description
EnableDevice	This method is not supported.
OnlineDevice	This method is not supported.
QuiesceDevice	This method is not supported.
RequestStateChange	This method is not supported.
Reset	This method is not supported.
RestoreProperties	This method is not supported.
SaveProperties	This method is not supported.
SetPowerState	This method is not supported.

Properties

The Msvm_HeartbeatComponent class has these properties.

AdditionalAvailability

Data type: uint16 array
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_LogicalDevice.Availability")

Any additional availability and status of the device. This property is inherited from CIM_LogicalDevice and is always set to 6 (Not Applicable).

Availability

Data type: uint16
Access type: Read-only
Qualifiers: Deprecated ("CIM_AssociatedPowerManagementService.PowerState", "CIM_ManagedSystemElement.OperationalStatus", "CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus", "MIF.DMTF|Host Device|001.5"), ModelCorrespondence ("CIM_LogicalDevice.AdditionalAvailability")

The primary availability and status of the device. This property is inherited from CIM_LogicalDevice but is not used.

Caption

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

A short textual description (one- line string) of the object. This property is inherited from CIM_ManagedElement and is always set to "Heartbeat".

CreationClassName

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

The scoping system's creation class name. This property is inherited from CIM_LogicalDevice and is always set to "Msvm_HeartbeatComponent".

Description

Data type: string
Access type: Read-only

A textual description of the object. This property is inherited from CIM_ManagedElement and is always set to "Microsoft Heartbeat Service".

DeviceID

Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (64)

An address or other identifying information to uniquely name the logical device. This property is inherited from CIM_LogicalDevice and is always set to "Microsoft:VMGUID\GUID" where VMGUID is the Name property of the Msvm_ComputerSystem associated with this device.

ElementName

Data type: string
Access type: Read-only

A user-friendly name for the object. This property is inherited from CIM_ManagedElement and it is set to "Heartbeat".

EnabledDefault

Data type: uint16
Access type: Read/write

This property is inherited from CIM_EnabledLogicalElement and is always set to 7 (No Default).

EnabledState

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")

The enabled and disabled states of an element. This property is inherited from CIM_EnabledLogicalElement and is either set to 2 (Enabled) or 3 (Disabled).

The possible values are.

Enabled (2)

Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.

Disabled (3)

Indicates that the element does not execute commands and that it drops any new requests.

ErrorCleared

Data type: boolean
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus")

Indicates whether the error reported in LastErrorCode is now cleared. This property is inherited from CIM_LogicalDevice but is not used.

ErrorDescription

Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_DeviceErrorData.ErrorDescription")

A free-form string that provides more information about the error recorded in LastErrorCode, and information on any corrective actions that may be taken. This property is inherited from CIM_LogicalDevice but is not used.

HealthState

Data type: uint16
Access type: Read-only

The current health of the element. This property is inherited from CIM_ManagedSystemElement and is always set to 5 (OK).

OK (5)

The element is fully functional and operates within normal operational parameters and without error.

IdentifyingDescriptions

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.OtherIdentifyingInfo")

An array of free-form strings that provide explanations and details behind the entries in the OtherIdentifyingInfo property array. This property is inherited from CIM_LogicalDevice but is not used.

InstallDate

Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

The date and time that the integration service was installed into the virtual system. This property is inherited from CIM_ManagedSystemElement.

LastErrorCode

Data type: uint32
Access type: Read-only
Qualifiers: Deprecated ("CIM_DeviceErrorData.LastErrorCode")

The last error code reported by the logical device. This property is inherited from CIM_LogicalDevice but is not used.

LocationIndicator

Data type: uint16
Access type: Read/write
Qualifiers: Experimental, ModelCorrespondence ("CIM_AlarmDevice.AlarmState", "CIM_AlarmDevice.AudioIndicatorIsDisabled", "CIM_AlarmDevice.VisualIndicatorIsDisabled", "CIM_AlarmDevice.MotionIndicatorIsDisabled")

The state of an indicator that is part of a device. This property is inherited from CIM_LogicalDevice and it is always set to 4 (Not Supported).

MaxQuiesceTime

Data type: uint64
Access type: Read-only
Qualifiers: Deprecated ("No value"), Units ("MilliSeconds")

This property is inherited from CIM_LogicalDevice but is not used.

Name

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

The label by which the object is known. This property is inherited from CIM_ManagedSystemElement and is always set to "Heartbeat".

OperationalStatus

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

The current status of the element. This property is inherited from CIM_ManagedSystemElement.

Windows Server 2008: The OperationalStatus[0] property is always set to 2 (OK).

OK (2)

The service is operating normally. The OperationalStatus[1] and StatusDescriptions[1] property values may contain more information.

Degraded (3)

The service is operating normally but the guest service negotiated a compatible communications protocol version. The OperationalStatus[1] and StatusDescriptions[1] property values may contain more information.

Non-Recoverable Error (7)

The guest does not support a compatible protocol version. The OperationalStatus[1] and StatusDescriptions[1] property values may contain more information.

No Contact (12)

The guest service is not installed or has not yet been contacted.

Lost Communication (13)

The guest service is no longer responding normally.

OtherEnabledState

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 (Other). This property must be set to NULL when the EnabledState property is any value other than 1. This property is inherited from CIM_EnabledLogicalElement and is always set to NULL.

OtherIdentifyingInfo

Data type: string array
Access type: Read-only
Qualifiers: MaxLen (256), ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.IdentifyingDescriptions")

Any additional data, beyond device ID information, that could be used to identify a logical device. This property is inherited from CIM_LogicalDevice and is always set to NULL.

PowerManagementCapabilities

Data type: uint16 array
Access type: Read-only
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities")

The power management capabilities of the device. This property is inherited from CIM_LogicalDevice but is not used.

PowerManagementSupported

Data type: boolean
Access type: Read-only
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities")

Indicates whether the device can be power managed. This property is inherited from CIM_LogicalDevice but is not used.

PowerOnHours

Data type: uint64
Access type: Read-only
Qualifiers: Deprecated ("CIM_PoweredStatisticalData.PowerOnHours"), Units ("Hours"), Counter

The number of consecutive hours that this device has been powered on, since its last power cycle. This property is inherited from CIM_LogicalDevice but is not used.

RequestedState

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

The last requested or desired state for the element. This property is inherited from CIM_EnabledLogicalElement and is always set to 12 (Not Applicable).

Not Applicable (12)

Indicates that this instance does not support the RequestedState property.

Status

Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

The current status of the object. This property is inherited from CIM_ManagedSystemElement but is not used.

StatusDescriptions

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement.

Windows Server 2008: The OperationalStatus[0] property value is always set to "OK" before Windows Server 2008 R2.

StatusInfo

Data type: uint16
Access type: Read-only
Qualifiers: Deprecated ("CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.4")

The current state the logical device. This property is inherited from CIM_LogicalDevice but is not used.

SystemCreationClassName

Data type: string
Access type: Read-only
Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)

The scoping system's creation class name. This property is inherited from CIM_LogicalDevice and is always set to "Msvm_ComputerSystem".

SystemName

Data type: string
Access type: Read-only
Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)

The scoping system's name. This property is inherited from CIM_LogicalDevice and is the Name of the Msvm_ComputerSystem associated with this heartbeat service.

TimeOfLastStateChange

Data type: datetime
Access type: Read-only

The date or time when the enabled state of the element last changed. This property is inherited from CIM_EnabledLogicalElement and is always set to NULL.

TotalPowerOnHours

Data type: uint64
Access type: Read-only
Qualifiers: Deprecated ("CIM_PoweredStatisticalData.TotalPowerOnHours"), Units ("Hours"), Counter

The total number of hours that this device has been powered. This property is inherited from CIM_LogicalDevice but is not used.

Remarks

Access to the Msvm_HeartbeatComponent class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2008
End of client support	None supported
End of server support	Windows Server 2012 R2
Namespace	Root\Virtualization
MOF	WindowsVirtualization.mof