MSFT_NetIPInterface class

Represents a TCP/IP (Internet Protocol Suite) network Interface.

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

Syntax

[UMLPackagePath("CIM::Network::ProtocolEndpoints"), ClassVersion("1.0.0"), dynamic, provider("nettcpip"), AMENDMENT]
class MSFT_NetIPInterface : CIM_LANEndpoint
{
  string   InstanceID;
  string   Caption;
  string   ElementName;
  datetime InstallDate;
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  uint16   TransitioningToState = 12;
  uint16   AvailableRequestedStates[];
  string   SystemCreationClassName;
  string   SystemName;
  string   CreationClassName;
  string   Description;
  string   Name;
  uint16   OperationalStatus[];
  uint16   EnabledState;
  datetime TimeOfLastStateChange;
  string   NameFormat;
  uint16   ProtocolType;
  uint16   ProtocolIFType;
  string   OtherTypeDescription;
  string   LANID;
  uint16   LANType;
  string   OtherLANType;
  string   MACAddress;
  string   AliasAddresses[];
  string   GroupAddresses[];
  uint32   MaxDataSize;
  uint32   InterfaceIndex;
  string   InterfaceAlias;
  uint16   AddressFamily;
  uint8    Forwarding;
  uint8    Advertising;
  uint32   NlMtu;
  uint32   InterfaceMetric;
  uint8    NeighborUnreachabilityDetection;
  uint32   BaseReachableTime;
  uint32   RetransmitTime;
  uint32   DadTransmits;
  uint8    RouterDiscovery;
  uint8    ManagedAddressConfiguration;
  uint8    OtherStatefulConfiguration;
  uint8    WeakHostSend;
  uint8    WeakHostReceive;
  uint8    IgnoreDefaultRoutes;
  datetime AdvertisedRouterLifetime;
  uint8    AdvertiseDefaultRoute;
  uint32   CurrentHopLimit;
  uint8    Store;
  uint8    ForceArpNdWolPattern;
  uint8    DirectedMacWolPattern;
  uint8    EcnMarking;
  uint8    Dhcp;
  uint32   ReachableTime;
  uint8    AutomaticMetric;
  uint8    NeighborDiscoverySupported;
  uint8    ConnectionState;
  uint32   DadRetransmitTime;
  uint32   CompartmentId;
  uint32   IsolationId;
  uint64   LowestIfNetLuid;
};

Members

The MSFT_NetIPInterface class has these types of members:

• Methods
• Properties

Methods

The MSFT_NetIPInterface class has these methods.

Properties

The MSFT_NetIPInterface class has these properties.

AddressFamily

Data type: uint16

Access type: Read-only

Gets a value that indicates whether the interface uses the IPv4 or IPv6 address family. This property gets one of the following values.

Value	Meaning
IPv4 2	The IPv4 address family.
IPv6 23	The IPv6 address family.

AdvertiseDefaultRoute

Data type: uint8

Access type: Read/write

Gets and sets a value that indicates whether the interface advertises itself as a default router. This property can contain one of the following values.

Value	Meaning
Disabled 0	The interface does not advertise itself as a default router.
Enabled 1	The interface advertises itself as a default router.

AdvertisedRouterLifetime

Data type: datetime

Access type: Read/write

Gets and sets the lifetime of the router.

Advertising

Data type: uint8

Access type: Read/write

Gets and sets a value that indicates whether to send router advertisements to the interface. This parameter can contain one of the following values. By default, router advertisements are not sent to the router.

Value	Meaning
Disabled 0	Do not send router advertisements to the interface
Enabled 1	Send router advertisements to the interface

AliasAddresses

Data type: string array

Access type: Read-only

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

This property is inherited from CIM_LANEndpoint.

AutomaticMetric

Data type: uint8

Access type: Read/write

Gets and sets a value that indicates whether automatic metric is enabled. This property can contain one of the following values.

