CLUSCTL_RESOURCE_VM_START_MIGRATION control code

Initiates the live migration of a virtual machine (VM) from one node of a cluster to another node of the cluster. The VM must be in the Online (Enabled) state (VmState property is 2) to start a live migration and the resource control must be called on the node that currently hosts the VM. Applications use this control code as a parameter to the ClusterResourceControl function, and resource DLLs receive the control code as a parameter to the ResourceControl callback function.

ClusterResourceControl( hResource,       // resource handle
                        hHostNode,       // optional node handle
                        CLUSCTL_RESOURCE_VM_START_MIGRATION, 
                        lpInBuffer,      // input buffer: Name of destination node
                        cbInBufferSize,  // input buffer size (bytes)
                        NULL,            // output buffer (not used)
                        0,               // output buffer size (not used)
                        NULL );          // returned data size (not used)

Parameters

The following control code function parameters are specific to this control code. For complete parameter descriptions, see ClusterResourceControl.

lpInBuffer [in, optional]

A pointer to an input buffer containing a null-terminated Unicode string containing the name of the destination node for the live migration.

cbInBufferSize [in]

The allocated size (in bytes) of the input buffer.

Return value

ClusterResourceControl returns one of the following values.

ERROR_SUCCESS

0

The migration was successfully started.

ERROR_INVALID_STATE

5023 (0x139F)

The VM is not in the Online (2) state on the source node.

System error code

The migration failed to start.

Remarks

The 32 bits of CLUSCTL_RESOURCE_VM_START_MIGRATION (0x01600004) are defined as follows.

For more information, see Control Code Architecture.

Requirements

See also

External Resource Control Codes

ClusterResourceControl

ResourceControl

VmState