Msvm_InternalEthernetPort class

Article
01/07/2021

Represents an internal Ethernet port (network adapter). This type of Ethernet port gives virtual machines access to the virtualization server running the networking software. The internal network adapters allow the virtual machines network traffic to be routed or filtered before leaving the physical system.

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_InternalEthernetPort : CIM_EthernetPort
{
  string   InstanceID;
  string   Caption = "Ethernet Port";
  string   Description = "Microsoft Internal Ethernet Port";
  string   ElementName;
  datetime InstallDate;
  string   Name;
  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_InternalEthernetPort";
  string   DeviceID;
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  boolean  ErrorCleared;
  string   OtherIdentifyingInfo[];
  uint64   PowerOnHours;
  uint16   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[] = 6;
  uint64   MaxQuiesceTime;
  uint64   MaxSpeed = 1000000000;
  uint64   RequestedSpeed = 1000000000;
  uint16   UsageRestriction = 4;
  string   OtherPortType;
  uint64   Speed;
  string   OtherNetworkPortType;
  uint16   PortNumber;
  uint16   LinkTechnology = 2;
  string   OtherLinkTechnology;
  string   PermanentAddress;
  boolean  FullDuplex = True;
  boolean  AutoSense = True;
  uint64   SupportedMaximumTransmissionUnit = 1500;
  uint64   ActiveMaximumTransmissionUnit = 1500;
  uint16   PortType;
  string   NetworkAddresses[];
  uint32   MaxDataSize = 1500;
  uint16   Capabilities[];
  string   CapabilityDescriptions[];
  uint16   EnabledCapabilities[];
  string   OtherEnabledCapabilities[];
};

Members

The Msvm_InternalEthernetPort class has these types of members:

Methods
Properties

Methods

The Msvm_InternalEthernetPort 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_InternalEthernetPort class has these properties.

ActiveMaximumTransmissionUnit

Data type: uint64
Access type: Read-only

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

Any additional availability and status of the device, beyond that specified in the Availability property. This property is inherited from CIM_LogicalDevice.

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 and 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 object. 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, but it is not used.

Capabilities

Data type: uint16 array
Access type: Read-only

Capabilities of the Ethernet port. If failover or load balancing capabilities are listed, a CIM_SpareGroup (failover) or CIM_ExtraCapacityGroup (load balancing) should also be defined to completely describe the capability. 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 any of the Ethernet port features that are indicated in the Capabilities array. Note, each entry of this array is related to the 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 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 used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified. 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, and it is set to "Microsoft:GUID\device-specific data".

ElementName

Data type: string
Access type: Read/write

A display name for the object. This property allows each instance to define a display name in addition to its key properties, identity data, and description information. This property is inherited from CIM_ManagedElement and is generated based on the NIC present in the host.

EnabledCapabilities

Data type: uint16 array
Access type: Read-only

Specifies which capabilities are enabled from the list of all supported ones, which are defined 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 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 an element. This property is inherited from CIM_EnabledLogicalElement.

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 and 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 property and 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 attribute expresses the health of this element but not necessarily that of its subcomponents. 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. Each entry of this array is related to the entry in the OtherIdentifyingInfo property array that is located at the same index. This property is inherited from CIM_LogicalDevice and is not used.

InstallDate

Data type: datetime
Access type: Read-only

A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not 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.

LastErrorCode

Data type: uint32
Access type: Read-only

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

LinkTechnology

Data type: uint16
Access type: Read-only

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.

Value	Meaning
2	Ethernet

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 has been deprecated. This property is inherited from CIM_LogicalDevice and is not used.

MaxSpeed

Data type: uint64
Access type: Read-only

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. When subclassed, this property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement.

NetworkAddresses

Data type: string array
Access type: Read-only

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

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

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.

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. For example, you could use this property to hold the operating system's display name for the 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 the LinkTechnology property 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 deprecated. Use the PortType property. This property is inherited from CIM_NetworkPort.

Deprecated description: The type of module, when the PortType property is set to 1 (Other).

OtherPortType

Data type: string
Access type: Read-only

The type of module, when the PortType property 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 a port. This 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. This 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.

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

PowerOnHours

Data type: uint64
Access type: Read-only

The number of consecutive hours that this device has been powered, since its last power cycle. This property is inherited from CIM_LogicalDevice and 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

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. When the EnabledState property is set to 5 (Not Applicable), then this property has no meaning. This property is inherited from CIM_EnabledLogicalElement.

Speed

Data type: uint64
Access type: Read-only
Qualifiers: Override, 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 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. Entries in this array are correlated with those at the same array index in OperationalStatus. This property is inherited from CIM_ManagedSystemElement.

StatusInfo

Data type: uint16
Access type: Read-only

The state of the logical device. This property is inherited from CIM_LogicalDevice and is not used.

SupportedMaximumTransmissionUnit

Data type: uint64
Access type: Read-only

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 scoping system's creation class name. This property is inherited from CIM_LogicalDevice, but it is not supported

SystemName

Data type: string
Access type: Read-only

The name of the scoping system. This property is inherited from CIM_LogicalDevice.

TimeOfLastStateChange

Data type: datetime
Access type: Read-only

The date or time when the EnabledState property of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated. This property is inherited from CIM_EnabledLogicalElement and is not used.

TotalPowerOnHours

Data type: uint16
Access type: Read-only

The total number of hours that this device has been powered. This property is inherited from CIM_LogicalDevice and 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. This property is inherited from CIM_LogicalPort.

Value	Meaning
4	Not Restricted

Remarks

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

Share via