Value	Meaning
Disabled 0	Automatic metric is disabled.
Enabled 1	Automatic metric is enabled.

AvailableRequestedStates

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.RequestStateChange", "CIM_EnabledLogicalElementCapabilities.RequestedStatesSupported")

AvailableRequestedStates indicates the possible values for the RequestedState parameter of the method RequestStateChange, used to initiate a state change. The values listed shall 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. This property may be non-null if an implementation is able to advertise the set of possible values as a function of the current state. This property shall 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.

Enabled (2)

Disabled (3)

Shut Down (4)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

DMTF Reserved (12 65535)

BaseReachableTime

Data type: uint32

Access type: Read/write

Gets and sets the base reachable time, in milliseconds.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

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

Values	Meaning
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 5 32767	Reserved.
Vendor Reserved 32768 = value	Reserved.

CompartmentId

Data type: uint32

Access type: Read-only

Gets the identifier of the routing compartment.

ConnectionState

Data type: uint8

Access type: Read-only

Gets the connection state of the interface. This property can contain one of the following values.

Disconnected (0)

Connected (1)

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: key, MaxLen (256)

Indicates 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_ServiceAccessPoint.

CurrentHopLimit

Data type: uint32

Access type: Read/write

Gets and sets the hop limit for the outgoing traffic of the interface.

DadRetransmitTime

Data type: uint32

Access type: Read/write

Gets and sets the retransmit time of duplicate address detection (DAD), in milliseconds.

DadTransmits

Data type: uint32

Access type: Read/write

Gets and sets the number of duplicate address detection transmits.

Description

Data type: string

Access type: Read-only

The Description property provides a textual description of the object.

This property is inherited from CIM_ProtocolEndpoint.

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.

Values	Meaning
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 6 32767	Reserved.
Vendor Reserved 32768 = value	Reserved.

Dhcp

Data type: uint8

Access type: Read/write

Gets and sets a value that indicates whether DHCP is enabled on the interface. This property can contain one of the following values.

Disabled (0)

Enabled (1)

DirectedMacWolPattern

Data type: uint8

Access type: Read/write

Gets and sets a value that indicates whether the direct MAC WOL pattern is enabled on the interface.

Value	Meaning
Disabled 0	The direct MAC WOL pattern is disabled.
Enabled 1	The direct MAC WOL pattern is enabled.

EcnMarking

Data type: uint8

Access type: Read/write

Gets and sets a value that indicates whether To control ECN codepoints for outgoing packets. Four possible values: - Disabled - UseEct1 - UseEct0 - AppDecide") : Amended ToSubclass,Values{"Disabled", "UseEct1", "UseEct0", "AppDecide

Disabled (0)

UseEct1 (1)

UseEct0 (2)

AppDecide (3)

ElementName

Data type: string

Access type: Read-only

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

EnabledDefault

Data type: uint16

Access type: Read/write

An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is "Enabled" (value=2).

This property is inherited from CIM_EnabledLogicalElement.

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

EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled.

This property is inherited from CIM_ProtocolEndpoint.

Value	Meaning
Unknown 0	The element state is unknown.
Other 1	The element is in a state other than one listed here.
Enabled 2	The element is or could be executing commands, will process any queued commands, and queues new requests.
Disabled 3	The element will not execute commands and will drop any new requests.
Shutting Down 4	The element is in the process of going to a Disabled state.
Not Applicable 5	The element does not support being enabled or disabled.
Enabled but Offline 6	The element might be completing commands, and will drop any new requests.
In Test 7	The element is in a test state.
Deferred 8	The element might be completing commands, but will queue any new requests.
Quiesce 9	The element is enabled but in a restricted mode.
Starting 10	The element is in the process of going to an Enabled state. New requests are queued.
DMTF Reserved 11 32767
Vendor Reserved 32768 65535

ForceArpNdWolPattern

Data type: uint8

Access type: Read/write

Gets and sets a value that indicates whether the ARP, Neighbor Discovery, and wake-on-LAN (WOL) pattern is enabled on the interface.

