Pool

Description

API


    POST /api/pool
    PUT /api/pool/<key>
    DELETE /api/pool/<key>
    GET /api/pool
    GET /api/pool/<key>

CLI


    configure pool <key>
    show pool <key>

Examples

To create a basic pool object that uses the least connections algorithm and has a couple of application servers in the backend

 POST /api/pool

{
    "lb_algorithm": "LB_ALGORITHM_LEAST_CONNECTIONS", 
    "default_server_port": 80, 
    "name": "production_pool", 
    "servers": [
        {
            "ip": {
                "type": "V4", 
                "addr": "10.10.90.120"
            }
        }, 
        {
            "ip": {
                "type": "V4", 
                "addr": "10.10.90.121"
            }
        }
    ]
}
 

Data

Pool

uuid

Type
string
Category
required
Description
UUID of the pool

name

Type
string
Category
required
Description
The name of the pool.

default_server_port

Type
int32
Category
optional
Description
Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The SSL checkbox enables Avi to server encryption.
Default
80

graceful_disable_timeout

Type
int32
Category
optional
Description
Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled.
Default
1

connection_ramp_duration

Type
int32
Category
optional
Description
Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for LB algorithms that are least connection based.
Default
10

max_concurrent_connections_per_server

Type
int32
Category
optional
Description
The maximum number of concurrent connections allowed to each server within the pool.
Default
0

health_monitor_refs

Type
Reference to HealthMonitor
Category
repeated
Description
Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each Service Engine and mark a server up or down based on the response. The Passive monitor listens to client to server communication and raises or lowers the ratio of traffic destined to a server based on successful responses.

servers

Type
Server
Category
repeated
Description
The pool directs load balanced traffic to this list of destination servers. The servers can be configured by IP address, name, network or via IP Address Group

server_count

Type
int32
Category
optional
Description
Default
0

lb_algorithm

Type
enum
Category
optional
Description
The load balancing algorithm will pick a server within the pool's list of available servers.
Default
LB_ALGORITHM_LEAST_CONNECTIONS
Choices
LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_LEAST_CONNECTIONS

lb_algorithm_hash

Type
enum
Category
optional
Description
Criteria used as a key for determining the hash between the client and server.
Default
LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS
Choices
LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_URI

lb_algorithm_consistent_hash_hdr

Type
string
Category
optional
Description
HTTP header name to be used for the hash key.

networks

Type
NetworkFilter
Category
repeated
Description
(internal-use) Networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by Avi, not editable by the user.

placement_networks

Type
PlacementNetwork
Category
repeated
Description
Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the Subnet using the following syntax: 10.1.1.0/24. If the Pool Servers are not directly connected, but routable from the ServiceEngine, please also provide the appropriate static routes to reach the Servers in the VRF configuration.

application_persistence_profile_ref

Type
Reference to ApplicationPersistenceProfile
Category
optional
Description
Persistence will ensure the same user sticks to the same server for a desired duration of time.

ssl_profile_ref

Type
Reference to SSLProfile
Category
optional
Description
When enabled, Avi re-encrypts traffic to the backend servers. The specific SSL profile defines which ciphers and SSL versions will be supported.

inline_health_monitor

Type
bool
Category
optional
Description
The Passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the LB method, such as Round Robin.
Default
True

use_service_port

Type
bool
Category
optional
Description
Do not translate the client's destination port when sending the connection to the server. The pool or servers specified service port will still be used for health monitoring. This feature is only applicable for a Virtual Service configured with the application type set to L4.
Default
False

fail_action

Type
FailAction
Category
optional
Description
Enable an action - Close Connection, HTTP Redirect, Local HTTP Response, or Backup Pool - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure.

capacity_estimation

Type
bool
Category
optional
Description
Inline estimation of capacity of servers.
Default
False

capacity_estimation_ttfb_thresh

Type
uint32
Category
optional
Description
The maximum time-to-first-byte of a server.
Default
0

pki_profile_ref

Type
Reference to PKIProfile
Category
optional
Description
Avi will validate the SSL certificate present by a server against the selected PKI Profile.

ssl_key_and_certificate_ref

Type
Reference to SSLKeyAndCertificate
Category
optional
Description
Service Engines will present a client SSL certificate to the server.

server_auto_scale

Type
bool
Category
optional
Description
Server AutoScale. Not used anymore.
Default
False

prst_hdr_name

Type
string
Category
optional
Description
Header name for custom header persistence

apic_epg_name

Type
string
Category
optional
Description
Synchronize Cisco APIC EPG members with pool servers

autoscale_networks

Type
string
Category
repeated
Description
Network Ids for the launch configuration

autoscale_policy_ref

Type
Reference to ServerAutoScalePolicy
Category
optional
Description
Reference to Server Autoscale Policy

autoscale_launch_config_ref

Type
Reference to AutoScaleLaunchConfig
Category
optional
Description
Reference to the Launch Configuration Profile

vrf_ref

Type
Reference to VrfContext
Category
optional,readonly
Description
Virtual Routing Context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the Virtual Routing Conext of the Virtual Service, and this field is used only internally, and is set by pb-transform.

ipaddrgroup_ref

Type
Reference to IpAddrGroup
Category
optional
Description
Use list of servers from Ip Address Group

fewest_tasks_feedback_delay

Type
uint32
Category
optional
Description
Periodicity of feedback for fewest tasks server selection algorithm.
Default
10

enabled

Type
bool
Category
optional
Description
Enable or disable the pool. Disabling will terminate all open connections and pause health monitors.
Default
True

max_conn_rate_per_server

Type
RateProfile
Category
optional
Description
Rate Limit connections to each server.

east_west

Type
bool
Category
optional
Description
Inherited config from VirtualService.

created_by

Type
string
Category
optional
Description
Creator name

cloud_config_cksum

Type
string
Category
optional
Description
Checksum of cloud configuration for Pool. Internally set by cloud connector

request_queue_enabled

Type
bool
Category
optional
Description
Enable request queue when pool is full
Default
False

request_queue_depth

Type
uint32
Category
optional
Description
Minimum number of requests to be queued when pool is full.
Default
128

ab_pool

Type
AbPool
Category
optional
Description
A/B pool configuration.

server_reselect

Type
HTTPServerReselect
Category
optional
Description
Server reselect configuration for HTTP requests.

a_pool

Type
string
Category
optional
Description
Name of container cloud application that constitutes A pool in a A-B pool configuration, if different from VS app

ab_priority

Type
uint32
Category
optional
Description
Priority of this pool in a A-B pool pair. Internally used

host_check_enabled

Type
bool
Category
optional
Description
Enable common name check for server certificate. If enabled and no explicit domain name is specified, Avi will use the incoming host header to do the match.
Default
False

domain_name

Type
string
Category
repeated
Description
Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates if common name check (host_check_enabled) is enabled.

sni_enabled

Type
bool
Category
optional
Description
Enable TLS SNI for server connections. If disabled, Avi will not send the SNI extension as part of the handshake.
Default
True

server_name

Type
string
Category
optional
Description
Fully qualified DNS hostname which will be used in the TLS SNI extension in server connections if SNI is enabled. If no value is specified, Avi will use the incoming host header instead.

rewrite_host_header_to_sni

Type
bool
Category
optional
Description
If SNI server name is specified, rewrite incoming host header to the SNI server name.
Default
False

rewrite_host_header_to_server_name

Type
bool
Category
optional
Description
Rewrite incoming Host Header to server name of the server to which the request is proxied. Enabling this feature rewrites Host Header for requests to all servers in the pool.
Default
False

description

Type
string
Category
optional
Description
A description of the pool.

tenant_ref

Type
Reference to Tenant
Category
optional
Description

cloud_ref

Type
Reference to Cloud
Category
optional,readonly
Description
Default
/api/cloud?name=Default-Cloud

Server

ip

Type
IpAddr
Category
required
Description
IP Address of the server. Required if there is no resolvable host name.

port

Type
int32
Category
optional
Description
Optionally specify the servers port number. This will override the pool's default server port attribute.

hostname

Type
string
Category
optional
Description
DNS resolvable name of the server. May be used in place of the IP address.

enabled

Type
bool
Category
optional
Description
Enable, Disable or Graceful Disable determine if new or existing connections to the server are allowed.
Default
True

ratio

Type
int32
Category
optional
Description
Ratio of selecting eligible servers in the pool
Default
1

vm_ref

Type
Reference to VIMgrVMRuntime
Category
optional
Description
(internal-use) This field is used internally by Avi, not editable by the user.

nw_ref

Type
Reference to VIMgrNWRuntime
Category
optional
Description
(internal-use) This field is used internally by Avi, not editable by the user.

discovered_network_ref

Type
Reference to Network
Category
repeated
Description
(internal-use) Discovered network for this server. This field is deprecated.

external_uuid

Type
string
Category
optional
Description
UUID identifying VM in OpenStack and other external compute

discovered_subnet

Type
IpAddrPrefix
Category
repeated
Description
(internal-use) Discovered subnet for this server. This field is deprecated.

verify_network

Type
bool
Category
optional
Description
Verify server belongs to a discovered network or reachable via a discovered network. Verify reachable network isn't the OpenStack management network
Default
False

discovered_networks

Type
DiscoveredNetwork
Category
repeated
Description
(internal-use) Discovered networks providing reachability for server IP. This field is used internally by Avi, not editable by the user.

resolve_server_by_dns

Type
bool
Category
optional
Description
Auto resolve server's IP using DNS name
Default
False

prst_hdr_val

Type
string
Category
optional
Description
Header value for custom header persistence.

mac_address

Type
string
Category
optional
Description
MAC address of server.

static

Type
bool
Category
optional
Description
If statically learned.
Default
False

server_node

Type
string
Category
optional
Description
Hostname of the node where the server VM or container resides

availability_zone

Type
string
Category
optional
Description
Availability-zone of the server VM.

rewrite_host_header

Type
bool
Category
optional
Description
Rewrite incoming Host Header to server name.
Default
False

external_orchestration_id

Type
string
Category
optional
Description
UID of server in external orchestration systems

description

Type
string
Category
optional
Description
A description of the Server.

IpAddr

addr

Type
string
Category
required
Description
IP address

type

Type
enum
Category
required
Description
Choices
V4, DNS

IpAddrPrefix

ip_addr

Type
IpAddr
Category
required
Description

mask

Type
int32
Category
required
Description

DiscoveredNetwork

network_ref

Type
Reference to Network
Category
required
Description
Discovered network for this IP.

subnet

Type
IpAddrPrefix
Category
repeated
Description
Discovered subnet for this IP.

NetworkFilter

network_ref

Type
Reference to VIMgrNWRuntime
Category
required
Description

server_filter

Type
string
Category
optional
Description

PlacementNetwork

network_ref

Type
Reference to Network
Category
required
Description

subnet

Type
IpAddrPrefix
Category
optional
Description

FailAction

type

Type
enum
Category
required
Description
Enables a response to client when pool experiences a failure. By default TCP connection is closed.
Default
FAIL_ACTION_CLOSE_CONN
Choices
FAIL_ACTION_BACKUP_POOL, FAIL_ACTION_CLOSE_CONN, FAIL_ACTION_HTTP_LOCAL_RSP, FAIL_ACTION_HTTP_REDIRECT

redirect

Type
FailActionHTTPRedirect
Category
optional
Description
URL to redirect HTTP requests to when pool experiences a failure

local_rsp

Type
FailActionHTTPLocalResponse
Category
optional
Description
Local response to HTTP requests when pool experiences a failure

backup_pool

Type
FailActionBackupPool
Category
optional
Description
Backup Pool when pool experiences a failure

FailActionHTTPRedirect

protocol

Type
enum
Category
optional
Description
Default
HTTPS
Choices
HTTP, HTTPS

host

Type
string
Category
required
Description

path

Type
string
Category
optional
Description

query

Type
string
Category
optional
Description

status_code

Type
enum
Category
optional
Description
Default
HTTP_REDIRECT_STATUS_CODE_302
Choices
HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_307

FailActionHTTPLocalResponse

status_code

Type
enum
Category
optional
Description
Default
FAIL_HTTP_STATUS_CODE_503
Choices
FAIL_HTTP_STATUS_CODE_503, FAIL_HTTP_STATUS_CODE_200

file

Type
HTTPLocalFile
Category
optional
Description

HTTPLocalFile

content_type

Type
string
Category
required
Description
Mime-type of the content in the file.

file_content

Type
string
Category
required
Description
File content to used in the local HTTP response body.

FailActionBackupPool

backup_pool_ref

Type
Reference to Pool
Category
required
Description
Specifies the UUID of the Pool acting as backup pool.

RateProfile

count

Type
int32
Category
optional
Description
Maximum number of connections or requests or packets
Default
0

burst_sz

Type
int32
Category
optional
Description
Maximum number of connections or requests or packets to be let through instantaneously
Default
0

period

Type
int32
Category
optional
Description
Time value in seconds to enforce rate count
Default
1

explicit_tracking

Type
bool
Category
optional
Description
Explicitly tracks an attacker across rate periods
Default
False

fine_grain

Type
bool
Category
optional
Description
Enable fine granularity
Default
False

action

Type
RateLimiterAction
Category
optional
Description
Action to perform upon rate limiting

RateLimiterAction

type

Type
enum
Category
optional
Description
Type of action to be enforced upon hitting the rate limit.
Default
RL_ACTION_NONE
Choices
RL_ACTION_RESET_CONN, RL_ACTION_LOCAL_RSP, RL_ACTION_DROP_CONN, RL_ACTION_CLOSE_CONN, RL_ACTION_NONE, RL_ACTION_REDIRECT

redirect

Type
HTTPRedirectAction
Category
optional
Description
Parameters for HTTP Redirect rate limit action.

status_code

Type
enum
Category
optional
Description
HTTP status code for Local Response rate limit action.
Default
HTTP_LOCAL_RESPONSE_STATUS_CODE_429
Choices
HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_404

file

Type
HTTPLocalFile
Category
optional
Description
File to be used for HTTP Local response rate limit action.

HTTPRedirectAction

protocol

Type
enum
Category
required
Description
Protocol type
Choices
HTTP, HTTPS

host

Type
URIParam
Category
optional
Description
Host config

port

Type
uint32
Category
optional
Description
Port to which redirect the request

path

Type
URIParam
Category
optional
Description
Path config

keep_query

Type
bool
Category
optional
Description
Keep or drop the query of the incoming request URI in the redirected URI
Default
True

status_code

Type
enum
Category
optional
Description
HTTP redirect status code
Default
HTTP_REDIRECT_STATUS_CODE_302
Choices
HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_307

URIParam

type

Type
enum
Category
required
Description
URI param type
Choices
URI_PARAM_TYPE_TOKENIZED

tokens

Type
URIParamToken
Category
repeated
Description
Token config either for the URI components or a constant string

URIParamToken

type

Type
enum
Category
required
Description
Token type for constructing the URI
Choices
URI_TOKEN_TYPE_PATH, URI_TOKEN_TYPE_REGEX, URI_TOKEN_TYPE_STRING, URI_TOKEN_TYPE_STRING_GROUP, URI_TOKEN_TYPE_HOST

start_index

Type
uint32
Category
optional
Description
Index of the starting token in the incoming URI

end_index

Type
uint32
Category
optional
Description
Index of the ending token in the incoming URI

str_value

Type
string
Category
optional
Description
Constant string to use as a token

AbPool

pool_ref

Type
Reference to Pool
Category
required
Description
Pool configured as B pool for A/B testing

ratio

Type
uint32
Category
optional
Description
Ratio of traffic diverted to the B pool, for A/B testing
Default
0

HTTPServerReselect

enabled

Type
bool
Category
required
Description
Enable HTTP request reselect when server responds with specific response codes.
Default
False

svr_resp_code

Type
HTTPReselectRespCode
Category
optional
Description
Server response codes which will trigger an HTTP request retry.

num_retries

Type
uint32
Category
optional
Description
Number of times to retry an HTTP request when server responds with configured status codes.
Default
4

retry_nonidempotent

Type
bool
Category
optional
Description
Allow retry of non-idempotent HTTP requests.
Default
False

HTTPReselectRespCode

codes

Type
int32
Category
repeated
Description
HTTP response code to be matched.

ranges

Type
HTTPStatusRange
Category
repeated
Description
HTTP response code ranges to match.

resp_code_block

Type
enum
Category
repeated
Description
Block of HTTP response codes to match for server reselect.
Choices
HTTP_RSP_5XX, HTTP_RSP_4XX

HTTPStatusRange

begin

Type
int32
Category
required
Description
Starting HTTP response status code

end

Type
int32
Category
required
Description
Ending HTTP response status code

Actions

API


    POST /api/pool/<key>/scalein

CLI


    scalein pool <key>

Data

ServerScaleInParams

reason

Type
string
Category
optional
Description
Reason for manual scalein.

servers

Type
ServerId
Category
repeated
Description
List of server IDs that should be scaled in.

ServerId

ip

Type
IpAddr
Category
required
Description

port

Type
uint32
Category
required
Description

external_uuid

Type
string
Category
optional
Description
This is the Pool servers external uuid

API


    POST /api/pool/<key>/scaleout

CLI


    scaleout pool <key>

Data

ServerScaleOutParams

reason

Type
string
Category
optional
Description
Reason for manual scaleout.

References

Network PKIProfile Cloud SSLKeyAndCertificate VIMgrNWRuntime IpAddrGroup SSLProfile HealthMonitor AutoScaleLaunchConfig ServerAutoScalePolicy VIMgrVMRuntime Tenant VrfContext Pool ApplicationPersistenceProfile

Sub Objects

HealthMonitorRuntime

API


    GET /api/pool/<key>/hmon/<key>

CLI


    show pool <key> hmon

Data

HealthMonitorRuntime

health_monitor

Type
HealthMonitor
Category
repeated
Description

se_uuid

Type
string
Category
optional
Description

proc_id

Type
string
Category
optional
Description

HealthMonitor

uuid

Type
string
Category
required
Description
UUID of the health monitor.

name

Type
string
Category
required
Description
A user friendly name for this health monitor.

send_interval

Type
int32
Category
optional
Description
Frequency, in seconds, that monitors are sent to a server.
Default
10

receive_timeout

Type
int32
Category
optional
Description
A valid response from the server is expected within the receive timeout window. This timeout must be less than the send interval. If server status is regularly flapping up and down, consider increasing this value.
Default
4

successful_checks

Type
int32
Category
optional
Description
Number of continuous successful health checks before server is marked up.
Default
2

failed_checks

Type
int32
Category
optional
Description
Number of continuous failed health checks before the server is marked down.
Default
2

type

Type
enum
Category
required
Description
Type of the health monitor.
Choices
HEALTH_MONITOR_TCP, HEALTH_MONITOR_HTTPS, HEALTH_MONITOR_EXTERNAL, HEALTH_MONITOR_UDP, HEALTH_MONITOR_DNS, HEALTH_MONITOR_HTTP, HEALTH_MONITOR_GSLB, HEALTH_MONITOR_PING

tcp_monitor

Type
HealthMonitorTcp
Category
optional
Description

http_monitor

Type
HealthMonitorHttp
Category
optional
Description

https_monitor

Type
HealthMonitorHttp
Category
optional
Description

external_monitor

Type
HealthMonitorExternal
Category
optional
Description

udp_monitor

Type
HealthMonitorUdp
Category
optional
Description

dns_monitor

Type
HealthMonitorDNS
Category
optional
Description

monitor_port

Type
int32
Category
optional
Description
Use this port instead of the port defined for the server in the Pool. If the monitor succeeds to this port, the load balanced traffic will still be sent to the port of the server defined within the Pool.

description

Type
string
Category
optional
Description

tenant_ref

Type
Reference to Tenant
Category
required
Description

HealthMonitorTcp

tcp_request

Type
string
Category
optional
Description
Request data to send after completing the TCP handshake.

tcp_response

Type
string
Category
optional
Description
Match for the desired keyword in the first 2Kb of the server's TCP response. If this field is left blank, no server response is required.

maintenance_response

Type
string
Category
optional
Description
Match or look for this keyword in the first 2KB of server's response indicating server maintenance. A successful match results in the server being marked down.

tcp_half_open

Type
bool
Category
optional
Description
Configure TCP health monitor to use half-open TCP connections to monitor the health of backend servers thereby avoiding consumption of a full fledged server side connection and the overhead and logs associated with it. This method is light-weight as it makes use of listener in server's kernel layer to measure the health and a child socket or user thread is not created on the server side.
Default
False

HealthMonitorHttp

http_request

Type
string
Category
optional
Description
Send an HTTP request to the server. The default GET / HTTP/1.0 may be extended with additional headers or information. For instance, GET /index.htm HTTP/1.1 Host: www.site.com Connection: Close
Default
GET / HTTP/1.0

http_response_code

Type
enum
Category
repeated
Description
List of HTTP response codes to match as successful. Default is 2xx.
Choices
HTTP_1XX, HTTP_3XX, HTTP_2XX, HTTP_5XX, HTTP_4XX, HTTP_ANY

http_response

Type
string
Category
optional
Description
Match for a keyword in the first 2Kb of the server header and body response.

maintenance_code

Type
uint32
Category
repeated
Description
Match or look for this HTTP response code indicating server maintenance. A successful match results in the server being marked down.

maintenance_response

Type
string
Category
optional
Description
Match or look for this keyword in the first 2KB of server header and body response indicating server maintenance. A successful match results in the server being marked down.

HealthMonitorExternal

command_path

Type
string
Category
optional
Description
Path of external health monitor script.

command_parameters

Type
string
Category
optional
Description
Optional arguments to feed into the script.

command_code

Type
string
Category
required
Description
Command script provided inline.

command_variables

Type
string
Category
optional
Description
Environment variables to be fed into the script.

HealthMonitorUdp

udp_request

Type
string
Category
optional
Description
Send UDP request.

udp_response

Type
string
Category
optional
Description
Match for keyword in the UDP response.

maintenance_response

Type
string
Category
optional
Description
Match or look for this keyword in the first 2KB of server's response indicating server maintenance. A successful match results in the server being marked down.

HealthMonitorDNS

query_name

Type
string
Category
required
Description
The DNS monitor will query the DNS server for the fully qualified name in this field.

qtype

Type
enum
Category
optional
Description
Query_Type: Response has atleast one answer of which the resource record type matches the query type Any_Type: Response should contain atleast one answer AnyThing: An empty answer is enough
Default
DNS_QUERY_TYPE
Choices
DNS_ANY_TYPE, DNS_ANY_THING, DNS_QUERY_TYPE

rcode

Type
enum
Category
optional
Description
When No Error is selected, a DNS query will be marked failed is any error code is returned by the server. With Any selected, the monitor ignores error code in the responses.
Default
RCODE_NO_ERROR
Choices
RCODE_NO_ERROR, RCODE_ANYTHING

response_string

Type
string
Category
optional
Description
The resource record of the queried DNS server's response for the Request Name must include the IP address defined in this field.

ServerRuntimeDetail

API


    GET /api/pool/<key>/runtime/server/detail/<key>
	Query Params: SeParamsFilter	ServerFilter

CLI


    show pool <key> server detail filter [primary_only] [disable_aggregate] [se_uuid] [all_se] [server_ip] [server_mask] [server_end_ip] [server_port]

Data

ServerRuntimeDetail

ip_addr

Type
IpAddr
Category
required
Description

port

Type
int32
Category
required
Description

oper_status

Type
OperationalStatus
Category
optional
Description

server_l4stats

Type
ServerL4Stats
Category
optional
Description

server_l7stats

Type
ServerL7Stats
Category
optional
Description

l7cp_stats

Type
ConnpoolStatsBase
Category
optional
Description

app_info

Type
AppInfo
Category
repeated
Description

proc_id

Type
string
Category
optional
Description

se_uuid

Type
string
Category
optional
Description

capest_data

Type
CapestData
Category
repeated
Description

capacity

Type
uint32
Category
optional
Description

capest_scale_hist

Type
float
Category
repeated
Description

capest_rand_max_conn_hist

Type
uint32
Category
repeated
Description

OperationalStatus

state

Type
enum
Category
optional
Description
Choices
OPER_PROCESSING, OPER_UPGRADING, OPER_CREATING, OPER_RESOURCES, OPER_SE_PROCESSING, OPER_AWAIT_MANUAL_PLACEMENT, OPER_ERROR_DISABLED, OPER_UNKNOWN, OPER_PARTITIONED, OPER_FAILED, OPER_UP, OPER_DISABLING, OPER_UNUSED, OPER_INITIALIZING, OPER_INACTIVE, OPER_DOWN, OPER_UNAVAIL, OPER_DISABLED

reason

Type
string
Category
repeated
Description

reason_code

Type
uint64
Category
optional
Description

last_changed_time

Type
TimeStamp
Category
optional
Description

reason_code_string

Type
string
Category
optional
Description

TimeStamp

secs

Type
Unknown
Category
required
Description

usecs

Type
Unknown
Category
required
Description

ServerL4Stats

node_obj_id

Type
string
Category
required
Description

conn_duration

Type
uint64
Category
required
Description

dup_ack_retransmits

Type
uint64
Category
required
Description

sack_retransmits

Type
uint64
Category
required
Description

timeout_retransmits

Type
uint64
Category
required
Description

out_of_orders

Type
uint64
Category
required
Description

syns_sent

Type
uint64
Category
required
Description

new_established_conns

Type
uint64
Category
required
Description

complete_conns

Type
uint64
Category
required
Description

finished_conns

Type
uint64
Category
required
Description

open_conns

Type
uint64
Category
required
Description

connections_dropped

Type
uint64
Category
required
Description

lossy_connections

Type
uint64
Category
required
Description

errored_connections

Type
uint64
Category
required
Description

rx_pkts

Type
uint64
Category
required
Description

rx_bytes

Type
uint64
Category
required
Description

tx_pkts

Type
uint64
Category
required
Description

tx_bytes

Type
uint64
Category
required
Description

tx_goodput

Type
uint64
Category
required
Description

rx_goodput

Type
uint64
Category
required
Description

rx_pkts_absolute

Type
uint64
Category
required
Description

rx_bytes_absolute

Type
uint64
Category
required
Description

tx_pkts_absolute

Type
uint64
Category
required
Description

tx_bytes_absolute

Type
uint64
Category
required
Description

rx_zero_window_size_events

Type
uint64
Category
required
Description

rx_tcp_resets

Type
uint64
Category
required
Description

connection_setup_time

Type
uint64
Category
required
Description

rtt

Type
uint64
Category
required
Description

rtt_valid_connections

Type
uint64
Category
required
Description

server_uptime

Type
uint64
Category
required
Description

num_state_changes

Type
uint64
Category
required
Description

health_check_failures

Type
uint64
Category
required
Description
Default
0

health_status

Type
uint64
Category
required
Description
Default
0

conn_dropped_before_syn_sent

Type
uint64
Category
required
Description

conn_dropped_before_est

Type
uint64
Category
required
Description

conn_dropped_after_est

Type
uint64
Category
required
Description

lb_fail_count

Type
uint64
Category
required
Description
Number of times load balancing failed

server_count

Type
uint64
Category
required
Description

lossy_req

Type
uint64
Category
optional
Description

tx_zero_window_size_events

Type
uint64
Category
optional
Description

capacity

Type
uint64
Category
optional
Description
This reflects capacity of the servers as measured from SE as C_i.

available_capacity

Type
uint64
Category
optional
Description
This reflects available capacity of the servers as measured from SE as C_i - L_i.

est_capacity

Type
uint64
Category
optional
Description
This reflects capacity of the servers as measured from SE as C_i.

ServerL7Stats

node_obj_id

Type
string
Category
required
Description

get_reqs

Type
uint64
Category
required
Description

post_reqs

Type
uint64
Category
required
Description

other_reqs

Type
uint64
Category
required
Description

finished_sessions

Type
uint64
Category
required
Description

reqs_finished_sessions

Type
uint64
Category
required
Description

concurrent_sessions

Type
uint64
Category
required
Description

resp_1xx

Type
uint64
Category
required
Description

resp_2xx

Type
uint64
Category
required
Description

resp_3xx

Type
uint64
Category
required
Description

resp_4xx

Type
uint64
Category
required
Description

resp_4xx_errors

Type
uint64
Category
required
Description

resp_5xx

Type
uint64
Category
required
Description

resp_5xx_errors

Type
uint64
Category
required
Description

get_resp_latency_bucket1

Type
uint64
Category
required
Description

get_resp_latency_bucket2

Type
uint64
Category
required
Description

post_resp_latency_bucket1

Type
uint64
Category
required
Description

post_resp_latency_bucket2

Type
uint64
Category
required
Description

other_resp_latency_bucket1

Type
uint64
Category
required
Description

other_resp_latency_bucket2

Type
uint64
Category
required
Description

get_resp_latency

Type
uint64
Category
required
Description

post_resp_latency

Type
uint64
Category
required
Description

other_resp_latency

Type
uint64
Category
required
Description

timeouts

Type
uint64
Category
required
Description

total_requests

Type
uint64
Category
required
Description

complete_responses

Type
uint64
Category
required
Description

total_responses

Type
uint64
Category
required
Description

application_response_time

Type
uint64
Category
required
Description

error_responses

Type
uint64
Category
required
Description

lb_fail_count

Type
uint64
Category
required
Description
Number of times load balancing failed

server_count

Type
uint64
Category
required
Description

ConnpoolStatsBase

free_size

Type
uint64
Category
required
Description

num_requested

Type
uint64
Category
required
Description

num_adds

Type
uint64
Category
required
Description

num_dels

Type
uint64
Category
required
Description

num_reused

Type
uint64
Category
required
Description

num_error_evicts

Type
uint64
Category
required
Description

bound_size

Type
uint64
Category
required
Description

busy_size

Type
uint64
Category
required
Description

AppInfo

app_hdr_name

Type
string
Category
required
Description

app_hdr_value

Type
string
Category
required
Description

CapestData

conns

Type
uint32
Category
required
Description

ttfb

Type
uint32
Category
required
Description

ConnpoolStats

API


CLI


Data

ConnpoolStats

free_size

Type
uint64
Category
required
Description

num_requested

Type
uint64
Category
required
Description

num_adds

Type
uint64
Category
required
Description

num_dels

Type
uint64
Category
required
Description

num_reused

Type
uint64
Category
required
Description

num_error_evicts

Type
uint64
Category
required
Description

num_reuse_evicts

Type
uint64
Category
required
Description

num_idle_evicts

Type
uint64
Category
required
Description

num_full_evicts

Type
uint64
Category
required
Description

bound_size

Type
uint64
Category
required
Description

num_close_evicts

Type
uint64
Category
required
Description

num_full_uncached

Type
uint64
Category
required
Description

busy_size

Type
uint64
Category
required
Description

num_lifetimes

Type
uint64
Category
required
Description

Actions

API


    POST /api/pool/<key>/connpoolstats/clear

CLI


    clear pool <key> connpoolstats

HttpCacheStatsDetail

API


    GET /api/pool/<key>/httpcachestats/detail/<key>
	Query Params: SeParamsFilter

CLI


    show pool <key> httpcachestats detail filter [primary_only] [disable_aggregate] [se_uuid] [all_se]

Data

HttpCacheStatsDetail

se_uuid

Type
string
Category
required
Description

proc_id

Type
string
Category
required
Description

available_size

Type
uint64
Category
required
Description

meta_size

Type
uint64
Category
required
Description

lookups

Type
uint64
Category
required
Description

shm_fail

Type
uint32
Category
required
Description

msplit_fail

Type
uint32
Category
required
Description

mcopy_fail

Type
uint32
Category
required
Description

local_evicts

Type
uint32
Category
required
Description

global_evicts

Type
uint32
Category
required
Description

etype_objects

Type
HttpCacheETypeStats
Category
repeated
Description

etype_adds

Type
HttpCacheETypeStats
Category
repeated
Description

incoming

Type
HttpCacheStatsObj
Category
required
Description

outgoing

Type
HttpCacheStatsObj
Category
required
Description

fetch

Type
HttpCacheStat
Category
repeated
Description

store

Type
HttpCacheStat
Category
repeated
Description

reval

Type
HttpCacheStat
Category
repeated
Description

store_out

Type
HttpCacheStat
Category
repeated
Description

HttpCacheETypeStats

encoding

Type
string
Category
required
Description

count

Type
int32
Category
required
Description

HttpCacheStatsObj

data_size

Type
uint64
Category
required
Description

objects

Type
uint64
Category
required
Description

hits

Type
uint64
Category
required
Description

hits_expired

Type
uint64
Category
required
Description

additions

Type
uint64
Category
required
Description

deletions

Type
uint64
Category
required
Description

overwrite_evicts

Type
uint64
Category
required
Description

out_of_mem_evicts

Type
uint64
Category
required
Description

served_bytes

Type
uint64
Category
required
Description

HttpCacheStat

name

Type
string
Category
required
Description

count

Type
int32
Category
required
Description

PoolDebug

API


    GET /api/pool/<key>/runtime/debug/<key>

CLI


    show pool <key> debug

Data

PoolDebug

uuid

Type
string
Category
optional
Description

oper_status

Type
OperationalStatus
Category
optional
Description

hmon_stat

Type
HealthMonitorStatRuntime
Category
repeated
Description

HealthMonitorStatRuntime

last_transition_timestamp_3

Type
TimeStamp
Category
optional
Description

last_transition_timestamp_2

Type
TimeStamp
Category
optional
Description

last_transition_timestamp_1

Type
TimeStamp
Category
optional
Description

server_hm_stat

Type
ServerHMStatRuntime
Category
repeated
Description

se_uuid

Type
string
Category
optional
Description

proc_id

Type
string
Category
optional
Description

ServerHMStatRuntime

server_name

Type
string
Category
optional
Description

oper_status

Type
OperationalStatus
Category
optional
Description

last_transition_timestamp_3

Type
TimeStamp
Category
optional
Description

last_transition_timestamp_2

Type
TimeStamp
Category
optional
Description

last_transition_timestamp_1

Type
TimeStamp
Category
optional
Description

shm_runtime

Type
ServerHealthMonitorRuntime
Category
repeated
Description

ip_addr

Type
IpAddr
Category
optional
Description

port

Type
int32
Category
optional
Description

ServerHealthMonitorRuntime

health_monitor_name

Type
string
Category
optional
Description

uuid

Type
string
Category
optional
Description

health_monitor_type

Type
enum
Category
required
Description
Choices
HEALTH_MONITOR_TCP, HEALTH_MONITOR_HTTPS, HEALTH_MONITOR_EXTERNAL, HEALTH_MONITOR_UDP, HEALTH_MONITOR_DNS, HEALTH_MONITOR_HTTP, HEALTH_MONITOR_GSLB, HEALTH_MONITOR_PING

last_transition_timestamp_3

Type
TimeStamp
Category
optional
Description

last_transition_timestamp_2

Type
TimeStamp
Category
optional
Description

last_transition_timestamp_1

Type
TimeStamp
Category
optional
Description

state

Type
int32
Category
required
Description

rise_count

Type
uint32
Category
required
Description

fall_count

Type
uint32
Category
required
Description

total_checks

Type
uint32
Category
optional
Description

total_failed_checks

Type
uint32
Category
optional
Description

total_count

Type
ServerHealthMonitorCounter
Category
repeated
Description

curr_count

Type
ServerHealthMonitorCounter
Category
repeated
Description

hm_initial

Type
uint32
Category
optional
Description

hm_icmp_id

Type
uint32
Category
optional
Description

hm_icmp_seq

Type
uint32
Category
optional
Description

hm_icmp_accept_rsp

Type
uint32
Category
optional
Description

avg_response_time

Type
uint64
Category
optional
Description

recent_response_time

Type
uint64
Category
optional
Description

min_response_time

Type
uint64
Category
optional
Description

max_response_time

Type
uint64
Category
optional
Description

port

Type
uint32
Category
optional
Description

protocol

Type
uint32
Category
optional
Description

request_string

Type
string
Category
optional
Description

response_string

Type
string
Category
optional
Description

bad_response_string

Type
string
Category
optional
Description

bad_response_timestamp

Type
TimeStamp
Category
optional
Description

response_code

Type
uint32
Category
optional
Description

ssl_error_code

Type
enum
Category
optional
Description
Choices
ADF_RATE_LIMIT_DROP_URI, ADF_CLIENT_CONN_SETUP_FAILED_BAD_PACKET, ADF_SSL_R_NO_CIPHERS_SPECIFIED, ADF_RATE_LIMIT_DROP_CONN, ADF_LOAD_BALANCING_FAILED, ADF_CLIENT_HIGH_RX_ZERO_WINDOW_SIZE_EVENTS, ADF_CLIENT_AUTH_UNKNOWN_USER, ADF_SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE, ADF_SSL_R_UNEXPECTED_RECORD, ADF_RATE_LIMIT_DROP_UNKNOWN_URI, ADF_X509_SERVER_CERTIFICATE_EXPIRED, ADF_X509_CLIENT_CERTIFICATE_REVOKED, ADF_CLIENT_DNS_FAILED_NO_VALID_GS_MEMBER, ADF_SSL_R_UNKNOWN_PROTOCOL, ADF_SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN, ADF_SSL_R_TLSV1_ALERT_DECRYPT_ERROR, ADF_SSL_R_RENEGOTIATION_ENCODING_ERR, ADF_SSL_R_TLSV1_ALERT_USER_CANCELLED, ADF_SERVER_HIGH_OUT_OF_ORDERS, ADF_X509_CLIENT_CERTIFICATE_CRL_NOT_PRESENT, ADF_SERVER_RTT_ABOVE_500MS, ADF_RATE_LIMIT_DROP_CLIENT_IP, ADF_CLIENT_AUTH_TIMED_OUT, ADF_CLIENT_HIGH_TOTAL_RETRANSMITS, ADF_X509_SERVER_CERTIFICATE_CRL_ERROR, ADF_CLIENT_DNS_FAILED_UNSUPPORTED_QUERY, ADF_SSL_R_RENEGOTIATE_EXT_TOO_LONG, ADF_SERVER_HIGH_RESPONSE_TIME, ADF_SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC, ADF_SSL_R_RECORD_LENGTH_MISMATCH, ADF_X509_CLIENT_CERTIFICATE_CRL_ERROR, ADF_SERVER_POSSIBLE_WINDOW_STUCK, ADF_HTTP_VERSION_LT_1_0, ADF_DOS_CLIENT_REQUEST_HEADER_TOO_LARGE, ADF_SERVER_HIGH_RX_ZERO_WINDOW_SIZE_EVENTS, ADF_SSL_R_TLSV1_ALERT_INTERNAL_ERROR, ADF_SSL_R_EXCESSIVE_MESSAGE_SIZE, ADF_CLIENT_CONN_TIMEDOUT, ADF_X509_SERVER_CERTIFICATE_VERIFICATION_FAILED, ADF_DOS_CLIENT_CLOSED_REQUEST, ADF_X509_SERVER_CERTIFICATE_INVALID_CA, ADF_DOS_CLIENT_REQUEST_ENTITY_TOO_LARGE, ADF_X509_SERVER_CERTIFICATE_CRL_NOT_YET_VALID, ADF_SSL_R_UNEXPECTED_MESSAGE, ADF_RATE_LIMIT_DROP_CLIENT_IP_CONN, ADF_X509_SERVER_CERTIFICATE_CRL_EXPIRED, ADF_SSL_R_DIGEST_CHECK_FAILED, ADF_SERVER_HIGH_TOTAL_RETRANSMITS, ADF_SERVER_CONN_SETUP_FAILED_INTERNAL, ADF_CLIENT_HIGH_OUT_OF_ORDERS, ADF_SSL_R_BLOCK_CIPHER_PAD_IS_WRONG, ADF_DOS_CLIENT_CONN_ABORTED, ADF_SERVER_SIDE_SSL_HANDSHAKE_FAILED, ADF_X509_CLIENT_CERTIFICATE_VERIFICATION_FAILED, ADF_SSL_R_SSLV3_ALERT_NO_CERTIFICATE, ADF_SSL_R_TLSV1_ALERT_ACCESS_DENIED, ADF_SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED, ADF_RATE_LIMIT_DROP_BAD_CIP, ADF_DOS_CLIENT_SENT_RESET, ADF_X509_SERVER_CERTIFICATE_NOT_YET_VALID, ADF_SSL_R_WRONG_VERSION_NUMBER, ADF_SERVER_CERTIFICATE_VERIFICATION_FAILED, ADF_SERVER_CONN_SETUP_TIMEDOUT, ADF_UDP_PORT_NOT_REACHABLE, ADF_SSL_R_NO_CIPHERS_PASSED, ADF_SSL_R_TLSV1_ALERT_RECORD_OVERFLOW, ADF_CLIENT_DNS_FAILED_GS_DOWN, ADF_CLIENT_AUTH_MISSING_CREDENTIALS, ADF_CLIENT_HIGH_TIMEOUT_RETRANSMITS, ADF_CLIENT_CONN_SETUP_FAILED_INTERNAL, ADF_DOS_SSL_ERROR, ADF_CLIENT_POSSIBLE_WINDOW_STUCK, ADF_SSL_R_INAPPROPRIATE_FALLBACK, ADF_RATE_LIMIT_DROP_CLIENT_IP_BAD, ADF_SERVER_CONN_SETUP_REFUSED, ADF_UDP_CONN_TIMEOUT, ADF_RESPONSE_CODE_4XX, ADF_CLIENT_CONN_ABORTED, ADF_DOS_SERVER_BAD_GATEWAY, ADF_SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING, ADF_PERSISTENT_SERVER_CHANGE, ADF_X509_CLIENT_CERTIFICATE_INVALID_CA, ADF_SERVER_UNANSWERED_SYNS, ADF_X509_CLIENT_CERTIFICATE_CRL_NOT_YET_VALID, ADF_SERVER_SENT_RESET, ADF_REQUEST_VIRTUAL_HOSTING_APP_SELECT_FAILED, ADF_SERVER_DNS_ERROR_RESPONSE, ADF_RATE_LIMIT_DROP_CLIENT_IP_URI_BAD, ADF_IDLE_TIMEDOUT, ADF_UDP_SERVER_CONN_SETUP_FAILED_INTERNAL, ADF_CLIENT_SENT_RESET, ADF_RATE_LIMIT_DROP_UNKNOWN_CIP, ADF_SSL_R_SSLV3_ALERT_BAD_CERTIFICATE, ADF_RATE_LIMIT_DROP_BAD_URI, ADF_SSL_R_PARSE_TLSEXT, ADF_SSL_R_SSLV3_ALERT_BAD_RECORD_MAC, ADF_CLIENT_REQUEST_TIMEOUT, ADF_SSL_R_TLSV1_ALERT_NO_RENEGOTIATION, ADF_CLIENT_CONN_FAILED, ADF_CLIENT_DNS_FAILED_INVALID_DOMAIN, ADF_SERVER_CONN_TIMEDOUT, ADF_SSL_R_TLSV1_ALERT_UNKNOWN_CA, ADF_DOS_CLIENT_CONN_TIMEOUT, ADF_DOS_CLIENT_BAD_REQUEST, ADF_SSL_R_BAD_CHANGE_CIPHER_SPEC, ADF_SSL_R_NO_SHARED_CIPHER, ADF_SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE, ADF_DOS_CLIENT_REQUEST_TIMEOUT, ADF_DOS_SERVER_GATEWAY_TIMEOUT, ADF_CLIENT_CONN_SETUP_TIMEDOUT, ADF_SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED, ADF_SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY, ADF_CLIENT_AUTH_LOGIN_FAILED, ADF_X509_SERVER_CERTIFICATE_REVOKED, ADF_SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION, ADF_SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST, ADF_X509_CLIENT_CERTIFICATE_CHAINING_ERROR, ADF_DOS_CLIENT_REQUEST_URI_TOO_LARGE, ADF_CLIENT_AUTH_UNKNOWN_ERROR, ADF_SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER, ADF_SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE, ADF_SSL_R_UNKNOWN_ALERT_TYPE, ADF_CLIENT_HIGH_RESPONSE_TIME, ADF_SSL_R_RENEGOTIATION_MISMATCH, ADF_SSL_R_LENGTH_MISMATCH, ADF_CLIENT_AUTH_SERVER_CONN_ERROR, ADF_CLIENT_DNS_FAILED_INVALID_QUERY, ADF_X509_SERVER_CERTIFICATE_HOSTNAME_ERROR, ADF_DATASCRIPT_EXECUTION_FAILED, ADF_CLIENT_SSL_HANDSHAKE_FAILURE, ADF_X509_SERVER_CERTIFICATE_CHAINING_ERROR, ADF_UDP_CONN_SETUP_FAILED_INTERNAL, ADF_REQUEST_NO_POOL, ADF_X509_SERVER_CERTIFICATE_INTERNAL_ERROR, ADF_CLIENT_DNS_FAILED_NO_SERVICE, ADF_RATE_LIMIT_DROP_REQ, ADF_X509_SERVER_CERTIFICATE_FORMAT_ERROR, ADF_CLIENT_RTT_ABOVE_SEC, ADF_RATE_LIMIT_DROP_CLIENT_IP_URI, ADF_SSL_R_NO_COMPRESSION_SPECIFIED, ADF_CLIENT_AUTH_USER_NOT_AUTHORIZED, ADF_X509_CLIENT_CERTIFICATE_EXPIRED, ADF_SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE, ADF_SSL_R_TLSV1_ALERT_PROTOCOL_VERSION, ADF_SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED, ADF_SSL_R_TLSV1_ALERT_DECRYPTION_FAILED, ADF_SSL_R_TLSV1_ALERT_DECODE_ERROR, ADF_X509_CLIENT_CERTIFICATE_INTERNAL_ERROR, ADF_CLIENT_CONN_SETUP_REFUSED, ADF_CLIENT_HIGH_TX_ZERO_WINDOW_SIZE_EVENTS, ADF_RESPONSE_CODE_5XX, ADF_RATE_LIMIT_DROP_URI_BAD, ADF_X509_CLIENT_CERTIFICATE_CRL_EXPIRED, ADF_USER_DELETE_OPERATION, ADF_X509_SERVER_CERTIFICATE_CRL_NOT_PRESENT, ADF_X509_CLIENT_CERTIFICATE_FORMAT_ERROR, ADF_SERVER_HIGH_TX_ZERO_WINDOW_SIZE_EVENTS, ADF_X509_CLIENT_CERTIFICATE_NOT_YET_VALID, ADF_SERVER_HIGH_TIMEOUT_RETRANSMITS

curr_failed_checks

Type
uint32
Category
optional
Description

ServerHealthMonitorCounter

type

Type
enum
Category
required
Description
Choices
OTHER_ERROR, HOST_ERROR, NO_RESOURCES, NO_RESPONSE, PAYLOAD_CONTENT_MISMATCH, CONNECTION_RESET, SERVER_UNREACHABLE, SCRIPT_ERROR, SSL_ERROR, SERVER_DISABLED, CONNECTION_TIMEOUT, PAYLOAD_TIMEOUT, CHUNKED_RESPONSE_PAYLOAD_NOT_FOUND, CONNECTION_ERROR, PORT_UNREACHABLE, GSLB_POOL_MEMBER_DISABLED, MAINTENANCE_PAYLOAD_CONTENT_MATCH, REMOTE_STATE, MAINTENANCE_RESPONSE_CODE_MATCH, NO_PORT, RESPONSE_CODE_MISMATCH, GSLB_POOL_MEMBER_DOWN, CONNECTION_REFUSED, ARP_UNRESOLVED, GSLB_POOL_MEMBER_STATE_UNKNOWN, SSL_CERT_ERROR, ADDRESS_ERROR

count

Type
uint32
Category
required
Description

HttpCache

API


    GET /api/pool/<key>/httpcache/<key>
	Query Params: HttpCacheObjFilter	SeParamsFilter

CLI


    show pool <key> httpcache filter [type] [key] [raw_key] [resource_name] [resource_type] [primary_only] [disable_aggregate] [se_uuid] [all_se]

Data

HttpCache

se_uuid

Type
string
Category
required
Description

proc_id

Type
string
Category
required
Description

config

Type
HttpCacheConfig
Category
optional
Description

objects

Type
HttpCacheObj
Category
repeated
Description

mime_str

Type
string
Category
repeated
Description

black_mime_str

Type
string
Category
repeated
Description

HttpCacheConfig

enabled

Type
bool
Category
optional
Description
Enable/disable HTTP object caching.
Default
False

xcache_header

Type
bool
Category
optional
Description
Add an X-Cache header to content served from cache, which indicates to the client that the object was server from an intermediate cache.
Default
True

age_header

Type
bool
Category
optional
Description
Add an Age header to content served from cache, which indicates to the client the number of seconds the object has been in the cache.
Default
True

date_header

Type
bool
Category
optional
Description
If a Date header was not added by the server, add a Date header to the object served from cache. This indicates to the client when the object was originally sent by the server to the cache.
Default
True

min_object_size

Type
uint32
Category
optional
Description
Minimum size of an object to store in the cache.
Default
100

max_object_size

Type
uint32
Category
optional
Description
Maximum size of an object to store in the cache.
Default
4194304

default_expire

Type
uint32
Category
optional
Description
Default expiration time of cache objects received from the server without a Cache-Control expiration header. This value may be overwritten by the Heuristic Expire setting.
Default
600

heuristic_expire

Type
bool
Category
optional
Description
If a response object from the server does not include the Cache-Control header, but does include a Last-Modified header, the system will use this time to calculate the Cache-Control expiration. If unable to solicit an Last-Modified header, then the system will fall back to the Cache Expire Time value.
Default
False

max_cache_size

Type
uint64
Category
optional
Description
Max size, in bytes, of the cache. The default, zero, indicates auto configuration.
Default
0

query_cacheable

Type
bool
Category
optional
Description
Allow caching of objects whose URI included a query argument. When disabled, these objects are not cached. When enabled, the request must match the URI query to be considered a hit.
Default
False

mime_types_list

Type
string
Category
repeated
Description
Whitelist of cacheable mime types. If both Cacheable Mime Types string list and string group are empty, this defaults to */*

mime_types_group_refs

Type
Reference to StringGroup
Category
repeated
Description
Whitelist string group of cacheable mime types. If both Cacheable Mime Types string list and string group are empty, this defaults to */*

aggressive

Type
bool
Category
optional
Description
Enable/disable caching objects without Cache-Control headers
Default
False

mime_types_black_list

Type
string
Category
repeated
Description
Blacklist of non-cacheable mime types

mime_types_black_group_refs

Type
Reference to StringGroup
Category
repeated
Description
Blacklist string group of non-cacheable mime types

HttpCacheObj

proc_id

Type
string
Category
required
Description

handle

Type
string
Category
required
Description
UUID of the cached object.

key

Type
string
Category
required
Description
MD5 representation of the cached object key.

raw_key

Type
string
Category
required
Description
Raw representation of the cached object key.

key_extn

Type
string
Category
optional
Description
MD5 representation of the cached object key extension.

raw_extn

Type
string
Category
optional
Description
Raw representation of the cached object key extension.

refcnt

Type
int32
Category
required
Description
Object ref count.

reuse_cnt

Type
int32
Category
required
Description
Object reuse count.

mbuf_head

Type
string
Category
required
Description
Object data head pointer.

data_size

Type
int32
Category
required
Description
Object data (headers + body) size.

meta_size

Type
int32
Category
required
Description
Object metadata size.

is_purged

Type
bool
Category
required
Description

ae_type_bm

Type
int32
Category
optional
Description

in_time

Type
int32
Category
required
Description

exp_age

Type
int32
Category
required
Description

init_age

Type
int32
Category
required
Description

date_time

Type
int32
Category
required
Description

ce_top

Type
int32
Category
optional
Description

ce_type_bm

Type
int32
Category
optional
Description

last_mod_time

Type
int32
Category
required
Description

hdr_size

Type
int32
Category
required
Description

body_size

Type
int32
Category
required
Description

reval

Type
int32
Category
required
Description

etag

Type
string
Category
optional
Description

must_reval

Type
bool
Category
required
Description

proxy_reval

Type
bool
Category
required
Description

is_expired

Type
bool
Category
required
Description

no_txm

Type
bool
Category
required
Description

exp_age_hrt

Type
bool
Category
required
Description

has_vary

Type
bool
Category
required
Description

is_chunked

Type
bool
Category
required
Description

mcache_out

Type
bool
Category
required
Description

last_used

Type
int32
Category
required
Description

ctype

Type
string
Category
optional
Description
content type

no_exp_info

Type
bool
Category
required
Description
objects cacheable, but no expiry info

Actions

API


    POST /api/pool/<key>/httpcache/clear

CLI


    clear pool <key> httpcache

Data

HttpCacheObjFilter

type

Type
enum
Category
optional
Description
HTTP cache object type.
Choices
CO_ALL, CO_IN, CO_OUT

key

Type
string
Category
optional
Description
HTTP cache object's exact key.

raw_key

Type
string
Category
optional
Description
HTTP cache object's exact raw key.

resource_name

Type
string
Category
optional
Description
HTTP cache object's resource name.

resource_type

Type
string
Category
optional
Description
objects with resource type

PoolRuntimeDetail

API


    GET /api/pool/<key>/runtime/detail/<key>
	Query Params: SeParamsFilter	ServerFilter

CLI


    show pool <key> detail filter [primary_only] [disable_aggregate] [se_uuid] [all_se] [server_ip] [server_mask] [server_end_ip] [server_port]

Data

PoolRuntimeDetail

oper_status

Type
OperationalStatus
Category
optional
Description

pool_stats

Type
PoolStats
Category
optional
Description

num_servers

Type
Unknown
Category
required
Description

num_servers_enabled

Type
Unknown
Category
required
Description

num_servers_up

Type
Unknown
Category
required
Description

se_uuid

Type
string
Category
optional
Description

vrf_uuid

Type
string
Category
optional
Description

vrf_id

Type
uint32
Category
optional
Description

name

Type
string
Category
optional
Description

uuid

Type
string
Category
optional
Description

PoolStats

total_connections

Type
uint64
Category
optional
Description

failed_requests

Type
uint64
Category
optional
Description

current_connections

Type
uint64
Category
optional
Description

persistence_objs

Type
uint64
Category
optional
Description

pre_closed_connections

Type
uint64
Category
optional
Description

bad_connections

Type
uint64
Category
optional
Description

pool_load

Type
int32
Category
optional
Description

persist_alloc_fails

Type
uint64
Category
optional
Description

lb_fail_persistent_server_invalid

Type
uint32
Category
optional
Description

lb_fail_persistent_server_down

Type
uint32
Category
optional
Description

lb_fail_server_down

Type
uint32
Category
optional
Description

lb_fail_add_pending

Type
uint32
Category
optional
Description

lb_fail_slow_start_max_conn

Type
uint32
Category
optional
Description

lb_fail_max_conn

Type
uint32
Category
optional
Description

lb_fail_no_lport

Type
uint32
Category
optional
Description

lb_fail_suspect_state

Type
uint32
Category
optional
Description

inlhm_skip_bypassed

Type
uint32
Category
optional
Description

lb_fail_max_conn_rate

Type
uint32
Category
optional
Description

lb_fail_capest_rand_max_conn

Type
uint32
Category
optional
Description

request_queue_num_adds

Type
uint64
Category
optional
Description

request_queue_num_dels

Type
uint64
Category
optional
Description

request_queue_num_flushes

Type
uint64
Category
optional
Description

request_queue_num_dispatched

Type
uint64
Category
optional
Description

request_queue_num_full

Type
uint64
Category
optional
Description

request_queue_num_evicted

Type
uint64
Category
optional
Description

request_queue_num_freed_requests

Type
uint64
Category
optional
Description

lb_fail_get_next

Type
uint32
Category
optional
Description

ServerRuntimeSummary

API


    GET /api/pool/<key>/runtime/server/<key>
	Query Params: ServerFilter

CLI


    show pool <key> server summary filter [server_ip] [server_mask] [server_end_ip] [server_port]

Data

ServerRuntimeSummary

ip_addr

Type
IpAddr
Category
required
Description

port

Type
int32
Category
required
Description

hostname

Type
string
Category
optional
Description

oper_status

Type
OperationalStatus
Category
required
Description

se_uuid

Type
string
Category
optional
Description

health_monitor_list

Type
SHMSummary
Category
optional
Description
Health monitor name, state and reason if down

is_standby

Type
bool
Category
optional
Description
Default
False

vs_uuid

Type
string
Category
optional
Description
VirtualService member in case this server is a member of GS group.

SHMSummary

health_monitor

Type
ServerHealthMonitor
Category
repeated
Description

ServerHealthMonitor

name

Type
string
Category
required
Description

state

Type
enum
Category
required
Description
Choices
OPER_PROCESSING, OPER_UPGRADING, OPER_CREATING, OPER_RESOURCES, OPER_SE_PROCESSING, OPER_AWAIT_MANUAL_PLACEMENT, OPER_ERROR_DISABLED, OPER_UNKNOWN, OPER_PARTITIONED, OPER_FAILED, OPER_UP, OPER_DISABLING, OPER_UNUSED, OPER_INITIALIZING, OPER_INACTIVE, OPER_DOWN, OPER_UNAVAIL, OPER_DISABLED

recent_response_time

Type
uint64
Category
optional
Description
Average health monitor response time from server in milli-seconds in the last few health monitor instances

avg_response_time

Type
uint64
Category
optional
Description
Average health monitor response time from server in milli-seconds

failure_code

Type
enum
Category
optional
Description
Choices
OTHER_ERROR, HOST_ERROR, NO_RESOURCES, NO_RESPONSE, PAYLOAD_CONTENT_MISMATCH, CONNECTION_RESET, SERVER_UNREACHABLE, SCRIPT_ERROR, SSL_ERROR, SERVER_DISABLED, CONNECTION_TIMEOUT, PAYLOAD_TIMEOUT, CHUNKED_RESPONSE_PAYLOAD_NOT_FOUND, CONNECTION_ERROR, PORT_UNREACHABLE, GSLB_POOL_MEMBER_DISABLED, MAINTENANCE_PAYLOAD_CONTENT_MATCH, REMOTE_STATE, MAINTENANCE_RESPONSE_CODE_MATCH, NO_PORT, RESPONSE_CODE_MISMATCH, GSLB_POOL_MEMBER_DOWN, CONNECTION_REFUSED, ARP_UNRESOLVED, GSLB_POOL_MEMBER_STATE_UNKNOWN, SSL_CERT_ERROR, ADDRESS_ERROR

reason

Type
string
Category
optional
Description

PoolInternal

API


    GET /api/pool/<key>/runtime/internal/<key>
	Query Params: SeParamsFilter	ServerFilter

CLI


    show pool <key> internal filter [primary_only] [disable_aggregate] [se_uuid] [all_se] [server_ip] [server_mask] [server_end_ip] [server_port]

Data

PoolInternal

se_uuid

Type
string
Category
optional
Description

proc_id

Type
string
Category
optional
Description

oper_status

Type
OperationalStatus
Category
optional
Description

pool_config

Type
Pool
Category
optional
Description

num_servers

Type
int32
Category
optional
Description

ref_count

Type
int32
Category
optional
Description

num_persistence_objs

Type
Unknown
Category
optional
Description

lb_state

Type
PoolLbState
Category
optional
Description

persistence_handle_internal

Type
PersistenceHandleInternal
Category
optional
Description

pool_refcnt

Type
PoolRefCnt
Category
optional
Description

max_concurrent_connections_per_server

Type
int32
Category
optional
Description

graceful_disable_timeout

Type
int32
Category
optional
Description

connection_ramp_duration

Type
int32
Category
optional
Description

use_service_port

Type
bool
Category
optional
Description

application_persistence_profile_uuid

Type
string
Category
optional
Description

prst_id

Type
uint64
Category
optional
Description

capacity_estimation

Type
bool
Category
optional
Description

capacity_estimation_ttfb_thresh

Type
uint32
Category
optional
Description

server_auto_scale

Type
bool
Category
optional
Description

prst_hdr_name

Type
string
Category
optional
Description

fewest_tasks_feedback_delay

Type
uint32
Category
optional
Description

num_hms_deduped

Type
uint32
Category
optional
Description

PoolLbState

ref_count

Type
int32
Category
optional
Description

PersistenceHandleInternal

redis_sync

Type
int32
Category
required
Description

aging_mode

Type
int32
Category
required
Description

key_type

Type
int32
Category
required
Description

vs_uuid

Type
string
Category
required
Description

num_local_create_races

Type
uint32
Category
optional
Description

num_redis_create_races

Type
uint32
Category
optional
Description

num_unknown_srv_from_redis

Type
uint32
Category
optional
Description

num_malloc_failures

Type
uint32
Category
optional
Description

num_start_ageing_val_null

Type
uint32
Category
optional
Description

num_too_early_delete

Type
uint32
Category
optional
Description

num_redis_eol_truncate_events

Type
uint32
Category
optional
Description

num_delete_nonexistent

Type
uint32
Category
optional
Description

num_redis_recvd

Type
uint32
Category
optional
Description

num_redis_sent_dp

Type
uint32
Category
optional
Description

num_redis_sent_ag

Type
uint32
Category
optional
Description

num_create_srv_null

Type
uint32
Category
optional
Description

num_start_ageing_srv_null

Type
uint32
Category
optional
Description

PoolRefCnt

uuid

Type
string
Category
optional
Description

name

Type
string
Category
optional
Description

refcnt

Type
int32
Category
optional
Description

server_refcnt

Type
ServerRefCnt
Category
repeated
Description

phm_refcnt

Type
HealthMonitorRefCnt
Category
repeated
Description

ServerRefCnt

ip

Type
IpAddr
Category
optional
Description

port

Type
int32
Category
optional
Description

refcnt

Type
int32
Category
optional
Description

shm_refcnt

Type
HealthMonitorRefCnt
Category
repeated
Description

HealthMonitorRefCnt

uuid

Type
string
Category
optional
Description

name

Type
string
Category
optional
Description

refcnt

Type
int32
Category
optional
Description

ServerInternal

API


    GET /api/pool/<key>/runtime/server/internal/<key>
	Query Params: SeParamsFilter	ServerFilter

CLI


    show pool <key> server internal filter [primary_only] [disable_aggregate] [se_uuid] [all_se] [server_ip] [server_mask] [server_end_ip] [server_port]

Data

ServerInternal

ip_addr

Type
IpAddr
Category
required
Description

port

Type
int32
Category
required
Description

oper_status

Type
OperationalStatus
Category
optional
Description

server_config

Type
Server
Category
optional
Description

ref_count

Type
int32
Category
optional
Description

server_stats

Type
ServerStats
Category
optional
Description

server_l4stats

Type
ServerL4Stats
Category
optional
Description

server_l7stats

Type
ServerL7Stats
Category
optional
Description

slow_start

Type
ServerSlowStart
Category
optional
Description

l7cp_stats

Type
ConnpoolStats
Category
optional
Description

proc_id

Type
string
Category
optional
Description

se_uuid

Type
string
Category
optional
Description

ck_prst_id

Type
uint32
Category
optional
Description

vm_powered_on_count

Type
uint32
Category
optional
Description

vm_powered_off_count

Type
uint32
Category
optional
Description

vm_powered_on

Type
bool
Category
optional
Description

ipv4_prst_id

Type
uint32
Category
optional
Description

prst_hdr_val

Type
string
Category
optional
Description

nat_ip_addr

Type
IpAddr
Category
optional
Description

nat_port

Type
int32
Category
optional
Description

nat_hostname

Type
string
Category
optional
Description

local

Type
uint32
Category
optional
Description

num_chash_unique_keys

Type
uint32
Category
optional
Description

server_node_name

Type
string
Category
optional
Description

gslb_site_name

Type
string
Category
optional
Description

gslb_vs_name

Type
string
Category
optional
Description

chash_arcs_sum

Type
uint32
Category
optional
Description

ServerStats

current_connections

Type
uint64
Category
optional
Description

total_connections

Type
uint64
Category
optional
Description

pre_closed_connections

Type
uint64
Category
optional
Description

bad_connections

Type
uint64
Category
optional
Description

inlhm_skipped

Type
uint64
Category
optional
Description

skipped_count

Type
uint64
Category
optional
Description

response_time

Type
Unknown
Category
optional
Description

response_time_var

Type
Unknown
Category
optional
Description

inlhm_down_duration

Type
uint64
Category
optional
Description

inlhm_good_ewma

Type
uint64
Category
optional
Description

inlhm_bad_ewma

Type
uint64
Category
optional
Description

no_lport

Type
uint64
Category
optional
Description

inlhm_letthrough

Type
uint64
Category
optional
Description

current_load

Type
uint64
Category
optional
Description

inlhm_skip_bypassed

Type
uint64
Category
optional
Description

fs_load_thresh

Type
Unknown
Category
optional
Description

current_tasks

Type
uint64
Category
optional
Description

current_tasks_fb

Type
uint64
Category
optional
Description

rl_good_fb

Type
uint64
Category
optional
Description

rl_bad_fb

Type
uint64
Category
optional
Description

capest_rand_max_conn_skipped

Type
uint64
Category
optional
Description

skipped_get_next_count

Type
uint64
Category
optional
Description

ServerSlowStart

delta_max_conn

Type
uint32
Category
required
Description

delta_time

Type
uint32
Category
required
Description

count_limit

Type
uint32
Category
required
Description

ref_count

Type
uint32
Category
required
Description

PersistenceInternal

API


    GET /api/pool/<key>/persistence/<key>
	Query Params: PersistenceFilter	SeParamsFilter

CLI


    show pool <key> persistence filter [persistence_ip] [persistence_mask] [persistence_end_ip] [server_ip] [server_mask] [server_end_ip] [server_port] [persistence_cookie] [primary_only] [disable_aggregate] [se_uuid] [all_se]

Data

PersistenceInternal

uuid

Type
string
Category
optional
Description

persistence_entry

Type
PersistenceInternalEntry
Category
repeated
Description

PersistenceInternalEntry

client_ip

Type
IpAddr
Category
optional
Description

server_ip

Type
IpAddr
Category
optional
Description

port

Type
int32
Category
optional
Description

ref_count

Type
int32
Category
optional
Description

total_conn_count

Type
int32
Category
optional
Description

local_age

Type
int32
Category
optional
Description

local_timeout

Type
int32
Category
optional
Description

global_age

Type
int32
Category
optional
Description

global_timeout

Type
int32
Category
optional
Description

in_progress_cnt

Type
int32
Category
optional
Description

local_eol

Type
uint32
Category
optional
Description

global_eol

Type
uint32
Category
optional
Description

server_key

Type
string
Category
optional
Description

Actions

API


    POST /api/pool/<key>/persistence/clear

CLI


    clear pool <key> persistence

Data

PersistenceFilter

persistence_ip

Type
IpAddr
Category
optional
Description

persistence_mask

Type
int32
Category
optional
Description

persistence_end_ip

Type
IpAddr
Category
optional
Description

server_ip

Type
IpAddr
Category
optional
Description

server_mask

Type
int32
Category
optional
Description

server_end_ip

Type
IpAddr
Category
optional
Description

server_port

Type
int32
Category
optional
Description

persistence_cookie

Type
string
Category
optional
Description
Persistence cookie

RequestQueueRuntime

API


CLI


Data

RequestQueueRuntime

num_requests

Type
uint32
Category
optional
Description

Actions

API


    POST /api/pool/<key>/request_queue/clear

CLI


    clear pool <key> request_queue

PoolRuntimeSummary

API


    GET /api/pool/<key>/runtime/<key>

CLI


    show pool <key> summary

Data

PoolRuntimeSummary

oper_status

Type
OperationalStatus
Category
required
Description

num_servers

Type
Unknown
Category
required
Description

num_servers_enabled

Type
Unknown
Category
required
Description

num_servers_up

Type
Unknown
Category
required
Description

percent_servers_up_total

Type
int32
Category
optional
Description
Default
0

percent_servers_up_enabled

Type
int32
Category
optional
Description
Default
0

HealthMonitorStatRuntime

API


    GET /api/pool/<key>/runtime/server/hmonstat/<key>
	Query Params: SeParamsFilter	ServerFilter

CLI


    show pool <key> server hmonstat filter [primary_only] [disable_aggregate] [se_uuid] [all_se] [server_ip] [server_mask] [server_end_ip] [server_port]

Data

AlgoStatRuntime

API


    GET /api/pool/<key>/algo/<key>

CLI


    show pool <key> algo

Data

AlgoStatRuntime

lb_algorithm

Type
string
Category
optional
Description

wrr_stats

Type
WrrStat
Category
optional
Description

lc_stats

Type
LeastConnectionStat
Category
optional
Description

WrrStat

total_weight

Type
uint32
Category
required
Description

next_index

Type
uint32
Category
required
Description

entry

Type
WrrEntry
Category
repeated
Description

WrrEntry

index

Type
uint32
Category
required
Description

ip_addr

Type
string
Category
optional
Description

port

Type
uint32
Category
required
Description

weight

Type
uint32
Category
required
Description

LeastConnectionStat

entry

Type
LcEntry
Category
repeated
Description

LcEntry

ip_addr

Type
string
Category
optional
Description

port

Type
uint32
Category
required
Description

weight

Type
uint32
Category
required
Description

num_open_connections

Type
uint32
Category
required
Description

index

Type
uint32
Category
required
Description

max_queue_length

Type
uint32
Category
required
Description

HttpCacheStats

API


    GET /api/pool/<key>/httpcachestats/<key>
	Query Params: SeParamsFilter

CLI


    show pool <key> httpcachestats filter [primary_only] [disable_aggregate] [se_uuid] [all_se]

Data

HttpCacheStats

se_uuid

Type
string
Category
required
Description

proc_id

Type
string
Category
required
Description

available_size

Type
uint64
Category
required
Description

current_size

Type
uint64
Category
required
Description

objects

Type
uint64
Category
required
Description

lookups

Type
uint64
Category
required
Description

hits

Type
uint64
Category
required
Description

additions

Type
uint64
Category
required
Description

deletions

Type
uint64
Category
required
Description

out_of_mem_evicts

Type
uint64
Category
required
Description

served_bytes

Type
uint64
Category
required
Description

Actions

API


    POST /api/pool/<key>/httpcachestats/clear

CLI


    clear pool <key> httpcachestats

PoolStats

API


CLI


Data

Actions

API


    POST /api/pool/<key>/stats/clear

CLI


    clear pool <key> stats

ConnpoolInternal

API


    GET /api/pool/<key>/connpool/<key>
	Query Params: ConnpoolFilter	SeParamsFilter

CLI


    show pool <key> connpool filter [type] [ip_addr] [ip_mask] [port] [primary_only] [disable_aggregate] [se_uuid] [all_se]

Data

ConnpoolInternal

se_uuid

Type
string
Category
optional
Description

proc_id

Type
string
Category
optional
Description

oper_status

Type
OperationalStatus
Category
optional
Description

config

Type
ConnpoolConfig
Category
optional
Description

servers

Type
ConnpoolServerInternal
Category
repeated
Description

ConnpoolConfig

strategy

Type
enum
Category
required
Description
Choices
CP_STRATEGY_NONE, CP_STRATEGY_SWITCH_REQ, CP_STRATEGY_SWITCH_CONN, CP_STRATEGY_SWITCH_SESS

max_cache

Type
int32
Category
required
Description

idle_timeout

Type
int32
Category
required
Description

max_reuse

Type
int32
Category
required
Description

lo_thresh

Type
int32
Category
required
Description

thresh_timeout

Type
int32
Category
required
Description

life_timeout

Type
int32
Category
required
Description

ConnpoolServerInternal

ip_addr

Type
IpAddr
Category
required
Description

port

Type
int32
Category
required
Description

oper_status

Type
OperationalStatus
Category
optional
Description

max_connection

Type
int32
Category
optional
Description

num_conn_free

Type
int32
Category
optional
Description

conn_free

Type
ConnectionItem
Category
repeated
Description

num_conn_bind

Type
int32
Category
optional
Description

conn_bind

Type
ConnectionItem
Category
repeated
Description

stats

Type
ConnpoolStats
Category
optional
Description

ConnectionItem

connection

Type
ConnectionEntry
Category
required
Description

reuse_cnt

Type
int32
Category
optional
Description

ConnectionEntry

client_src_ip

Type
string
Category
optional
Description

client_src_port

Type
uint32
Category
optional
Description

client_dst_ip

Type
string
Category
optional
Description

client_dst_port

Type
uint32
Category
optional
Description

server_src_ip

Type
string
Category
optional
Description

server_src_port

Type
uint32
Category
optional
Description

server_dst_ip

Type
string
Category
optional
Description

server_dst_port

Type
uint32
Category
optional
Description

client_vrf_id

Type
uint32
Category
optional
Description

server_vrf_id

Type
uint32
Category
optional
Description

downstream_buf_bytes

Type
uint64
Category
optional
Description

upstream_buf_bytes

Type
uint64
Category
optional
Description

Actions

API


    POST /api/pool/<key>/connpool/clear

CLI


    clear pool <key> connpool

Data

ConnpoolFilter

type

Type
enum
Category
optional
Description
cache type
Choices
CP_FREE, CP_CACHED, CP_ALL, CP_BIND

ip_addr

Type
string
Category
optional
Description
Backend or SE IP address

ip_mask

Type
string
Category
optional
Description
Backend or SE IP address mask

port

Type
int32
Category
optional
Description
Backend or SE port

Filters

SeParamsFilter

primary_only

Type
bool
Category
optional
Description
Only from primary se

disable_aggregate

Type
enum
Category
optional
Description
Do not aggregate at SE or CORE level
Choices
CORE, SE

se_uuid

Type
string
Category
optional
Description
Only from this se

all_se

Type
bool
Category
optional
Description
Report from all SEs overriding disable_aggregate field. If there are more than max scale out SEs, then this filter pops an error message to use a specific SE
Default
False

ServerFilter

server_ip

Type
IpAddr
Category
optional
Description

server_mask

Type
int32
Category
optional
Description

server_end_ip

Type
IpAddr
Category
optional
Description

server_port

Type
int32
Category
optional
Description