Export (0) Print
Expand All
Expand Minimize

3.1.4.2.50 ApiOnlineGroup (Opnum 49)

(Protocol Version 3) The ApiOnlineGroup method instructs the server to make all the resources in the designated group active or available on the node that is hosting the group. The persistent state of the group is set to online and is updated in the nonvolatile cluster state.

The server MUST attempt to make all resources in the group active or available as specified in section 3.1.4.2.18.

The server MUST fail this method using the error ERROR_NODE_CANT_HOST_RESOURCE if the node is already hosting a group with one or more resources in the ClusterResourceOnline state, and the group has the same anti-affinity setting as the designated group. For information about anti-affinity, see section 3.1.1.1.4.

The server MUST fail this method using the error ERROR_SHARING_PAUSED if the node hosting the group is in the paused state.

The server SHOULD<69> fail this method using the error ERROR_CLUSTER_RESOURCE_LOCKED_STATUS if the group is in locked mode, as specified in section 3.1.1.1.4

The server MUST accept an ApiOnlineGroup request for processing only if it is in the read/write state, as specified in section 3.1.1.

The server MUST require that the access level associated with the hGroup context handle is "All" (section 3.1.4).

error_status_t ApiOnlineGroup(
  [in] HGROUP_RPC hGroup,
  [out] error_status_t* rpc_status
);

hGroup: An HGROUP_RPC (section 2.2.1.3) context handle that was obtained in a previous ApiOpenGroup (section 3.1.4.2.42), ApiOpenGroupEx (section 3.1.4.2.118), or ApiCreateGroup (section 3.1.4.2.43) method call.

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 the following error codes for the specified conditions.

Return value/code Description

0x00000000
ERROR_SUCCESS

Success.

0x00000006
ERROR_INVALID_HANDLE

The hGroup parameter does not represent a valid HGROUP_RPC context handle.

0x00000046
ERROR_SHARING_PAUSED

The node hosting the group is in the paused state.

0x000003E5
ERROR_IO_PENDING

The server is in the process of making the group's resources active or available.

0x0000055C
ERROR_SPECIAL_GROUP

Cannot perform this operation on this built-in special group (section 3.1.1.1.4).

0x00001394
ERROR_GROUP_NOT_AVAILABLE

The group represented by the hGroup parameter no longer exists in the nonvolatile cluster state.

0x0000139F
ERROR_INVALID_STATE

The group is already in the ClusterGroupPending state, or the group is in the process of being deleted but is still in the cluster state.

0x000013CF
ERROR_NODE_CANT_HOST_RESOURCE

The node is already hosting a group with one or more resources in the ClusterResourceOnline state and the group has the same anti-affinity setting as the designated group.

0x00001748
ERROR_CLUSTER_RESOURCE_LOCKED_STATUS

The group is in locked mode, as specified in section 3.1.1.1.4.

For any other condition, this method MUST return a value that is not one of the values listed in the preceding table. The client MUST behave in one consistent, identical manner for all values that are not listed in the preceding table. The client SHOULD treat errors specified in section 3.2.4.6 as recoverable errors and initiate the reconnect procedure as specified in section 3.2.4.6.

 
Show:
© 2014 Microsoft