# Class CIM_VirtualSystemMigrationService
extends CIM_Service

Service to control the migration of virtual systems between host systems, including pre-checking to determine if an intended migration operation is likely to succeed.

### 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_VirtualSystemMigrationService

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | Service to control the migration of virtual systems between host systems, including pre-checking to determine if an intended migration operation is likely to succeed.
Experimental | boolean | true
UMLPackagePath | string | CIM::System::Virtualization
Version | string | 2.17.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
Generation | uint64 | CIM_ManagedElement
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

#### MigrateVirtualSystemToHost (uint32)

#### Method Qualifiers (MigrateVirtualSystemToHost)

Name | Data Type | Value
--- | --- | ---
Description | string | Method to move, migrate or relocate a virtual system to a target host specified by a network name or IP address. Return code description: 0: Success: Virtual system was migrated. 1: Error: Method not supported by implementation. 2: Error: Virtual system migration failed for unspecified reasons. 3: Error: Virtual system migration time out; the virtual system state is unknown. 4: Error: One or more parameters are formally invalid. For example, the value of the DestinationHost parameter could have been specified in an unsupported format. 5: Error: The source virtual system, the source host system or the target host system are in a state that does allow initiation of the requested virtual system migration; this may be a temporary condition. 6: Error: One or more input parameters are incompatible as a set, or with respect to the target host. For example the value of the MigrationNewSettingData parameter contains properties that are not supported by the target host system identified by the value of the DestinationHost parameter. Note: The MigrateVirtualSystemToHost( ) methods is intended as a transitional solution only until modelling of cluster support is available.
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 (MigrateVirtualSystemToHost)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
DestinationHost | string
Description | string | Target host system for the migration. Acceptable formats for this parameter are conveyed through values of elements of the DestinationHostFormatsSupported[ ] array property in the instance of the CIM_VirtualSystemMigrationCapabilities that is associated through the CIM_ElementCapabilities assocation.
In | boolean | true
ModelCorrespondence | string | CIM_VirtualSystemMigrationCapabilities.DestinationHostFormatsSupported
MigrationSettingData | string
Description | string | String containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.
EmbeddedInstance | string | CIM_VirtualSystemMigrationSettingData
In | boolean | true
NewSystemSettingData | string
Description | string | String containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.
EmbeddedInstance | string | CIM_VirtualSystemSettingData
In | boolean | true
NewResourceSettingData | string[]
ArrayType | string | Indexed
Description | string | Array of strings each containing an embedded instance of the CIM_ResourceAllocationSettingData class representing new properties applicable to virtual resources in the scope of the virtual system after it is migrated.
EmbeddedInstance | string | CIM_ResourceAllocationSettingData
In | boolean | true
ComputerSystem | REF CIM_ComputerSystem
Description | string | Source virtual computer system to be migrated.
In | boolean | true
Job | REF CIM_ConcreteJob
Description | string | If operation is long running then optionally a job may be returned.
In | boolean | false
Out | boolean | true

#### MigrateVirtualSystemToSystem (uint32)

#### Method Qualifiers (MigrateVirtualSystemToSystem)

Name | Data Type | Value
--- | --- | ---
Description | string | Method to move, migrate or relocate a virtual system to a target system. Return code description: 0: Success: Virtual system was migrated 1: Error: Method not supported by implementation 2: Error: Virtual system migration failed for unspecified reasons 3: Error: Virtual system migration time out; the virtual system state is unknown 4: Error: One or more parameters are formally invalid For example, the value of the Destination System parameter does not contain a valid object path 5: Error: The source virtual system, the source host system or the target host system are in a state that does allow initiation of the requested virtual system migration; this may be a temporary condition. 6: Error: One or more input parameters are incompatible as a set, or with respect to the target host. For example the value of the MigrationNewSettingData parameter contains properties that are not supported by the target host system identified by the value of the DestinationSystem parameter.
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 (MigrateVirtualSystemToSystem)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
MigrationSettingData | string
Description | string | String containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.
EmbeddedInstance | string | CIM_VirtualSystemMigrationSettingData
In | boolean | true
NewSystemSettingData | string
Description | string | String containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.
EmbeddedInstance | string | CIM_VirtualSystemSettingData
In | boolean | true
NewResourceSettingData | string[]
ArrayType | string | Indexed
Description | string | Array of strings each containing an embedded instance of the CIM_ResourceAllocationSettingData class representing new properties applicable to virtual resources in the scope of the virtual system after it is migrated.
EmbeddedInstance | string | CIM_ResourceAllocationSettingData
In | boolean | true
ComputerSystem | REF CIM_ComputerSystem
Description | string | Source virtual computer system to be migrated.
In | boolean | true
DestinationSystem | REF CIM_System
Description | string | Destination host system whereto migrate the virtual system.
In | boolean | true
Job | REF CIM_ConcreteJob
Description | string | If operation is long running then optionally a job may be returned.
In | boolean | false
Out | boolean | true
NewComputerSystem | REF CIM_ComputerSystem
Description | string | Reference to an instance of the CIM_ComputerSystem class representing the virtual computer system after it has been migrated.
In | boolean | false
Out | boolean | true

#### CheckVirtualSystemIsMigratableToHost (uint32)

#### Method Qualifiers (CheckVirtualSystemIsMigratableToHost)

