1 tony 1.1 // ===================================================================
2 // Title: Core Statistics 2.8
3 // Filename: Core28_Statistics.mof
4 // Version: 2.8.0
5 // Status: Final
6 // Date: Jan 26, 2004
7 // ===================================================================
8 // Copyright 2000-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 Core Model defines basic management concepts.
45 // This file defines the top of the Statistics/
46 // StatisticalData hierarchies.
47 //
48 // The object classes below are listed in an order that
49 // avoids forward references. Required objects, defined
50 // by other working groups, are omitted.
51 // ==================================================================
52 // Change Log for v2.8 Final
53 // CR1210 - Removal of experimental Qualifiers for core.
54 // CR1223 - SysDev Omnibus CR - Minor MOF corrections.
55 //
56 // Change Log for v2.8 Preliminary
57 // CR1082 - Fix reference of 0 value in StatisticalData.SampleInterval
58 // to reference a zero time interval value.
59 // CR952 - Add some time related properties
60 // CR1019 - CIM Versioning for 2.8 Preliminary
61 // CR1047 - Create StatisticalSettings to coordinate
62 // with changes made to StatisticalData.
63 //
64 tony 1.1 // Change Log for v2.7
65 // CR968 - Remove the Experimental qualifier
66 // CR994 - Update description of InstanceID
67 //
68 // Change Log for v2.7
69 // CR721 - Introduce StatisticalData, ElementStatisticalData,
70 // and ReleatedStatisticalData
71 // ==================================================================
72
73 #pragma locale ("en_US")
74
75
76 // ==================================================================
77 // StatisticalData
78 // ==================================================================
79 [Abstract, Version ( "2.8.0" ), Description (
80 "CIM_StatisticalData is a root class for any arbitrary "
81 "collection of statistical data and/or metrics applicable to "
82 "one or more ManagedElements. These statistics MUST represent "
83 "the most recent observations and MUST NOT be provided if "
84 "irrelevant or stale. Note that this class uses a simplified "
85 tony 1.1 "naming/identity algorithm as compared to "
86 "CIM_StatisticalInformation.")]
87 class CIM_StatisticalData : CIM_ManagedElement {
88
89 [Key, Description (
90 "Within the scope of the instantiating Namespace, InstanceID "
91 "opaquely and uniquely identifies an instance of this class. "
92 "In order to ensure uniqueness within the NameSpace, the "
93 "value of InstanceID SHOULD be constructed using the "
94 "following 'preferred' algorithm: \n"
95 "<OrgID>:<LocalID> \n"
96 "Where <OrgID> and <LocalID> are separated by a colon ':', "
97 "and where <OrgID> MUST include a copyrighted, trademarked "
98 "or otherwise unique name that is owned by the business "
99 "entity creating/defining the InstanceID, or is a registered "
100 "ID that is assigned to the business entity by a recognized "
101 "global authority (This is similar to the <Schema "
102 "Name>_<Class Name> structure of Schema class names.) In "
103 "addition, to ensure uniqueness <OrgID> MUST NOT contain a "
104 "colon (':'). When using this algorithm, the first colon to "
105 "appear in InstanceID MUST appear between <OrgID> and "
106 tony 1.1 "<LocalID>. \n"
107 "<LocalID> is chosen by the business entity and SHOULD not "
108 "be re-used to identify different underlying (real-world) "
109 "elements. If the above 'preferred' algorithm is not used, "
110 "the defining entity MUST assure that the resultant "
111 "InstanceID is not re-used across any InstanceIDs produced "
112 "by this or other providers for this instance's NameSpace. \n"
113 "For DMTF defined instances, the 'preferred' algorithm MUST "
114 "be used with the <OrgID> set to 'CIM'.")]
115 string InstanceID;
116
117 [Required, Override ( "ElementName" ), Description (
118 "The user friendly name for this instance of "
119 "StatisticalData. In addition, the user friendly name can be "
120 "used as a index property for a search of query. (Note: Name "
121 "does not have to be unique within a namespace.)")]
122 string ElementName;
123
124 [Description (
125 "The time, relative to managed element where the statistic "
126 "was collected, when the first measurement was taken. If the "
127 tony 1.1 "statistic is reset, the StartStatisticTime is the time when "
128 "the reset was performed.")]
129 datetime StartStatisticTime;
130
131 [Description (
132 "The time the most recent measurement was taken, relative to "
133 "the managed element where the statistic was collected.")]
134 datetime StatisticTime;
135
136 [Description (
137 "Some statistics are sampled at consistent time intervals. "
138 "This property provides the sample interval so that client "
139 "applications can determine the minimum time that new "
140 "statistics should be pulled. If the statistics are not "
141 "sampled at consistent time intervals, this property must be "
142 "set to a zero time interval.")]
143 datetime SampleInterval = "00000000000000.000000:000";
144
145 [Description (
146 "Method to reset one or more of the instance's statistics. "
147 "The method takes one parameter as input - an array of "
148 tony 1.1 "strings indicating which statistics to reset. If all the "
149 "statistics in the instance should be reset, the first "
150 "element of the array MUST be set to \"All\" or \"ALL\". If "
151 "one or more individual statistics should be reset, the "
152 "corresponding property names are entered into the elements "
153 "of the array. \n"
154 "The method returns 0 if successful, 1 if not supported, and "
155 "any other value if an error occurred. A method is specified "
156 "so that the StatisticalInformation's provider/ "
157 "instrumentation, which calculates the statistics, can reset "
158 "its internal processing, counters, etc. \n"
159 "In a subclass, the set of possible return codes could be "
160 "specified, using a ValueMap qualifier on the method. The "
161 "strings to which the ValueMap contents are 'translated' may "
162 "also be specified in the subclass as a Values array "
163 "qualifier.")]
164 uint32 ResetSelectedStats (
165 [IN, Description (
166 "Array of strings indicating which statistics to reset.")]
167 string SelectedStatistics[]);
168 };
169 tony 1.1
170
171 // ==================================================================
172 // ElementStatisticalData
173 // ==================================================================
174 [Association, Version ( "2.7.0" ), Description (
175 "CIM_ElementStatisticalData is an association that relates a "
176 "ManagedElement to its StatisticalData. Note that the "
177 "cardinality of the ManagedElement reference is Min(1), Max(1). "
178 "This cardinality mandates the instantiation of the "
179 "ElementStatisticalData association for the referenced instance "
180 "of CIM_StatisticalData. ElementStatisticalData describes the "
181 "existence requirements and context for the "
182 "CIM_StatisticalData, relative to a specific ManagedElement.")]
183 class CIM_ElementStatisticalData {
184
185 [Key, Min ( 1 ), Max ( 1 ), Description (
186 "The ManagedElement for which statistical or metric data is "
187 "defined.")]
188 CIM_ManagedElement REF ManagedElement;
189
190 tony 1.1 [Key, Description (
191 "The statistic information/object.")]
192 CIM_StatisticalData REF Stats;
193 };
194
195
196 // ==================================================================
197 // RelatedStatisticalData
198 // ==================================================================
199 [Association, Version ( "2.7.0" ), Description (
200 "CIM_RelatedStatisticalData is an association that defines "
201 "hierarchies and/or dependencies of related CIM_Statistical "
202 "Data classes.")]
203 class CIM_RelatedStatisticalData {
204
205 [Key, Description (
206 "The statistic information/object.")]
207 CIM_StatisticalData REF Stats;
208
209 [Key, Description (
210 "The related statistics.")]
211 tony 1.1 CIM_StatisticalData REF RelatedStats;
212
213 [Description (
214 "A free-form string describing how the statistics are "
215 "related.")]
216 string Description;
217 };
218
219
220 // ==================================================================
221 // StatisticalInformation
222 // ==================================================================
223 [Abstract, Version ( "2.6.0" ), Description (
224 "CIM_StatisticalInformation is a root class for any arbitrary "
225 "collection of statistical data and/or metrics applicable to "
226 "one or more ManagedSystemElements. Note that the CIM_ "
227 "StatisticalData class uses a simplified naming/identity "
228 "algorithm as compared to this class. StatisticalInformation is "
229 "not deprecated since its naming algorithm is still in use in "
230 "various implementations.")]
231 class CIM_StatisticalInformation : CIM_ManagedElement {
232 tony 1.1
233 [Description (
234 "The Name property defines the label by which the statistic "
235 "or metric is known. When subclassed, the property can be "
236 "overridden to be a Key property."),
237 MaxLen ( 256 )]
238 string Name;
239 };
240
241
242 // ==================================================================
243 // Statistics
244 // ==================================================================
245 [Association, Version ( "2.6.0" ), Description (
246 "CIM_Statistics is an association that relates Managed Elements "
247 "to the StatisticalGroup(s) that apply to them.")]
248 class CIM_Statistics {
249
250 [Key, Description (
251 "The statistic information/object.")]
252 CIM_StatisticalInformation REF Stats;
253 tony 1.1
254 [Key, Description (
255 "The ManagedElement for which statistical or metric data is "
256 "defined.")]
257 CIM_ManagedElement REF Element;
258 };
259
260
261 // ==================================================================
262 // RelatedStatistics
263 // ==================================================================
264 [Association, Version ( "2.6.0" ), Description (
265 "CIM_RelatedStatistics is an association that defines "
266 "hierarchies and/or dependencies of related CIM_Statistical "
267 "Information classes.")]
268 class CIM_RelatedStatistics {
269
270 [Key, Description (
271 "The statistic information/object.")]
272 CIM_StatisticalInformation REF Stats;
273
274 tony 1.1 [Key, Description (
275 "The related statistics or metrics.")]
276 CIM_StatisticalInformation REF RelatedStats;
277 };
278
279
280 // ==================================================================
281 // SystemStatisticalInformation
282 // ==================================================================
283 [Version ( "2.6.0" ), Description (
284 "Statistical information associated with a System object or one "
285 "of its subclasses.")]
286 class CIM_SystemStatisticalInformation : CIM_StatisticalInformation {
287
288 [Key, Propagated ( "CIM_System.CreationClassName" ),
289 Description (
290 "The scoping System's CreationClassName."),
291 MaxLen ( 256 )]
292 string SystemCreationClassName;
293
294 [Key, Propagated ( "CIM_System.Name" ), Description (
295 tony 1.1 "The scoping System's Name."),
296 MaxLen ( 256 )]
297 string SystemName;
298
299 [Key, Description (
300 "CreationClassName indicates the name of the class or the "
301 "subclass used in the creation of an instance. When used "
302 "with the other key properties of this class, this property "
303 "allows all instances of this class and its subclasses to be "
304 "uniquely identified."),
305 MaxLen ( 256 )]
306 string CreationClassName;
307
308 [Key, Override ( "Name" ), Description (
309 "The Name property, inherited from StatisticalInformation, "
310 "serves as part of the object key."),
311 MaxLen ( 256 )]
312 string Name;
313 };
314
315
316 tony 1.1 // ==================================================================
317 // SystemStatistics
318 // ==================================================================
319 [Association, Version ( "2.6.0" ), Description (
320 "SystemStatistics relates the SystemStatisticalInformation "
321 "class to the System to which it applies.")]
322 class CIM_SystemStatistics : CIM_Statistics {
323
324 [Override ( "Stats" ), Weak, Description (
325 "The statistical object.")]
326 CIM_SystemStatisticalInformation REF Stats;
327
328 [Override ( "Element" ), Min ( 1 ), Max ( 1 ), Description (
329 "The System to which the statistics apply.")]
330 CIM_System REF Element;
331 };
332
333
334 // ==================================================================
335 // ServiceStatisticalInformation
336 // ==================================================================
337 tony 1.1 [Version ( "2.6.0" ), Description (
338 "Statistical information associated with a Service object or "
339 "one of its subclasses.")]
340 class CIM_ServiceStatisticalInformation : CIM_StatisticalInformation {
341
342 [Key, Propagated ( "CIM_Service.SystemCreationClassName" ),
343 Description (
344 "The scoping System's CreationClassName."),
345 MaxLen ( 256 )]
346 string SystemCreationClassName;
347
348 [Key, Propagated ( "CIM_Service.SystemName" ), Description (
349 "The scoping System's Name."),
350 MaxLen ( 256 )]
351 string SystemName;
352
353 [Key, Propagated ( "CIM_Service.CreationClassName" ),
354 Description (
355 "The scoping Service's CreationClassName."),
356 MaxLen ( 256 )]
357 string ServiceCreationClassName;
358 tony 1.1
359 [Key, Propagated ( "CIM_Service.Name" ), Description (
360 "The scoping Service's Name."),
361 MaxLen ( 256 )]
362 string ServiceName;
363
364 [Key, Description (
365 "CreationClassName indicates the name of the class or the "
366 "subclass used in the creation of an instance. When used "
367 "with the other key properties of this class, this property "
368 "allows all instances of this class and its subclasses to be "
369 "uniquely identified."),
370 MaxLen ( 256 )]
371 string CreationClassName;
372
373 [Key, Override ( "Name" ), Description (
374 "The Name property, inherited from StatisticalInformation, "
375 "serves as part of the object key."),
376 MaxLen ( 256 )]
377 string Name;
378 };
379 tony 1.1
380
381 // ==================================================================
382 // ServiceStatistics
383 // ==================================================================
384 [Association, Version ( "2.6.0" ), Description (
385 "ServiceStatistics relates the ServiceStatisticalInformation "
386 "class to the Service to which it applies.")]
387 class CIM_ServiceStatistics : CIM_Statistics {
388
389 [Override ( "Stats" ), Weak, Description (
390 "The statistical object.")]
391 CIM_ServiceStatisticalInformation REF Stats;
392
393 [Override ( "Element" ), Min ( 1 ), Max ( 1 ), Description (
394 "The Service to which the statistics apply.")]
395 CIM_Service REF Element;
396 };
397
398
399 // ==================================================================
400 tony 1.1 // SAPStatisticalInformation
401 // ==================================================================
402 [Version ( "2.6.0" ), Description (
403 "Statistical information associated with a Service AccessPoint "
404 "object or one of its subclasses.")]
405 class CIM_SAPStatisticalInformation : CIM_StatisticalInformation {
406
407 [Key,
408 Propagated ( "CIM_ServiceAccessPoint.SystemCreationClassName"
409 ), Description (
410 "The scoping System's CreationClassName."),
411 MaxLen ( 256 )]
412 string SystemCreationClassName;
413
414 [Key, Propagated ( "CIM_ServiceAccessPoint.SystemName" ),
415 Description (
416 "The scoping System's Name."),
417 MaxLen ( 256 )]
418 string SystemName;
419
420 [Key, Propagated ( "CIM_ServiceAccessPoint.CreationClassName" ),
421 tony 1.1 Description (
422 "The scoping SAP's CreationClassName."),
423 MaxLen ( 256 )]
424 string SAPCreationClassName;
425
426 [Key, Propagated ( "CIM_ServiceAccessPoint.Name" ), Description (
427 "The scoping SAP's Name."),
428 MaxLen ( 256 )]
429 string SAPName;
430
431 [Key, Description (
432 "CreationClassName indicates the name of the class or the "
433 "subclass used in the creation of an instance. When used "
434 "with the other key properties of this class, this property "
435 "allows all instances of this class and its subclasses to be "
436 "uniquely identified."),
437 MaxLen ( 256 )]
438 string CreationClassName;
439
440 [Key, Override ( "Name" ), Description (
441 "The Name property, inherited from StatisticalInformation, "
442 tony 1.1 "serves as part of the object key."),
443 MaxLen ( 256 )]
444 string Name;
445 };
446
447
448 // ==================================================================
449 // SAPStatistics
450 // ==================================================================
451 [Association, Version ( "2.6.0" ), Description (
452 "SAPStatistics relates the SAPStatisticalInformation class to "
453 "the ServiceAccessPoint to which it applies.")]
454 class CIM_SAPStatistics : CIM_Statistics {
455
456 [Override ( "Stats" ), Weak, Description (
457 "The statistical object.")]
458 CIM_SAPStatisticalInformation REF Stats;
459
460 [Override ( "Element" ), Min ( 1 ), Max ( 1 ), Description (
461 "The ServiceAccessPoint to which the statistics apply.")]
462 CIM_ServiceAccessPoint REF Element;
463 tony 1.1 };
464
465
466 // ==================================================================
467 // DeviceStatisticalInformation
468 // ==================================================================
469 [Version ( "2.6.0" ), Description (
470 "Statistical information associated with a LogicalDevice or one "
471 "of its subclasses.")]
472 class CIM_DeviceStatisticalInformation : CIM_StatisticalInformation {
473
474 [Key, Propagated ( "CIM_LogicalDevice.SystemCreationClassName" ),
475 Description (
476 "The scoping System's CreationClassName."),
477 MaxLen ( 256 )]
478 string SystemCreationClassName;
479
480 [Key, Propagated ( "CIM_LogicalDevice.SystemName" ),
481 Description (
482 "The scoping System's Name."),
483 MaxLen ( 256 )]
484 tony 1.1 string SystemName;
485
486 [Key, Propagated ( "CIM_LogicalDevice.CreationClassName" ),
487 Description (
488 "The scoping Device's CreationClassName."),
489 MaxLen ( 256 )]
490 string DeviceCreationClassName;
491
492 [Key, Propagated ( "CIM_LogicalDevice.DeviceID" ), Description (
493 "The scoping Device's ID."),
494 MaxLen ( 64 )]
495 string DeviceID;
496
497 [Key, Description (
498 "CreationClassName indicates the name of the class or the "
499 "subclass used in the creation of an instance. When used "
500 "with the other key properties of this class, this property "
501 "allows all instances of this class and its subclasses to be "
502 "uniquely identified."),
503 MaxLen ( 256 )]
504 string CreationClassName;
505 tony 1.1
506 [Key, Override ( "Name" ), Description (
507 "The Name property, inherited from StatisticalInformation, "
508 "serves as part of the object key."),
509 MaxLen ( 256 )]
510 string Name;
511 };
512
513
514 // ==================================================================
515 // DeviceStatistics
516 // ==================================================================
517 [Association, Version ( "2.6.0" ), Description (
518 "DeviceStatistics relates the DeviceStatisticalInformation "
519 "class to the LogicalDevice to which it applies.")]
520 class CIM_DeviceStatistics : CIM_Statistics {
521
522 [Override ( "Stats" ), Weak, Description (
523 "The statistical object.")]
524 CIM_DeviceStatisticalInformation REF Stats;
525
526 tony 1.1 [Override ( "Element" ), Min ( 1 ), Max ( 1 ), Description (
527 "The Device to which the statistics apply.")]
528 CIM_LogicalDevice REF Element;
529 };
530
531
532 // ==================================================================
533 // PhysicalStatisticalInformation
534 // ==================================================================
535 [Version ( "2.6.0" ), Description (
536 "Statistical information associated with a PhysicalElement or "
537 "one of its subclasses.")]
538 class CIM_PhysicalStatisticalInformation : CIM_StatisticalInformation {
539
540 [Key, Propagated ( "CIM_PhysicalElement.CreationClassName" ),
541 Description (
542 "The scoping Element's CreationClassName."),
543 MaxLen ( 256 )]
544 string PhysicalCreationClassName;
545
546 [Key, Propagated ( "CIM_PhysicalElement.Tag" ), Description (
547 tony 1.1 "The scoping Element's identifying Tag."),
548 MaxLen ( 256 )]
549 string Tag;
550
551 [Key, Description (
552 "CreationClassName indicates the name of the class or the "
553 "subclass used in the creation of an instance. When used "
554 "with the other key properties of this class, this property "
555 "allows all instances of this class and its subclasses to be "
556 "uniquely identified."),
557 MaxLen ( 256 )]
558 string CreationClassName;
559
560 [Key, Override ( "Name" ), Description (
561 "The Name property, inherited from StatisticalInformation, "
562 "serves as part of the object key."),
563 MaxLen ( 256 )]
564 string Name;
565 };
566
567
568 tony 1.1 // ==================================================================
569 // PhysicalStatistics
570 // ==================================================================
571 [Association, Version ( "2.6.0" ), Description (
572 "PhysicalStatistics relates the PhysicalStatisticalInformation "
573 "class to the PhysicalElement to which it applies.")]
574 class CIM_PhysicalStatistics : CIM_Statistics {
575
576 [Override ( "Stats" ), Weak, Description (
577 "The statistical object.")]
578 CIM_PhysicalStatisticalInformation REF Stats;
579
580 [Override ( "Element" ), Min ( 1 ), Max ( 1 ), Description (
581 "The PhysicalElement to which the statistics apply.")]
582 CIM_PhysicalElement REF Element;
583 };
584
585 // ==================================================================
586 // StatisticalSetting
587 // ==================================================================
588 [Version ( "2.8.0" ), Description (
589 tony 1.1 "CIM_StatisticalSetting is the class for setting the collection "
590 "criteria of statistical data and/or metrics applicable to one "
591 "or more ManagedElements.")]
592 class CIM_StatisticalSetting : CIM_SettingData {
593
594 [Write, Description (
595 "The time, relative to managed element where the statistic "
596 "is to be collected, when the first measurement is to be "
597 "taken."),
598 ModelCorrespondence { "CIM_StatisticalData.StartStatisticTime" }]
599 datetime StartStatisticTime;
600
601 [Write, Description (
602 "The time, relative to managed element where the statistic "
603 "is to be collected, when the measurement is to end.")]
604 datetime EndStatisticTime;
605
606 [Write, Description (
607 "Some statistics are sampled at consistent time intervals. "
608 "This property when set indicates the desired minimum time "
609 "that new statistics should be polled or calculated."),
610 tony 1.1 ModelCorrespondence { "CIM_StatisticalData.SampleInterval" }]
611 datetime SampleInterval;
612 };
613
614 // ===================================================================
615 // end of file
616 // ===================================================================
|
Return to
Core28_Statistics.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIM28