Represents a port on the switch.
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_EthernetSwitchPort : CIM_EthernetPort
{
string InstanceID;
string Caption = "Ethernet Switch Port";
string Description = "Microsoft Virtual Ethernet Switch Port";
string ElementName;
datetime InstallDate;
string Name;
uint16 OperationalStatus[] = 2;
string StatusDescriptions[];
string Status;
uint16 HealthState = 5;
uint16 CommunicationStatus;
uint16 DetailedStatus;
uint16 OperatingStatus;
uint16 PrimaryStatus;
uint16 EnabledState = 2;
string OtherEnabledState;
uint16 RequestedState = 12;
uint16 EnabledDefault = 2;
datetime TimeOfLastStateChange;
uint16 AvailableRequestedStates[];
uint16 TransitioningToState;
string SystemCreationClassName = "Msvm_VirtualEthernetSwitch";
string SystemName;
string CreationClassName = "Msvm_EthernetSwitchPort";
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[];
uint64 MaxQuiesceTime;
uint64 Speed;
uint64 MaxSpeed;
uint64 RequestedSpeed;
uint16 UsageRestriction;
uint16 PortType;
string OtherPortType;
string OtherNetworkPortType;
uint16 PortNumber;
uint16 LinkTechnology;
string OtherLinkTechnology;
string PermanentAddress;
string NetworkAddresses[];
boolean FullDuplex;
boolean AutoSense;
uint64 SupportedMaximumTransmissionUnit;
uint64 ActiveMaximumTransmissionUnit;
uint32 MaxDataSize;
uint16 Capabilities[];
string CapabilityDescriptions[];
uint16 EnabledCapabilities[];
string OtherEnabledCapabilities[];
uint32 VMQOffloadUsage;
uint32 IOVOffloadUsage;
};
Members
The Msvm_EthernetSwitchPort class has these types of members:
Methods
The Msvm_EthernetSwitchPort 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 virtual device. |
| RestoreProperties | This method is not supported. |
| SaveProperties | This method is not supported. |
| SetPowerState | This method is not supported. |
Properties
The Msvm_EthernetSwitchPort class has these properties.
ActiveMaximumTransmissionUnit
Data type: uint64
Access type: Read-only
Qualifiers: Units ("Bytes")
The active or negotiated maximum transmission unit (MTU) that can be supported, in bytes. This property is inherited from CIM_NetworkPort.
AdditionalAvailability
Data type: uint16 array
Access type: Read-only
Any additional availability and status of the device. This property is inherited from CIM_LogicalDevice, but it is not used.
AutoSense
Data type: boolean
Access type: Read-only
Indicates whether the port is capable of automatically determining the speed or other communications characteristics of the attached network media. This property is inherited from CIM_NetworkPort.
Availability
Data type: uint16
Access type: Read-only
The primary availability and status of the device. This property is inherited from CIM_LogicalDevice, but it is not used.
AvailableRequestedStates
Data type: uint16 array
Access type: Read-only
Indicates the possible values for the RequestedState parameter of the RequestStateChange method used to initiate a state change. The values listed will be a subset of the values contained in the RequestedStatesSupported property of the associated instance of CIM_EnabledLogicalElementCapabilities, where the values selected are a function of the current state of the CIM_EnabledLogicalElement. This property can be non-Null if an implementation is able to advertise the set of possible values as a function of the current state. This property will be Null if an implementation is unable to determine the set of possible values as a function of the current state.
This property is inherited from CIM_EnabledLogicalElement.
Enabled (2)
Disabled (3)
Shut Down (4)
Offline (6)
Test (7)
Defer (8)
Quiesce (9)
Reboot (10)
Reset (11)
DMTF Reserved (.. )
Capabilities
Data type: uint16 array
Access type: Read-only
An array that specifies the capabilities of the port. This property is inherited from CIM_EthernetPort.
Unknown (0)
Other (1)
AlertOnLan (2)
WakeOnLan (3)
FailOver (4)
LoadBalancing (5 )
CapabilityDescriptions
Data type: string array
Access type: Read-only
An array of free-form strings that provides more detailed explanations for the port features that are contained in the Capabilities array. Each entry of this array is related to the corresponding entry in the Capabilities array that is located at the same index. This property is inherited from CIM_EthernetPort.
Caption
Data type: string
Access type: Read-only
A short description of the object. This property is inherited from the CIM_ManagedElement class, and it is always set to "Ethernet Switch Port".
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.
CreationClassName
Data type: string
Access type: Read-only
The scoping system's creation class name. This property is inherited from CIM_LogicalDevice, and it is always set to "Msvm_EthernetSwitchPort".
Description
Data type: string
Access type: Read-only
A description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Microsoft Virtual Ethernet Switch Port".
DetailedStatus
Data type: uint16
Access type: Read-only
Complements the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.
DeviceID
Data type: string
Access type: Read-only
An address or other identifying information to uniquely name the logical device. This property is inherited from CIM_LogicalDevice.
ElementName
Data type: string
Access type: Read-only
A display name for the object. This property is inherited from CIM_ManagedElement.
EnabledCapabilities
Data type: uint16 array
Access type: Read-only
Specifies which capabilities are enabled from the list of all supported capabilities in the Capabilities array. This property is inherited from CIM_EthernetPort.
Unknown (0)
Other (1)
AlertOnLan (2)
WakeOnLan (3)
FailOver (4)
LoadBalancing (5 )
EnabledDefault
Data type: uint16
Access type: Read-only
An administrator's default or startup configuration for the EnabledState property 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
The enabled and disabled states of an element. This property is inherited from CIM_EnabledLogicalElement, and it will be one of the following values.
| Value | Meaning |
|---|---|
| Enabled 2 | The element is running. |
| Disabled 3 | The element is turned off. |
ErrorCleared
Data type: boolean
Access type: Read-only
Indicates whether the error reported in LastErrorCode 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 LastErrorCode and information about any corrective actions that can be taken. This property is inherited from CIM_LogicalDevice, but it is not used.
FullDuplex
Data type: boolean
Access type: Read-only
Indicates whether the port is operating in full duplex mode. This property is inherited from CIM_NetworkPort.
HealthState
Data type: uint16
Access type: Read-only
The current health of the element. This property is inherited from CIM_ManagedSystemElement, and it is always set to 5 (OK).
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, but it is not used.
InstallDate
Data type: datetime
Access type: Read-only
The date and time when the object was installed. This property does not need a value to indicate that the object is installed. 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.
IOVOffloadUsage
Data type: uint32
Access type: Read-only
The current I/O virtualization (IOV) offload usage on this port. The usage is the amount of IOV resources in use on the port.
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.
LinkTechnology
Data type: uint16
Access type: Read-only
Specifies the type of link technology for the port. When set to 1 (Other), the OtherLinkTechnology property contains a string description of the type of link. This property is inherited from CIM_NetworkPort.
Unknown (0)
Other (1)
Ethernet (2)
IB (3)
FC (4)
FDDI (5)
ATM (6)
Token Ring (7)
Frame Relay (8)
Infrared (9)
BlueTooth (10)
Wireless LAN (11 )
MaxDataSize
Data type: uint32
Access type: Read-only
The maximum size of the INFO (non-MAC) field that will be received or transmitted. This property is inherited from CIM_EthernetPort, and it is always set to 1500.
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.
MaxSpeed
Data type: uint64
Access type: Read-only
Qualifiers: Units ("Bits per Second")
The maximum bandwidth of the port, in bits per second. This property is inherited from CIM_LogicalPort.
Name
Data type: string
Access type: Read-only
The label by which the object is known. This property is inherited from CIM_ManagedSystemElement.
NetworkAddresses
Data type: string array
Access type: Read-only
Qualifiers: MaxLen ( 64 )
An array of strings that contain the MAC addresses for the port. This property is inherited from CIM_NetworkPort.
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.
OperationalStatus
Data type: uint16 array
Access type: Read-only
The current statuses of the object. This property is inherited from CIM_ManagedSystemElement, and each array element is always set to 2 (OK).
OtherEnabledCapabilities
Data type: string array
Access type: Read-only
An array of free-form strings that provides more detailed explanations for any of the enabled capabilities that are specified as 1 (Other). This property is inherited from CIM_EthernetPort.
OtherEnabledState
Data type: string
Access type: Read-only
A string that describes 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 the EnabledState property 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
Any additional data, beyond device ID information, that could be used to identify a logical device. This property is inherited from CIM_LogicalDevice, but it is not used.
OtherLinkTechnology
Data type: string
Access type: Read-only
A string value that describes LinkTechnology when it is set to 1, (Other). This property is inherited from CIM_NetworkPort.
OtherNetworkPortType
Data type: string
Access type: Read-only
The use of this property is deprecated in lieu of the PortType property. This property is inherited from CIM_NetworkPort.
OtherPortType
Data type: string
Access type: Read-only
Describes the type of module, when PortType is set to 1 (Other). This property is inherited from CIM_LogicalPort.
PermanentAddress
Data type: string
Access type: Read-only
Qualifiers: MaxLen ( 64 )
The network address that is hardcoded into a port. This hardcoded address can be changed by using a firmware upgrade or a software configuration. When this change is made, the field should be updated at the same time. This property should be Null if no hardcoded address exists for the network adapter. This property is inherited from CIM_NetworkPort.
PortNumber
Data type: uint16
Access type: Read-only
The port number. This property is inherited from CIM_NetworkPort.
PortType
Data type: uint16
Access type: Read-only
The specific mode that is currently enabled for the port. When set to 1 (Other), the related OtherPortType property contains a string description of the type of port. This property is inherited from CIM_LogicalPort.
Unknown (0)
Other (1)
//50 Copper 10BaseT (50)
10-100BaseT (51)
100BaseT (52)
1000BaseT (53)
2500BaseT (54)
10GBaseT (55)
10GBase-CX4 (56)
//100 Fibre 100Base-FX (100)
100Base-SX (101)
1000Base-SX (102)
1000Base-LX (103)
1000Base-CX (104)
10GBase-SR (105)
10GBase-SW (106)
10GBase-LX4 (107)
10GBase-LR (108)
10GBase-LW (109)
10GBase-ER (110)
10GBase-EW (111)
Vendor Reserved (16000..65535 )
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 information for the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.
RequestedSpeed
Data type: uint64
Access type: Write-only
Qualifiers: Units ("Bits per Second")
The requested bandwidth of the port, in bits per second. The actual bandwidth is reported in the Speed property. This property is inherited from CIM_LogicalPort.
RequestedState
Data type: uint16
Access type: Read-only
The last requested or desired state for the element. This property is inherited from CIM_EnabledLogicalElement, and it is always set to 12 (Not Applicable).
Speed
Data type: uint64
Access type: Read-only
Qualifiers: Units ("Bits per Second")
The bandwidth of the port, in bits per second. This property is inherited from CIM_LogicalPort.
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.
SupportedMaximumTransmissionUnit
Data type: uint64
Access type: Read-only
Qualifiers: Units ("Bytes")
The maximum transmission unit (MTU) that can be supported, in bytes. This property is inherited from CIM_NetworkPort.
SystemCreationClassName
Data type: string
Access type: Read-only
The scoping system's creation class name. This property is inherited from CIM_LogicalDevice, and it is always set to "Msvm_VirtualEthernetSwitch".
SystemName
Data type: string
Access type: Read-only
The scoping system's name. This property is inherited from CIM_LogicalDevice.
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.
UsageRestriction
Data type: uint16
Access type: Read-only
In some circumstances, a logical port might be identifiable as a front end or back end port. An example of this situation would be a storage array that might have back end ports to communicate with disk drives and front end ports to communicate with hosts. If there is no restriction on the use of the port, then the value should be set to 4 (Not restricted). This property is inherited from CIM_LogicalPort.
Unknown (0)
Front-end only (2)
Back-end only (3)
Not restricted (4 )
VMQOffloadUsage
Data type: uint32
Access type: Read-only
The current virtual machine queue (VMQ) offloading usage on this port. The usage is the amount of VMQ resources in use on the port.
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 |
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
