Msvm_SyntheticEthernetPort class

Article
05/31/2018

Represents a synthetic Ethernet adapter. This adapter is the preferred network adapter because of its performance and 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   Caption = "Ethernet Port";
  string   Description = "Microsoft Synthetic Ethernet Port";
  string   ElementName = "Network Adapter";
  datetime InstallDate;
  string   Name = "Ethernet Port";
  uint16   OperationalStatus[] = 2;
  string   Status;
  uint16   HealthState = 5;
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  datetime TimeOfLastStateChange;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  boolean  ErrorCleared;
  uint64   PowerOnHours;
  uint64   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[] = 6;
  uint64   MaxQuiesceTime;
  uint64   MaxSpeed = 1000000000;
  uint64   RequestedSpeed = 1000000000;
  string   OtherNetworkPortType;
  uint16   PortNumber = 0;
  string   OtherLinkTechnology;
  string   PermanentAddress;
  boolean  FullDuplex = True;
  boolean  AutoSense = True;
  uint64   SupportedMaximumTransmissionUnit = 1500;
  string   NetworkAddresses[];
  string   CapabilityDescriptions[];
  uint16   EnabledCapabilities[];
  string   OtherEnabledCapabilities[];
  string   StatusDescriptions[] = "OK";
  uint16   EnabledDefault = 2;
  string   CreationClassName = "Msvm_SyntheticEthernetPort";
  string   DeviceID = "Microsoft:GUID";
  string   OtherIdentifyingInfo[];
  uint16   LocationIndicator = 4;
  uint16   UsageRestriction = 4;
  string   OtherPortType = "Virtual Ethernet";
  uint64   Speed = 1000000000;
  uint16   LinkTechnology = 2;
  uint64   ActiveMaximumTransmissionUnit = 1500;
  uint16   PortType = 1;
  uint32   MaxDataSize = 1500;
  uint16   Capabilities[];
};

Members

The Msvm_SyntheticEthernetPort class has these types of members:

Methods
Properties

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	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_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 and is always set to 1500.

AdditionalAvailability

Data type: uint16 array
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_LogicalDevice.Availability")

Additional availability and status of the device, beyond that specified in the Availability property. This property is inherited from CIM_LogicalDevice and 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 and is always set to True.

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

The primary availability and status of the device. This property is inherited from CIM_LogicalDevice and is always set to 6 (Not Applicable).

Capabilities

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_EthernetPort.CapabilityDescriptions")

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.

Unknown (0)

Other (1)

AlertOnLan (2)

WakeOnLan (3)

FailOver (4)

LoadBalancing (5)

CapabilityDescriptions

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

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
Qualifiers: MaxLen (64)

A short textual description (one- line string) of the object. This property is inherited from CIM_ManagedElement and is always set to "Ethernet Port".

CreationClassName

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

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

Description

Data type: string
Access type: Read-only

A textual description of the object. This property is inherited from CIM_ManagedElement and is always set to "Microsoft Synthetic Ethernet Port".

DeviceID

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

An address or other identifying information used to uniquely name the logical device. This property is inherited from CIM_LogicalDevice and always uses the format "Microsoft:GUID".

ElementName

Data type: string
Access type: Read-only

A user-friendly name for the object. This property is inherited from CIM_ManagedElement and is set to "Network Adapter".

EnabledCapabilities

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_EthernetPort.Capabilities", "CIM_EthernetPort.OtherEnabledCapabilities")

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 is not used.

Unknown (0)

Other (1)

AlertOnLan (2)

WakeOnLan (3)

FailOver (4)

LoadBalancing (5)

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

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 and is always set to True.

HealthState

Data type: uint16
Access type: Read-only

The current health of the element. This property is inherited from CIM_ManagedSystemElement and is always set to 5 (OK).

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

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
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

The date the Ethernet port was added to the virtual machine. 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.

LinkTechnology

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_NetworkPort.OtherLinkTechnology")

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 and is always set to 2 (Ethernet).

LocationIndicator

Data type: uint16
Access type: Read/write
Qualifiers: Experimental, ModelCorrespondence ("CIM_AlarmDevice.AlarmState", "CIM_AlarmDevice.AudioIndicatorIsDisabled", "CIM_AlarmDevice.VisualIndicatorIsDisabled", "CIM_AlarmDevice.MotionIndicatorIsDisabled")

The state of an indicator (for example, LED) that is part of a device. Reading the value gives the current state. Writing the value with 'On'/'Off' turns the indicator on/off, other values may not be written. This property is inherited from CIM_EthernetPort and is always set to 4 (Not Supported).

MaxDataSize

Data type: uint32
Access type: Read-only
Qualifiers: MappingStrings ("MIB.IETF|BRIDGE-MIB.dot1dTpPortMaxInfo")

The maximum size of the INFO (non-MAC) field that will be received or transmitted. This property is inherited from CIM_EthernetPort and is always set to 1500.

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.

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 and is always set to 1000000000.

Name

Data type: string
Access type: Read-only
Qualifiers: MaxLen (1024)

A user-friendly name for the object. This property is inherited from CIM_ManagedSystemElement and is always set to "Ethernet Port".

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 is not used.

OperationalStatus

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

The current status of the element. This property is inherited from CIM_ManagedSystemElement and is always set to 2 (OK).

OK (2)

Indicates full functionality without errors.

OtherEnabledCapabilities

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

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
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

The enabled or disabled state of the element when the EnabledState property is set to 1 (Other). This property is inherited from CIM_EnabledLogicalElement and is not used.

OtherIdentifyingInfo

Data type: string array
Access type: Read-only
Qualifiers: MaxLen (256), ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.IdentifyingDescriptions")

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
Qualifiers: ModelCorrespondence ("CIM_NetworkPort.LinkTechnology")

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
Qualifiers: Deprecated ("CIM_NetworkPort.OtherPortType"), ModelCorrespondence ("CIM_LogicalPort.PortType")

This property is inherited from CIM_NetworkPort and is set to NULL.

OtherPortType

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_LogicalPort.PortType")

The type of module, when PortType is set to 1 (Other). This property is inherited from CIM_LogicalPort and is always set to "Virtual Ethernet".

PermanentAddress

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64), MappingStrings ("MIF.DMTF|Network Adapter 802 Port|001.2")

The network address that is hardcoded into a 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 NetworkAdapter. 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 and is always set to 0.

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 and is always set to 1 (Other).

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.

RequestedSpeed

Data type: uint64
Access type: Read/write
Qualifiers: Units ("Bits per Second"), ModelCorrespondence ("CIM_LogicalPort.Speed")

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 and is always set to 1000000000.

RequestedState

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

The last requested or desired state for the management service. This property is inherited from CIM_EnabledLogicalElement and is always set to 12 (Not Applicable).

Not Applicable (12)

Indicates that this instance does not support the RequestedState property.

Speed

Data type: uint64
Access type: Read-only
Qualifiers: Units ("Bits per Second"), MappingStrings ("MIB.IETF|MIB-II.ifSpeed", "MIF.DMTF|Network Adapter 802 Port|001.5")

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 and is always set to 1000000000.

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

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 and is always set to 1500.

SystemCreationClassName

Data type: string
Access type: Read-only
Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)

The creation class name of the scoping system. This property is inherited from CIM_LogicalDevice and is always set to "Msvm_ComputerSystem".

SystemName

Data type: string
Access type: Read-only
Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)

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 and is not used.

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.

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 and is always set to 4 (Not Restricted).

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


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_SyntheticEthernetPort class

Syntax

Members

Methods

Properties

Remarks

Examples

Requirements

See also

Additional resources