Value	Meaning
Disabled 0	The ARP, Neighbor Discovery, and WOL pattern is disabled.
Enabled 1	The ARP, Neighbor Discovery, and WOL pattern is enabled.

Forwarding

Data type: uint8

Access type: Read/write

Gets and sets a value that indicates whether forwarding is enabled on the interface. This parameter can contain one of the following values. Forwarding is enabled by default.

Value	Meaning
Disabled 0	Forwarding is enabled.
Enabled 1	Forwarding is disabled.

GroupAddresses

Data type: string array

Access type: Read-only

Multicast addresses to which the LAN endpoint listens.

This property is inherited from CIM_LANEndpoint.

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 that of its sub-components.

This property is inherited from CIM_ManagedSystemElement.

Values	Meaning
Unknown 0	The implementation cannot report on HealthState at this time.
OK 5	The element is fully functional and is operating within normal operational parameters and without error.
Degraded/Warning 10	The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors
Minor failure 15	All functionality is available but some 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 not working.
Critical failure 25	The element is non-functional and recovery might not be possible.
Non-recoverable error 30	The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.
DMTF Reserved 31 = value	DMTF has reserved the unused portion of the continuum for additional HealthStates values in the future.

IgnoreDefaultRoutes

Data type: uint8

Access type: Read/write

Gets and sets a value that indicates whether the interface ignores default routes. This property can contain one of the following values.

Value	Meaning
Disabled 0	The interface does not ignore default routes.
Enabled 1	The interface ignores default routes.

InstallDate

Data type: datetime

Access type: Read-only

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 InstanceID 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 defining the InstanceID, or be a registered ID that is assigned by a recognized global authority. This 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. Therefor 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 preceding pattern is not used, the defining entity must assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this 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.

InterfaceAlias

Data type: string

Access type: Read-only

Gets the alias of the interface.

InterfaceIndex

Data type: uint32

Access type: Read-only

Gets the interface index.

InterfaceMetric

Data type: uint32

Access type: Read/write

Gets and sets the interface metric that applies to interface routes.

IsolationId

Data type: uint32

Access type: Read-only

Gets the network isolation identifier.

LANID

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_LANConnectivitySegment.LANID", "CIM_LANSegment.LANID")

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.

This property is inherited from CIM_LANEndpoint.

LANType

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_ProtocolEndpoint.ProtocolType"), ModelCorrespondence ("CIM_LANConnectivitySegment.ConnectivityType", "CIM_LANSegment.LANType")

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 CIM_ProtocolEndpoint and which includes the values specified here.

This property is inherited from CIM_LANEndpoint.

Unknown (0)

Other (1)

Ethernet (2)

TokenRing (3)

FDDI (4)

LowestIfNetLuid

Data type: uint64

Access type: Read-only

Gets the Locally Unique Identifier (LUID) of the lowest interface in the TCP/IP stack.

Windows 8 and Windows Server 2012: This property is not supported before Windows 8.1 and Windows Server 2012 R2.

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 (e.g., "010203040506"), with each pair representing one of the six octets of the MAC address in "canonical" bit order according to RFC 2469.

This property is inherited from CIM_LANEndpoint.

ManagedAddressConfiguration

Data type: uint8

Access type: Read/write

Gets and sets a value that indicates whether the interfaces uses a stateful protocol retrieve network addresses. If router discovery is enabled and advertising is disabled on the interface, this property is ignored. This property can contain one of the following values.

Value	Meaning
Disabled 0	Automatic metric is disabled.
Enabled 1	Automatic metric is enabled.

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.

This property is inherited from CIM_LANEndpoint.

Name

Data type: string

Access type: Read-only

Qualifiers: MaxLen (256), key

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.

This property is inherited from CIM_ProtocolEndpoint.

NameFormat

Data type: string

Access type: Read-only

Qualifiers: MaxLen (256)

