Msvm_SerialController class

Represents the capabilities and management of the serial controller. Serial controllers are logical devices that are always present in a virtual machine, and thus are not allocated through a resource pool. One serial controller instance is always present in a virtual machine. Serial controllers have a fixed number of port instances. This implementation supports two ports per controller.

Note

Serial controllers are optional in generation 2 virtual machines.

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_SerialController : CIM_SerialController
{
  string   InstanceID;
  string   Caption = "Serial Controller";
  string   Description = "Microsoft Virtual Serial Controller";
  string   ElementName = "Serial Controller";
  datetime InstallDate;
  string   Name = "Serial Controller";
  uint16   OperationalStatus[] = { 2 };
  string   StatusDescriptions[] = { "OK" };
  string   Status;
  uint16   HealthState = 5;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_SerialController";
  string   DeviceID;
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability = 6;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  boolean  ErrorCleared;
  string   OtherIdentifyingInfo[];
  uint64   PowerOnHours;
  uint64   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[] = { 6 };
  uint64   MaxQuiesceTime;
  datetime TimeOfLastReset;
  uint16   ProtocolSupported = 26;
  uint32   MaxNumberControlled = 2;
  string   ProtocolDescription;
  uint16   Capabilities[] = { 5 };
  string   CapabilityDescriptions[] = { "16550 compatible" };
  uint32   MaxBaudRate = 115200;
  uint16   Security = 3;
};

Members

The Msvm_SerialController class has these types of members:

• Methods
• Properties

Methods

The Msvm_SerialController 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	Requests a state change.
Reset	Resets the device.
RestoreProperties	This method is not supported.
SaveProperties	This method is not supported.
SetPowerState	This method is not supported.

Properties

The Msvm_SerialController class has these properties.

AdditionalAvailability

Data type: uint16 array

Access type: Read-only

Any additional availability and status of the device. This property is inherited from CIM_LogicalDevice.

Value	Meaning
{ 6 }
6	Not Applicable

Availability

Data type: uint16

Access type: Read-only

The primary availability and status of the device. This property is inherited from CIM_LogicalDevice.

Value	Meaning
6	Not Applicable

AvailableRequestedStates

Data type: uint16 array

Access type: Read-only

Indicates the possible values for the RequestedState parameter of the RequestStateChange method. This property is inherited from CIM_EnabledLogicalElement, but it is not used.

Capabilities

Data type: uint16 array

Access type: Read-only

The buffering and other capabilities of the serial controller that might be inherent in the chip hardware. This property is inherited from CIM_SerialController.

CapabilityDescriptions

Data type: string array

Access type: Read-only

An array of free-form strings that provides more detailed explanations for any of the serial controller features that are indicated in the Capabilities array. This property is inherited from CIM_SerialController.

Caption

Data type: string

Access type: Read-only

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

CommunicationStatus

Data type: uint16

Access type: Read-only

Indicates the ability of the instrumentation to communicate with the underlying managed element. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Not Available (1)

Communication OK (2)

Lost Communication (3)

No Contact (4)

DMTF Reserved (..)

Vendor Reserved (0x8000.. )

CreationClassName

Data type: string

Access type: Read-only

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

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

DetailedStatus

Data type: uint16

Access type: Read-only

Compliments the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Not Available (0)

No Additional Information (1)

Stressed (2)

Predictive Failure (3)

Non-Recoverable Error (4)

Supporting Entity in Error (5)

DMTF Reserved (..)

Vendor Reserved (0x8000.. )

DeviceID

Data type: string

Access type: Read-only

This property is inherited from CIM_LogicalDevice, and it is always set to "Microsoft:<GUID>".

ElementName

Data type: string

Access type: Read-only

A display name for the object. This property is inherited from CIM_ManagedElement.

EnabledDefault

Data type: uint16

Access type: Read-only

An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement.

Value	Meaning
2	Enabled

EnabledState

Data type: uint16

Access type: Read-only

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.

Value	Meaning
5	Not Applicable

ErrorCleared

Data type: boolean

Access type: Read-only

Indicates whether the error reported in the LastErrorCode property is now cleared. This property is inherited from CIM_LogicalDevice, but it is not used.

ErrorDescription

Data type: string

Access type: Read-only

A string that provides more information about the error recorded in the LastErrorCode property and information about any corrective actions that may be taken. 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 expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely nonfunctional. This property is inherited from CIM_ManagedSystemElement.

IdentifyingDescriptions

Data type: string array

Access type: Read-only

An array of free-form strings that provide explanations and details behind the entries in the OtherIdentifyingInfo property array. This property is inherited from CIM_LogicalDevice, and it is always set to Null.

