3.1.4.2.152 ApiMoveGroupToGroupSet (Opnum 169)

The ApiMoveGroupToGroupSet method<139> instructs the server to move the specified group into the specified group set in the cluster.

The semantic behavior is identical to the ApiAddGroupToGroupSet (section 3.1.4.2.150) if the group is not already in a cluster group set. And the semantic behavior is identical to calling ApiRemoveGroupFromGroupSet (section 3.1.4.2.151) and then ApiAddGroupToGroupSet if the group is currently in a group set.

The server MUST accept an ApiMoveGroupToGroupSet 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 GroupSet context handle is "All" and that the access level associated with the Group context handle is "All" (section 3.1.4).

 error_status_t
 ApiMoveGroupToGroupSet (
   [ in ] HGROUPSET_RPC GroupSet,
   [ in ] HGROUP_RPC Group,
   [ out ] error_status_t *rpc_status
 );

GroupSet: An HGROUPSET_RPC (section 2.2.1.11) context handle that was obtained in a previous ApiOpenGroupSet (section 3.1.4.2.147) or ApiCreateGroupSet (section 3.1.4.2.146) method call.

Group: An HGROUP_RPC (section 2.2.1.3) context handle that was obtained in a previous ApiOpenGroupSet or ApiCreateGroupSet 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 the runtime 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
0x00000032 ERROR_NOT_SUPPORTED	The request is not supported.
0x00000046 ERROR_SHARING_PAUSED	The remote server has been paused, or is in the process of being started.
0x00000428 ERROR_EXCEPTION_IN_SERVICE	An exception occurred in the service when handling the request.
0x00001394 ERROR_GROUP_NOT_AVAILABLE	The group represented by the Group parameter is not available in the cluster.
0x0000139F ERROR_INVALID_STATE	The group is not in the correct state to perform the requested operation.
0x000013D1 ERROR_CLUSTER_NODE_SHUTTING_DOWN	The cluster node is shutting down in cluster group set represented by GroupSet.
0x00001767 ERROR_GROUPSET_NOT_AVAILABLE	The group set represented by the GroupSet parameter is not part of the nonvolatile cluster state.
0x00001768 ERROR_GROUPSET_NOT_FOUND	The cluster group set represented by the GroupSet parameter is not available for any further requests.

For any other condition, the server MUST set rpc_status to a value that is not one of the values listed in the preceding table. The client MUST treat all values that are not listed in the preceding table the same, except as specified in section 3.2.4.6.