Migrate VM operation

The Migrate VM operation migrates a virtual machine's execution to a specific resource pool or host. If the {{<status>}} response element contains _success_, the {{<Task>}} response element contains the ID of the queued task, which you can use to obtain the task status.

The following table describes the elements for this request.

Adapter request elements for the Migrate VM operation

Element	Definition	Required
<operation-type>	Defines the type of operation: Advanced_Vm	Yes
<operation-name>	Defines the name of operation: Migrate_VM	Yes
<soap-url>	Specifies the URL for the remote SOAP service running on the VMware VirtualCenter If the <soap-url> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration. Default format for HTTPS: https://<hostName>:<port>/sdk/vim Default format for HTTP: http://<hostName>:<port>/sdk/vim Note If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.	No
<transport>	Specifies the transport protocol for the message If the <transport> element is not provided, the request uses the VirtualCenter Server details specified in the adapter configuration. Valid values: https-rpc (default), http-rpc Note If the value of the <transport> element is https-rpc, you must install the security certificate for the VMware Virtual Center to the keystore of the peer on which the adapter is enabled.	No
<user-name>	Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center If no user name is specified, the request is executed with the user name that is specified in the configuration.	No
<password>	Specifies the password corresponding to <user-name>	Conditional; required if <user-name> is specified
<parameters>	Contains the elements required to execute the operation	Yes
<virtual-machine>	Contains the name of the virtual machine on which this operation is to be executed	Yes
<resource-pool>	Specifies the resource pool for the virtual machine If the resource-pool parameter is not specified, the target pool for the virtual machine's migration is the current pool of the virtual machine. Valid value: String	Conditional; required if the host-system element is not specified.
<host-system>	Specifies the DNS name of the target host on which the virtual machine runs Valid value: host name If the compute resource associated with the target pool represents a stand-alone host or a DRS-enabled cluster, the host parameter is not specified. For a stand-alone host, the host is used as the target host. For a DRS-enabled cluster, every connected host in the cluster that is not in maintenance mode is tested as a target host.	Conditional; required if the resource-pool element is not specified.
<priority>	The priority of the migration task Valid values: defaultPriority, highPriority, lowPriority	Yes
<state>	The power state of the virtual machine Valid values: poweredOff, poweredOn, suspended	No

The following code sample shows a sample adapter request for the Migrate VM operation.

Sample adapter request for the Migrate VM operation

<vmware-infrastructure-request>
    <operation-type>Advanced_Vm</operation-type>
    <operation-name>Migrate_VM</operation-name>
    <soap-url></soap-url>
    <transport></transport>
    <user-name></user-name>
    <password></password>
    <parameters>
           <virtual-machine>win1</virtual-machine>
           <resource-pool>TestRP</resource-pool>
           <host-system>xyz.bmc.com</host-system>
           <priority>defaultPriority</priority>
           <state>poweredOff</state>
    </parameters>
</vmware-infrastructure-request>

The following code sample shows the response for the sample Migrate VM operation.

Sample adapter response for the Migrate VM operation

<vmware-infrastructure-response>
    <metadata>
       <status>success</status>
    </metadata>
    <MigrateVM_TaskResponse>
       <Task>task-721</Task>
    </MigrateVM_TaskResponse>
</vmware-infrastructure-response>

The following table describes the response element.

Adapter response element for the Migrate VM operation

Element	Definition
<Task>	Specifies the task ID of the submitted task Use the task ID to obtain the status of the specified task. For information about using the task ID to check the task status, see Request and response for the Retrieve_Task_Status operation.

Migrate VM operation

On this page