Msvm_SerialController class

아티클
05/31/2018

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

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   Caption = "Serial Controller";
  string   Description = "Microsoft Virtual Serial Controller";
  string   ElementName = "Serial Controller";
  datetime InstallDate;
  string   Name = "Serial Controller";
  uint16   OperationalStatus[] = 2;
  string   Status;
  uint16   HealthState = 5;
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  datetime TimeOfLastStateChange;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_SerialController";
  string   DeviceID = "Microsoft:<GUID>";
  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 = 26;
  uint32   MaxNumberControlled = 2;
  string   ProtocolDescription;
  uint16   Capabilities[] = 5;
  string   CapabilityDescriptions[];
  uint16   Security = 3;
  string   StatusDescriptions[] = { "OK" };
  uint16   EnabledDefault = 2;
  string   CapabilitiesDescriptions[] = { "16550 compatible" };
  uint32   MaxBaudRate = 115200;
};

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	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_SerialController class has these properties.

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").

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

Capabilities

Data type: uint16 array
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Serial Ports|004.7"), ArrayType ("Indexed"), ModelCorrespondence ("CIM_SerialController.CapabilityDescriptions")

The buffering and other capabilities of the serial controller that might be inherent in the chip hardware. This property is inherited from CIM_SerialController and it is set to 5 (16550 compatible).

CapabilitiesDescriptions

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 and it is set to "16550 compatible".

CapabilityDescriptions

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_SerialController.Capabilities")

An array that contains more detailed explanations for serial controller features in the Capabilities array. The items in the CapabilityDescriptions array correlate to those in the Capabilities array.

This property is inherited from CIM_SerialController.

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 and it is set to "Serial Controller".

CreationClassName

Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

The name of the class or subclass used in the creation of an instance. This property is inherited from CIM_LogicalDevice and it is set to "Msvm_SerialController".

Description

Data type: string
Access type: Read-only

A textual description of the object. This property is inherited from CIM_ManagedElement and it is always set to "Microsoft Virtual Serial Controller".

DeviceID

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

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

ElementName

Data type: string
Access type: Read-only

This property is inherited from CIM_ManagedElement and it is set to "Serial Controller".

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 always set to 5 (Not Applicable).

Not Applicable (5)

Indicates the element does not support to be enabled or disabled.

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 subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. This property is inherited from CIM_ManagedSystemElement and it is always set to 5.

OK (5)

The element is fully functional and operates within normal operational parameters and without error.

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").

MaxBaudRate

Data type: uint32
Access type: Read-only
Qualifiers: Units ("Bits per Second"), MappingStrings ("MIF.DMTF|Serial Ports|004.6")

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

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

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 and it is the same as the ElementName property.

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 and each array element is always set to 2 (OK).

OK (2)

Indicates full functionality without errors.

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.

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

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 26 (IEEE-488).

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 the RequestedStateChange method. If this occurs, the value 12 (Not Applicable) is used. This property is inherited from CIM_EnabledLogicalElement and it is always set to 12 (Not Applicable).

Not Applicable (12)

Indicates that this instance does not support the RequestedState property.

Security

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Serial Ports|004.9")

The operational security for the controller. This property is inherited from CIM_SerialController and it is set to 3 (None).

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 and each array element is always set to "OK".

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 and it is set to "Msvm_ComputerSystem".

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 and it is set to NULL.

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
Qualifiers: Deprecated ("CIM_PoweredStatisticalData.TotalPowerOnHours"), Units ("Hours"), Counter

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


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

다음을 통해 공유

Msvm_SerialController class

Syntax

Members

Methods

Properties

Remarks

Requirements

See also

추가 리소스