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