Msvm_HeartbeatComponentSettingData class
Represents the configured state of the heartbeat service.
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_HeartbeatComponentSettingData : CIM_ResourceAllocationSettingData
{
string InstanceID = "Microsoft:GUID\DeviceSpecificData";
string Caption = "Heartbeat";
string Description = "Microsoft Heartbeat Service Setting Data";
string ElementName = "Heartbeat";
uint16 ResourceType = 1;
string OtherResourceType = "Microsoft Heartbeat Component";
string ResourceSubType;
string PoolID;
uint16 ConsumerVisibility = 3;
string HostResource[];
string AllocationUnits = "Integration Components";
uint64 VirtualQuantity = 1;
uint64 Reservation = 1;
uint64 Limit = 1;
uint32 Weight = 0;
boolean AutomaticAllocation = True;
boolean AutomaticDeallocation = True;
string Parent;
string Connection[];
string Address;
uint16 MappingBehavior;
string AddressOnParent;
string VirtualQuantityUnits = "count";
uint16 EnabledState = 2;
uint32 ErrorThreshold = 2;
uint32 Interval = 2000;
uint32 Latency = 1000;
};
Members
The Msvm_HeartbeatComponentSettingData class has these types of members:
Properties
The Msvm_HeartbeatComponentSettingData class has these properties.
-
Address
-
-
Data type: string
-
Access type: Read-only
The address of the resource. This property is inherited from CIM_ResourceAllocationSettingData and is always set to Null.
-
-
AddressOnParent
-
-
Data type: string
-
Access type: Read-only
Describes the address of this resource in the context of the parent. The Parent/AddressOnParent properties are used to describe the controller relationship as well as the ordering of devices on a controller. For example, if the parent is a PCI Controller, this property would specify the PCI slot of this child device. This property is inherited from CIM_ResourceAllocationSettingData and is always set to Null.
-
-
AllocationUnits
-
-
Data type: string
-
Access type: Read-only
The units of allocation used by the Reservation and Limit properties. This property is inherited from CIM_ResourceAllocationSettingData and is always set to "Integration Components".
-
-
AutomaticAllocation
-
-
Data type: boolean
-
Access type: Read-only
Indicates whether the resource is automatically allocated. This property is inherited from CIM_ResourceAllocationSettingData and is always set to True.
-
-
AutomaticDeallocation
-
-
Data type: boolean
-
Access type: Read-only
Indicates whether the resource is automatically de-allocated. This property is inherited from CIM_ResourceAllocationSettingData and is always set to True.
-
-
Caption
-
-
Data type: string
-
Access type: Read-only
A short description of the object. This property is inherited from the CIM_ManagedElement class and is always set to "Heartbeat".
-
-
Connection
-
-
Data type: string array
-
Access type: Read-only
The thing to which this resource is connected. This property is inherited from CIM_ResourceAllocationSettingData and is always set to Null.
-
-
ConsumerVisibility
-
-
Data type: uint16
-
Access type: Read-only
Describes the consumers' visibility to the allocated resource. This property is inherited from CIM_ResourceAllocationSettingData and is always set to 3 (Virtualized).
-
-
Description
-
-
Data type: string
-
Access type: Read-only
A description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Microsoft Heartbeat Service Setting Data".
-
-
ElementName
-
-
Data type: string
-
Access type: Read-only
A display name for the object. This property is inherited from CIM_SettingData, and it is always set to "Heartbeat". Changing this property will change the ElementName property of the associated CIM_LogicalDevice derivative.
This is a read-only property, but it can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.
-
-
EnabledState
-
-
Data type: uint16
-
Access type: Read-only
The enabled and disabled states of an element.
This is a read-only property, but it can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.
-
-
Enabled (2)
-
Disabled (3)
ErrorThreshold
-
Data type: uint32
-
Access type: Read-only
An administrator's startup configuration for the enabled state of an element. This property is always set to 2 (Enabled).
This is a read-only property, but it can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.
HostResource
-
Data type: string array
-
Access type: Read-only
Exposes a specific assignment to host or underlying resources. This property is inherited from CIM_ResourceAllocationSettingData and is always set to Null.
InstanceID
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
Uniquely identifies an instance of this class. This property is inherited from CIM_SettingData and is always set to "Microsoft:GUID\DeviceSpecificData".
Interval
-
Data type: uint32
-
Access type: Read-only
The interval, in milliseconds, between ping attempts. This is always set to 2000.
This is a read-only property, but it can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.
Latency
-
Data type: uint32
-
Access type: Read-only
The maximum expected latency, in milliseconds, between a request ping and a response before a given request is considered dropped. This property is always set to 1000.
This is a read-only property, but it can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.
Limit
-
Data type: uint64
-
Access type: Read-only
The upper bound, or maximum amount of resource that will be granted for this allocation. This property is inherited from CIM_ResourceAllocationSettingData and is always set to 1.
MappingBehavior
-
Data type: uint16
-
Access type: Read-only
Specifies how this resource maps to underlying resources. This property is inherited from CIM_ResourceAllocationSettingData and is always set to Null.
OtherResourceType
-
Data type: string
-
Access type: Read-only
A string that describes the resource type when a well-defined value is not available and the ResourceType property has the value 1 (Other). This property is inherited from CIM_ResourceAllocationSettingData and is always set to "Microsoft Heartbeat Component".
Parent
-
Data type: string
-
Access type: Read-only
The parent of the resource. This property is inherited from CIM_ResourceAllocationSettingData and is always set to Null.
PoolID
-
Data type: string
-
Access type: Read-only
The ID of the resource pool from which the resource is allocated. This property is inherited from CIM_ResourceAllocationSettingData.
Reservation
-
Data type: uint64
-
Access type: Read-only
The amount of resource guaranteed to be available for this allocation. This property is inherited from CIM_ResourceAllocationSettingData and is always set to 1.
ResourceSubType
-
Data type: string
-
Access type: Read-only
An implementation specific subtype for this resource. This property is inherited from CIM_ResourceAllocationSettingData and is always set to Null.
ResourceType
-
Data type: uint16
-
Access type: Read-only
The type of resource this allocation setting represents. This property is inherited from the CIM_ResourceAllocationSettingData class and is always set to 1 (Other).
VirtualQuantity
-
Data type: uint64
-
Access type: Read-only
The quantity of resources presented to the consumer. This property is inherited from CIM_ResourceAllocationSettingData and is always set to 1.
VirtualQuantityUnits
-
Data type: string
-
Access type: Read-only
Specifies the units used by the VirtualQuantity property. For example, if ResourceType=Processor, the value of the VirtualQuantityUnits property can be set to "count", indicating that the value of the VirtualQuantity property is expressed as a count. If ResourceType=Memory, the value of the VirtualQuantityUnits property can be set to "bytes*10^3", indicating that the value of the VirtualQuantity property is expressed in kilobytes. This property is inherited from CIM_ResourceAllocationSettingData and is always set to "count".
Weight
-
Data type: uint32
-
Access type: Read-only
The relative priority for this allocation in relation to other allocations from the same resource pool. This property is inherited from CIM_ResourceAllocationSettingData and is always set to 0.
Remarks
Access to the Msvm_HeartbeatComponentSettingData class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 8 [desktop apps only] |
| Minimum supported server |
Windows Server 2012 [desktop apps only] |
| Namespace |
Root\Virtualization\V2 |
| MOF |
|
| DLL |
|