ApiSetClusterName (Opnum 2)

(Protocol Version 2) The ApiSetClusterName method changes the name of the cluster.

The server MUST accept an ApiSetClusterName request only if its protocol server state is read/write, as specified in section 3.1.1.

 error_status_t ApiSetClusterName(
   [in, string] LPCWSTR NewClusterName

NewClusterName: A pointer to a case-insensitive Unicode string indicating the new name for the cluster. The new name consists of a DNS host name (in the format of a label as specified in [RFC1035]) and MUST NOT exceed 32 bytes (16 Unicode characters), including the terminating null character.

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

Return value/code







The NewClusterName parameter is already used as the name of a configured node.



The NewClusterName parameter exceeds 32 bytes (16 Unicode characters), including the terminating null character.



The server is unable to immediately affect the behavior of the cluster and make the new name of the configured node visible to entities external to the cluster. If this condition applies, the server MUST store the change to the nonvolatile cluster state and then return this error code.

For any other condition, the server sets 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