CIM_EthernetPort class

Article
05/31/2018

Represents an ethernet port.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Abstract, Version("2.10.0"), UMLPackagePath("CIM::Device::Ports")]
class CIM_EthernetPort : CIM_NetworkPort
{
  string   InstanceID;
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  string   Name;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  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 = 12;
  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[];
  uint64   MaxQuiesceTime;
  uint64   MaxSpeed;
  uint64   RequestedSpeed;
  uint16   UsageRestriction;
  string   OtherPortType;
  uint64   Speed;
  string   OtherNetworkPortType;
  uint16   PortNumber;
  uint16   LinkTechnology;
  string   OtherLinkTechnology;
  string   PermanentAddress;
  boolean  FullDuplex;
  boolean  AutoSense;
  uint64   SupportedMaximumTransmissionUnit;
  uint64   ActiveMaximumTransmissionUnit;
  uint16   PortType;
  string   NetworkAddresses[];
  uint32   MaxDataSize;
  uint16   Capabilities[];
  string   CapabilityDescriptions[];
  uint16   EnabledCapabilities[];
  string   OtherEnabledCapabilities[];
};

Members

The CIM_EthernetPort class has these types of members:

Methods
Properties

Methods

The CIM_EthernetPort class has these methods.

Method	Description
EnableDevice	This method is deprecated. Instead we recommend that you use the RequestStateChange method. This method is inherited from CIM_LogicalDevice. Deprecated description: Enables or disables the logical device.
OnlineDevice	This method is deprecated. Instead we recommend that you use the RequestStateChange method. This method is inherited from CIM_LogicalDevice. Deprecated description: Brings the logical device online so it can accept requests, or offline so it can no longer accept requests.
QuiesceDevice	This method is deprecated. Instead we recommend that you use the RequestStateChange method. This method is inherited from CIM_LogicalDevice. Deprecated description: Temporarily suspends activity on the logical device, or re-enables the activity.
RequestStateChange	Requests that the state of the element be changed to the specified value. This method is inherited from CIM_EnabledLogicalElement.
Reset	Resets the logical device. This method is inherited from CIM_LogicalDevice.
RestoreProperties	Restores a previous configuration and state of the logical device. This method is inherited from CIM_LogicalDevice.
SaveProperties	Saves the configuration and state of the logical device. This method is inherited from CIM_LogicalDevice.
SetPowerState	Instead we recommend that you use the SetPowerState property of the CIM_PowerManagementService class. This method is inherited from CIM_LogicalDevice. Deprecated description: Sets the power state of the logical device.

Properties

The CIM_EthernetPort class has these properties.

ActiveMaximumTransmissionUnit

Data type: uint64
Access type: Read-only
Qualifiers: Units ("Bytes"), PUnit ("byte")

The active or negotiated maximum transmission unit (MTU) that is supported by the port.

This property is inherited from CIM_NetworkPort.

AdditionalAvailability

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

An array that contains availability information about of the logical device, in addition to the that of the Availability property.

This property is inherited from CIM_LogicalDevice.

The possible values are:

Other (1)

Unknown (2)

Running/Full Power (3)

Warning (4)

In Test (5)

Not Applicable (6)

Power Off (7)

Off Line (8)

Off Duty (9)

Degraded (10)

Not Installed (11)

Install Error (12)

Power Save - Unknown (13)

Power Save - Low Power Mode (14)

Power Save - Standby (15)

Power Cycle (16)

Power Save - Warning (17)

Paused (18)

Not Ready (19)

Not Configured (20)

Quiesced (21)

Quiescent

AutoSense

Data type: boolean
Access type: Read-only

true if the port can automatically determine the speed or other communications characteristic of the attached network media; otherwise, false.

This property is inherited from CIM_NetworkPort.

Availability

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Operational State|006.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus", "MIF.DMTF|Host Device|001.5"), ModelCorrespondence ("CIM_LogicalDevice.AdditionalAvailability")

Deprecated description: Contains the availability of the logical device.

This property is deprecated. Instead we recommend that you use the CIM_PowerManagementCapabilities class.

This property is inherited from CIM_LogicalDevice.

This property contains the following values:

Other (1)

Unknown (2)

Running/Full Power (3)

Warning (4)

In Test (5)

Not Applicable (6)

Power Off (7)

Off Line (8)

Off Duty (9)

Degraded (10)

Not Installed (11)

Install Error (12)

Power Save - Unknown (13)

Power Save - Low Power Mode (14)

Power Save - Standby (15)

Power Cycle (16)

Power Save - Warning (17)

