Msvm_Synthetic3DDisplayController class
Represents the synthetic 3-D display controller that is assigned to a virtual machine. This class is only used with virtual machines that use RemoteFX.
The following syntax is simplified from MOF code and includes all inherited properties.
Syntax
[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider")]
class Msvm_Synthetic3DDisplayController : CIM_DisplayController
{
string Caption;
string ElementName;
datetime InstallDate;
string Name;
uint16 OperationalStatus[];
string StatusDescriptions[];
string Status;
uint16 HealthState;
uint16 EnabledState;
string OtherEnabledState;
uint16 RequestedState = 2;
uint16 EnabledDefault = 2;
datetime TimeOfLastStateChange;
string SystemCreationClassName;
string SystemName;
string CreationClassName;
string DeviceID;
boolean PowerManagementSupported;
uint16 PowerManagementCapabilities[];
uint16 Availability;
uint16 StatusInfo;
uint32 LastErrorCode;
string ErrorDescription;
boolean ErrorCleared;
string OtherIdentifyingInfo[];
uint64 PowerOnHours;
uint64 TotalPowerOnHours;
string IdentifyingDescriptions[];
uint16 AdditionalAvailability[] = 6;
uint64 MaxQuiesceTime;
uint16 LocationIndicator = 4;
datetime TimeOfLastReset;
uint16 ProtocolSupported = 1;
uint32 MaxNumberControlled;
string ProtocolDescription;
string Description;
string VideoProcessor;
uint16 VideoMemoryType = 2;
string OtherVideoMemoryType;
uint32 NumberOfVideoPages;
uint32 MaxMemorySupported;
uint16 AcceleratorCapabilities[] = 2;
string CapabilityDescriptions[];
string AllocatedGPU;
};
Members
The Msvm_Synthetic3DDisplayController class has these types of members:
Methods
The Msvm_Synthetic3DDisplayController class has these methods.
| Method | Description |
|---|---|
| EnableDevice | This method is not supported. |
| OnlineDevice | This method is not supported. |
| QuiesceDevice | This method is not supported. |
| RequestStateChange | This method is not supported. |
| Reset | This method is not supported. |
| RestoreProperties | This method is not supported. |
| SaveProperties | This method is not supported. |
| SetPowerState | This method is not supported. |
Properties
The Msvm_Synthetic3DDisplayController class has these properties.
-
AcceleratorCapabilities
-
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_DisplayController.CapabilityDescriptions")
The graphics and 3-D capabilities of the display controller. This property is inherited from CIM_DisplayController, and it is set to 2 (Graphics Accelerator).
-
-
AdditionalAvailability
-
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_LogicalDevice.Availability")
This property is inherited from CIM_LogicalDevice, and it is set to 6 (Not Applicable).
-
-
AllocatedGPU
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MAXLEN (1024)
The identifier of the physical graphics processing unit (GPU) allocated to this virtual machine. This property only applies to virtual machines that use RemoteFX.
-
-
Availability
-
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_AssociatedPowerManagementService.PowerState", "CIM_ManagedSystemElement.OperationalStatus", "CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus", "MIF.DMTF|Host Device|001.5"), ModelCorrespondence ("CIM_LogicalDevice.AdditionalAvailability")
This property is inherited from CIM_LogicalDevice, and it is set to 6 (Not Applicable).
-
-
CapabilityDescriptions
-
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_DisplayController.AcceleratorCapabilities")
An array of free-form strings that provide more detailed explanations for any of the video accelerator features indicated in the AcceleratorCapabilities property array. Note that each entry of this array is related to the entry in the AcceleratorCapabilities property array that is located at the same index. This property is inherited from CIM_DisplayController, and it is set to "Graphics Accelerator".
-
-
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.
-
-
CreationClassName
-
The name of the class or subclass used in the creation of an instance. This property is inherited from CIM_LogicalDevice.
-
Description
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|Video|004.18")
A textual description of the object. This property is inherited from CIM_ManagedElement.
-
-
DeviceID
-
The device identifier. This property is inherited from CIM_LogicalDevice, and it is set to "Microsoft:GUID".
-
ElementName
-
-
Data type: string
-
Access type: Read-only
A user-friendly name for the object. This property is inherited from CIM_ManagedElement.
-
-
EnabledDefault
-
-
Data type: uint16
-
Access type: Read/write
An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement, and it is always set to 2 (Enabled).
-
-
EnabledState
-
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")
The enabled and disabled states of an element. It can also indicate the transitions between these requested states. This property is inherited from CIM_EnabledLogicalElement, and it is set to either 2 (Enabled) or 3 (Disabled).
The possible values are.
-
-
Enabled (2)
-
Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.
-
Disabled (3)
-
Indicates that the element does not execute commands and that it drops any new requests.
ErrorCleared
-
Data type: boolean
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus")
This property is inherited from CIM_LogicalDevice, but it is not used.
ErrorDescription
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_DeviceErrorData.ErrorDescription")
This property is inherited from CIM_LogicalDevice, but it is not used.
HealthState
-
Data type: uint16
-
Access type: Read-only
The current health of the element. This attribute expresses the health of this element but not necessarily that of its subelements. The possible values are from 0 through 30, where 5 means the element is entirely healthy and 30 means the element is completely nonfunctional. This property is inherited from CIM_ManagedSystemElement.
Unknown (0)
The implementation cannot report on HealthState at this time.
OK (5)
The element is fully functional and operates within normal operational parameters and without error.
Degraded/Warning (10)
The element is in working order, and all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.
Minor failure (15)
All functionality is available, but some functionality might be degraded.
Major failure (20)
The element is failing. It is possible that some or all of the functionality of this component is degraded or does not work.
Critical failure (25)
The element is nonfunctional, and recovery might not be possible.
Non-recoverable error (30)
The element has completely failed, and recovery is not possible. All functionality that this element provides has been lost.
DMTF Reserved
Reserved.
IdentifyingDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.OtherIdentifyingInfo")
This property is inherited from CIM_LogicalDevice, and it is set to NULL.
InstallDate
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")
The date and time the virtual machine configuration was created. This property is inherited from CIM_ManagedSystemElement.
LastErrorCode
-
Data type: uint32
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_DeviceErrorData.LastErrorCode")
This property is inherited from CIM_LogicalDevice, but it is not used.
LocationIndicator
-
Data type: uint16
-
Access type: Read/write
-
Qualifiers: Experimental, ModelCorrespondence ("CIM_AlarmDevice.AlarmState", "CIM_AlarmDevice.AudioIndicatorIsDisabled", "CIM_AlarmDevice.VisualIndicatorIsDisabled", "CIM_AlarmDevice.MotionIndicatorIsDisabled")
This property is inherited from CIM_LogicalDevice, and it is set to 4 (Not Supported).
MaxMemorySupported
-
Data type: uint32
-
Access type: Read-only
-
Qualifiers: Units ("Bytes")
The maximum amount of memory supported, in bytes. This property is inherited from CIM_DisplayController, and it is set to 4,194,304 (0x400000).
MaxNumberControlled
-
Data type: uint32
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|Bus Port|004.9")
The maximum number of directly addressable entities that are supported by this controller. A value of 0 should be used if the number is unknown or unlimited. The protocol used by the controller to access controlled devices. This property is inherited from CIM_Controller, and it is set to 1.
MaxQuiesceTime
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: Deprecated ("No value"), Units ("MilliSeconds")
This property is inherited from CIM_LogicalDevice, but it is not used.
Name
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (1024)
The label by which the object is known. This property is inherited from CIM_ManagedSystemElement.
NumberOfVideoPages
-
Data type: uint32
-
Access type: Read-only
The number of video pages supported given the current resolutions and available memory. This property is inherited from CIM_DisplayController, and it is set to 1024.
OperationalStatus
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")
The current statuses of the object. This property is inherited from CIM_ManagedSystemElement.
The possible values are.
Unknown (0)
Indicates that the implementation cannot report on the OperationalStatus property at this time.
Other (1)
Indicates an undefined state.
OK (2)
Indicates full functionality without errors.
Degraded (3)
Indicates that the element is in working order and that all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.
Stressed (4)
Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.
Predictive Failure (5)
Indicates that an element functions nominally, but predicts a failure in the near future.
Error (6)
Indicates that an error has occurred.
Non-Recoverable Error (7)
Indicates that a nonrecoverable error has occurred.
Starting (8)
Indicates that the job is starting.
Stopping (9)
Indicates that the job is stopping.
Stopped (10)
Indicates that the element has been intentionally stopped.
In Service (11)
Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.
No Contact (12)
Indicates that the monitoring system has information about this element, but has never been able to establish communications with it.
Lost Communication (13)
Indicates that the monitoring system has successfully contacted this element in the past, but it is currently unavailable.
Aborted (14)
Indicates that the job stopped in an unexpected way. The state and configuration of the job might require an update.
Dormant (15)
Indicates that the job is inactive.
Supporting Entity in Error (16)
Indicates that an element on which this job depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.
Completed (17)
Indicates that the job has completed its operation. This value should be combined with either OK, Error, or Degraded to indicate to a client whether the complete operation Completed with OK and passed, or completed with Error and failed, or completed with Degraded and finished the operation, but did not complete OK or did not report an error.
Power Mode (18)
Indicates that the element has additional power model information that is contained in the associated power management service.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
OtherEnabledState
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
The enabled or disabled state of the element when the EnabledState property is set to 1 (Other). This property must be set to null when EnabledState is any value other than 1. This property is inherited from CIM_EnabledLogicalElement, and it is always set to NULL.
OtherIdentifyingInfo
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: MaxLen (256), ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.IdentifyingDescriptions")
This property is inherited from CIM_LogicalDevice, and it is set to NULL.
OtherVideoMemoryType
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_DisplayController.VideoMemoryType")
The video memory type when the instance's VideoMemoryType property is 1 (Other). This property is inherited from CIM_DisplayController, and it is set to NULL.
PowerManagementCapabilities
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities")
This property is inherited from CIM_LogicalDevice, but it is not used.
PowerManagementSupported
-
Data type: boolean
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities")
This property is inherited from CIM_LogicalDevice, but it is not used.
PowerOnHours
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_PoweredStatisticalData.PowerOnHours"), Units ("Hours"), Counter
This property is inherited from CIM_LogicalDevice, but it is not used.
ProtocolDescription
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|Bus Port|004.3"), ModelCorrespondence ("CIM_Controller.ProtocolSupported")
A free-form string that provides more information that is related to the protocol supported by the controller. This property is inherited from CIM_Controller, and it is set to "Video".
ProtocolSupported
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|Bus Port|004.2", "MIF.DMTF|Disks|003.3"), ModelCorrespondence ("CIM_Controller.ProtocolDescription")
The protocol used by the controller to access controlled devices. This property is inherited from CIM_Controller, and it is set to 1 (Other).
RequestedState
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
The last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. A particular instance of CIM_EnabledLogicalElement might not support RequestStateChange. If this occurs, the value 12 (Not Applicable) is used. This property is inherited from CIM_EnabledLogicalElement, and it is set to 2 (Enabled), 3 (Disabled), or 12 (Not Applicable).
Enabled (2)
Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)
This property is inherited from CIM_ManagedSystemElement but it is not used.
StatusDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")
Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement.
StatusInfo
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.4")
This property is inherited from CIM_LogicalDevice, but it is not used.
SystemCreationClassName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)
The scoping system's creation class name. This property is inherited from CIM_LogicalDevice.
SystemName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)
The unique identifier for the scoping virtual system. This property is inherited from CIM_LogicalDevice.
TimeOfLastReset
-
Data type: datetime
-
Access type: Read-only
The last time the virtual computer system was powered on. This property is inherited from CIM_Controller.
TimeOfLastStateChange
-
Data type: datetime
-
Access type: Read-only
The date or time when the enabled state of the element last changed. This property is inherited from CIM_EnabledLogicalElement.
TotalPowerOnHours
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_PoweredStatisticalData.TotalPowerOnHours"), Units ("Hours"), Counter
This property is inherited from CIM_LogicalDevice, but it is not used.
VideoMemoryType
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|Video|004.6"), ModelCorrespondence ("CIM_DisplayController.OtherVideoMemoryType")
The type of video memory. This property is inherited from CIM_DisplayController, and it is set to 2 (VRAM).
VideoProcessor
-
Data type: string
-
Access type: Read-only
A free-form string that describes the video processor/controller. This property is inherited from CIM_DisplayController, and it is set to "Synthetic Video Processor".
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 |
|