NameFormat contains the naming heuristic that is selected to ensure that the value of the Name property is unique. For example, you might 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.

This property is inherited from CIM_ProtocolEndpoint.

NeighborDiscoverySupported

Data type: uint8

Access type: Read-only

Gets a value that indicates whether neighbor discovery is supported. This property can contain one of the following values.

Value	Meaning
No 0	Neighbor discovery is not supported.
Yes 1	Neighbor discovery is supported.

NeighborUnreachabilityDetection

Data type: uint8

Access type: Read-only

Gets a value that indicates whether Neighbor Unreachability Detection (NUD) is enabled on the interface. This parameter can contain one of the following values.

Value	Meaning
Disabled 0	NUD is enabled.
Enabled 1	NUD is disabled.

NlMtu

Data type: uint32

Access type: Read/write

Gets and sets the network layer maximum transmission unit (MTU) of the interface, in bytes. The default value is the natural MTU of the link.

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 current state of the element. It can also indicate transitional states. A NULL value indicates that the instrumentation does not support this property.

This property is inherited from CIM_ManagedSystemElement.

Value	Meaning
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 or quiesced.
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 17 32767	Reserved.
Vendor Reserved 32768 = value	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 OperationalStatus should contain the primary status for the element.

Note

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

This property is inherited from CIM_ProtocolEndpoint.

Values	Meaning
Unknown 0	Indicates the implementation cannot report on OperationalStatus at this time.
Other 1	Indicates an undefined state.
OK 2	Indicates full functionality without errors.
Degraded 3	Indicates the element is working and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors
Stressed 4	Indicates that the element is functioning, but needs attention. Overload and overheated are examples of Stressed states.
Predictive Failure 5	Indicates that an element is functioning nominally but predicting a failure in the near future.
Error 6	Indicates that an error has occurred.
Non-Recoverable Error 7	A nonrecoverable error has occurred.
Starting 8	The job is starting.
Stopping 9	The job is stopping.
Stopped 10	The element has been intentionally stopped.
In Service 11	Indicates the element is being configured, maintained, cleaned, or otherwise administered.
No Contact 12	Indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.
Lost Communication 13	Indicates that the job is known to exist and has been contacted successfully in the past, but is currently unreachable.
Aborted 14	Indicates the job stopped in an unexpected way. The state and configuration of the job might need to be updated.
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 may be OK but is unable to 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, ErrorError, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error).
Power Mode 18	"Power Mode" indicates that the element has additional power model information contained in the associated PowerManagementService association.
DMTF Reserved 19 32767	DMTF has reserved this portion of the range for additional OperationalStatus values in the future.
Vendor Reserved 32768 65535	Microsoft has reserved the unused portion of the range for additional OperationalStatus values in the future.

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 to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1.

This property is inherited from CIM_EnabledLogicalElement.

OtherLANType

Data type: string

Access type: Read-only

Qualifiers: Deprecated ("CIM_ProtocolEndpoint.OtherTypeDescription"), ModelCorrespondence ("CIM_LANConnectivitySegment.OtherTypeDescription", "CIM_LANEndpoint.LANType")

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 (i.e., "Other"). This property is deprecated since its purpose overlaps with OtherTypeDescription, which is inherited from CIM_ProtocolEndpoint.

This property is inherited from CIM_LANEndpoint.

OtherStatefulConfiguration

Data type: uint8

Access type: Read/write

Gets and sets a value that indicates whether the interfaces uses a stateful protocol retrieve configuration information. If router discovery is enabled and advertising is disabled on the interface, this property is ignored. This property can contain one of the following values.

Value	Meaning
Disabled 0	Automatic metric is disabled.
Enabled 1	Automatic metric is enabled.

OtherTypeDescription

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64), ModelCorrespondence ("CIM_ProtocolEndpoint.ProtocolType", "CIM_ProtocolEndpoint.ProtocolIFType")

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.