Paused (18)

Not Ready (19)

Not Configured (20)

Quiesced (21)

AvailableRequestedStates

Data type: uint16 array
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.RequestStateChange", "CIM_EnabledLogicalElementCapabilities.RequestedStatesSupported")

Indicates the possible values for the RequestedState parameter of the RequestStateChange method.

The listed values must be a subset of the values that are contained in the RequestedStatesSupported property of the associated CIM_EnabledLogicalElementCapabilities instance. This property is NULL if the implementation cannot determine the set of possible values for the current state of the element.

This property is inherited from CIM_EnabledLogicalElement.

The possible values are.

Enabled (2)

Disabled (3)

Shut Down (4)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

DMTF Reserved

12 65535

Capabilities

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

The capabilities of the ethernet port.

Note

If failover or load balancing capabilities are enabled, a CIM_SpareGroup (failover) or CIM_ExtraCapacityGroup (load balancing) object should also be defined to completely describe the capability.

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 features that are indicated in the Capabilities array. The items in this array correspond to the items in the Capabilities array.

Caption

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

A short textual 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 this element. A NULL value indicates that instrumentation does not support this property.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Indicates that the instrumentation cannot report on the CommunicationStatus property at this time.

Not Available (1)

Indicates that the instrumentation is capable of reporting this property, but intentionally does not for this element.

Communication OK (2)

Indicates only that communication is established with the element.

Lost Communication (3)

Indicates that the element has been contacted in the past, but is currently unreachable.

No Contact (4)

Indicates that the instrumentation has contact information for this element, but has never been able to communicate with it.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

CreationClassName

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

The class name used to create an instance of the logical device. CreationClassName is combined with other key properties of this class to uniquely identify instances of this class and its subclasses.

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.

DetailedStatus

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.PrimaryStatus", "CIM_ManagedSystemElement.HealthState")

Indicates additional status details that complement the PrimaryStatus property. A NULL value indicates that the instrumentation does not support this property.

This property is inherited from CIM_ManagedSystemElement.

Not Available (0)

Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.

No Additional Information (1)

Indicates that no details have to be added to the PrimaryStatus property, for example when the PrimaryStatus is set to OK.

Stressed (2)

Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.

Predictive Failure (3)

Indicates that an element functions nominally, but predicts a failure in the near future.

Non-Recoverable Error (4)

Indicates that this element is in an error condition that requires human intervention.

Supporting Entity in Error (5)

Indicates that an element on which this element depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

DeviceID

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

A unique identifier of the logical device, such as the address.

This property is inherited from CIM_LogicalDevice.

ElementName

Data type: string
Access type: Read-only

A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.

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

Indicates which capabilities are enabled in the Capabilities array. The items in this array correspond to the items in the Capabilities array.

Unknown (0)

Other (1)

AlertOnLan (2)

WakeOnLan (3)

FailOver (4)

LoadBalancing (5)

EnabledDefault

Data type: uint16
Access type: Read/write

Indicates an administrator's default or startup configuration for the enabled state of an element. The default value Enabled (2).

This property is inherited from CIM_EnabledLogicalElement.

The possible values are.

Enabled (2)

Disabled (3)

Not Applicable (5)

Enabled but Offline (6)

No Default (7)

Quiesce (9)

DMTF Reserved

10 32767

Vendor Reserved

32768 65535

EnabledState

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

Indicates the enabled state of an element. Possible values include the transitions between states. For example, Shutting Down (4) and Starting (10) are transient states between Enabled and Disabled.

This property is inherited from CIM_EnabledLogicalElement.

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

Deprecated description: Indicates whether an error reported by the LastErrorCode property is cleared.

This property is deprecated. Instead we recommend that you use the OperationalStatus property from the CIM_ManagedSystemElement class.

This property is inherited from CIM_LogicalDevice.

ErrorDescription

Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_DeviceErrorData.ErrorDescription")

Deprecated description: Additional information about the error reported by the LastErrorCode property.

This property is deprecated. Instead we recommend that you use the ErrorDescription property from the CIM_DeviceErrorData class.

This property is inherited from CIM_LogicalDevice.

FullDuplex

Data type: boolean
Access type: Read-only

true if the port is operating in full duplex mode; otherwise, false.

This property is inherited from CIM_NetworkPort.

HealthState

Data type: uint16
Access type: Read-only

Indicates the current health of the element. This attribute expresses the health of this element, but not necessarily the health of its subcomponents.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

The implementation cannot report on HealthState at this time.

OK (5)

The element is fully functional and operates within normal operational parameters and without error.

