Represents the virtual system migration service. It is used for migrating a virtual system or for migration the storage of a virtual system from one virtualization platform to another.
Msvm_VirtualSystemMigrationService methods
Msvm_VirtualSystemMigrationService has 15 methods (8 Local, 7 Derived)
{'Description':'An optional parameter for monitoring progress of the operation, which is used if the method could not be executed synchronously. If the operation is executing asynchronously, the return value is 4096.','Out':True}
Bypass_GetObject
True
Description
'Adds migration network subnets for virtual system migration service.'
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
AddNetworkSettings method is in 1 class (Msvm_VirtualSystemMigrationService) of ROOT\virtualization\v2 and in 2 namespaces
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'Not compatible']
CheckSystemCompatibilityInfo method is in 1 class (Msvm_VirtualSystemMigrationService) of ROOT\virtualization\v2 and in 2 namespaces
['Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
CheckVirtualSystemIsMigratable method is in 1 class (Msvm_VirtualSystemMigrationService) of ROOT\virtualization\v2 and in 2 namespaces
{'Description':'A reference to a CIM_ComputerSystem class that represents the VM to retrieve compatibility information. If the ComputerSystem parameter refers to the hosting computer system, the data returned in the CompatibilityInfo parameter can be used to determine whether any of the VMs on the hosting computer system can be quickly migrated to another hosting computer system.','In':True}
CompatibilityInfo
uint8
1
-
✓
{'ArrayType':'Indexed','Description':'An opaque blob of data that can be passed to the CheckSystemCompatibilityInfo method on another hosting computer system to confirm compatibility.','OctetString':True,'Out':True}
Bypass_GetObject
True
Description
'Generates an opaque blob of data containing compatibility information for the specified system. Remarks: The GetSystemCompatibilityInfo method is used in conjunction with CheckSystemCompatibilityInfo to determine whether a quick or live migration of a VM to another hosting computer system is possible without first trying the migration. The compatibility information is dependent on the current EnabledState property of the system specified in the ComputerSystem parameter. In addition, the compatibility informationfor a VM may change when a snapshot is applied or the system is restarted. A VM in the Disabled state (EnabledState property value of 3) is compatible with more systems than one in the Suspended or Enabled states (EnabledState property value of 32769 or 2).'
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
GetSystemCompatibilityInfo method is in 1 class (Msvm_VirtualSystemMigrationService) of ROOT\virtualization\v2 and in 2 namespaces
{'Description':'A reference to a CIM_ComputerSystem class that represents the VM to retrieve compatibility vectors. If the ComputerSystem parameter refers to the hosting computer system, the data returned in the CompatibilityInfo parameter can be used to determine whether any of the VMs on the hosting computer system can be quickly migrated to another hosting computer system.','In':True}
{'ArrayType':'Indexed','Description':'An array of Msvm_CompatibilityVector instances containing the compatibility information for the virtual machines or hosting computer system.','Out':True}
Bypass_GetObject
True
Description
'Returns a list of Msvm_CompatibilityVector instances that can be used to check for VM to host compatibility.'
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
GetSystemCompatibilityVectors method is in 1 class (Msvm_VirtualSystemMigrationService) of ROOT\virtualization\v2 and in 2 namespaces
{'Description':'An optional parameter for monitoring progress of the operation, which is used if the method could not be executed synchronously. If the operation is executing asynchronously, the return value is 4096.','Out':True}
Bypass_GetObject
True
Description
'Modifies migration network subnets of virtual system migration service.'
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
ModifyNetworkSettings method is in 1 class (Msvm_VirtualSystemMigrationService) of ROOT\virtualization\v2 and in 2 namespaces
{'Description':'An optional parameter for monitoring progress of the operation, which is used if the method could not be executed synchronously. If the operation is executing asynchronously, the return value is 4096.','Out':True}
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
{'Description':'An optional parameter for monitoring progress of the operation, which is used if the method could not be executed synchronously. If the operation is executing asynchronously, the return value is 4096.','Out':True}
Bypass_GetObject
True
Description
'Removes migration network subnets from virtual system migration service.'
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
RemoveNetworkSettings method is in 1 class (Msvm_VirtualSystemMigrationService) of ROOT\virtualization\v2 and in 2 namespaces
Derived methods (7) of Msvm_VirtualSystemMigrationService class
{'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':'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':'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}
['Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
{'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':'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.'}
'Represents the virtual system migration service. It is used for migrating a virtual system or for migration the storage of a virtual system from one virtualization platform to another.'
✗
✗
✓
✓
✓
dynamic
True
✓
✗
✓
✗
✓
Locale
1033
✗
✗
✓
✓
✓
provider
'VmmsWmiInstanceAndMethodProvider'
✗
✗
✓
✗
✓
Msvm_VirtualSystemMigrationService System properties