Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › Host Configuration Methods › FailoverThreshold Method—Sets or Retrieves the Failover Threshold Percentage

FailoverThreshold Method—Sets or Retrieves the Failover Threshold Percentage

The FailoverThreshold method sets or retrieves the failover threshold percentage for the clusters in the host configuration.

Syntax

The FailoverThreshold method has the following format:

Netegrity::PolicyMgtHostConfig‑>FailoverThreshold([FailoverThreshold])

Parameters

The FailoverThreshold method accepts the following parameter:

FailoverThreshold (int)

(Optional) Specifies the failover threshold percentage to set.

Return Value

The FailoverThreshold method returns one of the following values:

• The new or existing failover threshold percentage
• undef if the call is unsuccessful

Remarks

The threshold percentage represents the minimum number of servers in a cluster that must be available for requests. If the number of available servers falls below the threshold, failover to the next cluster occurs. To determine the number of servers represented by the percentage, multiply the threshold percentage by the number of servers in a cluster, rounding up to the next highest integer. For example:

• With a 60-percent failover threshold for a cluster of five servers, failover to the next cluster occurs when the number of available servers in the cluster falls below 3.
• With a 61-percent failover threshold for the same cluster, failover occurs when the number of available servers falls below 4.