# Class CIM_ProtocolEndpoint
extends CIM_ServiceAccessPoint

A communication point from which data can be sent or received. ProtocolEndpoints link system or computer interfaces to LogicalNetworks.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_ServiceAccessPoint
|
+--CIM_ProtocolEndpoint

## Direct Known Subclasses

CIM_BGPProtocolEndpoint
CIM_CLPProtocolEndpoint
CIM_DHCPProtocolEndpoint
CIM_DNSProtocolEndpoint
CIM_IPProtocolEndpoint
CIM_IPXProtocolEndpoint
CIM_LANEndpoint
CIM_OSPFProtocolEndpointBase
CIM_SCSIProtocolEndpoint
CIM_SecurityAssociationEndpoint
CIM_SSHProtocolEndpoint
CIM_SwitchPort
CIM_TCPProtocolEndpoint
CIM_TelnetProtocolEndpoint
CIM_UDPProtocolEndpoint
CIM_VLANEndpoint

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | A communication point from which data can be sent or received. ProtocolEndpoints link system or computer interfaces to LogicalNetworks.
UMLPackagePath | string | CIM::Core::Service
Version | string | 2.15.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
Description | string |
Description | string | The Description property provides a textual description of the object.
MappingStrings | string | MIB.IETF|IF-MIB.ifDescr
Override | string | Description
EnabledState | uint16 |
Description | string | 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. The following text briefly summarizes the various enabled and disabled states: Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element does not support being enabled or disabled. Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element might be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.
MappingStrings | string | MIB.IETF|IF-MIB.ifAdminStatus
ModelCorrespondence | string | CIM_EnabledLogicalElement.OtherEnabledState
Override | string | EnabledState
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535
Values | string | Unknown, Other, Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor Reserved
Name | string |
Description | string | A string that identifies this ProtocolEndpoint 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.
Key | boolean | true
MaxLen | uint32 | 256
Override | string | Name
NameFormat | string |
Description | string | 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.
MaxLen | uint32 | 256
OtherTypeDescription | string |
Description | string | A string that describes the type of ProtocolEndpoint 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.
MaxLen | uint32 | 64
ModelCorrespondence | string | CIM_ProtocolEndpoint.ProtocolType, CIM_ProtocolEndpoint.ProtocolIFType
ProtocolIFType | uint16 |
Description | string | ProtocolIFType is 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.
MappingStrings | string | MIB.IETF|IF-MIB.ifType
ModelCorrespondence | string | CIM_ProtocolEndpoint.OtherTypeDescription
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225..4095, 4096, 4097, 4098, 4099, 4100, 4101, 4102, 4103, 4104, 4105, 4106, 4107, 4108, 4109, 4110, 4111, 4112, 4113, 4114, 4115, 4200, 4201, 4202, 4203, 4204, 4205, 4300, 4400, 4401, 4402, 4403, 4404, 4405, 4406, .., 32768..
Values | string | Unknown, Other, Regular 1822, HDH 1822, DDN X.25, RFC877 X.25, Ethernet CSMA/CD, ISO 802.3 CSMA/CD, ISO 802.4 Token Bus, ISO 802.5 Token Ring, ISO 802.6 MAN, StarLAN, Proteon 10Mbit, Proteon 80Mbit, HyperChannel, FDDI, LAP-B, SDLC, DS1, E1, Basic ISDN, Primary ISDN, Proprietary Point-to-Point Serial, PPP, Software Loopback, EON, Ethernet 3Mbit, NSIP, SLIP, Ultra, DS3, SIP, Frame Relay, RS-232, Parallel, ARCNet, ARCNet Plus, ATM, MIO X.25, SONET, X.25 PLE, ISO 802.211c, LocalTalk, SMDS DXI, Frame Relay Service, V.35, HSSI, HIPPI, Modem, AAL5, SONET Path, SONET VT, SMDS ICIP, Proprietary Virtual/Internal, Proprietary Multiplexor, IEEE 802.12, Fibre Channel, HIPPI Interface, Frame Relay Interconnect, ATM Emulated LAN for 802.3, ATM Emulated LAN for 802.5, ATM Emulated Circuit, Fast Ethernet (100BaseT), ISDN, V.11, V.36, G703 at 64K, G703 at 2Mb, QLLC, Fast Ethernet 100BaseFX, Channel, IEEE 802.11, IBM 260/370 OEMI Channel, ESCON, Data Link Switching, ISDN S/T Interface, ISDN U Interface, LAP-D, IP Switch, Remote Source Route Bridging, ATM Logical, DS0, DS0 Bundle, BSC, Async, Combat Net Radio, ISO 802.5r DTR, Ext Pos Loc Report System, AppleTalk Remote Access Protocol, Proprietary Connectionless, ITU X.29 Host PAD, ITU X.3 Terminal PAD, Frame Relay MPI, ITU X.213, ADSL, RADSL, SDSL, VDSL, ISO 802.5 CRFP, Myrinet, Voice Receive and Transmit, Voice Foreign Exchange Office, Voice Foreign Exchange Service, Voice Encapsulation, Voice over IP, ATM DXI, ATM FUNI, ATM IMA, PPP Multilink Bundle, IP over CDLC, IP over CLAW, Stack to Stack, Virtual IP Address, MPC, IP over ATM, ISO 802.5j Fibre Token Ring, TDLC, Gigabit Ethernet, HDLC, LAP-F, V.37, X.25 MLP, X.25 Hunt Group, Transp HDLC, Interleave Channel, FAST Channel, IP (for APPN HPR in IP Networks), CATV MAC Layer, CATV Downstream, CATV Upstream, Avalon 12MPP Switch, Tunnel, Coffee, Circuit Emulation Service, ATM SubInterface, Layer 2 VLAN using 802.1Q, Layer 3 VLAN using IP, Layer 3 VLAN using IPX, Digital Power Line, Multimedia Mail over IP, DTM, DCN, IP Forwarding, MSDSL, IEEE 1394, IF-GSN/HIPPI-6400, DVB-RCC MAC Layer, DVB-RCC Downstream, DVB-RCC Upstream, ATM Virtual, MPLS Tunnel, SRP, Voice over ATM, Voice over Frame Relay, ISDL, Composite Link, SS7 Signaling Link, Proprietary P2P Wireless, Frame Forward, RFC1483 Multiprotocol over ATM, USB, IEEE 802.3ad Link Aggregate, BGP Policy Accounting, FRF .16 Multilink FR, H.323 Gatekeeper, H.323 Proxy, MPLS, Multi-Frequency Signaling Link, HDSL-2, S-HDSL, DS1 Facility Data Link, Packet over SONET/SDH, DVB-ASI Input, DVB-ASI Output, Power Line, Non Facility Associated Signaling, TR008, GR303 RDT, GR303 IDT, ISUP, Proprietary Wireless MAC Layer, Proprietary Wireless Downstream, Proprietary Wireless Upstream, HIPERLAN Type 2, Proprietary Broadband Wireless Access Point to Mulipoint, SONET Overhead Channel, Digital Wrapper Overhead Channel, ATM Adaptation Layer 2, Radio MAC, ATM Radio, Inter Machine Trunk, MVL DSL, Long Read DSL, Frame Relay DLCI Endpoint, ATM VCI Endpoint, Optical Channel, Optical Transport, Proprietary ATM, Voice over Cable, Infiniband, TE Link, Q.2931, Virtual Trunk Group, SIP Trunk Group, SIP Signaling, CATV Upstream Channel, Econet, FSAN 155Mb PON, FSAN 622Mb PON, Transparent Bridge, Line Group, Voice E&M Feature Group, Voice FGD EANA, Voice DID, MPEG Transport, 6To4, GTP, Paradyne EtherLoop 1, Paradyne EtherLoop 2, Optical Channel Group, HomePNA, GFP, ciscoISLvlan, actelisMetaLOOP, Fcip, IANA Reserved, IPv4, IPv6, IPv4/v6, IPX, DECnet, SNA, CONP, CLNP, VINES, XNS, ISDN B Channel Endpoint, ISDN D Channel Endpoint, BGP, OSPF, UDP, TCP, 802.11a, 802.11b, 802.11g, 802.11h, NFS, CIFS, DAFS, WebDAV, HTTP, FTP, NDMP, Telnet, SSH, SM CLP, SMTP, LDAP, RDP, HTTPS, DMTF Reserved, Vendor Reserved
ProtocolType | uint16 |
Deprecated | string | CIM_ProtocolEndpoint.ProtocolIFType
Description | string | 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.
ModelCorrespondence | string | CIM_ProtocolEndpoint.OtherTypeDescription
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27
Values | string | Unknown, Other, IPv4, IPv6, IPX, AppleTalk, DECnet, SNA, CONP, CLNP, VINES, XNS, ATM, Frame Relay, Ethernet, TokenRing, FDDI, Infiniband, Fibre Channel, ISDN BRI Endpoint, ISDN B Channel Endpoint, ISDN D Channel Endpoint, IPv4/v6, BGP, OSPF, MPLS, UDP, TCP
TimeOfLastStateChange | datetime |
Description | string | 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.
MappingStrings | string | MIB.IETF|IF-MIB.ifLastChange
Override | string | TimeOfLastStateChange
OperationalStatus | uint16[] |
ArrayType | string | Indexed
Description | string | Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration's values are self-explanatory. However, a few are not and are described here in more detail. "Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on. "Predictive Failure" indicates that an element is functioning nominally but predicting a failure in the near future. "In Service" describes an element being configured, maintained, cleaned, or otherwise administered. "No Contact" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. "Lost Communication" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. "Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated. "Dormant" indicates that the element is inactive or quiesced. "Supporting Entity in Error" indicates that this element might be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems. "Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, 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" indicates that the element has additional power model information contained in the Associated PowerManagementService association. "Relocating" indicates the element is being relocated. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or instrumentation provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus should contain the primary status for the element. When instrumented, Status (because it is single-valued) should also provide the primary status of the element.
MappingStrings | string | MIB.IETF|IF-MIB.ifOperStatus
ModelCorrespondence | string | CIM_ManagedSystemElement.StatusDescriptions
Override | string | OperationalStatus
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, .., 0x8000..
Values | string | Unknown, Other, OK, Degraded, Stressed, Predictive Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity in Error, Completed, Power Mode, Relocating, DMTF Reserved, Vendor Reserved

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_ServiceAccessPoint
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_ServiceAccessPoint
SystemName | string | CIM_ServiceAccessPoint
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
RequestStateChange | uint32 | CIM_EnabledLogicalElement