1 marek 1.1 // Copyright (c) 2005 DMTF. All rights reserved.
2 // <change cr="DMTFCR01378.002" type ="change">Update of description to
3 // support deprecation of CIM_Profile and
4 // CIM_Configuration.</change>
5 // <change cr="SysDevCR00728.000" type ="change">Update of
6 // descriptions based on Tech Edit review.</
7 // <change cr="ArchCR00066.004" type="add">Add UmlPackagePath
8 // qualifier values to CIM Schema.</change>
9 // ==================================================================
10 // CIM_Setting
11 // ==================================================================
12 [Abstract, Version ( "2.8.1000" ),
13 UMLPackagePath ( "CIM::Core::Settings" ),
14 Description (
15 "The Setting class represents configuration-related and "
16 "operational parameters for one or more ManagedSystemElements. "
17 "An Element can have multiple Setting objects associated with "
18 "it. The current operational values for the parameters of an "
19 "Element are reflected by properties in the Element itself or "
20 "by properties in its associations. These properties do not "
21 "have to be the same values present in the Setting object. For "
22 marek 1.1 "example, a modem might have a Setting baud rate of 56Kb/sec "
23 "but be operating at 19.2Kb/sec. \n"
24 "Note: The CIM_SettingData class is very similar to "
25 "CIM_Setting, yet both classes are present in the model because "
26 "many implementations have successfully used CIM_Setting. "
27 "However, issues have arisen that could not be resolved without "
28 "defining a new class. Therefore, until a new major release "
29 "occurs, both classes will exist in the model. Refer to the "
30 "Core White Paper for additional information. Setting instances "
31 "can be aggregated together into higher-level Setting objects "
32 "using ConcreteComponent associations." )]
33 class CIM_Setting : CIM_ManagedElement {
34
35 [Description (
36 "The identifier by which the Setting object is known." ),
37 MaxLen ( 256 )]
38 string SettingID;
39
40
41 [Description (
42 "The VerifyOKToApplyToMSE method is used to verify that "
43 marek 1.1 "this Setting can be applied to the referenced "
44 "ManagedSystemElement at the given time or time interval. "
45 "This method takes three input parameters: MSE (the "
46 "Managed SystemElement that is being verified), "
47 "TimeToApply (which, being a datetime, can be either a "
48 "specific time or a time interval), and MustBeCompletedBy "
49 "(which indicates the required completion time for the "
50 "method). The return value should be 0 if it is okay to "
51 "apply the Setting, 1 if the method is not supported, 2 "
52 "if the Setting cannot be applied within the specified "
53 "times, and any other number if an error occurred. In a "
54 "subclass, the set of possible return codes could be "
55 "specified using a ValueMap qualifier on the method. The "
56 "strings to which the ValueMap contents are \"translated\" "
57 "can also be specified in the subclass as a Values array "
58 "qualifier." )]
59 uint32 VerifyOKToApplyToMSE(
60 [IN, Description (
61 "The ManagedSystemElement that is being verified." )]
62 CIM_ManagedSystemElement REF MSE,
63 [IN, Description (
64 marek 1.1 "TimeToApply can be either a specific time or a time interval."
65 )]
66 datetime TimeToApply,
67 [IN, Description (
68 "The required completion time for the method." )]
69 datetime MustBeCompletedBy);
70
71 [Description (
72 "The ApplyToMSE method performs the actual application of "
73 "the Setting to the referenced ManagedSystemElement. It "
74 "takes three input parameters: MSE (the "
75 "ManagedSystemElement to which the Setting is being "
76 "applied), TimeToApply (which, being a datetime, can be "
77 "either a specific time or a time interval), and "
78 "MustBeCompletedBy (which indicates the required "
79 "completion time for the method). Note that the semantics "
80 "of this method are that individual Settings are either "
81 "wholly applied or not applied at all to their target "
82 "ManagedSystemElement. The return value should be 0 if "
83 "the Setting is successfully applied to the referenced "
84 "ManagedSystemElement, 1 if the method is not supported, "
85 marek 1.1 "2 if the Setting was not applied within the specified "
86 "times, and any other number if an error occurred. In a "
87 "subclass, the set of possible return codes could be "
88 "specified, using a ValueMap qualifier on the method. The "
89 "strings to which the ValueMap contents are \"translated\" "
90 "can also be specified in the subclass as a Values array "
91 "qualifier. \n"
92 "Note: If an error occurs when applying the Setting to a "
93 "ManagedSystemElement, the Element must be configured as "
94 "it was when the \"Apply\" attempt began. That is, the "
95 "Element should not be left in an indeterminate state." )]
96 uint32 ApplyToMSE(
97 [IN, Description (
98 "The ManagedSystemElement to which the Setting is being applied."
99 )]
100 CIM_ManagedSystemElement REF MSE,
101 [IN, Description (
102 "TimeToApply can be either a specific time or a time interval."
103 )]
104 datetime TimeToApply,
105 [IN, Description (
106 marek 1.1 "The required completion time for the method." )]
107 datetime MustBeCompletedBy);
108
109 [Description (
110 "The VerifyOKToApplyToCollection method is used to verify "
111 "that this Setting can be applied to the referenced "
112 "Collection of ManagedSystemElements, at the given time "
113 "or time interval, without causing adverse effects to "
114 "either the Collection itself or its surrounding "
115 "environment. The net effect is to execute the "
116 "VerifyOKToApply method against each of the Elements that "
117 "are aggregated by the Collection. This method takes "
118 "three input parameters: Collection (the Collection of "
119 "ManagedSystemElements that is being verified), "
120 "TimeToApply (which, being a datetime, can be either a "
121 "specific time or a time interval), and MustBeCompletedBy "
122 "(which indicates the required completion time for the "
123 "method). The return value should be 0 if it is okay to "
124 "apply the Setting, 1 if the method is not supported, 2 "
125 "if the Setting cannot be applied within the specified "
126 "times, and any other number if an error occurred. One "
127 marek 1.1 "output parameter, CanNotApply, is defined, which is a "
128 "string array that lists the keys of the "
129 "ManagedSystemElements to which the Setting cannot be "
130 "applied. This parameter enables those Elements to be "
131 "revisited and either fixed or have other corrective "
132 "action taken on them. \n"
133 "In a subclass, the set of possible return codes could be "
134 "specified, using a ValueMap qualifier on the method. The "
135 "strings to which the ValueMap contents are \"translated\" "
136 "can also be specified in the subclass as a Values array "
137 "qualifier." )]
138 uint32 VerifyOKToApplyToCollection(
139 [IN, Description (
140 "The Collection of ManagedSystemElements that is being verified."
141 )]
142 CIM_CollectionOfMSEs REF Collection,
143 [IN, Description (
144 "TimeToApply can be either a specific time or a time interval."
145 )]
146 datetime TimeToApply,
147 [IN, Description (
148 marek 1.1 "The required completion time for the method." )]
149 datetime MustBeCompletedBy,
150 [IN ( false ), OUT, Description (
151 "A string array that lists the keys of the "
152 "ManagedSystemElements to which the Setting cannot "
153 "be applied." )]
154 string CanNotApply[]);
155
156 [Description (
157 "The ApplyToCollection method performs the application of "
158 "the Setting to the referenced Collection of "
159 "ManagedSystemElements. The net effect is to execute the "
160 "ApplyToMSE method against each of the Elements that are "
161 "aggregated by the Collection. If the input value "
162 "ContinueOnError is false, this method applies the "
163 "Setting to all Elements in the Collection until it "
164 "encounters an error. In the case of an error, the method "
165 "stops execution, logs the key of the Element that caused "
166 "the error in the CanNotApply array, and issues a return "
167 "code of 2. If the input value ContinueOnError is true, "
168 "then this method applies the Setting to all of the "
169 marek 1.1 "ManagedSystemElements in the Collection, and reports the "
170 "failed Elements in the array, CanNotApply. For the "
171 "latter, processing will continue until the method is "
172 "applied to all Elements in the Collection, regardless of "
173 "any errors encountered. The key of each "
174 "ManagedSystemElement to which the Setting could not be "
175 "applied is logged into the CanNotApply array. This "
176 "method takes four input parameters: Collection (the "
177 "Collection of Elements to which the Setting is being "
178 "applied), TimeToApply (which, being a datetime, can be "
179 "either a specific time or a time interval), "
180 "ContinueOnError (true indicates to continue processing "
181 "when an error is encountered), and MustBeCompletedBy "
182 "(which indicates the required completion time for the "
183 "method). The return value should be 0 if the Setting is "
184 "successfully applied to the referenced Collection, 1 if "
185 "the method is not supported, 2 if the Setting was not "
186 "applied within the specified times, 3 if the Setting "
187 "cannot be applied using the input value for "
188 "ContinueOnError, and any other number if an error "
189 "occurred. One output parameter, CanNotApplystring, is "
190 marek 1.1 "defined, which is an array that lists the keys of the "
191 "ManagedSystemElements to which the Setting could not be "
192 "applied. This output parameter has meaning only when the "
193 "ContinueOnError parameter is true. \n"
194 "In a subclass, the set of possible return codes could be "
195 "specified using a ValueMap qualifier on the method. The "
196 "strings to which the ValueMap contents are \"translated\" "
197 "can also be specified in the subclass as a Values array "
198 "qualifier. \n"
199 "Note: If an error occurs when applying the Setting to a "
200 "ManagedSystemElement in the Collection, the Element must "
201 "be configured as it was when the \"Apply\" attempt "
202 "began. That is, the Element should not be left in an "
203 "indeterminate state." )]
204 uint32 ApplyToCollection(
205 [IN, Description (
206 "The Collection of ManagedSystemElements to be applied."
207 )]
208 CIM_CollectionOfMSEs REF Collection,
209 [IN, Description (
210 "TimeToApply can be either a specific time or a time interval."
211 marek 1.1 )]
212 datetime TimeToApply,
213 [IN, Description (
214 "True means to continue processing when an error is encountered."
215 )]
216 boolean ContinueOnError,
217 [IN, Description (
218 "The required completion time for the method." )]
219 datetime MustBeCompletedBy,
220 [IN ( false ), OUT, Description (
221 "A string array that lists the keys of the "
222 "ManagedSystemElements to which the Setting could "
223 "not be applied." )]
224 string CanNotApply[]);
225
226 [Description (
227 "The VerifyOKToApplyIncrementalChangeToMSE method is used "
228 "to verify that a subset of the properties in this "
229 "Setting can be applied to the referenced "
230 "ManagedSystemElement at the given time or time interval. "
231 "This method takes four input parameters: MSE (the "
232 marek 1.1 "ManagedSystemElement that is being verified), "
233 "TimeToApply (which, being a datetime, can be either a "
234 "specific time or a time interval), MustBeCompletedBy "
235 "(which indicates the required completion time for the "
236 "method), and a PropertiesToApply array (which contains a "
237 "list of the property names whose values will be "
238 "verified). If the array is null or empty or contains the "
239 "string \"ALL\" as a property name, then all Settings "
240 "properties will be verified. If it is set to \"NONE\", "
241 "then no Settings properties will be verified. The return "
242 "value should be 0 if it is okay to apply the Setting, 1 "
243 "if the method is not supported, 2 if the Setting cannot "
244 "be applied within the specified times, and any other "
245 "number if an error occurred. In a subclass, the set of "
246 "possible return codes could be specified using a "
247 "ValueMap qualifier on the method. The strings to which "
248 "the ValueMap contents are \"translated\" can also be "
249 "specified in the subclass as a Values array qualifier." )]
250 uint32 VerifyOKToApplyIncrementalChangeToMSE(
251 [IN, Description (
252 "The ManagedSystemElement for which the Setting is "
253 marek 1.1 "being verified." )]
254 CIM_ManagedSystemElement REF MSE,
255 [IN, Description (
256 "TimeToApply can be either a specific time or a time interval."
257 )]
258 datetime TimeToApply,
259 [IN, Description (
260 "The required completion time for the method." )]
261 datetime MustBeCompletedBy,
262 [IN, Description (
263 "A list of the property names whose values will be verified."
264 )]
265 string PropertiesToApply[]);
266
267 [Description (
268 "The ApplyIncrementalChangeToMSE method performs the "
269 "actual application of a subset of the properties in the "
270 "Setting to the referenced ManagedSystemElement. It takes "
271 "four input parameters: MSE (the ManagedSystem Element to "
272 "which the Setting is being applied), TimeToApply (which, "
273 "being a datetime, can be either a specific time or a "
274 marek 1.1 "time interval), MustBeCompletedBy (which indicates the "
275 "required completion time for the method), and a "
276 "PropertiesToApply array (which contains a list of the "
277 "property names whose values will be applied). If a "
278 "property is not in this list, it will be ignored by the "
279 "Apply. If the array is null, empty, or contains the "
280 "string \"ALL\" as a property name, then all Settings "
281 "properties will be applied. If it is set to \"NONE\", "
282 "then no Settings properties will be applied. \n"
283 "Note that the semantics of this method are that "
284 "individual Settings are either wholly applied or not "
285 "applied at all to their target ManagedSystemElement. The "
286 "return value should be 0 if the Setting is successfully "
287 "applied to the referenced ManagedSystemElement, 1 if the "
288 "method is not supported, 2 if the Setting was not "
289 "applied within the specified times, and any other number "
290 "if an error occurred. In a subclass, the set of possible "
291 "return codes could be specified using a ValueMap "
292 "qualifier on the method. The strings to which the "
293 "ValueMap contents are \"translated\" can also be "
294 "specified in the subclass as a Values array qualifier. \n"
295 marek 1.1 "Note: If an error occurs when applying the Setting to a "
296 "ManagedSystemElement, the Element must be configured as "
297 "it was when the \"Apply\" attempt began. That is, the "
298 "Element should not be left in an indeterminate state." )]
299 uint32 ApplyIncrementalChangeToMSE(
300 [IN, Description (
301 "The ManagedSystemElement to which the Setting is being applied."
302 )]
303 CIM_ManagedSystemElement REF MSE,
304 [IN, Description (
305 "TimeToApply can be either a specific time or a time interval."
306 )]
307 datetime TimeToApply,
308 [IN, Description (
309 "The required completion time for the method." )]
310 datetime MustBeCompletedBy,
311 [IN, Description (
312 "A list of the property names whose values will be applied."
313 )]
314 string PropertiesToApply[]);
315
316 marek 1.1 [Description (
317 "The VerifyOKToApplyIncrementalChangeToCollection method "
318 "is used to verify that a subset of the properties in "
319 "this Setting can be applied to the referenced Collection "
320 "of ManagedSystemElements at the given time or time "
321 "interval, without causing adverse effects to either the "
322 "Collection itself or its surrounding environment. The "
323 "net effect is to execute the "
324 "VerifyOKToApplyIncrementalChangeToMSE method against "
325 "each of the Elements that are aggregated by the "
326 "Collection. This method takes four input parameters: "
327 "Collection (the Collection of ManagedSystemElements that "
328 "is being verified), TimeToApply (which, being a "
329 "datetime, can be either a specific time or a time "
330 "interval), MustBeCompletedBy (which indicates the "
331 "required completion time for the method), and a "
332 "PropertiesToApply array (which contains a list of the "
333 "property names whose values will be verified). If the "
334 "array is null or empty or contains the string \"all\" as "
335 "a property name, all Settings properties will be "
336 "verified. If it is set to \"none\" then no Settings "
337 marek 1.1 "properties will be verified. The return value should be "
338 "0 if it is okay to apply the Setting, 1 if the method is "
339 "not supported, 2 if the Setting cannot be applied within "
340 "the specified times, and any other number if an error "
341 "occurred. One output parameter, CanNotApply, is defined, "
342 "which is a string array that lists the keys of the "
343 "ManagedSystemElements to which the Setting cannot be "
344 "applied. This parameter enables those Elements to be "
345 "revisited and either fixed or have other corrective "
346 "action taken on them. \n"
347 "In a subclass, the set of possible return codes could be "
348 "specified using a ValueMap qualifier on the method. The "
349 "strings to which the ValueMap contents are \"translated\" "
350 "can also be specified in the subclass as a Values array "
351 "qualifier." )]
352 uint32 VerifyOKToApplyIncrementalChangeToCollection(
353 [IN, Description (
354 "The Collection of ManagedSystemElements for which "
355 "the setting is being verified." )]
356 CIM_CollectionOfMSEs REF Collection,
357 [IN, Description (
358 marek 1.1 "TimeToApply can be either a specific time or a time interval."
359 )]
360 datetime TimeToApply,
361 [IN, Description (
362 "The required completion time for the method." )]
363 datetime MustBeCompletedBy,
364 [IN, Description (
365 "A list of the property names whose values will be verified."
366 )]
367 string PropertiesToApply[],
368 [IN ( false ), OUT, Description (
369 "A string array that lists the keys of the "
370 "ManagedSystemElements to which the Setting cannot "
371 "be applied." )]
372 string CanNotApply[]);
373
374 [Description (
375 "The ApplyIncrementalChangeToCollection method performs "
376 "the application of a subset of the properties in this "
377 "Setting to the referenced Collection of "
378 "ManagedSystemElements. The net effect is to execute the "
379 marek 1.1 "ApplyIncrementalChangeToMSE method against each of the "
380 "Elements that are aggregated by the Collection. If the "
381 "input value ContinueOnError is false, this method "
382 "applies the Setting to all Elements in the Collection "
383 "until it encounters an error, in which case it stops "
384 "execution, logs the key of the Element that caused the "
385 "error in the CanNotApply array, and issues a return code "
386 "of 2. If the input value ContinueOnError is true, then "
387 "this method applies the Setting to all of the "
388 "ManagedSystemElements in the Collection, and reports the "
389 "failed Elements in the array, CanNotApply. For the "
390 "latter, processing will continue until the method is "
391 "applied to all Elements in the Collection, regardless of "
392 "any errors encountered. The key of each "
393 "ManagedSystemElement to which the Setting could not be "
394 "applied is logged into the CanNotApply array. This "
395 "method takes four input parameters: Collection (the "
396 "Collection of Elements to which the Setting is being "
397 "applied), TimeToApply (which, being a datetime, can be "
398 "either a specific time or a time interval), "
399 "ContinueOnError (true indicates to continue processing "
400 marek 1.1 "when an error is encountered), MustBeCompletedBy (which "
401 "indicates the required completion time for the method), "
402 "and a PropertiesToApply array (which contains a list of "
403 "the property names whose values will be applied). If a "
404 "property is not in this list, it will be ignored by the "
405 "Apply. If the array is null or empty or contains the "
406 "string \"ALL\" as a property name, then all Settings "
407 "properties will be applied. If it is set to \"NONE\", "
408 "then no Settings properties will be applied. \n"
409 "The return value should be 0 if the Setting is "
410 "successfully applied to the referenced Collection, 1 if "
411 "the method is not supported, 2 if the Setting was not "
412 "applied within the specified time, 3 if the Setting "
413 "cannot be applied using the input value for "
414 "ContinueOnError, and any other number if an error "
415 "occurred. One output parameter, CanNotApplystring, is "
416 "defined, which is an array that lists the keys of the "
417 "ManagedSystemElements to which the Setting could not be "
418 "applied. This output parameter has meaning only when the "
419 "ContinueOnError parameter is true. \n"
420 "In a subclass, the set of possible return codes could be "
421 marek 1.1 "specified using a ValueMap qualifier on the method. The "
422 "strings to which the ValueMap contents are \"translated\" "
423 "can also be specified in the subclass as a Values array "
424 "qualifier. \n"
425 "Note: If an error occurs when applying the Setting to a "
426 "ManagedSystemElement in the Collection, the Element must "
427 "be configured as it was when the \"Apply\" attempt "
428 "began. That is, the Element should not be left in an "
429 "indeterminate state." )]
430 uint32 ApplyIncrementalChangeToCollection(
431 [IN, Description (
432 "The Collection of Elements to which the Setting is "
433 "being applied." )]
434 CIM_CollectionOfMSEs REF Collection,
435 [IN, Description ( "A specific time or a time interval." )]
436 datetime TimeToApply,
437 [IN, Description (
438 "True indicates to continue processing when an "
439 "error is encountered." )]
440 boolean ContinueOnError,
441 [IN, Description (
442 marek 1.1 "This parameter indicates the required completion "
443 "time for the method." )]
444 datetime MustBeCompletedBy,
445 [IN, Description (
446 "A list of the property names whose values will be verified."
447 )]
448 string PropertiesToApply[],
449 [IN ( false ), OUT, Description (
450 "A string array that lists the keys of the "
451 "ManagedSystemElements to which the Setting cannot "
452 "be applied." )]
453 string CanNotApply[]);
454
455 };
|
Return to
CIM_Setting.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIM231 / DMTF / Core