Skip to content

Latest commit

 

History

History
84 lines (66 loc) · 2.32 KB

nf-clusapi-pauseclusternodeex.md

File metadata and controls

84 lines (66 loc) · 2.32 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:clusapi.PauseClusterNodeEx
PauseClusterNodeEx function (clusapi.h)
Requests that a node temporarily suspends its cluster activity.
PCLUSAPI_PAUSE_CLUSTER_NODE_EX
PCLUSAPI_PAUSE_CLUSTER_NODE_EX function [Failover Cluster]
PauseClusterNodeEx
PauseClusterNodeEx function [Failover Cluster]
clusapi/PCLUSAPI_PAUSE_CLUSTER_NODE_EX
clusapi/PauseClusterNodeEx
mscs.pauseclusternodeex
mscs\pauseclusternodeex.htm
MsCS
632C26C2-ED12-40DC-9615-4A09A7E2F7CB
12/05/2018
PCLUSAPI_PAUSE_CLUSTER_NODE_EX, PCLUSAPI_PAUSE_CLUSTER_NODE_EX function [Failover Cluster], PauseClusterNodeEx, PauseClusterNodeEx function [Failover Cluster], clusapi/PCLUSAPI_PAUSE_CLUSTER_NODE_EX, clusapi/PauseClusterNodeEx, mscs.pauseclusternodeex
clusapi.h
Windows
None supported
Windows Server 2012
ClusAPI.lib
ClusAPI.dll
Windows
19H1
PauseClusterNodeEx
clusapi/PauseClusterNodeEx
c++
kbSyntax
<TBD>
PauseClusterNodeEx

PauseClusterNodeEx function

-description

Requests that a node temporarily suspends its cluster activity.

-parameters

-param hNode [in]

A handle to the node to suspend.

-param bDrainNode [in]

TRUE to drain the node; otherwise FALSE.

-param dwPauseFlags [in] [in]

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

-param hNodeDrainTarget [in, optional] [in, optional]

The node drain topic.

-returns

If the operation succeeds, the function returns ERROR_SUCCESS.

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

-see-also

Node Management Functions