Msvm_Synthetic3DDisplayControllerSettingData class

Article
05/31/2018

Represents settings for a synthetic 3-D display controller for a virtual machine. This class is only used with virtual machines that use RemoteFX.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_Synthetic3DDisplayControllerSettingData : 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;
  uint8   MaximumScreenResolution;
  uint8   MaximumMonitors;
};

Members

The Msvm_Synthetic3DDisplayControllerSettingData class has these types of members:

Properties

Properties

The Msvm_Synthetic3DDisplayControllerSettingData 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 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 deallocated. 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 by 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 by 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 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 that 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 by 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\DeviceSpecificData". 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 that can 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

MaximumMonitors

Data type: uint8
Access type: Read/write

The maximum number of monitors available to the 3-D display controller. The minimum number of monitors is 1 and the maximum is dependent upon the maximum screen resolution. The following table defines the maximum number of monitors allowed for different resolutions.

Resolution	Maximum monitors
1024 768	4
1280 1024	4
1600 1200	3
1920 1200	2

MaximumScreenResolution

Data type: uint8
Access type: Read-only

Specifies the maximum screen resolution for the 3-D display controller. This must be one of the following values.

1024 * 768 (0)

The maximum resolution is 1024 768.

1280 * 1024 (1)

The maximum resolution is 1280 1024.

1600 * 1200 (2)

The maximum resolution is 1600 1200.

1920 * 1200 (3)

The maximum resolution is 1920 1200.

2560 * 1600 (4)

The maximum resolution is 2560 1600.

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\DeviceSpecificData". 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 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
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.

Weight

Data type: uint32
Access type: Read-only

An integer that defines 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.

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2008 R2 with SP1
End of client support	None supported
End of server support	Windows Server 2012 R2
Namespace	Root\Virtualization
MOF	WindowsVirtualization.mof

Msvm_Synthetic3DDisplayControllerSettingData class

Syntax

Members

Properties

Requirements

Additional resources