Skip to content

Latest commit

 

History

History
116 lines (88 loc) · 4.6 KB

nf-clusapi-moveclustergroup.md

File metadata and controls

116 lines (88 loc) · 4.6 KB
Raw
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.MoveClusterGroup
MoveClusterGroup function (clusapi.h)
Moves a group and all of its resources from one node to another.
MoveClusterGroup
MoveClusterGroup function [Failover Cluster]
PCLUSAPI_MOVE_CLUSTER_GROUP
PCLUSAPI_MOVE_CLUSTER_GROUP function [Failover Cluster]
_wolf_moveclustergroup
clusapi/MoveClusterGroup
clusapi/PCLUSAPI_MOVE_CLUSTER_GROUP
mscs.moveclustergroup
mscs\moveclustergroup.htm
MsCS
32408600-5118-47fb-890b-9c31faef2299
12/05/2018
MoveClusterGroup, MoveClusterGroup function [Failover Cluster], PCLUSAPI_MOVE_CLUSTER_GROUP, PCLUSAPI_MOVE_CLUSTER_GROUP function [Failover Cluster], _wolf_moveclustergroup, clusapi/MoveClusterGroup, clusapi/PCLUSAPI_MOVE_CLUSTER_GROUP, mscs.moveclustergroup
clusapi.h
Windows
None supported
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
ClusAPI.lib
ClusAPI.dll
Windows
19H1
MoveClusterGroup
clusapi/MoveClusterGroup
c++
APIRef
kbSyntax
DllExport
ClusAPI.dll
MoveClusterGroup

MoveClusterGroup function

-description

Moves a group and all of its resources from one node to another. The PCLUSAPI_MOVE_CLUSTER_GROUP type defines a pointer to this function.

-parameters

-param hGroup [in]

Handle to the group to be moved.

-param hDestinationNode [in, optional]

Handle to the node where the moved group should be brought back online or NULL.

-returns

If the operation succeeds, the function returns ERROR_SUCCESS.

If the operation fails, the function returns a system error code. The following is one of the possible error codes.

Return code Description
ERROR_IO_PENDING
 The reassignment of ownership of the group is in progress.

-remarks

The return value from the MoveClusterGroup function does not imply anything about the state of the group or any of its resources. The return value only indicates whether the change of ownership was successful. After returning from MoveClusterGroup, the cluster always attempts to return the group to the state it was before the move.

If you want your application to ensure a particular state for a resource or a group after a move:

  1. Check the state prior to the move. The cluster will attempt to restore that state after the move.
  2. Poll for the state after the move and adjust as necessary. Or create a notification port (see Receiving Cluster Events) and wait for a CLUSTER_CHANGE_GROUP_STATE event.
When hDestinationNode is set to NULL, MoveClusterGroup attempts to move the group to the best possible node. If there is no node available that can accept the group, the function fails. MoveClusterGroup also fails if MoveClusterGroup determines that the group cannot be brought online on the node identified by the hDestinationNode parameter.

Do not call MoveClusterGroup from a resource DLL. For more information, see Function Calls to Avoid in Resource DLLs.

Do not pass LPC and RPC handles to the same function call. Otherwise, the call will raise an RPC exception and can have additional destructive effects. For information on how LPC and RPC handles are created, see Using Object Handles and OpenCluster.

-see-also

OpenCluster

OpenClusterGroup

OpenClusterNode