CIM_ProtocolEndpoint class

A communication point from which data can be sent or received. protocol endpoints link system or computer interfaces to logical networks.

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_ProtocolEndpoint : CIM_ServiceAccessPoint
{
  uint32   Type;
  string   SystemName;
  string   SystemCreationClassName;
  string   Status;
  datetime InstallDate;
  string   CreationClassName;
  string   Caption;
  string   Description;
  uint16   OperationalStatus[];
  uint16   EnabledState;
  datetime TimeOfLastStateChange;
  string   Name;
  string   NameFormat;
  uint16   ProtocolType;
  uint16   ProtocolIFType;
  string   OtherTypeDescription;
  boolean  BroadcastResetSupported;
};

Members

The CIM_ProtocolEndpoint class has these types of members:

Methods

The CIM_ProtocolEndpoint class has these methods.

MethodDescription
BroadcastReset

Send a broadcast reset. A broadcast reset is a request that peers perform a reset. Examples include a parallel SCSI Bus Reset and a Fibre Channel LIP.

 

Properties

The CIM_ProtocolEndpoint class has these properties.

BroadcastResetSupported
Data type: boolean
Access type: Read-only

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

Caption
Data type: string
Access type: Read-only

Short textual description of the object. This property is inherited from CIM_ManagedSystemElement.

CreationClassName
Data type: string
Access type: Read-only

Name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified.

Description
Data type: string
Access type: Read-only

A textual description of the object.

EnabledState
Data type: uint16
Access type: Read-only

This property is inherited from CIM_EnabledLogicalElement.

InstallDate
Data type: datetime
Access type: Read-only

Date and time the object was installed. This property does not require a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.

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

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

This property is inherited from CIM_EnabledLogicalElement.

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

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. Be aware that if the ProtocolIFType is set to 1 (Other), then the type information should be provided in the OtherTypeDescription string property.