Degraded/Warning (10)

The element is in working order, and all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.

Minor failure (15)

All functionality is available, but some functionality might be degraded.

Major failure (20)

The element is failing. It is possible that some or all of the functionality of this component is degraded or does not work.

Critical failure (25)

The element is nonfunctional, and recovery might not be possible.

Non-recoverable error (30)

The element has completely failed, and recovery is not possible. All functionality that this element provides has been lost.

DMTF Reserved

Reserved.

IdentifyingDescriptions

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

An array of strings that describe the OtherIdentifyingInfo array items of the same index.

This property is inherited from CIM_LogicalDevice.

InstallDate

Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

Indicates when the object was installed. The 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

Uniquely and opaquely identifies an instance of this class within the scope of the containing namespace.

[!Important]

In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID

OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID, or be a registered ID that is assigned by a recognized global authority. This pattern is similar to the structure of schema class names. In addition, to ensure uniqueness, the first colon in InstanceID must be between the OrgID andLocalID. Therefore the OrgID must not contain a colon (':').

LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.

If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.

For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.

This property is inherited from CIM_ManagedElement.

LastErrorCode

Data type: uint32
Access type: Read-only
Qualifiers: Deprecated ("CIM_DeviceErrorData.LastErrorCode")

Deprecated description: The last error code reported by the logical device.

This property is deprecated. Instead we recommend that you use the LastErrorCode property from theCIM_DeviceErrorData class.

This property is inherited from CIM_LogicalDevice.

LinkTechnology

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

The link technology used by the port. When set to "1" (other), the OtherLinkTechnology property contains a description of the link type.

This property is inherited from CIM_NetworkPort.

The possible values are:

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
Qualifiers: MappingStrings ("MIB.IETF|BRIDGE-MIB.dot1dTpPortMaxInfo")

The maximum size of the INFO (non-MAC) field that will be received or transmitted.

MaxQuiesceTime

Data type: uint64
Access type: Read-only
Qualifiers: Deprecated ("No value"), Units ("MilliSeconds")

Deprecated description: The maximum time in milliseconds, that a device can remain in a temporarily disabled state (Availability and AdditionalAvailability properties set to "21" quiescent ). A value of "0" indicates that the logical device can remain in a temporarily disabled state indefinitely.

This property is deprecated and should not be used.

This property is inherited from CIM_LogicalDevice.

MaxSpeed

