1 a.dunfey 1.1 // ===================================================================
2 // Title: Network_OSPF
3 // $State: Exp $
4 // $Date: 2004/11/29 18:31:42 $
5 // $RCSfile: Network_OSPF.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 classes to manage OSPF
49 // (Open Shortest Path First).
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 // CR788 - Add classes to support OSPF
57 // CR806 - Update the OSPF model to take into account the
58 // RangeOfIPAddresses class (vs IPAddressRange)
59 // CR837 - Add the property RFC1583Compatibility to OSPFService, and
60 // add the property StubMetricType to OSPFAreaConfiguration
61 // CR863 - Update the format of the MappingStrings qualifier when
62 // referencing IETF RFCs
63 // CR903 - Correction of EndpointInLink.Member reference.
64 a.dunfey 1.1 // CR959 - Reposition OSPFLink using the ConnectivityCollection class
65 // CR982 - Removal of Experimental for preliminary to final
66 // CR994 - Update of the InstanceID property Description
67 // Change Log for v2.8
68 // CR1231 - Update references
69 // Property CIM_OSPFService.RunningMOSPF
70 // (CIM_OSPFServiceCapabillities.SupportMOSPF)
71 // ===================================================================
72
73 #pragma Locale ("en_US")
74
75
76 // ====================================================================
77 // OSPFArea
78 // ====================================================================
79 [Version ( "2.7.0" ), Description (
80 "This class represents an OSPF area. The definition of an OSPF "
81 "area from RFC2328, is 'OSPF allows sets of networks to be "
82 "grouped together. Such a grouping is called an area. The "
83 "topology of an area is hidden from the rest of the Autonomous "
84 "System. This information hiding enables a significant "
85 a.dunfey 1.1 "reduction in routing traffic. Also, routing within the area is "
86 "determined only by the area's own topology, lending the area "
87 "protection from bad routing data.' This class has a 'Type' "
88 "propery, which distinguishes between the different area types. "
89 "This approach was chosen, because it provides a simpler way to "
90 "indicate the type of an area, and additional subclassing is "
91 "not needed at this time.")]
92 class CIM_OSPFArea : CIM_RoutingProtocolDomain {
93
94 [Description (
95 "The area ID of this OSPF area, see C.2 in RFC 2328."),
96 MappingStrings { "MIB.IETF|OSPF-MIB.ospfAreaId" }]
97 uint32 AreaID;
98
99 [Required, Description (
100 "The type of the OSPF area."),
101 ValueMap { "2", "3", "4" },
102 Values { "Plain", "Stub", "NSSA" }]
103 uint16 AreaType;
104
105 [Description (
106 a.dunfey 1.1 "When the number of non-default AS-external-LSAs in a "
107 "router's link-state database reaches this limit, the router "
108 "enters OverflowState, see 2.1 in RFC 1765."),
109 MappingStrings { "MIB.IETF|OSPF-MIB.ospfExtLsdbLimit" }]
110 uint32 ExtLsdbLimit;
111 };
112
113
114 // ====================================================================
115 // OSPFService
116 // ====================================================================
117 [Version ( "2.7.0" ), Description (
118 "This class is used to represent the basic operation of OSPF. "
119 "It is derived from the RouteCalculationService, the superclass "
120 "of all routing protocols.")]
121 class CIM_OSPFService : CIM_RouteCalculationService {
122
123 [Description (
124 "This attribute indicates whether this router is running "
125 "MOSPF (multicast enhancements to OSPF) or not, see B.1 in "
126 "RFC 1584. This attribute only can be true, when the "
127 a.dunfey 1.1 "SupportMOSPF property in OSPFService Capabilities is also "
128 "true. If SupportMOSPF is false, then this property has no "
129 "meaning."),
130 MappingStrings { "MIB.IETF|OSPF-MIB.ospfMulticastExtensions" }]
131 boolean RunningMOSPF;
132
133 [Description (
134 "This attribute indicates whether this router will forward "
135 "multicast datagrams between OSPF areas or not, see B.1 in "
136 "RFC 1584."),
137 MappingStrings { "MIB.IETF|OSPF-MIB.ospfMulticastExtensions" }]
138 boolean IsInterAreaMulticastForwarder;
139
140 [Description (
141 "This attribute indicates whether this router will forward "
142 "multicast datagrams between Autonomous Systems or not, see "
143 "B.1 in RFC 1584."),
144 MappingStrings { "MIB.IETF|OSPF-MIB.ospfMulticastExtensions" }]
145 boolean IsInterAsMulticastForwarder;
146
147 [Description (
148 a.dunfey 1.1 "The number of seconds that, after entering OverflowState, a "
149 "router will attempt to leave OverflowState. When set to 0, "
150 "the router will not leave OverflowState until restarted, "
151 "see 2.1 in RFC 1765."),
152 Units ( "Seconds" ),
153 MappingStrings { "MIB.IETF|OSPF-MIB.ospfExitOverflowInterval" }]
154 uint32 ExitOverflowInterval;
155
156 [Description (
157 "Controls the preference rules used in choosing among "
158 "multiple AS-external-LSAs advertising the same destination. "
159 "When set to TRUE, the preference rules remain those "
160 "specified by RFC 1583. When set to FALSE, the preference "
161 "rules are those stated in RFC 2328, which prevent routing "
162 "loops when AS-external-LSAs for the same destination have "
163 "been originated from different areas. See C.1 in RFC2328.")]
164 boolean RFC1583Compatibility;
165 };
166
167
168 // ==================================================================
169 a.dunfey 1.1 // OSPFServiceCapabilities
170 // ==================================================================
171 [Version ( "2.7.0" ), Description (
172 "The OSPFServiceCapabilities class represents the capabilities "
173 "of an OSPF service.")]
174 class CIM_OSPFServiceCapabilities : CIM_Capabilities {
175
176 [Description (
177 "This attribute indicates whether this router supports NSSA "
178 "(\"not-so-stubby\") areas or not, see RFC 1587.")]
179 boolean SupportNSSA;
180
181 [Description (
182 "This attribute indicates whether this router supports "
183 "on-demand circuits or not, see RFC 1793."),
184 MappingStrings { "MIB.IETF|OSPF-MIB.ospfDemandExtensions" }]
185 boolean SupportOnDemand;
186
187 [Description (
188 "This attribute indicates whether this router supports MOSPF "
189 "(multicast enhancements to OSPF) or not, see B.1 in RFC "
190 a.dunfey 1.1 "1584."),
191 MappingStrings { "MIB.IETF|OSPF-MIB.ospfMulticastExtensions" }]
192 boolean SupportMOSPF;
193 };
194
195
196 // ====================================================================
197 // OSPFAreaConfiguration
198 // ====================================================================
199 [Version ( "2.7.0" ), Description (
200 "Each OSPF router has an association to one or more OSPF areas. "
201 "Into these areas, a router advertises summaries filtered by "
202 "specific address ranges. This would natively be modeled as a "
203 "ternary association (router/OSPFService to OSPFArea to "
204 "RangeOfIPAddresses), which is problematic in some "
205 "implementations. To get around this issue, the "
206 "OSPFAreaConfiguration class is defined to act as a focal point "
207 "to bring together the router (indicated as a ComputerSystem "
208 "with an instance of OSPFService, associated to the "
209 "AreaConfiguration using OSPFServiceConfiguration), the area "
210 "(indicated as an OSPFArea, associated to the AreaConfiguration "
211 a.dunfey 1.1 "using AreaOfConfiguration) and the address ranges for "
212 "advertising (indicated as instances of RangeOfIPAddresses, "
213 "associated to the AreaConfiguration using "
214 "RangesOfConfiguration). There would be an instance of "
215 "OSPFAreaConfiguration for each connected area of a "
216 "router/OSPFService. \n"
217 "\n"
218 "When network administrators want to control the advertisements "
219 "of OSPF routers by filters, they first define the relevant "
220 "ranges. In order for a router to handle a range, an instance "
221 "of RangeOfIPAddresses MUST be associated to the relevant "
222 "OSPFAreaConfiguration (using the relationship, RangesOf "
223 "Configuration). The association between the range and area "
224 "configuration contains a property defining the handling "
225 "(EnableAdvertise) to allow or disallow advertisements in the "
226 "range. \n"
227 "\n"
228 "Notes: \n"
229 "- Because RangeOfIPAddresses is scoped by a System (via the "
230 "HostedCollection association), an instance of "
231 "RangeOfIPAddresses would be associated to an OSPFArea, "
232 a.dunfey 1.1 "satisfying this semantic. \n"
233 "- This class is inherited from LogicalElement, because a "
234 "suitable subclass 'lower' in the inheritance hiearchy does not "
235 "exist.")]
236 class CIM_OSPFAreaConfiguration : CIM_LogicalElement {
237
238 [Key, Description (
239 "Within the scope of the instantiating Namespace, InstanceID "
240 "opaquely and uniquely identifies an instance of this class. "
241 "In order to ensure uniqueness within the NameSpace, the "
242 "value of InstanceID SHOULD be constructed using the "
243 "following 'preferred' algorithm: \n"
244 "<OrgID>:<OSPFService ID><Area Configuration ID> \n"
245 "where: \n"
246 "<OrgID> and the remainder of the InstanceID are separated "
247 "by a colon ':', and where <OrgID> MUST include a "
248 "copyrighted, trademarked or otherwise unique name that is "
249 "owned by the business entity creating/defining the "
250 "InstanceID, or is a registered ID that is assigned to the "
251 "business entity by a recognized global authority. (This is "
252 "similar to the <Schema Name>_<Class Name> structure of "
253 a.dunfey 1.1 "Schema class names.) In addition, to ensure uniqueness "
254 "<OrgID> MUST NOT contain a colon (':'). When using this "
255 "algorithm, the first colon to appear in InstanceID MUST "
256 "appear between <OrgID> and the <OSPFService ID>. For DMTF "
257 "defined instances, the 'preferred' algorithm MUST be used, "
258 "and the <OrgID> set to 'CIM'. \n"
259 "<OSPFService ID> and <Area Configuration ID> MUST specify "
260 "vendor-unique identifiers for the OSPFService and "
261 "AreaConfiguration.")]
262 string InstanceID;
263
264 [Description (
265 "This attribute contains the value of the default route that "
266 "this router advertises into a stub area, see C.2 RFC 2328."),
267 MappingStrings { "MIB.IETF|OSPF-MIB.ospfStubMetric" }]
268 uint32 StubDefaultCost;
269
270 [Description (
271 "This attribute contains the type of metric advertised as a "
272 "default route into a stub area, see 3. in RFC 1850."),
273 ValueMap { "2", "3", "4" },
274 a.dunfey 1.1 Values { "OSPF Metric", "Comparable Cost", "NonComparable" },
275 MappingStrings { "MIB.IETF|OSPF-MIB.ospfStubMetricType" }]
276 uint16 StubMetricType;
277 };
278
279
280 // ====================================================================
281 // OSPFLink
282 // ====================================================================
283 [Version ( "2.7.0" ), Description (
284 "This class is used to represent OSPF connectivity between two "
285 "or more OSPF protocol endpoints.")]
286 class CIM_OSPFLink : CIM_ConnectivityCollection {
287
288 [Required, Description (
289 "The type of the OSPF link, see section 1.2 in RFC 2328."),
290 ValueMap { "2", "3", "4", "5" },
291 Values { "Point-To-Point", "Point-To-Multipoint", "Broadcast",
292 "NBMA" }]
293 uint16 LinkType;
294
295 a.dunfey 1.1 [Description (
296 "The time, in seconds, between sending OSPF Hello-packets "
297 "over the interface, see section C.3 in RFC 2328."),
298 Units ( "Seconds" ),
299 MappingStrings { "MIB.IETF|OSPF-MIB.ospfIfHelloInterval" }]
300 uint32 HelloInterval;
301
302 [Description (
303 "After ceasing to hear a router's Hello-packets, the number "
304 "of seconds before its neighbors declare the router down, "
305 "see section C.3 in RFC 2328."),
306 Units ( "Seconds" ),
307 MappingStrings { "MIB.IETF|OSPF-MIB.ospfIfRtrDeadInterval" }]
308 uint32 RouterDeadInterval;
309
310 [Required, Description (
311 "This parameter indicates whether IP multicast datagrams "
312 "should be forwarded over this OSPF link, and if so, how the "
313 "forwarding should be done, see section B.2 in RFC 1584."),
314 ValueMap { "2", "3", "4" },
315 Values { "Disabled", "Data-link Multicast",
316 a.dunfey 1.1 "Data-link Unicast" },
317 MappingStrings { "MIB.IETF|OSPF-MIB.ospfIfMulticastForwarding" }]
318 uint16 MulticastForwarding;
319 };
320
321 // ====================================================================
322 // AreaOfConfiguration
323 // ====================================================================
324 [Association, Version ( "2.7.0" ), Description (
325 "This association connects an area configuration to its area. "
326 "The OSPFAreaConfiguration class is defined to act as a focal "
327 "point to bring together the router (indicated as a "
328 "ComputerSystem with an instance of OSPFService, associated to "
329 "the AreaConfiguration using OSPFServiceConfiguration), the "
330 "area (indicated as an OSPFArea, associated to the "
331 "AreaConfiguration using AreaOfConfiguration) and the address "
332 "ranges for advertising (indicated as instances of "
333 "RangeOfIPAddresses, associated to the AreaConfiguration using "
334 "RangesOfConfiguration). There is an instance of "
335 "OSPFAreaConfiguration for each connected area of a "
336 "router/OSPFService.")]
337 a.dunfey 1.1 class CIM_AreaOfConfiguration : CIM_Dependency {
338
339 [Override ( "Antecedent" ), Max ( 1 ), Description (
340 "The OSPF area.")]
341 CIM_OSPFArea REF Antecedent ;
342
343 [Override ( "Dependent" ), Description (
344 "The configuration which is applied to an OSPF area. This is "
345 "the Dependent reference in this association, since it "
346 "depends on the area for any functional significance.")]
347 CIM_OSPFAreaConfiguration REF Dependent;
348 };
349
350
351 // ====================================================================
352 // OSPFServiceConfiguration
353 // ====================================================================
354 [Association, Version ( "2.7.0" ), Description (
355 "OSPFServiceConfiguration connects an OSPF service to its area "
356 "configurations. The configurations are defined for the OSPF "
357 "Service, and so do not make sense as stand alone objects. This "
358 a.dunfey 1.1 "is the reason for the Min (1), Max (1) cardinalities on "
359 "OSPFService. They mandate the instantiation of the service and "
360 "of this association for the referenced instance of "
361 "OSPFAreaConfiguration. The area configuration acts as a focal "
362 "point to bring together the router (indicated as a "
363 "ComputerSystem with an instance of OSPFService, associated to "
364 "the AreaConfiguration using this relationship), the area "
365 "(indicated as an OSPFArea, associated to the AreaConfiguration "
366 "using AreaOfConfiguration) and the address ranges for "
367 "advertising (indicated as instances of RangeOfIPAddresses, "
368 "associated to the AreaConfiguration using "
369 "RangesOfConfiguration). There would be an instance of "
370 "OSPFAreaConfiguration for each connected area of a "
371 "router/OSPFService.")]
372 class CIM_OSPFServiceConfiguration : CIM_Dependency {
373
374 [Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
375 "The OSPF service.")]
376 CIM_OSPFService REF Antecedent ;
377
378 [Override ( "Dependent" ), Description (
379 a.dunfey 1.1 "The area configuration.")]
380 CIM_OSPFAreaConfiguration REF Dependent;
381 };
382
383
384 // ====================================================================
385 // RangesOfConfiguration
386 // ====================================================================
387 [Association, Version ( "2.7.0" ), Description (
388 "This association connects address ranges to the OSPF area "
389 "configuration. When network administrators want to control the "
390 "advertisements of OSPF routers by filters, they first define "
391 "the relevant ranges. In order for a router to handle a range, "
392 "an instance of RangeOfIPAddresses MUST be associated to the "
393 "router's OSPFAreaConfiguration, using this relationship. The "
394 "association between the range and area configuration contains "
395 "a property (EnableAdvertise) defining the handling - to allow "
396 "or disallow advertismenets in the range.")]
397 class CIM_RangesOfConfiguration : CIM_Dependency {
398
399 [Override ( "Antecedent" ), Description (
400 a.dunfey 1.1 "The address range that is in the OSPF area configuration.")]
401 CIM_RangeOfIPAddresses REF Antecedent;
402
403 [Override ( "Dependent" ), Description (
404 "The OSPF area configuration that contains the range.")]
405 CIM_OSPFAreaConfiguration REF Dependent;
406
407 [Description (
408 "The address range is advertised (TRUE) or not (FALSE), see "
409 "C.2 in RFC 2328.")]
410 boolean EnableAdvertise;
411 };
412
413
414 // ====================================================================
415 // EndpointInLink
416 // ====================================================================
417 [Association, Aggregation, Version ( "2.7.0" ), Description (
418 "This association connects an OSPFLink to the OSPFProtocol "
419 "Endpoints that this link aggregates.")]
420 class CIM_EndpointInLink : CIM_MemberOfCollection {
421 a.dunfey 1.1
422 [Aggregate, Override ( "Collection" ), Max ( 1 ), Description (
423 "The OSPF link.")]
424 CIM_OSPFLink REF Collection;
425
426 [Override ( "Member" ), Description (
427 "The OSPF protocol endpoint.")]
428 CIM_OSPFProtocolEndpointBase REF Member;
429 };
430
431
432 // ====================================================================
433 // EndpointInArea
434 // ====================================================================
435 [Association, Aggregation, Composition, Version ( "2.7.0" ),
436 Description (
437 "This relation connects an OSPF endpoint to an area.")]
438 class CIM_EndpointInArea : CIM_Component {
439
440 [Aggregate, Override ( "GroupComponent" ), Min ( 1 ), Max ( 1 ),
441 Description (
442 a.dunfey 1.1 "The OSPF area.")]
443 CIM_OSPFArea REF GroupComponent;
444
445 [Override ( "PartComponent" ), Description (
446 "The OSPF endpoint in the area.")]
447 CIM_OSPFProtocolEndpointBase REF PartComponent;
448 };
449
450
451 // ===================================================================
452 // end of file
453 // ===================================================================
|
Return to
Network_OSPF.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIM29