<head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="mof.css" xmlns:lxslt="http://xml.apache.org/xslt"> <title>DMTF Schema Documentation Schema Documentation</title> </head><html> <body bgcolor="White"> <hr> </hr> <a name="CIM_VirtualSystemMigrationService"></a> <H1>Class CIM_VirtualSystemMigrationService<BR>extends <a href="CIM_Service.html">CIM_Service</a> </H1>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.<h3> Table of Contents<br> <a href="#c_hierarchy">Hierarchy</a> <br> <a href="#c_subclasses">Direct Known Subclasses</a> <br> <a href="#c_qualifiers">Class Qualifiers</a> <br> <a href="#c_properties">Class Properties</a> <br> <a href="#c_methods">Class Methods</a> <br> </h3> <hr> </hr> <H2> <a name="c_hierarchy">Class Hierarchy</a> </H2> <a href="CIM_ManagedElement.html">CIM_ManagedElement</a> <br data="@NAME"> |<br> +--<a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a> <br data="@NAME"> |<br> +--<a href="CIM_LogicalElement.html">CIM_LogicalElement</a> <br data="@NAME"> |<br> +--<a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a> <br data="@NAME"> |<br> +--<a href="CIM_Service.html">CIM_Service</a> <br data="@NAME"> |<br> +--<b>CIM_VirtualSystemMigrationService</b> <br data="CIM_VirtualSystemMigrationService -- CIM_Service"> <H2> <a name="c_subclasses">Direct Known Subclasses</a> </H2> <H2> <a name="c_qualifiers">Class Qualifiers</a> </H2> <TABLE BORDER="1" CELLPADDING="1" WIDTH="100%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD> </TR> <TR> <TD VALIGN="TOP">Experimental</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TD VALIGN="TOP">UMLPackagePath</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM::System::Virtualization</TD> </TR> <TR> <TD VALIGN="TOP">Version</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">2.17.0</TD> </TR> </TABLE> <H2> <a name="c_properties">Class Properties</a> </H2> <H3>Inherited Properties</H3> <TABLE BORDER="1" CELLPADDING="1" WIDTH="60%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Class Origin</TH> </TR> <TR> <TH VALIGN="TOP">Caption</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">CommunicationStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">CreationClassName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">Description</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">DetailedStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">ElementName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">EnabledDefault</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">EnabledState</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">Generation</TH><TD VALIGN="TOP">uint64</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">HealthState</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">InstallDate</TH><TD VALIGN="TOP">datetime</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">InstanceID</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">Name</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">OperatingStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">OtherEnabledState</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">PrimaryOwnerContact</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">PrimaryOwnerName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">PrimaryStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">RequestedState</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">Started</TH><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">StartMode</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">Status</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">SystemCreationClassName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">SystemName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">TimeOfLastStateChange</TH><TD VALIGN="TOP">datetime</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">TransitioningToState</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">AvailableRequestedStates</TH><TD VALIGN="TOP">uint16[]</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">OperationalStatus</TH><TD VALIGN="TOP">uint16[]</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">StatusDescriptions</TH><TD VALIGN="TOP">string[]</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> </TABLE> <h2> <a name="c_methods">Class Methods</a> </h2> <H3>Local Class Methods</H3> <h4>MigrateVirtualSystemToHost (uint32)</h4> <h4>Method Qualifiers (MigrateVirtualSystemToHost)</h4> <TABLE BORDER="1" CELLPADDING="1" WIDTH="100%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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</TD> </TR> </TABLE> <h4>Method Parameters (MigrateVirtualSystemToHost)</h4> <TABLE WIDTH="100%" CELLPADDING="1" BORDER="1"> <TR> <TH ROWSPAN="2"><B>Name</B></TH><TH ROWSPAN="2"><B>Type</B></TH><TH COLSPAN="5"><B>Qualifiers</B></TH> </TR> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">DestinationHost</TH><TD ROWSPAN="4" VALIGN="TOP">string</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_VirtualSystemMigrationCapabilities.DestinationHostFormatsSupported</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">MigrationSettingData</TH><TD ROWSPAN="4" VALIGN="TOP">string</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">String containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.</TD> </TR> <TR> <TD VALIGN="TOP">EmbeddedInstance</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_VirtualSystemMigrationSettingData</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">NewSystemSettingData</TH><TD ROWSPAN="4" VALIGN="TOP">string</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">String containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.</TD> </TR> <TR> <TD VALIGN="TOP">EmbeddedInstance</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_VirtualSystemSettingData</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="5" VALIGN="TOP">NewResourceSettingData</TH><TD ROWSPAN="5" VALIGN="TOP">string[]</TD> </TR> <TR> <TD VALIGN="TOP">ArrayType</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Indexed</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD> </TR> <TR> <TD VALIGN="TOP">EmbeddedInstance</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_ResourceAllocationSettingData</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="3" VALIGN="TOP">ComputerSystem</TH><TD ROWSPAN="3" VALIGN="TOP"> REF <a href="CIM_ComputerSystem.html">CIM_ComputerSystem</a></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Source virtual computer system to be migrated.</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">Job</TH><TD ROWSPAN="4" VALIGN="TOP"> REF <a href="CIM_ConcreteJob.html">CIM_ConcreteJob</a></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">If operation is long running then optionally a job may be returned.</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">false</TD> </TR> <TR> <TD VALIGN="TOP">Out</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> </TABLE> <h4>MigrateVirtualSystemToSystem (uint32)</h4> <h4>Method Qualifiers (MigrateVirtualSystemToSystem)</h4> <TABLE BORDER="1" CELLPADDING="1" WIDTH="100%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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</TD> </TR> </TABLE> <h4>Method Parameters (MigrateVirtualSystemToSystem)</h4> <TABLE WIDTH="100%" CELLPADDING="1" BORDER="1"> <TR> <TH ROWSPAN="2"><B>Name</B></TH><TH ROWSPAN="2"><B>Type</B></TH><TH COLSPAN="5"><B>Qualifiers</B></TH> </TR> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">MigrationSettingData</TH><TD ROWSPAN="4" VALIGN="TOP">string</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">String containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.</TD> </TR> <TR> <TD VALIGN="TOP">EmbeddedInstance</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_VirtualSystemMigrationSettingData</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">NewSystemSettingData</TH><TD ROWSPAN="4" VALIGN="TOP">string</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">String containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.</TD> </TR> <TR> <TD VALIGN="TOP">EmbeddedInstance</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_VirtualSystemSettingData</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="5" VALIGN="TOP">NewResourceSettingData</TH><TD ROWSPAN="5" VALIGN="TOP">string[]</TD> </TR> <TR> <TD VALIGN="TOP">ArrayType</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Indexed</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD> </TR> <TR> <TD VALIGN="TOP">EmbeddedInstance</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_ResourceAllocationSettingData</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="3" VALIGN="TOP">ComputerSystem</TH><TD ROWSPAN="3" VALIGN="TOP"> REF <a href="CIM_ComputerSystem.html">CIM_ComputerSystem</a></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Source virtual computer system to be migrated.</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="3" VALIGN="TOP">DestinationSystem</TH><TD ROWSPAN="3" VALIGN="TOP"> REF <a href="CIM_System.html">CIM_System</a></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Destination host system whereto migrate the virtual system.</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">Job</TH><TD ROWSPAN="4" VALIGN="TOP"> REF <a href="CIM_ConcreteJob.html">CIM_ConcreteJob</a></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">If operation is long running then optionally a job may be returned.</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">false</TD> </TR> <TR> <TD VALIGN="TOP">Out</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">NewComputerSystem</TH><TD ROWSPAN="4" VALIGN="TOP"> REF <a href="CIM_ComputerSystem.html">CIM_ComputerSystem</a></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Reference to an instance of the CIM_ComputerSystem class representing the virtual computer system after it has been migrated.</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">false</TD> </TR> <TR> <TD VALIGN="TOP">Out</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> </TABLE> <h4>CheckVirtualSystemIsMigratableToHost (uint32)</h4> <h4>Method Qualifiers (CheckVirtualSystemIsMigratableToHost)</h4> <TABLE BORDER="1" CELLPADDING="1" WIDTH="100%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">0, 1, 2, 3, 4, 5, 6, .., 4097..32767, 32768..65535</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Completed with No Error, Not Supported, Failed, Timeout, Invalid Parameter, Invalid State, Incompatible Parameters, DMTF Reserved, Method Reserved, Vendor Specific</TD> </TR> </TABLE> <h4>Method Parameters (CheckVirtualSystemIsMigratableToHost)</h4> <TABLE WIDTH="100%" CELLPADDING="1" BORDER="1"> <TR> <TH ROWSPAN="2"><B>Name</B></TH><TH ROWSPAN="2"><B>Type</B></TH><TH COLSPAN="5"><B>Qualifiers</B></TH> </TR> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">DestinationHost</TH><TD ROWSPAN="4" VALIGN="TOP">string</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_VirtualSystemMigrationCapabilities.DestinationHostFormatsSupported</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">IsMigratable</TH><TD ROWSPAN="4" VALIGN="TOP">boolean</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The migration check result indicating whether or not the virtual system can be successfully migrated.</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">false</TD> </TR> <TR> <TD VALIGN="TOP">Out</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">MigrationSettingData</TH><TD ROWSPAN="4" VALIGN="TOP">string</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">String containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.</TD> </TR> <TR> <TD VALIGN="TOP">EmbeddedInstance</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_VirtualSystemMigrationSettingData</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">NewSystemSettingData</TH><TD ROWSPAN="4" VALIGN="TOP">string</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">String containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.</TD> </TR> <TR> <TD VALIGN="TOP">EmbeddedInstance</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_VirtualSystemSettingData</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="5" VALIGN="TOP">NewResourceSettingData</TH><TD ROWSPAN="5" VALIGN="TOP">string[]</TD> </TR> <TR> <TD VALIGN="TOP">ArrayType</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Indexed</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD> </TR> <TR> <TD VALIGN="TOP">EmbeddedInstance</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_ResourceAllocationSettingData</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="3" VALIGN="TOP">ComputerSystem</TH><TD ROWSPAN="3" VALIGN="TOP"> REF <a href="CIM_ComputerSystem.html">CIM_ComputerSystem</a></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Source virtual computer system to be migrated.</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> </TABLE> <h4>CheckVirtualSystemIsMigratableToSystem (uint32)</h4> <h4>Method Qualifiers (CheckVirtualSystemIsMigratableToSystem)</h4> <TABLE BORDER="1" CELLPADDING="1" WIDTH="100%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">0, 1, 2, 3, 4, 5, 6, .., 4097..32767, 32768..65535</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Completed with No Error, Not Supported, Failed, Timeout, Invalid Parameter, Invalid State, Incompatible Parameters, DMTF Reserved, Method Reserved, Vendor Specific</TD> </TR> </TABLE> <h4>Method Parameters (CheckVirtualSystemIsMigratableToSystem)</h4> <TABLE WIDTH="100%" CELLPADDING="1" BORDER="1"> <TR> <TH ROWSPAN="2"><B>Name</B></TH><TH ROWSPAN="2"><B>Type</B></TH><TH COLSPAN="5"><B>Qualifiers</B></TH> </TR> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">IsMigratable</TH><TD ROWSPAN="4" VALIGN="TOP">boolean</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The migration check result indicating whether or not the virtual system can be successfully migrated.</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">false</TD> </TR> <TR> <TD VALIGN="TOP">Out</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">MigrationSettingData</TH><TD ROWSPAN="4" VALIGN="TOP">string</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">String containing an embedded instance of the CIM_VirtualSystemMigrationSettingData class representing migration settings applicable to the migration operation.</TD> </TR> <TR> <TD VALIGN="TOP">EmbeddedInstance</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_VirtualSystemMigrationSettingData</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">NewSystemSettingData</TH><TD ROWSPAN="4" VALIGN="TOP">string</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">String containing an embedded instance of the CIM_VirtualSystemSettingData class representing new properties applicable to the virtual system after it is migrated.</TD> </TR> <TR> <TD VALIGN="TOP">EmbeddedInstance</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_VirtualSystemSettingData</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="5" VALIGN="TOP">NewResourceSettingData</TH><TD ROWSPAN="5" VALIGN="TOP">string[]</TD> </TR> <TR> <TD VALIGN="TOP">ArrayType</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Indexed</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">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.</TD> </TR> <TR> <TD VALIGN="TOP">EmbeddedInstance</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_ResourceAllocationSettingData</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="3" VALIGN="TOP">ComputerSystem</TH><TD ROWSPAN="3" VALIGN="TOP"> REF <a href="CIM_ComputerSystem.html">CIM_ComputerSystem</a></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Source virtual computer system to be migrated.</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="3" VALIGN="TOP">DestinationSystem</TH><TD ROWSPAN="3" VALIGN="TOP"> REF <a href="CIM_System.html">CIM_System</a></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Destination system onto which to migrate the virtual system.</TD> </TR> <TR> <TD VALIGN="TOP">In</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> </TABLE> <H3>Inherited Class Methods</H3> <TABLE BORDER="1" CELLPADDING="1" WIDTH="60%"> <TR> <TH>Name</TH><TH>Return Type</TH><TH>Class Origin</TH> </TR> <TR> <TH VALIGN="TOP">ChangeAffectedElementsAssignedSequence</TH><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">RequestStateChange</TH><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">StartService</TH><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">StopService</TH><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> </TABLE> </body> </html>
