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

ClusterSwapActive

This function allows the user to deactivate an active cluster at the same time as activating an inactive cluster. The arguments may be passed in any order, but one cluster needs to be active and the other needs to be inactive.

Syntax

ClusterSwapActive(clusterNameA, clusterNameB)

clusterNameA:

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

clusterNameB:

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

Return Value

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

Related Functions

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

See Also

Cluster Functions

About cluster context