InstallDate

Data type: datetime

Access type: Read-only

The date and time the virtual machine configuration was created. This property is inherited from CIM_ManagedSystemElement.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

LastErrorCode

Data type: uint32

Access type: Read-only

The last error code reported by the logical device. This property is inherited from CIM_LogicalDevice, but it is not used.

MaxBaudRate

Data type: uint32

Access type: Read-only

The maximum baud rate, in bits per second, that is supported by the serial controller. This property is inherited from CIM_SerialController.

MaxNumberControlled

Data type: uint32

Access type: Read-only

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.

MaxQuiesceTime

Data type: uint64

Access type: Read-only

This property has been deprecated. This property is inherited from CIM_LogicalDevice, but it is not used.

Name

Data type: string

Access type: Read-only

The label by which the object is known. This property is inherited from CIM_ManagedSystemElement, and it is the same as the ElementName property.

OperatingStatus

Data type: uint16

Access type: Read-only

Provides current status information for the operational condition of the element and can be used for providing more detail with respect to the value of the EnabledState property. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Not Available (1)

Servicing (2)

Starting (3)

Stopping (4)

Stopped (5)

Aborted (6)

Dormant (7)

Completed (8)

Migrating (9)

Emigrating (10)

Immigrating (11)

Snapshotting (12)

Shutting Down (13)

In Test (14)

Transitioning (15)

In Service (16)

DMTF Reserved (..)

Vendor Reserved (0x8000.. )

OperationalStatus

Data type: uint16 array

Access type: Read-only

The current statuses of the object. This property is inherited from CIM_ManagedSystemElement.

OtherEnabledState

Data type: string

Access type: Read-only

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.

OtherIdentifyingInfo

Data type: string array

Access type: Read-only

Any additional data, beyond device ID information, that could be used to identify a logical device. This property is inherited from CIM_LogicalDevice, and it is always set to Null.

PowerManagementCapabilities

Data type: uint16 array

Access type: Read-only

The power management capabilities of the device. This property is inherited from CIM_LogicalDevice, but it is not used.

PowerManagementSupported

Data type: boolean

Access type: Read-only

Indicates whether the device can be power managed. This property is inherited from CIM_LogicalDevice, but it is not used.

PowerOnHours

Data type: uint64

Access type: Read-only

The number of consecutive hours that this device has been powered on since its last power cycle. This property is inherited from CIM_LogicalDevice, but it is not used.

PrimaryStatus

Data type: uint16

Access type: Read-only

Provides high level status information. This property should be used in conjunction with the DetailedStatus property to provide high level and detailed health status of the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

OK (1)

Degraded (2)

Error (3)

DMTF Reserved (..)

Vendor Reserved (0x8000.. )

ProtocolDescription

Data type: string

Access type: Read-only

A string that provides more information that is related to the protocol supported by the controller. This property is inherited from CIM_Controller.

ProtocolSupported

Data type: uint16

Access type: Read-only

The protocol used by the controller to access controlled devices. This property is inherited from CIM_Controller.

Value	Meaning
26	IEEE-488

RequestedState

Data type: uint16

Access type: Read-only

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. This property is inherited from CIM_EnabledLogicalElement.

Value	Meaning
12	Not Applicable

Security

Data type: uint16

Access type: Read-only

The operational security for the controller. This property is inherited from CIM_SerialController.

Value	Meaning
3	None

Status

Data type: string

Access type: Read-only

The current status of the object. This property is inherited from CIM_ManagedSystemElement, but it is not used.

StatusDescriptions

Data type: string array

Access type: Read-only

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement.

StatusInfo

Data type: uint16

Access type: Read-only

The current state of the logical device. This property is inherited from CIM_LogicalDevice, but it is not used.

SystemCreationClassName

Data type: string

Access type: Read-only

The scoping system's creation class name. This property is inherited from CIM_LogicalDevice.

SystemName

Data type: string

Access type: Read-only

The unique identifier for the scoping virtual machine. This property is inherited from CIM_LogicalDevice.

TimeOfLastReset

Data type: datetime

Access type: Read-only

The last time the controller 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, and it is always set to Null.

TotalPowerOnHours

Data type: uint64

Access type: Read-only

The total number of hours that this device has been powered. This property is inherited from CIM_LogicalDevice, but it is not used.

TransitioningToState

Data type: uint16

Access type: Read-only

Indicates the target state to which the instance is transitioning. This property is inherited from CIM_EnabledLogicalElement, but it is not used.

Remarks

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

See also

CIM_SerialController

CIM_SerialController

Serial Devices Classes