This property is inherited from CIM_ProtocolEndpoint.

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 = value )

ProtocolIFType

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_ProtocolEndpoint.OtherTypeDescription")

An enumeration that is synchronized with the IANA ifType MIB. The ifType MIB is maintained at the URL, http://www.iana.org/assignments/ianaiftype-mib. Also, additional values defined by the DMTF are included. The property is used to categorize and classify instances of the ProtocolEndpoint class. Note that if the ProtocolIFType is set to 1 (Other), then the type information should be provided in the OtherTypeDescription string property.

This property is inherited from CIM_ProtocolEndpoint.

Unknown (0)

Other (1)

Regular 1822 (2)

HDH 1822 (3)

DDN X.25 (4)

RFC877 X.25 (5)

Ethernet CSMA/CD (6)

ISO 802.3 CSMA/CD (7)

ISO 802.4 Token Bus (8)

ISO 802.5 Token Ring (9)

ISO 802.6 MAN (10)

StarLAN (11)

Proteon 10Mbit (12)

Proteon 80Mbit (13)

HyperChannel (14)

FDDI (15)

LAP-B (16)

SDLC (17)

DS1 (18)

E1 (19)

Basic ISDN (20)

Primary ISDN (21)

Proprietary Point-to-Point Serial (22)

PPP (23)

Software Loopback (24)

EON (25)

Ethernet 3Mbit (26)

NSIP (27)

SLIP (28)

Ultra (29)

DS3 (30)

SIP (31)

Frame Relay (32)

RS-232 (33)

Parallel (34)

ARCNet (35)

ARCNet Plus (36)

ATM (37)

MIO X.25 (38)

SONET (39)

X.25 PLE (40)

ISO 802.211c (41)

LocalTalk (42)

SMDS DXI (43)

Frame Relay Service (44)

V.35 (45)

HSSI (46)

HIPPI (47)

Modem (48)

AAL5 (49)

SONET Path (50)

SONET VT (51)

SMDS ICIP (52)

Proprietary Virtual/Internal (53)

Proprietary Multiplexor (54)

IEEE 802.12 (55)

Fibre Channel (56)

HIPPI Interface (57)

Frame Relay Interconnect (58)

ATM Emulated LAN for 802.3 (59)

ATM Emulated LAN for 802.5 (60)

ATM Emulated Circuit (61)

Fast Ethernet (100BaseT) (62)

ISDN (63)

V.11 (64)

V.36 (65)

G703 at 64K (66)

G703 at 2Mb (67)

QLLC (68)

Fast Ethernet 100BaseFX (69)

Channel (70)

IEEE 802.11 (71)

IBM 260/370 OEMI Channel (72)

ESCON (73)

Data Link Switching (74)

ISDN S/T Interface (75)

ISDN U Interface (76)

LAP-D (77)

IP Switch (78)

Remote Source Route Bridging (79)

ATM Logical (80)

DS0 (81)

DS0 Bundle (82)

BSC (83)

Async (84)

Combat Net Radio (85)

ISO 802.5r DTR (86)

Ext Pos Loc Report System (87)

AppleTalk Remote Access Protocol (88)

Proprietary Connectionless (89)

ITU X.29 Host PAD (90)

ITU X.3 Terminal PAD (91)

Frame Relay MPI (92)

ITU X.213 (93)

ADSL (94)

RADSL (95)

SDSL (96)

VDSL (97)

ISO 802.5 CRFP (98)

Myrinet (99)

Voice Receive and Transmit (100)

Voice Foreign Exchange Office (101)

Voice Foreign Exchange Service (102)

Voice Encapsulation (103)

Voice over IP (104)

ATM DXI (105)

ATM FUNI (106)

ATM IMA (107)

PPP Multilink Bundle (108)

IP over CDLC (109)

IP over CLAW (110)

Stack to Stack (111)

Virtual IP Address (112)

MPC (113)

IP over ATM (114)

ISO 802.5j Fibre Token Ring (115)

