Msvm_KvpExchangeComponentSettingData class

Article
05/31/2018

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
{
  string  Caption = "Key-Value
      Pair Exchange";
  string  Description = "Microsoft
      Key-Value Pair Exchange Component Setting Data";
  string  InstanceID = "Microsoft:GUID\device-specific data";
  string  ElementName = "Key-Value Pair Exchange";
  uint16  ResourceType = 1;
  string  OtherResourceType = "Microsoft Key-Value Pair Exchange Component";
  string  PoolID;
  uint16  ConsumerVisibility = 3;
  string  HostResource[];
  string  AllocationUnits = "Integration Components";
  uint64  VirtualQuantity = 1;
  uint64  Reservation = 1;
  boolean AutomaticAllocation = TRUE;
  boolean AutomaticDeallocation = TRUE;
  string  Parent;
  string  Connection[];
  string  Address;
  uint16  MappingBehavior;
  string  ResourceSubType;
  uint64  Limit = 1;
  uint32  Weight = 0;
  uint16  EnabledState = 2;
  String  HostExchangeItems[];
  String  HostOnlyItems[];
};

Members

The Msvm_KvpExchangeComponentSettingData class has these types of members:

Properties

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.

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 will be 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 will be automatically de-allocated. This property is inherited from CIM_ResourceAllocationSettingData and is always set to TRUE.

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 "Key-Value Pair Exchange".

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 and is always set to 3 ("Virtualized").

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 Key-Value Pair Exchange Component Setting Data".

ElementName

Data type: string
Access type: Read-only
Qualifiers: Required

A user-friendly name for the object. This property is inherited from CIM_ManagedElement and it is set to "Key-Value Pair Exchange". 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 using the ModifyVirtualSystemResources 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 using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.

Enabled (2)

Disabled (3)

HostExchangeItems

Data type: String array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), HyperVEmbeddedInstance ("Msvm_KvpExchangeDataItem")

An array of Msvm_KvpExchangeDataItem instances.

This is a read-only property, but it can be changed using the AddKvpItems, ModifyKvpItems, and RemoveKvpItems methods of the Msvm_VirtualSystemManagementService class.

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

Windows Server 2008: The HostOnlyItems property is not supported until Windows Server 2008 R2.

HostResource

Data type: string array
Access type: Read-only
Qualifiers: HyperVEmbeddedInstance ("CIM_LogicalDevice")

Exposes 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

This property is inherited from CIM_ResourceAllocationSettingData and is always set to "Microsoft:GUID\device-specific data".

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
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.ResourceType")

A string that describes the resource type when a well-defined value is not available and ResourceType has the value "Other". This property is inherited from CIM_ResourceAllocationSettingData and is always set to "Microsoft Key-Value Pair Exchange 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
Qualifiers: ModelCorrespondence ("CIM_ResourcePool.PoolId")

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

A string that describes an implementation specific sub-type for this resource. This property is inherited from CIM_ResourceAllocationSettingData and is always set to NULL.

ResourceType

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.OtherResourceType")

The type of resource this allocation setting represents. This property is inherited from CIM_ResourceAllocationSettingData 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.

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 and is always set to 0.

Remarks

Access to the Msvm_KvpExchangeComponentSettingData 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