ClusterStatus

This function allows the user to determine the connection status from the client to a server on a cluster.

Syntax

ClusterStatus(clusterName, serverType)

clusterName:

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

serverType:

The type of server (not a bit mask):

1 - Alarm Server

2 - Trend Server

4 - Report Server

8 - IO Server

Return Value

One of the following values:

• -1 - if the cluster does not contain a server of the given type.

• -2 - if the cluster does not exist"

• 0 - if the cluster contains the server but the cluster is inactive.

• 1 - if the cluster is active but the connection to the server is offline.

• 2 - if the cluster is active and the connection to the server is online.

Related Functions

ClusterActivate, ClusterDeactivate, ClusterFirst, ClusterIsActive, ClusterNext, ClusterServerTypes, ClusterSwapActive, TaskCluster

See Also

Cluster Functions