1 marek 1.1 // Copyright (c) 2005 DMTF. All rights reserved.
2 [Version ( "2.11.0" ),
3 UMLPackagePath ( "CIM::Device::StorageServices" ),
4 Description (
5 "This service allows the active management of a Storage Server. "
6 "It allows jobs to be started for the creation, modification "
7 "and deletion of storage objects (StoragePools, StorageVolumes "
8 "and LogicalDisks)." )]
9 class CIM_StorageConfigurationService : CIM_Service {
10
11
12 [Description (
13 "Starts a job to create (or modify) a StoragePool. The "
14 "StoragePool will be (or must be) scoped to the same "
15 "System as this Service. One of the parameters for this "
16 "method is Size. As an input parameter, Size specifies "
17 "the desired size of the pool. As an output parameter, it "
18 "specifies the size achieved. Space is taken from either "
19 "or both of the specified input StoragePools and "
20 "StorageExtents (InPools and InExtents). The capability "
21 "requirements that the Pool must support are defined "
22 marek 1.1 "using the Goal parameter. If the requested pool size "
23 "cannot be created, no action will be taken, the Return "
24 "Value will be 4097/0x1001, and the output value of Size "
25 "will be set to the nearest possible size. If 0 is "
26 "returned, then the task completed successfully and the "
27 "use of ConcreteJob was not required. If the task will "
28 "take some time to complete, a ConcreteJob will be "
29 "created and its reference returned in the output "
30 "parameter Job." ),
31 ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096",
32 "4097", "4098..32767", "32768..65535" },
33 Values { "Job Completed with No Error", "Not Supported",
34 "Unknown", "Timeout", "Failed", "Invalid Parameter",
35 "In Use", "DMTF Reserved",
36 "Method Parameters Checked - Job Started",
37 "Size Not Supported", "Method Reserved", "Vendor Specific" }]
38 uint32 CreateOrModifyStoragePool(
39 [IN, Description (
40 "A end user relevant name for the pool being "
41 "created. If NULL, then a system supplied default "
42 "name can be used. The value will be stored in the "
43 marek 1.1 "\'ElementName\' property for the created pool. If "
44 "not NULL, this parameter will supply a new name "
45 "when modifying an existing pool." )]
46 string ElementName,
47 [IN ( false ), OUT, Description (
48 "Reference to the job (may be null if job completed)."
49 )]
50 CIM_ConcreteJob REF Job,
51 [IN, Description (
52 "Reference to an instance of StorageSetting that "
53 "defines the desired capabilities of the "
54 "StoragePool. If set to a null value, the default "
55 "configuration from the source pool will be used. "
56 "If not NULL, this parameter will supply a new Goal "
57 "setting when modifying an existing pool." )]
58 CIM_StorageSetting REF Goal,
59 [IN, OUT, Description (
60 "As an input parameter this specifies the desired "
61 "pool size in bytes. As an output parameter this "
62 "specifies the size achieved." ),
63 Units ( "Bytes" )]
64 marek 1.1 uint64 Size,
65 [IN, Description (
66 "Array of strings containing representations of "
67 "references to CIM_StoragePool instances, that are "
68 "used to create the Pool or modify the source "
69 "pools." )]
70 string InPools[],
71 [IN, Description (
72 "Array of strings containing representations of "
73 "references to CIM_StorageExtent instances, that "
74 "are used to create the Pool or modify the source "
75 "extents." )]
76 string InExtents[],
77 [IN, OUT, Description (
78 "As an input parameter: if null, creates a new "
79 "StoragePool. If not null, modifies the referenced "
80 "Pool. When returned, it is a reference to the "
81 "resulting StoragePool." )]
82 CIM_StoragePool REF Pool);
83
84 [Description (
85 marek 1.1 "Start a job to create (or modify) a specified element "
86 "(for example a StorageVolume or StorageExtent) from a "
87 "StoragePool. One of the parameters for this method is "
88 "Size. As an input parameter, Size specifies the desired "
89 "size of the element. As an output parameter, it "
90 "specifies the size achieved. Space is taken from the "
91 "input StoragePool. The desired settings for the element "
92 "are specified by the Goal parameter. If the requested "
93 "size cannot be created, no action will be taken, and the "
94 "Return Value will be 4097/0x1001. Also, the output value "
95 "of Size is set to the nearest possible size. If 0 is "
96 "returned, the function completed successfully and no "
97 "ConcreteJob instance was required. If 4096/0x1000 is "
98 "returned, a ConcreteJob will be started to create the "
99 "element. The Job\'s reference will be returned in the "
100 "output parameter Job." ),
101 ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096",
102 "4097", "4098..32767", "32768..65535" },
103 Values { "Job Completed with No Error", "Not Supported",
104 "Unknown", "Timeout", "Failed", "Invalid Parameter",
105 "In Use", "DMTF Reserved",
106 marek 1.1 "Method Parameters Checked - Job Started",
107 "Size Not Supported", "Method Reserved", "Vendor Specific" }]
108 uint32 CreateOrModifyElementFromStoragePool(
109 [IN, Description (
110 "A end user relevant name for the element being "
111 "created. If NULL, then a system supplied default "
112 "name can be used. The value will be stored in the "
113 "\'ElementName\' property for the created element. "
114 "If not NULL, this parameter will supply a new name "
115 "when modifying an existing element." )]
116 string ElementName,
117 [IN, Description (
118 "Enumeration indicating the type of element being "
119 "created or modified. If the input parameter "
120 "TheElement is specified when the operation is a "
121 "\'modify\', this type value must match the type of "
122 "that instance." ),
123 ValueMap { "0", "1", "2", "3", "4", "..", "32768..65535" },
124 Values { "Unknown", "Reserved", "StorageVolume",
125 "StorageExtent", "LogicalDisk", "DMTF Reserved",
126 "Vendor Specific" }]
127 marek 1.1 uint16 ElementType,
128 [IN ( false ), OUT, Description (
129 "Reference to the job (may be null if job completed)."
130 )]
131 CIM_ConcreteJob REF Job,
132 [IN, Description (
133 "The requirements for the element to maintain. If "
134 "set to a null value, the default configuration "
135 "from the source pool will be used. This parameter "
136 "should be a reference to a Setting or Profile "
137 "appropriate to the element being created. If not "
138 "NULL, this parameter will supply a new Goal when "
139 "modifying an existing element." )]
140 CIM_ManagedElement REF Goal,
141 [IN, OUT, Description (
142 "As an input parameter Size specifies the desired "
143 "size. If not NULL, this parameter will supply a "
144 "new size when modifying an existing element. As an "
145 "output parameter Size specifies the size achieved." ),
146 Units ( "Bytes" )]
147 uint64 Size,
148 marek 1.1 [IN, Description (
149 "The Pool from which to create the element. This "
150 "parameter must be set to null if the input "
151 "parameter TheElement is specified (in the case of "
152 "a \'modify\' operation)." )]
153 CIM_StoragePool REF InPool,
154 [IN, OUT, Description (
155 "As an input parameter: if null, creates a new "
156 "element. If not null, then the method modifies the "
157 "specified element. As an output parameter, it is a "
158 "reference to the resulting element." )]
159 CIM_LogicalElement REF TheElement);
160
161 [Description (
162 "Start a job to delete a StoragePool. The freed space is "
163 "returned source StoragePools (indicated by AllocatedFrom "
164 "StoragePool) or back to underlying storage extents. If 0 "
165 "is returned, the function completed successfully, and no "
166 "ConcreteJob was required. If 4096/0x1000 is returned, a "
167 "ConcreteJob will be started to delete the StoragePool. A "
168 "reference to the Job is returned in the Job parameter." ),
169 marek 1.1 ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096",
170 "4097..32767", "32768..65535" },
171 Values { "Job Completed with No Error", "Not Supported",
172 "Unknown", "Timeout", "Failed", "Invalid Parameter",
173 "In Use", "DMTF Reserved",
174 "Method Parameters Checked - Job Started",
175 "Method Reserved", "Vendor Specific" }]
176 uint32 DeleteStoragePool(
177 [IN ( false ), OUT, Description (
178 "Reference to the job (may be null if job completed)."
179 )]
180 CIM_ConcreteJob REF Job,
181 [IN, Description ( "Reference to the pool to delete." )]
182 CIM_StoragePool REF Pool);
183
184 [Description (
185 "Start a job to delete an element previously created from "
186 "a StoragePool. The freed space is returned to the source "
187 "StoragePool. If 0 is returned, the function completed "
188 "successfully and no ConcreteJob was required. If "
189 "4096/0x1000 is returned, a ConcreteJob will be started "
190 marek 1.1 "to delete the element. A reference to the Job is "
191 "returned in the Job parameter." ),
192 ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096",
193 "4097..32767", "32768..65535" },
194 Values { "Job Completed with No Error", "Not Supported",
195 "Unknown", "Timeout", "Failed", "Invalid Parameter",
196 "In Use", "DMTF Reserved",
197 "Method Parameters Checked - Job Started",
198 "Method Reserved", "Vendor Specific" }]
199 uint32 ReturnToStoragePool(
200 [IN ( false ), OUT, Description (
201 "Reference to the job (may be null if job completed)."
202 )]
203 CIM_ConcreteJob REF Job,
204 [IN, Description (
205 "Reference to the element to return to the StoragePool."
206 )]
207 CIM_LogicalElement REF TheElement);
208
209 [Description (
210 "Start a job to create a new storage object which is a "
211 marek 1.1 "replica of the specified source storage object. "
212 "(SourceElement). Note that using the input paramter, "
213 "CopyType, this function can be used to instantiate the "
214 "replica, and to create an ongoing association between "
215 "the source and replica. If 0 is returned, the function "
216 "completed successfully and no ConcreteJob instance is "
217 "created. If 4096/0x1000 is returned, a ConcreteJob is "
218 "started, a reference to which is returned in the Job "
219 "output parameter." ),
220 ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096",
221 "4097..32767", "32768..65535" },
222 Values { "Job Completed with No Error", "Not Supported",
223 "Unknown", "Timeout", "Failed", "Invalid Parameter",
224 "In Use", "DMTF Reserved",
225 "Method Parameters Checked - Job Started",
226 "Method Reserved", "Vendor Specific" }]
227 uint32 CreateReplica(
228 [IN, Description (
229 "A end user relevant name for the element being "
230 "created. If NULL, then a system supplied default "
231 "name can be used. The value will be stored in the "
232 marek 1.1 "\'ElementName\' property for the created element." )]
233 string ElementName,
234 [IN ( false ), OUT, Description (
235 "Reference to the job (may be null if job completed)."
236 )]
237 CIM_ConcreteJob REF Job,
238 [Required, IN, Description (
239 "The source storage object which may be a "
240 "StorageVolume or storage object." )]
241 CIM_LogicalElement REF SourceElement,
242 [IN ( false ), OUT, Description (
243 "Reference to the created target storage element "
244 "(i.e., the replica)." )]
245 CIM_LogicalElement REF TargetElement,
246 [IN, Description (
247 "The definition for the StorageSetting to be "
248 "maintained by the target storage object (the "
249 "replica)." )]
250 CIM_StorageSetting REF TargetSettingGoal,
251 [IN, Description (
252 "The underlying storage for the target element (the "
253 marek 1.1 "replica) will be drawn from TargetPool if "
254 "specified, otherwise the allocation is "
255 "implementation specific." )]
256 CIM_StoragePool REF TargetPool,
257 [IN, Description (
258 "CopyType describes the type of copy that will be "
259 "made. Values are: \n"
260 "Async: Create and maintain an asynchronous copy of "
261 "the source. \n"
262 "Sync: Create and maintain a synchronized copy of "
263 "the source. \n"
264 "UnSyncAssoc: Create an unsynchronized copy and "
265 "maintain an association to the source. \n"
266 "UnSyncUnAssoc: Create unassociated copy of the "
267 "source element." ),
268 ValueMap { "2", "3", "4", "5", "..", "32768..65535" },
269 Values { "Async", "Sync", "UnSyncAssoc",
270 "UnSyncUnAssoc", "DMTF Reserved", "Vendor Specific" }]
271 uint16 CopyType);
272
273 [Description (
274 marek 1.1 "Modify (or start a job to modify) the synchronization "
275 "association between two storage objects. If 0 is "
276 "returned, the function completed successfully and no "
277 "ConcreteJob instance was created. If 0x1000 is returned, "
278 "a ConcreteJob was started and a reference to this Job is "
279 "returned in the Job output parameter. A return value of "
280 "1 indicates the method is not supported. All other "
281 "values indicate some type of error condition." ),
282 ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "0x1000",
283 "0x1001..0x7FFF", "0x8000..0xFFFF" },
284 Values { "Job Completed with No Error", "Not Supported",
285 "Unspecified Error", "Timeout", "Failed",
286 "Invalid Parameter", "In Use", "DMTF Reserved",
287 "Method Parameters Checked - Job Started",
288 "Method Reserved", "Vendor Specific" }]
289 uint32 ModifySynchronization(
290 [IN, Description (
291 "Operation describes the type of modification to be "
292 "made to the replica. Values are: \n"
293 "Detach: \'Forget\' the synchronization between two "
294 "storage objects. Start to treat the objects as "
295 marek 1.1 "independent. \n"
296 "Fracture: Suspend the synchronization between two "
297 "storage objects using Sync or Async replication. \n"
298 "The association and (typically) changes are "
299 "remembered to allow a fast resynchronization. This "
300 "may be used during a backup cycle to allow one of "
301 "the objects to be copied while the other remains "
302 "in production. \n"
303 "Resync Replica: Re-establish the synchronization "
304 "of a Sync or Async replication. This will negate "
305 "the action of a previous Fracture operation. "
306 "Recreate a Point In Time image for an UnSyncAssoc "
307 "replication. \n"
308 "Restore from Replica: Renew the contents of the "
309 "original storage object from a replica. \n"
310 "Prepare: Get the link ready for a Resync operation "
311 "to take place. Some implementations will require "
312 "this operation to be invoked to keep the Resync "
313 "operation as fast as possible. May start the copy "
314 "engine. \n"
315 "Unprepare: Clear a prepared state if a Prepare is "
316 marek 1.1 "not to be followed by a Resync operation. \n"
317 "Quiesce: Some applications require notification so "
318 "that they can ready the link for an operation. For "
319 "example flush any cached data or buffered changes. "
320 "The copy engine is stopped for UnSyncAssoc "
321 "replications. \n"
322 "Unquiesce: Take the link from the quiesced state "
323 "(without executing the intended operation. \n"
324 "Start Copy: initiate a full background copy of the "
325 "source to the UnSyncAssoc replica. Replica enters "
326 "Frozen state when copy operation is completed. \n"
327 "Stop Copy: stop the background copy previously "
328 "started. Reset To Sync: Change the CopyType of the "
329 "association to Sync (e.g., from the Async "
330 "CopyType). \n"
331 "Reset To Async: Change the CopyType of the "
332 "association to Async (e.g., from the Sync "
333 "CopyType)." ),
334 ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8",
335 "9", "10", "11", "12", "13", "..", "0x8000..0xFFFF" },
336 Values { "DMTF Reserved", "DMTF Reserved", "Detach",
337 marek 1.1 "Fracture", "Resync Replica",
338 "Restore from Replica", "Prepare", "Unprepare",
339 "Quiesce", "Unquiesce", "Reset To Sync",
340 "Reset To Async", "Start Copy", "Stop Copy",
341 "DMTF Reserved", "Vendor Specific" }]
342 uint16 Operation,
343 [IN ( false ), OUT, Description (
344 "Reference to the job (may be null if the task completed)."
345 )]
346 CIM_ConcreteJob REF Job,
347 [IN, Description (
348 "The referenced to the StorageSynchronized "
349 "association describing the storage source/replica "
350 "relationship." )]
351 CIM_StorageSynchronized REF Synchronization);
352
353 [Description (
354 "Create (or start a job to create) a StorageSynchronized "
355 "relationship between two existing storage objects. Note "
356 "that using the input parameter, CopyType, this function "
357 "can be used to to create an ongoing association between "
358 marek 1.1 "the source and replica. If 0 is returned, the function "
359 "completed successfully and no ConcreteJob instance is "
360 "created. If 0x1000 is returned, a ConcreteJob is "
361 "started, a reference to which is returned in the Job "
362 "output parameter. A return value of 1 indicates the "
363 "method is not supported. All other values indicate some "
364 "type of error condition." ),
365 ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "0x1000",
366 "0x1001..0x7FFF", "0x8000..0xFFFF" },
367 Values { "Job Completed with No Error", "Not Supported",
368 "Unspecified Error", "Timeout", "Failed",
369 "Invalid Parameter", "In Use", "DMTF Reserved",
370 "Method Parameters Checked - Job Started",
371 "Method Reserved", "Vendor Specific" }]
372 uint32 AttachReplica(
373 [IN ( false ), OUT, Description (
374 "Reference to the job (may be null if the task completed)."
375 )]
376 CIM_ConcreteJob REF Job,
377 [Required, IN, Description (
378 "The source storage object which may be a "
379 marek 1.1 "StorageVolume or other storage object." )]
380 CIM_ManagedElement REF SourceElement,
381 [IN, Description (
382 "Reference to the target storage element (i.e., the replica)."
383 )]
384 CIM_ManagedElement REF TargetElement,
385 [IN, Description (
386 "CopyType describes the type of Synchronized "
387 "relationship that will be created. Values are: \n"
388 "Async: Create and maintain an asynchronous copy of "
389 "the source. \n"
390 "Sync: Create and maintain a synchronized copy of "
391 "the source. \n"
392 "UnSyncAssoc: Create an unsynchronized copy and "
393 "maintain an association to the source. \n"
394 "UnSyncUnAssoc: Create unassociated copy of the "
395 "source element." ),
396 ValueMap { "2", "3", "4", "5", "..", "0x8000..0xFFFF" },
397 Values { "Async", "Sync", "UnSyncAssoc",
398 "UnSyncUnAssoc", "DMTF Reserved", "Vendor Specific" }]
399 uint16 CopyType);
400 marek 1.1
401 [Description (
402 "Start a job to create (or modify) a specified storage "
403 "element from specified input StorageExtents. The created "
404 "or modified storage element can be a StorageExtent, "
405 "StorageVolume, LogicalDisk, or StoragePool. An input "
406 "list of InElements must be specified. The "
407 "GetAvailableExtents method can be used to get a list of "
408 "valid extents that can be used to achieve a desired "
409 "goal. Validity of the extents is determined by the "
410 "implementation. As an input parameter, Size specifies "
411 "the desired size of the element. As an output parameter, "
412 "it specifies the size achieved. Space is taken from the "
413 "input InElements. The desired Settings for the element "
414 "are specified by the Goal parameter. If the size of "
415 "Extents passed is less than the size requested, then the "
416 "capacity is drawn from the extents in the order, left to "
417 "right, that the Extents were specified. The partial "
418 "consumption of an Extent is represented by an Extent for "
419 "the capacity used and an Extent for the capacity not "
420 "used. If the Size is NULL, then a configuration using "
421 marek 1.1 "all Extents passed will be attempted. If the requested "
422 "size cannot be created, no action will be taken, and the "
423 "Return Value will be 4097/0x1001. Also, the output value "
424 "of Size is set to the nearest possible size. If 0 is "
425 "returned, the function completed successfully and no "
426 "ConcreteJob instance was required. If 4096/0x1000 is "
427 "returned, a ConcreteJob will be started to create the "
428 "element. The Job\'s reference will be returned in the "
429 "output parameter Job." ),
430 ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096",
431 "4097", "4098..32767", "32768..65535" },
432 Values { "Completed with No Error", "Not Supported",
433 "Unknown", "Timeout", "Failed", "Invalid Parameter",
434 "In Use", "DMTF Reserved",
435 "Method Parameters Checked - Job Started",
436 "Size Not Supported", "Method Reserved", "Vendor Specific" }]
437 uint32 CreateOrModifyElementFromElements(
438 [IN, Description (
439 "A end user relevant name for the element being "
440 "created. If NULL, then a system-supplied default "
441 "name can be used. The value will be stored in the "
442 marek 1.1 "\'ElementName\' property for the created element. "
443 "If not NULL, this parameter will supply a new name "
444 "when modifying an existing element." )]
445 string ElementName,
446 [Required, IN, Description (
447 "Enumeration indicating the type of element being "
448 "created or modified. If the input parameter "
449 "TheElement is specified when the operation is a "
450 "\'modify\', this type value must match the type of "
451 "that instance. The actual CIM class of the created "
452 "TheElement can be vendor-specific, but it must be "
453 "a derived class of the appropriate CIM class -- "
454 "i.e., CIM_StorageVolume, CIM_StorageExtent, "
455 "CIM_LogicalDisk, or CIM_StoragePool." ),
456 ValueMap { "0", "1", "2", "3", "4", "5", "..",
457 "32768..65535" },
458 Values { "Unknown", "Reserved", "Storage Volume",
459 "Storage Extent", "Storage Pool", "Logical Disk",
460 "DMTF Reserved", "Vendor Specific" }]
461 uint16 ElementType,
462 [IN ( false ), OUT, Description (
463 marek 1.1 "Reference to the job (may be null if job completed)."
464 )]
465 CIM_ConcreteJob REF Job,
466 [IN, Description (
467 "The requirements for the element to maintain. If "
468 "set to a null value, the default configuration "
469 "associated with the Service will be used. This "
470 "parameter should be a reference to a Setting, "
471 "SettingData, or Profile appropriate to the element "
472 "being created. If not NULL, this parameter will "
473 "supply a new Goal when modifying an existing "
474 "element." )]
475 CIM_ManagedElement REF Goal,
476 [IN, OUT, Description (
477 "As an input parameter Size specifies the desired "
478 "size. If not NULL, this parameter will supply a "
479 "new size when modifying an existing element. As an "
480 "output parameter Size specifies the size achieved." ),
481 Units ( "Bytes" )]
482 uint64 Size,
483 [Required, IN, Description (
484 marek 1.1 "Array of references to storage element instances "
485 "that are used to create or modify TheElement." )]
486 CIM_StorageExtent REF InElements[],
487 [IN, OUT, Description (
488 "As an input parameter: if null, creates a new "
489 "element. If not null, then the method modifies the "
490 "specified element. As an output parameter, it is a "
491 "reference to the resulting element." )]
492 CIM_LogicalElement REF TheElement);
493
494 };
|
Return to
CIM_StorageConfigurationService.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIM231 / DMTF / Device