os-cmpi-xen

annotate schema/dmtf/CIM_VirtualSystemManagementService.mof @ 121:4868ace2726b

Add initial consistence checks in test suite for Xen_MemoryPool, Xen_ProcessorPool and Xen_VirtualSystemManagementService.

Signed-off-by: Luke Szymanski <Lukasz.Szymanski@Unisys.com>
author Jim Fehlig <jfehlig@novell.com>
date Fri Jun 08 10:22:05 2007 -0600 (2007-06-08)
parents cd21b7e999f3
children
rev   line source
jfehlig@49 1 // Copyright (c) 2007 DMTF. All rights reserved.
jfehlig@18 2 // This document is a DMTF System Virtualization, Partitioning and
jfehlig@18 3 // Clustering workgroup "Work in Progress" and is subject to change.
jfehlig@49 4 // This document was released on January 15 2007.
jfehlig@49 5 // This document must not be used after May 1 2007.
jfehlig@49 6 //===================================================================
jfehlig@18 7 // CIM_VirtualSystemManagementService
jfehlig@49 8 //===================================================================
jfehlig@18 9 // 0 - Completed with No Error
jfehlig@18 10 // 1 - Not Supported
jfehlig@18 11 // 2 - Failed
jfehlig@18 12 // 3 - Timeout
jfehlig@18 13 // 4 - Invalid Parameter
jfehlig@49 14 // 5 - Invalid State
jfehlig@49 15 // 6 - Invalid Type
jfehlig@49 16 //
jfehlig@18 17 // 4096 - Method Parameters Checked - Job Started
jfehlig@49 18 //
jfehlig@18 19 // ===================================================================
jfehlig@49 20
jfehlig@49 21 // ===================================================================
jfehlig@49 22 [ Experimental,
jfehlig@49 23 Version("2.14.0"),
jfehlig@49 24 Description(
jfehlig@49 25 "Service to define and manipulate virtual systems and their "
jfehlig@49 26 "components")]
jfehlig@18 27 class CIM_VirtualSystemManagementService : CIM_Service {
jfehlig@18 28
jfehlig@18 29 //--------------------------------------------------------------------
jfehlig@49 30 // AddResourceSettings
jfehlig@49 31 //--------------------------------------------------------------------
jfehlig@49 32 [ Description(
jfehlig@49 33 "Adds resources to a virtual system configuration\n."
jfehlig@49 34 "When applied to a \"state\" virtual system configuration, "
jfehlig@49 35 "as a side effect resources are added to the active virtual "
jfehlig@49 36 "system."),
jfehlig@49 37 ValueMap {
jfehlig@49 38 "0","1","2","3","4","..","4096","4097..32767","32768..65535"},
jfehlig@49 39 Values {
jfehlig@49 40 "Completed with No Error","Not Supported","Failed","Timeout",
jfehlig@49 41 "Invalid Parameter","DMTF Reserved",
jfehlig@49 42 "Method Parameters Checked - Job Started",
jfehlig@49 43 "Method Reserved","Vendor Specific"}]
jfehlig@49 44 uint32 AddResourceSettings(
jfehlig@49 45
jfehlig@49 46 [ Description(
jfehlig@49 47 "Reference to the affected virtual system configuration.")]
jfehlig@49 48 CIM_VirtualSystemSettingData REF AffectedConfiguration,
jfehlig@49 49
jfehlig@49 50 [ ArrayType("Indexed"),
jfehlig@49 51 Description(
jfehlig@49 52 "Array of strings each containing one embedded instance of "
jfehlig@49 53 "class CIM_ResourceAllocationSettingData that describes the "
jfehlig@49 54 "virtual aspects of a virtual resource to be added to the "
jfehlig@49 55 "virtual system."),
jfehlig@49 56 EmbeddedInstance("CIM_ResourceAllocationSettingData")]
jfehlig@49 57 string ResourceSettings[],
jfehlig@49 58
jfehlig@49 59 [ In(False), Out,
jfehlig@49 60 ArrayType("Indexed"),
jfehlig@49 61 Description(
jfehlig@49 62 "Array of references to instances of class "
jfehlig@49 63 "CIM_ResourceAllocationSettingData representing virtual "
jfehlig@49 64 "aspects of the added virtual resources.")]
jfehlig@49 65 CIM_ResourceAllocationSettingData REF
jfehlig@49 66 ResultingResourceSettings[],
jfehlig@49 67
jfehlig@49 68 [ In(False), Out,
jfehlig@49 69 Description(
jfehlig@49 70 "If the operation is long running, then optionally a job may "
jfehlig@49 71 "be returned. In this case, the instances of class "
jfehlig@49 72 "CIM_ResourceAllocationSettingData representing the added "
jfehlig@49 73 "resource settings are available via association "
jfehlig@49 74 "CIM_ConreteComponent from the instance of class "
jfehlig@49 75 "CIM_VirtualSystemSettingData representing the affected "
jfehlig@49 76 "virtual system configuration.")]
jfehlig@49 77 CIM_ConcreteJob REF Job);
jfehlig@49 78
jfehlig@49 79 //--------------------------------------------------------------------
jfehlig@49 80 // DefineSystem
jfehlig@49 81 //--------------------------------------------------------------------
jfehlig@49 82 [ Description(
jfehlig@49 83 "Defines a virtual system.\n"
jfehlig@49 84 "Input that is not completely specified may be filled out with "
jfehlig@49 85 "default values."),
jfehlig@49 86 ValueMap {
jfehlig@49 87 "0","1","2","3","4","..","4096","4097..32767","32768..65535"},
jfehlig@49 88 Values {
jfehlig@49 89 "Completed with No Error","Not Supported","Failed","Timeout",
jfehlig@49 90 "Invalid Parameter","DMTF Reserved",
jfehlig@49 91 "Method Parameters Checked - Job Started",
jfehlig@49 92 "Method Reserved","Vendor Specific"}]
jfehlig@49 93 uint32 DefineSystem(
jfehlig@49 94
jfehlig@49 95 [ Description(
jfehlig@49 96 "String containing an embedded instance of "
jfehlig@49 97 "class CIM_VirtualSystemSettingData that is used to define "
jfehlig@49 98 "attributes of the virtual system to be created."),
jfehlig@49 99 EmbeddedInstance("CIM_VirtualSystemSettingData")]
jfehlig@49 100 string SystemSettings,
jfehlig@49 101
jfehlig@49 102 [ ArrayType("Indexed"),
jfehlig@49 103 Description(
jfehlig@49 104 "Array of strings each containing an embedded instance of "
jfehlig@49 105 "class CIM_ResourceAllocationSettingData that describes the "
jfehlig@49 106 "virtual aspects of a virtual resource to be created in "
jfehlig@49 107 "the scope of the new virtual system."),
jfehlig@49 108 EmbeddedInstance("CIM_ResourceAllocationSettingData")]
jfehlig@49 109 string ResourceSettings[],
jfehlig@49 110
jfehlig@49 111 [ Description(
jfehlig@49 112 "Reference to an instance of class "
jfehlig@49 113 "CIM_VirtualSystemSettingData object that is the top level "
jfehlig@49 114 "object of a reference virtual system configuration. The "
jfehlig@49 115 "reference configuration is used to complement the "
jfehlig@49 116 "configuration of the new virtual system if parameters "
jfehlig@49 117 "SystemSettings and ResourceSettings did not provide "
jfehlig@49 118 "respective information.")]
jfehlig@49 119 CIM_VirtualSystemSettingData REF ReferenceConfiguration,
jfehlig@49 120
jfehlig@49 121 [ In(False), Out,
jfehlig@49 122 Description(
jfehlig@49 123 "If a virtual computer system is successfully defined, a "
jfehlig@49 124 "reference to an instance of class CIM_ComputerSystem that "
jfehlig@49 125 "represents the newly defined virtual computer system is "
jfehlig@49 126 "returned.")]
jfehlig@49 127 CIM_ComputerSystem REF ResultingSystem,
jfehlig@49 128
jfehlig@49 129 [ In(False), Out,
jfehlig@49 130 Description(
jfehlig@49 131 "If the operation is long running, then optionally a job "
jfehlig@49 132 "may be returned. In this case, the instance of class "
jfehlig@49 133 "CIM_ComputerSystem representing the new virtual system"
jfehlig@49 134 "is presented via association CIM_AffectedJobElement"
jfehlig@49 135 "with property AffectedElement refering to the new "
jfehlig@49 136 "instance of class CIM_ComputerSystem and property "
jfehlig@49 137 "ElementEffects set to 5 (Create).")]
jfehlig@49 138 CIM_ConcreteJob REF Job);
jfehlig@49 139
jfehlig@49 140 //--------------------------------------------------------------------
jfehlig@49 141 // DestroySystem()
jfehlig@49 142 //--------------------------------------------------------------------
jfehlig@49 143 [ Description(
jfehlig@49 144 "Destroys a virtual system.\n"
jfehlig@49 145 "The referenced virtual system is destroyed, including any "
jfehlig@49 146 "elements scoped by it. Virtual resources are returned to "
jfehlig@49 147 "their resource pools, which may imply the destruction of "
jfehlig@49 148 "those resources (implementation dependent). If the virtual "
jfehlig@49 149 "system is active when the operation is invoked, it is "
jfehlig@49 150 "first deactivated and then destroyed. If snapshots were "
jfehlig@49 151 "created from the virtual system, these are destroyed as "
jfehlig@49 152 "well."),
jfehlig@49 153 ValueMap {
jfehlig@49 154 "0","1","2","3","4","5","..","4096","4097..32767",
jfehlig@49 155 "32768..65535"},
jfehlig@49 156 Values {
jfehlig@49 157 "Completed with No Error","Not Supported","Failed","Timeout",
jfehlig@49 158 "Invalid Parameter","Invalid State",
jfehlig@49 159 "DMTF Reserved","Method Parameters Checked - Job Started",
jfehlig@49 160 "Method Reserved","Vendor Specific"}]
jfehlig@49 161 uint32 DestroySystem(
jfehlig@49 162
jfehlig@49 163 [ Description(
jfehlig@49 164 "Reference to an instance of class CIM_ComputerSystem "
jfehlig@49 165 "representing the virtual computer system that it to be "
jfehlig@49 166 "destroyed.")]
jfehlig@49 167 CIM_ComputerSystem REF AffectedSystem,
jfehlig@49 168
jfehlig@49 169 [ In(False), Out,
jfehlig@49 170 Description (
jfehlig@49 171 "If the operation is long running, then optionally a job "
jfehlig@49 172 "may be returned.")]
jfehlig@49 173 CIM_ConcreteJob REF Job);
jfehlig@49 174
jfehlig@49 175 //--------------------------------------------------------------------
jfehlig@49 176 // ModifyResourceSettings()
jfehlig@18 177 //--------------------------------------------------------------------
jfehlig@18 178 [ Description (
jfehlig@49 179 "Modifies virtual resource settings.\n"
jfehlig@49 180 "When applied to parts of a \"current\" virtual system "
jfehlig@49 181 "configuration, as a side effect resources of the "
jfehlig@49 182 "active virtual system may be modified."),
jfehlig@18 183 ValueMap {
jfehlig@18 184 "0","1","2","3","4","5","6","..","4096","4097..32767",
jfehlig@18 185 "32768..65535"},
jfehlig@18 186 Values {
jfehlig@18 187 "Completed with No Error","Not Supported","Failed","Timeout",
jfehlig@18 188 "Invalid Parameter","Invalid State","Incompatible Parameters",
jfehlig@18 189 "DMTF Reserved","Method Parameters Checked - Job Started",
jfehlig@18 190 "Method Reserved","Vendor Specific"}]
jfehlig@49 191 uint32 ModifyResourceSettings(
jfehlig@18 192
jfehlig@18 193 [ ArrayType("Indexed"),
jfehlig@18 194 Description(
jfehlig@18 195 "Array of strings each containing an embedded instance of "
jfehlig@49 196 "class CIM_ResourceAllocationSettingData that describes "
jfehlig@49 197 "modifications to the virtual aspects of an existing virtual "
jfehlig@49 198 "resource. All instances must have a valid InstanceID "
jfehlig@49 199 "in order to identify the virtual resource setting to be "
jfehlig@49 200 "modified."),
jfehlig@49 201 EmbeddedInstance("CIM_ResourceAllocationSettingData")]
jfehlig@49 202 string ResourceSettings[],
jfehlig@18 203
jfehlig@49 204 [ In(False), Out,
jfehlig@49 205 ArrayType("Indexed"),
jfehlig@49 206 Description(
jfehlig@49 207 "Array of references to instances of class "
jfehlig@49 208 "Cim_ResourceAllocationSettingData representing virtual "
jfehlig@49 209 "aspects of the modified virtual resources.")]
jfehlig@49 210 CIM_ResourceAllocationSettingData REF
jfehlig@49 211 ResultingResourceSettings[],
jfehlig@18 212
jfehlig@49 213 [ In(False), Out,
jfehlig@49 214 Description (
jfehlig@49 215 "If the operation is long running, then optionally a job "
jfehlig@49 216 "be returned. In this case, the instances of class "
jfehlig@49 217 "CIM_ResourceAllocationSettingData representing the "
jfehlig@49 218 "modified resource settings are available via association "
jfehlig@49 219 "CIM_ConreteComponent from the instance of class "
jfehlig@49 220 "CIM_VirtualSystemSettingData representing the affected "
jfehlig@49 221 "virtual system configuration.")]
jfehlig@18 222 CIM_ConcreteJob REF Job);
jfehlig@18 223
jfehlig@18 224 //--------------------------------------------------------------------
jfehlig@49 225 // ModifySystemSettings()
jfehlig@18 226 //--------------------------------------------------------------------
jfehlig@49 227 [ Description (
jfehlig@49 228 "Modifies virtual system settings.\n"
jfehlig@49 229 "When applied to the system settings of a \"current\" virtual "
jfehlig@49 230 "system configuration, as a side effect the virtual system "
jfehlig@49 231 "instance may be modified. "),
jfehlig@18 232 ValueMap {
jfehlig@49 233 "0","1","2","3","4","5","6","..","4096","4097..32767",
jfehlig@49 234 "32768..65535"},
jfehlig@18 235 Values {
jfehlig@18 236 "Completed with No Error","Not Supported","Failed","Timeout",
jfehlig@49 237 "Invalid Parameter","Invalid State","Incompatible Parameters",
jfehlig@49 238 "DMTF Reserved","Method Parameters Checked - Job Started",
jfehlig@18 239 "Method Reserved","Vendor Specific"}]
jfehlig@49 240 uint32 ModifySystemSettings(
jfehlig@18 241
jfehlig@18 242 [ Description(
jfehlig@49 243 "String containing an instance of class "
jfehlig@49 244 "CIM_VirtualSystemSettingData that is used to modify "
jfehlig@49 245 "the settings of the virtual system. The instance must have "
jfehlig@49 246 "a valid InstanceID in order to identify the virtual system "
jfehlig@49 247 "setting to be modified."),
jfehlig@49 248 EmbeddedInstance("CIM_VirtualSystemSettingData")]
jfehlig@49 249 string SystemSettings,
jfehlig@18 250
jfehlig@49 251 [ In(False), Out,
jfehlig@49 252 Description (
jfehlig@49 253 "If the operation is long running, then optionally a job "
jfehlig@49 254 "may be returned.")]
jfehlig@18 255 CIM_ConcreteJob REF Job);
jfehlig@18 256
jfehlig@18 257 //--------------------------------------------------------------------
jfehlig@49 258 // RemoveResourceSettings()
jfehlig@18 259 //--------------------------------------------------------------------
jfehlig@18 260 [ Description(
jfehlig@49 261 "Removes virtual resource settings from a virtual system "
jfehlig@49 262 "configuration.\n"
jfehlig@49 263 "When applied to parts of a \"current\" virtual system "
jfehlig@49 264 "configuration, as a side effect resources of the "
jfehlig@49 265 "active virtual system may be removed."),
jfehlig@18 266 ValueMap {
jfehlig@18 267 "0","1","2","3","4","5","..","4096","4097..32767",
jfehlig@18 268 "32768..65535"},
jfehlig@18 269 Values {
jfehlig@18 270 "Completed with No Error","Not Supported","Failed","Timeout",
jfehlig@18 271 "Invalid Parameter","Invalid State",
jfehlig@18 272 "DMTF Reserved","Method Parameters Checked - Job Started",
jfehlig@18 273 "Method Reserved","Vendor Specific"}]
jfehlig@49 274 uint32 RemoveResourceSettings(
jfehlig@18 275
jfehlig@18 276 [ Description(
jfehlig@49 277 "Array of references to instances of class "
jfehlig@49 278 "CIM_ResourceAllocationSettingData where each instance "
jfehlig@49 279 "represents the settings of a virtual resource within a "
jfehlig@49 280 "virtual system configuration that are to be removed.")]
jfehlig@49 281 CIM_ResourceAllocationSettingData REF ResourceSettings[],
jfehlig@18 282
jfehlig@49 283 [ In(False), Out,
jfehlig@49 284 Description (
jfehlig@49 285 "If the operation is long running, then optionally a job "
jfehlig@49 286 "my be returned.")]
jfehlig@18 287 CIM_ConcreteJob REF Job);
jfehlig@18 288
jfehlig@18 289 };