3.1.4.2.130 ApiOfflineGroupEx (Opnum 131)

  • Article

(Protocol Version 3) The ApiOfflineGroupEx method SHOULD<113> instruct the server to make all the resources in the designated group inactive or unavailable on the node that is hosting the group.

The server MUST handle this method in the same manner as ApiOfflineGroup (section 3.1.4.2.51) except as follows:

  • If the CLUSAPI_GROUP_OFFLINE_IGNORE_RESOURCE_STATUS flag is set in the dwOfflineFlags parameter, the server MUST ignore the locked mode value of the group designated by the hGroup parameter.

  • For each resource contained in the group designated by the hGroup parameter that is in the ClusterResourceOnline state (section 3.1.4.2.13), the server MUST provide the buffer specified by the lpInBuffer parameter to the server implementation-specific object that controls the resource operation while bringing the resource offline.

The server MUST accept an ApiOfflineGroupEx request 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 parameter is "All" (section 3.1.4).

 error_status_t ApiOfflineGroupEx(
   [in] HGROUP_RPC hGroup,
   [in] DWORD dwOfflineFlags,
   [in, size_is(cbInBufferSize)] BYTE* lpInBuffer,
   [in] DWORD cbInBufferSize,
   [out] error_status_t *rpc_status
 );

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

dwOfflineFlags: Either CLUSAPI_GROUP_OFFLINE_IGNORE_RESOURCE_STATUS (0x00000001), if the client needs the server to ignore the locked mode for the group specified by the hGroup parameter (section 3.1.1.1.4), or zero.

lpInBuffer: A pointer to a buffer that the server will provide to implementation-specific objects that control the resource operations for each resource in the group. The client SHOULD set this parameter to a PROPERTY_LIST (section 2.2.3.10). For each value in this list, the client SHOULD set the property name to the name of the resource type of one of the resources in the group. The client MAY provide a buffer that does not have a property value corresponding to each resource type in the group, and the client MAY provide a buffer that has multiple property values for the same resource type. Except for the following property values, the server MUST treat all property values provided by the client identically.

Property Name

CLUSTER_PROPERTY_FORMAT

Value

Description

Virtual Machine

CLUSPROP_FORMAT_DWORD

0x00000000

For a resource of type "Virtual Machine" in the group that is in the ClusterResourceOnline state (section 3.1.4.2.13), the server MUST turn off the corresponding virtual machine.

Virtual Machine

CLUSPROP_FORMAT_DWORD

0x00000001

For a resource of type "Virtual Machine" in the group that is in the ClusterResourceOnline state (section 3.1.4.2.13), the server MUST save the corresponding virtual machine.

Virtual Machine

CLUSPROP_FORMAT_DWORD

0x00000002

For a resource of type "Virtual Machine" in the group that is in the ClusterResourceOnline state (section 3.1.4.2.13), the server MUST shut down the corresponding virtual machine.

Virtual Machine

CLUSPROP_FORMAT_DWORD

0x00000003

For a resource of type "Virtual Machine" in the group that is in the ClusterResourceOnline state (section 3.1.4.2.13), the server MUST forcibly shut down the corresponding virtual machine.

Virtual Machine

CLUSPROP_FORMAT_DWORD

0x00000004

Reserved.

cbInBufferSize: The size in bytes of the buffer pointed to by the lpInBuffer parameter.

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: This method MUST return the same error codes as specified for ApiOfflineGroup (section 3.1.4.2.51).