Msvm_ResourceAllocationSettingData class

Article
01/07/2021

Represents the current and recorded allocation states of a virtual resource.

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_ResourceAllocationSettingData : CIM_ResourceAllocationSettingData
{
  string  InstanceID = "Microsoft:GUID\DeviceSpecificData";
  string  Caption;
  string  Description;
  string  ElementName;
  uint16  ResourceType;
  string  OtherResourceType;
  string  ResourceSubType;
  string  PoolID;
  uint16  ConsumerVisibility;
  string  HostResource[];
  string  AllocationUnits;
  uint64  VirtualQuantity;
  uint64  Reservation;
  uint64  Limit;
  uint32  Weight;
  boolean AutomaticAllocation;
  boolean AutomaticDeallocation;
  string  Parent;
  string  Connection[];
  string  Address;
  uint16  MappingBehavior;
  string  AddressOnParent;
  string  VirtualQuantityUnits = "count";
  string  VirtualSystemIdentifiers[] = { "GUID" };
};

Members

The Msvm_ResourceAllocationSettingData class has these types of members:

Properties

Properties

The Msvm_ResourceAllocationSettingData class has these properties.

Address

Data type: string
Access type: Read-only

The address of the resource. This property is inherited from CIM_ResourceAllocationSettingData.

This is a read-only property, but if the ResourceType property is 20 (Graphics controller), it can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.

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 unit 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 deallocated. This property is inherited from CIM_ResourceAllocationSettingData.

Caption

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

A short description of the object. This property is inherited from CIM_ManagedElement.

Connection

Data type: string array
Access type: Read-only

The device to which this resource is connected. This property is inherited from CIM_ResourceAllocationSettingData.

This is a read-only property. But if the ResourceType property is 21 (Serial port) and the ResourceSubType property is "Microsoft:Hyper-V:Serial Port", the Connection property can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.

ConsumerVisibility

Data type: uint16
Access type: Read-only

The consumer's visibility to the allocated resource. This property is inherited from CIM_ResourceAllocationSettingData.

Description

Data type: string
Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement.

ElementName

Data type: string
Access type: Read-only

A display name for the object. This property is inherited from CIM_SettingData. Changing this property will change the element name of the associated logical device derivative.

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

Only one host resource can be assigned to each device in the virtual machine, so only the first element of this array can be set. For devices that support this feature, set the first element of the HostResource array to contain a reference to the underlying host resource to be assigned. This property is inherited from CIM_ResourceAllocationSettingData.

This is a read-only property. But if the ResourceType property is 17 (Disk) and the ResourceSubType property is "Microsoft:Hyper-V:Physical Disk Drive", the HostResource property can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.

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 it is always set to "Microsoft:GUID\DeviceSpecificData".

Limit

Data type: uint64
Access type: Read-only

The maximum amount of resource that will be granted for this allocation. The unit of measurement for this property is specified by the VirtualQuantityUnits property. 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.

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.

PoolID

Data type: string
Access type: Read-only

The identifier of the resource pool from which this resource was allocated. For instances associated with a virtual machine, this will be "Microsoft:GUID\device-specific data". For instances that define potential settings for a virtual machine, this will be "Microsoft:Definition\GUID\Type", where Type can be one of "Maximum", "Minimum", "Default", or "Increment". 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. The unit of measurement for this property is specified by the VirtualQuantityUnits property. These resources are guaranteed to be available for consumption by the virtual machine. This property is inherited from CIM_ResourceAllocationSettingData.

ResourceSubType

Data type: string
Access type: Read-only

A string that describes an implementation specific subtype for this resource. For example, this may be used to distinguish different models of the same resource type. 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.

Other (1)
Computer System (2)
Processor (3)
Memory (4)
IDE Controller (5)
Parallel SCSI HBA (6)
FC HBA (7)
iSCSI HBA (8)
IB HCA (9)
Ethernet Adapter (10)
Other Network Adapter (11)
I/O Slot (12)
I/O Device (13)
Diskette Drive (14)
CD Drive (15)
DVD drive (16)
Disk Drive (17)
Tape Drive (18)
Storage Extent (19)
Other Storage Device (20)
Serial port (21)
Parallel port (22)
USB controller (23)
Graphics controller (24)
IEEE 1394 controller (25)
Partitionable Unit (26)
Base Partitionable Unit (27)
Power Supply (28)
Cooling Device (29)
Ethernet Switch Port (30)
Logical Disk (31)
Storage Volume (32)
Ethernet connection (33)
DMTF reserved (30 32767)
Vendor Reserved (32768 65535)

VirtualQuantity

Data type: uint64
Access type: Read-only

Specifies the quantity of resources presented to the consumer. The unit of measurement for this property is specified by the VirtualQuantityUnits property. 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.

VirtualSystemIdentifiers

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed")

A string array of identifiers of this resource presented to the virtual machine's operating system. These values are used only if the ResourceType property is set to 6 (Parallel SCSI HBA) and the ResourceSubType property is set to "Microsoft Synthetic SCSI Controller". This property is set to "GUID".

This is a read-only property, but it can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.

Weight

Data type: uint32
Access type: Read-only

An integer that defines the relative weight for each virtual machine processor. After all reserves have been met, the remaining physical processor capacity of the hosting platform will be allocated to virtual machines based on their relative weights. This property is inherited from CIM_ResourceAllocationSettingData.

Range: 0 1000

Remarks

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