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.
CIM_VirtualSystemMigrationService - child subclasses in ROOT\virtualization\v2
{'Description':'Source virtual computer system to be migrated.','In':True}
DestinationHost
string
1
✓
-
{'Description':'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':True,'ModelCorrespondence':['CIM_VirtualSystemMigrationCapabilities.DestinationHostFormatsSupported']}
MigrationSettingData
string
2
✓
-
{'Description':'String containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.','HyperVEmbeddedInstance':'CIM_VirtualSystemMigrationSettingData','In':True}
NewSystemSettingData
string
3
✓
-
{'Description':'String containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.','HyperVEmbeddedInstance':'CIM_VirtualSystemSettingData','In':True}
NewResourceSettingData
string
4
✓
-
{'ArrayType':'Indexed','Description':'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.','HyperVEmbeddedInstance':'CIM_ResourceAllocationSettingData','In':True}
IsMigratable
boolean
5
-
✓
{'Description':'The migration check result indicating whether or not the virtual system can be successfully migrated.','Out':True}
Description
'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.'
{'Description':'Destination system onto which to migrate the virtual system.','In':True}
MigrationSettingData
string
2
✓
-
{'Description':'String containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.','HyperVEmbeddedInstance':'CIM_VirtualSystemMigrationSettingData','In':True}
NewSystemSettingData
string
3
✓
-
{'Description':'String containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.','HyperVEmbeddedInstance':'CIM_VirtualSystemSettingData','In':True}
NewResourceSettingData
string
4
✓
-
{'ArrayType':'Indexed','Description':'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.','HyperVEmbeddedInstance':'CIM_ResourceAllocationSettingData','In':True}
IsMigratable
boolean
5
-
✓
{'Description':'The migration check result indicating whether or not the virtual system can be successfully migrated.','Out':True}
Description
'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.'
{'Description':'Source virtual computer system to be migrated.','In':True}
DestinationHost
string
1
✓
-
{'Description':'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':True,'ModelCorrespondence':['CIM_VirtualSystemMigrationCapabilities.DestinationHostFormatsSupported']}
MigrationSettingData
string
2
✓
-
{'Description':'String containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.','HyperVEmbeddedInstance':'CIM_VirtualSystemMigrationSettingData','In':True}
NewSystemSettingData
string
3
✓
-
{'Description':'String containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.','HyperVEmbeddedInstance':'CIM_VirtualSystemSettingData','In':True}
NewResourceSettingData
string
4
✓
-
{'ArrayType':'Indexed','Description':'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.','HyperVEmbeddedInstance':'CIM_ResourceAllocationSettingData','In':True}
{'Description':'If operation is long running then optionally a job may be returned.','Out':True}
Description
'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.'
{'Description':'Destination host system whereto migrate the virtual system.','In':True}
MigrationSettingData
string
2
✓
-
{'Description':'String containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.','HyperVEmbeddedInstance':'CIM_VirtualSystemMigrationSettingData','In':True}
NewSystemSettingData
string
3
✓
-
{'Description':'String containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.','HyperVEmbeddedInstance':'CIM_VirtualSystemSettingData','In':True}
NewResourceSettingData
string
4
✓
-
{'ArrayType':'Indexed','Description':'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.','HyperVEmbeddedInstance':'CIM_ResourceAllocationSettingData','In':True}
{'Description':'Reference to an instance of the CIM_ComputerSystem class representing the virtual computer system after it has been migrated.','Out':True}
{'Description':'If operation is long running then optionally a job may be returned.','Out':True}
Description
'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.'
{'Description':'The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.','ModelCorrespondence':['CIM_EnabledLogicalElement.RequestedState'],'ValueMap':['2', '3', '4', '6', '7', '8', '9', '10', '11', '..', '32768..65535'],'Values':['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved', 'Vendor Reserved']}
{'Description':'May contain a reference to the ConcreteJob created to track the state transition initiated by the method invocation.'}
TimeoutPeriod
datetime
2
✓
-
{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' shall be returned.'}
'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
True
✗
✗
✓
✗
✓
LOCALE
1033
✗
✗
✓
✓
✓
UMLPackagePath
'CIM::System::Virtualization'
✗
✗
✓
✗
✓
Version
'2.17.0'
✗
✗
✓
✗
✓
CIM_VirtualSystemMigrationService System properties