TDLC (116)

Gigabit Ethernet (117)

HDLC (118)

LAP-F (119)

V.37 (120)

X.25 MLP (121)

X.25 Hunt Group (122)

Transp HDLC (123)

Interleave Channel (124)

FAST Channel (125)

IP (for APPN HPR in IP Networks) (126)

CATV MAC Layer (127)

CATV Downstream (128)

CATV Upstream (129)

Avalon 12MPP Switch (130)

Tunnel (131)

Coffee (132)

Circuit Emulation Service (133)

ATM SubInterface (134)

Layer 2 VLAN using 802.1Q (135)

Layer 3 VLAN using IP (136)

Layer 3 VLAN using IPX (137)

Digital Power Line (138)

Multimedia Mail over IP (139)

DTM (140)

DCN (141)

IP Forwarding (142)

MSDSL (143)

IEEE 1394 (144)

IF-GSN/HIPPI-6400 (145)

DVB-RCC MAC Layer (146)

DVB-RCC Downstream (147)

DVB-RCC Upstream (148)

ATM Virtual (149)

MPLS Tunnel (150)

SRP (151)

Voice over ATM (152)

Voice over Frame Relay (153)

ISDL (154)

Composite Link (155)

SS7 Signaling Link (156)

Proprietary P2P Wireless (157)

Frame Forward (158)

RFC1483 Multiprotocol over ATM (159)

USB (160)

IEEE 802.3ad Link Aggregate (161)

BGP Policy Accounting (162)

FRF .16 Multilink FR (163)

H.323 Gatekeeper (164)

H.323 Proxy (165)

MPLS (166)

Multi-Frequency Signaling Link (167)

HDSL-2 (168)

S-HDSL (169)

DS1 Facility Data Link (170)

Packet over SONET/SDH (171)

DVB-ASI Input (172)

DVB-ASI Output (173)

Power Line (174)

Non Facility Associated Signaling (175)

TR008 (176)

GR303 RDT (177)

GR303 IDT (178)

ISUP (179)

Proprietary Wireless MAC Layer (180)

Proprietary Wireless Downstream (181)

Proprietary Wireless Upstream (182)

HIPERLAN Type 2 (183)

Proprietary Broadband Wireless Access Point to Mulipoint (184)

SONET Overhead Channel (185)

Digital Wrapper Overhead Channel (186)

ATM Adaptation Layer 2 (187)

Radio MAC (188)

ATM Radio (189)

Inter Machine Trunk (190)

MVL DSL (191)

Long Read DSL (192)

Frame Relay DLCI Endpoint (193)

ATM VCI Endpoint (194)

Optical Channel (195)

Optical Transport (196)

Proprietary ATM (197)

Voice over Cable (198)

Infiniband (199)

TE Link (200)

Q.2931 (201)

Virtual Trunk Group (202)

SIP Trunk Group (203)

SIP Signaling (204)

CATV Upstream Channel (205)

Econet (206)

FSAN 155Mb PON (207)

FSAN 622Mb PON (208)

Transparent Bridge (209)

Line Group (210)

Voice E&M Feature Group (211)

Voice FGD EANA (212)

Voice DID (213)

MPEG Transport (214)

6To4 (215)

GTP (216)

Paradyne EtherLoop 1 (217)

Paradyne EtherLoop 2 (218)

Optical Channel Group (219)

HomePNA (220)

GFP (221)

ciscoISLvlan (222)

actelisMetaLOOP (223)

Fcip (224)

IANA Reserved (225 4095)

IPv4 (4096)

IPv6 (4097)

IPv4/v6 (4098)

IPX (4099)

DECnet (4100)

SNA (4101)

CONP (4102)

CLNP (4103)

VINES (4104)

XNS (4105)

ISDN B Channel Endpoint (4106)

ISDN D Channel Endpoint (4107)

BGP (4108)

OSPF (4109)

UDP (4110)

TCP (4111)

