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.
-
The operation failed.
Remarks
The 32 bits of CLUSCTL_RESOURCE_VM_CANCEL_MIGRATION (0x01600008) are defined as follows.
| Component | Bit location | Value |
|---|---|---|
| Object code |
24 31 |
CLUS_OBJECT_RESOURCE (0x1) |
| Global bit |
23 |
CLUS_NOT_GLOBAL (0x0) |
| Modify bit |
22 |
CLUS_MODIFY (0x1) |
| User bit |
21 |
CLCTL_USER_BASE (0x200000) |
| Type bit |
20 |
External (0x0) |
| Operation code |
0 23 |
(0x8) |
| Access code |
0 1 |
CLUS_ACCESS_ANY (0x0) |
For more information, see Control Code Architecture.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 R2 Datacenter, Windows Server 2008 R2 Enterprise |