APIRef_tm_gtm_pool_aaaa

mgmt/tm/gtm/pool/aaaa

/tm/gtm/pool

Pool configuration for type AAAA members

REST Endpoints

Collection URI
/mgmt/tm/gtm/pool/aaaa
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/gtm/pool/aaaa/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key
name, partition, subPath

Properties

Name Type Default Value Required Access Description
alternateMode string round-robin optional read/write Specifies the load balancing mode that the system uses to load balance name resolution requests among the members of this pool, if the preferred method is unsuccessful in picking a pool. Note that you can set the preferred method using the command sequence / gtm create pool name mode name.
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 Specifies that this pool is not available for load balancing.
dynamicRatio string disabled optional read/write Enables or disables a dynamic ratio load balancing algorithm for this pool. This option is applicable only when you also configure the mode option for the pool with one of these dynamic load balancing modes: completion-rate, fewest-hops, kilobytes-per-second, least-connections, lowest-round-trip-times, quality-of-service, virtual-server-capacity, or virtual-server-score. When this option is disabled (the default), the system uses only the server or virtual server with the best metrics, or highest quality of service (QOS) score, for load balancing. When dynamic-ratio is enabled, the system treats QOS scores as ratios, and it uses each server or virtual server in proportion to the ratio determined by the QOS calculation.
enabled boolean true optional read/write Specifies that this pool is available for load balancing.
fallbackIp string 0.0.0.0 optional read/write Specifies the IP V6 address of the server to which the system directs requests in the event that the load balancing methods configured for this pool fail to return a valid virtual server.
fallbackMode string return-to-dns optional read/write Specifies the load balancing mode that the system uses to load balance name resolution requests among the members of this pool, if the preferred and alternate modes are unsuccessful in picking a pool. Note that you can set the preferred mode using the command sequence / gtm create pool name mode option, and the alternate-mode option using the command sequence: / gtm create pool name alternate-mode option.
limitMaxBps uint64   optional read/write Specifies the maximum allowable data throughput rate, in bits per second, for the virtual servers in the pool. If the network traffic volume exceeds this value, the system marks the pool as unavailable.
limitMaxBpsStatus string disabled optional read/write Enables or disables the limit-max-bps option for this pool. The default value is disabled.
limitMaxConnections uint64   optional read/write Specifies the number of current connections allowed for the virtual servers in the pool. If the current connections exceed this value, the system marks the pool as unavailable.
limitMaxConnectionsStatus string disabled optional read/write Enables or disables the limit-max-connections option for this pool. The default value is disabled.
limitMaxPps uint64   optional read/write Specifies the maximum allowable data transfer rate, in packets per second, for the virtual servers in the pool. If the network traffic volume exceeds this value, the system marks the pool as unavailable.
limitMaxPpsStatus string disabled optional read/write Enables or disables the limit-max-pps option for this pool. The default value is disabled.
loadBalancingMode string round-robin optional read/write Specifies the preferred load balancing mode that the system uses to load balance name resolution requests among the members of this pool.
manualResume string disabled optional read/write Enables or disables manual-resume for this pool. If you leave this option disabled (the default), then a member of this pool automatically becomes available for load balancing when its status changes from down to up. When manual-resume is enabled, if the status of a member of this pool changes from up to down, the pool member remains disabled indefinitely until you manually re-enable it.
maxAnswersReturned integer 1 optional read/write Specifies the maximum number of available pool members added to a DNS response.
monitor string   optional read/write Specifies the health monitors that the system uses to determine whether it can use this pool for load balancing.
tmPartition string Common optional read/write Specifies the partition within which this object resides.
qosHitRatio integer 5 optional read/write Assigns a weight to the Hit Ratio performance factor for the Quality of Service dynamic load balancing mode. To use this option, you must set the load-balancing-mode option to quality-of-service.
qosHops integer 0 optional read/write Assigns a weight to the Hops performance factor for the Quality of Service dynamic load balancing mode. To use this option, you must set the load-balancing-mode option to quality-of-service.
qosKilobytesSecond integer 3 optional read/write Assigns a weight to the Kilobytes per Second performance factor for the Quality of Service dynamic load balancing mode. To use this option, you must set the load-balancing-mode option to quality-of-service.
qosLcs integer 30 optional read/write Assigns a weight to the Link Capacity performance factor for the Quality of Service dynamic load balancing mode. To use this option, you must set the load-balancing-mode option to quality-of-service.
qosPacketRate integer 1 optional read/write Assigns a weight to the Packet Rate performance factor for the Quality of Service dynamic load balancing mode. To use this option, you must set the load-balancing-mode option to quality-of-service.
qosRtt integer 50 optional read/write Assigns a weight to the Round Trip Time performance factor for the Quality of Service dynamic load balancing mode. To use this option, you must set the load-balancing-mode option to quality-of-service.
qosTopology integer 0 optional read/write Assigns a weight to the Topology performance factor for the Quality of Service dynamic load balancing mode. To use this option, you must set the load-balancing-mode option to quality-of-service.
qosVsCapacity integer 0 optional read/write Assigns a weight to the Virtual Server performance factor for the Quality of Service dynamic load balancing mode. To use this option, you must set the load-balancing-mode option to quality-of-service.
qosVsScore integer 0 optional read/write Assigns a weight to the Virtual Server Score performance factor for the Quality of Service dynamic load balancing mode. To use this option, you must set the load-balancing-mode option to quality-of-service.
ttl integer 30 optional read/write Specifies the number of seconds that the IP address, once found, is valid. Once the time-to-live (TTL) expires, the client has to request the IP address resolution again. The valid values are 0 through 4294967295; the default value is 30.
type string   optional read/write  
verifyMemberAvailability string enabled optional read/write Specifies that the system verifies the availability of the members before sending a connection to those resources. The default value is enabled.

Subcollections

Name Type Default Value Required Access Description
members array_structure   optional read/write  

Array Structures

Name Type Default Value Required Access Description
/metadata array_structure   optional read/write User defined generic data for the pool. It is a name and value pair.
/metadata/app-service string   optional read/write The application service that the object belongs to.
/metadata/persist string true optional read/write Specifies whether the command “tmsh save sys config” will save the metadata entry to the configuration files.
/metadata/value string   optional read/write Value of the pool metadata
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.