Data type: uint64
Access type: Read-only
Qualifiers: Units ("Bits per Second"), PUnit ("bit / 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
Qualifiers: MaxLen (1024)

The label by which the object is known. When subclassed, the Name 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: Override ("NetworkAddresses")

The network addresses assigned to the port. The address is a 802.3 MAC that is formatted as twelve hexadecimal digits (for example, "010203040506"), where each pair of digits represents one of the six octets of the MAC address in canonical bit order.

OperatingStatus

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

Indicates the current operational condition of the element. This property can be used to provide more detail about the value of the EnabledState property. A NULL value indicates that the instrumentation does not support this property.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Indicates that the instrumentation cannot report on the OperatingStatus property at this time.

Not Available (1)

Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.

Servicing (2)

Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.

Starting (3)

Indicates that the element is being initialized.

Stopping (4)

Indicates that the element is being brought to an orderly stop.

Stopped (5)

Indicates that the element is intentionally stopped.

Aborted (6)

Indicates that the element stopped in an unexpected way.

Dormant (7)

Indicates that the element is inactive.

Completed (8)

Indicates that the element completed its operation. We recommend using a PrimaryStatus property value of OK, Error, or Degraded to indicate success or failure of the operation.

Migrating (9)

Indicates that the element is being moved between host elements.

Emigrating (10)

Indicates that the element is being moved away from the host element.

Immigrating (11)

Indicates that the element is being moved to a new host element.

Snapshotting (12)

Indicates that a snapshot copy of the element is being created.

Shutting Down (13)

Indicates that the element is being brought to an abrupt stop.

In Test (14)

Indicates that the element is performing test functions.

Transitioning (15)

Indicates that the element is between states and is not fully available in either state. Use another value that indicates a more specific transition if one is available.

In Service (16)

Indicates that the element is in service and operational.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

OperationalStatus

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

Contains indicators of the current status of the element. The first value of the OperationalStatus property should contain the primary status for the element.

Note

The OperationalStatus property replaces the deprecated Status property. Due to the widespread use of the existing Status property in management applications, we strongly recommend that providers or instrumentation provide both the Status and OperationalStatus properties. When instrumented, Status, because it is a single-valued property, should also provide the primary status of the element.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Indicates that the implementation cannot report on the OperationalStatus property at this time.

Other (1)

Indicates an undefined state.

OK (2)

Indicates full functionality without errors.

Degraded (3)

Indicates that the element is in working order and that all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.

Stressed (4)

Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.

Predictive Failure (5)

Indicates that an element functions nominally, but predicts a failure in the near future.

Error (6)

Indicates that an error has occurred.

Non-Recoverable Error (7)

Indicates that a nonrecoverable error has occurred.

Starting (8)

Indicates that the job is starting.

Stopping (9)

Indicates that the job is stopping.

Stopped (10)

Indicates that the element has been intentionally stopped.

In Service (11)

Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.

No Contact (12)

Indicates that the monitoring system has information about this element, but has never been able to establish communications with it.

Lost Communication (13)

Indicates that the monitoring system has successfully contacted this element in the past, but it is currently unavailable.

Aborted (14)

Indicates that the job stopped in an unexpected way. The state and configuration of the job might require an update.

Dormant (15)

Indicates that the job is inactive.

Supporting Entity in Error (16)

Indicates that an element on which this job depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.

Completed (17)

Indicates that the job has completed its operation. This value should be combined with either OK, Error, or Degraded to indicate to a client whether the complete operation Completed with OK and passed, or completed with Error and failed, or completed with Degraded and finished the operation, but did not complete OK or did not report an error.

Power Mode (18)

Indicates that the element has additional power model information that is contained in the associated power management service.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

OtherEnabledCapabilities

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

An array of free-form strings that provide more detailed explanations for any of the EnabledCapabilities array items that are set to 1 (Other). The items in this array correspond to the items in the EnabledCapabilities array.

OtherEnabledState

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

Describes the state of the element when the value of the EnabledState property is Other. This property must be set to NULL when EnabledState is not Other.

This property is inherited from CIM_EnabledLogicalElement.

OtherIdentifyingInfo

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

Information that identifies the logical device, other than DeviceID.

This property is inherited from CIM_LogicalDevice.

OtherLinkTechnology

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_NetworkPort.LinkTechnology")

The link technology when LinkTechnology 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")

Note

Deprecated description: The module type of the port, when the PortType property contains 1 (other).

This property is deprecated. Instead, we recommend the PortType property in the CIM_LogicalPort class.

This property is inherited from CIM_NetworkPort.

OtherPortType

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

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), MappingStrings ("MIF.DMTF|Network Adapter 802 Port|001.2")

The network address that is hardcoded into a port. The hardcoded address can be changed using a firmware upgrade or a software configuration. When this change is made, this property should be updated at the same time. PermanentAddress should be left blank if the address doesn't exist.

This property is inherited from CIM_NetworkPort.

PortNumber

Data type: uint16
Access type: Read-only

The port number of the network port. 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
Qualifiers: Override ("PortType")

The mode that is enabled on the port. When set to 1 (Other), the OtherPortType property describes the mode.

Unknown (0)

Other (1)

10BaseT (50)

10-100BaseT (51)

100BaseT (52)

1000BaseT (53)

2500BaseT (54)

10GBaseT (55)

10GBase-CX4 (56)

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

Reserved.

PowerManagementCapabilities

Data type: uint16 array
Access type: Read-only
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities")

Deprecated description: An array that contains the power management capabilities of the device.

This property is deprecated. Instead we recommend that you use the CIM_PowerManagementCapabilities class.

This property is inherited from CIM_LogicalDevice.

This array contains the following values:

Unknown (0)

Not Supported (1)

Disabled (2)

Enabled (3)

Power Saving Modes Entered Automatically (4)

Power State Settable (5)

Configurable Power State

Power Cycling Supported (6)

Timed Power On Supported (7)

PowerManagementSupported

Data type: boolean
Access type: Read-only
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities")

Deprecated description: true if the logical device can be power managed; otherwise, false.

This property is deprecated. Instead, you should use the PowerManagementCapabilities class.

This property is inherited from CIM_LogicalDevice.

PowerOnHours

Data type: uint64
Access type: Read-only
Qualifiers: Units ("Hours"), Counter

The number of consecutive hours the logical device has been powered, since its last power cycle.

This property is inherited from CIM_LogicalDevice.

PrimaryStatus

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ManagedSystemElement.DetailedStatus", "CIM_ManagedSystemElement.HealthState")

Indicates a high-level status value.

This property is inherited from CIM_ManagedSystemElement.

The possible values are.

Unknown (0)

OK (1)

