Validate VM Migration operation

The Validate VM Migration operation verifies the validity of the proposed virtual machine migration before performing the actual migration.

The following table describes the elements for this request.

Adapter request elements for the Validate VM Migration operation

Element

Definition

Required

<operation-type>

Defines the type of the operation: Advanced_Vm

Yes

<operation-name>

Defines the name of the operation: Validate_VM_Migration

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

If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.

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.

The default value is https-rpc.

Valid values are https-rpc and http-rpc.

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.

<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 user specified in the configuration.

Specifies the password corresponding to <user-name>

Conditional

Required if the user-name element is provided

Contains the data types and elements required to execute the operation

Yes

<virtual-machine>

Contains the name of the virtual machine intended to be migrated

Yes

<resource-pool>

Specifies the target resource pool of the virtual machine

If the <resource-pool> element is not specified, the target resource pool for the virtual machine's migration is the current resource 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 will run

Valid value: host name

If the compute resource associated with the resource 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

<test-type-list>

Specifies the set of tests to run

If this argument is not set, all tests will be executed.

Valid values: compatibilityTests, diskAccessibilityTests, resourceTests, sourceTests
Sample value:

<test-type-list>
   <test-type>
   </test-type>
   <test-type>
   </test-type>
</test-type-list>

<state>

Specifies the power state that the virtual machine must have

If this element is not specified, the virtual machine is evaluated according to its current power state.

Valid values: poweredOff, poweredOn, suspended

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

Sample adapter request for the Validate VM Migration operation

<vmware-infrastructure-request>
    <operation-type>Advanced_Vm</operation-type>
    <operation-name>Validate_VM_Migration</operation-name>
    <soap-url></soap-url>
    <transport></transport>
    <user-name></user-name>
    <password></password>
    <parameters>
       <virtual-machine>win1</virtual-machine>
       <state>poweredOn</state>
       <test-type-list>
          <test-type>compatibilityTests</test-type>
          <test-type>resourceTests</test-type>
       </test-type-list>
       <resource-pool>TestRP</resource-pool>
       <host-system>xyz.bmc.com</host-system>
    </parameters>
</vmware-infrastructure-request>

The following code sample shows the response for the sample Validate VM Migration operation.

Sample adapter response for the Validate VM Migration operation

<vmware-infrastructure-response>
    <metadata>
       <status>success</status>
    </metadata>
    <ValidateMigrationResponse>
    <MigrationErrorEvent>
    <key>0</key>
    <chainId>0</chainId>
    <createdTime>2008-01-01T13:48:13.613125Z</createdTime>
    <userName>Administrator</userName>
    <datacenter>
       <name>Development</name>
       <Datacenter>datacenter-2</Datacenter>
    </datacenter>
    <computeResource>
       <name>xyz.bmc.com</name>
    <ComputeResource>domain-s175</ComputeResource>
    </computeResource>
    <host>
       <name>xyz.bmc.com</name>
       <HostSystem">host-8</HostSystem>
    </host>
    <vm>
       <name>win1</name>
       <VirtualMachine>vm-14</VirtualMachine>
    </vm>
       <fullFormattedMessage>Migration completed.'ng5.abc.com'.</fullFormattedMessage>
    <template>false</template>
    <fault>
    <localizedMessage></localizedMessage>
    <VMotionNotConfigured>
    <atSourceHost>true</atSourceHost>
    <failedHost>xyz.bmc.com</failedHost>
    </fault>
    </fault>
    </MigrationErrorEvent>
    </ValidateMigrationResponse>
</vmware-infrastructure-response>

The following table describes the response element.

Adapter response element for the Validate VM Migration operation

Element	Definition
<Events>	A set of events describing the warnings or errors that would be applicable, if the proposed set of migrations were executed.

Validate VM Migration operation

TrueSight Orchestration Content 20.19.02

On this page