Represents the configured state of the key/value pair exchange 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_KvpExchangeComponentSettingData : CIM_ResourceAllocationSettingData
{
boolean DisableHostKVPItems;
string InstanceID;
string Caption = "Key-Value Pair Exchange";
string Description = "Microsoft Key-Value Pair Exchange Service Setting Data";
string ElementName = "Key-Value Pair Exchange";
uint16 ResourceType = 1;
string OtherResourceType = "Microsoft:Hyper-V:Key-Value Pair Exchange Component";
string ResourceSubType;
string PoolID;
uint16 ConsumerVisibility = 3;
string HostResource[];
string AllocationUnits = "count";
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;
String HostExchangeItems[];
String HostOnlyItems[];
};
Members
The Msvm_KvpExchangeComponentSettingData class has these types of members:
Properties
The Msvm_KvpExchangeComponentSettingData 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 and AddressOnParent properties are used to describe the controller relationship as well as the ordering of devices on a controller. This property is inherited from CIM_ResourceAllocationSettingData.
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.
AutomaticAllocation
Data type: boolean
Access type: Read-only
Indicates whether the resource will be automatically allocated. This property is inherited from CIM_ResourceAllocationSettingData.
AutomaticDeallocation
Data type: boolean
Access type: Read-only
Indicates whether the resource will be automatically de-allocated. This property is inherited from CIM_ResourceAllocationSettingData.
Caption
Data type: string
Access type: Read-only
A short description of the object. This property is inherited from CIM_ManagedElement.
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
The consumers visibility to the allocated resource. This property is inherited from CIM_ResourceAllocationSettingData.
| Value | Meaning |
|---|---|
| 3 | Virtualized |
Description
Data type: string
Access type: Read-only
A description of the object. This property is inherited from CIM_ManagedElement.
DisableHostKVPItems
Data type: boolean
Access type: Read/write
This property disables the host from automatically populatinghost name and OS information inside the guest.
Note:
This property was added in Windows 10, version 1703.
ElementName
Data type: string
Access type: Read-only
A display name for the object. This property is inherited from CIM_ManagedElement.
EnabledState
Data type: uint16
Access type: Read-only
The enabled state of the element.
Enabled (2)
Disabled (3)
HostExchangeItems
Data type: String array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), HyperVEmbeddedInstance ("Msvm_KvpExchangeDataItem")
An array of embedded Msvm_KvpExchangeDataItem instances that represent the key/value pairs.
HostOnlyItems
Data type: String array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), HyperVEmbeddedInstance ("Msvm_KvpExchangeDataItem")
An array of Msvm_KvpExchangeDataItem instances containing the key/value pairs that are stored in the configuration file but not exchanged with the guest operating system. This allows applications to store virtual machine-specific data that does not need to be visible to the guest operating system. The items are formatted the same as the items in the HostExchangeItems property except the Source property of the Msvm_KvpExchangeDataItem instance is set to 4. Each configuration file is limited to 128 key/value pairs, where each value field is allowed to be up to 16 KB in size and the key field is allowed to be up to 512 bytes.
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_ManagedElement.
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.
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 ResourceType has the value 1 (Other). This property is inherited from CIM_ResourceAllocationSettingData.
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.
ResourceSubType
Data type: string
Access type: Read-only
A string that describes an implementation specific sub-type for this resource. This property is inherited from CIM_ResourceAllocationSettingData.
ResourceType
Data type: uint16
Access type: Read-only
The type of resource this allocation setting represents. This property is inherited from CIM_ResourceAllocationSettingData.
| Value | Meaning |
|---|---|
| 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.
VirtualQuantityUnits
Data type: string
Access type: Read-only
Specifies the unit of measurement for this resource allocation. The value of this property must be a legal value of the Programmatic Units qualifier as defined in Annex C.1 of DSP0004 V2.5 or later. This property is inherited from CIM_ResourceAllocationSettingData.
Weight
Data type: uint32
Access type: Read-only
A relative priority for this allocation in relation to other allocations from the same resource pool. This property is inherited from CIM_ResourceAllocationSettingData.
Remarks
Access to the Msvm_KvpExchangeComponentSettingData 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 | WindowsVirtualization.V2.mof |
| DLL | Vmms.exe |
See also
CIM_ResourceAllocationSettingData
CIM_ResourceAllocationSettingData
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
