3.1.4.2.134 ApiOnlineResourceEx (Opnum 135)

  • Article

(Protocol Version 3) The ApiOnlineResourceEx method SHOULD<118> instruct the server to make the specified resource active or available on the node that currently owns it.

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

  • If the CLUSAPI_RESOURCE_ONLINE_IGNORE_RESOURCE_STATUS flag is set in the dwOnlineFlags parameter, the server MUST ignore the locked mode value of the resource designated by the hResource parameter as well as the locked mode value of any of its provider resources as specified in section 3.1.1.1.2.

  • If the CLUSAPI_RESOURCE_ONLINE_DO_NOT_UPDATE_PERSISTENT_STATE flag is set in the dwOnlineFlags parameter, the server MUST not update the persistent state of the resource designated by the hResource parameter.

  • If the CLUSAPI_RESOURCE_ONLINE_NECESSARY_FOR_QUORUM flag is set in the dwOnlineFlags parameter, the server MUST bring the resource designated by the hResource parameter to online to maintain a quorum.

  • If the CLUSAPI_RESOURCE_ONLINE_BEST_POSSIBLE_NODE flag is set in the dwOnlineFlags parameter, the server MUST determine the best possible node that will host the resource designated by the hResource parameter.

  • If the CLUSAPI_RESOURCE_ONLINE_IGNORE_AFFINITY_RULE flag is set in the dwOnlineFlags parameter, the server MUST ignore the affinity rule of the resource designated by the hResource parameter.

  • If the resource designated by hResource is not already in the ClusterResourceOnline state (section 3.1.4.2.13), the server MUST provide the buffer designated by the lpInBuffer parameter to the server implementation-specific object that controls the resource operation while bringing the resource online and MUST provide this buffer to the server implementation-specific objects for any of the designated resource's provider resources that are not already in the ClusterResourceOnline state. How the server provides this buffer is implementation-specific.

The server accepts an ApiOnlineResourceEx 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 hResource parameter is "All" (section 3.1.4).

 error_status_t ApiOnlineResourceEx(
   [in] HRES_RPC hResource,
   [in] DWORD dwOnlineFlags,
   [in, size_is(cbInBufferSize)] BYTE* lpInBuffer,
   [in] DWORD cbInBufferSize,
   [out] error_status_t *rpc_status
 );

hResource: An HRES_RPC context handle that was obtained in a previous call to ApiOpenResource (section 3.1.4.2.9), ApiOpenResourceEx (section 3.1.4.2.119), or ApiCreateResource (section 3.1.4.2.10).

dwOnlineFlags: A bitwise-OR of zero or more of the following flags.

Value

Description

0x00000001

CLUSAPI_RESOURCE_ONLINE_IGNORE_RESOURCE_STATUS

The server MUST ignore the resource locked mode as specified in section 3.1.1.1.1.

0x00000002

CLUSAPI_RESOURCE_ONLINE_DO_NOT_UPDATE_PERSISTENT_STATE

The server MUST not update the persistent state of the resource.

0x00000004

CLUSAPI_RESOURCE_ONLINE_NECESSARY_FOR_QUORUM

The server MUST bring the resource to online to maintain a quorum.

0x00000008

CLUSAPI_RESOURCE_ONLINE_BEST_POSSIBLE_NODE

The server MUST determine the best possible node that will host the resource.<119>

0x00000020

CLUSAPI_RESOURCE_ONLINE_IGNORE_AFFINITY_RULE

The server MUST ignore the affinity rule of the resource.<120>

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

0x00000004

Reserved for local use.

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 returned by the ApiOnlineResource (section 3.1.4.2.18) method, in addition to the following return value.

Return value/code

Description

0x00000057

ERROR_INVALID_PARAMETER

The dwOnlineFlags parameter is not one of the specified values.