Share via

Msvm_ResourceAllocationSettingData class

  • Article

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

Members

The Msvm_ResourceAllocationSettingData class has these types of members:

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 using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.

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

Qualifiers: MaxLen (64)

A short textual description (one-line string) 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 either (1) the ResourceType property is 17 (Serial port) or (2) the ResourceType property is 21 (Storage Extent) and the ResourceSubType property is "Microsoft Virtual Hard Disk" then it can be changed using the ModifyVirtualSystemResources 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.

Unknown (0)

Passed-Through (2)

Virtualized (3)

Not represented (4)

DMTF reserved

5 32766

Vendor Reserved

32767 65535

Description

Data type: string

Access type: Read-only

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

ElementName

Data type: string

Access type: Read-only

Qualifiers: Required

A user-friendly 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 using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.

HostResource

Data type: string array

Access type: Read-only

Qualifiers: HyperVEmbeddedInstance ("CIM_LogicalDevice")

Only one host resource may be assigned to each device in the virtual machine, so only the first element of this array may 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 which is to be assigned. This property is inherited from CIM_ResourceAllocationSettingData.

This is a read-only property, but if the ResourceType property is 22 (Disk) and the ResourceSubType property is "Microsoft Physical Disk Drive" then it can be changed using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

For instances associated with a virtual system, this will be "Microsoft:GUID\device-specific data". For instances which define potential settings for a virtual system, this will be "Microsoft:Definition\GUID\Type", where Type can be one of "Maximum", "Minimum", "Default", or "Increment". This property is inherited from CIM_SettingData.

Limit

Data type: uint64

Access type: Read-only

The maximum amount of corresponding host resources which may be consumed by the virtual system. 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.

Unknown (0)

Not Supported (1)

Dedicated (2)

Soft Affinity (3)

Hard Affinity (4)

DMTF Reserved

5 32766

Vendor Reserved

32767 65535

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

Qualifiers: ModelCorrespondence ("CIM_ResourcePool.PoolId")

The identifier of the resource pool from which this resource was allocated. For instances associated with a virtual system, this will be "Microsoft:GUID\device-specific data". For instances which define potential settings for a virtual system, 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 CPU resources that are reserved for use by the virtual system. These resources are guaranteed to be available for consumption by the virtual system. 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. 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

Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.OtherResourceType")

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)

I/O Slot (11)

I/O Device (12)

Floppy Drive (13)

CD Drive (14)

DVD drive (15)

Serial port (16)

Parallel port (17)

USB Controller (18)

Graphics controller (19)

Storage Extent (20)

Disk (21)

Tape (22)

Other storage device (23)

Firewire Controller (24)

Partitionable Unit (25)

Base Partitionable Unit (26)

Power Supply (27)

Cooling Device (28)

DMTF reserved

34 32767

Vendor Reserved

32768 35535

VirtualQuantity

Data type: uint64

Access type: Read-only

The total number of cores in the virtual system. This property is inherited from CIM_ResourceAllocationSettingData.

VirtualSystemIdentifiers

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed")

A free-form string array of identifiers of this resource presented to the virtual computer system'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 using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.

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

Weight

Data type: uint32

Access type: Read-only

An integer defining the 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 systems 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
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

See also

CIM_ResourceAllocationSettingData

CIM_ResourceAllocationSettingData

Msvm_ResourceAllocationSettingData (V2)

Resource Management Classes