Class CIM_VirtualSystemManagementService
extends CIM_Service

Service to define and manipulate virtual systems and their components

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_VirtualSystemManagementService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringService to define and manipulate virtual systems and their components
UMLPackagePathstringCIM::Core::Virtualization
Versionstring2.22.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

AddResourceSettings (uint32)

Method Qualifiers (AddResourceSettings)

NameData TypeValue
DescriptionstringAdds resources to a virtual system configuration .When applied to a "state" virtual system configuration, as a side effect resources are added to the active virtual system.
ValueMapstring0, 1, 2, 3, 4, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Failed, Timeout, Invalid Parameter, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (AddResourceSettings)

NameTypeQualifiers
NameData TypeValue
ResourceSettingsstring[]
ArrayTypestringIndexed
DescriptionstringArray of strings each containing one embedded instance of class CIM_ResourceAllocationSettingData that describes the virtual aspects of a virtual resource to be added to the virtual system.
EmbeddedInstancestringCIM_ResourceAllocationSettingData
ResultingResourceSettingsCIM_ResourceAllocationSettingData[]
ArrayTypestringIndexed
DescriptionstringArray of references to instances of class CIM_ResourceAllocationSettingData representing virtual aspects of the added virtual resources.
Inbooleanfalse
Outbooleantrue
AffectedConfiguration REF CIM_VirtualSystemSettingData
DescriptionstringReference to the affected virtual system configuration.
Job REF CIM_ConcreteJob
DescriptionstringIf the operation is long running, then optionally a job may be returned. In this case, the instances of class CIM_ResourceAllocationSettingData representing the added resource settings are available via association CIM_ConreteComponent from the instance of class CIM_VirtualSystemSettingData representing the affected virtual system configuration.
Inbooleanfalse
Outbooleantrue

DefineSystem (uint32)

Method Qualifiers (DefineSystem)

NameData TypeValue
DescriptionstringDefines a virtual system. Input that is not completely specified may be filled out with default values.
ValueMapstring0, 1, 2, 3, 4, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Failed, Timeout, Invalid Parameter, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (DefineSystem)

NameTypeQualifiers
NameData TypeValue
SystemSettingsstring
DescriptionstringString containing an embedded instance of class CIM_VirtualSystemSettingData that is used to define attributes of the virtual system to be created.
EmbeddedInstancestringCIM_VirtualSystemSettingData
ResourceSettingsstring[]
ArrayTypestringIndexed
DescriptionstringArray of strings each containing an embedded instance of class CIM_ResourceAllocationSettingData that describes the virtual aspects of a virtual resource to be created in the scope of the new virtual system.
EmbeddedInstancestringCIM_ResourceAllocationSettingData
Job REF CIM_ConcreteJob
DescriptionstringIf the operation is long running, then optionally a job may be returned. In this case, the instance of class CIM_ComputerSystem representing the new virtual systemis presented via association CIM_AffectedJobElementwith property AffectedElement refering to the new instance of class CIM_ComputerSystem and property ElementEffects set to 5 (Create).
Inbooleanfalse
Outbooleantrue
ReferenceConfiguration REF CIM_VirtualSystemSettingData
DescriptionstringReference to an instance of class CIM_VirtualSystemSettingData object that is the top level object of a reference virtual system configuration. The reference configuration is used to complement the configuration of the new virtual system if parameters SystemSettings and ResourceSettings did not provide respective information.
ResultingSystem REF CIM_ComputerSystem
DescriptionstringIf a virtual computer system is successfully defined, a reference to an instance of class CIM_ComputerSystem that represents the newly defined virtual computer system is returned.
Inbooleanfalse
Outbooleantrue

DestroySystem (uint32)

Method Qualifiers (DestroySystem)

NameData TypeValue
DescriptionstringDestroys a virtual system. The referenced virtual system is destroyed, including any elements scoped by it. Virtual resources are returned to their resource pools, which may imply the destruction of those resources (implementation dependent). If the virtual system is active when the operation is invoked, it is first deactivated and then destroyed. If snapshots were created from the virtual system, these are destroyed as well.
ValueMapstring0, 1, 2, 3, 4, 5, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Failed, Timeout, Invalid Parameter, Invalid State, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (DestroySystem)

NameTypeQualifiers
NameData TypeValue
AffectedSystem REF CIM_ComputerSystem
DescriptionstringReference to an instance of class CIM_ComputerSystem representing the virtual computer system that it to be destroyed.
Job REF CIM_ConcreteJob
DescriptionstringIf the operation is long running, then optionally a job may be returned.
Inbooleanfalse
Outbooleantrue

ModifyResourceSettings (uint32)

Method Qualifiers (ModifyResourceSettings)

NameData TypeValue
DescriptionstringModifies virtual resource settings. When applied to parts of a "current" virtual system configuration, as a side effect resources of the active virtual system may be modified.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Failed, Timeout, Invalid Parameter, Invalid State, Incompatible Parameters, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (ModifyResourceSettings)

NameTypeQualifiers
NameData TypeValue
ResourceSettingsstring[]
ArrayTypestringIndexed
DescriptionstringArray of strings each containing an embedded instance of class CIM_ResourceAllocationSettingData that describes modifications to the virtual aspects of an existing virtual resource. All instances must have a valid InstanceID in order to identify the virtual resource setting to be modified.
EmbeddedInstancestringCIM_ResourceAllocationSettingData
ResultingResourceSettingsCIM_ResourceAllocationSettingData[]
ArrayTypestringIndexed
DescriptionstringArray of references to instances of class Cim_ResourceAllocationSettingData representing virtual aspects of the modified virtual resources.
Inbooleanfalse
Outbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringIf the operation is long running, then optionally a job be returned. In this case, the instances of class CIM_ResourceAllocationSettingData representing the modified resource settings are available via association CIM_ConreteComponent from the instance of class CIM_VirtualSystemSettingData representing the affected virtual system configuration.
Inbooleanfalse
Outbooleantrue

ModifySystemSettings (uint32)

Method Qualifiers (ModifySystemSettings)

NameData TypeValue
DescriptionstringModifies virtual system settings. When applied to the system settings of a "current" virtual system configuration, as a side effect the virtual system instance may be modified.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Failed, Timeout, Invalid Parameter, Invalid State, Incompatible Parameters, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (ModifySystemSettings)

NameTypeQualifiers
NameData TypeValue
SystemSettingsstring
DescriptionstringString containing an instance of class CIM_VirtualSystemSettingData that is used to modify the settings of the virtual system. The instance must have a valid InstanceID in order to identify the virtual system setting to be modified.
EmbeddedInstancestringCIM_VirtualSystemSettingData
Job REF CIM_ConcreteJob
DescriptionstringIf the operation is long running, then optionally a job may be returned.
Inbooleanfalse
Outbooleantrue

RemoveResourceSettings (uint32)

Method Qualifiers (RemoveResourceSettings)

NameData TypeValue
DescriptionstringRemoves virtual resource settings from a virtual system configuration. When applied to parts of a "current" virtual system configuration, as a side effect resources of the active virtual system may be removed.
ValueMapstring0, 1, 2, 3, 4, 5, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Failed, Timeout, Invalid Parameter, Invalid State, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (RemoveResourceSettings)

NameTypeQualifiers
NameData TypeValue
ResourceSettingsCIM_ResourceAllocationSettingData[]
DescriptionstringArray of references to instances of class CIM_ResourceAllocationSettingData where each instance represents the settings of a virtual resource within a virtual system configuration that are to be removed.
Job REF CIM_ConcreteJob
DescriptionstringIf the operation is long running, then optionally a job my be returned.
Inbooleanfalse
Outbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service