APIRef_tm_ltm_pool_members¶
mgmt/tm/ltm/pool/~resource id/members
Manage the set of pool members that are associated with a load balancing pool
REST Endpoints
- Collection URI
/mgmt/tm/ltm/pool/~resource id/members- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/ltm/pool/~resource id/members- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, partition, subPath
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
address |
string | optional | read/write | IP address of a pool member if a node by the given name does not already exist. | |
appService |
string | optional | read/write | ||
connectionLimit |
integer | 0 | optional | read/write | Specifies the maximum number of concurrent connections allowed for a pool member. The default value is 0 (zero). |
description |
string | optional | read/write | User defined description. | |
dynamicRatio |
integer | 1 | optional | read/write | Specifies a range of numbers that you want the system to use in conjunction with the ratio load balancing method. The default value is 1. |
ephemeral |
string | false | optional | read | |
inheritProfile |
string | enabled | optional | read/write | Specifies whether the pool member inherits the encapsulation profile from the parent pool. The default value is enabled. If you disable inheritance, no encapsulation takes place, unless you specify another encapsulation profile for the pool member using the profiles attribute. |
logging |
string | disabled | optional | read/write | Specifies whether the pool member’s monitor(s) actions will be logged. Logs are stored in /var/log/monitors/ |
monitor |
string | optional | read/write | Displays the health monitors that are configured to monitor the pool member, and the status of each monitor. The default value is default. | |
priorityGroup |
integer | 0 | optional | read/write | Specifies the priority group within the pool for this pool member. The priority group number specifies that traffic is directed to that member before being directed to a member of a lower priority. The default value is 0. |
rateLimit |
string | 0 | optional | read/write | Specifies the maximum number of connections per second allowed for a pool member. The default value is ‘disabled’. |
ratio |
integer | 1 | optional | read/write | Specifies the ratio weight that you want to assign to the pool member. The default value is 1. |
session |
string | user-enabled | optional | read/write | Enables or disables the pool member for new sessions. The default value is user-enabled. |
state |
string | optional | read/write | user-down forces the pool member offline, overriding monitors. user-up reverts the user-down. When user-up, this displays the monitor state. | |
trafficAccelerationStatus |
string | none | optional | read/write |
Lists
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
profiles (net/tunnels/gre) |
array_structure | optional | read/write |
Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/fqdn |
array_structure | optional | read/write | ||
/fqdn/autopopulate |
string | disabled | optional | read/write | |
/fqdn/name |
string | optional | read/write | ||
/fqdn/autopopulate |
string | disabled | optional | read/write | |
/fqdn/name |
string | 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 member. 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 member 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.