LTM/ADC Pool Member Management

Overview

API used to manage LTM pool members.

REST Endpoint: /mgmt/cm/adc-core/working-config/ltm/pool

Requests

GET /mgmt/cm/adc-core/working-config/ltm/pool

List all virtual pools items as a collection.

Request Parameters

None

Query Parameters

None

Response

HTTP/1.1 200 OK

Returns a properties_collection of virtual pools.

Name Type Description
generation integer(int64) A integer that will track change made to a virtual pool collection object. generation. optional, read-only
items < object > array A collection of pool members. properties defining items. optional
kind string Type information for this virtual pool collection object. optional, read-only
lastUpdateMicros integer(int64) Update time (micros) for last change made to an virtual pool collection object. time. optional, read-only
selfLink string A reference link URI to the virtual pool collection object. optional, read-only

HTTP/1.1 400 Bad Request

Error response “Bad Request”

Name Type Description
errorStack string Error stack trace returned by java. optional, read-only
items < object > array Collection of pool members. error response from server. optional, read-only
kind string Type information for pool member collections-cm:adc-core:working-config:ltm:pool:adcpoolstate. optional, read-only
message string Error message returned from server. optional, read-only
requestBody string The data in the request body. GET (None) optional, read-only
requestOperationId integer(int64) Unique id assigned to rest operation. optional, read-only

Permissions

Role Allow
Local Traffic & Network Deployer Yes
Local Traffic & Network Editor Yes
Local Traffic & Network Manager Yes
Local Traffic & Network Viewer Yes
Pool Member Operator Yes

GET /mgmt/cm/adc-core/working-config/ltm/pool/{objectId}

Get a single pool object identified by id for an endpoint URI.

Request Parameters

None

Query Parameters

Name Type Description
objectId string(UUID) Unique id assigned to a virtual pool. required

Response

HTTP/1.1 200 OK

Returns a single properties_pool object.

Name Type Description
allowNat boolean Is NAT (addess translation) allowed for application servers in this pool. optional
deviceReference object A reference link to a device (BIGIP) that virtual pool exists. Also additional data such as id, name, kind and machine id is provided. optional
     id string Unique id assigned to a device referenced by this object. optional
     kind string Type information for device. shared:resolver:device-groups:restdeviceresolverdevicestate optional
     link string Reference link to adc-core-allbigipDevices in shared resolver device-groups. optional
     machineId string Unique id assigned to the hardware device. If virtual could be the same as id object. optional
     name string A name used to identify this device. optional
enableQueueOnConnectionLimit boolean Enable or disable queuing connections when pool member or node connection limits are reached. optional
generation integer(int64) A integer that will track change made to a virtual pool object. generation. optional, read-only
id string Unique id assigned to a virtual pool object. optional, read-only
ignorePersistedWeight boolean Is the weight of persisted connections on pool members when making load balancing decisions counted. optional
ipTosToClientControl string Specifies the Type of Service (ToS) level to use when sending packets to a client. possible values on bigiq: 0 ~ 255 optional
ipTosToServerControl string Specifies the Type of Service (ToS) level to use when sending packets to a server. possible values on bigiq: 0 ~ 255 optional
kind string Type information for this virtual pool object. optional, read-only
lastUpdateMicros integer(int64) Update time (micros) for last change made to an virtual pool object. time. optional, read-only
linkQosToClient integer Specifies the Quality of Service (QoS) level to use when sending packets to a client. 0 ~ 7, 65535 (passthrough) optional
linkQosToServer integer Specifies the Quality of Service (QoS) level to use when sending packets to a server. 0 ~ 7, 65535 (passthrough) optional
loadBalancingMode string Specifies the modes that the system uses to load balance name resolution requests among the members of this pool. dynamic-ratio-member, least-connections-member, observed-node, ratio-least-connections-node, round-robin, dynamic-ratio-node, least-connections-node, predictive-member, ratio-member, weighted-least-connections-member, fastest-app-response, least-sessions, predictive-node, ratio-node, weighted-least-connections-node, fastest-node, observed-member, ratio-least-connections-member, ratio-session optional
membersCollectionReference object Reference link to collection of pool members (nodes). optional
     isSubcollection boolean Does a sub-collection for this object exist. True / False optional
     link string Reference link to a collection of pool members. optional
minActiveMembers integer Specifies the minimum number of members that must be up for traffic to be confined to a priority group when using priority-based activation. optional
name string Name of virtual pool. optional
partition string Partition location that pool and members are located. default Common optional
queueDepthLimit integer Specifies the maximum number of connections that may simultaneously be queued to go to any member of this pool. optional
queueTimeLimit integer Specifies the maximum time, in milliseconds, a connection will remain enqueued. When unset, there is no limit. optional
reselectTries integer Specifies the number of times the system tries to contact a pool member after a passive failure. optional
selfLink string A reference link URI to the virtual pool object. optional, read-only
serviceDownAction string Specifies the action to take if the service specified in the pool is marked down. The default value is none. optional
slowRampTime integer 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. optional

HTTP/1.1 400 Bad Request

Error response “Bad Request”

Name Type Description
errorStack string Error stack trace returned by java. optional, read-only
items < object > array Collection of pool members. error response from server. optional, read-only
kind string Type information for pool member collections-cm:adc-core:working-config:ltm:pool:adcpoolstate. optional, read-only
message string Error message returned from server. optional, read-only
requestBody string The data in the request body. GET (None) optional, read-only
requestOperationId integer(int64) Unique id assigned to rest operation. optional, read-only

Permissions

Role Allow
Local Traffic & Network Deployer Yes
Local Traffic & Network Editor Yes
Local Traffic & Network Manager Yes
Local Traffic & Network Viewer Yes
Pool Member Operator Yes

POST /mgmt/cm/adc-core/working-config/ltm/pool/{objectId}/members

Add a LTM node as a member of a virtual application pool.

Request Parameters

The post_pool_member_body input parameter list in Json format.

Name Type Description
partition string Partition where this application node lives. default Common required
name string Name of application node. required
port integer Port to request connection to node. required
nodeReference string Reference link to application node. required

Query Parameters

Name Type Description
objectId string(UUID) Unique id assigned to pool member object. required

Response

HTTP/1.1 200 OK

POST an item in propertiescollection to add a node to an application pool.

Name Type Description
generation integer(int64) A integer that will track change made to a virtual pool collection object. generation. optional, read-only
items < object > array A collection of pool members. properties defining items. optional
kind string Type information for this virtual pool collection object. optional, read-only
lastUpdateMicros integer(int64) Update time (micros) for last change made to an virtual pool collection object. time. optional, read-only
selfLink string A reference link URI to the virtual pool collection object. optional, read-only

HTTP/1.1 400 Bad Request

Error response “Bad Request”

Name Type Description
errorStack string Error stack trace returned by java. optional, read-only
items < object > array Collection of pool members. error response from server. optional, read-only
kind string Type information for pool member collections-cm:adc-core:working-config:ltm:pool:adcpoolstate. optional, read-only
message string Error message returned from server. optional, read-only
requestBody string The data in the request body. GET (None) optional, read-only
requestOperationId integer(int64) Unique id assigned to rest operation. optional, read-only

HTTP/1.1 404 Bad Request

Error response “Public URI path not registered.”

Permissions

Role Allow
Local Traffic & Network Deployer No
Local Traffic & Network Editor Yes
Local Traffic & Network Manager Yes
Local Traffic & Network Viewer No
Pool Member Operator No

DEL /mgmt/cm/adc-core/working-config/ltm/pool/{objectId}/members

Delete an application server node for a specific virtual pool.

Request Parameters

None

Query Parameters

Name Type Description
objectId string(UUID) Unique id assigned to pool member object. required

Response

HTTP/1.1 200 OK

Deletes an item from propertiescollection to delete a node from an application pool.

Name Type Description
generation integer(int64) A integer that will track change made to a virtual pool collection object. generation. optional, read-only
items < object > array A collection of pool members. properties defining items. optional
kind string Type information for this virtual pool collection object. optional, read-only
lastUpdateMicros integer(int64) Update time (micros) for last change made to an virtual pool collection object. time. optional, read-only
selfLink string A reference link URI to the virtual pool collection object. optional, read-only

HTTP/1.1 400 Bad Request

Error response “Bad Request”

Name Type Description
errorStack string Error stack trace returned by java. optional, read-only
items < object > array Collection of pool members. error response from server. optional, read-only
kind string Type information for pool member collections-cm:adc-core:working-config:ltm:pool:adcpoolstate. optional, read-only
message string Error message returned from server. optional, read-only
requestBody string The data in the request body. GET (None) optional, read-only
requestOperationId integer(int64) Unique id assigned to rest operation. optional, read-only

HTTP/1.1 404 Bad Request

Error response “Public URI path not registered.”

Permissions

Role Allow
Local Traffic & Network Deployer No
Local Traffic & Network Editor Yes
Local Traffic & Network Manager Yes
Local Traffic & Network Viewer No
Pool Member Operator No

GET /mgmt/cm/adc-core/working-config/ltm/pool/{objectId}/members

List all pool members as part of a collection.

Request Parameters

None

Query Parameters

Name Type Description
objectId string(UUID) Unique id assigned to a virtual pool. required

Response

HTTP/1.1 200 OK

Virtual pool members properties_collection object.

Name Type Description
generation integer(int64) A integer that will track change made to a virtual pool collection object. generation. optional, read-only
items < object > array A collection of pool members. properties defining items. optional
kind string Type information for this virtual pool collection object. optional, read-only
lastUpdateMicros integer(int64) Update time (micros) for last change made to an virtual pool collection object. time. optional, read-only
selfLink string A reference link URI to the virtual pool collection object. optional, read-only

HTTP/1.1 400 Bad Request

Error response “Bad Request”

Name Type Description
errorStack string Error stack trace returned by java. optional, read-only
items < object > array Collection of pool members. error response from server. optional, read-only
kind string Type information for pool member collections-cm:adc-core:working-config:ltm:pool:adcpoolstate. optional, read-only
message string Error message returned from server. optional, read-only
requestBody string The data in the request body. GET (None) optional, read-only
requestOperationId integer(int64) Unique id assigned to rest operation. optional, read-only

Permissions

Role Allow
Local Traffic & Network Deployer Yes
Local Traffic & Network Editor Yes
Local Traffic & Network Manager Yes
Local Traffic & Network Viewer Yes
Pool Member Operator Yes

GET /mgmt/cm/adc-core/working-config/ltm/pool/{objectId}/members/{objectId}

Used to get a single pool member (node) object identified by id for an endpoint URI.

Request Parameters

None

Query Parameters

Name Type Description
objectId string(UUID) Unique id assigned to a virtual pool. required

Response

HTTP/1.1 200 OK

Virtual pool member (node) properties_pool_members object.

Name Type Description
connectionLimit integer Number of connection allowed for pool member. optional
generation integer(int64) A integer that will track change made to a virtual pool member object. generation. optional, read-only
id string Unique id assigned to a virtual pool collection object. optional, read-only
kind string Type information for this virtual pool member object. optional, read-only
lastUpdateMicros integer(int64) Update time (micros) for last change made to an virtual pool member object. time. optional, read-only
name string Name of pool member. optional
nodeReference object Reference link to ltm nodes. optional
     link string Reference link to node specific to pool member configuration. optional
partition string Partition location that pool and members are located. default Common optional
port integer Port used for application connect. optional
priortyGroup integer Specifies the priority group within the pool for this pool member. optional
rateLimit string Specifies the maximum number of connections per second allowed for a pool member. The default value is ‘disabled optional
ratio integer Specifies the ratio weight that you want to assign to the pool member. The default value is 1. optional
selfLink string A reference link URI to the virtual pool member object. optional, read-only
sessionConfig string Enables or disables the node for new sessions. The default value is user-enabled. optional

HTTP/1.1 400 Bad Request

Error response “Bad Request”

Name Type Description
errorStack string Error stack trace returned by java. optional, read-only
items < object > array Collection of pool members. error response from server. optional, read-only
kind string Type information for pool member collections-cm:adc-core:working-config:ltm:pool:adcpoolstate. optional, read-only
message string Error message returned from server. optional, read-only
requestBody string The data in the request body. GET (None) optional, read-only
requestOperationId integer(int64) Unique id assigned to rest operation. optional, read-only

Permissions

Role Allow
Local Traffic & Network Deployer Yes
Local Traffic & Network Editor Yes
Local Traffic & Network Manager Yes
Local Traffic & Network Viewer Yes
Pool Member Operator Yes

Examples

None