802.11a (4112)

802.11b (4113)

802.11g (4114)

802.11h (4115)

NFS (4200)

CIFS (4201)

DAFS (4202)

WebDAV (4203)

HTTP (4204)

FTP (4205)

NDMP (4300)

Telnet (4400)

SSH (4401)

SM CLP (4402)

SMTP (4403)

LDAP (4404)

RDP (4405)

HTTPS (4406)

DMTF Reserved (4407 32767)

Vendor Reserved (32768 65535)

ProtocolType

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_ProtocolEndpoint.ProtocolIFType"), ModelCorrespondence ("CIM_ProtocolEndpoint.OtherTypeDescription")

Note: This property is deprecated in lieu of the ProtocolIFType enumeration. This deprecation was done to have better alignment between 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 needed to define the type of Endpoint.

This property is inherited from CIM_ProtocolEndpoint.

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)

ReachableTime

Data type: uint32

Access type: Read-only

Gets the reachable time of the interface, in milliseconds.

RequestedState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

RequestedState is an integer enumeration that indicates 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 "Reboot" (10) and "Reset" (11). Reboot refers to doing a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The 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 StartService 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 CIM_EnabledLogicalElement might not support RequestStateChange. If this occurs, the value 12 ("Not Applicable") is used.

This property is inherited from CIM_EnabledLogicalElement.

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 (13 32767)

Vendor Reserved (32768 65535)

RetransmitTime

Data type: uint32

Access type: Read/write

Gets and sets the retransmit time, in milliseconds.

RouterDiscovery

Data type: uint8

Access type: Read/write

Gets and sets a value that indicates whether router discover is enabled on the interface. This property can contain one of the following values.

Disabled (0)

Enabled (1)

ControlledByDHCP (2)

Unchanged (255)

Status

Data type: string

Access type: Read-only

Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

Contains a string indicating the primary status of the object.

Note

This property is deprecated and 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.

Store

Data type: uint8

Access type: Read-only

Gets a value that indicates whether the interface store persists after a reboot. This property can contain one of the following values.

Value	Meaning
Persistent 0	The interface store persists after a reboot.
Active 1	The interface store does not persist after a reboot.

SystemCreationClassName

Data type: string

Access type: Read-only

Qualifiers: key, MaxLen (256), Propagated ("CIM_System.CreationClassName")

The CreationClassName of the scoping System.

This property is inherited from CIM_ServiceAccessPoint.

SystemName

Data type: string

Access type: Read-only

Qualifiers: key, MaxLen (256), Propagated ("CIM_System.Name")

The Name of the scoping System.

This property is inherited from CIM_ServiceAccessPoint.

TimeOfLastStateChange

Data type: datetime

Access type: Read-only

The date or time when the EnabledState 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_ProtocolEndpoint.

TransitioningToState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.RequestStateChange", "CIM_EnabledLogicalElement.RequestedState", "CIM_EnabledLogicalElement.EnabledState")

TransitioningToState indicates the target state to which the instance is transitioning.

A value of 5 "No Change" shall indicate that no transition is in progress.A value of 12 "Not Applicable" shall indicate the implementation does not support representing ongoing transitions.

A value other than 5 or 12 shall identify the state to which the element is in the process of transitioning.

This property is inherited from CIM_EnabledLogicalElement.

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)

WeakHostReceive

Data type: uint8

Access type: Read/write

Gets and sets a value that indicates whether weak host receives are enabled. This property can contain one of the following values.

Value	Meaning
Disabled 0	Weak host receives are disabled.
Enabled 1	Weak host receives are enabled.

WeakHostSend

Data type: uint8

Access type: Read/write

Gets and sets a value that indicates whether weak host sends are enabled. This property can contain one of the following values.

Value	Meaning
Disabled 0	Weak host sends are disabled.
Enabled 1	Weak host sends are enabled.

Requirements

See also

CIM_LANEndpoint

NetTCPIP Provider Classes