CIM_LANEndpoint class

A communication endpoint which, when its associated interface device is connected to a LAN, may send and receive data frames. LAN endpoints include Ethernet, Token Ring, and FDDI interfaces.

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 of the inherited properties.

Syntax

class CIM_LANEndpoint : CIM_ProtocolEndpoint
{
  boolean BroadcastResetSupported;
  string  OtherTypeDescription;
  uint16  ProtocolType;
  string  NameFormat;
  string  Name;
  string  LANID;
  uint16  LANType;
  string  OtherLANType;
  string  MACAddress;
  string  AliasAddresses[];
  string  GroupAddresses[];
  uint32  MaxDataSize;
  uint16  ProtocolIFType;
};

Members

The CIM_LANEndpoint class has these types of members:

Properties

The CIM_LANEndpoint class has these properties.

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

Other unicast addresses that may be used to communicate with the LAN endpoint.

BroadcastResetSupported
Data type: boolean
Access type: Read-only

A boolean that indicates whether the instrumentation supports the BroadcastReset method.

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

Multicast addresses to which the LAN endpoint listens.

LANID
Data type: string
Access type: Read-only

A label or identifier for the LAN Segment to which the endpoint is connected. If the endpoint is not currently active/connected or this information is not known, then LANID is NULL.

LANType
Data type: uint16
Access type: Read-only

An indication of the kind of technology used on the LAN. This property is deprecated in lieu of ProtocolType, which is an enumeration inherited from ProtocolEndpoint and which includes the values specified here.

Unknown (0)
Other (1)
Ethernet (2)
TokenRing (3)
FDDI (4)
MACAddress
Data type: string
Access type: Read-only
Qualifiers: MaxLen ( 12)

The principal unicast address used in communication with the LAN endpoint. The MAC address is 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 according to RFC 2469.

MaxDataSize
Data type: uint32
Access type: Read-only
Qualifiers: Units ( "Bits" )

The largest information field that may be sent or received by the LAN endpoint.

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

A string that identifies this protocol endpoint with either a port or an interface on a device. To ensure uniqueness, the Name property should be prepended or appended with information from the Type or OtherTypeDescription properties. The method selected is described in the NameFormat property of this class.

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

The naming heuristic that is used to ensure that the value of the Name property is unique. For example, you can choose to prepend the name of the port or interface with the Type of ProtocolEndpoint (for example, IPv4) of this instance followed by an underscore.

OtherLANType
Data type: string
Access type: Read-only

A free-form string that describes the type of technology used on the LAN when the value of the LANType property is equal to 1 (that is, "Other"). This property is deprecated because its purpose overlaps with OtherTypeDescription, which is inherited from ProtocolEndpoint.

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

A string that describes the type of protocol endpoint when the Type property of this class (or any of its subclasses) is set to 1 (Other). This property should be set to NULL when the Type property is any value other than 1.

ProtocolIFType
Data type: uint16
Access type: Read-only

The ProtocolIFType enumeration is limited to Layer 2-related and reserved values for this subclass of ProtocolEndpoint.

Other (1)
Ethernet CSMA/CD (6)
ISO 802.5 Token Ring (9)
FDDI (15)
IANA Reserved (225..4095)
DMTF Reserved (4301..32767)
Vendor Reserved (32768..)
ProtocolType
Data type: uint16
Access type: Read-only

Note: This property is deprecated in lieu of the ProtocolIFType enumeration. This deprecation was done to better align the IF-MIB of the IETF and this CIM class. Deprecated description: ProtocolType is an enumeration that provides information to categorize and classify different instances of this class. For most instances, information in this enumeration and the definition of the subclass overlap. However, there are several cases where a specific subclass of ProtocolEndpoint is not required (for example, there is no Fibre Channel subclass of ProtocolEndpoint). Therefore, this property is required to define the type of Endpoint.

Unknown (0)
Other (1)
IPv4 (2)
IPv6 (3)
IPX (4)
AppleTalk (5)
DECnet (6)
SNA (7)
CONP (8)
CLNP (9)
VINES (10)
XNS (11)
ATM (12)
Frame Relay (13)
Ethernet (14)
TokenRing (15)
FDDI (16)
Infiniband (17)
Fibre Channel (18)
ISDN BRI Endpoint (19)
ISDN B Channel Endpoint (20)
ISDN D Channel Endpoint (21)
IPv4/v6 (22)
BGP (23)
OSPF (24)
MPLS (25)
UDP (26)
TCP (27)

Remarks

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

Namespace

Root\CIMV2

See also

CIM_ProtocolEndpoint

 

 

Show: