Msvm_ExternalEthernetPort class
Represents an external Ethernet port (network adapter). These types of Ethernet ports give virtual machines access to the external network.
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_ExternalEthernetPort : CIM_EthernetPort
{
string Caption;
string Description;
datetime InstallDate;
string Name;
uint16 OperationalStatus[] = 2;
string StatusDescriptions[] = "OK";
string Status;
uint16 HealthState = 5;
uint16 EnabledState = 5;
string OtherEnabledState;
uint16 EnabledDefault = 2;
string SystemCreationClassName;
string SystemName;
uint16 PowerManagementCapabilities[];
uint16 Availability;
uint16 StatusInfo;
uint32 LastErrorCode;
boolean ErrorCleared;
string OtherIdentifyingInfo[];
uint64 PowerOnHours;
uint64 TotalPowerOnHours;
string IdentifyingDescriptions[];
uint16 AdditionalAvailability[];
uint64 MaxQuiesceTime;
uint16 LocationIndicator;
uint64 MaxSpeed;
uint64 RequestedSpeed;
uint16 UsageRestriction;
string OtherPortType;
string OtherNetworkPortType;
string OtherLinkTechnology;
string PermanentAddress;
boolean FullDuplex;
boolean AutoSense;
uint64 SupportedMaximumTransmissionUnit;
string NetworkAddresses[];
uint16 Capabilities[];
string CapabilityDescriptions[];
uint16 EnabledCapabilities[];
string OtherEnabledCapabilities[];
string ElementName;
uint16 RequestedState = 12;
datetime TimeOfLastStateChange;
string CreationClassName;
string DeviceID;
boolean PowerManagementSupported;
string ErrorDescription;
uint64 Speed;
uint16 PortNumber;
uint16 LinkTechnology;
uint64 ActiveMaximumTransmissionUnit;
uint16 PortType;
uint32 MaxDataSize;
boolean IsBound;
};
Members
The Msvm_ExternalEthernetPort class has these types of members:
Methods
The Msvm_ExternalEthernetPort 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_ExternalEthernetPort 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
-
Qualifiers: ModelCorrespondence ("CIM_LogicalDevice.Availability")
Any additional availability and status of the device, beyond that specified in the Availability property. This property is inherited from CIM_LogicalDevice but it is not used.
-
-
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
-
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 not used.
-
-
Capabilities
-
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_EthernetPort.CapabilityDescriptions")
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 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
-
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 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
-
Qualifiers: MaxLen (64)
A short textual description (one- line string) of the object. This property is inherited from CIM_ManagedElement.
CreationClassName
The name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified. This property is inherited from CIM_LogicalDevice.
Description
-
Data type: string
-
Access type: Read-only
A textual description of the object. This property is inherited from CIM_ManagedElement.
DeviceID
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 user-friendly name for the object. This property enables each instance to define a display name in addition to its key properties, identity data, and description information. Be aware that the Name property of CIM_ManagedSystemElement is also defined as a display name. However, it is often subclassed to be a Key. The same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of logical device), the same information can be present in both the Name and ElementName properties. This property is inherited from CIM_ManagedElement.
EnabledCapabilities
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_EthernetPort.Capabilities", "CIM_EthernetPort.OtherEnabledCapabilities")
The 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/write
An administrator's default or startup configuration for the EnabledState property of an element. This property is inherited from CIM_EnabledLogicalElement and has a default value of 2 (Enabled).
The possible values are.
Enabled (2)
Disabled (3)
Not Applicable (5)
Enabled but Offline (6)
No Default (7)
Quiesce (9)
DMTF Reserved
Vendor Reserved
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. For example, shutting down (4) and starting (10) are transient states between enabled and disabled. This property is inherited from CIM_EnabledLogicalElement.
The possible values are.
Unknown (0)
Indicates that the state of the element is unknown.
Other (1)
Indicates that the state of the element is described in the OtherEnabledState property.
Enabled (2)
Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.
Disabled (3)
Indicates that the element does not execute commands and that it drops any new requests.
Shutting Down (4)
Indicates that the element is in the process of changing to a Disabled state.
Not Applicable (5)
Indicates the element does not support to be enabled or disabled.
Enabled but Offline (6)
Indicates that the element might be completing commands and that it drops any new requests.
In Test (7)
Indicates that the element is in a test state.
Deferred (8)
Indicates that the element might be completing commands, but that it queues any new requests.
Quiesce (9)
Indicates that the element is enabled but is in a restricted mode.
Starting (10)
Indicates that the element is in the process of changing to an Enabled state. New requests are queued.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
ErrorCleared
-
Data type: boolean
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus")
If TRUE, the error reported in the LastErrorCode property is now cleared. This property is inherited from CIM_LogicalDevice.
ErrorDescription
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_DeviceErrorData.ErrorDescription")
A free-form string that provides information about the error recorded in the LastErrorCode property and corrective actions to perform. This property is inherited from CIM_LogicalDevice.
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. 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).
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 but it is not used.
InstallDate
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")
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.
IsBound
-
Data type: boolean
-
Access type: Read-only
If this property is true, then this Ethernet port can be connected to the switches and thus can provide connectivity to virtual machine. If this property is false, then this Ethernet is not being used by the virtual machine networking architecture.
LastErrorCode
-
Data type: uint32
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_DeviceErrorData.LastErrorCode")
The last error code reported by the logical device. This property is inherited from CIM_LogicalDevice.
LinkTechnology
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_NetworkPort.OtherLinkTechnology")
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.
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)
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 that is part of a device. This property is inherited from CIM_LogicalDevice but it is not used.
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 it 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, in bits per second, of the port. This property is inherited from CIM_LogicalPort.
Name
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (1024)
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
-
Qualifiers:
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. (Therefore, 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.
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.
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 1 (Other.) This property is inherited from CIM_EthernetPort.
OtherEnabledState
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
A string that describes the enabled or disabled state of the element when the EnabledState property is set to1 (Other). This property must be set to null when EnabledState is any value other than 1. This property is inherited from CIM_EnabledLogicalElement.
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 but it 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 deprecated. Use the PortType property of CIM_LogicalPort. 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
-
Qualifiers: ModelCorrespondence ("CIM_LogicalPort.PortType")
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), 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. PermanentAddress 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 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 Fiber 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
PowerManagementCapabilities
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities")
An array of the specific power-related capabilities of a logical device. This property is inherited from CIM_LogicalDevice.
PowerManagementSupported
-
Data type: boolean
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities")
If TRUE, the device can be power managed, that is, put into a power-save state. If FALSE, the integer value 1 (Not Supported) should be the only entry in the PowerManagementCapabilities property array.
This property does not indicate whether power management features are currently enabled, or if enabled, which features are supported. For more information, see the PowerManagementCapabilities property array.
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.
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. Note that when EnabledState is set to 5 (Not Applicable), then this property has no meaning. By default, the RequestedState of the element is 5 (No Change). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are 10 (Reboot) and 11 (Reset). 10 (Reboot) refers to doing a 4 (Shut Down) and then moving to an 2 (Enabled) state. Reset indicates whether the element is first 3 (Disabled) and then 2 (Enabled). The distinction between requesting 4 (Shut Down) and 3 (Disabled) should also be noted. 4 (Shut Down) requests an orderly transition to the 3 (Disabled) state, and might involve removing power, to completely erase any existing state. The 3 (Disabled) state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code. A particular instance of an enabled logical element might not support RequestedStateChange. If this occurs, the value 12 (Not Applicable) is used.
Unknown (0)
Enabled (2)
Disabled (3)
Shut Down (4)
No Change (5)
Offline (6)
Test (7)
Deferred (8)
Quiesce (9)
Reboot (10)
Reset (11)
Not Applicable (12)
DMTF Reserved
Vendor Reserved
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.
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)
The current status of the object. This property is inherited from CIM_ManagedSystemElement.
StatusDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")
Strings that describes 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")
The state of the logical device. If this property does not apply to the logical device, the value 5 (Not Applicable) should be used. This property is inherited from CIM_LogicalDevice.
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
-
Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)
The creation class name of the scoping system. This property is inherited from CIM_LogicalDevice.
SystemName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)
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 enabled state 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.
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. 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 'not restricted'. This property is inherited from CIM_LogicalPort.
The possible values are.
Unknown (0)
Front-end only (2)
Back-end only (3)
Not restricted (4)
Remarks
Access to the Msvm_ExternalEthernetPort 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 |
|