Degraded (2)

Error (3)

DMTF Reserved

4 32767

Vendor Reserved

32768 65535

RequestedSpeed

Data type: uint64
Access type: Read/write
Qualifiers: Units ("Bits per Second"), ModelCorrespondence ("CIM_LogicalPort.Speed"), PUnit ("bit / 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
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

Indicates the last requested state for the element. The current state is indicated by the EnabledState property. This property enables you to compare the last requested and current states.

Note

When the value of the EnabledState property is Not Applicable, this property has no meaning.

This property is inherited from CIM_EnabledLogicalElement.

Unknown (0)

Indicates the last requested state for the element is unknown.

Enabled (2)

Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.

Disabled (3)

Indicates a request to immediately disable the element, such that it does not execute or accept any commands or processing requests.

Shut Down (4)

Indicates a request for an orderly transition to the Disabled state, and might require you to shut off the power to completely erase any existing state.

No Change (5)

No state change has been requested.

Offline (6)

Indicates a request to change to the Enabled but Offline state.

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.

Reboot (10)

Indicates a request to shut down and then change to an Enabled state.

Reset (11)

Indicates a request to change to a Disabled state and then change to an Enabled state.

Not Applicable (12)

Indicates that this instance does not support the RequestedState property.

DMTF Reserved

Reserved.

Vendor Reserved

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"), PUnit ("bit / 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
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

Indicates the primary status of the object.

Note

This property is deprecated. It is replaced by the OperationalStatus property. If you choose to use the Status property for backward compatibility, it should be secondary to the OperationalStatus property.

This property is inherited from CIM_ManagedSystemElement.

The possible values are.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

("Stressed")

("NonRecover")

("No Contact")

("Lost Comm")

("Stopped")

StatusDescriptions

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

Indicates descriptions of the corresponding values in the OperationalStatus array. For example, if an element in the OperationalStatus property contains the value Stopping, then the element at the same array index in this property might contain an explanation as to why an object is being stopped.

This property is inherited from CIM_ManagedSystemElement.

StatusInfo

Data type: uint16
Access type: Read-only
Qualifiers: Deprecated ("CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.4")

Deprecated description: Indicates whether the logical device is enabled or in a related state.

This property is deprecated. Instead we recommend that you use the CIM_PowerManagementCapabilities class.

This property is inherited from CIM_LogicalDevice.

The possible values are:

Other (1)

Unknown (2)

Enabled (3)

Disabled (4)

Not Applicable (5)

SupportedMaximumTransmissionUnit

Data type: uint64
Access type: Read-only
Qualifiers: Units ("Bytes"), PUnit ("byte")

The maximum transmission unit (MTU) that is supported by the port.

This property is inherited from CIM_NetworkPort.

SystemCreationClassName

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

The class name used to create an instance of the system that contains the logical device. SystemCreationClassName is combined with other key properties of this class to uniquely identify instances of this class and its subclasses.

This property is inherited from CIM_LogicalDevice.

SystemName

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

The name of the system that contains the logical device.

This property is inherited from CIM_LogicalDevice.

TimeOfLastStateChange

Data type: datetime
Access type: Read-only

Indicates when the element last changed state. If the state of the element has not changed and this property is populated, then it must be set to a zero interval value. If a state change was requested, but was rejected or is not yet processed, the property must not be updated.

This property is inherited from CIM_EnabledLogicalElement.

TotalPowerOnHours

Data type: uint64
Access type: Read-only
Qualifiers: Units ("Hours"), Counter

The total number of hours the logical device has been powered.

This property is inherited from CIM_LogicalDevice.

TransitioningToState

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

Indicates the target state to which the instance is changing.

A value of No Change indicates that no transition is in progress. A value of Not Applicable indicates that the implementation does not report ongoing transitions.

This property is inherited from CIM_EnabledLogicalElement.

The possible values are.

Unknown (0)

Enabled (2)

Disabled (3)

Shut Down (4)

No Change (5)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

Not Applicable (12)

DMTF Reserved

13 65535

UsageRestriction

Data type: uint16
Access type: Read-only

Indicates whether the port is restricted to being a front-end or back-end port.

This property is inherited from CIM_LogicalPort.

The possible values are:

Unknown (0)

Front-end only (2)

Back-end only (3)

Not restricted (4)

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2016
Namespace	Root\HyperVCluster\v2
MOF	WindowsHyperVCluster.V2.mof
DLL	VMMS.exe

Share via

CIM_EthernetPort class

Syntax

Members

Methods

Properties

Requirements

See also

Additional resources