3.1.4.1.106 ApiClusterControl (Opnum 106)

(Protocol Version 2) The ApiClusterControl method SHOULD<72> instruct the server to initiate, on the specified cluster, an operation that is defined by the specified control code. The operation is executed on the node from which the specified cluster context handle is obtained.

 error_status_t ApiClusterControl(
   [in] HCLUSTER_RPC hCluster,
   [in] DWORD dwControlCode,
   [in, unique, size_is(nInBufferSize)] UCHAR *lpInBuffer,
   [in] DWORD nInBufferSize,
   [out, size_is(nOutBufferSize), 
     length_is (*lpBytesReturned)] UCHAR *lpOutBuffer,
   [in] DWORD nOutBufferSize,
   [out] DWORD *lpBytesReturned,
   [out] DWORD *lpcbRequired
 );

hCluster: An HCLUSTER_RPC context handle that is obtained in a previous ApiOpenCluster method call.

dwControlCode: Indicates the operation to perform on the cluster. It MUST be one of the following values.

Value	Meaning
CLUSCTL_CLUSTER_UNKNOWN 0x07000000	Verifies that control codes for the cluster are being processed.
CLUSCTL_CLUSTER_GET_FQDN 0x0700003D	Retrieves the fully qualified domain name (FQDN) of the cluster.
CLUSCTL_CLUSTER_CHECK_VOTER_EVICT 0x07000045	Queries the cluster to determine whether evicting the specified node will cause the cluster to lose quorum.
CLUSCTL_CLUSTER_CHECK_VOTER_DOWN 0x07000049	Queries the cluster to determine whether taking the specified resource offline or stopping the specified active node will cause the cluster to lose quorum.
CLUSCTL_CLUSTER_SHUTDOWN 0x0700004D	Instructs the server to stop the cluster service on every active node.
CLUSCTL_CLUSTER_ENUM_COMMON_PROPERTIES 0x07000051	Retrieves a list of the common property names for the designated cluster.
CLUSCTL_CLUSTER_GET_RO_COMMON_PROPERTIES 0x07000055	Retrieves the read-only common property values for the designated cluster.
CLUSCTL_CLUSTER_GET_COMMON_PROPERTIES 0x07000059	Retrieves all common property values for the designated cluster.
CLUSCTL_CLUSTER_SET_COMMON_PROPERTIES 0x0740005E	Sets the common property values for the designated cluster.
CLUSCTL_CLUSTER_VALIDATE_COMMON_PROPERTIES 0x07000061	Validates that the values supplied for the common property are acceptable for the designated cluster.
CLUSCTL_CLUSTER_GET_COMMON_PROPERTY_FMTS 0x07000065	Retrieves a list of the common property formats for the designated cluster.
CLUSCTL_CLUSTER_ENUM_PRIVATE_PROPERTIES 0x07000079	Retrieves a list of the private property names for the designated cluster.
CLUSCTL_CLUSTER_GET_RO_PRIVATE_PROPERTIES 0x0700007D	Retrieves the read-only private property values for the designated cluster.
CLUSCTL_CLUSTER_GET_PRIVATE_PROPERTIES 0x07000081	Gets the private property values for the designated cluster.
CLUSCTL_CLUSTER_SET_PRIVATE_PROPERTIES 0x07400086	Sets the private property values for the designated cluster.
CLUSCTL_CLUSTER_VALIDATE_PRIVATE_PROPERTIES 0x07000089	Validates that the supplied private property list is valid.
CLUSCTL_CLUSTER_GET_SHARED_VOLUME_ID 0x07000291	Verifies that the file path is on the cluster shared volume and retrieves a unique volume identifier corresponding to that volume.

lpInBuffer: The input data for the operation that is specified by dwControlCode. See the following sections for the data structures that are required for each dwControlCode.

nInBufferSize: The size, in bytes, of the buffer that is specified by lpInBuffer.

lpOutBuffer: The output data for the operation that is specified by dwControlCode. The output buffer MUST be allocated and provided by the client.

nOutBufferSize: The available size of the buffer that is specified by lpOutBuffer, as allocated by the client.

lpBytesReturned: On successful completion of the method, the server MUST set lpBytesReturned to the number of bytes that are written to the lpOutBuffer buffer.

lpcbRequired: If nOutBufferSize indicates that the buffer that is specified by lpOutBuffer is too small for the output data, the server MUST return 0x000000EA (ERROR_MORE_DATA) and set lpcbRequired to the number of bytes that are required for the output buffer. If the method completes successfully and lpBytesReturned is 0x00000000 then the server MUST set lpcbRequired to 0x00000000. In any other condition the client MUST ignore lpcbRequired after this method completes.

Return Values: The method MUST return the following error codes for the specified conditions.

Return value/code	Description
0x00000000 ERROR_SUCCESS	Success.
0x00000001 ERROR_INVALID_FUNCTION	The cluster that is designated by hCluster does not support the operation that is designated by dwControlCode.
0x0000000D ERROR_INVALID_DATA	The input data was invalid or was incorrectly formatted.
0x00000057 ERROR_INVALID_PARAMETER	The input data was invalid or was incorrectly formatted.
0x000000EA ERROR_MORE_DATA	The nOutBufferSize parameter indicates that the buffer that is pointed to by lpOutBuffer is not large enough to hold the data that resulted from the operation.
0x00001739 ERROR_CLUSTER_NOT_SHARED_VOLUME	See section 3.1.4.3.7.17 for details about when this error can occur.

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 3.2.4.6 as recoverable errors, and initiate the reconnect procedure as specified in section 3.2.4.6.

Upon receiving this message, the server MUST:

• Determine the number of bytes that are required for lpOutBuffer. If the size indicated by nOutBufferSize is less than the number of bytes that are required for lpOutBuffer, return ERROR_MORE_DATA (0x000000EA), except as specified in the following sub-sections where a different value is returned, and set lpcbRequired to the number of bytes that are required for the output buffer.

• Return either ERROR_INVALID_DATA or ERROR_INVALID_PARAMETER if the input data is invalid or incorrectly formatted. The client MUST treat these two error codes the same.