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