CLUSCTL_RESOURCE_VM_SET_NEXT_OFFLINE_ACTION control code

Specifies the offline action for the next Offline operation on the virtual machine (VM) resource instance. This can be used to temporarily change the value of the OfflineAction property without the overhead of modifying and restoring the resource property. 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_SET_NEXT_OFFLINE_ACTION,
                        lpInBuffer,           // input buffer: DWORD
                        cbInBufferSize,       // input buffer size (bytes)
                        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.

lpInBuffer [in, optional]

A pointer to an input buffer containing a DWORD with the OfflineAction.

Turn Off (0)

The VM is turned off.

Save (1)

The VM is saved.

Shutdown (2)

The guest operating system running in the VM is shut down. This requires that the guest operating system has the shutdown integration component installed. For more information on the shutdown integration component, see the Msvm_ShutdownComponent and Msvm_ShutdownComponentSettingData classes.

Shutdown (Forced) (3)

The Windows guest operating system running in the VM is shut down forcibly. For more information, see the EWX_FORCE option flag on the ExitWindowsEx function page. This requires that the guest operating system has the shutdown integration component installed.

cbInBufferSize [in]

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

Return value

ClusterResourceControl returns one of the following values.

ERROR_SUCCESS

0

The operation was successful.

System error code

The operation failed.

Remarks

The 32 bits of CLUSCTL_RESOURCE_VM_SET_NEXT_OFFLINE_ACTION (0x01600014) are defined as follows.

ComponentBit locationValue

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

(0x14)

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

See also

External Resource Control Codes
ClusterResourceControl
ResourceControl
OfflineAction

 

 

Show: