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