Windows desktop applications
Collapse the table of content
Expand the table of content

CIM_EthernetPort class

Capabilities and management of an ethernet port.

Important  The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

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

Syntax

class CIM_EthernetPort : CIM_NetworkPort
{
  uint64  ActiveMaximumTransmissionUnit;
  uint64  SupportedMaximumTransmissionUnit;
  boolean AutoSense;
  boolean FullDuplex;
  string  NetworkAddresses[];
  string  PermanentAddress;
  string  OtherLinkTechnology;
  uint16  LinkTechnology;
  uint16  PortNumber;
  string  OtherNetworkPortType;
  uint64  Speed;
  uint16  PortType;
  uint32  MaxDataSize;
  uint16  Capabilities[];
  string  CapabilityDescriptions[];
  uint16  EnabledCapabilities[];
  string  OtherEnabledCapabilities[];
};

Members

The CIM_EthernetPort class has these types of members:

Properties

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

AutoSense
Data type: boolean
Access type: Read-only

A Boolean that indicates whether the network port is capable of automatically determining the speed or other communications characteristics of the attached network media.

Capabilities
Data type: uint16 array
Access type: Read-only

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.

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. Be aware that each entry of this array is related to the entry in the Capabilities array that is located at the same index.

EnabledCapabilities
Data type: uint16 array
Access type: Read-only

Specifies which capabilities are enabled from the list of those supported, which are defined in the Capabilities array.

Unknown (0)
Other (1)
AlertOnLan (2)
WakeOnLan (3)
FailOver (4)
LoadBalancing (5)
FullDuplex
Data type: boolean
Access type: Read-only

Boolean that indicates that the port is operating in full duplex mode.

LinkTechnology
Data type: uint16
Access type: Read-only

An enumeration of the types of links. When set to 1 ("Other"), the related property OtherLinkTechnology contains a string description of the type of link.

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

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

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

An array of strings that indicate the network addresses for the port.

The network addresses are 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.)

OtherEnabledCapabilities
Data type: string array
Access type: Read-only

An array of free-form strings that provides more detailed explanations for any of the enabled capabilities that are specified as 'Other'.

OtherLinkTechnology
Data type: string
Access type: Read-only

A string value that describes LinkTechnology when it is set to 1, "Other".

OtherNetworkPortType
Data type: string
Access type: Read-only

Note: The use of this property is deprecated in lieu of CIM_LogicalPort.PortType. Deprecated description: The type of module, when PortType is set to 1 ("Other".)

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

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.

PortNumber
Data type: uint16
Access type: Read-only

Network ports are often numbered relative to either a logical module or a network element.

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.

Unknown (0)
Other (1)
Copper 10BaseT (50)
10-100BaseT (51)
100BaseT (52)
1000BaseT (53)
2500BaseT (54)
10GBaseT (55)
10GBase-CX4 (56)
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 (16000..65535)
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.

SupportedMaximumTransmissionUnit
Data type: uint64
Access type: Read-only
Qualifiers: Units ( "Bytes" )

The maximum transmission unit (MTU) that can be supported.

Requirements

Namespace

Root\CIMV2

See also

CIM_NetworkPort

 

 

Show:
© 2016 Microsoft