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