# 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

Name | Data Type | Value
--- | --- | ---
Description | string | Service to define and manipulate virtual systems and their components
UMLPackagePath | string | CIM::Core::Virtualization
Version | string | 2.22.0

## Class Properties

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_Service
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
Name | string | CIM_Service
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryOwnerContact | string | CIM_Service
PrimaryOwnerName | string | CIM_Service
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Started | boolean | CIM_Service
StartMode | string | CIM_Service
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_Service
SystemName | string | CIM_Service
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### AddResourceSettings (uint32)

#### Method Qualifiers (AddResourceSettings)

Name | Data Type | Value
--- | --- | ---
Description | string | Adds 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.
ValueMap | string | 0, 1, 2, 3, 4, .., 4096, 4097..32767, 32768..65535
Values | string | Completed with No Error, Not Supported, Failed, Timeout, Invalid Parameter, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

#### Method Parameters (AddResourceSettings)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ResourceSettings | string[]
ArrayType | string | Indexed
Description | string | Array 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.
EmbeddedInstance | string | CIM_ResourceAllocationSettingData
ResultingResourceSettings | CIM_ResourceAllocationSettingData[]
ArrayType | string | Indexed
Description | string | Array of references to instances of class CIM_ResourceAllocationSettingData representing virtual aspects of the added virtual resources.
In | boolean | false
Out | boolean | true
AffectedConfiguration | REF CIM_VirtualSystemSettingData
Description | string | Reference to the affected virtual system configuration.
Job | REF CIM_ConcreteJob
Description | string | If 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.
In | boolean | false
Out | boolean | true

#### DefineSystem (uint32)

#### Method Qualifiers (DefineSystem)

Name | Data Type | Value
--- | --- | ---
Description | string | Defines a virtual system. Input that is not completely specified may be filled out with default values.
ValueMap | string | 0, 1, 2, 3, 4, .., 4096, 4097..32767, 32768..65535
Values | string | Completed with No Error, Not Supported, Failed, Timeout, Invalid Parameter, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

#### Method Parameters (DefineSystem)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
SystemSettings | string
Description | string | String containing an embedded instance of class CIM_VirtualSystemSettingData that is used to define attributes of the virtual system to be created.
EmbeddedInstance | string | CIM_VirtualSystemSettingData
ResourceSettings | string[]
ArrayType | string | Indexed
Description | string | Array 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.
EmbeddedInstance | string | CIM_ResourceAllocationSettingData
Job | REF CIM_ConcreteJob
Description | string | If 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).
In | boolean | false
Out | boolean | true
ReferenceConfiguration | REF CIM_VirtualSystemSettingData
Description | string | Reference 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
Description | string | If 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.
In | boolean | false
Out | boolean | true

#### DestroySystem (uint32)

#### Method Qualifiers (DestroySystem)

Name | Data Type | Value
--- | --- | ---

Description

string

Destroys 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.

ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4096, 4097..32767, 32768..65535
Values | string | Completed 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
AffectedSystem | REF CIM_ComputerSystem
Description | string | Reference to an instance of class CIM_ComputerSystem representing the virtual computer system that it to be destroyed.
Job | REF CIM_ConcreteJob
Description | string | If the operation is long running, then optionally a job may be returned.
In | boolean | false
Out | boolean | true

#### ModifyResourceSettings (uint32)

#### Method Qualifiers (ModifyResourceSettings)

Name | Data Type | Value
--- | --- | ---
Description | string | Modifies 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
Values | string | Completed 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ResourceSettings | string[]
ArrayType | string | Indexed
Description | string | Array 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.
EmbeddedInstance | string | CIM_ResourceAllocationSettingData
ResultingResourceSettings | CIM_ResourceAllocationSettingData[]
ArrayType | string | Indexed
Description | string | Array of references to instances of class Cim_ResourceAllocationSettingData representing virtual aspects of the modified virtual resources.
In | boolean | false
Out | boolean | true
Job | REF CIM_ConcreteJob
Description | string | If 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.
In | boolean | false
Out | boolean | true

#### ModifySystemSettings (uint32)

#### Method Qualifiers (ModifySystemSettings)

Name | Data Type | Value
--- | --- | ---
Description | string | Modifies 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
Values | string | Completed 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
SystemSettings | string
Description | string | String 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.
EmbeddedInstance | string | CIM_VirtualSystemSettingData
Job | REF CIM_ConcreteJob
Description | string | If the operation is long running, then optionally a job may be returned.
In | boolean | false
Out | boolean | true

#### RemoveResourceSettings (uint32)

#### Method Qualifiers (RemoveResourceSettings)

Name | Data Type | Value
--- | --- | ---
Description | string | Removes 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4096, 4097..32767, 32768..65535
Values | string | Completed 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ResourceSettings | CIM_ResourceAllocationSettingData[]
Description | string | Array 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
Description | string | If the operation is long running, then optionally a job my be returned.
In | boolean | false
Out | boolean | true

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
RequestStateChange | uint32 | CIM_EnabledLogicalElement
StartService | uint32 | CIM_Service
StopService | uint32 | CIM_Service