APIRef_tm_ltm_pool¶
mgmt/tm/ltm/pool
Load balancing pool configuration
REST Endpoints
- Collection URI
/mgmt/tm/ltm/pool- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/ltm/pool/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, partition, subPath
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
allowNat |
string | yes | optional | read/write | Specifies whether the pool can load balance NAT connections. The default value is yes. |
allowSnat |
string | yes | optional | read/write | Specifies whether the pool can load balance SNAT connections. The default value is yes. |
appService |
string | optional | read/write | The application service to which the object belongs. | |
autoscaleGroupId |
string | optional | read/write | autoscale-group id to which pool members belong to. | |
description |
string | optional | read/write | User defined description. | |
gatewayFailsafeDevice |
string | optional | read/write | Specifies that the pool is a gateway failsafe pool in a redundant configuration. This string identifies the device that will failover when the monitor reports the pool member down. By default the device string is empty. | |
ignorePersistedWeight |
string | disabled | optional | read/write | Do not count the weight of persisted connections on pool members when making load balancing decisions. |
ipTosToClient |
string | 65535 | optional | read/write | Specifies the Type of Service (ToS) level to use when sending packets to a client. 65534 (mimic) specifies that the system sets the ToS level of outgoing packets to the same ToS level of the most-recently received incoming packet. The default value is 65535 (pass-through). |
ipTosToServer |
string | 65535 | optional | read/write | Specifies the Type of Service (ToS) level to use when sending packets to a server. 65534 (mimic) specifies that the system sets the ToS level of outgoing packets to the same ToS level of the most-recently received incoming packet. The default value is 65535 (pass-through). |
linkQosToClient |
string | 65535 | optional | read/write | Specifies the Quality of Service (QoS) level to use when sending packets to a client. The default value is 65535 (pass-through). |
linkQosToServer |
string | 65535 | optional | read/write | Specifies the Quality of Service (QoS) level to use when sending packets to a server. The default value is 65535 (pass-through). |
loadBalancingMode |
string | round-robin | optional | read/write | Specifies the modes that the system uses to load balance name resolution requests among the members of this pool. See “help pool” for a description of each loading balancing mode. |
minActiveMembers |
integer | 0 | optional | read/write | Specifies the minimum number of members that must be up for traffic to be confined to a priority group when using priority-based activation. The default value is 0 (zero). An active member is a member that is up (not marked down) and is handling fewer connections than its connection limit. |
minUpMembers |
integer | 0 | optional | read/write | Specifies the minimum number of pool members that must be up; otherwise, the system takes the action specified in the min-up-members-action option. Use this option for gateway pools in a redundant system where a unit number is applied to a pool. This indicates that the pool is only configured on the specified unit. |
minUpMembersAction |
string | failover | optional | read/write | Specifies the action to take if the min-up-members-checking is enabled and the number of active pool members falls below the number specified in min-up-members. The default value is failover. |
minUpMembersChecking |
string | disabled | optional | read/write | Enables or disables the min-up-members feature. If you enable this feature, you must also specify a value for both the min-up-members and min-up-members-action options. |
monitor |
string | optional | read/write | Specifies the health monitors that the system uses to determine whether it can use this pool for load balancing. The monitor marks the pool up or down based on whether the monitor(s) are successful. You can specify a single monitor, multiple monitors “http and https”, or a “min” rule, “min 1 of { http https }”. You may remove the monitor by specifying “none”. | |
tmPartition |
string | Common | optional | read/write | Displays the administrative partition within which the pool resides. |
queueDepthLimit |
integer | 0 | optional | read/write | Specifies the maximum number of connections that may simultaneously be queued to go to any member of this pool. The default is zero which indicates there is no limit. |
queueOnConnectionLimit |
string | disabled | optional | read/write | Enable or disable queuing connections when pool member or node connection limits are reached. When queuing is not enabled, new connections are reset when connection limits are met. |
queueTimeLimit |
integer | 0 | optional | read/write | Specifies the maximum time, in milliseconds, a connection will remain enqueued. The default is zero which indicates there is no limit. |
reselectTries |
integer | 0 | optional | read/write | Specifies the number of times the system tries to contact a pool member after a passive failure. A passive failure consists of a server-connect failure or a failure to receive a data response within a user-specified interval. The default is 0 (zero), which indicates no reselect attempts. |
serviceDownAction |
string | none | optional | read/write | Specifies the action to take if the service specified in the pool is marked down. The default value is none. |
slowRampTime |
integer | 10 | optional | read/write | Specifies, in seconds, the ramp time for the pool. This provides the ability to cause a pool member that has just been enabled, or marked up, to receive proportionally less traffic than other members in the pool. The proportion of traffic the member accepts is determined by how long the member has been up in comparison to the slow-ramp-time setting for the pool.For example, if the load-balancing-mode of a pool is round-robin, and it has a slow-ramp-time of 60 seconds, when a pool member has been up for only 30 seconds, the pool member receives approximately half the amount of new traffic as other pool members that have been up for more than 60 seconds. After the pool member has been up for 45 seconds, it receives approximately three quarters of the new traffic.The slow ramp time is particularly useful when used with the least-connections-member load balancing mode. The default value is 10. |
trafficAccelerationStatus |
string | none | optional | read/write |
Subcollections
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
members |
array_structure | optional | read/write | Manage the set of pool members that are associated with a load balancing pool |
Lists
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
profiles (net/tunnels/gre) |
array_structure | optional | read/write | Specifies the profile to use for encapsulation. The default value is none, which indicates no encapsulation. |
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 | ||
/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.