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

NameData TypeValue
DescriptionstringService to control the migration of virtual systems between host systems, including pre-checking to determine if an intended migration operation is likely to succeed.
Experimentalbooleantrue
UMLPackagePathstringCIM::System::Virtualization
Versionstring2.17.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

MigrateVirtualSystemToHost (uint32)

Method Qualifiers (MigrateVirtualSystemToHost)

NameData TypeValue
DescriptionstringMethod 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.
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 (MigrateVirtualSystemToHost)

NameTypeQualifiers
NameData TypeValue
DestinationHoststring
DescriptionstringTarget 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.
Inbooleantrue
ModelCorrespondencestringCIM_VirtualSystemMigrationCapabilities.DestinationHostFormatsSupported
MigrationSettingDatastring
DescriptionstringString containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.
EmbeddedInstancestringCIM_VirtualSystemMigrationSettingData
Inbooleantrue
NewSystemSettingDatastring
DescriptionstringString containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.
EmbeddedInstancestringCIM_VirtualSystemSettingData
Inbooleantrue
NewResourceSettingDatastring[]
ArrayTypestringIndexed
DescriptionstringArray 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.
EmbeddedInstancestringCIM_ResourceAllocationSettingData
Inbooleantrue
ComputerSystem REF CIM_ComputerSystem
DescriptionstringSource virtual computer system to be migrated.
Inbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringIf operation is long running then optionally a job may be returned.
Inbooleanfalse
Outbooleantrue

MigrateVirtualSystemToSystem (uint32)

Method Qualifiers (MigrateVirtualSystemToSystem)

NameData TypeValue
DescriptionstringMethod 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.
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 (MigrateVirtualSystemToSystem)

NameTypeQualifiers
NameData TypeValue
MigrationSettingDatastring
DescriptionstringString containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.
EmbeddedInstancestringCIM_VirtualSystemMigrationSettingData
Inbooleantrue
NewSystemSettingDatastring
DescriptionstringString containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.
EmbeddedInstancestringCIM_VirtualSystemSettingData
Inbooleantrue
NewResourceSettingDatastring[]
ArrayTypestringIndexed
DescriptionstringArray 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.
EmbeddedInstancestringCIM_ResourceAllocationSettingData
Inbooleantrue
ComputerSystem REF CIM_ComputerSystem
DescriptionstringSource virtual computer system to be migrated.
Inbooleantrue
DestinationSystem REF CIM_System
DescriptionstringDestination host system whereto migrate the virtual system.
Inbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringIf operation is long running then optionally a job may be returned.
Inbooleanfalse
Outbooleantrue
NewComputerSystem REF CIM_ComputerSystem
DescriptionstringReference to an instance of the CIM_ComputerSystem class representing the virtual computer system after it has been migrated.
Inbooleanfalse
Outbooleantrue

CheckVirtualSystemIsMigratableToHost (uint32)

Method Qualifiers (CheckVirtualSystemIsMigratableToHost)

NameData TypeValue
DescriptionstringMethod 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Failed, Timeout, Invalid Parameter, Invalid State, Incompatible Parameters, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (CheckVirtualSystemIsMigratableToHost)

NameTypeQualifiers
NameData TypeValue
DestinationHoststring
DescriptionstringTarget 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.
Inbooleantrue
ModelCorrespondencestringCIM_VirtualSystemMigrationCapabilities.DestinationHostFormatsSupported
IsMigratableboolean
DescriptionstringThe migration check result indicating whether or not the virtual system can be successfully migrated.
Inbooleanfalse
Outbooleantrue
MigrationSettingDatastring
DescriptionstringString containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.
EmbeddedInstancestringCIM_VirtualSystemMigrationSettingData
Inbooleantrue
NewSystemSettingDatastring
DescriptionstringString containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.
EmbeddedInstancestringCIM_VirtualSystemSettingData
Inbooleantrue
NewResourceSettingDatastring[]
ArrayTypestringIndexed
DescriptionstringArray 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.
EmbeddedInstancestringCIM_ResourceAllocationSettingData
Inbooleantrue
ComputerSystem REF CIM_ComputerSystem
DescriptionstringSource virtual computer system to be migrated.
Inbooleantrue

CheckVirtualSystemIsMigratableToSystem (uint32)

Method Qualifiers (CheckVirtualSystemIsMigratableToSystem)

NameData TypeValue
DescriptionstringMethod 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Failed, Timeout, Invalid Parameter, Invalid State, Incompatible Parameters, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (CheckVirtualSystemIsMigratableToSystem)

NameTypeQualifiers
NameData TypeValue
IsMigratableboolean
DescriptionstringThe migration check result indicating whether or not the virtual system can be successfully migrated.
Inbooleanfalse
Outbooleantrue
MigrationSettingDatastring
DescriptionstringString containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.
EmbeddedInstancestringCIM_VirtualSystemMigrationSettingData
Inbooleantrue
NewSystemSettingDatastring
DescriptionstringString containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.
EmbeddedInstancestringCIM_VirtualSystemSettingData
Inbooleantrue
NewResourceSettingDatastring[]
ArrayTypestringIndexed
DescriptionstringArray 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.
EmbeddedInstancestringCIM_ResourceAllocationSettingData
Inbooleantrue
ComputerSystem REF CIM_ComputerSystem
DescriptionstringSource virtual computer system to be migrated.
Inbooleantrue
DestinationSystem REF CIM_System
DescriptionstringDestination system onto which to migrate the virtual system.
Inbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service