Cicode Programming Reference > Cicode Function Categories > Cluster Functions Introduction > ClusterDeactivate

ClusterDeactivate

This function allows the user to deactivate an active cluster. When a cluster is made inactive, no data associated with that cluster is available to the client, and hardware alarms will not occur if no connections can be made to the servers in the cluster.

Syntax

ClusterDeactivate(ClusterName)

ClusterName:

The name of the cluster to deactivate enclosed in quotation marks "".

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

ClusterActivate, ClusterFirst, ClusterGetName, ClusterIsActive, ClusterNext, ClusterServerTypes, ClusterSetName, ClusterStatus, ClusterSwapActive, TaskCluster

See Also

Cluster Functions

About cluster context