1 karl 1.1 // ===================================================================
2 // Title: Core Statistics 2.7
3 // Filename: Core27_Statistics.mof
4 // Version: 2.7.0
5 // Release: Preliminary
6 // Date: 07/01/02
7 // ===================================================================
8 // Copyright 2002 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 karl 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 karl 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.7
53 // CR721 - Introduce StatisticalData, ElementStatisticalData,
54 // and ReleatedStatisticalData
55 // ==================================================================
56
57 #pragma locale ("en_US")
58
59
60 // ==================================================================
61 // StatisticalData
62 // ==================================================================
63 [Abstract, Experimental, Version ("2.7.0"), Description (
64 karl 1.1 "CIM_StatisticalData is a root class for any arbitrary "
65 "collection of statistical data and/or metrics applicable to "
66 "one or more ManagedElements. These statistics MUST "
67 "represent the most recent observations and MUST NOT be "
68 "provided if irrelevant or stale. Note that this class uses "
69 "a simplified naming/identity algorithm as compared to "
70 "CIM_StatisticalInformation.") ]
71 class CIM_StatisticalData : CIM_ManagedElement {
72
73 [Key, Description (
74 "InstanceID opaquely identifies a unique instance of "
75 "StatisticalData. The InstanceID must be unique within a "
76 "namespace. In order to ensure uniqueness, the value of "
77 "InstanceID SHOULD be constructed in the following manner: \n"
78 "<Vendor ID><ID> \n"
79 " <Vendor ID> MUST include a copyrighted, trademarked "
80 "or otherwise unique name that is owned by the business "
81 "entity or a registered ID that is assigned to the business "
82 "entity that is defining the InstanceID. (This is similar to "
83 "the <Schema Name>_<Class Name> structure of Schema class "
84 "names.) The purpose of <Vendor ID> is to ensure that <ID> "
85 karl 1.1 "is truly unique across multiple vendor implementations. "
86 "If such a name is not used, the defining entity MUST assure "
87 "that the <ID> portion of the Instance ID is unique when "
88 "compared with other instance providers. For DMTF defined "
89 "instances, the <Vendor ID> is 'CIM'. \n"
90 " <ID> MUST include a vendor specified unique "
91 "identifier.") ]
92 string InstanceID;
93
94 [Override ("ElementName"), Required, Description (
95 "The user friendly name for this instance of StatisticalData. "
96 "In addition, the user friendly name can be used as a "
97 "index property for a search of query. (Note: Name "
98 "does not have to be unique within a namespace.)") ]
99 string ElementName;
100
101 [Description (
102 "Method to reset one or more of the instance's statistics. "
103 "The method takes one parameter as input - an array of "
104 "strings indicating which statistics to reset. If all the "
105 "statistics in the instance should be reset, the first "
106 karl 1.1 "element of the array MUST be set to \"All\" or \"ALL\". "
107 "If one or more individual statistics should be reset, the "
108 "corresponding property names are entered into the "
109 "elements of the array. \n"
110 "The method returns 0 if successful, 1 if not supported, and "
111 "any other value if an error occurred. A method is specified "
112 "so that the StatisticalInformation's provider/"
113 "instrumentation, which calculates the statistics, can reset "
114 "its internal processing, counters, etc. \n"
115 "In a subclass, the set of possible return codes could be "
116 "specified, using a ValueMap qualifier on the method. The "
117 "strings to which the ValueMap contents are 'translated' "
118 "may also be specified in the subclass as a Values "
119 "array qualifier.") ]
120 uint32 ResetSelectedStats (
121 [IN] string SelectedStatistics[]);
122 };
123
124
125 // ==================================================================
126 // ElementStatisticalData
127 karl 1.1 // ==================================================================
128 [Association, Experimental, Version ("2.7.0"), Description (
129 "CIM_ElementStatisticalData is an association that relates a "
130 "ManagedElement to its StatisticalData. Note that the "
131 "cardinality of the ManagedElement reference is Min(1), "
132 "Max(1). This cardinality mandates the instantiation of the "
133 "ElementStatisticalData association for the referenced instance "
134 "of CIM_StatisticalData. ElementStatisticalData describes the "
135 "existence requirements and context for the CIM_StatisticalData, "
136 "relative to a specific ManagedElement.") ]
137 class CIM_ElementStatisticalData {
138
139 [Key, Min(1), Max(1), Description (
140 "The ManagedElement for which statistical or metric "
141 "data is defined.") ]
142 CIM_ManagedElement REF ManagedElement;
143
144 [Key, Description (
145 "The statistic information/object.") ]
146 CIM_StatisticalData REF Stats;
147 };
148 karl 1.1
149
150 // ==================================================================
151 // RelatedStatisticalData
152 // ==================================================================
153 [Association, Experimental, Description (
154 "CIM_RelatedStatisticalData is an association that defines "
155 "hierarchies and/or dependencies of related CIM_Statistical"
156 "Data classes.") ]
157 class CIM_RelatedStatisticalData {
158
159 [Key, Description (
160 "The statistic information/object.") ]
161 CIM_StatisticalData REF Stats;
162
163 [Key, Description (
164 "The related statistics.") ]
165 CIM_StatisticalData REF RelatedStats;
166
167 [Description (
168 "A free-form string describing how the statistics are "
169 karl 1.1 "related.") ]
170 string Description;
171 };
172
173
174 // ==================================================================
175 // StatisticalInformation
176 // ==================================================================
177 [Abstract, Version ("2.6.0"), Description (
178 "CIM_StatisticalInformation is a root class for any arbitrary "
179 "collection of statistical data and/or metrics applicable to "
180 "one or more ManagedSystemElements. Note that the CIM_"
181 "StatisticalData class uses a simplified naming/identity "
182 "algorithm as compared to this class. StatisticalInformation "
183 "is not deprecated since its naming algorithm is still in use in "
184 "various implementations.") ]
185 class CIM_StatisticalInformation : CIM_ManagedElement {
186
187 [MaxLen (256), Description (
188 "The Name property defines the label by which the statistic "
189 "or metric is known. When subclassed, the property can be "
190 karl 1.1 "overridden to be a Key property.") ]
191 string Name;
192 };
193
194
195 // ==================================================================
196 // Statistics
197 // ==================================================================
198 [Association, Version ("2.6.0"), Description (
199 "CIM_Statistics is an association that relates Managed"
200 "Elements to the StatisticalGroup(s) that apply to them.") ]
201 class CIM_Statistics {
202
203 [Key, Description (
204 "The statistic information/object.") ]
205 CIM_StatisticalInformation REF Stats;
206
207 [Key, Description (
208 "The ManagedElement for which statistical or metric "
209 "data is defined.") ]
210 CIM_ManagedElement REF Element;
211 karl 1.1 };
212
213
214 // ==================================================================
215 // RelatedStatistics
216 // ==================================================================
217 [Association, Version ("2.6.0"), Description (
218 "CIM_RelatedStatistics is an association that defines "
219 "hierarchies and/or dependencies of related CIM_Statistical"
220 "Information classes.") ]
221 class CIM_RelatedStatistics {
222
223 [Key, Description (
224 "The statistic information/object.") ]
225 CIM_StatisticalInformation REF Stats;
226
227 [Key, Description (
228 "The related statistics or metrics.") ]
229 CIM_StatisticalInformation REF RelatedStats;
230 };
231
232 karl 1.1
233 // ==================================================================
234 // SystemStatisticalInformation
235 // ==================================================================
236 [Version ("2.6.0"), Description (
237 "Statistical information associated with a System object "
238 "or one of its subclasses.") ]
239 class CIM_SystemStatisticalInformation : CIM_StatisticalInformation {
240
241 [Propagated("CIM_System.CreationClassName"), Key,
242 MaxLen (256), Description (
243 "The scoping System's CreationClassName.") ]
244 string SystemCreationClassName;
245
246 [Propagated("CIM_System.Name"), Key, MaxLen (256),
247 Description ("The scoping System's Name.") ]
248 string SystemName;
249
250 [Key, MaxLen (256), Description (
251 "CreationClassName indicates the name of the class or the "
252 "subclass used in the creation of an instance. When used "
253 karl 1.1 "with the other key properties of this class, this property "
254 "allows all instances of this class and its subclasses to "
255 "be uniquely identified.") ]
256 string CreationClassName;
257
258 [Key, MaxLen (256), Override ("Name"), Description (
259 "The Name property, inherited from StatisticalInformation, "
260 "serves as part of the object key.") ]
261 string Name;
262 };
263
264
265 // ==================================================================
266 // SystemStatistics
267 // ==================================================================
268 [Association, Version ("2.6.0"), Description (
269 "SystemStatistics relates the SystemStatisticalInformation "
270 "class to the System to which it applies.") ]
271 class CIM_SystemStatistics : CIM_Statistics {
272
273 [Override ("Stats"), Weak, Description (
274 karl 1.1 "The statistical object.") ]
275 CIM_SystemStatisticalInformation REF Stats;
276
277 [Override ("Element"), Min (1), Max (1),
278 Description ("The System to which the statistics apply.") ]
279 CIM_System REF Element;
280 };
281
282
283 // ==================================================================
284 // ServiceStatisticalInformation
285 // ==================================================================
286 [Version ("2.6.0"), Description (
287 "Statistical information associated with a Service object "
288 "or one of its subclasses.") ]
289 class CIM_ServiceStatisticalInformation : CIM_StatisticalInformation {
290
291 [Propagated("CIM_Service.SystemCreationClassName"), Key,
292 MaxLen (256), Description (
293 "The scoping System's CreationClassName.") ]
294 string SystemCreationClassName;
295 karl 1.1
296 [Propagated("CIM_Service.SystemName"), Key, MaxLen (256),
297 Description ("The scoping System's Name.") ]
298 string SystemName;
299
300 [Propagated("CIM_Service.CreationClassName"), Key,
301 MaxLen (256), Description (
302 "The scoping Service's CreationClassName.") ]
303 string ServiceCreationClassName;
304
305 [Propagated("CIM_Service.Name"), Key, MaxLen (256),
306 Description ("The scoping Service's Name.") ]
307 string ServiceName;
308
309 [Key, MaxLen (256), Description (
310 "CreationClassName indicates the name of the class or the "
311 "subclass used in the creation of an instance. When used "
312 "with the other key properties of this class, this property "
313 "allows all instances of this class and its subclasses to "
314 "be uniquely identified.") ]
315 string CreationClassName;
316 karl 1.1
317 [Key, MaxLen (256), Override ("Name"), Description (
318 "The Name property, inherited from StatisticalInformation, "
319 "serves as part of the object key.") ]
320 string Name;
321 };
322
323
324 // ==================================================================
325 // ServiceStatistics
326 // ==================================================================
327 [Association, Version ("2.6.0"), Description (
328 "ServiceStatistics relates the ServiceStatisticalInformation "
329 "class to the Service to which it applies.") ]
330 class CIM_ServiceStatistics : CIM_Statistics {
331
332 [Override ("Stats"), Weak,
333 Description ("The statistical object.") ]
334 CIM_ServiceStatisticalInformation REF Stats;
335
336 [Override ("Element"), Min (1), Max (1),
337 karl 1.1 Description (
338 "The Service to which the statistics apply.") ]
339 CIM_Service REF Element;
340 };
341
342
343 // ==================================================================
344 // SAPStatisticalInformation
345 // ==================================================================
346 [Version ("2.6.0"), Description (
347 "Statistical information associated with a Service"
348 "AccessPoint object or one of its subclasses.") ]
349 class CIM_SAPStatisticalInformation : CIM_StatisticalInformation {
350
351 [Propagated("CIM_ServiceAccessPoint.SystemCreationClassName"),
352 Key, MaxLen (256), Description (
353 "The scoping System's CreationClassName.") ]
354 string SystemCreationClassName;
355
356 [Propagated("CIM_ServiceAccessPoint.SystemName"), Key,
357 MaxLen (256), Description ("The scoping System's Name.") ]
358 karl 1.1 string SystemName;
359
360 [Propagated("CIM_ServiceAccessPoint.CreationClassName"),
361 Key, MaxLen (256), Description (
362 "The scoping SAP's CreationClassName.") ]
363 string SAPCreationClassName;
364
365 [Propagated("CIM_ServiceAccessPoint.Name"), Key,
366 MaxLen (256), Description ("The scoping SAP's Name.") ]
367 string SAPName;
368
369 [Key, MaxLen (256), Description (
370 "CreationClassName indicates the name of the class or the "
371 "subclass used in the creation of an instance. When used "
372 "with the other key properties of this class, this property "
373 "allows all instances of this class and its subclasses to "
374 "be uniquely identified.") ]
375 string CreationClassName;
376
377 [Key, MaxLen (256), Override ("Name"), Description (
378 "The Name property, inherited from StatisticalInformation, "
379 karl 1.1 "serves as part of the object key.") ]
380 string Name;
381 };
382
383
384 // ==================================================================
385 // SAPStatistics
386 // ==================================================================
387 [Association, Version ("2.6.0"), Description (
388 "SAPStatistics relates the SAPStatisticalInformation "
389 "class to the ServiceAccessPoint to which it applies.") ]
390 class CIM_SAPStatistics : CIM_Statistics {
391
392 [Override ("Stats"), Weak,
393 Description ("The statistical object.") ]
394 CIM_SAPStatisticalInformation REF Stats;
395
396 [Override ("Element"), Min (1), Max (1), Description (
397 "The ServiceAccessPoint to which the statistics apply.") ]
398 CIM_ServiceAccessPoint REF Element;
399 };
400 karl 1.1
401
402 // ==================================================================
403 // DeviceStatisticalInformation
404 // ==================================================================
405 [Version ("2.6.0"), Description (
406 "Statistical information associated with a LogicalDevice "
407 "or one of its subclasses.") ]
408 class CIM_DeviceStatisticalInformation : CIM_StatisticalInformation {
409 [Propagated("CIM_LogicalDevice.SystemCreationClassName"), Key,
410 MaxLen (256), Description (
411 "The scoping System's CreationClassName.") ]
412 string SystemCreationClassName;
413
414 [Propagated("CIM_LogicalDevice.SystemName"), Key, MaxLen (256),
415 Description ("The scoping System's Name.") ]
416 string SystemName;
417
418 [Propagated("CIM_LogicalDevice.CreationClassName"), Key,
419 MaxLen (256),
420 Description ("The scoping Device's CreationClassName.") ]
421 karl 1.1 string DeviceCreationClassName;
422
423 [Propagated("CIM_LogicalDevice.DeviceID"), Key, MaxLen (64),
424 Description ("The scoping Device's ID.") ]
425 string DeviceID;
426
427 [Key, MaxLen (256), Description (
428 "CreationClassName indicates the name of the class or the "
429 "subclass used in the creation of an instance. When used "
430 "with the other key properties of this class, this property "
431 "allows all instances of this class and its subclasses to "
432 "be uniquely identified.") ]
433 string CreationClassName;
434
435 [Key, MaxLen (256), Override ("Name"), Description (
436 "The Name property, inherited from StatisticalInformation, "
437 "serves as part of the object key.") ]
438 string Name;
439 };
440
441
442 karl 1.1 // ==================================================================
443 // DeviceStatistics
444 // ==================================================================
445 [Association, Version ("2.6.0"), Description (
446 "DeviceStatistics relates the DeviceStatisticalInformation "
447 "class to the LogicalDevice to which it applies.") ]
448 class CIM_DeviceStatistics : CIM_Statistics {
449 [Override ("Stats"), Weak,
450 Description ("The statistical object.") ]
451 CIM_DeviceStatisticalInformation REF Stats;
452
453 [Override ("Element"), Min (1), Max (1),
454 Description ("The Device to which the statistics apply.") ]
455 CIM_LogicalDevice REF Element;
456 };
457
458
459 // ==================================================================
460 // PhysicalStatisticalInformation
461 // ==================================================================
462 [Version ("2.6.0"), Description (
463 karl 1.1 "Statistical information associated with a PhysicalElement "
464 "or one of its subclasses.") ]
465 class CIM_PhysicalStatisticalInformation : CIM_StatisticalInformation {
466 [Propagated("CIM_PhysicalElement.CreationClassName"), Key,
467 MaxLen (256),
468 Description ("The scoping Element's CreationClassName.") ]
469 string PhysicalCreationClassName;
470
471 [Propagated("CIM_PhysicalElement.Tag"), Key, MaxLen (256),
472 Description ("The scoping Element's identifying Tag.") ]
473 string Tag;
474
475 [Key, MaxLen (256), Description (
476 "CreationClassName indicates the name of the class or the "
477 "subclass used in the creation of an instance. When used "
478 "with the other key properties of this class, this property "
479 "allows all instances of this class and its subclasses to "
480 "be uniquely identified.") ]
481 string CreationClassName;
482
483 [Key, MaxLen (256), Override ("Name"), Description (
484 karl 1.1 "The Name property, inherited from StatisticalInformation, "
485 "serves as part of the object key.") ]
486 string Name;
487 };
488
489
490 // ==================================================================
491 // PhysicalStatistics
492 // ==================================================================
493 [Association, Version ("2.6.0"), Description (
494 "PhysicalStatistics relates the PhysicalStatisticalInformation "
495 "class to the PhysicalElement to which it applies.") ]
496 class CIM_PhysicalStatistics : CIM_Statistics {
497 [Override ("Stats"), Weak,
498 Description ("The statistical object.") ]
499 CIM_PhysicalStatisticalInformation REF Stats;
500
501 [Override ("Element"), Min (1), Max (1), Description (
502 "The PhysicalElement to which the statistics apply.") ]
503 CIM_PhysicalElement REF Element;
504 };
505 karl 1.1
506
507 // ===================================================================
508 // end of file
509 // ===================================================================
|