1 a.dunfey 1.1 // ===================================================================
2 // Title: Network_BGP
3 // $State: Exp $
4 // $Date: 2004/11/29 18:31:42 $
5 // $RCSfile: Network_BGP.mof,v $
6 // $Revision: 1.3.2.3 $
7 // ===================================================================
8 //#pragma inLine ("Includes/copyright.inc")
9 // Copyright 1998-2005 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 a.dunfey 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 a.dunfey 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 the classes that model
49 // BGP (Border Gateway Protocol).
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 // Change Log for v2.7
56 // CR792 - Add the Composition qualifer to BGPClustersInAS,
57 // ASBGPEndpoints, and Confederation
58 // CR863 - Update the format of the MappingStrings qualifier when
59 // referencing IETF RFCs
60 // CR866 - Fixes to the BGP Model
61 // CR920 - BGPAttributes.AtomicAggregate is incorrectly defined with
62 // Values/ValueMap qualifiers when it is a boolean - these
63 // qualifiers must be removed and the Description updated
64 a.dunfey 1.1 // CR965 - Update Description for BGPIPRoute
65 // CR982 - Removal of Experimental for preliminary to final
66 // CR983 - v2.7 Deprecations promoted to final
67 // Change Log for v2.8
68 // CR1128 - Change subclassing from CIM_Dependency to
69 // CIM_HostedDependency for identified classes. This is
70 // needed as a result of the introduction of HostedDependency
71 // by SysDev
72 // CR1232 - Updated reference
73 // Property CIM_BGPStatistics.InUpdateElapsedTime
74 // (CIM_BGPEndpointStatistics.InUpdateEstablishedTime
75 // Property CIM_BGPRouteMap.OtherMatchConditionType
76 // (CIM_RouteMap.MatchConditionType)
77 // Property CIM_BGPRouteMap.MatchConditionType
78 // (CIM_RouteMap.OtherMatchConditionType)
79 // CR1238 - Fix model correspondece reference problems in final version
80 // ===================================================================
81
82 #pragma Locale ("en_US")
83
84
85 a.dunfey 1.1 // ==================================================================
86 // BGPService
87 // ==================================================================
88 [Version ( "2.7.0" ), Description (
89 "This class is used to represent the basic operation of BGP. It "
90 "is derived from RouteCalculationService, the superclass of all "
91 "routing protocols.")]
92 class CIM_BGPService : CIM_RouteCalculationService {
93
94 [Description (
95 "The BGPVersion property defines the version of BGP that "
96 "this router is using. This is part of the BGP peer "
97 "negotiation process)."),
98 MappingStrings { "MIB.IETF|BGP4-MIB.bgpVersion" }]
99 uint8 BGPVersion;
100
101 [Description (
102 "BGP sends errors using a NOTIFICATION message. This message "
103 "contains an error code, an error subcode, and error data. "
104 "The error code defines the type of the notification. The "
105 "'Cease' error is for all fatal errors that are not one of "
106 a.dunfey 1.1 "the other five types of errors. For several of the errors, "
107 "subcode information is also enumerated in other properties "
108 "of this class."),
109 ValueMap { "0", "1", "2", "3", "4", "5", "6" },
110 Values { "None", "Message Header Error", "OPEN Message Error",
111 "UPDATE Message Error", "Hold Timer Expired",
112 "Finite State Machine Error", "Cease" }]
113 uint16 LastErrorCode;
114
115 [Description (
116 "This defines the BGP error subcode for message header "
117 "errors (LastErrorCode = 1). If LastErrorCode is any other "
118 "value, then this property should be set to NULL."),
119 ValueMap { "0", "1", "2", "3" },
120 Values { "None", "Connection Not Synchronized",
121 "Bad Message Length", "Bad Message Type" }]
122 uint16 LastMessageErrorSubCode;
123
124 [Description (
125 "This defines the BGP error subcode for OPEN message errors "
126 "(LastErrorCode = 2). If LastErrorCode is any other value, "
127 a.dunfey 1.1 "then this property should be set to NULL."),
128 ValueMap { "0", "1", "2", "3", "4", "5", "6" },
129 Values { "None", "Unsupported Version Number", "Bad Peer AS",
130 "Bad BGP Identifier", "Unsupported Optional Parameter",
131 "Authentication Failure", "Unacceptable Hold Time" }]
132 uint16 LastOpenErrorSubCode;
133
134 [Description (
135 "This defines the BGP error subcode for UPDATE message "
136 "errors (LastErrorCode = 3). If LastErrorCode is any other "
137 "value, then this property should be set to NULL."),
138 ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
139 "10", "11" },
140 Values { "None", "Malformed Attribute List",
141 "Unrecognized Well-Known Attribute",
142 "Missing Well-Known Attribute", "Attribute Flags Error",
143 "Attribute Length Error", "Invalid Origin Attribute",
144 "AS Routing Loop", "Invalid NEXT_HOP Attribute",
145 "Optional Attribute Error", "Invalid Network Field",
146 "Malformed AS_path" }]
147 uint16 LastUpdateErrorSubCode;
148 a.dunfey 1.1 };
149
150
151 // ==================================================================
152 // BGPAdminDistance
153 // ==================================================================
154 [Association, Version ( "2.6.0" ), Description (
155 "This is a specialization of the Dependency association, and "
156 "defines the relationship between a BGPService and the "
157 "AdministrativeDistances that it uses to control the (BGP) "
158 "routing decisions that it makes.")]
159 class CIM_BGPAdminDistance : CIM_Dependency {
160
161 [Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
162 "The table of (global) administrative distances that are "
163 "used by the BGPService.")]
164 CIM_AdministrativeDistance REF Antecedent;
165
166 [Override ( "Dependent" ), Description (
167 "The BGPService object that makes BGP routing decisions.")]
168 CIM_BGPService REF Dependent;
169 a.dunfey 1.1 };
170
171
172 // ==================================================================
173 // BGPCluster
174 // ==================================================================
175 [Version ( "2.6.0" ), Description (
176 "The BGP speakers in an AS are required to be fully meshed. "
177 "This can lead to a huge number of TCP connections per router. "
178 "One way to reduce the peering requirements is to use a route "
179 "reflector. This is based on specifying one or more routers to "
180 "act as focal points for IBGP sessions. \n"
181 "\n"
182 "The route reflector as a whole is called a cluster. It is "
183 "logically divided into three types of routers: reflectors, "
184 "clients of the route reflector(s), and non-clients of the "
185 "route reflector. There can be more than one route reflector in "
186 "a cluster, and there can be more than one cluster in an AS.")]
187 class CIM_BGPCluster : CIM_CollectionOfMSEs {
188
189 [Key, Description (
190 a.dunfey 1.1 "If a cluster has more than one route reflector, all of the "
191 "route reflectors in the cluster need to be configured with "
192 "a 4-byte cluster ID. This allows route reflectors to "
193 "recognize updates from other route reflectors in the same "
194 "cluster.")]
195 uint32 ClusterID;
196 };
197
198
199 // ==================================================================
200 // RoutersInBGPCluster
201 // ==================================================================
202 [Association, Aggregation, Version ( "2.6.0" ), Description (
203 "This aggregation establishes the routers (ComputerSystems) in "
204 "a BGPCluster. At least three routers are required to form a "
205 "cluster - a reflector and two clients. The routers that form a "
206 "cluster share common configuration information.")]
207 class CIM_RoutersInBGPCluster : CIM_CollectedMSEs {
208
209 [Aggregate, Override ( "Collection" ), Max ( 1 ), Description (
210 "The Cluster that aggregates the routers participating in "
211 a.dunfey 1.1 "it.")]
212 CIM_BGPCluster REF Collection;
213
214 [Override ( "Member" ), Min ( 3 ), Description (
215 "The routers that form the Cluster.")]
216 CIM_ComputerSystem REF Member;
217 };
218
219
220 // ==================================================================
221 // BGPClustersInAS
222 // ==================================================================
223 [Association, Aggregation, Composition, Version ( "2.7.0" ),
224 Description (
225 "This aggregation establishes 'whole-part' relationships "
226 "between an AutonomousSystem and the BGPClusters that it "
227 "contains.")]
228 class CIM_BGPClustersInAS {
229
230 [Key, Aggregate, Max ( 1 ), Description (
231 "The AutonomousSystem that aggregates the Clusters belonging "
232 a.dunfey 1.1 "to it and administers them.")]
233 CIM_AutonomousSystem REF GroupAS;
234
235 [Key, Description (
236 "The Clusters that are contained in the AS.")]
237 CIM_BGPCluster REF PartAS;
238 };
239
240
241 // ==================================================================
242 // Confederation
243 // ==================================================================
244 [Association, Aggregation, Composition, Version ( "2.7.0" ),
245 Description (
246 "The BGP speakers in an AS are required to be fully meshed. "
247 "This can lead to a huge number of TCP connections per router. "
248 "One way to reduce the peering requirements is to use a "
249 "confederation. A confederation effectively partitions one AS "
250 "into a group of 'sub-ASs'. This enables all of the benefits of "
251 "IBGP to be applied inside the confederation, while enabling "
252 "EBGP to be run between each confederation. It also enables "
253 a.dunfey 1.1 "certain BGP attribute values to be preserved between "
254 "confederations. However, to the outside world, the AS with its "
255 "confederations appear to be a single AS.")]
256 class CIM_Confederation : CIM_SystemComponent {
257
258 [Aggregate, Override ( "GroupComponent" ), Max ( 1 ),
259 Description (
260 "The AutonomousSystem that contains the confederations.")]
261 CIM_AutonomousSystem REF GroupComponent;
262
263 [Override ( "PartComponent" ), Description (
264 "The Confederation within the AutonomousSystem.")]
265 CIM_AutonomousSystem REF PartComponent;
266
267 [Description (
268 "A unique identifier of the AutonomousSystem that contains "
269 "the confederations.")]
270 uint32 ParentASNumber;
271
272 [Description (
273 "A unique identifier of the Confederation within the "
274 a.dunfey 1.1 "AutonomousSystem.")]
275 uint32 ChildASNumber;
276 };
277
278
279 // ==================================================================
280 // BGPIPRoute
281 // ==================================================================
282 [Version ( "2.6.0" ), Description (
283 "BGPIPRoute describes a BGP routing entry that connects two "
284 "peer routers that are running BGP. The source and destination "
285 "addresses may be either specific IP endpoints or IP subnets. "
286 "Examining the BGPIPRoute class definition, note that its "
287 "superclass IPRoute is deprecated. Unfortunately, IPRoute "
288 "cannot be removed from the object hierarchy without a major "
289 "Schema release. When/if this occurs, the IPRoute superclass "
290 "will be removed, and BGPIPRoute will subclass from "
291 "CIM_NextHopRouting directly.")]
292 class CIM_BGPIPRoute : CIM_IPRoute {
293
294 [Description (
295 a.dunfey 1.1 "Usually, the administrative distance is used to determine "
296 "which route gets installed in the routing table. Using this "
297 "scheme, routes learned via EBGP will win over routes "
298 "learned via an IGP. If this is not desired, then this "
299 "assigns the administrative distance of this route to be "
300 "equal to that of a local route, which means that the same "
301 "route learned by an IGP will have a lower administrative "
302 "distance and be installed instead.")]
303 boolean IsBackDoorRoute;
304
305 [Description (
306 "Loopback interfaces are often used by IBGP peers, because "
307 "they eliminate a dependency that would otherwise occur if "
308 "the actual IP address of a physical interface was used to "
309 "configure BGP. The loopback interface instead instructs the "
310 "router to use any available interface.")]
311 boolean UsesLoopbackPeering;
312 };
313
314
315 // ==================================================================
316 a.dunfey 1.1 // RoutesBGP
317 // ==================================================================
318 [Association, Version ( "2.6.0" ), Description (
319 "This association defines a BGP route, and makes explicit the "
320 "dependency between a BGPIPRoute and a BGPProtocolEndpoint.")]
321 class CIM_RoutesBGP : CIM_Dependency {
322
323 [Override ( "Antecedent" ), Max ( 2 ), Description (
324 "The BGPProtocolEndpoints that represent the source and "
325 "destination (or at least the next hop) of the BGP route.")]
326 CIM_BGPProtocolEndpoint REF Antecedent;
327
328 [Override ( "Dependent" ), Min ( 1 ), Description (
329 "The routing table entry that represents a BGP route.")]
330 CIM_BGPIPRoute REF Dependent;
331 };
332
333
334 // ==================================================================
335 // EGPRouteCalcDependency
336 // ==================================================================
337 a.dunfey 1.1 [Association, Version ( "2.6.0" ), Description (
338 "This is a specialization of ServiceServiceDependency, and "
339 "captures the dependency that external gateway protocols (such "
340 "as BGP) have on interior gateway protocols (such as OSPF).")]
341 class CIM_EGPRouteCalcDependency : CIM_ServiceServiceDependency {
342
343 [Override ( "Antecedent" ), Description (
344 "The independent RouteCalculationService that provides "
345 "routing information from the AS, for the EGP to use.")]
346 CIM_RouteCalculationService REF Antecedent;
347
348 [Override ( "Dependent" ), Description (
349 "The dependent RouteCalculationService (e.g., the Route "
350 "CalculationService) that is functioning as an EGP.")]
351 CIM_RouteCalculationService REF Dependent;
352
353 [Description (
354 "Sometimes it is necessary to inject EGP information, such "
355 "as that from BGP, into IGPs. This attribute defines whether "
356 "this should be done for the two routing protocols that are "
357 "defined by this association. The values below mean that no, "
358 a.dunfey 1.1 "partial, and full EGP information is injected into the IGP, "
359 "respectively."),
360 ValueMap { "1", "2", "3" },
361 Values { "None", "Partial", "Full" }]
362 uint16 IGPInjection;
363 };
364
365
366 // ==================================================================
367 // BGPPeerGroup
368 // ==================================================================
369 [Version ( "2.7.0" ), Description (
370 "A BGP Peer Group is a set of BGP neighbors that share the same "
371 "update policies. This enables an administrator to assign "
372 "policies to the peer group, instead of individually. This "
373 "enables the routers in the Peer Group to optimize UPDATE "
374 "messages. Consequently, Peer Groups have a set of restrictions "
375 "that must be followed in order to work correctly with external "
376 "BGP peers. Otherwise, loss of routing information could occur. "
377 "\n\n"
378 "A BGPPeerGroup is weak to the AutonomousSystem that contains "
379 a.dunfey 1.1 "it. Therefore, the keys from System must be propagated to it.")]
380 class CIM_BGPPeerGroup : CIM_CollectionOfMSEs {
381
382 [Key, Propagated ( "CIM_AutonomousSystem.CreationClassName" ),
383 Description (
384 "The scoping AutonomousSystem's CreationClassName."),
385 MaxLen ( 256 )]
386 string SystemCreationClassName;
387
388 [Key, Propagated ( "CIM_AutonomousSystem.Name" ), Description (
389 "The scoping AutonomousSystem's Name."),
390 MaxLen ( 256 )]
391 string SystemName;
392
393 [Key, Description (
394 "CreationClassName indicates the name of the class or the "
395 "subclass used in the creation of an instance. When used "
396 "with the other key properties of this class, this property "
397 "allows all instances of this class and its subclasses to be "
398 "uniquely identified.")]
399 string CreationClassName;
400 a.dunfey 1.1
401 [Key, Description (
402 "This is the name of the BGP Peer Group."),
403 MaxLen ( 256 )]
404 string Name;
405
406 [Description (
407 "This defines the time interval, in seconds, for the "
408 "ConnectRetry timer for the endpoints of the routers in the "
409 "PeerGroup. The suggested value is 120 seconds."),
410 Units ( "Seconds" ),
411 MappingStrings { "MIB.IETF|BGP4-MIB.bgpConnectRetryInterval" }]
412 uint32 ConnectRetryInterval = 120;
413
414 [Description (
415 "This defines the time interval in seconds for the Hold "
416 "TimeConfigured property of the endpoints of the routers in "
417 "the PeerGroup. This value must not be less than three "
418 "seconds. The suggested value for this timer is 90 seconds."),
419 Units ( "Seconds" ),
420 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerHoldTimeConfigured" }]
421 a.dunfey 1.1 uint16 HoldTimeConfigured = 90;
422
423 [Description (
424 "This defines the time interval in seconds for the "
425 "KeepAliveConfigured timer for the endpoints of the routers "
426 "in the PeerGroup. The suggested value for this property is "
427 "30 seconds. The maximum value of this property is 21845 "
428 "seconds."),
429 Units ( "Seconds" ),
430 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerKeepAliveConfigured"
431 }]
432 uint16 KeepAliveConfigured = 30;
433
434 [Description (
435 "This defines the time interval in seconds for the "
436 "MinASOriginationInterval timer for the endpoints of the "
437 "routers in the PeerGroup. The suggested value for this "
438 "property is 15 seconds."),
439 Units ( "Seconds" ),
440 MappingStrings {
441 "MIB.IETF|BGP4-MIB.bgpPeerMinASOriginationInterval" }]
442 a.dunfey 1.1 uint16 MinASOriginationInterval = 15;
443
444 [Description (
445 "This defines the time interval in seconds for the "
446 "MinRouteAdvertisementInterval timer for the endpoints of "
447 "the routers in the PeerGroup. The suggested value for this "
448 "property is 30 seconds."),
449 Units ( "Seconds" ),
450 MappingStrings {
451 "MIB.IETF|BGP4-MIB.bgpPeerMinRouteAdvertisementInterval" }]
452 uint16 MinRouteAdvertisementInterval = 30;
453 };
454
455
456 // ==================================================================
457 // HostedBGPPeerGroup
458 // ==================================================================
459 [Association, Version ( "2.6.0" ), Description (
460 "A BGPPeerGroup is weak to the AutonomousSystem that contains "
461 "it. This association formalizes that relationship.")]
462 class CIM_HostedBGPPeerGroup : CIM_HostedDependency {
463 a.dunfey 1.1
464 [Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
465 "The AutonomousSystem that scopes the BGP peer group.")]
466 CIM_AutonomousSystem REF Antecedent;
467
468 [Override ( "Dependent" ), Weak, Description (
469 "The BGP peer group defined in the context of the "
470 "AutonomousSystem.")]
471 CIM_BGPPeerGroup REF Dependent;
472 };
473
474 // ==================================================================
475 // InBGPPeerGroup
476 // ==================================================================
477 [Association, Aggregation, Version ( "2.6.0" ), Description (
478 "This aggregation defines the specific routers (i.e., "
479 "ComputerSystems) that participate in a PeerGroup.")]
480 class CIM_InBGPPeerGroup : CIM_CollectedMSEs {
481
482 [Aggregate, Override ( "Collection" ), Max ( 1 ), Description (
483 "The PeerGroup that aggregates the routers.")]
484 a.dunfey 1.1 CIM_BGPPeerGroup REF Collection;
485
486 [Override ( "Member" ), Min ( 2 ), Description (
487 "The routers that comprise the PeerGroup.")]
488 CIM_ComputerSystem REF Member;
489 };
490
491
492 // ==================================================================
493 // BGPPeerGroupService
494 // ==================================================================
495 [Association, Version ( "2.7.0" ), Description (
496 "This defines the relationship between a BGPService and a "
497 "specific BGPPeerGroup in which it is executing.")]
498 class CIM_BGPPeerGroupService : CIM_Dependency {
499
500 [Override ( "Antecedent" ), Description (
501 "The BGPPeerGroup in which the BGPService is executing.")]
502 CIM_BGPPeerGroup REF Antecedent;
503
504 [Override ( "Dependent" ), Description (
505 a.dunfey 1.1 "The BGPService that is executing in the BGPPeerGroup.")]
506 CIM_BGPService REF Dependent;
507 };
508
509
510 // ==================================================================
511 // ReflectorService
512 // ==================================================================
513 [Association, Version ( "2.6.0" ), Description (
514 "This association will serve as the base class for defining and "
515 "distributing BGP routing information for the reflector of this "
516 "Cluster.")]
517 class CIM_ReflectorService : CIM_Dependency {
518
519 [Override ( "Antecedent" ), Max ( 1 ), Description (
520 "The Cluster for which this Service is being defined.")]
521 CIM_BGPCluster REF Antecedent;
522
523 [Override ( "Dependent" ), Min ( 1 ), Description (
524 "The BGPService which distributes routing information in the "
525 "Cluster.")]
526 a.dunfey 1.1 CIM_BGPService REF Dependent;
527 };
528
529
530 // ==================================================================
531 // ReflectorClientService
532 // ==================================================================
533 [Association, Version ( "2.6.0" ), Description (
534 "This association will serve as the base class for handling BGP "
535 "routing information for clients of the reflector of this "
536 "Cluster.")]
537 class CIM_ReflectorClientService : CIM_Dependency {
538
539 [Override ( "Antecedent" ), Max ( 1 ), Description (
540 "The Cluster for which this Service is being defined.")]
541 CIM_BGPCluster REF Antecedent;
542
543 [Override ( "Dependent" ), Min ( 1 ), Description (
544 "The BGPService to handles routing information as a client "
545 "in the Cluster.")]
546 CIM_BGPService REF Dependent;
547 a.dunfey 1.1 };
548
549
550 // ==================================================================
551 // ReflectorNonClientService
552 // ==================================================================
553 [Association, Version ( "2.6.0" ), Description (
554 "This association will serve as the base class for handling BGP "
555 "routing information for the non-clients of the reflector of "
556 "this Cluster.")]
557 class CIM_ReflectorNonClientService : CIM_Dependency {
558
559 [Override ( "Antecedent" ), Max ( 1 ), Description (
560 "The Cluster for which this Service is being defined.")]
561 CIM_BGPCluster REF Antecedent;
562
563 [Override ( "Dependent" ), Description (
564 "The BGPService which handles routing information as a "
565 "non-client of the Cluster.")]
566 CIM_BGPService REF Dependent;
567 };
568 a.dunfey 1.1
569
570 // ==================================================================
571 // BGPRoutingPolicy
572 // ==================================================================
573 [Association, Version ( "2.6.0" ), Description (
574 "This is a specialization of the Dependency association, and "
575 "defines the relationship between a BGPService and the "
576 "RoutingPolicy that control it.")]
577 class CIM_BGPRoutingPolicy : CIM_Dependency {
578
579 [Override ( "Antecedent" ), Description (
580 "The BGP routing policy object.")]
581 CIM_RoutingPolicy REF Antecedent;
582
583 [Override ( "Dependent" ), Description (
584 "The BGPService that operates according to the routing "
585 "policy.")]
586 CIM_BGPService REF Dependent;
587 };
588
589 a.dunfey 1.1
590 // ==================================================================
591 // BGPAttributes
592 // ==================================================================
593 [Version ( "2.7.0" ), Description (
594 "This class defines the BGP Attributes, that can be used to "
595 "affect routing decisions. BGPAttributes are specific to a "
596 "given AutonomousSystem that contains it. Hence, the keys of "
597 "the AutonomousSystem are propagated to this class.")]
598 class CIM_BGPAttributes : CIM_LogicalElement {
599
600 [Key, Propagated ( "CIM_AutonomousSystem.CreationClassName" ),
601 Description (
602 "The scoping AutonomousSystem's CreationClassName."),
603 MaxLen ( 256 )]
604 string SystemCreationClassName;
605
606 [Key, Propagated ( "CIM_AutonomousSystem.Name" ), Description (
607 "The scoping AutonomousSystem's Name."),
608 MaxLen ( 256 )]
609 string SystemName;
610 a.dunfey 1.1
611 [Key, Description (
612 "This defines the version of the BGP protocol.")]
613 string Version;
614
615 [Description (
616 "This defines the priority, or preference, of a route, in "
617 "order to better compare it with other routes for the same "
618 "destination. Higher values indicate a higher preference for "
619 "a route."),
620 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrLocalPref" }]
621 uint16 LocalPreference;
622
623 [Description (
624 "This attribute is a sequences of the AS numbers through "
625 "which routing information carried in this UPDATE message "
626 "has passed. The components of this list can be AS_SETs or "
627 "AS_SEQUENCEs."),
628 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrASPath" }]
629 string ASPath;
630
631 a.dunfey 1.1 [Description (
632 "This is the set of all elements contained in all specific "
633 "paths that are being summarized, so that those attributes "
634 "will remain available to the routing decision process.")]
635 string AsSet;
636
637 [Description (
638 "This attribute defines the IP address of the border router "
639 "that should be used as the next hop to the destinations "
640 "listed in the UPDATE message."),
641 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrNextHop" }]
642 string NextHop;
643
644 [Description (
645 "This defines the next hop to be the IP address of the "
646 "border IBGP neighbor.")]
647 string NextHopSelf;
648
649 [Description (
650 "This is used on external (e.g., inter-AS) links to indicate "
651 "which is the preferred entry point into an AS, when that AS "
652 a.dunfey 1.1 "has multiple entry points. Lower MED values have "
653 "preference."),
654 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrMultiExitDisc" }]
655 uint32 MED;
656
657 [Description (
658 "This defines a group of destinations that share a similar "
659 "property. Communities are not restricted to a single AS, "
660 "and can span multiple ASs. This attribute is used to "
661 "simplify routing policies by basing policies on a logical "
662 "value, as opposed to an IP address or an AS number.")]
663 uint32 BGPCommunityValue;
664
665 [Description (
666 "This property is set to TRUE if there are overlapping "
667 "routes, and a less-specific route is selected instead of a "
668 "more specific one (e.g., a system propagates an aggregate "
669 "that causes loss of information). The value is set to FALSE "
670 "if a less-specific route is NOT selected."),
671 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrAtomicAggregate"
672 }]
673 a.dunfey 1.1 boolean AtomicAggregate;
674
675 [Description (
676 "This specifies the AS and IP address of the router that has "
677 "generated an aggregate."),
678 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrAggregatorAS" }]
679 string Aggregator;
680
681 [Description (
682 "This is generated by the AS that originates the routing "
683 "information. There are three types of origins - IGP, EGP, "
684 "and INCOMPLETE. These correspond to whether the information "
685 "was learned internally in the AS, externally via an EGP, or "
686 "by some other means."),
687 ValueMap { "1", "2", "3" },
688 Values { "IGP", "EGP", "INCOMPLETE" },
689 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrOrigin" }]
690 uint16 Origin;
691
692 [Description (
693 "This is the router ID for the ORIGIN attribute.")]
694 a.dunfey 1.1 string OriginatorID;
695 };
696
697
698 // ==================================================================
699 // HostedBGPAttributes
700 // ==================================================================
701 [Association, Version ( "2.7.0" ), Description (
702 "The class BGPAttributes is weak to the AutonomousSystem that "
703 "contains it. This association formalizes that relationship.")]
704 class CIM_HostedBGPAttributes : CIM_HostedDependency {
705
706 [Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
707 "The AutonomousSystem that scopes the BGP attributes.")]
708 CIM_AutonomousSystem REF Antecedent;
709
710 [Override ( "Dependent" ), Weak, Description (
711 "The BGP attributes defined in the context of the "
712 "AutonomousSystem.")]
713 CIM_BGPAttributes REF Dependent;
714 };
715 a.dunfey 1.1
716
717 // ==================================================================
718 // FilteredBGPAttributes
719 // ==================================================================
720 [Association, Aggregation, Version ( "2.7.0" ), Description (
721 "This is a specialization of the Component aggregation, which "
722 "is used to define the set of BGP Attributes that are used by a "
723 "particular Routing Policy.")]
724 class CIM_FilteredBGPAttributes : CIM_Component {
725
726 [Aggregate, Override ( "GroupComponent" ), Description (
727 "The RoutingPolicy, which aggregates a set of BGP "
728 "attributes.")]
729 CIM_RoutingPolicy REF GroupComponent;
730
731 [Override ( "PartComponent" ), Description (
732 "A BGP attribute, which is part-of the RoutingPolicy.")]
733 CIM_BGPAttributes REF PartComponent;
734 };
735
736 a.dunfey 1.1
737 // ==================================================================
738 // BGPRouteMap
739 // ==================================================================
740 [Version ( "2.7.0" ), Description (
741 "A route map is used to control and modify routing information "
742 "as well as to define when a route is redistributed between "
743 "routing domains. Route maps are placed in router configuration "
744 "files, and several instances of the same route map may be used "
745 "to implement different actions. RouteMaps MAY use FilterLists "
746 "to identify the route. \n"
747 "\n"
748 "A BGPRouteMap is specific to a given AutonomousSystem that "
749 "contains it. Hence, the keys of the AutonomousSystem are "
750 "propagated to this class.")]
751 class CIM_BGPRouteMap : CIM_LogicalElement {
752
753 [Key, Propagated ( "CIM_AutonomousSystem.CreationClassName" ),
754 Description (
755 "The scoping AutonomousSystem's CreationClassName."),
756 MaxLen ( 256 )]
757 a.dunfey 1.1 string SystemCreationClassName;
758
759 [Key, Propagated ( "CIM_AutonomousSystem.Name" ), Description (
760 "The scoping AutonomousSystem's Name."),
761 MaxLen ( 256 )]
762 string SystemName;
763
764 [Key, Description (
765 "CreationClassName indicates the name of the class or the "
766 "subclass used in the creation of an instance. When used "
767 "with the other key properties of this class, this property "
768 "allows all instances of this class and its subclasses to be "
769 "uniquely identified.")]
770 string CreationClassName;
771
772 [Key, Override ( "Name" ), Description (
773 "This is the name of the RouteMap class."),
774 MaxLen ( 256 )]
775 string Name;
776
777 [Description (
778 a.dunfey 1.1 "This defines whether this RouteMap is used for input, "
779 "output, or both input and output filtering."),
780 ValueMap { "1", "2", "3" },
781 Values { "Input", "Output", "Both" }]
782 uint16 Direction;
783
784 [Description (
785 "This defines whether the action should be to forward or "
786 "deny traffic meeting the match condition specified in this "
787 "RouteMap."),
788 ValueMap { "1", "2" },
789 Values { "Permit", "Deny" }]
790 uint16 Action;
791
792 [Description (
793 "This specifies the criteria that must be matched in order "
794 "for the corresponding MatchAction to take effect. The "
795 "matching of the criteria may be specified by using a "
796 "FilterList. For example, the command 'match ip address foo' "
797 "uses the FilterList named 'foo' to do the matching of IP "
798 "addresses."),
799 a.dunfey 1.1 ValueMap { "1", "2", "3", "4", "5", "6", "7", "8", "9" },
800 Values { "Other", "Source Address and Mask",
801 "Destination Address and Mask", "Source Port",
802 "Source Port Range", "Destination Port",
803 "Destination Port Range", "Protocol Type",
804 "Protocol Type and Option" },
805 ModelCorrespondence { "CIM_BGPRouteMap.OtherMatchConditionType"
806 }]
807 uint16 MatchConditionType;
808
809 [Description (
810 "If the value of the MatchConditionType property in this "
811 "class is 1 (i.e., \"Other\"), then the specific type of "
812 "filtering is specified in this property."),
813 ModelCorrespondence { "CIM_BGPRouteMap.MatchConditionType" }]
814 string OtherMatchConditionType;
815
816 [Description (
817 "This defines an additional action to take if the "
818 "MatchCondition is satisfied. This definition is "
819 "specifically limited to BGP filtering at this time. The "
820 a.dunfey 1.1 "actual value of the metric is specified in the "
821 "SetMetricValue property."),
822 ValueMap { "1", "2", "3", "4", "5", "6", "7", "8", "9" },
823 Values { "Origin", "AS_Path", "NEXT_HOP", "Multi_Exit_Disc",
824 "Local_Pref", "Atomic_Aggregate", "Aggregator", "Community",
825 "Originator_ID" },
826 ModelCorrespondence { "CIM_BGPRouteMap.SetMetricValue" }]
827 uint16 SetMetricType;
828
829 [Description (
830 "This is the value of the metric that is being set for the "
831 "BGP attribute defined in the SetMetricType property.")]
832 string SetMetricValue;
833 };
834
835
836 // ==================================================================
837 // HostedBGPRouteMap
838 // ==================================================================
839 [Association, Version ( "2.6.0" ), Description (
840 "A BGPRouteMap is weak to the AutonomousSystem that contains "
841 a.dunfey 1.1 "it. This association formalizes that relationship.")]
842 class CIM_HostedBGPRouteMap : CIM_HostedDependency {
843
844 [Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
845 "The AutonomousSystem that scopes the BGPRouteMap.")]
846 CIM_AutonomousSystem REF Antecedent;
847
848 [Override ( "Dependent" ), Weak, Description (
849 "The BGPRouteMap defined in the context of the "
850 "AutonomousSystem.")]
851 CIM_BGPRouteMap REF Dependent;
852 };
853
854
855 // ==================================================================
856 // BGPRouteMapsInRoutingPolicy
857 // ==================================================================
858 [Association, Aggregation, Version ( "2.6.0" ), Description (
859 "This aggregation defines the BGPRouteMaps that are used by a "
860 "particular RoutingPolicy object. Multiple instances of the "
861 "same RouteMap may be used in the same RoutingPolicy instance. "
862 a.dunfey 1.1 "If this is desired, then the Sequence attribute of this "
863 "aggregation can be used to disambiguate them.")]
864 class CIM_BGPRouteMapsInRoutingPolicy : CIM_Component {
865
866 [Aggregate, Override ( "GroupComponent" ), Description (
867 "The RoutingPolicy that aggregates the RouteMaps.")]
868 CIM_RoutingPolicy REF GroupComponent;
869
870 [Override ( "PartComponent" ), Description (
871 "The RouteMaps that are used by the RoutingPolicy.")]
872 CIM_BGPRouteMap REF PartComponent;
873
874 [Description (
875 "This defines the position of this RouteMap instance "
876 "relative to all other instances of the same RouteMap.")]
877 uint16 MapSequence;
878 };
879
880
881 // ==================================================================
882 // BGPPeerUsesRouteMap
883 a.dunfey 1.1 // ==================================================================
884 [Association, Aggregation, Version ( "2.6.0" ), Description (
885 "This association defines the RouteMaps that are aggregated and "
886 "used by a particular BGPPeerGroup object. Multiple instances "
887 "of the same RouteMap may be aggregated into the same "
888 "BGPPeerGroup. If this is desired, then the MapSequence "
889 "attribute of the association can be used to disambiguate them.")]
890 class CIM_BGPPeerUsesRouteMap : CIM_CollectedMSEs {
891
892 [Aggregate, Override ( "Collection" ), Description (
893 "The BGPPeerGroup that aggregates the RouteMaps.")]
894 CIM_BGPPeerGroup REF Collection;
895
896 [Override ( "Member" ), Description (
897 "The RouteMaps that are used by the BGPPeerGroup.")]
898 CIM_BGPRouteMap REF Member;
899
900 [Description (
901 "This defines the position of this RouteMap instance "
902 "relative to all other instances of the same RouteMap.")]
903 uint16 MapSequence;
904 a.dunfey 1.1 };
905
906
907 // ==================================================================
908 // FilterListsInBGPRouteMap
909 // ==================================================================
910 [Association, Version ( "2.6.0" ), Description (
911 "RouteMaps do not have to use FilterLists, but if they do, this "
912 "association defines which FilterList is used by a particular "
913 "RouteMap.")]
914 class CIM_FilterListsInBGPRouteMap : CIM_Dependency {
915
916 [Override ( "Antecedent" ), Description (
917 "The FilterList used by a RouteMap.")]
918 CIM_FilterList REF Antecedent;
919
920 [Override ( "Dependent" ), Description (
921 "The RouteMap using the FilterList.")]
922 CIM_BGPRouteMap REF Dependent;
923 };
924
925 a.dunfey 1.1
926 // ==================================================================
927 // BGPPathAttributes
928 // ==================================================================
929 [Version ( "2.7.0" ), Description (
930 "This class defines the per-path information used to process "
931 "specific BGP attribute information, as defined in the "
932 "bgp4PathAttrTable of RFC 1657.")]
933 class CIM_BGPPathAttributes : CIM_LogicalElement {
934
935 [Key, Description (
936 "A comma-separated list of AS numbers, as would be stored in "
937 "the value portion of the path segment in the "
938 "PathAttrASPathSegment property. This list can be ordered or "
939 "unordered."),
940 MaxLen ( 512 )]
941 string ASNumbers;
942
943 [Key, Description (
944 "This is the address of the border router that should be "
945 "used for the destination network."),
946 a.dunfey 1.1 MaxLen ( 32 ),
947 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrNextHop" }]
948 string PathAttrNextHop;
949
950 [Description (
951 "This property and its description are taken directly from "
952 "RFC 1657. The property represents a sequence of AS path "
953 "segments. Each AS path segment is represented by the tuple: "
954 "\n<type, length, value> \n"
955 "The type is a 1-octet field which has two possible values: "
956 "\n1 = AS_SET \n"
957 "2 = AS_SEQUENCE \n"
958 "An AS_SET is an unordered set of ASs representing the path "
959 "that an UPDATE message has traversed, and an AS_SEQUENCE is "
960 "an ordered set of ASs representing the path that an UPDATE "
961 "message has traversed. \n"
962 "The length is a 1-octet field containing the number of ASs "
963 "in the value field. \n"
964 "The value field contains one or more AS numbers, each AS is "
965 "represented in the octet string as a pair of octets "
966 "according to the following algorithm: \n"
967 a.dunfey 1.1 "first-byte-of-pair = ASNumber / 256; \n"
968 "second-byte-of-pair = ASNumber & 255; \n"
969 "This property is mapped from the bgp4PathAttrASPathSegment "
970 "MIB variable, which is an OctetString. Its length is "
971 "defined as a minimum of 2 and a maximum of 255 octets."),
972 OctetString,
973 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrASPathSegment" }]
974 uint8 PathAttrASPathSegment[];
975
976 [Description (
977 "This is an enumeration that defines the ultimate origin of "
978 "the path information. The value 'IGP' means that the origin "
979 "is interior; the value 'EGP' means that it was learned via "
980 "an EGP; the value 'INCOMPLETE' means that the origin is "
981 "undetermined."),
982 ValueMap { "1", "2", "3" },
983 Values { "IGP", "EGP", "Incomplete" },
984 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrOrigin" }]
985 uint16 PathAttrOrigin;
986
987 [Description (
988 a.dunfey 1.1 "This metric is used to discriminate between multiple "
989 "adjacent autonomous systems. A value of -1 indicates the "
990 "absence of this attribute. The range of this attribute is "
991 "defined to be -1 to 2147483647."),
992 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrMultiExitDisc" }]
993 sint32 PathAttrMultiExitDisc;
994
995 [Description (
996 "This is the originating BGP4 speaker's degree of preference "
997 "for an advertised route. A value of -1 indicates the "
998 "absence of this attribute. The range of this attribute is "
999 "defined to be -1 to 2147483647."),
1000 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrLocalPref" }]
1001 sint32 PathAttrLocalPref;
1002
1003 [Description (
1004 "This is an enumeration that defines whether or not the "
1005 "local system has selected a less specific route without "
1006 "selecting a more specific route. There are two values, 1 "
1007 "and 2, indicating that a less specific route has not and "
1008 "has been selected, respectively. This is a 32-bit integer "
1009 a.dunfey 1.1 "to correspond to the IETF MIB."),
1010 ValueMap { "0", "1", "2" },
1011 Values { "Unknown", "Less Specific Not Selected",
1012 "Less Specific Selected" },
1013 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrAtomicAggregate"
1014 }]
1015 uint32 PathAttrAtomicAggregate;
1016
1017 [Description (
1018 "This is the AS number of the last BGP speaker that "
1019 "performed route aggregation. A value of 0 indicates the "
1020 "absence of this attribute. The range of this attribute is "
1021 "defined to be 0 to 65535."),
1022 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrAggregatorAS" }]
1023 uint16 PathAttrAggregatorAS;
1024
1025 [Description (
1026 "This is the IP address of the last BGP speaker that "
1027 "performed route aggregation. A value of 0.0.0.0 indicates "
1028 "the absence of this attribute."),
1029 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrAggregatorAddr"
1030 a.dunfey 1.1 }]
1031 string PathAttrAggregatorAddr;
1032
1033 [Description (
1034 "This is the degree of preference calculated by the "
1035 "receiving BGP speaker for an advertised route. A value of "
1036 "-1 indicates the absence of this attribute. The range of "
1037 "this attribute is defined to be -1 to 2147483647."),
1038 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrCalcLocalPref" }]
1039 sint16 PathAttrCalcLocalPref;
1040
1041 [Description (
1042 "This is an indication of whether or not this route was "
1043 "chosen as the best BGP route. There are three possible "
1044 "values, 0 (Unknown), 1 (FALSE) and 2 (TRUE)."),
1045 ValueMap { "0", "1", "2" },
1046 Values { "Unknown", "False", "True" },
1047 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrBest" }]
1048 uint16 PathAttrBest;
1049
1050 [Description (
1051 a.dunfey 1.1 "This contains one or more path atributes not understood by "
1052 "this BGP speaker. It is a array of path attributes that are "
1053 "not understood. The number of attributes is placed in a "
1054 "separate property of this class, PathAttrUnknownNumber."),
1055 OctetString,
1056 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrUnknown" },
1057 ModelCorrespondence {
1058 "CIM_BGPPathAttributes.PathAttrUnknownNumber" }]
1059 string PathAttrUnknown[];
1060
1061 [Description (
1062 "The number of unknown attributes in the array, "
1063 "PathAttrUnknown."),
1064 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrUnknown" },
1065 ModelCorrespondence { "CIM_BGPPathAttributes.PathAttrUnknown" }]
1066 uint16 PathAttrUnknownNumber;
1067 };
1068
1069
1070 // ==================================================================
1071 // BGPAttributesForRoute
1072 a.dunfey 1.1 // ==================================================================
1073 [Association, Version ( "2.7.0" ), Description (
1074 "This defines the attributes that are transmitted between BGP "
1075 "peers on a per-route basis.")]
1076 class CIM_BGPAttributesForRoute : CIM_Dependency {
1077
1078 [Override ( "Antecedent" ), Max ( 1 ), Description (
1079 "The BGPPathAttribute object that may be associated with a "
1080 "BGPIPRoute.")]
1081 CIM_BGPPathAttributes REF Antecedent;
1082
1083 [Override ( "Dependent" ), Max ( 1 ), Description (
1084 "The BGPIPRoute that may have an associated set of per-peer "
1085 "attributes.")]
1086 CIM_BGPIPRoute REF Dependent;
1087
1088 [Description (
1089 "This defines the IP address of the peer where the path "
1090 "information was learned."),
1091 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrPeer" },
1092 ModelCorrespondence {
1093 a.dunfey 1.1 "CIM_BGPAttributesForRoute.PathAttrIPAddrPrefixLen",
1094 "CIM_BGPAttributesForRoute.PathAttrIPAddrPrefix" }]
1095 string PathAttrPeer;
1096
1097 [Description (
1098 "This defines the length in bits of the IP address prefix "
1099 "for the property, PathAttrPeer. The range is 0 to 32."),
1100 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrIpAddrPrefixLen"
1101 },
1102 ModelCorrespondence { "CIM_BGPAttributesForRoute.PathAttrPeer" }]
1103 uint8 PathAttrIPAddrPrefixLen;
1104
1105 [Description (
1106 "The IP address prefix of the property, PathAttrPeer. Its "
1107 "length is specified by the property, "
1108 "PathAttrIpAddrPrefixLen."),
1109 MappingStrings { "MIB.IETF|BGP4-MIB.bgp4PathAttrIpAddrPrefix" },
1110 ModelCorrespondence { "CIM_BGPAttributesForRoute.PathAttrPeer",
1111 "CIM_BGPAttributesForRoute.PathAttrIPAddrPrefixLen" }]
1112 string PathAttrIPAddrPrefix;
1113 };
1114 a.dunfey 1.1
1115
1116 // ==================================================================
1117 // BGPServiceAttributes
1118 // ==================================================================
1119 [Association, Deprecated { "No value" }, Aggregation,
1120 Version ( "2.7.0" ), Description (
1121 "This is a specialization of the Component aggregation. This "
1122 "aggregation defines the set of BGPPathAttributes that are "
1123 "transmitted in per-path UPDATE messages. The association is "
1124 "deprecated since it is incorrectly defined as a Component "
1125 "relationship, and since the properties of BGPPathAttribute are "
1126 "path/endpoint-specific (not defined at the level of the "
1127 "Service).")]
1128 class CIM_BGPServiceAttributes : CIM_Component {
1129
1130 [Deprecated { "No value" }, Aggregate,
1131 Override ( "GroupComponent" ), Max ( 1 ), Description (
1132 "The BGPService that aggregates BGPPathAttributes as part of "
1133 "its routing information.")]
1134 CIM_BGPService REF GroupComponent;
1135 a.dunfey 1.1
1136 [Deprecated { "No value" }, Override ( "PartComponent" ),
1137 Max ( 1 ), Description (
1138 "The BGP attribute, which are part-of the BGP UPDATE "
1139 "message.")]
1140 CIM_BGPPathAttributes REF PartComponent;
1141 };
1142
1143
1144 // ==================================================================
1145 // BGPEndpointStatistics
1146 // ==================================================================
1147 [Version ( "2.7.0" ), Description (
1148 "This class contains statistical information for a connection "
1149 "on a BGPProtocolEndpoint. It is defined as a subclass of "
1150 "StatisticalData and associated with the Endpoint using the "
1151 "relationship, ElementStatisticalData.")]
1152 class CIM_BGPEndpointStatistics : CIM_StatisticalData {
1153
1154 [Description (
1155 "This is the number of BGP UPDATE messages received on this "
1156 a.dunfey 1.1 "router's BGP connection. This is a 32-bit counter."),
1157 Counter,
1158 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerInUpdates" }]
1159 uint32 InUpdates;
1160
1161 [Description (
1162 "This is the number of BGP UPDATE messages transmitted on "
1163 "this router's BGP connection. This is a 32-bit counter."),
1164 Counter,
1165 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerOutUpdates" }]
1166 uint32 OutUpdates;
1167
1168 [Description (
1169 "This is the total number of BGP messages received on this "
1170 "router's BGP connection. This is a 32-bit counter."),
1171 Counter,
1172 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerInTotalMessages" }]
1173 uint32 InTotalMessages;
1174
1175 [Description (
1176 "This is the total number of BGP messages transmitted on "
1177 a.dunfey 1.1 "this router's BGP connection. This is a 32-bit counter."),
1178 Counter,
1179 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerOutTotalMessages" }]
1180 uint32 OutTotalMessages;
1181
1182 [Description (
1183 "This contains the last error code and error subcode for "
1184 "this router's BGP connection. If no error has occurred, "
1185 "then each integer in the array is zero."),
1186 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerLastError" }]
1187 uint8 LastError [2];
1188
1189 [Description (
1190 "This contains the total number of times that the BGP Finite "
1191 "State Machine has transitioned into the established state "
1192 "for this router's BGP connection. This is a 32-bit counter."),
1193 Counter,
1194 MappingStrings {
1195 "MIB.IETF|BGP4-MIB.bgpPeerFsmEstablishedTransitions" }]
1196 uint32 FsmEstablishedTransitions;
1197
1198 a.dunfey 1.1 [Description (
1199 "This indicates how long, in seconds, this peer has been in "
1200 "the established state, or how long since this peer was last "
1201 "in the established state. It is set to zero when a new peer "
1202 "is configured or when the router is booted. This has the "
1203 "semantics of a 32-bit gauge."),
1204 Units ( "Seconds" ), Gauge,
1205 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerFsmEstablishedTime" }]
1206 uint32 FsmEstablishedTime;
1207
1208 [Description (
1209 "This defines the time in seconds since the last BGP UPDATE "
1210 "message was received from the peer. This has the semantics "
1211 "of a 32-bit gauge."),
1212 Units ( "Seconds" ), Gauge,
1213 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerInUpdateElapsedTime"
1214 }]
1215 uint32 InUpdateElapsedTime;
1216 };
1217
1218
1219 a.dunfey 1.1 // ==================================================================
1220 // BGPStatistics
1221 // ==================================================================
1222 [Deprecated { "CIM_BGPEndpointStatistics" }, Version ( "2.7.0" ),
1223 Description (
1224 "This class contains statistical information for a Service's "
1225 "sessions. It is deprecated since the statistics are defined in "
1226 "the BGP4 MIB at the level of individual peers/ endpoints.")]
1227 class CIM_BGPStatistics : CIM_ServiceStatisticalInformation {
1228
1229 [Deprecated { "CIM_BGPEndpointStatistics.InUpdates" },
1230 Description (
1231 "This is the number of BGP UPDATE messages received on this "
1232 "router's BGP connection. This is a 32-bit counter."),
1233 Counter,
1234 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerInUpdates" }]
1235 uint32 InUpdates;
1236
1237 [Deprecated { "CIM_BGPEndpointStatistics.OutUpdates" },
1238 Description (
1239 "This is the number of BGP UPDATE messages transmitted on "
1240 a.dunfey 1.1 "this router's BGP connection. This is a 32-bit counter."),
1241 Counter,
1242 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerOutUpdates" }]
1243 uint32 OutUpdates;
1244
1245 [Deprecated { "CIM_BGPEndpointStatistics.InTotalMessages" },
1246 Description (
1247 "This is the total number of BGP messages received on this "
1248 "router's BGP connection. This is a 32-bit counter."),
1249 Counter,
1250 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerInTotalMessages" }]
1251 uint32 InTotalMessages;
1252
1253 [Deprecated { "CIM_BGPEndpointStatistics.OutTotalMessages" },
1254 Description (
1255 "This is the total number of BGP messages transmitted on "
1256 "this router's BGP connection. This is a 32-bit counter."),
1257 Counter,
1258 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerOutTotalMessages" }]
1259 uint32 OutTotalMessages;
1260
1261 a.dunfey 1.1 [Deprecated { "CIM_BGPEndpointStatistics.LastError" },
1262 Description (
1263 "This contains the last error code and error subcode for "
1264 "this router's BGP connection. If no error has occurred, "
1265 "then each integer in the array is zero."),
1266 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerLastError" }]
1267 uint8 LastError [2];
1268
1269 [Deprecated {
1270 "CIM_BGPEndpointStatistics.FsmEstablishedTransitions" },
1271 Description (
1272 "This contains the total number of times that the BGP Finite "
1273 "State Machine has transitioned into the established state "
1274 "for this router's BGP connection. This is a 32-bit counter."),
1275 Counter,
1276 MappingStrings {
1277 "MIB.IETF|BGP4-MIB.bgpPeerFsmEstablishedTransitions" }]
1278 uint32 FsmEstablishedTransitions;
1279
1280 [Deprecated { "CIM_BGPEndpointStatistics.FsmEstablishedTime" },
1281 Description (
1282 a.dunfey 1.1 "This indicates how long, in seconds, this peer has been in "
1283 "the established state, or how long since this peer was last "
1284 "in the established state. It is set to zero when a new peer "
1285 "is configured or when the router is booted. This has the "
1286 "semantics of a 32-bit gauge."),
1287 Units ( "Seconds" ), Gauge,
1288 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerFsmEstablishedTime" }]
1289 uint32 FsmEstablishedTime;
1290
1291 [Deprecated { "CIM_BGPEndpointStatistics.InUpdateElapsedTime" },
1292 Description (
1293 "This defines the time in seconds since the last BGP UPDATE "
1294 "message was received from the peer. This has the semantics "
1295 "of a 32-bit gauge."),
1296 Units ( "Seconds" ), Gauge,
1297 MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerInUpdateElapsedTime"
1298 }]
1299 uint32 InUpdateElapsedTime;
1300 };
1301
1302
1303 a.dunfey 1.1 // ==================================================================
1304 // BGPServiceStatistics
1305 // ==================================================================
1306 [Association, Deprecated { "CIM_ElementStatisticalData" },
1307 Version ( "2.7.0" ), Description (
1308 "This association defines statistics collected for a BGP "
1309 "Service. The relationship is deprecated since the class "
1310 "BGPStatistics is deprecated. It is incorrectly associated with "
1311 "a BGPService, but should instead be associated with a "
1312 "BGPProtocolEndpoint using the ElementStatisticalData "
1313 "relationship.")]
1314 class CIM_BGPServiceStatistics : CIM_ServiceStatistics {
1315
1316 [Deprecated { "CIM_ElementStatisticalData.Stats" },
1317 Override ( "Stats" ), Max ( 1 ), Description (
1318 "The statistics object for the BGP session.")]
1319 CIM_BGPStatistics REF Stats;
1320
1321 [Deprecated { "CIM_ElementStatisticalData.ManagedElement" },
1322 Override ( "Element" ), Min ( 1 ), Max ( 1 ), Description (
1323 "The BGPService for which statistics are being gathered.")]
1324 a.dunfey 1.1 CIM_BGPService REF Element;
1325 };
1326
1327
1328 // ===================================================================
1329 // end of file
1330 // ===================================================================
|
Return to
Network_BGP.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIM29