CLUSCTL_CLUSTER_SET_ACCOUNT_ACCESS control code

Updates the account access settings for a cluster.

ClusterControl( hCluster,       // cluster handle
                hHostNode,      // optional node handle
                CLUSCTL_CLUSTER_SET_ACCOUNT_ACCESS, // control code
                lpInBuffer,     // input buffer: property list
                cbInBufferSize, // input buffer size (bytes)
                NULL,           // output buffer (not used)
                0,              // output buffer size (not used)
                NULL );         // output data size (not used)

Parameters

The following control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterControl.

lpInBuffer

A pointer to a property list that contains the new values for the account access settings.

Return value

ClusterControl returns one of the following values.

ERROR_SUCCESS

0

The operation completed successfully. The lpcbBytesReturned parameter points to the actual size of the returned data.

ERROR_MORE_DATA

234 (0xEA)

More data is available. The output buffer pointed to by lpOutBuffer was not large enough to hold the data resulting from the operation. The lpcbBytesReturned parameter points to the size required for the output buffer.

System error code

If any other value is returned, then the operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

By default, failover clusters do not define any private cluster properties. You can use the CLUSCTL_CLUSTER_SET_PRIVATE_PROPERTIES control code to define private properties for a cluster.

For information on working with property lists, see Using Property Lists.

ClusAPI.h defines the 32 bits of CLUSCTL_CLUSTER_SET_ACCOUNT_ACCESS (0x074000F2) as follows (for more information, see Control Code Architecture).

Component Bit location Value
Object code 24 31 CLUS_OBJECT_CLUSTER (0x7)
Global bit 23 CLUS_NOT_GLOBAL (0x0)
Modify bit 22 CLUS_MODIFY (0x1)
User bit 21 CLCTL_CLUSTER_BASE (0x0)
Type bit 20 External (0x0)
Operation code 0 23 CLCTL_SET_ACCOUNT_ACCESS (0x4000F2)
Access code 0 1 CLUS_ACCESS_WRITE (0x2)

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2016
Header
ClusAPI.h;
MSClus.h

See also

ClusterSetAccountAccess

External Resource Control Codes

Control Codes