1 marek 1.1 // Copyright (c) 2009 DMTF.  All rights reserved.
  2              [Version ( "2.22.0" ), 
  3               UMLPackagePath ( "CIM::Core::Resource" ), 
  4               Description ( 
  5                  "This service provides for active management of Resource Pools. "
  6                  "It allows jobs to be started for the creation and deletion of "
  7                  "ResourcePools as well as addition and subtraction of host "
  8                  "resources from ResourcePools" )]
  9           class CIM_ResourcePoolConfigurationService : CIM_Service {
 10           
 11           
 12                 [Description ( 
 13                     "Starts a job to create a root ResourcePool. The "
 14                     "ResourcePool will be scoped to the same System as this "
 15                     "Service. If 0 is returned, then the task completed "
 16                     "successfully and the use of ConcreteJob was not "
 17                     "required. If the task will take some time to complete, a "
 18                     "ConcreteJob will be created and its reference returned "
 19                     "in the output parameter Job. The resulting pool will be "
 20                     "a root pool with no parent pool." ), 
 21                  ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "..", 
 22 marek 1.1           "4096", "4097", "4098..32767", "32768..65535" }, 
 23                  Values { "Job Completed with No Error", "Not Supported", 
 24                     "Unknown", "Timeout", "Failed", "Invalid Parameter", 
 25                     "In Use", "Incorrect ResourceType for the Pool", 
 26                     "DMTF Reserved", 
 27                     "Method Parameters Checked - Job Started", 
 28                     "Size Not Supported", "Method Reserved", "Vendor Specific" }]
 29              uint32 CreateResourcePool(
 30                    [IN, Description ( 
 31                        "A end user relevant name for the pool being "
 32                        "created. If NULL, then a system supplied default "
 33                        "name can be used. The value will be stored in the "
 34                        "\'ElementName\' property for the created pool." )]
 35                 string ElementName, 
 36                    [IN, Description ( 
 37                        "Array of zero or more devices that are used to "
 38                        "create the Pool or modify the source extents. All "
 39                        "elements in the array must be of the same type." )]
 40                 CIM_LogicalDevice REF HostResources[], 
 41                    [IN, Description ( 
 42                        "The type of resources the created poolwill manage. "
 43 marek 1.1              "If HostResources contains elements, this property "
 44                        "must mach their type." )]
 45                 string ResourceType, 
 46                    [IN ( false ), OUT, Description ( 
 47                        "On success, a reference to the resulting "
 48                        "ResourcePool is returned. When a Job is returned, "
 49                        "this may be NULL, in which case, the client must "
 50                        "use the Job to find the resulting ResourcePool "
 51                        "once the Job completes." )]
 52                 CIM_ResourcePool REF Pool, 
 53                    [IN ( false ), OUT, Description ( 
 54                        "Reference to the job (may be null if job completed)."
 55                         )]
 56                 CIM_ConcreteJob REF Job);
 57           
 58                 [Description ( 
 59                     "Start a job to create a sub-pool from a parent pool "
 60                     "using the specified allocation settings If 0 is "
 61                     "returned, the function completed successfully and no "
 62                     "ConcreteJob instance was required. If 4096/0x1000 is "
 63                     "returned, a ConcreteJob will be started to create the "
 64 marek 1.1           "sub-pool. The Job\'s reference will be returned in the "
 65                     "output parameter Job." ), 
 66                  ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "..", 
 67                     "4096", "4097", "4098..32767", "32768..65535" }, 
 68                  Values { "Job Completed with No Error", "Not Supported", 
 69                     "Unknown", "Timeout", "Failed", "Invalid Parameter", 
 70                     "In Use", "Incorrect ResourceType for the Pool", 
 71                     "Insufficient Resources", "DMTF Reserved", 
 72                     "Method Parameters Checked - Job Started", 
 73                     "Size Not Supported", "Method Reserved", "Vendor Specific" }]
 74              uint32 CreateChildResourcePool(
 75                    [IN, Description ( 
 76                        "A end user relevant name for the pool being "
 77                        "created. If NULL, then a system supplied default "
 78                        "name can be used. The value will be stored in the "
 79                        "\'ElementName\' property for the created element." )]
 80                 string ElementName, 
 81                    [IN, Description ( 
 82                        "String containing a representation of a "
 83                        "CIM_SettingData instance that is used to specify "
 84                        "the settings for the child Pool." ), 
 85 marek 1.1           EmbeddedInstance ( "CIM_ResourceAllocationSettingData" ), 
 86                     ModelCorrespondence { 
 87                        "CIM_ResourcePoolConfigurationService.CreateChildResourcePool.ParentPool" }]
 88                 string Settings[], 
 89                    [IN, Description ( 
 90                        "The Pool(s) from which to create the new Pool." ), 
 91                     ModelCorrespondence { 
 92                        "CIM_ResourcePoolConfigurationService.CreateChildResourcePool.Settings" }]
 93                 CIM_ResourcePool REF ParentPool[], 
 94                    [IN ( false ), OUT, Description ( 
 95                        "A reference to the resulting pool." )]
 96                 CIM_ResourcePool REF Pool, 
 97                    [IN ( false ), OUT, Description ( 
 98                        "Reference to the job (may be null if job completed)."
 99                         )]
100                 CIM_ConcreteJob REF Job);
101           
102                 [Description ( 
103                     "Start a job to delete a ResourcePool. No allocations may "
104                     "be outstanding or the delete will fail with \"In Use.\" "
105                     "If the resource pool is a root resource pool, any host "
106 marek 1.1           "resources are returned back to the underlying system. If "
107                     "0 is returned, the function completed successfully, and "
108                     "no ConcreteJob was required. If 4096/0x1000 is returned, "
109                     "a ConcreteJob will be started to delete the "
110                     "ResourcePool. A reference to the Job is returned in the "
111                     "Job parameter." ), 
112                  ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "..", 
113                     "4096", "4097..32767", "32768..65535" }, 
114                  Values { "Job Completed with No Error", "Not Supported", 
115                     "Unknown", "Timeout", "Failed", "Invalid Parameter", 
116                     "In Use", "Incorrect ResourceType for the Pool", 
117                     "DMTF Reserved", 
118                     "Method Parameters Checked - Job Started", 
119                     "Method Reserved", "Vendor Specific" }]
120              uint32 DeleteResourcePool(
121                    [IN, Description ( "Reference to the pool to delete." )]
122                 CIM_ResourcePool REF Pool, 
123                    [IN ( false ), OUT, Description ( 
124                        "Reference to the job (may be null if job completed)."
125                         )]
126                 CIM_ConcreteJob REF Job);
127 marek 1.1 
128                 [Description ( 
129                     "Starts a job to add resources to a ResourcePool. If 0 is "
130                     "returned, then the task completed successfully and the "
131                     "use of ConcreteJob was not required. If the task will "
132                     "take some time to complete, a ConcreteJob will be "
133                     "created and its reference returned in the output "
134                     "parameter Job. The resulting pool will be a root pool "
135                     "with no parent pool." ), 
136                  ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "..", 
137                     "4096", "4097", "4098..32767", "32768..65535" }, 
138                  Values { "Job Completed with No Error", "Not Supported", 
139                     "Unknown", "Timeout", "Failed", "Invalid Parameter", 
140                     "In Use", "Incorrect ResourceType for the Pool", 
141                     "DMTF Reserved", 
142                     "Method Parameters Checked - Job Started", 
143                     "Size Not Supported", "Method Reserved", "Vendor Specific" }]
144              uint32 AddResourcesToResourcePool(
145                    [IN, Description ( 
146                        "Array of CIM_LogicalDevice instances to add to the Pool."
147                         )]
148 marek 1.1       CIM_LogicalDevice REF HostResources[], 
149                    [IN, Description ( "The pool to add the resources to." )]
150                 CIM_ResourcePool REF Pool, 
151                    [IN ( false ), OUT, Description ( 
152                        "Reference to the job (may be null if job completed)."
153                         )]
154                 CIM_ConcreteJob REF Job);
155           
156                 [Description ( 
157                     "Starts a job to remove resources from a ResourcePool. If "
158                     "0 is returned, then the task completed successfully and "
159                     "the use of ConcreteJob was not required. If the task "
160                     "will take some time to complete, a ConcreteJob will be "
161                     "created and its reference returned in the output "
162                     "parameter Job. The resulting pool will be a root pool "
163                     "with no parent pool." ), 
164                  ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "..", 
165                     "4096", "4097", "4098..32767", "32768..65535" }, 
166                  Values { "Job Completed with No Error", "Not Supported", 
167                     "Unknown", "Timeout", "Failed", "Invalid Parameter", 
168                     "In Use", "Incorrect ResourceType for the Pool", 
169 marek 1.1           "DMTF Reserved", 
170                     "Method Parameters Checked - Job Started", 
171                     "Size Not Supported", "Method Reserved", "Vendor Specific" }]
172              uint32 RemoveResourcesFromResourcePool(
173                    [IN, Description ( 
174                        "Array of CIM_LogicalDevice instances to remove from the Pool."
175                         )]
176                 CIM_LogicalDevice REF HostResources[], 
177                    [IN, Description ( 
178                        "The pool to remove the resources from." )]
179                 CIM_ResourcePool REF Pool, 
180                    [IN ( false ), OUT, Description ( 
181                        "Reference to the job (may be null if job completed)."
182                         )]
183                 CIM_ConcreteJob REF Job);
184           
185                 [Description ( 
186                     "Start a job to change a parent pool using the specified "
187                     "allocation settings If 0 is returned, the function "
188                     "completed successfully and no ConcreteJob instance was "
189                     "required. If 4096/0x1000 is returned, a ConcreteJob will "
190 marek 1.1           "be started to change the parent pool. The Job\'s "
191                     "reference will be returned in the output parameter Job." ), 
192                  ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "..", 
193                     "4096", "4097", "4098..32767", "32768..65535" }, 
194                  Values { "Job Completed with No Error", "Not Supported", 
195                     "Unknown", "Timeout", "Failed", "Invalid Parameter", 
196                     "In Use", "Incorrect ResourceType for the Pool", 
197                     "Insufficient Resources", "DMTF Reserved", 
198                     "Method Parameters Checked - Job Started", 
199                     "Size Not Supported", "Method Reserved", "Vendor Specific" }]
200              uint32 ChangeParentResourcePool(
201                    [IN, Description ( "Reference to the child pool." )]
202                 CIM_ResourcePool REF ChildPool, 
203                    [IN, Description ( "Reference to the parent pool(s)." )]
204                 CIM_ResourcePool REF ParentPool[], 
205                    [IN, Description ( 
206                        "Optional string containing a representation of a "
207                        "CIM_SettingData instance that is used to specify "
208                        "the settings for the Parent Pool." ), 
209                     EmbeddedInstance ( "CIM_ResourceAllocationSettingData" ), 
210                     ModelCorrespondence { 
211 marek 1.1              "CIM_ResourcePoolConfigurationService.ChangeParentResourcePool.Settings" }]
212                 string Settings[], 
213                    [IN ( false ), OUT, Description ( 
214                        "Reference to the job (may be null if job completed)."
215                         ), 
216                     ModelCorrespondence { 
217                        "CIM_ResourcePoolConfigurationService.ChangeParentResourcePool.ParentPool" }]
218                 CIM_ConcreteJob REF Job);
219           
220           };