1 tony 1.1 // ===================================================================
2 // Title: Network Protocol Endpoints 2.8
3 // Filename: Network27_ProtocolEndpoints.mof
4 // Version: 2.8
5 // Status: Preliminary
6 // Date: August 18, 2003
7 // ===================================================================
8 // Copyright 1998-2003 Distributed Management Task Force, Inc. (DMTF).
9 // All rights reserved.
10 // DMTF is a not-for-profit association of industry members dedicated
11 // to promoting enterprise and systems management and interoperability.
12 // DMTF specifications and documents may be reproduced for uses
13 // consistent with this purpose by members and non-members,
14 // provided that correct attribution is given.
15 // As DMTF specifications may be revised from time to time,
16 // the particular version and release date should always be noted.
17 //
18 // Implementation of certain elements of this standard or proposed
19 // standard may be subject to third party patent rights, including
20 // provisional patent rights (herein "patent rights"). DMTF makes
21 // no representations to users of the standard as to the existence
22 tony 1.1 // of such rights, and is not responsible to recognize, disclose, or
23 // identify any or all such third party patent right, owners or
24 // claimants, nor for any incomplete or inaccurate identification or
25 // disclosure of such rights, owners or claimants. DMTF shall have no
26 // liability to any party, in any manner or circumstance, under any
27 // legal theory whatsoever, for failure to recognize, disclose, or
28 // identify any such third party patent rights, or for such party's
29 // reliance on the standard or incorporation thereof in its product,
30 // protocols or testing procedures. DMTF shall have no liability to
31 // any party implementing such standard, whether such implementation
32 // is foreseeable or not, nor to any patent owner or claimant, and shall
33 // have no liability or responsibility for costs or losses incurred if
34 // a standard is withdrawn or modified after publication, and shall be
35 // indemnified and held harmless by any party implementing the
36 // standard from any and all claims of infringement by a patent owner
37 // for such implementations.
38 //
39 // For information about patents held by third-parties which have
40 // notified the DMTF that, in their opinion, such patent may relate to
41 // or impact implementations of DMTF standards, visit
42 // http://www.dmtf.org/about/policies/disclosures.php.
43 tony 1.1 // ===================================================================
44 // Description: The Network Model extends the management concepts to
45 // represent protocol interfaces and network/protocol
46 // services. This file defines network interfaces -
47 // subclasses of CIM_ProtocolEndpoint.
48 //
49 // The object classes below are listed in an order that
50 // avoids forward references. Required objects, defined
51 // by other working groups, are omitted.
52 // ==================================================================
53 // Change Log for v2.8
54 // CR1052 - Override the ProtocolIFType property in ProtocolEndpoint's
55 // subclasses which include IPProtocolEndpoint,
56 // BGPProtocolEndpoint, IPXProtocolEndpoint,
57 // TCPProtocolEndpoint
58 // UDPProtocolEndpoint and OSPFProtocolEndpoint.
59 // CR1053 - Add a new endpoint for wireless support
60 // (WirelessLANEndpoint)
61 // CR1061 - Add class definition for MPLSProtocolEndpoint
62 //
63 // Change Log for v2.7
64 tony 1.1 // CR788 - Add classes to support OSPF
65 // CR789 - Add TCP and UDP Endpoints
66 // CR790 - Add classes to support MPLS
67 // CR792 - Add the Composition qualifer to ASBGPEndpoints
68 // CR804 - Updates to LANEndpoint - Update description for .LANID;
69 // Deprecate .LANType and .OtherLANType
70 // - Updates to IPProtocolEndpoint - Deprecate .Address; Add
71 // .IPv4Address, .IPv6Address, and .PrefixLength
72 // - Update several property descriptions
73 // CR837 - Move AuthType, OtherAuthType and AuthKey to the
74 // OSPFProtocolEndpointBase class (from the
75 // OSPFProtocolEndpoint)
76 // CR863 - Update the format of the MappingStrings qualifier when
77 // referencing IETF RFCs
78 // CR866 - Fixes to BGPProtocolEndpoint - Deprecated several
79 // properties and added properties from BGPPeerGroup that
80 // are per Endpoint
81 // CR920 - Add missing parenthesis to the Description for
82 // BGPProtocolEndpoint.IsEBGPMultihop
83 // CR961 - Changes to Enabled and RequestedState in BGPProtocolEndpoint
84 // and OSPFProtocolEndpointBase, inherited from
85 tony 1.1 // EnabledLogicalElement
86 // CR982 - Removal of Experimental for preliminary to final
87 // CR983 - Deprecations for v2.7 made final
88 // CR991 - Adjust LANEndpoint classes to reference
89 // LANConnectivitySegment
90 // and deprecate the association InSegment
91 // ===================================================================
92
93 #pragma Locale ("en_US")
94
95
96 // ==================================================================
97 // LANEndpoint
98 // ==================================================================
99 [Version ("2.7.0"), Description (
100 "A communication endpoint which, when its associated interface "
101 "device is connected to a LAN, may send and receive data "
102 "frames. LANEndpoints include Ethernet, Token Ring and FDDI "
103 "interfaces.") ]
104 class CIM_LANEndpoint : CIM_ProtocolEndpoint {
105
106 tony 1.1 [Description (
107 "A label or identifier for the LAN Segment to which the "
108 "Endpoint is connected. If the Endpoint is not currently "
109 "active/connected or this information is not known, then "
110 "LANID is NULL."),
111 ModelCorrespondence {"CIM_LANConnectivitySegment.LANID",
112 "CIM_LANSegment.LANID"} ]
113 string LANID;
114
115 [Deprecated {"CIM_ProtocolEndpoint.ProtocolType"}, Description (
116 "An indication of the kind of technology used on the LAN. "
117 "This property is deprecated in lieu of ProtocolType, which "
118 "is an enumeration inherited from ProtocolEndpoint and which "
119 "includes the Values specified here."),
120 ValueMap {"0", "1", "2", "3", "4"},
121 Values {"Unknown", "Other", "Ethernet", "TokenRing", "FDDI"},
122 ModelCorrespondence
123 {"CIM_LANConnectivitySegment.ConnectivityType",
124 "CIM_LANSegment.LANType"} ]
125 uint16 LANType;
126
127 tony 1.1 [Deprecated {"CIM_ProtocolEndpoint.OtherTypeDescription"},
128 Description (
129 "A free-form string that describes the type of technology "
130 "used on the LAN when the value of the LANType property is "
131 "equal to 1 (i.e., \"Other\"). This property is deprecated "
132 "since its purpose overlaps with OtherTypeDescription, which "
133 "which is inherited from ProtocolEndpoint."),
134 ModelCorrespondence
135 {"CIM_LANConnectivitySegment.OtherTypeDescription",
136 "CIM_LANEndpoint.LANType"} ]
137 string OtherLANType;
138
139 [Description (
140 "The principal unicast address used in communication with "
141 "the LANEndpoint. The MAC address is formatted as twelve "
142 "hexadecimal digits (e.g., \"010203040506\"), with each pair "
143 "representing one of the six octets of the MAC address in "
144 "\"canonical\" bit order according to RFC 2469."),
145 MaxLen (12) ]
146 string MACAddress;
147
148 tony 1.1 [Description (
149 "Other unicast addresses that may be used to communicate "
150 "with the LANEndpoint.") ]
151 string AliasAddresses[];
152
153 [Description (
154 "Multicast addresses to which the LANEndpoint listens.") ]
155 string GroupAddresses[];
156
157 [Description (
158 "The largest information field that may be sent or received "
159 "by the LANEndpoint."),
160 Units ("Bits") ]
161 uint32 MaxDataSize;
162 };
163
164
165 // ==================================================================
166 // InSegment
167 // ==================================================================
168 [Association, Deprecated {"CIM_MemberOfCollection"}, Aggregation,
169 tony 1.1 Version ("2.7.0"), Description (
170 "Defines a LANEndpoint as a member of a specific LANSegment. "
171 "Note that one of this association's references (LANSegment) is "
172 "deprecated, as well as its superclass (InLogicalNetwork). "
173 "Following the same logic as its parent, this association is "
174 "deprecated to the MemberOfCollection association.") ]
175 class CIM_InSegment : CIM_InLogicalNetwork {
176
177 [Deprecated {"CIM_MemberOfCollection.Collection"}, Aggregate,
178 Override ("Collection"), Max (1), Description (
179 "The LANSegment that groups the LANEndpoint instances.") ]
180 CIM_LANSegment REF Collection;
181
182 [Deprecated {"CIM_MemberOfCollection.Member"},
183 Override ("Member"), Description (
184 "A child LANEndpoint that is a component of the LANSegment.") ]
185 CIM_LANEndpoint REF Member;
186 };
187
188
189
190 tony 1.1 // ==================================================================
191 // BindsToLANEndpoint
192 // ==================================================================
193 [Association, Version ("2.6.0"), Description (
194 "This association makes explicit the dependency of a SAP or "
195 "ProtocolEndpoint on an underlying LANEndpoint, on the same "
196 "system.") ]
197 class CIM_BindsToLANEndpoint : CIM_BindsTo {
198
199 [Override ("Antecedent"), Description (
200 "The underlying LANEndpoint, which is depended upon.") ]
201 CIM_LANEndpoint REF Antecedent;
202
203 [Override ("Dependent"), Description (
204 "The AccessPoint or ProtocolEndpoint dependent on the "
205 "LANEndpoint.") ]
206 CIM_ServiceAccessPoint REF Dependent;
207
208 [Description (
209 "This describes the framing method for the upper layer SAP "
210 "or Endpoint that is bound to the LANEndpoint. Note: "
211 tony 1.1 "\"Raw802.3\" is only known to be used with the IPX "
212 "protocol."),
213 ValueMap {"0", "1", "2", "3", "4"},
214 Values {"Unknown", "Ethernet", "802.2", "SNAP", "Raw802.3"} ]
215 uint16 FrameType;
216 };
217
218
219 // ==================================================================
220 // IPProtocolEndpoint
221 // ==================================================================
222 [Version ("2.7.1000"), Description (
223 "A ProtocolEndpoint that is dedicated to running IP.") ]
224 class CIM_IPProtocolEndpoint : CIM_ProtocolEndpoint {
225
226 [Description (
227 "The IPv4 address that this ProtocolEndpoint represents.") ]
228 string IPv4Address;
229
230 [Description (
231 "The IPv6 address that this ProtocolEndpoint represents.") ]
232 tony 1.1 string IPv6Address;
233
234 [Deprecated {"CIM_IPProtocolEndpoint.IPv4Address",
235 "CIM_IPProtocolEndpoint.IPv6Address"}, Description (
236 "The IP address that this ProtocolEndpoint represents, "
237 "formatted according to the appropriate convention as "
238 "defined in the AddressType property of this class (e.g., "
239 "171.79.6.40). This single property is deprecated to "
240 "replace it by specific IPv4 and v6 addresses.") ]
241 string Address;
242
243 [Description (
244 "The mask for the IPv4 address of this ProtocolEndpoint, if "
245 "one is defined.") ]
246 string SubnetMask;
247
248 [Description (
249 "The prefix length for the IPv6 address of this Protocol "
250 "Endpoint, if one is defined.") ]
251 uint8 PrefixLength;
252
253 tony 1.1 [Deprecated {"No value"}, Description (
254 "An enumeration that describes the format of the Address "
255 "property. It is deprecated since it is not needed, as the "
256 "class contains both IPv4 and v6 addresses)."),
257 ValueMap {"0", "1", "2"},
258 Values {"Unknown", "IPv4", "IPv6"} ]
259 uint16 AddressType;
260
261 [Deprecated {"CIM_ProtocolEndpoint.ProtocolIFType"},
262 Description (
263 "This property explicitly defines support for different "
264 "versions of the IP protocol, for this Endpoint. It is "
265 "deprecated since the ProtocolIFType also provides this "
266 "functionality by describing an endpoint as IPv4 only "
267 "(value=4096), IPv6 only (value=4097), or IPv4/v6 "
268 "(value=4098)."),
269 ValueMap {"0", "1", "2", "3"},
270 Values {"Unknown", "IPv4 Only", "IPv6 Only",
271 "Both IPv4 and IPv6"} ]
272 uint16 IPVersionSupport;
273
274 tony 1.1 [Experimental, Override ("ProtocolIFType"), Description (
275 "ProtocolIFType's enumeration is limited to IP-related and "
276 "reserved values for this subclass of ProtocolEndpoint."),
277 ValueMap {"1", "221..4095", "4096", "4097", "4098",
278 "4116..32767", "32768.."},
279 Values {"Other", "IANA Reserved", "IPv4", "IPv6", "IPv4/v6",
280 "DMTF Reserved", "Vendor Reserved"} ]
281 uint16 ProtocolIFType = 4096;
282 };
283
284
285 // ==================================================================
286 // BGPProtocolEndpoint
287 // ==================================================================
288 [Version ("2.7.1000"), Description (
289 "A ProtocolEndpoint that is dedicated to running BGP.") ]
290 class CIM_BGPProtocolEndpoint : CIM_ProtocolEndpoint {
291
292 [Description (
293 "A boolean that, when TRUE, signifies that this is an "
294 "instance of the external version of BGP (FALSE is the "
295 tony 1.1 "internal version).") ]
296 boolean IsEBGP;
297
298 [Description (
299 "Normally, two routers running EBGP must be physically "
300 "connected. This boolean, when TRUE, denotes a LOGICAL "
301 "connection between two routers that are running EBGP (e.g., "
302 "there is an intermediate router or interface between "
303 "them).") ]
304 boolean IsEBGPMultihop;
305
306 [Description (
307 "This is the unique identifier of the local BGP router. "
308 "This is often the router ID (e.g., an IP address)."),
309 MappingStrings {"MIB.IETF|BGP4-MIB.bgpIdentifier"} ]
310 string LocalIdentifier;
311
312 [Description (
313 "This is the unique identifier of the peer BGP router. This "
314 "is often the router ID (e.g., an IP address)."),
315 MappingStrings {"MIB.IETF|BGP4-MIB.bgpPeerIdentifier"} ]
316 tony 1.1 string PeerIdentifier;
317
318 [Description (
319 "This defines the current connection state of the BGP Peer."),
320 ValueMap {"1", "2", "3", "4", "5", "6"},
321 Values {"Idle", "Connect", "Active", "OpenSet", "OpenConfirm",
322 "Established"},
323 MappingStrings {"MIB.IETF|BGP4-MIB.bgpPeerState"} ]
324 uint16 State;
325
326 [Deprecated {"CIM_EnabledLogicalElement.RequestedState"},
327 Description (
328 "This defines the desired state of the BGP connection. It "
329 "is equivalent to the RequestedState property (i.e., "
330 "enabled/disabled status) that is inherited from "
331 "EnabledLogicalElement. AdminStatus is deprecated in lieu "
332 "of this inherited property."),
333 ValueMap {"1", "2"},
334 Values {"Stop", "Start"},
335 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerAdminStatus"} ]
336 uint16 AdminStatus;
337 tony 1.1
338 [Description (
339 "This defines the negotiated version of BGP that is running "
340 "between the two peers."),
341 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerNegotiatedVersion"} ]
342 string NegotiatedVersion;
343
344 [Deprecated {"CIM_BindsTo", "CIM_IPProtocolEndpoint"},
345 Description (
346 "This is the local IP address of this router's BGP "
347 "connection. It is deprecated since a binding should be "
348 "defined using the CIM_BindsTo association. Ideally the "
349 "binding is to a TCPProtocolEndpoint which then handles the "
350 "association to its IPEndpoint."),
351 MappingStrings {"MIB.IETF|BGP4-MIB.bgpPeerLocalAddr"} ]
352 string LocalAddress;
353
354 [Deprecated {"CIM_BindsTo", "CIM_TCPProtocolEndpoint"},
355 Description (
356 "This is the local port number for the TCP connection of "
357 "this router's BGP connection. It is deprecated since a "
358 tony 1.1 "binding should be defined (to a TCPProtocolEndpoint) using "
359 "the CIM_BindsTo association."),
360 MappingStrings {"MIB.IETF|BGP4-MIB.bgpPeerLocalPort"} ]
361 uint16 LocalPort;
362
363 [Deprecated {"CIM_BindsTo", "CIM_RemoteServiceAccessPoint"},
364 Description (
365 "This is the remote IP address of this router's BGP "
366 "connection. It is deprecated since a binding to a Remote "
367 "ServiceAccessPoint should be instantiated, using "
368 "CIM_BindsTo."),
369 MappingStrings {"MIB.IETF|BGP4-MIB.bgpPeerRemoteAddr"} ]
370 string RemoteAddress;
371
372 [Deprecated {"CIM_BindsTo", "CIM_RemotePort"}, Description (
373 "This is the remote port number for the TCP connection of "
374 "this router's BGP connection. It is deprecated since a "
375 "binding to a RemotePort should be instantiated, using "
376 "CIM_BindsTo."),
377 MappingStrings {"MIB.IETF|BGP4-MIB.bgpPeerRemotePort"} ]
378 uint16 RemotePort;
379 tony 1.1
380 [Description (
381 "This is the remote AS number for this router's BGP "
382 "connection."),
383 MappingStrings {"MIB.IETF|BGP4-MIB.bgpPeerRemoteAs"} ]
384 uint16 RemoteAS;
385
386 [Description (
387 "This defines the time interval, in seconds, for the "
388 "ConnectRetry timer. The suggested value is 120 seconds."),
389 Units ("Seconds"),
390 MappingStrings { "MIB.IETF|BGP4-MIB.bgpConnectRetryInterval"} ]
391 uint32 ConnectRetryInterval = 120;
392
393 [Description (
394 "This defines the time interval in seconds for the Hold Time "
395 "configured for this BGP speaker with a peer. This value is "
396 "placed in an OPEN message sent to a peer by this BGP "
397 "speaker, and is compared with the Hold Time field in the "
398 "OPEN message received from the peer. It enables this "
399 "speaker to establish a mutually agreeable Hold Time with "
400 tony 1.1 "the peer. This value must not be less than three seconds. "
401 "If it is zero, then the Hold Time is NOT to be established "
402 "with the peer. The suggested value for this timer is 90 "
403 "seconds."),
404 Units ("Seconds"),
405 MappingStrings {"MIB.IETF|BGP4-MIB.bgpPeerHoldTimeConfigured"} ]
406 uint16 HoldTimeConfigured = 90;
407
408 [Description (
409 "This defines the time interval in seconds for the KeepAlive "
410 "timer configured for this BGP speaker with a peer. This "
411 "value will determine the frequency of the KEEPALIVE "
412 "messages relative to the value of the HoldTimeConfigured "
413 "property; the actual frequency is specified by the value of "
414 "the KeepAlive property. A reasonable value is one third of "
415 "that of the value of the HoldTimeConfigured property. If "
416 "it is zero, then NO periodic KEEPALIVE messages are sent to "
417 "the peer. The suggested value for this property is 30 "
418 "seconds. The maximum value of this property is 21845 "
419 "seconds."),
420 Units ("Seconds"),
421 tony 1.1 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerKeepAliveConfigured"} ]
422 uint16 KeepAliveConfigured = 30;
423
424 [Description (
425 "This defines the time interval in seconds for the "
426 "MinASOriginationInterval timer. The suggested value for "
427 "this property is 15 seconds."),
428 Units ("Seconds"),
429 MappingStrings
430 {"MIB.IETF|BGP4-MIB.bgpPeerMinASOriginationInterval"} ]
431 uint16 MinASOriginationInterval = 15;
432
433 [Description (
434 "This defines the time interval in seconds for the "
435 "MinRouteAdvertisementInterval timer. The suggested value "
436 "for this property is 30 seconds."),
437 Units ("Seconds"),
438 MappingStrings {
439 "MIB.IETF|BGP4-MIB.bgpPeerMinRouteAdvertisementInterval"} ]
440 uint16 MinRouteAdvertisementInterval = 30;
441
442 tony 1.1 [Description (
443 "This defines the maximum amount of time in seconds that may "
444 "elapse between the receipt of successive KEEPALIVE or "
445 "UPDATE messages. This is instrumented as a counter that "
446 "increments from zero to the value specified in this "
447 "property. The value of this property is calculated by the "
448 "BGP speaker by using the smaller of the values of "
449 "bgpPeerHoldTimeConfigured and the Hold Time received in the "
450 "OPEN message. This value, if not zero seconds, must be at "
451 "least three seconds, up to a maximum of 65535 seconds. "
452 "Receipt of either a KEEPALIVE or an UPDATE message resets "
453 "this value."),
454 Units ("Seconds"),
455 MappingStrings {"MIB.IETF|BGP4-MIB.bgpPeerHoldTime"} ]
456 uint16 HoldTime;
457
458 [Description (
459 "This defines the time interval in seconds for the KeepAlive "
460 "timer established with the peer. The value of this "
461 "property is calculated by the speaker such that, when "
462 "compared with the HoldTime property, it has the same "
463 tony 1.1 "proportion as the KeepAliveConfigured property has with the "
464 "HoldTimeConfigured property. A value of 0 indicates that "
465 "the KeepAlive timer has not yet been established. The "
466 "maximum value of this property is 21845 seconds."),
467 Units ("Seconds"),
468 MappingStrings {"MIB.IETF|BGP4-MIB.bgpPeerKeepAlive"} ]
469 uint16 KeepAlive;
470
471 [Experimental, Override ("ProtocolIFType"), Description (
472 "ProtocolIFType's enumeration is limited to BGP and reserved "
473 "values for this subclass of ProtocolEndpoint."),
474 ValueMap {"1", "222..4095", "4108", "4116..32767", "32768.."},
475 Values {"Other", "IANA Reserved", "BGP", "DMTF Reserved",
476 "Vendor Reserved"} ]
477 uint16 ProtocolIFType = 4108;
478 };
479
480
481 // ==================================================================
482 // ASBGPEndpoints
483 // ==================================================================
484 tony 1.1 [Association, Aggregation, Composition, Version ("2.7.0"),
485 Description (
486 "This aggregation defines the different router interfaces that "
487 "are running BGP in the AutonomousSystem.") ]
488 class CIM_ASBGPEndpoints : CIM_SystemComponent {
489
490 [Aggregate, Override ("GroupComponent"), Max (1), Description (
491 "The AutonomousSystem that aggregates the router interfaces "
492 "that are running BGP.") ]
493 CIM_AutonomousSystem REF GroupComponent;
494
495 [Override ("PartComponent"), Description (
496 "The router interfaces that are contained in the AS.") ]
497 CIM_BGPProtocolEndpoint REF PartComponent;
498 };
499
500
501 // ==================================================================
502 // IPXProtocolEndpoint
503 // ==================================================================
504 [Version ("2.7.1000"), Description (
505 tony 1.1 "An IPX communication point from which data may be sent or "
506 "received.") ]
507 class CIM_IPXProtocolEndpoint : CIM_ProtocolEndpoint {
508
509 [Description (
510 "An IPX address formatted as eight hexadecimal digits "
511 "representing the network number, followed by a colon, "
512 "followed by twelve hexadecimal digits representing the host "
513 "address (e.g. \"00112233:010203040506\").") ]
514 string Address;
515
516 [Experimental, Override ("ProtocolIFType"), Description (
517 "ProtocolIFType's enumeration is limited to IPX and reserved "
518 "values for this subclass of ProtocolEndpoint."),
519 ValueMap {"1", "222..4095", "4099", "4116..32767", "32768.."},
520 Values {"Other", "IANA Reserved", "IPX", "DMTF Reserved",
521 "Vendor Reserved"} ]
522 uint16 ProtocolIFType = 4099;
523 };
524
525
526 tony 1.1 // ==================================================================
527 // TCPProtocolEndpoint
528 // ==================================================================
529 [Version ("2.7.1000"), Description (
530 "A protocol endpoint that is dedicated to running TCP.") ]
531 class CIM_TCPProtocolEndpoint : CIM_ProtocolEndpoint {
532
533 [Description (
534 "The TCP port number.") ]
535 uint32 PortNumber;
536
537 [Experimental, Override ("ProtocolIFType"), Description (
538 "ProtocolIFType's enumeration is limited to TCP and reserved "
539 "values for this subclass of ProtocolEndpoint."),
540 ValueMap {"1", "222..4095", "4111", "4116..32767", "32768.."},
541 Values {"Other", "IANA Reserved", "TCP", "DMTF Reserved",
542 "Vendor Reserved"} ]
543 uint16 ProtocolIFType = 4111;
544 };
545
546
547 tony 1.1 // ==================================================================
548 // UDPProtocolEndpoint
549 // ==================================================================
550 [Version ("2.7.1000"), Description (
551 "A protocol endpoint that is dedicated to running UDP.") ]
552 class CIM_UDPProtocolEndpoint : CIM_ProtocolEndpoint {
553
554 [Description (
555 "The UDP port number.") ]
556 uint32 PortNumber;
557
558 [Experimental, Override ("ProtocolIFType"), Description (
559 "ProtocolIFType's enumeration is limited to UDP and reserved "
560 "values for this subclass of ProtocolEndpoint."),
561 ValueMap {"1", "222..4095", "4110", "4116..32767", "32768.."},
562 Values {"Other", "IANA Reserved", "UDP", "DMTF Reserved",
563 "Vendor Reserved"} ]
564 uint16 ProtocolIFType = 4110;
565 };
566
567
568 tony 1.1 // ====================================================================
569 // OSPFProtocolEndpointBase
570 // ====================================================================
571 [Version ("2.7.1000"), Description (
572 "Base class for OSPF protocol endpoints, defining several "
573 "general properties.") ]
574 class CIM_OSPFProtocolEndpointBase : CIM_ProtocolEndpoint {
575
576 [Override ("EnabledState"), Description (
577 "The operational status of the interface, see "
578 "ospfIfAdminStat in RFC 1850. This is an integer "
579 "enumeration whose complete definition is found in the "
580 "EnabledLogicalElement class."),
581 MappingStrings {"MIB.IETF|OSPF-MIB.ospfIfAdminStat"} ]
582 uint16 EnabledState;
583
584 [Description (
585 "Estimated delay, in seconds that it takes to transmit a "
586 "Link State Update Packet over this interface, see C.3 in "
587 "RFC 2328."),
588 Units ("Seconds"),
589 tony 1.1 MappingStrings {"MIB.IETF|OSPF-MIB.ospfIfTransitDelay"} ]
590 uint16 TransitDelay;
591
592 [Description (
593 "The number of seconds between LSA (Link State "
594 "Advertisement) retransmissions, see C.3 in RFC 2328."),
595 Units ("Seconds"),
596 MappingStrings {"MIB.IETF|OSPF-MIB.ospfIfRetransInterval"} ]
597 uint16 RetransmitInterval;
598
599 [Required, Description (
600 "Identifies the authentication procedure to be used on the "
601 "attached network, see C.3 in RFC 2328."),
602 ValueMap {"1", "2", "3", "4"},
603 Values {"Other", "Null authentication", "Simple password",
604 "Cryptographic authentication"},
605 MappingStrings {"MIB.IETF|OSPF-MIB.ospfIfAuthType"} ]
606 uint16 AuthType;
607
608 [Description (
609 "Specifies the authentication procedure if the value, "
610 tony 1.1 "\"Other\" (1) is set for AuthType."),
611 ModelCorrespondence {"CIM_OSPFProtocolEndpoint.AuthType"} ]
612 string OtherAuthType;
613
614 [Description (
615 "This key is used during the authentication procedure to "
616 "verify OSPF protocol packets, see C.3 RFC 2328. It is used "
617 "in the \"Simple password\" and in the \"Cryptographic "
618 "authentication\" case too."),
619 MappingStrings {"MIB.IETF|OSPF-MIB.ospfIfAuthKey"} ]
620 string AuthKey;
621
622 [Experimental, Override ("ProtocolIFType"), Description (
623 "ProtocolIFType's enumeration is limited to OSPF and "
624 "reserved values for this subclass of ProtocolEndpoint."),
625 ValueMap {"1", "222..4095", "4109", "4116..32767", "32768.."},
626 Values {"Other", "IANA Reserved", "OSPF", "DMTF Reserved",
627 "Vendor Reserved"} ]
628 uint16 ProtocolIFType = 4109;
629 };
630
631 tony 1.1
632 // ====================================================================
633 // OSPFProtocolEndpoint
634 // ====================================================================
635 [Version ("2.7.0"), Description (
636 "This class represents the OSPF configuration of an interface "
637 "running OSPF. The instance of this class should be connected "
638 "to an IPProtocolEndpoint instance via a BindsTo association. "
639 "The IPProtocolEndpoint instance is the Antecedent and the "
640 "OSPFProtocolEndpoint instance is the Dependent in the BindsTo "
641 "association.") ]
642 class CIM_OSPFProtocolEndpoint : CIM_OSPFProtocolEndpointBase {
643
644 [Description (
645 "When two routers attached to a network both attempt to "
646 "become the Designated Router, the one with the highest "
647 "(i.e. largest) Priority takes precedence, see C.3 in RFC "
648 "2328. Only routers with greater than zero priority are "
649 "eligible to become Designated Router."),
650 MappingStrings {"MIB.IETF|OSPF-MIB.ospfIfRtrPriority"} ]
651 uint8 Priority;
652 tony 1.1
653 [Description (
654 "If a neighbouring router on an NBMA (NonBroadcast "
655 "MultiAccess) link becomes inactive, it is still necessary "
656 "to send Hello Packets to the dead neighbor. These packets "
657 "will be sent at the reduced rate, which should be much "
658 "larger than HelloInterval, see C.5 in RFC 2328."),
659 Units ("Seconds"),
660 MappingStrings {"MIB.IETF|OSPF-MIB.ospfIfPollInterval"} ]
661 uint16 PollInterval;
662
663 [Description (
664 "The cost of the routes through this OSPF endpoint, see C.3 "
665 "in RFC 2328."),
666 MappingStrings {"MIB.IETF|OSPF-MIB.ospfIfMetricStatus"} ]
667 uint16 Cost;
668
669 [Description (
670 "Indicates whether the interface connects to an on-demand "
671 "circuit, see RFC 1793."),
672 MappingStrings {"MIB.IETF|OSPF-MIB.ospfIfDemand"} ]
673 tony 1.1 boolean IfDemand;
674 };
675
676
677 // ====================================================================
678 // OSPFVirtualInterface
679 // ====================================================================
680 [Version ("2.7.0"), Description (
681 "This class represent an OSPF protocol endpoint on a virtual "
682 "link. The definition of a virtual link from RFC2328, is "
683 "'Virtual links can be configured between any two backbone "
684 "routers that have an interface to a common non-backbone area. "
685 "Virtual links belong to the backbone. The protocol treats two "
686 "routers joined by a virtual link as if they were connected by "
687 "an unnumbered point-to-point backbone network.'") ]
688 class CIM_OSPFVirtualInterface : CIM_OSPFProtocolEndpointBase {
689 };
690
691
692 // ===================================================================
693 // EndpointIdentity
694 tony 1.1 // ===================================================================
695 [Association, Version ("2.6.0"), Description (
696 "CIM_EndpointIdentity indicates that two ProtocolEndpoints "
697 "represent different aspects of the same underlying address or "
698 "protocol-specific ID. This association refines the "
699 "CIM_LogicalIdentity superclass by restricting it to the "
700 "Endpoint level and defining its use in well understood "
701 "scenarios. One of these scenarios is to represent that an "
702 "Endpoint has both 'LAN' and protocol-specific aspects. For "
703 "example, an Endpoint could be both a LANEndpoint as well as a "
704 "DHCPEndpoint.") ]
705 class CIM_EndpointIdentity : CIM_LogicalIdentity {
706
707 [Override ("SystemElement"), Description (
708 "SystemElement represents one aspect of the Endpoint.") ]
709 CIM_ProtocolEndpoint ref SystemElement;
710
711 [Override ("SameElement"), Description (
712 "SameElement represents an alternate aspect of the "
713 "Endpoint.") ]
714 CIM_ProtocolEndpoint ref SameElement;
715 tony 1.1 };
716
717
718 // ===================================================================
719 // SwitchPort
720 // ===================================================================
721 [Version ("2.7.0"), Description (
722 "Switch Port from which frames are received and out which they "
723 "are transmitted. This endpoint is associated with its "
724 "networking interface (such as Ethernet) via the "
725 "EndpointIdentity relationship.") ]
726 class CIM_SwitchPort : CIM_ProtocolEndpoint {
727
728 [Description (
729 "Numeric identifier for a switch port."),
730 MappingStrings {"MIB.IETF|BRIDGE-MIB.dot1dPort"} ]
731 uint16 PortNumber;
732 };
733
734 // ==================================================================
735 // MPLSProtocolEndpoint
736 tony 1.1 // ==================================================================
737 [Experimental, Version ("2.7.1000"), Description (
738 "This is the representation of an MPLS interface on a Label "
739 "Switch Router (LSR).") ]
740 class CIM_MPLSProtocolEndpoint : CIM_ProtocolEndpoint {
741
742 [Description (
743 "If this property is true, the Label Min/Max In/Out values "
744 "of the ProtocolEndpoint's MPLSCapabilities overrule the "
745 "values specified for the Label Switched Router as a whole "
746 "(where the LSR is indicated by the existence of an "
747 "MPLSService). Note that the min/max in/out labels are only "
748 "defined in the MPLSCapabilities class, which is associated "
749 "with either an MPLSService or an MPLSProtocolEndpoint via "
750 "the CIM_ElementCapabilities relationship.") ]
751 boolean OverruleLSR;
752
753 [Description (
754 "This property indicates the total amount of usable "
755 "bandwidth on this interface and is specified in kilobits "
756 "per second (Kbps)."),
757 tony 1.1 Units ("KiloBits per Second"),
758 MappingStrings {
759 "MIB.IETF|MPLS-LSR-MIB.MPLSInterfaceTotalBandwidth"} ]
760 uint32 TotalBandwidth;
761
762 [Description (
763 "This property indicates the total amount of available "
764 "bandwidth for the interface and is specified in kilobits "
765 "per second (Kbps). This value is calculated as the "
766 "difference between the amount of bandwidth currently in use "
767 "and that specified in TotalBandwidth. Note that this is "
768 "not statistical data, since change is not frequent, and the "
769 "property can be regarded as the 'current state' of the "
770 "network. It is intended that this data be used by "
771 "applications doing centralized LSP provisioning."),
772 Units ("KiloBits per Second"),
773 MappingStrings {
774 "MIB.IETF|MPLS-LSR-MIB.MPLSInterfaceAvailableBandwidth"},
775 ModelCorrespondence { "CIM_MPLSProtocolEndpoint.TotalBandwidth"} ]
776 uint32 AvailableBandwidth;
777
778 tony 1.1 [Description (
779 "The ResourceClasses property defines a 32-bit vector "
780 "representing the classes associated with a link, where the "
781 "link originates at this ProtocolEndpoint. A resource class "
782 "is described in [RFC2702].") ]
783 uint32 ResourceClasses;
784 };
785
786 // ==================================================================
787 // WirelessLANEndpoint
788 // ==================================================================
789 [Experimental, Version ("2.7.1000"), Description (
790 "A ProtocolEndpoint supporting 802.11 wireless networking.") ]
791 class CIM_WirelessLANEndpoint : CIM_ProtocolEndpoint {
792
793 [Override ("Name"), Description (
794 "The MAC Address of the wireless endpoint.") ]
795 string Name;
796
797 [Override ("ProtocolIFType"), Description (
798 "ProtocolIFType's enumeration is limited to wirelss-related "
799 tony 1.1 "and reserved values for this subclass of ProtocolEndpoint."),
800 ValueMap {"1", "71", "222..4095", "4112", "4113", "4114",
801 "4115", "4116..32767", "32768.."},
802 Values {"Other", "IEEE 802.11", "IANA Reserved", "802.11a",
803 "802.11b", "802.11g", "802.11h", "DMTF Reserved",
804 "Vendor Reserved"} ]
805 uint16 ProtocolIFType = 71;
806
807 [Description (
808 "A 32-character identifier (the Service Set Identifier) that "
809 "is inserted into the header of packets transmitted from the "
810 "endpoint. This identifier helps to distinguish one "
811 "Wireless LAN from another."),
812 MaxLen (32) ]
813 string SSID;
814
815 [Description (
816 "Boolean indicating whether the Wired Equivalent Privacy "
817 "algorithm is enabled for communications on this endpoint. "
818 "By default, this property is set to FALSE.") ]
819 boolean WEPEnabled = FALSE;
820 tony 1.1
821 [Description (
822 "Boolean indicating whether WEP key mixing is used. By "
823 "default, this property is set to FALSE.") ]
824 boolean WEPKeyMixEnabled = FALSE;
825 };
826
827 // ===================================================================
828 // end of file
829 // ===================================================================
|