APIRef_tm_sys_ha-group

mgmt/tm/sys/ha-group

/tm/sys

Specifies the ha group used to calculate the failover score.

REST Endpoints

Collection URI
/mgmt/tm/sys/ha-group
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/sys/ha-group/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key
name

Properties

Name Type Default Value Required Access Description
activeBonus integer 10 optional read/write Add this extra value to the active unit’s ha score.
appService string   optional read/write The application service that the object belongs to.
description string   optional read/write User defined description.
disabled boolean true optional read/write Disable the ha score feature.
enabled boolean true optional read/write Enable the ha score feature.

Array Structures

Name Type Default Value Required Access Description
/clusters array_structure   optional read/write  
/clusters/app-service string   optional read/write  
/clusters/attribute string percent-up-members optional read/write Choose the cluster attribute that contributes to the ha score.
/clusters/minimum-threshold integer   optional read/write Below this value the attribute contributes nothing to the ha score.
/clusters/percent-up integer   optional read/write Displays the calculated percent of cluster members that are up.
/clusters/sufficient-threshold string   optional read/write Above this value the attribute contributes 100% to the ha score.
/clusters/threshold integer   optional read/write Deprecated since v13.0.0. Please use minimum-threshold instead.
/clusters/weight integer   optional read/write Maximum value this attribute contributes to the ha score.
/pools array_structure   optional read/write  
/pools/app-service string   optional read/write  
/pools/attribute string percent-up-members optional read/write Choose the pool attribute that contributes to the ha score.
/pools/minimum-threshold integer   optional read/write Below this value the attribute contributes nothing to the ha score.
/pools/percent-up integer   optional read/write Displays the calculated percent of pool members that are up.
/pools/sufficient-threshold string   optional read/write Above this value the attribute contributes 100% to the ha score.
/pools/threshold integer   optional read/write Deprecated since v13.0.0. Please use minimum-threshold instead.
/pools/weight integer   optional read/write Maximum value this attribute contributes to the ha score.
/trunks array_structure   optional read/write  
/trunks/app-service string   optional read/write  
/trunks/attribute string percent-up-members optional read/write Choose the trunk attribute that contributes to the ha score.
/trunks/minimum-threshold integer   optional read/write Below this value the attribute contributes nothing to the ha score.
/trunks/percent-up integer   optional read/write Displays the calculated percent of trunk members that are up.
/trunks/sufficient-threshold string   optional read/write If not all (or zero), above this value the attribute contributes 100% to the ha score.
/trunks/threshold integer   optional read/write Deprecated since v13.0.0. Please use minimum-threshold instead.
/trunks/weight integer   optional read/write Maximum value this attribute contributes to the ha score.
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

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.