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