Represents a synthetic Ethernet adapter. This adapter is the preferred network adapter because of its performance and because changes to it can take effect right away, while it is in use (hot configurability).
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_SyntheticEthernetPort : CIM_EthernetPort
{
string InstanceID;
string Caption;
string Description;
string ElementName;
datetime InstallDate;
string Name;
uint16 OperationalStatus[] = 2;
string StatusDescriptions[];
string Status;
uint16 HealthState;
uint16 CommunicationStatus;
uint16 DetailedStatus;
uint16 OperatingStatus;
uint16 PrimaryStatus;
uint16 EnabledState;
string OtherEnabledState;
uint16 RequestedState;
uint16 EnabledDefault;
datetime TimeOfLastStateChange;
uint16 AvailableRequestedStates[];
uint16 TransitioningToState;
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;
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[];
};
Members
The Msvm_SyntheticEthernetPort class has these types of members:
Methods
The Msvm_SyntheticEthernetPort 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_SyntheticEthernetPort 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. This property is inherited from CIM_NetworkPort.
AdditionalAvailability
Data type: uint16 array
Access type: Read-only
Additional availability and status of the device, beyond that specified in the Availability property. This property is inherited from CIM_LogicalDevice, and it is always set to 6 (Not Applicable).
AutoSense
Data type: boolean
Access type: Read-only
Indicates whether the network 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.
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
The capabilities of the Ethernet port. For example, the device might support AlertOnLan, WakeOnLan, Load Balancing, or FailOver. If failover or load balancing capabilities are listed, a SpareGroup (failover) or ExtraCapacityGroup (load balancing) should also be defined to completely describe the capability. This property is inherited from CIM_EthernetPort and is not used.
CapabilityDescriptions
Data type: string array
Access type: Read-only
An array of free-form strings that provides more detailed explanations for any of the EthernetPort features that are indicated in the Capabilities property array. Note, each entry of this array is related to the entry in the Capabilities property array that is located at the same index. This property is inherited from CIM_EthernetPort and is not used.
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.
CreationClassName
Data type: string
Access type: Read-only
The name of the class or the subclass that is 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
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 used 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
The capabilities that are enabled from the list of all supported ones, which are defined in the Capabilities property array. This property is inherited from CIM_EthernetPort, but it is not used.
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.
EnabledState
Data type: uint16
Access type: Read-only
The enabled and disabled states of this element. This property is inherited from CIM_EnabledLogicalElement.
ErrorCleared
Data type: boolean
Access type: Read-only
This property is inherited from CIM_LogicalDevice, but it is not used.
ErrorDescription
Data type: string
Access type: Read-only
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.
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 array. This property is inherited from CIM_LogicalDevice and is not used.
InstallDate
Data type: datetime
Access type: Read-only
The date the Ethernet port was added to the virtual machine. 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
This property is inherited from CIM_LogicalDevice, but it is not used.
LinkTechnology
Data type: uint16
Access type: Read-only
An enumeration of the types of links. When set to 1 (Other), the related property OtherLinkTechnology contains a string description of the type of link. This property is inherited from CIM_NetworkPort.
Ethernet (2)
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.
MaxQuiesceTime
Data type: uint64
Access type: Read-only
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
A display name for the object. This property is inherited from CIM_ManagedSystemElement.
NetworkAddresses
Data type: string array
Access type: Read-only
Ethernet/802.3 MAC addresses formatted as twelve hexadecimal digits (for example, "010203040506"), with each pair representing one of the six octets of the MAC address in canonical bit order (the Group address bit is found in the low order bit of the first character of the string). This property is inherited from CIM_EthernetPort, and it is not used.
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 status of the element. This property is inherited from CIM_ManagedSystemElement, and it 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 "Other". This property is inherited from CIM_EthernetPort and is not used.
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 is inherited from CIM_EnabledLogicalElement.
OtherIdentifyingInfo
Data type: string array
Access type: Read-only
Any data, in addition to device ID information, that could be used to identify a logical device. This property is inherited from CIM_LogicalDevice and 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
This property is inherited from CIM_NetworkPort and is set to Null.
OtherPortType
Data type: string
Access type: Read-only
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
The network address that is hardcoded into the port. This hardcoded address can be changed using a firmware upgrade or a software configuration. When this change is made, the field should be updated at the same time. The PermanentAddress property should be left blank if no hardcoded address exists for the network adapter. This property is inherited from CIM_NetworkPort.
PortNumber
Data type: uint16
Access type: Read-only
Network ports are often numbered relative to either a logical module or a network element. This value is 1 for emulated NICs, 0 for all others. 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 property OtherPortType contains a string description of the type of port. This property is inherited from CIM_EthernetPort.
PowerManagementCapabilities
Data type: uint16 array
Access type: Read-only
This property is inherited from CIM_LogicalDevice, but it is not used.
PowerManagementSupported
Data type: boolean
Access type: Read-only
This property is inherited from CIM_LogicalDevice, but it is not used.
PowerOnHours
Data type: uint64
Access type: Read-only
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: Read-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 management service. This property is inherited from CIM_EnabledLogicalElement.
Speed
Data type: uint64
Access type: Read-only
Qualifiers: Units ("Bits per Second")
The current bandwidth of the port, in bits per second. For ports that vary in bandwidth or for those where no accurate estimation can be made, this property should contain the nominal bandwidth. This property is inherited from CIM_NetworkPort.
Status
Data type: string
Access type: Read-only
The current status of the element. This property is inherited from CIM_ManagedSystemElement.
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
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. This property is inherited from CIM_NetworkPort.
SystemCreationClassName
Data type: string
Access type: Read-only
The creation class name of the scoping system. This property is inherited from CIM_LogicalDevice.
SystemName
Data type: string
Access type: Read-only
The NetBIOS name of the hosting computer system. This property will contain the virtual machine ID in GUID form. 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.
TotalPowerOnHours
Data type: uint64
Access type: Read-only
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.
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. 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.
Remarks
Access to the Msvm_SyntheticEthernetPort class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.
Examples
See Querying networking objects.
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
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.
