System::HAGroup¶
Introduced : BIG-IP_v11.0.0
The high availability group is used to calculate a score to determine
the relative health of the system. If enabled for a redundant pair,
the system with the highest score becomes the active system,
everything else being equal. The score is calculated by measuring
specified attributes for a set of specified objects (the high
availability group). Each object contributes to the total score
according to its specified weight. In addition, a value can be added
to the total score if a system is currently active, a contribution
which can prevent continual failovers due to small fluctuations in the
scores on both systems in the redundant pair. This interface
configures all of the items listed above, plus retrieves the current
high availability score and scores for individual objects.
Methods¶
| Method | Description | Introduced |
| add_cluster | Adds clusters to a set of high availability groups. Each cluster&aposs score contributes to the total score for its high availability group. | BIG-IP_v11.0.0 |
| add_pool | Adds pools to a set of high availability groups. Each pool&aposs score contributes to the total score for its high availability group. | BIG-IP_v11.0.0 |
| add_trunk | Adds trunks to a set of high availability groups. Each trunk&aposs score contributes to the total score for its high availability group. | BIG-IP_v11.0.0 |
| create | Creates a set of high availability groups. | BIG-IP_v11.0.0 |
| delete_all_high_availability_groups | Deletes all high availability groups. | BIG-IP_v11.0.0 |
| delete_high_availability_group | Deletes a set of high availability groups. | BIG-IP_v11.0.0 |
| get_active_score | Gets the value added to the total score if the system is active for a set of high availability groups. | BIG-IP_v11.0.0 |
| get_cluster | Gets the clusters used to contribute to the score of a set of high availability groups. | BIG-IP_v11.0.0 |
| get_cluster_attribute | Gets the attribute used for scoring a set of clusters in a set of high availability groups. | BIG-IP_v11.0.0 |
| get_cluster_attribute_minimum_threshold | Gets the minimum number of monitored clusters required to consider the set of high availability groups valid. | BIG-IP_v13.0.0 |
| get_cluster_attribute_sufficient_threshold | Gets the sufficient number of monitored clusters that will contribute to the total score in a set of high availability groups. | BIG-IP_v13.0.0 |
| get_cluster_attribute_threshold | This method has been deprecated, please use get_cluster_attribute_minimum_threshold instead. Gets the value of the scoring attribute below which a cluster&aposs contribution to the total score is zero for a set of clusters in a set of high availability groups. | BIG-IP_v11.0.0 |
| get_cluster_attribute_value | Gets the current value of the scoring attribute for a set of clusters for a set of high availability groups. | BIG-IP_v11.0.0 |
| get_cluster_score | Gets the current score for a set of clusters for a set of high availability groups. | BIG-IP_v11.0.0 |
| get_cluster_weight | Gets the proportional weight of a cluster&aposs score in the total score for a set of clusters in a set of high availability groups. | BIG-IP_v11.0.0 |
| get_description | Gets the descriptions for a set of high availability groups. | BIG-IP_v11.0.0 |
| get_enabled_state | Gets whether the score for a group is enabled for use to determine system failover for a set of high availability groups. | BIG-IP_v11.0.0 |
| get_list | Gets the names of all high availability groups. | BIG-IP_v11.0.0 |
| get_pool | Gets the pools in a set of high availability groups. | BIG-IP_v11.0.0 |
| get_pool_attribute | Gets the attribute used for scoring a set of pools in a set of high availability groups. | BIG-IP_v11.0.0 |
| get_pool_attribute_minimum_threshold | Gets the minimum number of monitored pools required to consider the set of high availability groups valid. | BIG-IP_v13.0.0 |
| get_pool_attribute_sufficient_threshold | Gets the sufficient number of monitored pool members that will contribute to the total score in a set of high availability groups. | BIG-IP_v13.0.0 |
| get_pool_attribute_threshold | This method has been deprecated, please use get_pool_attribute_minimum_threshold instead. Gets the value of the scoring attribute below which a pools&apos contribution to the total score is zero for a set of pool in a set of high availability groups. | BIG-IP_v11.0.0 |
| get_pool_attribute_value | Gets the current value of the scoring attribute for a set of pools in a set of high availability groups. | BIG-IP_v11.0.0 |
| get_pool_score | Gets the current score for a set of pools for a set of high availability groups. | BIG-IP_v11.0.0 |
| get_pool_weight | Gets the proportional weight of a pool&aposs score in the total score for a set of pools in a set of high availability groups. | BIG-IP_v11.0.0 |
| get_total_score | Gets the current total score for a set of high availablity groups. | BIG-IP_v11.0.0 |
| get_trunk | Gets the trunks in a set of high availability groups. | BIG-IP_v11.0.0 |
| get_trunk_attribute | Gets the attribute used for scoring a set of trunks in a set of high availability groups. | BIG-IP_v11.0.0 |
| get_trunk_attribute_minimum_threshold | Gets the minimum number of monitored trunks required to consider the set of high availability groups valid. | BIG-IP_v13.0.0 |
| get_trunk_attribute_sufficient_threshold | Gets the sufficient number of monitored trunks that will contribute to the total score in a set of high availability groups. | BIG-IP_v13.0.0 |
| get_trunk_attribute_threshold | This method has been deprecated, please use get_trunk_attribute_minimum_threshold instead. Gets the value of the scoring attribute below which a trunk&aposs contribution to the total score is zero for a set of trunks in a set of high availability groups. | BIG-IP_v11.0.0 |
| get_trunk_attribute_value | Gets the current value of the scoring attribute for a set of trunks for a set of high availability groups. | BIG-IP_v11.0.0 |
| get_trunk_score | Gets the current score for a set of trunks for a set of high availability groups. | BIG-IP_v11.0.0 |
| get_trunk_weight | Gets the proportional weight of a trunk&aposs score in the total score for a set of trunks in a set of high availability groups. | BIG-IP_v11.0.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.0.0 |
| remove_all_clusters | Removes all clusters from a set of high availability groups. | BIG-IP_v11.0.0 |
| remove_all_pools | Removes all pools from a set of high availability groups. | BIG-IP_v11.0.0 |
| remove_all_trunks | Removes all trunks from a set of high availability groups. | BIG-IP_v11.0.0 |
| remove_cluster | Removes clusters from a set of high availability groups. | BIG-IP_v11.0.0 |
| remove_pool | Removes pools from a set of high availability groups. | BIG-IP_v11.0.0 |
| remove_trunk | Removes trunks from a set of high availability groups. | BIG-IP_v11.0.0 |
| set_active_score | Sets the value added to the total score if the system is active for a set of high availability groups. If zero, the active system scoring is disabled. Otherwise, this value must range between 0 and 100. | BIG-IP_v11.0.0 |
| set_cluster_attribute | Sets the attribute used for scoring a set of clusters in a set of high availability groups. | BIG-IP_v11.0.0 |
| set_cluster_attribute_minimum_threshold | Sets the minimum number of monitored clusters required to consider the set of high availability groups valid. A cluster is considered unhealthy if it has less than the minimum threshold number of cluster members up. | BIG-IP_v13.0.0 |
| set_cluster_attribute_sufficient_threshold | Sets the sufficient number of monitored clusters that will contribute to the total score in a set of high availability groups. A cluster is considered 100% healthy if it has equal to or more than the sufficient threshold number of cluster members up. | BIG-IP_v13.0.0 |
| set_cluster_attribute_threshold | This method has been deprecated, please use set_cluster_attribute_minimum_threshold instead. Sets the value of the scoring attribute below which a cluster&aposs contribution to the total score is zero for a set of cluster in a set of high availability groups. | BIG-IP_v11.0.0 |
| set_cluster_weight | Sets the proportional weight of a cluster&aposs score in the total score for a set of clusters in a set of high availability groups. | BIG-IP_v11.0.0 |
| set_description | Sets the description for a set of high availability groups. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_enabled_state | Sets whether the score for a group is enabled for use to determine system failover for a set of high availability groups. | BIG-IP_v11.0.0 |
| set_pool_attribute | Sets the attribute used for scoring a set of pools in a set of high availability groups. | BIG-IP_v11.0.0 |
| set_pool_attribute_minimum_threshold | Sets the minimum number of monitored pools required to consider the set of high availability groups valid. A pool is considered unhealthy if it has less than the minimum threshold number of pool members up. | BIG-IP_v13.0.0 |
| set_pool_attribute_sufficient_threshold | Sets the sufficent number of monitored pool members that will contribute to the total score in a set of high availability groups. A pool is considered 100% healthy if it has equal to or more than the sufficient threshold number of pool members up. | BIG-IP_v13.0.0 |
| set_pool_attribute_threshold | This method has been deprecated. Please use set_pool_attribute_minimum_threshold instead. Sets the value of the scoring attribute below which a pool&aposs contribution to the total score is zero for a set of pools in a set of high availability groups. | BIG-IP_v11.0.0 |
| set_pool_weight | Sets the proportional weight of a pool&aposs score in the total score for a set of pools in a set of high availability groups. | BIG-IP_v11.0.0 |
| set_trunk_attribute | Sets the attribute used for scoring a set of trunks in a set of high availability groups. | BIG-IP_v11.0.0 |
| set_trunk_attribute_minimum_threshold | Sets the minimum number of monitored trunks required to consider the set of high availability groups valid. A trunk is considered unhealthy if it has less than the minimum threshold number of trunk members up. | BIG-IP_v13.0.0 |
| set_trunk_attribute_sufficient_threshold | Sets the sufficient number of monitored trunks that will contribute to the total score in a set of high availability groups. A trunk is considered 100% healthy if it has equal to or more than the sufficient threshold number of trunk members up. | BIG-IP_v13.0.0 |
| set_trunk_attribute_threshold | This method has been deprecated, please use set_trunk_attribute_minimum_threshold instead. Sets the value of the scoring attribute below which a trunk&aposs contribution to the total score is zero for a set of trunks in a set of high availability groups. | BIG-IP_v11.0.0 |
| set_trunk_weight | Sets the proportional weight of a trunk&aposs score in the total score for a set of trunks in a set of high availability groups. | BIG-IP_v11.0.0 |
Enumerations¶
| Enumeration | Description |
| HAGroupClusterAttribute | Attributes available for use in scoring a cluster |
| HAGroupPoolAttribute | Attributes available for use in scoring a pool |
| HAGroupTrunkAttribute | Attributes available for use in scoring a trunk |
Aliases¶
| Alias | Type | Description |
| HAGroupClusterAttributeSequence | HAGroupClusterAttribute [] | Sequence of cluster scoring attributes |
| HAGroupClusterAttributeSequenceSequence | HAGroupClusterAttribute [] [] | Sequence of sequence of cluster scoring attributes |
| HAGroupPoolAttributeSequence | HAGroupPoolAttribute [] | Sequence of pool scoring attributes |
| HAGroupPoolAttributeSequenceSequence | HAGroupPoolAttribute [] [] | Sequence of a sequence of pool scoring attributes |
| HAGroupTrunkAttributeSequence | HAGroupTrunkAttribute [] | Sequence of trunk scoring attributes |
| HAGroupTrunkAttributeSequenceSequence | HAGroupTrunkAttribute [] [] | Sequence of sequence of trunk scoring attributes |
See Also¶
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.