CLUSCTL_RESOURCE_VM_CANCEL_MIGRATION control code

Cancels an ongoing live migration of a virtual machine (VM). The migration can be canceled only if the migration is in the "Setup" (MigrationState is 1) or "Data Transfer" (MigrationState is 2) states and the resource control is called on the source node of the live migration. 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_CANCEL_MIGRATION, 
                        NULL,                // input buffer (not used)
                        0,                   // input buffer size (not used)
                        NULL,                // output buffer (not used)
                        0,                   // output buffer size (not used)
                        NULL );              // resulting data size (not used)

Parameters

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

Return value

ClusterResourceControl returns one of the following values.

ERROR_SUCCESS

0

The migration was successfully canceled.

ERROR_INVALID_STATE

5023 (0x139F)

The VM is not in the "Setup" (MigrationState is 1) or "Data Transfer" (MigrationState is 2) state on the source node.

System error code

The operation failed.

Remarks

The 32 bits of CLUSCTL_RESOURCE_VM_CANCEL_MIGRATION (0x01600008) are defined as follows.

For more information, see Control Code Architecture.

Requirements

See also

External Resource Control Codes

ClusterResourceControl

ResourceControl

MigrationState