1 a.dunfey 1.1 // ===================================================================
2 // Title: Core Settings
3 // $State: Preliminary $
4 // $Date: 2005/01/05 00:54:00 $
5 // $Source: /home/dmtf2/dotorg/var/cvs/repositories/dev/Schema/MOF/Core_Settings.mof,v $
6 // $Revision: 1.14 $
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 Settings/SettingData and their
48 // groupings, Profiles and Configurations.
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.9 Preliminary
55 // CR1333 - Add support for configuration "blobs" as a subclass of
56 // SettingData.Also deprecate Save and Restore properties in
57 // LogicalDevice
58 // CR1336 - Add TimeService and related classes. Deprecate CIM_TimeZone
59 // CR1378 - Deprecate CIM_Profile, CIM_Configuration
60 //
61 // Change Log for v2.8 Final
62 // CR1128 - Addition of HostedDependency
63 // CR1223 - SysDev Omnibus CR - Minor MOF corrections.
64 a.dunfey 1.1 //
65 // Change Log for v2.7 Final
66 // CR927 - Relax cardinality for the ManagedElement side of
67 // ElementProfile
68 // - Update the description of Profile to reflect this change.
69 // CR968 - Remove the Experimental qualifier
70 // CR994 - Update description of InstanceID
71 //
72 // Change Log for v2.7
73 // CR723 - Introduce SettingData, ScopedSetttingData, ScopedSetting,
74 // and ElementSettingData.
75 // - Clarify the description of Setting to reconcile with
76 // SettingData.
77 // CR642 - Add Profile and ElementProfile
78 // ==================================================================
79
80 #pragma locale ("en_US")
81
82
83 // ===================================================================
84 // SettingData
85 a.dunfey 1.1 // ===================================================================
86 [Abstract, Version ( "2.8.1000" ), Description (
87 "The SettingData class represents configuration-related and "
88 "operational parameters for one or more ManagedElement(s). A "
89 "ManagedElement may have multiple SettingData objects "
90 "associated with it. The current operational values for an "
91 "Element's parameters are reflected by properties in the "
92 "Element itself or by properties in its associations. These "
93 "properties do not have to be the same values present in the "
94 "SettingData object. For example, a modem may have a "
95 "SettingData baud rate of 56Kb/sec but be operating at "
96 "19.2Kb/sec. \n"
97 "Note that the CIM_SettingData class is very similar to "
98 "CIM_Setting, yet both classes are present in the model. This "
99 "is because many implementations have successfully used "
100 "CIM_Setting. However, issues have arisen that could not be "
101 "resolved without defining a new class. Therefore, until a new "
102 "major release occurs, both classes will exist in the model. "
103 "Refer to the Core White Paper for additional information. "
104 "SettingData instances may be aggregated together into higher "
105 "level SettingData objects using ConcreteComponent "
106 a.dunfey 1.1 "associations.")]
107 class CIM_SettingData : CIM_ManagedElement {
108
109 [Key, Description (
110 "Within the scope of the instantiating Namespace, InstanceID "
111 "opaquely and uniquely identifies an instance of this class. "
112 "In order to ensure uniqueness within the NameSpace, the "
113 "value of InstanceID SHOULD be constructed using the "
114 "following 'preferred' algorithm: \n"
115 "<OrgID>:<LocalID> \n"
116 "Where <OrgID> and <LocalID> are separated by a colon ':', "
117 "and where <OrgID> MUST include a copyrighted, trademarked "
118 "or otherwise unique name that is owned by the business "
119 "entity creating/defining the InstanceID, or is a registered "
120 "ID that is assigned to the business entity by a recognized "
121 "global authority (This is similar to the <Schema "
122 "Name>_<Class Name> structure of Schema class names.) In "
123 "addition, to ensure uniqueness <OrgID> MUST NOT contain a "
124 "colon (':'). When using this algorithm, the first colon to "
125 "appear in InstanceID MUST appear between <OrgID> and "
126 "<LocalID>. \n"
127 a.dunfey 1.1 "<LocalID> is chosen by the business entity and SHOULD not "
128 "be re-used to identify different underlying (real-world) "
129 "elements. If the above 'preferred' algorithm is not used, "
130 "the defining entity MUST assure that the resultant "
131 "InstanceID is not re-used across any InstanceIDs produced "
132 "by this or other providers for this instance's NameSpace. \n"
133 "For DMTF defined instances, the 'preferred' algorithm MUST "
134 "be used with the <OrgID> set to 'CIM'.")]
135 string InstanceID;
136
137 [Required, Override ( "ElementName" ), Description (
138 "The user friendly name for this instance of SettingData. In "
139 "addition, the user friendly name can be used as a index "
140 "property for a search of query. (Note: Name does not have "
141 "to be unique within a namespace.)")]
142 string ElementName;
143 };
144
145
146 // ===================================================================
147 // ScopedSettingData
148 a.dunfey 1.1 // ===================================================================
149 [Abstract, Version ( "2.7.0" ), Description (
150 "The ScopedSettingData class represents the general concept of "
151 "SettingData which is scoped/contained by a ManagedElement "
152 "(i.e. settings that are specifically defined for a system, "
153 "device, etc). ScopedSettingData is tied to a ManagedElement "
154 "using the ScopedSetting association. Note that the cardinality "
155 "of the ManagedElement reference is Min(1), Max(1). This "
156 "cardinality mandates the instantiation of the ScopedSetting "
157 "association for the referenced instance of ScopedSettingData. "
158 "ScopedSetting describes the existence requirements and context "
159 "for the referenced instance of ManagedElement. Specifically, "
160 "the ManagedElement MUST exist and provides the context for the "
161 "ScopedSettingData.")]
162 class CIM_ScopedSettingData : CIM_SettingData {
163 };
164
165
166 // ===================================================================
167 // ScopedSetting
168 // ===================================================================
169 a.dunfey 1.1 [Association, Version ( "2.8.0" ), Description (
170 "ScopedSetting defines a setting in the context of the Managed "
171 "Element which it resides.")]
172 class CIM_ScopedSetting : CIM_HostedDependency {
173
174 [Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
175 "The scoping ManagedElement.")]
176 CIM_ManagedElement REF Antecedent;
177
178 [Override ( "Dependent" ), Description (
179 "The setting defined for the ManagedElement.")]
180 CIM_ScopedSettingData REF Dependent;
181 };
182
183
184 // ===================================================================
185 // ElementSettingData
186 // ===================================================================
187 [Association, Version ( "2.8.1000" ), Description (
188 "ElementSettingData represents the association between "
189 "ManagedElements and applicable setting data. This association "
190 a.dunfey 1.1 "also describes whether this is a default or current setting.")]
191 class CIM_ElementSettingData {
192
193 [Key, Description (
194 "The managed element.")]
195 CIM_ManagedElement REF ManagedElement;
196
197 [Key, Description (
198 "The SettingData object associated with the element.")]
199 CIM_SettingData REF SettingData;
200
201 [Description (
202 "An enumerated integer indicating that the referenced "
203 "setting is a default setting for the element, or that this "
204 "information is unknown."),
205 ValueMap { "0", "1", "2" },
206 Values { "Unknown", "Is Default", "Is Not Default" }]
207 uint16 IsDefault;
208
209 [Description (
210 "An enumerated integer indicating that the referenced "
211 a.dunfey 1.1 "setting is currently being used in the operation of the "
212 "element, or that this information is unknown."),
213 ValueMap { "0", "1", "2" },
214 Values { "Unknown", "Is Current", "Is Not Current" }]
215 uint16 IsCurrent;
216 };
217
218
219 // ==================================================================
220 // Profile
221 // ==================================================================
222 [Deprecated { "CIM_SettingData", "CIM_Setting",
223 "CIM_ConcreteComponent" }, Version ( "2.8.1000" ), Description (
224 "The use of CIM_Profile is deprecated in favor of aggregating "
225 "instances of Setting or SettingData into 'higher' level "
226 "Settings/SettingData objects, using the ConcreteComponent "
227 "association. This simplifies the use of Settings/SettingData. "
228 "With Profiles subclassing from Collection, separate "
229 "associations were needed from an element to either its "
230 "Profiles or Settings/ SettingData. This introduced unnecessary "
231 "complexity and redundancy into the model. \n"
232 a.dunfey 1.1 "\n"
233 "Profile specifies a general collection of Settings/SettingData "
234 "that are logically grouped together. Note that the CIM_Profile "
235 "class uses simplified naming/identity and collection "
236 "algorithms, as compared to CIM_Configuration. The settings are "
237 "'collected' into the Profile using the MemberOfCollection "
238 "association. Note that a Profile obtains its setting data and "
239 "other necessary information from collected Setting/SettingData "
240 "instances, and by the definition of additional properties in "
241 "subclasses. One example of a Profile is to define the "
242 "collection of settings for a particular person. Another is to "
243 "define the collection of settings appropriate when "
244 "initializing a system. \n"
245 "\n"
246 "Profile is tied to a ManagedElement using the ElementProfile "
247 "association. The ManagedElement provides context for the "
248 "Profile, and the settings collected by Profile SHOULD be "
249 "settings of the associated ManagedElement. Note that a "
250 "ManagedElement MAY NOT exist when the Profile is instantiated. "
251 "This is true when the Profile is used in the creation of the "
252 "real world entity represented by (and then instantiated in) "
253 a.dunfey 1.1 "the ManagedElement.")]
254 class CIM_Profile : CIM_Collection {
255
256 [Deprecated { "CIM_SettingData.InstanceID",
257 "CIM_Setting.SettingID" }, Key, Description (
258 "Within the scope of the instantiating Namespace, InstanceID "
259 "opaquely and uniquely identifies an instance of this class. "
260 "In order to ensure uniqueness within the NameSpace, the "
261 "value of InstanceID SHOULD be constructed using the "
262 "following 'preferred' algorithm: \n"
263 "<OrgID>:<LocalID> \n"
264 "Where <OrgID> and <LocalID> are separated by a colon ':', "
265 "and where <OrgID> MUST include a copyrighted, trademarked "
266 "or otherwise unique name that is owned by the business "
267 "entity creating/defining the InstanceID, or is a registered "
268 "ID that is assigned to the business entity by a recognized "
269 "global authority (This is similar to the <Schema "
270 "Name>_<Class Name> structure of Schema class names.) In "
271 "addition, to ensure uniqueness <OrgID> MUST NOT contain a "
272 "colon (':'). When using this algorithm, the first colon to "
273 "appear in InstanceID MUST appear between <OrgID> and "
274 a.dunfey 1.1 "<LocalID>. \n"
275 "<LocalID> is chosen by the business entity and SHOULD not "
276 "be re-used to identify different underlying (real-world) "
277 "elements. If the above 'preferred' algorithm is not used, "
278 "the defining entity MUST assure that the resultant "
279 "InstanceID is not re-used across any InstanceIDs produced "
280 "by this or other providers for this instance's NameSpace. \n"
281 "For DMTF defined instances, the 'preferred' algorithm MUST "
282 "be used with the <OrgID> set to 'CIM'.")]
283 string InstanceID;
284 };
285
286
287 // ===================================================================
288 // ElementProfile
289 // ===================================================================
290 [Association, Deprecated { "CIM_ElementSettingData",
291 "CIM_ElementSetting" }, Version ( "2.8.1000" ), Description (
292 "ElementProfile represents the association between "
293 "ManagedElements and the Profiles (collection of settings) "
294 "defined for them. This association describes that the settings "
295 a.dunfey 1.1 "collected by the Profile apply to the associated "
296 "ManagedElement. \n"
297 "\n"
298 "The Profile class is being deprecated in lieu of using a "
299 "ConcreteComponent relationship to indicate a hierarchy of "
300 "Setting/SettingData instances. This allows the re-use of the "
301 "element to Setting/SettingData associations, instead of "
302 "defining a peer association specifically for Profiles.")]
303 class CIM_ElementProfile {
304
305 [Deprecated { "CIM_ElementSettingData.ManagedElement",
306 "CIM_ElementSetting.Element" }, Key, Description (
307 "The managed element.")]
308 CIM_ManagedElement REF ManagedElement;
309
310 [Deprecated { "CIM_ElementSettingData.SettingData",
311 "CIM_ElementSetting.Setting" }, Key, Description (
312 "The Profile object associated with the element.")]
313 CIM_Profile REF Profile;
314 };
315
316 a.dunfey 1.1 // ===================================================================
317 // Setting
318 // ===================================================================
319 [Abstract, Version ( "2.8.1000" ), Description (
320 "The Setting class represents configuration-related and "
321 "operational parameters for one or more "
322 "ManagedSystemElement(s). An Element may have multiple Setting "
323 "objects associated with it. The current operational values for "
324 "an Element's parameters are reflected by properties in the "
325 "Element itself or by properties in its associations. These "
326 "properties do not have to be the same values present in the "
327 "Setting object. For example, a modem may have a Setting baud "
328 "rate of 56Kb/sec but be operating at 19.2Kb/sec. \n"
329 "Note that the CIM_SettingData class is very similar to "
330 "CIM_Setting, yet both classes are present in the model. This "
331 "is because many implementations have successfully used "
332 "CIM_Setting. However, issues have arisen that could not be "
333 "resolved without defining a new class. Therefore, until a new "
334 "major release occurs, both classes will exist in the model. "
335 "Refer to the Core White Paper for additional information. "
336 "Setting instances may be aggregated together into higher level "
337 a.dunfey 1.1 "Setting objects using ConcreteComponent associations.")]
338 class CIM_Setting : CIM_ManagedElement {
339
340 [Description (
341 "The identifier by which the Setting object is known."),
342 MaxLen ( 256 )]
343 string SettingID;
344
345 [Description (
346 "The VerifyOKToApplyToMSE method is used to verify that this "
347 "Setting can be 'applied' to the referenced Managed "
348 "SystemElement, at the given time or time interval. This "
349 "method takes three input parameters: MSE (the Managed "
350 "SystemElement that is being verified), TimeToApply (which, "
351 "being a datetime, can be either a specific time or a time "
352 "interval), and MustBeCompletedBy (which indicates the "
353 "required completion time for the method). The return value "
354 "should be 0 if it is OK to apply the Setting, 1 if the "
355 "method is not supported, 2 if the Setting cannot be applied "
356 "within the specified times, and any other number if an "
357 "error occurred. In a subclass, the set of possible return "
358 a.dunfey 1.1 "codes could be specified, using a ValueMap qualifier on the "
359 "method. The strings to which the ValueMap contents are "
360 "'translated' may also be specified in the subclass as a "
361 "Values array qualifier.")]
362 uint32 VerifyOKToApplyToMSE(
363 [IN, Description (
364 "The Managed SystemElement that is being verified.")]
365 CIM_ManagedSystemElement REF MSE,
366 [IN, Description (
367 "TimeToApply can be either a specific time or a time "
368 "interval.")]
369 datetime TimeToApply,
370 [IN, Description (
371 "The required completion time for the method.")]
372 datetime MustBeCompletedBy);
373
374 [Description (
375 "The ApplyToMSE method performs the actual application of "
376 "the Setting to the referenced ManagedSystemElement. It "
377 "takes three input parameters: MSE (the ManagedSystem "
378 "Element to which the Setting is being applied), TimeToApply "
379 a.dunfey 1.1 "(which, being a datetime, can be either a specific time or "
380 "a time interval), and MustBeCompletedBy (which indicates "
381 "the required completion time for the method). Note that the "
382 "semantics of this method are that individual Settings are "
383 "either wholly applied or not applied at all to their target "
384 "ManagedSystemElement. The return value should be 0 if the "
385 "Setting is successfully applied to the referenced "
386 "ManagedSystemElement, 1 if the method is not supported, 2 "
387 "if the Setting was not applied within the specified times, "
388 "and any other number if an error occurred. In a subclass, "
389 "the set of possible return codes could be specified, using "
390 "a ValueMap qualifier on the method. The strings to which "
391 "the ValueMap contents are 'translated' may also be "
392 "specified in the subclass as a Values array qualifier. \n"
393 "Note: If an error occurs in applying the Setting to a "
394 "ManagedSystemElement, the Element must be configured as "
395 "when the 'Apply' attempt began. That is, the Element should "
396 "NOT be left in an indeterminate state.")]
397 uint32 ApplyToMSE(
398 [IN, Description (
399 "The ManagedSystem Element to which the Setting is being "
400 a.dunfey 1.1 "applied.")]
401 CIM_ManagedSystemElement REF MSE,
402 [IN, Description (
403 "TimeToApply can be either a specific time or a time "
404 "interval.")]
405 datetime TimeToApply,
406 [IN, Description (
407 "The required completion time for the method.")]
408 datetime MustBeCompletedBy);
409
410 [Description (
411 "The VerifyOKToApplyToCollection method is used to verify "
412 "that this Setting can be 'applied' to the referenced "
413 "Collection of ManagedSystemElements, at the given time or "
414 "time interval, without causing adverse effects to either "
415 "the Collection itself or its surrounding environment. The "
416 "net effect is to execute the VerifyOKToApply method against "
417 "each of the Elements aggregated by the Collection. This "
418 "method takes three input parameters: Collection (the "
419 "Collection of Managed SystemElements that is being "
420 "verified), TimeToApply (which, being a datetime, can be "
421 a.dunfey 1.1 "either a specific time or a time interval), and "
422 "MustBeCompletedBy (which indicates the required completion "
423 "time for the method). The return value should be 0 if it is "
424 "OK to apply the Setting, 1 if the method is not supported, "
425 "2 if the Setting cannot be applied within the specified "
426 "times, and any other number if an error occurred. One "
427 "output parameter is defined - CanNotApply - which is a "
428 "string array that lists the keys of the "
429 "ManagedSystemElements to which the Setting can NOT be "
430 "applied. This enables those Elements to be revisited and "
431 "either fixed, or other corrective action taken. \n"
432 "In a subclass, the set of possible return codes could be "
433 "specified, using a ValueMap qualifier on the method. The "
434 "strings to which the ValueMap contents are 'translated' may "
435 "also be specified in the subclass as a Values array "
436 "qualifier.")]
437 uint32 VerifyOKToApplyToCollection (
438 [IN, Description (
439 "The Collection of Managed SystemElements that is being "
440 "verified.")]
441 CIM_CollectionOfMSEs REF Collection,
442 a.dunfey 1.1 [IN, Description (
443 "TimeToApply can be either a specific time or a time "
444 "interval.")]
445 datetime TimeToApply,
446 [IN, Description (
447 "The required completion time for the method.")]
448 datetime MustBeCompletedBy,
449 [IN ( false ), OUT, Description (
450 "A string array that lists the keys of the "
451 "ManagedSystemElements to which the Setting can NOT be "
452 "applied.")]
453 string CanNotApply[]);
454
455 [Description (
456 "The ApplyToCollection method performs the application of "
457 "the Setting to the referenced Collection of ManagedSystem "
458 "Elements. The net effect is to execute the ApplyToMSE "
459 "method against each of the Elements aggregated by the "
460 "Collection. If the input value ContinueOnError is FALSE, "
461 "this method applies the Setting to all Elements in the "
462 "Collection until it encounters an error, in which case it "
463 a.dunfey 1.1 "stops execution, logs the key of the Element that caused "
464 "the error in the CanNotApply array, and issues a return "
465 "code of 2. If the input value ContinueOnError is TRUE, then "
466 "this method applies the Setting to all the "
467 "ManagedSystemElements in the Collection, and reports the "
468 "failed Elements in the array, CanNotApply. For the latter, "
469 "processing will continue until the method is applied to all "
470 "Elements in the Collection, regardless of any errors "
471 "encountered. The key of each ManagedSystemElement to which "
472 "the Setting could not be applied is logged into the "
473 "CanNotApply array. This method takes four input parameters: "
474 "Collection (the Collection of Elements to which the Setting "
475 "is being applied), TimeToApply (which, being a datetime, "
476 "can be either a specific time or a time interval), "
477 "ContinueOnError (TRUE means to continue processing on "
478 "encountering an error), and MustBeCompletedBy (which "
479 "indicates the required completion time for the method). The "
480 "return value should be 0 if the Setting is successfully "
481 "applied to the referenced Collection, 1 if the method is "
482 "not supported, 2 if the Setting was not applied within the "
483 "specified times, 3 if the Setting cannot be applied using "
484 a.dunfey 1.1 "the input value for ContinueOnError, and any other number "
485 "if an error occurred. One output parameter is defined, "
486 "CanNotApplystring, which is an array that lists the keys of "
487 "the ManagedSystemElements to which the Setting was NOT able "
488 "to be applied. This output parameter has meaning only when "
489 "the ContinueOnError parameter is TRUE. \n"
490 "In a subclass, the set of possible return codes could be "
491 "specified, using a ValueMap qualifier on the method. The "
492 "strings to which the ValueMap contents are 'translated' may "
493 "also be specified in the subclass as a Values array "
494 "qualifier. \n"
495 "Note: if an error occurs in applying the Setting to a "
496 "ManagedSystemElement in the Collection, the Element must be "
497 "configured as when the 'Apply' attempt began. That is, the "
498 "Element should NOT be left in an indeterminate state.")]
499 uint32 ApplyToCollection(
500 [IN, Description (
501 "The Collection of Managed SystemElements to be applied.")]
502 CIM_CollectionOfMSEs REF Collection,
503 [IN, Description (
504 "TimeToApply can be either a specific time or a time "
505 a.dunfey 1.1 "interval.")]
506 datetime TimeToApply,
507 [IN, Description (
508 "TRUE means to continue processing on encountering an "
509 "error.")]
510 boolean ContinueOnError,
511 [IN, Description (
512 "The required completion time for the method.")]
513 datetime MustBeCompletedBy,
514 [IN ( false ), OUT, Description (
515 "A string array that lists the keys of the "
516 "ManagedSystemElements to which the Setting was NOT be "
517 "applied.")]
518 string CanNotApply[]);
519
520 [Description (
521 "The VerifyOKToApplyIncrementalChangeToMSE method is used to "
522 "verify that a subset of the properties in this Setting can "
523 "be 'applied' to the referenced Managed SystemElement, at "
524 "the given time or time interval. This method takes four "
525 "input parameters: MSE (the Managed SystemElement that is "
526 a.dunfey 1.1 "being verified), TimeToApply (which, being a datetime, can "
527 "be either a specific time or a time interval), "
528 "MustBeCompletedBy (which indicates the required completion "
529 "time for the method), and a PropertiesToApply array (which "
530 "contains a list of the property names whose values will be "
531 "verified.) If the array is null, empty or contains the "
532 "string \"ALL\" as a property name, then all Settings "
533 "properties shall be verified. If it is set to \"NONE\", "
534 "then no Settings properties will be verified. The return "
535 "value should be 0 if it is OK to apply the Setting, 1 if "
536 "the method is not supported, 2 if the Setting cannot be "
537 "applied within the specified times, and any other number if "
538 "an error occurred. In a subclass, the set of possible "
539 "return codes could be specified, using a ValueMap qualifier "
540 "on the method. The strings to which the ValueMap contents "
541 "are 'translated' may also be specified in the subclass as a "
542 "Values array qualifier.")]
543 uint32 VerifyOKToApplyIncrementalChangeToMSE(
544 [IN, Description (
545 "The ManagedSystem Element for which the Setting is being "
546 "verified.")]
547 a.dunfey 1.1 CIM_ManagedSystemElement REF MSE,
548 [IN, Description (
549 "TimeToApply can be either a specific time or a time "
550 "interval.")]
551 datetime TimeToApply,
552 [IN, Description (
553 "The required completion time for the method.")]
554 datetime MustBeCompletedBy,
555 [IN, Description (
556 "A list of the property names whose values will be "
557 "verified.")]
558 string PropertiesToApply[]);
559
560 [Description (
561 "The ApplyIncrementalChangeToMSE method performs the actual "
562 "application of a subset of the properties in the Setting to "
563 "the referenced ManagedSystemElement. It takes four input "
564 "parameters: MSE (the ManagedSystem Element to which the "
565 "Setting is being applied), TimeToApply (which, being a "
566 "datetime, can be either a specific time or a time "
567 "interval), MustBeCompletedBy (which indicates the required "
568 a.dunfey 1.1 "completion time for the method), and a PropertiesToApply "
569 "array (which contains a list of the property names whose "
570 "values will be applied.) If a property is not in this list, "
571 "it will be ignored by the Apply. If the array is null, "
572 "empty or contains the string \"ALL\" as a property name, "
573 "then all Settings properties shall be applied. If it is set "
574 "to \"NONE\", then no Settings properties will be applied. \n"
575 "Note that the semantics of this method are that individual "
576 "Settings are either wholly applied or not applied at all to "
577 "their target ManagedSystemElement. The return value should "
578 "be 0 if the Setting is successfully applied to the "
579 "referenced ManagedSystemElement, 1 if the method is not "
580 "supported, 2 if the Setting was not applied within the "
581 "specified times, and any other number if an error occurred. "
582 "In a subclass, the set of possible return codes could be "
583 "specified, using a ValueMap qualifier on the method. The "
584 "strings to which the ValueMap contents are 'translated' may "
585 "also be specified in the subclass as a Values array "
586 "qualifier. \n"
587 "Note: If an error occurs in applying the Setting to a "
588 "ManagedSystemElement, the Element must be configured as "
589 a.dunfey 1.1 "when the 'Apply' attempt began. That is, the Element should "
590 "NOT be left in an indeterminate state.")]
591 uint32 ApplyIncrementalChangeToMSE(
592 [IN, Description (
593 "The ManagedSystem Element to which the Setting is being "
594 "applied.")]
595 CIM_ManagedSystemElement REF MSE,
596 [IN, Description (
597 "TimeToApply can be either a specific time or a time "
598 "interval.")]
599 datetime TimeToApply,
600 [IN, Description (
601 "The required completion time for the method.")]
602 datetime MustBeCompletedBy,
603 [IN, Description (
604 "A list of the property names whose values will be "
605 "applied.")]
606 string PropertiesToApply[]);
607
608 [Description (
609 "The VerifyOKToApplyIncrementalChangeToCollection method is "
610 a.dunfey 1.1 "used to verify that a subset of the properties in this "
611 "Setting can be 'applied' to the referenced Collection of "
612 "ManagedSystemElements, at the given time or time interval, "
613 "without causing adverse effects to either the Collection "
614 "itself or its surrounding environment. The net effect is to "
615 "execute the VerifyOKToApplyIncrementalChangeToMSE method "
616 "against each of the Elements aggregated by the Collection. "
617 "This method takes three input parameters: Collection (the "
618 "Collection of Managed SystemElements that is being "
619 "verified), TimeToApply (which, being a datetime, can be "
620 "either a specific time or a time interval), "
621 "MustBeCompletedBy (which indicates the required completion "
622 "time for the method), and a PropertiesToApply array (which "
623 "contains a list of the property names whose values will be "
624 "verified. If they array is null or empty or constains the "
625 "string \"all\" as a property name then all Settings "
626 "properties shall be verified. If it is set to \"none\" then "
627 "no Settings properties will be verified). The return value "
628 "should be 0 if it is OK to apply the Setting, 1 if the "
629 "method is not supported, 2 if the Setting cannot be applied "
630 "within the specified times, and any other number if an "
631 a.dunfey 1.1 "error occurred. One output parameter is defined - "
632 "CanNotApply - which is a string array that lists the keys "
633 "of the ManagedSystemElements to which the Setting can NOT "
634 "be applied. This enables those Elements to be revisited and "
635 "either fixed, or other corrective action taken. \n"
636 "In a subclass, the set of possible return codes could be "
637 "specified, using a ValueMap qualifier on the method. The "
638 "strings to which the ValueMap contents are 'translated' may "
639 "also be specified in the subclass as a Values array "
640 "qualifier.")]
641 uint32 VerifyOKToApplyIncrementalChangeToCollection (
642 [IN, Description (
643 "The Collection of Managed SystemElements for which the "
644 "setting is being verified.")]
645 CIM_CollectionOfMSEs REF Collection,
646 [IN, Description (
647 "TimeToApply can be either a specific time or a time "
648 "interval.")]
649 datetime TimeToApply,
650 [IN, Description (
651 "The required completion time for the method.")]
652 a.dunfey 1.1 datetime MustBeCompletedBy,
653 [IN, Description (
654 "A list of the property names whose values will be "
655 "verified.")]
656 string PropertiesToApply[],
657 [IN ( false ), OUT, Description (
658 "A string array that lists the keys of the "
659 "ManagedSystemElements to which the Setting can NOT be "
660 "applied.")]
661 string CanNotApply[]);
662
663 [Description (
664 "The ApplyIncrementalChangeToCollection method performs the "
665 "application of a subset of the properties in this Setting "
666 "to the referenced Collection of ManagedSystem Elements. The "
667 "net effect is to execute the ApplyIncrementalChangeToMSE "
668 "method against each of the Elements aggregated by the "
669 "Collection. If the input value ContinueOnError is FALSE, "
670 "this method applies the Setting to all Elements in the "
671 "Collection until it encounters an error, in which case it "
672 "stops execution, logs the key of the Element that caused "
673 a.dunfey 1.1 "the error in the CanNotApply array, and issues a return "
674 "code of 2. If the input value ContinueOnError is TRUE, then "
675 "this method applies the Setting to all the "
676 "ManagedSystemElements in the Collection, and reports the "
677 "failed Elements in the array, CanNotApply. For the latter, "
678 "processing will continue until the method is applied to all "
679 "Elements in the Collection, regardless of any errors "
680 "encountered. The key of each ManagedSystemElement to which "
681 "the Setting could not be applied is logged into the "
682 "CanNotApply array. This method takes four input parameters: "
683 "Collection (the Collection of Elements to which the Setting "
684 "is being applied), TimeToApply (which, being a datetime, "
685 "can be either a specific time or a time interval), "
686 "ContinueOnError (TRUE means to continue processing on "
687 "encountering an error), and MustBeCompletedBy (which "
688 "indicates the required completion time for the method), and "
689 "a PropertiesToApply array (which contains a list of the "
690 "property names whose values will be applied.) If a property "
691 "is not in this list, it will be ignored by the Apply. If "
692 "the array is null or empty or contains the string \"ALL\" "
693 "as a property name, then all Settings properties shall be "
694 a.dunfey 1.1 "applied. If it is set to \"NONE\", then no Settings "
695 "properties will be applied. \n"
696 "The return value should be 0 if the Setting is successfully "
697 "applied to the referenced Collection, 1 if the method is "
698 "not supported, 2 if the Setting was not applied within the "
699 "specified time, 3 if the Setting cannot be applied using "
700 "the input value for ContinueOnError, and any other number "
701 "if an error occurred. One output parameter is defined, "
702 "CanNotApplystring, which is an array that lists the keys of "
703 "the ManagedSystemElements to which the Setting was NOT able "
704 "to be applied. This output parameter has meaning only when "
705 "the ContinueOnError parameter is TRUE. \n"
706 "In a subclass, the set of possible return codes could be "
707 "specified, using a ValueMap qualifier on the method. The "
708 "strings to which the ValueMap contents are 'translated' may "
709 "also be specified in the subclass as a Values array "
710 "qualifier. \n"
711 "Note: if an error occurs in applying the Setting to a "
712 "ManagedSystemElement in the Collection, the Element must be "
713 "configured as when the 'Apply' attempt began. That is, the "
714 "Element should NOT be left in an indeterminate state.")]
715 a.dunfey 1.1 uint32 ApplyIncrementalChangeToCollection(
716 [IN, Description (
717 "The Collection of Elements to which the Setting is being "
718 "applied.")]
719 CIM_CollectionOfMSEs REF Collection,
720 [IN, Description (
721 "A specific time or a time interval.")]
722 datetime TimeToApply,
723 [IN, Description (
724 "TRUE means to continue processing on encountering an "
725 "error.")]
726 boolean ContinueOnError,
727 [IN, Description (
728 "This parameter indicates the required completion time "
729 "for the method.")]
730 datetime MustBeCompletedBy,
731 [IN, Description (
732 "A list of the property names whose values will be "
733 "verified.")]
734 string PropertiesToApply[],
735 [IN ( false ), OUT, Description (
736 a.dunfey 1.1 "A string array that lists the keys of the "
737 "ManagedSystemElements to which the Setting can NOT be "
738 "applied.")]
739 string CanNotApply[]);
740 };
741
742
743 // ===================================================================
744 // ElementSetting
745 // ===================================================================
746 [Association, Version ( "2.6.0" ), Description (
747 "ElementSetting represents the association between Managed "
748 "SystemElements and the Setting class(es) defined for them.")]
749 class CIM_ElementSetting {
750
751 [Key, Description (
752 "The ManagedSystemElement.")]
753 CIM_ManagedSystemElement REF Element;
754
755 [Key, Description (
756 "The Setting object associated with the ManagedSystem "
757 a.dunfey 1.1 "Element.")]
758 CIM_Setting REF Setting;
759 };
760
761
762 // ===================================================================
763 // DefaultSetting
764 // ===================================================================
765 [Association, Version ( "2.6.0" ), Description (
766 "DefaultSetting represents the association between a Managed "
767 "SystemElement and the single Setting class that is defined to "
768 "be the default setting for this Element.")]
769 class CIM_DefaultSetting : CIM_ElementSetting {
770
771 [Override ( "Setting" ), Max ( 1 ), Description (
772 "The Setting object which is the default.")]
773 CIM_Setting REF Setting;
774 };
775
776
777 // ==================================================================
778 a.dunfey 1.1 // CIM_SystemSetting
779 // ==================================================================
780 [Abstract, Version ( "2.6.0" ), Description (
781 "CIM_SystemSetting represents the general concept of a "
782 "CIM_Setting which is scoped by/weak to a System.")]
783 class CIM_SystemSetting : CIM_Setting {
784
785 [Key, Propagated ( "CIM_System.CreationClassName" ),
786 Description (
787 "The scoping System's CreationClassName."),
788 MaxLen ( 256 )]
789 string SystemCreationClassName;
790
791 [Key, Propagated ( "CIM_System.Name" ), Description (
792 "The scoping System's Name."),
793 MaxLen ( 256 )]
794 string SystemName;
795
796 [Key, Description (
797 "CreationClassName indicates the name of the class or the "
798 "subclass used in the creation of an instance. When used "
799 a.dunfey 1.1 "with the other key properties of this class, this property "
800 "allows all instances of this class and its subclasses to be "
801 "uniquely identified."),
802 MaxLen ( 256 )]
803 string CreationClassName;
804
805 [Key, Override ( "SettingID" ), MaxLen ( 256 )]
806 string SettingID;
807 };
808
809
810 // ==================================================================
811 // SettingForSystem
812 // ==================================================================
813 [Association, Version ( "2.8.0" ), Description (
814 "CIM_SettingForSystem defines a Setting in the context of the "
815 "System on which it resides.")]
816 class CIM_SettingForSystem : CIM_HostedDependency {
817
818 [Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
819 "The hosting System.")]
820 a.dunfey 1.1 CIM_System REF Antecedent;
821
822 [Override ( "Dependent" ), Weak, Description (
823 "The Setting defined for the System.")]
824 CIM_SystemSetting REF Dependent;
825 };
826
827
828 // ===================================================================
829 // Configuration
830 // ===================================================================
831 [Deprecated { "CIM_SettingData", "CIM_Setting" },
832 Version ( "2.8.1000" ), Description (
833 "The Configuration object allows the grouping of sets of "
834 "parameters (defined in Setting objects) and dependencies for "
835 "one or more ManagedSystemElements. It represents a certain "
836 "behavior, or a desired functional state for the ManagedSystem "
837 "Elements. The use of CIM_Configuration is deprecated in favor "
838 "of aggregating instances of Setting or SettingData into "
839 "'higher' level Settings/SettingData objects, using the "
840 "ConcreteComponent association. This simplifies the use of "
841 a.dunfey 1.1 "Settings/SettingData. With Configurations serving as "
842 "aggregations of Settings (as defined by the Configuration "
843 "Component relationship), separate associations were needed for "
844 "the aggregation and to tie an element to either its "
845 "Configurations or Settings/SettingData. This introduced "
846 "unnecessary complexity and redundancy into the model. \n"
847 "The desired functional state of the Configuration is typically "
848 "driven by external requirements such as time or location. For "
849 "example, to connect to a Mail System from 'home', a dependency "
850 "on a modem exists, but a dependency on a network adapter "
851 "exists at 'work'. Settings for the pertinent LogicalDevices "
852 "(in this example, POTSModem and NetworkAdapter) can be defined "
853 "and aggregated by the Configuration. Therefore, two 'Connect "
854 "to Mail' Configurations may be defined grouping the relevant "
855 "dependencies and Setting objects.")]
856 class CIM_Configuration : CIM_ManagedElement {
857
858 [Deprecated { "CIM_SettingData.InstanceID",
859 "CIM_Setting.SettingID" }, Key, Description (
860 "The label by which the Configuration object is known."),
861 MaxLen ( 256 )]
862 a.dunfey 1.1 string Name;
863 };
864
865
866 // ===================================================================
867 // ConfigurationComponent
868 // ===================================================================
869 [Association, Deprecated { "CIM_ConcreteComponent" }, Aggregation,
870 Version ( "2.8.1000" ), Description (
871 "ConfigurationComponent aggregates 'lower-level' Configuration "
872 "objects into a 'high-level' Configuration. This enables the "
873 "assembly of complex Configurations by grouping together "
874 "simpler ones. For example, a logon policy for the United "
875 "States could consist of two Configuration groups, one for the "
876 "east coast and one for the west coast. Each of these could in "
877 "turn consist of multiple Configurations to handle different "
878 "aspects of the logon process. \n"
879 "\n"
880 "The Configuration class is being deprecated in lieu of using a "
881 "ConcreteComponent relationship to indicate a hierarchy of "
882 "instances of Setting/SettingData.")]
883 a.dunfey 1.1 class CIM_ConfigurationComponent {
884 [Deprecated { "CIM_ConcreteComponent.GroupComponent" }, Key,
885 Aggregate, Description (
886 "The Configuration that aggregates additional "
887 "Configurations.")]
888 CIM_Configuration REF ConfigGroup;
889
890 [Deprecated { "CIM_ConcreteComponent.PartComponent" }, Key,
891 Description (
892 "A Configuration that is part of a 'higher-level' "
893 "Configuration.")]
894 CIM_Configuration REF ConfigComponent;
895 };
896
897
898 // ===================================================================
899 // ElementConfiguration
900 // ===================================================================
901 [Association, Deprecated { "CIM_ElementSettingData",
902 "CIM_ElementSetting" }, Version ( "2.8.1000" ), Description (
903 "This association relates a Configuration object to one or more "
904 a.dunfey 1.1 "ManagedSystemElements. The Configuration object represents a "
905 "certain behavior, or a desired functional state for the "
906 "associated ManagedSystemElements. \n"
907 "\n"
908 "The Configuration class is being deprecated in lieu of using a "
909 "ConcreteComponent relationship to indicate a hierarchy of "
910 "Setting/SettingData instances. This allows the re-use of the "
911 "element to Setting/SettingData associations, instead of "
912 "defining a peer association specifically for Configurations.")]
913 class CIM_ElementConfiguration {
914
915 [Deprecated { "CIM_ElementSettingData.ManagedElement",
916 "CIM_ElementSetting.Element" }, Key, Description (
917 "The ManagedSystemElement.")]
918 CIM_ManagedSystemElement REF Element;
919
920 [Deprecated { "CIM_ElementSettingData.SettingData",
921 "CIM_ElementSetting.Setting" }, Key, Description (
922 "The Configuration object that groups the Settings and "
923 "dependencies associated with the ManagedSystemElement.")]
924 CIM_Configuration REF Configuration;
925 a.dunfey 1.1 };
926
927
928 // ===================================================================
929 // CollectionConfiguration
930 // ===================================================================
931 [Association, Deprecated { "CIM_ElementSettingData",
932 "CIM_CollectionSetting" }, Version ( "2.8.1000" ), Description (
933 "This association relates a Configuration object to one or more "
934 "CollectionOfMSEs objects. The Configuration object represents "
935 "a certain behavior, or a desired functional state for the "
936 "associated Collection. \n"
937 "\n"
938 "The Configuration class is being deprecated in lieu of using a "
939 "ConcreteComponent relationship to indicate a hierarchy of "
940 "instances of Setting/SettingData. This allows the re-use of "
941 "the collection to Setting and element to SettingData "
942 "associations, instead of defining peer associations "
943 "specifically for Configurations.")]
944 class CIM_CollectionConfiguration {
945
946 a.dunfey 1.1 [Deprecated { "CIM_ElementSettingData.ManagedElement",
947 "CIM_CollectionSetting.Collection" }, Key, Description (
948 "The CollectionOfMSEs.")]
949 CIM_CollectionOfMSEs REF Collection;
950
951 [Deprecated { "CIM_ElementSettingData.SettingData",
952 "CIM_CollectionSetting.Setting" }, Key, Description (
953 "The Configuration object that groups the Settings and "
954 "dependencies associated with the Collection.")]
955 CIM_Configuration REF Configuration;
956 };
957
958 // ===================================================================
959 // DependencyContext
960 // ===================================================================
961 [Association, Deprecated { "No value" }, Aggregation,
962 Version ( "2.8.1000" ), Description (
963 "This relationship associates a Dependency with one or more "
964 "Configuration objects. For example, a ComputerSystem's "
965 "dependencies could change based on the site/network to which "
966 "the System is attached. \n"
967 a.dunfey 1.1 "\n"
968 "The Configuration class is being deprecated in lieu of using a "
969 "ConcreteComponent relationship to indicate a hierarchy of "
970 "Setting/SettingData instances. Therefore, this association is "
971 "also deprecated - but is deprecated to 'No value' since there "
972 "are no equivalent relationships currently defined for the "
973 "Setting or SettingData classes. This association is an anomaly "
974 "because it defines what cannot be expressed for the components "
975 "of the Configuration. Also, it singles out the Dependency "
976 "association as opposed to allowing any relationships to be "
977 "defined as 'settings'. Its use in the industry is discouraged.")]
978 class CIM_DependencyContext {
979
980 [Deprecated { "No value" }, Key, Aggregate, Description (
981 "The Configuration object that aggregates the Dependency.")]
982 CIM_Configuration REF Context;
983
984 [Deprecated { "No value" }, Key, Description (
985 "An aggregated Dependency.")]
986 CIM_Dependency REF Dependency;
987 };
988 a.dunfey 1.1
989 // ===================================================================
990 // SettingContext
991 // ===================================================================
992 [Association, Deprecated { "CIM_ConcreteComponent" }, Aggregation,
993 Version ( "2.8.1000" ), Description (
994 "This relationship associates Configuration objects with "
995 "Setting objects. For example, a NetworkAdapter's Settings "
996 "could change based on the site/network to which its hosting "
997 "ComputerSystem is attached. In this case, the ComputerSystem "
998 "would have two different Configuration objects, corresponding "
999 "to the differences in network configuration for the two "
1000 "network segments. Configuration A would aggregate a Setting "
1001 "object for the NetworkAdapter when operating on segment "
1002 "\"ANet\", whereas Configuration B would aggregate a different "
1003 "NetworkAdapter Setting object, specific to segment \"BNet\". "
1004 "Note that many Settings of the computer are independent of the "
1005 "network Configuration. For example, both Configurations A and "
1006 "B would aggregate the same Setting object for the "
1007 "ComputerSystem's MonitorResolution. \n"
1008 "\n"
1009 a.dunfey 1.1 "The Configuration class is being deprecated in lieu of using a "
1010 "ConcreteComponent relationship to indicate a hierarchy of "
1011 "instances of Setting/SettingData. Therefore, the aggregation "
1012 "of Settings into Configurations is replaced by the Concrete "
1013 "Component relationship between instances of Settings and "
1014 "SettingData.")]
1015 class CIM_SettingContext {
1016
1017 [Deprecated { "CIM_ConcreteComponent.GroupComponent" }, Key,
1018 Aggregate, Description (
1019 "The Configuration object that aggregates the Setting.")]
1020 CIM_Configuration REF Context;
1021
1022 [Deprecated { "CIM_ConcreteComponent.PartComponent" }, Key,
1023 Description (
1024 "An aggregated Setting.")]
1025 CIM_Setting REF Setting;
1026 };
1027
1028 // ===================================================================
1029 // CollectionSetting
1030 a.dunfey 1.1 // ===================================================================
1031 [Association, Version ( "2.6.0" ), Description (
1032 "CollectionSetting represents the association between a "
1033 "CollectionOfMSEs class and the Setting class(es) defined for "
1034 "them.")]
1035 class CIM_CollectionSetting {
1036
1037 [Key, Description (
1038 "The CollectionOfMSEs.")]
1039 CIM_CollectionOfMSEs REF Collection;
1040
1041 [Key, Description (
1042 "The Setting object associated with the Collection.")]
1043 CIM_Setting REF Setting;
1044 };
1045
1046
1047 // ==================================================================
1048 // SystemConfiguration
1049 // ==================================================================
1050 [Deprecated { "CIM_ScopedSettingData", "CIM_SystemSetting" },
1051 a.dunfey 1.1 Version ( "2.8.1000" ), Description (
1052 "CIM_SystemConfiguration represents the general concept of a "
1053 "CIM_Configuration which is scoped by/weak to a System. This "
1054 "class is a peer of CIM_Configuration since the key structure "
1055 "of Configuration is currently defined and cannot be modified "
1056 "with additional properties. \n"
1057 "Similar to the deprecation of CIM_Configuration, this peer "
1058 "class is also deprecated in favor of aggregating instances of "
1059 "Setting or SettingData into 'higher' level Settings/ "
1060 "SettingData objects, using the ConcreteComponent association.")]
1061 class CIM_SystemConfiguration : CIM_ManagedElement {
1062
1063 [Deprecated { "CIM_SystemSetting.SystemCreationClassName" }, Key,
1064 Propagated ( "CIM_System.CreationClassName" ), Description (
1065 "The scoping System's CreationClassName."),
1066 MaxLen ( 256 )]
1067 string SystemCreationClassName;
1068
1069 [Deprecated { "CIM_SystemSetting.SystemName" }, Key,
1070 Propagated ( "CIM_System.Name" ), Description (
1071 "The scoping System's Name."),
1072 a.dunfey 1.1 MaxLen ( 256 )]
1073 string SystemName;
1074
1075 [Deprecated { "CIM_SystemSetting.CreationClassName" }, Key,
1076 Description (
1077 "CreationClassName indicates the name of the class or the "
1078 "subclass used in the creation of an instance. When used "
1079 "with the other key properties of this class, this property "
1080 "allows all instances of this class and its subclasses to be "
1081 "uniquely identified."),
1082 MaxLen ( 256 )]
1083 string CreationClassName;
1084
1085 [Deprecated { "CIM_ScopedSettingData.InstanceID",
1086 "CIM_SystemSetting.SettingID" }, Key, Description (
1087 "The label by which the Configuration object is known."),
1088 MaxLen ( 256 )]
1089 string Name;
1090 };
1091
1092 // ==================================================================
1093 a.dunfey 1.1 // ConfigurationForSystem
1094 // ==================================================================
1095 [Association, Deprecated { "CIM_ScopedSetting",
1096 "CIM_SettingForSystem" }, Version ( "2.8.1000" ), Description (
1097 "CIM_ConfigurationForSystem defines a Configuration in the "
1098 "context of the System on which it resides. Since the "
1099 "Configuration class is deprecated, this association is "
1100 "similarly deprecated.")]
1101 class CIM_ConfigurationForSystem : CIM_HostedDependency {
1102
1103 [Deprecated { "CIM_ScopedSetting.Antecedent",
1104 "CIM_SettingForSystem.Antecedent" },
1105 Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
1106 "The hosting System.")]
1107 CIM_System REF Antecedent;
1108
1109 [Deprecated { "CIM_ScopedSetting.Dependent",
1110 "CIM_SettingForSystem.Dependent" }, Override ( "Dependent" ),
1111 Weak, Description (
1112 "The Configuration defined for the System.")]
1113 CIM_SystemConfiguration REF Dependent;
1114 a.dunfey 1.1 };
1115
1116 // ==================================================================
1117 // SystemSettingContext
1118 // ==================================================================
1119 [Association, Deprecated { "CIM_ConcreteComponent" }, Aggregation,
1120 Version ( "2.8.1000" ), Description (
1121 "This relationship associates System-specific Configuration "
1122 "objects with System-specific Setting objects, similar to the "
1123 "SettingContext association. \n"
1124 "\n"
1125 "The Configuration and SystemConfiguration classes are "
1126 "deprecated in lieu of using a ConcreteComponent relationship "
1127 "to indicate a hierarchy of Settings/SettingData instances. "
1128 "Therefore, the aggregation of SystemSettings into System "
1129 "Configurations is replaced by the ConcreteComponent "
1130 "relationship between instances of Settings and SettingData.")]
1131 class CIM_SystemSettingContext {
1132
1133 [Deprecated { "CIM_ConcreteComponent.GroupComponent" }, Key,
1134 Aggregate, Description (
1135 a.dunfey 1.1 "The Configuration object that aggregates the Setting.")]
1136 CIM_SystemConfiguration REF Context;
1137
1138 [Deprecated { "CIM_ConcreteComponent.PartComponent" }, Key,
1139 Description (
1140 "An aggregated Setting.")]
1141 CIM_SystemSetting REF Setting;
1142 };
1143
1144 // ==================================================================
1145 // ConfigurationData
1146 // ==================================================================
1147 [Experimental, Version ( "2.8.1000" ), Description (
1148 "Captures an element's configuration information as an octet "
1149 "string (i.e., a 'blob'). The configuration data is "
1150 "element-specific and generalizes (for any element) the "
1151 "semantically similar 'Save/RestoreProperties' methods "
1152 "currently defined as part of the LogicalDevice class. \n"
1153 "\n"
1154 "Various types of configurations MAY be instantiated for an "
1155 "element - a currently running config, a startup config, and/or "
1156 a.dunfey 1.1 "other 'possible' configurations. The configuration's type is "
1157 "specified in the association of the instance to a "
1158 "ManagedElement, using the properties of the ElementSettingData "
1159 "association: \n"
1160 "- When the configuration is currently running, then the "
1161 "association's IsCurrent boolean is TRUE. \n"
1162 "- When the configuration is the initial/startup config, then "
1163 "the association's IsDefault boolean is TRUE. \n"
1164 "- If the IsCurrent and IsDefault booleans are FALSE, then the "
1165 "configuration is assumed to be a 'possible' config "
1166 "(configuration workspace) for the element. \n"
1167 "\n"
1168 "Note that this class only has an 'apply' method with no "
1169 "corresponding 'extract'. This is because an application/client "
1170 "can query for and enumerate any existing configurations using "
1171 "existing CIM Operations. It is the responsibility of the "
1172 "client to reuse/reapply the configurations that are returned "
1173 "by such a request - since the configuration data itself is "
1174 "opaque and element-specific. \n"
1175 "\n"
1176 "Note that there exists at most one 'running' configuration, at "
1177 a.dunfey 1.1 "any time. And, this may be the only configuration reported by "
1178 "an element. However, elements MAY also have one 'startup' "
1179 "configuration and MAY have multiple 'possible'/workspace "
1180 "configurations. The configurations MAY be identical. For "
1181 "example, if a 'possible' configuration is applied to an "
1182 "element (and therefore made the 'running/current' "
1183 "configuration), then the two configs would be identical upon a "
1184 "subsequent query or enumerate instances request.")]
1185 class CIM_ConfigurationData : CIM_SettingData {
1186
1187 [Required, Description (
1188 "The configuration information stored as an octet string."),
1189 OctetString]
1190 uint8 ConfigurationInformation[];
1191
1192 [Required, Description (
1193 "The datetime when the configuration information was "
1194 "obtained.")]
1195 datetime ConfigurationTimestamp;
1196
1197 [Description (
1198 a.dunfey 1.1 "This method processes the configuration data for an "
1199 "element. In this case, the data in the instance's "
1200 "ConfigurationInformation property is validated for the "
1201 "specified element (if the ValidateOnly parameter is TRUE), "
1202 "or actually set as a configuration on the element. If the "
1203 "method is successful, then the appropriate "
1204 "ElementSettingData associations are created or modified. "
1205 "Note that it is not necessary for the element to be "
1206 "associated with the ConfigurationData instance at the time "
1207 "that this method is called."),
1208 ValueMap { "0", "1", "2", "3", "4", "5", "6..15999", "16000",
1209 "16001", "16002", "16003", "16004", "16005", "16006..32767",
1210 "32768..65535" },
1211 Values { "Success", "Not Supported", "Unknown", "Timeout",
1212 "Failed", "Invalid Parameter", "DMTF Reserved",
1213 "Validate Only Request Not Supported",
1214 "Configuration Data Would Not Validate",
1215 "Element Does Not Support Initial/Default Configs",
1216 "Element Does Not Support Possible Configs/Config "
1217 "Workspaces",
1218 "Element Does Not Support Setting of the Running/Current "
1219 a.dunfey 1.1 "Config", "Element Would Not Accept Configuration",
1220 "Method Reserved", "Vendor Specific" }]
1221 uint32 ApplyConfiguration (
1222
1223 [IN, Description (
1224 "Indicates that the request is to validate the format and "
1225 "syntax of the configuration data, but not apply it to "
1226 "the referenced ManagedElement.")]
1227 boolean ValidateOnly,
1228
1229 [IN, Description (
1230 "The type of configuration information, indicating "
1231 "whether the ConfigurationInformation property holds an "
1232 "initial/default configuration, a running/current "
1233 "configuration, or a configuration for a 'temporary'/ "
1234 "possible workspace. This information affects the values "
1235 "of the IsDefault and IsCurrent properties of the "
1236 "association, ElementSettingData."),
1237 ValueMap { "2", "3", "4" },
1238 Values { "Running/Current Configuration",
1239 "Initial/Default Configuration",
1240 a.dunfey 1.1 "Possible Configuration/Config Workspace" }]
1241 uint16 TypeOfConfiguration,
1242
1243 [Required, IN, Description (
1244 "A reference to the ManagedElement whose configuration "
1245 "data is validated or applied. This reference is "
1246 "necessary since a configuration could apply to multiple "
1247 "elements simultaneously, but this processing request is "
1248 "more restrictive.")]
1249 CIM_ManagedElement REF ManagedElement);
1250 };
1251
1252 // ===================================================================
1253 // CIM_TimeZoneSettingData
1254 // ===================================================================
1255 [Experimental, Version ( "2.8.1000" ), Description (
1256 "The TimeZone class is a set of properties defining a "
1257 "particular time zone. These properties include the concept of "
1258 "daylight saving time. \n"
1259 "If time zone is implemented, then there MUST be a current "
1260 "zone, as indicated using the IsCurrent property of the "
1261 a.dunfey 1.1 "inherited ElementSettingData association. This class allows an "
1262 "application/client to pick the time zone that will be used for "
1263 "any related ManagedElements. The latter are defined by the "
1264 "Element SettingData association, based on the association's "
1265 "IsCurrent/ IsDefault properties. There SHOULD be an instance "
1266 "of TimeZoneSettingData for each zone supported by an element. "
1267 "\n\n"
1268 "If this class is implemented, then TimeService MUST also be "
1269 "implemented and available for a particular ManagedElement. "
1270 "Both together define the date and time. If the "
1271 "ElementSettingData instance associating the ManagedElement has "
1272 "the IsCurrent property set to TRUE, then the TimeData "
1273 "parameter returned by the ManageTime method MUST reflect this "
1274 "zone when time data is requested.")]
1275 class CIM_TimeZoneSettingData : CIM_SettingData {
1276
1277 [Description (
1278 "Full name of the 'standard' time zone (e.g., \"U.S. Eastern "
1279 "Standard Time\"), suitable for presentation to the user in "
1280 "the default locale.")]
1281 string StandardName;
1282 a.dunfey 1.1
1283 [Description (
1284 "Short name of the 'standard' time zone (e.g., \"EST\"), "
1285 "suitable for presentation to the user in the default "
1286 "locale. Note that a specific StandardCaption property is "
1287 "defined, instead of using the inherited Caption. This is "
1288 "done to force consistent property naming for the "
1289 "StandardXXX and DaylightXXX properties.")]
1290 string StandardCaption;
1291
1292 [Description (
1293 "The number of minutes by which this 'standard' time differs "
1294 "from UTC. For example, U.S. EST differs from UTC by -5.0 "
1295 "hours or -300 minutes, whereas Australia Adelaide Standard "
1296 "Time differs by 9.5 hours or 570 minutes."),
1297 Units ( "Minutes" )]
1298 sint32 StandardOffset;
1299
1300 [Description (
1301 "The month in which daylight saving time ends (and "
1302 "'standard' time begins). Specify 0 for January, 1 for "
1303 a.dunfey 1.1 "February, and so on."),
1304 ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
1305 "10", "11" },
1306 Values { "January", "February", "March", "April", "May", "June",
1307 "July", "August", "September", "October", "November",
1308 "December" }]
1309 uint8 StandardMonth;
1310
1311 [Description (
1312 "There are two different interpretations for this property, "
1313 "depending on the value of StandardDayOfWeek. In one case, "
1314 "StandardDay defines the day-in-month on which daylight "
1315 "saving time ends. This interpretation is used when the "
1316 "StandardDayOfWeek is 0. A positive or negative integer is "
1317 "specified to indicate whether the StandardDay is calculated "
1318 "from the beginning or the end of the month. For example, 5 "
1319 "indicates the fifth day in the StandardMonth and -1 "
1320 "indicates the last day in the StandardMonth. \n"
1321 "\n"
1322 "When StandardDayOfWeek is not 0, StandardDay is the day- "
1323 "in-month on which daylight saving time ends, defined in "
1324 a.dunfey 1.1 "conjunction with StandardDayOfWeek. For example, if "
1325 "StandardDay is 15 and StandardDayOfWeek is Saturday, then "
1326 "daylight saving time ends on the first Saturday on or after "
1327 "the 15th day in the StandardMonth (i.e., the third Saturday "
1328 "in the month). If StandardDay is 20 and StandardDayOfWeek "
1329 "is -Saturday, then this indicates the first Saturday on or "
1330 "before the 20th day in the StandardMonth. If StandardDay is "
1331 "-1 and StandardDayOfWeek is -Sunday, then this indicates "
1332 "the last Sunday in the StandardMonth."),
1333 MinValue ( -31 ), MaxValue ( 31 )]
1334 sint8 StandardDay;
1335
1336 [Description (
1337 "Positive or negative integer used in conjunction with "
1338 "StandardDay to indicate the day of the week on which "
1339 "daylight saving time ends (and 'standard' time begins). "
1340 "StandardDayOfWeek is set to 0 to indicate an exact day of "
1341 "the month, such as March 1. A positive integer "
1342 "(representing Sunday, Monday, ..., Saturday) means that the "
1343 "day of week is found on or after the specified StandardDay. "
1344 "A negative integer (representing -Sunday, -Monday, ..., "
1345 a.dunfey 1.1 "-Saturday) means that the day of week is found on or before "
1346 "the StandardDay."),
1347 ValueMap { "-7", "-6", "-5", "-4", "-3", "-2", "-1", "0", "1",
1348 "2", "3", "4", "5", "6", "7" },
1349 Values { "-Saturday", "-Friday", "-Thursday", "-Wednesday",
1350 "-Tuesday", "-Monday", "-Sunday", "ExactDayOfMonth",
1351 "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday",
1352 "Friday", "Saturday" }]
1353 sint8 StandardDayOfWeek;
1354
1355 [Description (
1356 "The time interval after midnight when daylight saving time "
1357 "ends. For example, \n"
1358 "00000000020000.000000:000 \n"
1359 "indicates that daylight saving time ends at two o'clock, "
1360 "local time (usually, daylight saving time).")]
1361 datetime StandardStartInterval;
1362
1363 [Description (
1364 "Full name of the 'daylight' time zone (e.g., \"U.S. Eastern "
1365 "Daylight Saving Time\"), suitable for presentation to the "
1366 a.dunfey 1.1 "user in the default locale.")]
1367 string DaylightName;
1368
1369 [Description (
1370 "Short name of the 'daylight' time zone (e.g., \"EDT\"), "
1371 "suitable for presentation to the user in the default "
1372 "locale. Note that a specific DaylightCaption property is "
1373 "defined, instead of using the inherited Caption. This is "
1374 "done to force consistent property naming for the "
1375 "StandardXXX and DaylightXXX properties.")]
1376 string DaylightCaption;
1377
1378 [Description (
1379 "The number of minutes by which this daylight saving time "
1380 "differs from UTC. For example, U.S. EDT differs from UTC by "
1381 "-4.0 hours or -240 minutes, whereas Australia Adelaide "
1382 "Daylight Time differs by 10.5 hours or 630 minutes."),
1383 Units ( "Minutes" )]
1384 sint32 DaylightOffset;
1385
1386 [Description (
1387 a.dunfey 1.1 "The month in which daylight saving time starts. Specify 0 "
1388 "for January, 1 for February, and so on."),
1389 ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
1390 "10", "11" },
1391 Values { "January", "February", "March", "April", "May", "June",
1392 "July", "August", "September", "October", "November",
1393 "December" }]
1394 uint8 DaylightMonth;
1395
1396 [Description (
1397 "There are two different interpretations for this property, "
1398 "depending on the value of DaylightDayOfWeek. In one case, "
1399 "DaylightDay defines the day-in-month on which daylight "
1400 "saving time starts. This interpretation is used when the "
1401 "DaylightDayOfWeek is 0. A positive or negative integer is "
1402 "specified to indicate whether the DaylightDay is calculated "
1403 "from the beginning or the end of the month. For example, 5 "
1404 "indicates the fifth day in the DaylightMonth and -1 "
1405 "indicates the last day in the DaylightMonth. \n"
1406 "\n"
1407 "When DaylightDayOfWeek is not 0, DaylightDay is the day- "
1408 a.dunfey 1.1 "in-month on which daylight saving time starts, defined in "
1409 "conjunction with DaylightDayOfWeek. For example, if "
1410 "DaylightDay is 15 and DaylightDayOfWeek is Saturday, then "
1411 "daylight saving time starts on the first Saturday on or "
1412 "after the 15th day in the DaylightMonth (i.e., the third "
1413 "Saturday in the month). If DaylightDay is 20 and "
1414 "DaylightDayOfWeek is -Saturday, then this indicates the "
1415 "first Saturday on or before the 20th day in the "
1416 "DaylightMonth. If DaylightDay is -1 and DaylightDayOfWeek "
1417 "is -Sunday, then this indicates the last Sunday in the "
1418 "month."),
1419 MinValue ( -31 ), MaxValue ( 31 )]
1420 sint8 DaylightDay;
1421
1422 [Description (
1423 "Positive or negative integer used in conjunction with "
1424 "DaylightDay to indicate the day of the week on which "
1425 "daylight saving time starts. Set DaylightDayOfWeek to 0 to "
1426 "indicate an exact day of month, such as March 1. Positive "
1427 "integer (Sunday, Monday, ..., Saturday) means that the day "
1428 "of week is found on or after DaylightDay. Negative integer "
1429 a.dunfey 1.1 "(-Sunday, -Monday, ..., -Saturday) means that the day of "
1430 "week is found on or before DaylightDay."),
1431 ValueMap { "-7", "-6", "-5", "-4", "-3", "-2", "-1", "0", "1",
1432 "2", "3", "4", "5", "6", "7" },
1433 Values { "-Saturday", "-Friday", "-Thursday", "-Wednesday",
1434 "-Tuesday", "-Monday", "-Sunday", "ExactDayOfMonth",
1435 "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday",
1436 "Friday", "Saturday" }]
1437 sint8 DaylightDayOfWeek;
1438
1439 [Description (
1440 "The time interval after midnight when daylight saving time "
1441 "starts. For example, \n"
1442 "00000000020000.000000:000 \n"
1443 "indicates that daylight saving time starts at two o'clock, "
1444 "local time (usually, standard time).")]
1445 datetime DaylightStartInterval;
1446
1447 };
1448
1449 // ===================================================================
1450 a.dunfey 1.1 // end of file
1451 // ===================================================================
|
Return to
Core_Settings.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIMPrelim291