PauseClusterNodeEx function (clusapi.h)

Requests that a node temporarily suspends its cluster activity.

Syntax

DWORD PauseClusterNodeEx(
  [in]                          HNODE hNode,
  [in]                          BOOL  bDrainNode,
  [in] [in]                     DWORD dwPauseFlags,
  [in, optional] [in, optional] HNODE hNodeDrainTarget
);

Parameters

[in] hNode

A handle to the node to suspend.

[in] bDrainNode

TRUE to drain the node; otherwise FALSE.

[in] [in] dwPauseFlags

One of the following flags:

• CLUSAPI_NODE_PAUSE_REMAIN_ON_PAUSED_NODE_ON_MOVE_ERROR 0x00000001
• CLUSAPI_NODE_AVOID_PLACEMENT 0x00000002
• CLUSAPI_NODE_PAUSE_RETRY_DRAIN_ON_FAILURE 0x00000004

[in, optional] [in, optional] hNodeDrainTarget

The node drain topic.

Return value

If the operation succeeds, the function returns ERROR_SUCCESS.

If the operation fails, the function returns a system error code.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Target Platform	Windows
Header	clusapi.h
Library	ClusAPI.lib
DLL	ClusAPI.dll

See also

Node Management Functions