Name | Data Type | Value
--- | --- | ---
Description | string | Method to perform a pre-check to determine whether a virtual system is likely to be successfully migrated to a target host specified by a network name or IP address. This method does not guarantee that a subsequent migration will always succeed, due to dynamic resource availability. Return code description: 0: Success: Check performed; result reported through the value of the [Out] IsMigratable parameter. 1: Error: Method not supported by implementation. No result reported through the value of the [Out] IsMigratable parameter. 2: Error: Check failed for unspecified reasons. No result reported through the value of the [Out] IsMigratable parameter. 3: Error: Check timed out. No result reported through the value of the [Out] IsMigratable parameter. 4: Error: One or more parameters are formally invalid. For example, the value of the DestinationHost parameter could have been specified in an unsupported format. No result reported through the value of the [Out] IsMigratable parameter. 5: Error: The source virtual system, the source host system or the target host system are in a state that does allow initiation of the requested virtual system migration; this may be a temporary condition. No result reported reported through the value of the [Out] IsMigratable parameter. 6: Error: One or more input parameters are incompatible as a set, or with respect to the target host. For example the value of the MigrationNewSettingData parameter contains properties that are not supported by the target host system identified by the value of the DestinationHost parameter. No result reported through the value of the [Out] IsMigratable parameter. Note: The CheckVirtualSystemIsMigratableToHost( ) method is intended as a transitional solution only until modelling of cluster support is available.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, .., 4097..32767, 32768..65535
Values | string | Completed with No Error, Not Supported, Failed, Timeout, Invalid Parameter, Invalid State, Incompatible Parameters, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (CheckVirtualSystemIsMigratableToHost)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
DestinationHost | string
Description | string | Target host system for the migration. Acceptable formats for this parameter are conveyed through values of elements of the DestinationHostFormatsSupported[ ] array property in the instance of the CIM_VirtualSystemMigrationCapabilities that is associated through the CIM_ElementCapabilities assocation.
In | boolean | true
ModelCorrespondence | string | CIM_VirtualSystemMigrationCapabilities.DestinationHostFormatsSupported
IsMigratable | boolean
Description | string | The migration check result indicating whether or not the virtual system can be successfully migrated.
In | boolean | false
Out | boolean | true
MigrationSettingData | string
Description | string | String containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.
EmbeddedInstance | string | CIM_VirtualSystemMigrationSettingData
In | boolean | true
NewSystemSettingData | string
Description | string | String containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.
EmbeddedInstance | string | CIM_VirtualSystemSettingData
In | boolean | true
NewResourceSettingData | string[]
ArrayType | string | Indexed
Description | string | Array of strings each containing an embedded instance of the CIM_ResourceAllocationSettingData class representing new properties applicable to virtual resources in the scope of the virtual system after it is migrated.
EmbeddedInstance | string | CIM_ResourceAllocationSettingData
In | boolean | true
ComputerSystem | REF CIM_ComputerSystem
Description | string | Source virtual computer system to be migrated.
In | boolean | true

#### CheckVirtualSystemIsMigratableToSystem (uint32)

#### Method Qualifiers (CheckVirtualSystemIsMigratableToSystem)

Name | Data Type | Value
--- | --- | ---
Description | string | Method to perform a pre-check to determine whether a virtual system is likely to be successfully migrated to a target system. This method does not guarantee that a subsequent migration will always succeed, due to dynamic resource availability. Return code description: 0: Success: Check performed; result reported through the value of the [Out] IsMigratable parameter. 1: Error: Method not supported by implementation. No result reported through the value of the [Out] IsMigratable parameter. 2: Error: Check failed for unspecified reasons. No result reported through the value of the [Out] IsMigratable parameter. 3: Error: Check timed out. No result reported through the value of the [Out] IsMigratable parameter. 4: Error: One or more parameters are formally invalid. For example, the value of the DestinationSystem parameter does not comprise a valid object path. No result reported through the value of the [Out] IsMigratable parameter. 5: Error: The source virtual system, the source host system or the target host system are in a state that does allow initiation of the requested virtual system migration; this may be a temporary condition. No result reported reported through the value of the [Out] IsMigratable parameter. 6: Error: One or more input parameters are incompatible as a set, or with respect to the target host. For example the value of the NewSettingData parameter contains properties that are not supported by the target host system identified by the value of the DestinationSystem parameter. No result reported through the value of the [Out] IsMigratable parameter.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, .., 4097..32767, 32768..65535
Values | string | Completed with No Error, Not Supported, Failed, Timeout, Invalid Parameter, Invalid State, Incompatible Parameters, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (CheckVirtualSystemIsMigratableToSystem)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
IsMigratable | boolean
Description | string | The migration check result indicating whether or not the virtual system can be successfully migrated.
In | boolean | false
Out | boolean | true
MigrationSettingData | string
Description | string | String containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.
EmbeddedInstance | string | CIM_VirtualSystemMigrationSettingData
In | boolean | true
NewSystemSettingData | string
Description | string | String containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.
EmbeddedInstance | string | CIM_VirtualSystemSettingData
In | boolean | true
NewResourceSettingData | string[]
ArrayType | string | Indexed
Description | string | Array of strings each containing an embedded instance of the CIM_ResourceAllocationSettingData class representing new properties applicable to virtual resources in the scope of the virtual system after it is migrated.
EmbeddedInstance | string | CIM_ResourceAllocationSettingData
In | boolean | true
ComputerSystem | REF CIM_ComputerSystem
Description | string | Source virtual computer system to be migrated.
In | boolean | true
DestinationSystem | REF CIM_System
Description | string | Destination system onto which to migrate the virtual system.
In | boolean | true

### Inherited Class Methods

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