0 (Unknown)
1 (Other)
2 (Regular 1822)
3 (HDH 1822)
4 (DDN X.25)
5 (RFC877 X.25)
6 (Ethernet CSMA/CD)
7 (ISO 802.3 CSMA/CD)
8 (ISO 802.4 Token Bus)
9 (ISO 802.5 Token Ring)
10 (ISO 802.6 MAN)
11 (StarLAN)
12 (Proteon 10Mbit)
13 (Proteon 80Mbit)
14 (HyperChannel)
15 (FDDI)
16 (LAP-B)
17 (SDLC)
18 (DS1)
19 (E1)
20 (Basic ISDN)
21 (Primary ISDN)
22 (Proprietary Point-to-Point Serial)
23 (PPP)
24 (Software Loopback)
25 (EON)
26 (Ethernet 3Mbit)
27 (NSIP)
28 (SLIP)
29 (Ultra)
30 (DS3)
31 (SIP)
32 (Frame Relay)
33 (RS-232)
34 (Parallel)
35 (ARCNet)
36 (ARCNet Plus)
37 (ATM)
38 (MIO X.25)
39 (SONET)
40 (X.25 PLE)
41 (ISO 802.211c)
42 (LocalTalk)
43 (SMDS DXI)
44 (Frame Relay Service)
45 (V.35)
46 (HSSI)
47 (HIPPI)
48 (Modem)
49 (AAL5)
50 (SONET Path)
51 (SONET VT)
52 (SMDS ICIP)
53 (Proprietary Virtual/Internal)
54 (Proprietary Multiplexor)
55 (IEEE 802.12)
56 (Fibre Channel)
57 (HIPPI Interface)
58 (Frame Relay Interconnect)
59 (ATM Emulated LAN for 802.3)
60 (ATM Emulated LAN for 802.5)
61 (ATM Emulated Circuit)
62 (Fast Ethernet (100BaseT))
63 (ISDN)
64 (V.11)
65 (V.36)
66 (G703 at 64K)
67 (G703 at 2Mb)
68 (QLLC)
69 (Fast Ethernet 100BaseFX)
70 (Channel)
71 (IEEE 802.11)
72 (IBM 260/370 OEMI Channel)
73 (ESCON)
74 (Data Link Switching)
75 (ISDN S/T Interface)
76 (ISDN U Interface)
77 (LAP-D)
78 (IP Switch)
79 (Remote Source Route Bridging)
80 (ATM Logical)
81 (DS0)
82 (DS0 Bundle)
83 (BSC)
84 (Async)
85 (Combat Net Radio)
86 (ISO 802.5r DTR)
87 (Ext Pos Loc Report System)
88 (AppleTalk Remote Access Protocol)
89 (Proprietary Connectionless)
90 (ITU X.29 Host PAD)
91 (ITU X.3 Terminal PAD)
92 (Frame Relay MPI)
93 (ITU X.213)
94 (ADSL)
95 (RADSL)
96 (SDSL)
97 (VDSL)
98 (ISO 802.5 CRFP)
99 (Myrinet)
100 (Voice Receive and Transmit)
101 (Voice Foreign Exchange Office)
102 (Voice Foreign Exchange Service)
103 (Voice Encapsulation)
104 (Voice over IP)
105 (ATM DXI)
106 (ATM FUNI)
107 (ATM IMA)
108 (PPP Multilink Bundle)
109 (IP over CDLC)
110 (IP over CLAW)
111 (Stack to Stack)
112 (Virtual IP Address)
113 (MPC)
114 (IP over ATM)
115 (ISO 802.5j Fibre Token Ring)
116 (TDLC)
117 (Gigabit Ethernet)
118 (HDLC)
119 (LAP-F)
120 (V.37)
121 (X.25 MLP)
122 (X.25 Hunt Group)
123 (Transp HDLC)
124 (Interleave Channel)
125 (FAST Channel)
126 (IP (for APPN HPR in IP Networks))
127 (CATV MAC Layer)
128 (CATV Downstream)
129 (CATV Upstream)
130 (Avalon 12MPP Switch)
131 (Tunnel)
132 (Coffee)
133 (Circuit Emulation Service)
134 (ATM SubInterface)
135 (Layer 2 VLAN using 802.1Q)
136 (Layer 3 VLAN using IP)
137 (Layer 3 VLAN using IPX)
138 (Digital Power Line)
139 (Multimedia Mail over IP)
140 (DTM)
141 (DCN)
142 (IP Forwarding)
143 (MSDSL)
144 (IEEE 1394)
145 (IF-GSN/HIPPI-6400)
146 (DVB-RCC MAC Layer)
147 (DVB-RCC Downstream)
148 (DVB-RCC Upstream)
149 (ATM Virtual)
150 (MPLS Tunnel)
151 (SRP)
152 (Voice over ATM)
153 (Voice over Frame Relay)
154 (ISDL)
155 (Composite Link)
156 (SS7 Signaling Link)
157 (Proprietary P2P Wireless)
158 (Frame Forward)
159 (RFC1483 Multiprotocol over ATM)
160 (USB)
161 (IEEE 802.3ad Link Aggregate)
162 (BGP Policy Accounting)
163 (FRF .16 Multilink FR)
164 (H.323 Gatekeeper)
165 (H.323 Proxy)
166 (MPLS)
167 (Multi-Frequency Signaling Link)
168 (HDSL-2)
169 (S-HDSL)
170 (DS1 Facility Data Link)
171 (Packet over SONET/SDH)
172 (DVB-ASI Input)
173 (DVB-ASI Output)
174 (Power Line)
175 (Non Facility Associated Signaling)
176 (TR008)
177 (GR303 RDT)
178 (GR303 IDT)
179 (ISUP)
180 (Proprietary Wireless MAC Layer)
181 (Proprietary Wireless Downstream)
182 (Proprietary Wireless Upstream)
183 (HIPERLAN Type 2)
184 (Proprietary Broadband Wireless Access Point to Multipoint)
185 (SONET Overhead Channel)
186 (Digital Wrapper Overhead Channel)
187 (ATM Adaptation Layer 2)
188 (Radio MAC)
189 (ATM Radio)
190 (Inter Machine Trunk)
191 (MVL DSL)
192 (Long Read DSL)
193 (Frame Relay DLCI Endpoint)
194 (ATM VCI Endpoint)
195 (Optical Channel)
196 (Optical Transport)
197 (Proprietary ATM)
198 (Voice over Cable)
199 (Infiniband)
200 (TE Link)
201 (Q.2931)
202 (Virtual Trunk Group)
203 (SIP Trunk Group)
204 (SIP Signaling)
205 (CATV Upstream Channel)
206 (Econet)
207 (FSAN 155Mb PON)
208 (FSAN 622Mb PON)
209 (Transparent Bridge)
210 (Line Group)
211 (Voice E&M Feature Group)
212 (Voice FGD EANA)
213 (Voice DID)
214 (MPEG Transport)
215 (6To4)
216 (GTP)
217 (Paradyne EtherLoop 1)
218 (Paradyne EtherLoop 2)
219 (Optical Channel Group)
220 (HomePNA)
221 (GFP)
222 (ciscoISLvlan)
223 (actelisMetaLOOP)
224 (Fcip)
225..4095 (IANA Reserved)
4096 (IPv4)
4097 (IPv6)
4098 (IPv4/v6)
4099 (IPX)
4100 (DECnet)
4101 (SNA)
4102 (CONP)
4103 (CLNP)
4104 (VINES)
4105 (XNS)
4106 (ISDN B Channel Endpoint)
4107 (ISDN D Channel Endpoint)
4108 (BGP)
4109 (OSPF)
4110 (UDP)
4111 (TCP)
4112 (802.11a)
4113 (802.11b)
4114 (802.11g)
4115 (802.11h)
4200 (NFS)
4201 (CIFS)
4202 (DAFS)
4203 (WebDAV)
4204 (HTTP)
4205 (FTP)
4300 (NDMP)
4301..32767 (DMTF Reserved)
32768.. (Vendor Reserved)
ProtocolType
Data type: uint16
Access type: Read-only

Note: This property is deprecated in lieu of the ProtocolIFType enumeration. This deprecation was done to create 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 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)
Status
Data type: string
Access type: Read-only

Current status of the object. This property is inherited from CIM_ManagedSystemElement.

Values include the following:

"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
SystemCreationClassName
Data type: string
Access type: Read-only

Scoping system creation class name.

SystemName
Data type: string
Access type: Read-only

Scoping system name.

TimeOfLastStateChange
Data type: datetime
Access type: Read-only

This property is inherited from CIM_EnabledLogicalElement.

Type
Data type: uint32
Access type: Read-only

Type of SAP, such as attached or redirected.

ValueMeaning
1 (0x1)

Write

2 (0x2)

Read

4 (0x4)

Redirected

8 (0x8)

Net_Attached

16 (0x10)

Unknown

 

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_ServiceAccessPoint

 

 

Show: