3.1.4.2.127 ApiResumeNodeEx (Opnum 128)

(Protocol Version 3) The ApiResumeNodeEx method SHOULD<107> instruct the server to resume normal group ownership and failover activity on the designated node and, optionally, to initiate operations to move groups to the designated node.

The server MUST handle this method in the same manner as ApiResumeNode (section 3.1.4.2.71) except as specified below for the dwResumeFailbackType parameter.

The server MUST require that the access level associated with the hNode parameter context handle is "All", as specified in section 3.1.4.

 error_status_t ApiResumeNodeEx(
   [in] HNODE_RPC hNode,
   [in] DWORD dwResumeFailbackType,
   [in] DWORD dwResumeFlagsReserved,
   [out] error_status_t *rpc_status
 );

hNode: An HNODE_RPC context handle that was obtained in a previous call to ApiOpenNode (section 3.1.4.1.67) or ApiOpenNodeEx (section 3.1.4.2.117).

dwResumeFailbackType: Designates whether the server MUST initiate operations to move groups to the node designated by the hNode parameter. This parameter MUST be set to one of the following values:

Value

Description

0

The server SHOULD NOT move groups to the node designated by the hNode parameter as a result of the call to this method. The server MAY subsequently move groups to the node designated by the hNode parameter according to other implementation-specific policies.

1

The server SHOULD move groups to the node designated by the hNode parameter as a result of the call to this method. The server SHOULD use implementation-specific policies to determine the groups to move and the manner in which to move them. In determining the groups to move, the server SHOULD ignore previously configured policies that control whether groups are to be moved to a node upon its transition to the ClusterNodeUp state (as specified in section 3.1.4.1.69).

2

The server SHOULD move groups to the node designated by the hNode parameter as a result of the call to this method. The server SHOULD use implementation-specific policies to determine the groups to move and the manner in which to move them. In selecting the groups to move, the server SHOULD adhere to policies that control whether groups are to be moved to a node upon its transition to the ClusterNodeUp state (as specified in section 3.1.4.1.69).

This setting will cause failback due to potential violations of configured policies (such as possible owners, anti-affinity, and preferred owners) only if failback is enabled. Although callers can specify a failback window in which failback would normally occur, in this situation the server will ignore any caller-specified failback window. The failback can happen at any time. This setting also causes failback of all groups from all paused nodes to this node.

dwResumeFlagsReserved: Reserved for future use.

rpc_status: A 32-bit integer used to indicate success or failure. The RPC runtime MUST indicate, by writing to this parameter, whether it succeeded in executing this method on the server. The encoding of the value passed in this parameter MUST conform to encoding for comm_status and fault_status, as specified in Appendix E of [C706].

Return Values: The method MUST return one of the following error codes:

Return value/code

Description

0x00000000

ERROR_SUCCESS

The method completed successfully.

0x00000006

ERROR_INVALID_HANDLE

The hNode parameter does not contain a valid HNODE_RPC context handle.

0x000013C2

ERROR_CLUSTER_NODE_NOT_PAUSED

The node designated by the hNode parameter is not paused.

0x000013BA

ERROR_CLUSTER_NODE_DOWN

The node designated by the hNode parameter is down.