Avi Pool Object API
CLI ``` - configure pool - show pool - scaleout pool - scalein pool - clear pool ``` Examples - **pool_example**: To create a basic pool object that uses the least connections algorithm and has a couple of application servers in the backend ```json {'name': 'production_pool', 'default_server_port': 80, 'servers': [{'ip': {'addr': '10.10.90.120', 'type': 'V4'}}, {'ip': {'addr': '10.10.90.121', 'type': 'V4'}}], 'lb_algorithm': 'LB_ALGORITHM_LEAST_CONNECTIONS'} ```
Contact Info: support@avinetworks.com
Version: 20.1.9
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
post /pool/clearget /poolpost /poolget /pool/{uuid}/algo/get /pool/{uuid}/connpool/post /pool/{uuid}/connpoolstats/cleardelete /pool/{uuid}get /pool/{uuid}get /pool/{uuid}/hmon/get /pool/{uuid}/httpcache/get /pool/{uuid}/httpcachestats/detail/get /pool/{uuid}/httpcachestats/get /pool/{uuid}/objsync/patch /pool/{uuid}get /pool/{uuid}/persistence/put /pool/{uuid}get /pool/{uuid}/runtime/debug/get /pool/{uuid}/runtime/detail/get /pool/{uuid}/runtime/get /pool/{uuid}/runtime/internal/post /pool/{uuid}/runtime/request_queue/clearget /pool/{uuid}/runtime/server/detail/get /pool/{uuid}/runtime/server/get /pool/{uuid}/runtime/server/hmonstat/get /pool/{uuid}/runtime/server/internal/post /pool/{uuid}/runtime/stats/clearpost /pool/{uuid}/scaleinpost /pool/{uuid}/scaleoutget /pool/{uuid}/vs/
(poolClearPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — empty
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
(poolGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
cloud_uuid (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.
cloud_ref.name (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud usings its name. This uses cloud name rather than uuid. Eg. cloud_ref.name=Default-Cloud.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"ipaddrgroup_ref" : "aeiou",
"min_health_monitors_up" : 123,
"inline_health_monitor" : true,
"default_server_port" : 123,
"resolve_pool_by_dns" : true,
"lookup_server_by_name" : true,
"fewest_tasks_feedback_delay" : 123,
"sni_enabled" : true,
"vrf_ref" : "aeiou",
"uuid" : "aeiou",
"domain_name" : [ "aeiou" ],
"east_west" : true,
"rewrite_host_header_to_server_name" : true,
"ssl_key_and_certificate_ref" : "aeiou",
"cloud_ref" : "aeiou",
"tier1_lr" : "aeiou",
"analytics_policy" : {
"enable_realtime_metrics" : true
},
"health_monitor_refs" : [ "aeiou" ],
"ab_pool" : {
"pool_ref" : "aeiou",
"ratio" : 123
},
"application_persistence_profile_ref" : "aeiou",
"lb_algorithm_core_nonaffinity" : 123,
"autoscale_launch_config_ref" : "aeiou",
"routing_pool" : true,
"prst_hdr_name" : "aeiou",
"placement_networks" : [ {
"subnet" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"network_ref" : "aeiou"
} ],
"autoscale_networks" : [ "aeiou" ],
"enable_http2" : true,
"created_by" : "aeiou",
"external_autoscale_groups" : [ "aeiou" ],
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"min_servers_up" : 123,
"ab_priority" : 123,
"capacity_estimation" : true,
"ignore_server_port" : true,
"name" : "aeiou",
"cloud_config_cksum" : "aeiou",
"server_auto_scale" : true,
"gslb_sp_enabled" : true,
"server_name" : "aeiou",
"request_queue_depth" : 123,
"description" : "aeiou",
"lb_algorithm" : "aeiou",
"ssl_profile_ref" : "aeiou",
"graceful_disable_timeout" : 123,
"networks" : [ {
"server_filter" : "aeiou",
"network_ref" : "aeiou"
} ],
"use_service_port" : true,
"enabled" : true,
"_last_modified" : "aeiou",
"a_pool" : "aeiou",
"server_reselect" : {
"retry_timeout" : 123,
"svr_resp_code" : {
"resp_code_block" : [ "aeiou" ],
"codes" : [ "" ],
"ranges" : [ {
"end" : 123,
"begin" : 123
} ]
},
"num_retries" : 123,
"enabled" : true,
"retry_nonidempotent" : true
},
"autoscale_policy_ref" : "aeiou",
"servers" : [ {
"availability_zone" : "aeiou",
"prst_hdr_val" : "aeiou",
"static" : true,
"vm_ref" : "aeiou",
"ip" : "",
"description" : "aeiou",
"external_uuid" : "aeiou",
"verify_network" : true,
"enabled" : true,
"autoscaling_group_name" : "aeiou",
"rewrite_host_header" : true,
"discovered_subnet" : [ "" ],
"hostname" : "aeiou",
"nw_ref" : "aeiou",
"external_orchestration_id" : "aeiou",
"port" : 123,
"mac_address" : "aeiou",
"server_node" : "aeiou",
"location" : {
"latitude" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"tag" : "aeiou",
"longitude" : 1.3579000000000001069366817318950779736042022705078125
},
"resolve_server_by_dns" : true,
"discovered_networks" : [ {
"subnet" : [ "" ],
"subnet6" : [ "" ],
"network_ref" : "aeiou"
} ],
"discovered_network_ref" : [ "aeiou" ],
"ratio" : 123
} ],
"fail_action" : {
"redirect" : {
"path" : "aeiou",
"protocol" : "aeiou",
"status_code" : "aeiou",
"query" : "aeiou",
"host" : "aeiou"
},
"local_rsp" : {
"file" : {
"file_content" : "aeiou",
"content_type" : "aeiou"
},
"status_code" : "aeiou"
},
"backup_pool" : {
"backup_pool_ref" : "aeiou"
},
"type" : "aeiou"
},
"max_conn_rate_per_server" : {
"rate_limiter" : {
"period" : 123,
"count" : 123,
"name" : "aeiou",
"burst_sz" : 123
},
"period" : 123,
"count" : 123,
"action" : {
"redirect" : {
"keep_query" : true,
"path" : "",
"protocol" : "aeiou",
"status_code" : "aeiou",
"port" : 123,
"host" : {
"tokens" : [ {
"start_index" : 123,
"str_value" : "aeiou",
"end_index" : 123,
"type" : "aeiou"
} ],
"type" : "aeiou"
}
},
"file" : "",
"status_code" : "aeiou",
"type" : "aeiou"
},
"burst_sz" : 123,
"explicit_tracking" : true,
"fine_grain" : true,
"http_cookie" : "aeiou",
"http_header" : "aeiou"
},
"analytics_profile_ref" : "aeiou",
"max_concurrent_connections_per_server" : 123,
"service_metadata" : "aeiou",
"capacity_estimation_ttfb_thresh" : 123,
"lb_algorithm_hash" : "aeiou",
"delete_server_on_dns_refresh" : true,
"request_queue_enabled" : true,
"host_check_enabled" : true,
"server_timeout" : 123,
"url" : "aeiou",
"nsx_securitygroup" : [ "aeiou" ],
"pki_profile_ref" : "aeiou",
"connection_ramp_duration" : 123,
"tenant_ref" : "aeiou",
"conn_pool_properties" : {
"upstream_connpool_conn_idle_tmo" : 123,
"upstream_connpool_conn_life_tmo" : 123,
"upstream_connpool_conn_max_reuse" : 123,
"upstream_connpool_server_max_cache" : 123
},
"server_count" : 123,
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"apic_epg_name" : "aeiou",
"lb_algorithm_consistent_hash_hdr" : "aeiou",
"rewrite_host_header_to_sni" : true
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
PoolApiResponse
401
log in failed
(poolPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Pool object creation
Return type
Example data
Content-Type: application/json
{
"ipaddrgroup_ref" : "aeiou",
"min_health_monitors_up" : 123,
"inline_health_monitor" : true,
"default_server_port" : 123,
"resolve_pool_by_dns" : true,
"lookup_server_by_name" : true,
"fewest_tasks_feedback_delay" : 123,
"sni_enabled" : true,
"vrf_ref" : "aeiou",
"uuid" : "aeiou",
"domain_name" : [ "aeiou" ],
"east_west" : true,
"rewrite_host_header_to_server_name" : true,
"ssl_key_and_certificate_ref" : "aeiou",
"cloud_ref" : "aeiou",
"tier1_lr" : "aeiou",
"analytics_policy" : {
"enable_realtime_metrics" : true
},
"health_monitor_refs" : [ "aeiou" ],
"ab_pool" : {
"pool_ref" : "aeiou",
"ratio" : 123
},
"application_persistence_profile_ref" : "aeiou",
"lb_algorithm_core_nonaffinity" : 123,
"autoscale_launch_config_ref" : "aeiou",
"routing_pool" : true,
"prst_hdr_name" : "aeiou",
"placement_networks" : [ {
"subnet" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"network_ref" : "aeiou"
} ],
"autoscale_networks" : [ "aeiou" ],
"enable_http2" : true,
"created_by" : "aeiou",
"external_autoscale_groups" : [ "aeiou" ],
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"min_servers_up" : 123,
"ab_priority" : 123,
"capacity_estimation" : true,
"ignore_server_port" : true,
"name" : "aeiou",
"cloud_config_cksum" : "aeiou",
"server_auto_scale" : true,
"gslb_sp_enabled" : true,
"server_name" : "aeiou",
"request_queue_depth" : 123,
"description" : "aeiou",
"lb_algorithm" : "aeiou",
"ssl_profile_ref" : "aeiou",
"graceful_disable_timeout" : 123,
"networks" : [ {
"server_filter" : "aeiou",
"network_ref" : "aeiou"
} ],
"use_service_port" : true,
"enabled" : true,
"_last_modified" : "aeiou",
"a_pool" : "aeiou",
"server_reselect" : {
"retry_timeout" : 123,
"svr_resp_code" : {
"resp_code_block" : [ "aeiou" ],
"codes" : [ "" ],
"ranges" : [ {
"end" : 123,
"begin" : 123
} ]
},
"num_retries" : 123,
"enabled" : true,
"retry_nonidempotent" : true
},
"autoscale_policy_ref" : "aeiou",
"servers" : [ {
"availability_zone" : "aeiou",
"prst_hdr_val" : "aeiou",
"static" : true,
"vm_ref" : "aeiou",
"ip" : "",
"description" : "aeiou",
"external_uuid" : "aeiou",
"verify_network" : true,
"enabled" : true,
"autoscaling_group_name" : "aeiou",
"rewrite_host_header" : true,
"discovered_subnet" : [ "" ],
"hostname" : "aeiou",
"nw_ref" : "aeiou",
"external_orchestration_id" : "aeiou",
"port" : 123,
"mac_address" : "aeiou",
"server_node" : "aeiou",
"location" : {
"latitude" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"tag" : "aeiou",
"longitude" : 1.3579000000000001069366817318950779736042022705078125
},
"resolve_server_by_dns" : true,
"discovered_networks" : [ {
"subnet" : [ "" ],
"subnet6" : [ "" ],
"network_ref" : "aeiou"
} ],
"discovered_network_ref" : [ "aeiou" ],
"ratio" : 123
} ],
"fail_action" : {
"redirect" : {
"path" : "aeiou",
"protocol" : "aeiou",
"status_code" : "aeiou",
"query" : "aeiou",
"host" : "aeiou"
},
"local_rsp" : {
"file" : {
"file_content" : "aeiou",
"content_type" : "aeiou"
},
"status_code" : "aeiou"
},
"backup_pool" : {
"backup_pool_ref" : "aeiou"
},
"type" : "aeiou"
},
"max_conn_rate_per_server" : {
"rate_limiter" : {
"period" : 123,
"count" : 123,
"name" : "aeiou",
"burst_sz" : 123
},
"period" : 123,
"count" : 123,
"action" : {
"redirect" : {
"keep_query" : true,
"path" : "",
"protocol" : "aeiou",
"status_code" : "aeiou",
"port" : 123,
"host" : {
"tokens" : [ {
"start_index" : 123,
"str_value" : "aeiou",
"end_index" : 123,
"type" : "aeiou"
} ],
"type" : "aeiou"
}
},
"file" : "",
"status_code" : "aeiou",
"type" : "aeiou"
},
"burst_sz" : 123,
"explicit_tracking" : true,
"fine_grain" : true,
"http_cookie" : "aeiou",
"http_header" : "aeiou"
},
"analytics_profile_ref" : "aeiou",
"max_concurrent_connections_per_server" : 123,
"service_metadata" : "aeiou",
"capacity_estimation_ttfb_thresh" : 123,
"lb_algorithm_hash" : "aeiou",
"delete_server_on_dns_refresh" : true,
"request_queue_enabled" : true,
"host_check_enabled" : true,
"server_timeout" : 123,
"url" : "aeiou",
"nsx_securitygroup" : [ "aeiou" ],
"pki_profile_ref" : "aeiou",
"connection_ramp_duration" : 123,
"tenant_ref" : "aeiou",
"conn_pool_properties" : {
"upstream_connpool_conn_idle_tmo" : 123,
"upstream_connpool_conn_life_tmo" : 123,
"upstream_connpool_conn_max_reuse" : 123,
"upstream_connpool_server_max_cache" : 123
},
"server_count" : 123,
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"apic_epg_name" : "aeiou",
"lb_algorithm_consistent_hash_hdr" : "aeiou",
"rewrite_host_header_to_sni" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
Pool
401
log in failed
Up
get /pool/{uuid}/algo/
(poolUuidAlgoGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /pool/{uuid}/connpool/
(poolUuidConnpoolGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
post /pool/{uuid}/connpoolstats/clear
(poolUuidConnpoolstatsClearPost)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — empty
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
(poolUuidDelete)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
(poolUuidGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"ipaddrgroup_ref" : "aeiou",
"min_health_monitors_up" : 123,
"inline_health_monitor" : true,
"default_server_port" : 123,
"resolve_pool_by_dns" : true,
"lookup_server_by_name" : true,
"fewest_tasks_feedback_delay" : 123,
"sni_enabled" : true,
"vrf_ref" : "aeiou",
"uuid" : "aeiou",
"domain_name" : [ "aeiou" ],
"east_west" : true,
"rewrite_host_header_to_server_name" : true,
"ssl_key_and_certificate_ref" : "aeiou",
"cloud_ref" : "aeiou",
"tier1_lr" : "aeiou",
"analytics_policy" : {
"enable_realtime_metrics" : true
},
"health_monitor_refs" : [ "aeiou" ],
"ab_pool" : {
"pool_ref" : "aeiou",
"ratio" : 123
},
"application_persistence_profile_ref" : "aeiou",
"lb_algorithm_core_nonaffinity" : 123,
"autoscale_launch_config_ref" : "aeiou",
"routing_pool" : true,
"prst_hdr_name" : "aeiou",
"placement_networks" : [ {
"subnet" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"network_ref" : "aeiou"
} ],
"autoscale_networks" : [ "aeiou" ],
"enable_http2" : true,
"created_by" : "aeiou",
"external_autoscale_groups" : [ "aeiou" ],
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"min_servers_up" : 123,
"ab_priority" : 123,
"capacity_estimation" : true,
"ignore_server_port" : true,
"name" : "aeiou",
"cloud_config_cksum" : "aeiou",
"server_auto_scale" : true,
"gslb_sp_enabled" : true,
"server_name" : "aeiou",
"request_queue_depth" : 123,
"description" : "aeiou",
"lb_algorithm" : "aeiou",
"ssl_profile_ref" : "aeiou",
"graceful_disable_timeout" : 123,
"networks" : [ {
"server_filter" : "aeiou",
"network_ref" : "aeiou"
} ],
"use_service_port" : true,
"enabled" : true,
"_last_modified" : "aeiou",
"a_pool" : "aeiou",
"server_reselect" : {
"retry_timeout" : 123,
"svr_resp_code" : {
"resp_code_block" : [ "aeiou" ],
"codes" : [ "" ],
"ranges" : [ {
"end" : 123,
"begin" : 123
} ]
},
"num_retries" : 123,
"enabled" : true,
"retry_nonidempotent" : true
},
"autoscale_policy_ref" : "aeiou",
"servers" : [ {
"availability_zone" : "aeiou",
"prst_hdr_val" : "aeiou",
"static" : true,
"vm_ref" : "aeiou",
"ip" : "",
"description" : "aeiou",
"external_uuid" : "aeiou",
"verify_network" : true,
"enabled" : true,
"autoscaling_group_name" : "aeiou",
"rewrite_host_header" : true,
"discovered_subnet" : [ "" ],
"hostname" : "aeiou",
"nw_ref" : "aeiou",
"external_orchestration_id" : "aeiou",
"port" : 123,
"mac_address" : "aeiou",
"server_node" : "aeiou",
"location" : {
"latitude" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"tag" : "aeiou",
"longitude" : 1.3579000000000001069366817318950779736042022705078125
},
"resolve_server_by_dns" : true,
"discovered_networks" : [ {
"subnet" : [ "" ],
"subnet6" : [ "" ],
"network_ref" : "aeiou"
} ],
"discovered_network_ref" : [ "aeiou" ],
"ratio" : 123
} ],
"fail_action" : {
"redirect" : {
"path" : "aeiou",
"protocol" : "aeiou",
"status_code" : "aeiou",
"query" : "aeiou",
"host" : "aeiou"
},
"local_rsp" : {
"file" : {
"file_content" : "aeiou",
"content_type" : "aeiou"
},
"status_code" : "aeiou"
},
"backup_pool" : {
"backup_pool_ref" : "aeiou"
},
"type" : "aeiou"
},
"max_conn_rate_per_server" : {
"rate_limiter" : {
"period" : 123,
"count" : 123,
"name" : "aeiou",
"burst_sz" : 123
},
"period" : 123,
"count" : 123,
"action" : {
"redirect" : {
"keep_query" : true,
"path" : "",
"protocol" : "aeiou",
"status_code" : "aeiou",
"port" : 123,
"host" : {
"tokens" : [ {
"start_index" : 123,
"str_value" : "aeiou",
"end_index" : 123,
"type" : "aeiou"
} ],
"type" : "aeiou"
}
},
"file" : "",
"status_code" : "aeiou",
"type" : "aeiou"
},
"burst_sz" : 123,
"explicit_tracking" : true,
"fine_grain" : true,
"http_cookie" : "aeiou",
"http_header" : "aeiou"
},
"analytics_profile_ref" : "aeiou",
"max_concurrent_connections_per_server" : 123,
"service_metadata" : "aeiou",
"capacity_estimation_ttfb_thresh" : 123,
"lb_algorithm_hash" : "aeiou",
"delete_server_on_dns_refresh" : true,
"request_queue_enabled" : true,
"host_check_enabled" : true,
"server_timeout" : 123,
"url" : "aeiou",
"nsx_securitygroup" : [ "aeiou" ],
"pki_profile_ref" : "aeiou",
"connection_ramp_duration" : 123,
"tenant_ref" : "aeiou",
"conn_pool_properties" : {
"upstream_connpool_conn_idle_tmo" : 123,
"upstream_connpool_conn_life_tmo" : 123,
"upstream_connpool_conn_max_reuse" : 123,
"upstream_connpool_server_max_cache" : 123
},
"server_count" : 123,
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"apic_epg_name" : "aeiou",
"lb_algorithm_consistent_hash_hdr" : "aeiou",
"rewrite_host_header_to_sni" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
Pool
401
log in failed
Up
get /pool/{uuid}/hmon/
(poolUuidHmonGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /pool/{uuid}/httpcache/
(poolUuidHttpcacheGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /pool/{uuid}/httpcachestats/detail/
(poolUuidHttpcachestatsDetailGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /pool/{uuid}/httpcachestats/
(poolUuidHttpcachestatsGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /pool/{uuid}/objsync/
(poolUuidObjsyncGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
(poolUuidPatch)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Pool object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"ipaddrgroup_ref" : "aeiou",
"min_health_monitors_up" : 123,
"inline_health_monitor" : true,
"default_server_port" : 123,
"resolve_pool_by_dns" : true,
"lookup_server_by_name" : true,
"fewest_tasks_feedback_delay" : 123,
"sni_enabled" : true,
"vrf_ref" : "aeiou",
"uuid" : "aeiou",
"domain_name" : [ "aeiou" ],
"east_west" : true,
"rewrite_host_header_to_server_name" : true,
"ssl_key_and_certificate_ref" : "aeiou",
"cloud_ref" : "aeiou",
"tier1_lr" : "aeiou",
"analytics_policy" : {
"enable_realtime_metrics" : true
},
"health_monitor_refs" : [ "aeiou" ],
"ab_pool" : {
"pool_ref" : "aeiou",
"ratio" : 123
},
"application_persistence_profile_ref" : "aeiou",
"lb_algorithm_core_nonaffinity" : 123,
"autoscale_launch_config_ref" : "aeiou",
"routing_pool" : true,
"prst_hdr_name" : "aeiou",
"placement_networks" : [ {
"subnet" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"network_ref" : "aeiou"
} ],
"autoscale_networks" : [ "aeiou" ],
"enable_http2" : true,
"created_by" : "aeiou",
"external_autoscale_groups" : [ "aeiou" ],
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"min_servers_up" : 123,
"ab_priority" : 123,
"capacity_estimation" : true,
"ignore_server_port" : true,
"name" : "aeiou",
"cloud_config_cksum" : "aeiou",
"server_auto_scale" : true,
"gslb_sp_enabled" : true,
"server_name" : "aeiou",
"request_queue_depth" : 123,
"description" : "aeiou",
"lb_algorithm" : "aeiou",
"ssl_profile_ref" : "aeiou",
"graceful_disable_timeout" : 123,
"networks" : [ {
"server_filter" : "aeiou",
"network_ref" : "aeiou"
} ],
"use_service_port" : true,
"enabled" : true,
"_last_modified" : "aeiou",
"a_pool" : "aeiou",
"server_reselect" : {
"retry_timeout" : 123,
"svr_resp_code" : {
"resp_code_block" : [ "aeiou" ],
"codes" : [ "" ],
"ranges" : [ {
"end" : 123,
"begin" : 123
} ]
},
"num_retries" : 123,
"enabled" : true,
"retry_nonidempotent" : true
},
"autoscale_policy_ref" : "aeiou",
"servers" : [ {
"availability_zone" : "aeiou",
"prst_hdr_val" : "aeiou",
"static" : true,
"vm_ref" : "aeiou",
"ip" : "",
"description" : "aeiou",
"external_uuid" : "aeiou",
"verify_network" : true,
"enabled" : true,
"autoscaling_group_name" : "aeiou",
"rewrite_host_header" : true,
"discovered_subnet" : [ "" ],
"hostname" : "aeiou",
"nw_ref" : "aeiou",
"external_orchestration_id" : "aeiou",
"port" : 123,
"mac_address" : "aeiou",
"server_node" : "aeiou",
"location" : {
"latitude" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"tag" : "aeiou",
"longitude" : 1.3579000000000001069366817318950779736042022705078125
},
"resolve_server_by_dns" : true,
"discovered_networks" : [ {
"subnet" : [ "" ],
"subnet6" : [ "" ],
"network_ref" : "aeiou"
} ],
"discovered_network_ref" : [ "aeiou" ],
"ratio" : 123
} ],
"fail_action" : {
"redirect" : {
"path" : "aeiou",
"protocol" : "aeiou",
"status_code" : "aeiou",
"query" : "aeiou",
"host" : "aeiou"
},
"local_rsp" : {
"file" : {
"file_content" : "aeiou",
"content_type" : "aeiou"
},
"status_code" : "aeiou"
},
"backup_pool" : {
"backup_pool_ref" : "aeiou"
},
"type" : "aeiou"
},
"max_conn_rate_per_server" : {
"rate_limiter" : {
"period" : 123,
"count" : 123,
"name" : "aeiou",
"burst_sz" : 123
},
"period" : 123,
"count" : 123,
"action" : {
"redirect" : {
"keep_query" : true,
"path" : "",
"protocol" : "aeiou",
"status_code" : "aeiou",
"port" : 123,
"host" : {
"tokens" : [ {
"start_index" : 123,
"str_value" : "aeiou",
"end_index" : 123,
"type" : "aeiou"
} ],
"type" : "aeiou"
}
},
"file" : "",
"status_code" : "aeiou",
"type" : "aeiou"
},
"burst_sz" : 123,
"explicit_tracking" : true,
"fine_grain" : true,
"http_cookie" : "aeiou",
"http_header" : "aeiou"
},
"analytics_profile_ref" : "aeiou",
"max_concurrent_connections_per_server" : 123,
"service_metadata" : "aeiou",
"capacity_estimation_ttfb_thresh" : 123,
"lb_algorithm_hash" : "aeiou",
"delete_server_on_dns_refresh" : true,
"request_queue_enabled" : true,
"host_check_enabled" : true,
"server_timeout" : 123,
"url" : "aeiou",
"nsx_securitygroup" : [ "aeiou" ],
"pki_profile_ref" : "aeiou",
"connection_ramp_duration" : 123,
"tenant_ref" : "aeiou",
"conn_pool_properties" : {
"upstream_connpool_conn_idle_tmo" : 123,
"upstream_connpool_conn_life_tmo" : 123,
"upstream_connpool_conn_max_reuse" : 123,
"upstream_connpool_server_max_cache" : 123
},
"server_count" : 123,
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"apic_epg_name" : "aeiou",
"lb_algorithm_consistent_hash_hdr" : "aeiou",
"rewrite_host_header_to_sni" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
Pool
401
log in failed
Up
get /pool/{uuid}/persistence/
(poolUuidPersistenceGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
(poolUuidPut)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Pool object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"ipaddrgroup_ref" : "aeiou",
"min_health_monitors_up" : 123,
"inline_health_monitor" : true,
"default_server_port" : 123,
"resolve_pool_by_dns" : true,
"lookup_server_by_name" : true,
"fewest_tasks_feedback_delay" : 123,
"sni_enabled" : true,
"vrf_ref" : "aeiou",
"uuid" : "aeiou",
"domain_name" : [ "aeiou" ],
"east_west" : true,
"rewrite_host_header_to_server_name" : true,
"ssl_key_and_certificate_ref" : "aeiou",
"cloud_ref" : "aeiou",
"tier1_lr" : "aeiou",
"analytics_policy" : {
"enable_realtime_metrics" : true
},
"health_monitor_refs" : [ "aeiou" ],
"ab_pool" : {
"pool_ref" : "aeiou",
"ratio" : 123
},
"application_persistence_profile_ref" : "aeiou",
"lb_algorithm_core_nonaffinity" : 123,
"autoscale_launch_config_ref" : "aeiou",
"routing_pool" : true,
"prst_hdr_name" : "aeiou",
"placement_networks" : [ {
"subnet" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"network_ref" : "aeiou"
} ],
"autoscale_networks" : [ "aeiou" ],
"enable_http2" : true,
"created_by" : "aeiou",
"external_autoscale_groups" : [ "aeiou" ],
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"min_servers_up" : 123,
"ab_priority" : 123,
"capacity_estimation" : true,
"ignore_server_port" : true,
"name" : "aeiou",
"cloud_config_cksum" : "aeiou",
"server_auto_scale" : true,
"gslb_sp_enabled" : true,
"server_name" : "aeiou",
"request_queue_depth" : 123,
"description" : "aeiou",
"lb_algorithm" : "aeiou",
"ssl_profile_ref" : "aeiou",
"graceful_disable_timeout" : 123,
"networks" : [ {
"server_filter" : "aeiou",
"network_ref" : "aeiou"
} ],
"use_service_port" : true,
"enabled" : true,
"_last_modified" : "aeiou",
"a_pool" : "aeiou",
"server_reselect" : {
"retry_timeout" : 123,
"svr_resp_code" : {
"resp_code_block" : [ "aeiou" ],
"codes" : [ "" ],
"ranges" : [ {
"end" : 123,
"begin" : 123
} ]
},
"num_retries" : 123,
"enabled" : true,
"retry_nonidempotent" : true
},
"autoscale_policy_ref" : "aeiou",
"servers" : [ {
"availability_zone" : "aeiou",
"prst_hdr_val" : "aeiou",
"static" : true,
"vm_ref" : "aeiou",
"ip" : "",
"description" : "aeiou",
"external_uuid" : "aeiou",
"verify_network" : true,
"enabled" : true,
"autoscaling_group_name" : "aeiou",
"rewrite_host_header" : true,
"discovered_subnet" : [ "" ],
"hostname" : "aeiou",
"nw_ref" : "aeiou",
"external_orchestration_id" : "aeiou",
"port" : 123,
"mac_address" : "aeiou",
"server_node" : "aeiou",
"location" : {
"latitude" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"tag" : "aeiou",
"longitude" : 1.3579000000000001069366817318950779736042022705078125
},
"resolve_server_by_dns" : true,
"discovered_networks" : [ {
"subnet" : [ "" ],
"subnet6" : [ "" ],
"network_ref" : "aeiou"
} ],
"discovered_network_ref" : [ "aeiou" ],
"ratio" : 123
} ],
"fail_action" : {
"redirect" : {
"path" : "aeiou",
"protocol" : "aeiou",
"status_code" : "aeiou",
"query" : "aeiou",
"host" : "aeiou"
},
"local_rsp" : {
"file" : {
"file_content" : "aeiou",
"content_type" : "aeiou"
},
"status_code" : "aeiou"
},
"backup_pool" : {
"backup_pool_ref" : "aeiou"
},
"type" : "aeiou"
},
"max_conn_rate_per_server" : {
"rate_limiter" : {
"period" : 123,
"count" : 123,
"name" : "aeiou",
"burst_sz" : 123
},
"period" : 123,
"count" : 123,
"action" : {
"redirect" : {
"keep_query" : true,
"path" : "",
"protocol" : "aeiou",
"status_code" : "aeiou",
"port" : 123,
"host" : {
"tokens" : [ {
"start_index" : 123,
"str_value" : "aeiou",
"end_index" : 123,
"type" : "aeiou"
} ],
"type" : "aeiou"
}
},
"file" : "",
"status_code" : "aeiou",
"type" : "aeiou"
},
"burst_sz" : 123,
"explicit_tracking" : true,
"fine_grain" : true,
"http_cookie" : "aeiou",
"http_header" : "aeiou"
},
"analytics_profile_ref" : "aeiou",
"max_concurrent_connections_per_server" : 123,
"service_metadata" : "aeiou",
"capacity_estimation_ttfb_thresh" : 123,
"lb_algorithm_hash" : "aeiou",
"delete_server_on_dns_refresh" : true,
"request_queue_enabled" : true,
"host_check_enabled" : true,
"server_timeout" : 123,
"url" : "aeiou",
"nsx_securitygroup" : [ "aeiou" ],
"pki_profile_ref" : "aeiou",
"connection_ramp_duration" : 123,
"tenant_ref" : "aeiou",
"conn_pool_properties" : {
"upstream_connpool_conn_idle_tmo" : 123,
"upstream_connpool_conn_life_tmo" : 123,
"upstream_connpool_conn_max_reuse" : 123,
"upstream_connpool_server_max_cache" : 123
},
"server_count" : 123,
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"apic_epg_name" : "aeiou",
"lb_algorithm_consistent_hash_hdr" : "aeiou",
"rewrite_host_header_to_sni" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
Pool
401
log in failed
Up
get /pool/{uuid}/runtime/debug/
(poolUuidRuntimeDebugGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /pool/{uuid}/runtime/detail/
(poolUuidRuntimeDetailGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /pool/{uuid}/runtime/
(poolUuidRuntimeGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /pool/{uuid}/runtime/internal/
(poolUuidRuntimeInternalGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
post /pool/{uuid}/runtime/request_queue/clear
(poolUuidRuntimeRequestQueueClearPost)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — empty
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /pool/{uuid}/runtime/server/detail/
(poolUuidRuntimeServerDetailGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /pool/{uuid}/runtime/server/
(poolUuidRuntimeServerGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /pool/{uuid}/runtime/server/hmonstat/
(poolUuidRuntimeServerHmonstatGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /pool/{uuid}/runtime/server/internal/
(poolUuidRuntimeServerInternalGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
post /pool/{uuid}/runtime/stats/clear
(poolUuidRuntimeStatsClearPost)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — empty
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
post /pool/{uuid}/scalein
(poolUuidScaleinPost)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ServerScaleInParams
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
post /pool/{uuid}/scaleout
(poolUuidScaleoutPost)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ServerScaleOutParams
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
(poolUuidVsGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
[ Jump to Methods ]
Table of Contents
AbPoolConnPoolPropertiesConnpoolFilterDiscoveredNetworkFailActionFailActionBackupPoolFailActionHTTPLocalResponseFailActionHTTPRedirectGeoLocationHTTPLocalFileHTTPRedirectActionHTTPReselectRespCodeHTTPServerReselectHTTPStatusRangeHttpCacheObjFilterIpAddrIpAddrPrefixKeyValueNetworkFilterPersistenceFilterPlacementNetworkPoolPoolAnalyticsPolicyPoolApiResponseRateLimiterRateLimiterActionRateProfileRoleFilterMatchLabelServerServerIdServerScaleInParamsServerScaleOutParamsURIParamURIParamToken
pool_ref
String Pool configured as B pool for A/B testing. It is a reference to an object of type Pool.
ratio (optional)
Integer Ratio of traffic diverted to the B pool, for A/B testing. Allowed values are 0-100. format: int32
upstream_connpool_conn_idle_tmo (optional)
Integer Connection idle timeout. Field introduced in 18.2.1. Allowed in Basic(Allowed values- 60000) edition, Essentials(Allowed values- 60000) edition, Enterprise edition. format: int32
upstream_connpool_conn_life_tmo (optional)
Integer Connection life timeout. Field introduced in 18.2.1. Allowed in Basic(Allowed values- 600000) edition, Essentials(Allowed values- 600000) edition, Enterprise edition. format: int32
upstream_connpool_conn_max_reuse (optional)
Integer Maximum number of times a connection can be reused. Special values are 0- 'unlimited'. Field introduced in 18.2.1. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. format: int32
upstream_connpool_server_max_cache (optional)
Integer Maximum number of connections a server can cache. Special values are 0- 'unlimited'. Field introduced in 18.2.1. format: int32
ip_addr (optional)
String Backend or SE IP address.
ip_mask (optional)
String Backend or SE IP address mask.
port (optional)
Integer Backend or SE port. format: int32
type (optional)
String cache type. Enum options - CP_ALL, CP_FREE, CP_BIND, CP_CACHED.
network_ref
String Discovered network for this IP. It is a reference to an object of type Network.
subnet (optional)
subnet6 (optional)
backup_pool (optional)
local_rsp (optional)
redirect (optional)
type
String Enables a response to client when pool experiences a failure. By default TCP connection is closed. Enum options - FAIL_ACTION_HTTP_REDIRECT, FAIL_ACTION_HTTP_LOCAL_RSP, FAIL_ACTION_CLOSE_CONN, FAIL_ACTION_BACKUP_POOL. Allowed in Basic(Allowed values- FAIL_ACTION_CLOSE_CONN,FAIL_ACTION_HTTP_REDIRECT) edition, Essentials(Allowed values- FAIL_ACTION_CLOSE_CONN) edition, Enterprise edition.
backup_pool_ref
String Specifies the UUID of the Pool acting as backup pool. It is a reference to an object of type Pool.
file (optional)
HTTPLocalFile Placeholder for description of property file of obj type FailActionHTTPLocalResponse field type str type object
status_code (optional)
String Enum options - FAIL_HTTP_STATUS_CODE_200, FAIL_HTTP_STATUS_CODE_503.
host
String host of FailActionHTTPRedirect.
path (optional)
String path of FailActionHTTPRedirect.
protocol (optional)
String Enum options - HTTP, HTTPS. Allowed in Basic(Allowed values- HTTP) edition, Enterprise edition. Special default for Basic edition is HTTP, Enterprise is HTTPS.
query (optional)
String query of FailActionHTTPRedirect.
status_code (optional)
String Enum options - HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307. Allowed in Basic(Allowed values- HTTP_REDIRECT_STATUS_CODE_302) edition, Enterprise edition.
latitude (optional)
Float Latitude of the location. This is represented as degrees.minutes. The range is from -90.0 (south) to +90.0 (north). Allowed values are -90.0-+90.0. Field introduced in 17.1.1. format: float
longitude (optional)
Float Longitude of the location. This is represented as degrees.minutes. The range is from -180.0 (west) to +180.0 (east). Allowed values are -180.0-+180.0. Field introduced in 17.1.1. format: float
name (optional)
String Location name in the format Country/State/City. Field introduced in 17.1.1.
tag (optional)
String Location tag string - example USEast. Field introduced in 17.1.1.
content_type
String Mime-type of the content in the file.
file_content
String File content to used in the local HTTP response body.
host (optional)
keep_query (optional)
Boolean Keep or drop the query of the incoming request URI in the redirected URI.
path (optional)
port (optional)
Integer Port to which redirect the request. Allowed values are 1-65535. format: int32
protocol
String Protocol type. Enum options - HTTP, HTTPS.
status_code (optional)
String HTTP redirect status code. Enum options - HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307.
codes (optional)
array[Integer] HTTP response code to be matched. Allowed values are 400-599.
ranges (optional)
resp_code_block (optional)
array[String] Block of HTTP response codes to match for server reselect. Enum options - HTTP_RSP_4XX, HTTP_RSP_5XX.
enabled
Boolean Enable HTTP request reselect when server responds with specific response codes. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
num_retries (optional)
Integer Number of times to retry an HTTP request when server responds with configured status codes. format: int32
retry_nonidempotent (optional)
Boolean Allow retry of non-idempotent HTTP requests.
retry_timeout (optional)
Integer Timeout per retry attempt, for a given request. Value of 0 indicates default timeout. Allowed values are 0-3600000. Field introduced in 18.1.5,18.2.1. Unit is MILLISECONDS. format: int32
svr_resp_code (optional)
begin
Integer Starting HTTP response status code. format: int32
end
Integer Ending HTTP response status code. format: int32
key (optional)
String HTTP cache object's exact key.
raw_key (optional)
String HTTP cache object's exact raw key.
resource_name (optional)
String HTTP cache object's resource name.
resource_type (optional)
String objects with resource type.
type (optional)
String HTTP cache object type. Enum options - CO_ALL, CO_IN, CO_OUT.
addr
type
String Enum options - V4, DNS, V6.
ip_addr
IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object
mask
Integer Number of mask. format: int32
network_ref
String It is a reference to an object of type VIMgrNWRuntime.
server_filter (optional)
String server_filter of NetworkFilter.
persistence_cookie (optional)
persistence_end_ip (optional)
IpAddr Placeholder for description of property persistence_end_ip of obj type PersistenceFilter field type str type object
persistence_ip (optional)
IpAddr Placeholder for description of property persistence_ip of obj type PersistenceFilter field type str type object
persistence_mask (optional)
Integer Number of persistence_mask. format: int32
server_end_ip (optional)
IpAddr Placeholder for description of property server_end_ip of obj type PersistenceFilter field type str type object
server_ip (optional)
IpAddr Placeholder for description of property server_ip of obj type PersistenceFilter field type str type object
server_mask (optional)
Integer Number of server_mask. format: int32
server_port (optional)
Integer Number of server_port. format: int32
network_ref
String It is a reference to an object of type Network.
subnet
IpAddrPrefix Placeholder for description of property subnet of obj type PlacementNetwork field type str type object
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
a_pool (optional)
String Name of container cloud application that constitutes A pool in a A-B pool configuration, if different from VS app. Field deprecated in 18.1.2.
ab_pool (optional)
AbPool A/B pool configuration. Field deprecated in 18.1.2.
ab_priority (optional)
Integer Priority of this pool in a A-B pool pair. Internally used. Field deprecated in 18.1.2. format: int32
analytics_policy (optional)
PoolAnalyticsPolicy Determines analytics settings for the pool. Field introduced in 18.1.5, 18.2.1.
analytics_profile_ref (optional)
String Specifies settings related to analytics. It is a reference to an object of type AnalyticsProfile. Field introduced in 18.1.4,18.2.1.
apic_epg_name (optional)
String Synchronize Cisco APIC EPG members with pool servers.
application_persistence_profile_ref (optional)
String Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type ApplicationPersistenceProfile.
autoscale_launch_config_ref (optional)
String If configured then Avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type AutoScaleLaunchConfig.
autoscale_networks (optional)
autoscale_policy_ref (optional)
String Reference to Server Autoscale Policy. It is a reference to an object of type ServerAutoScalePolicy.
capacity_estimation (optional)
Boolean Inline estimation of capacity of servers. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
capacity_estimation_ttfb_thresh (optional)
Integer The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - 'Automatic'. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. format: int32
cloud_config_cksum (optional)
String Checksum of cloud configuration for Pool. Internally set by cloud connector.
cloud_ref (optional)
String It is a reference to an object of type Cloud.
conn_pool_properties (optional)
connection_ramp_duration (optional)
Integer 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. Allowed values are 1-300. Special values are 0 - 'Immediate'. Unit is MIN. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Special default for Basic edition is 0, Essentials edition is 0, Enterprise is 10. format: int32
created_by (optional)
default_server_port (optional)
Integer 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. Allowed values are 1-65535. format: int32
delete_server_on_dns_refresh (optional)
Boolean Indicates whether existing IPs are disabled(false) or deleted(true) on dns hostname refreshDetail -- On a dns refresh, some IPs set on pool may no longer be returned by the resolver. These IPs are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Field introduced in 18.2.3. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition.
description (optional)
String A description of the pool.
domain_name (optional)
array[String] Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled.
east_west (optional)
Boolean Inherited config from VirtualService.
enable_http2 (optional)
Boolean Enable HTTP/2 for traffic from VirtualService to all backend servers in this pool. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
enabled (optional)
Boolean Enable or disable the pool. Disabling will terminate all open connections and pause health monitors.
external_autoscale_groups (optional)
array[String] Names of external auto-scale groups for pool servers. Currently available only for AWS and Azure. Field introduced in 17.1.2.
fail_action (optional)
FailAction Enable an action - Close Connection, HTTP Redirect or Local HTTP Response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure.
fewest_tasks_feedback_delay (optional)
Integer Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is SEC. format: int32
graceful_disable_timeout (optional)
Integer Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - 'Immediate', -1 - 'Infinite'. Unit is MIN. format: int32
gslb_sp_enabled (optional)
Boolean Indicates if the pool is a site-persistence pool. . Field introduced in 17.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition.
health_monitor_refs (optional)
array[String] 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 only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type HealthMonitor. Maximum of 50 items allowed.
host_check_enabled (optional)
Boolean 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.
ignore_server_port (optional)
Boolean Ignore the server port in building the load balancing state.Applicable only for consistent hash load balancing algorithm or Disable Port translation (use_service_port) use cases. Field introduced in 20.1.1.
inline_health_monitor (optional)
Boolean 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.
ipaddrgroup_ref (optional)
String Use list of servers from Ip Address Group. It is a reference to an object of type IpAddrGroup.
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field deprecated in 20.1.5. Field introduced in 20.1.2. Maximum of 4 items allowed.
lb_algorithm (optional)
String The load balancing algorithm will pick a server within the pool's list of available servers. Values LB_ALGORITHM_NEAREST_SERVER and LB_ALGORITHM_TOPOLOGY are only allowed for GSLB pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed in Basic(Allowed values- LB_ALGORITHM_LEAST_CONNECTIONS,LB_ALGORITHM_ROUND_ROBIN,LB_ALGORITHM_CONSISTENT_HASH) edition, Essentials(Allowed values- LB_ALGORITHM_LEAST_CONNECTIONS,LB_ALGORITHM_ROUND_ROBIN,LB_ALGORITHM_CONSISTENT_HASH) edition, Enterprise edition.
lb_algorithm_consistent_hash_hdr (optional)
String HTTP header name to be used for the hash key.
lb_algorithm_core_nonaffinity (optional)
Integer Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Field introduced in 17.1.3. Allowed in Basic(Allowed values- 2) edition, Essentials(Allowed values- 2) edition, Enterprise edition. format: int32
lb_algorithm_hash (optional)
String Criteria used as a key for determining the hash between the client and server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed in Basic(Allowed values- LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS) edition, Essentials(Allowed values- LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS) edition, Enterprise edition.
lookup_server_by_name (optional)
Boolean Allow server lookup by name. Field introduced in 17.1.11,17.2.4. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Basic edition, Essentials edition, Enterprise edition.
max_concurrent_connections_per_server (optional)
Integer The maximum number of concurrent connections allowed to each server within the pool. NOTE applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. format: int32
max_conn_rate_per_server (optional)
min_health_monitors_up (optional)
Integer Minimum number of health monitors in UP state to mark server UP. Field introduced in 18.2.1, 17.2.12. Allowed in Basic edition, Essentials edition, Enterprise edition. format: int32
min_servers_up (optional)
Integer Minimum number of servers in UP state for marking the pool UP. Field introduced in 18.2.1, 17.2.12. format: int32
name
networks (optional)
array[NetworkFilter] (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.
nsx_securitygroup (optional)
array[String] A list of NSX Groups where the Servers for the Pool are created . Field introduced in 17.1.1.
pki_profile_ref (optional)
String Avi will validate the SSL certificate present by a server against the selected PKI Profile. It is a reference to an object of type PKIProfile.
placement_networks (optional)
array[PlacementNetwork] 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. Use static routes in VRF configuration when pool servers are not directly connected but routable from the service engine.
prst_hdr_name (optional)
String Header name for custom header persistence. Field deprecated in 18.1.2.
request_queue_depth (optional)
Integer Minimum number of requests to be queued when pool is full. Allowed in Basic(Allowed values- 128) edition, Essentials(Allowed values- 128) edition, Enterprise edition. format: int32
request_queue_enabled (optional)
Boolean Enable request queue when pool is full. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
resolve_pool_by_dns (optional)
Boolean This field is used as a flag to create a job for JobManager. Field introduced in 18.2.10,20.1.2.
rewrite_host_header_to_server_name (optional)
Boolean 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.
rewrite_host_header_to_sni (optional)
Boolean If SNI server name is specified, rewrite incoming host header to the SNI server name.
routing_pool (optional)
Boolean Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Field introduced in 20.1.1.
server_auto_scale (optional)
Boolean Server AutoScale. Not used anymore. Field deprecated in 18.1.2.
server_count (optional)
Integer Field deprecated in 18.2.1. format: int32
server_name (optional)
String 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.
server_reselect (optional)
server_timeout (optional)
Integer Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between AVI and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-21600000. Field introduced in 18.1.5,18.2.1. Unit is MILLISECONDS. format: int32
servers (optional)
array[Server] 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. Maximum of 5000 items allowed.
service_metadata (optional)
String Metadata pertaining to the service provided by this Pool. In Openshift/Kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by Avi Vantage. Field introduced in 17.2.14,18.1.5,18.2.1.
sni_enabled (optional)
Boolean Enable TLS SNI for server connections. If disabled, Avi will not send the SNI extension as part of the handshake.
ssl_key_and_certificate_ref (optional)
String Service Engines will present a client SSL certificate to the server. It is a reference to an object of type SSLKeyAndCertificate.
ssl_profile_ref (optional)
String When enabled, Avi re-encrypts traffic to the backend servers. The specific SSL profile defines which ciphers and SSL versions will be supported. It is a reference to an object of type SSLProfile.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
tier1_lr (optional)
String This tier1_lr field should be set same as VirtualService associated for NSX-T. Field introduced in 20.1.1.
url (optional)
use_service_port (optional)
Boolean 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. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
uuid (optional)
vrf_ref (optional)
String 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. It is a reference to an object of type VrfContext.
enable_realtime_metrics (optional)
Boolean Enable real time metrics for server and pool metrics eg. l4_server.xxx, l7_server.xxx. Field introduced in 18.1.5, 18.2.1.
count
results
next (optional)
burst_sz (optional)
Integer Maximum number of connections, requests or packets to be let through instantaneously. If this is less than count, it will have no effect. Allowed values are 0-1000000000. Field introduced in 18.2.9. format: int32
count
Integer Maximum number of connections, requests or packets permitted each period. Allowed values are 1-1000000000. Field introduced in 18.2.9. format: int32
name (optional)
String Identifier for Rate Limit. Constructed according to context. Field introduced in 18.2.9.
period
Integer Time value in seconds to enforce rate count. Allowed values are 1-1000000000. Field introduced in 18.2.9. Unit is SEC. format: int32
file (optional)
HTTPLocalFile File to be used for HTTP Local response rate limit action.
redirect (optional)
status_code (optional)
String HTTP status code for Local Response rate limit action. Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501.
type (optional)
String Type of action to be enforced upon hitting the rate limit. Enum options - RL_ACTION_NONE, RL_ACTION_DROP_CONN, RL_ACTION_RESET_CONN, RL_ACTION_CLOSE_CONN, RL_ACTION_LOCAL_RSP, RL_ACTION_REDIRECT.
action
burst_sz (optional)
Integer Maximum number of connections or requests or packets to be let through instantaneously. Allowed values are 10-2500. Special values are 0- 'automatic'. Field deprecated in 18.2.9. format: int32
count (optional)
Integer Maximum number of connections or requests or packets. Allowed values are 1-1000000000. Special values are 0- 'unlimited'. Field deprecated in 18.2.9. format: int32
explicit_tracking (optional)
Boolean Explicitly tracks an attacker across rate periods.
fine_grain (optional)
http_cookie (optional)
String HTTP cookie name. Field introduced in 17.1.1.
http_header (optional)
String HTTP header name. Field introduced in 17.1.1.
period (optional)
Integer Time value in seconds to enforce rate count. Allowed values are 1-300. Field deprecated in 18.2.9. Unit is SEC. format: int32
rate_limiter (optional)
RateLimiter The rate limiter configuration for this rate profile. Field introduced in 18.2.9.
key
String Key for filter match. Field introduced in 20.1.3.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3.
autoscaling_group_name (optional)
String Name of autoscaling group this server belongs to. Field introduced in 17.1.2. Allowed in Essentials edition, Enterprise edition.
availability_zone (optional)
String Availability-zone of the server VM.
description (optional)
String A description of the Server.
discovered_network_ref (optional)
array[String] (internal-use) Discovered network for this server. This field is deprecated. It is a reference to an object of type Network. Field deprecated in 17.1.1.
discovered_networks (optional)
array[DiscoveredNetwork] (internal-use) Discovered networks providing reachability for server IP. This field is used internally by Avi, not editable by the user.
discovered_subnet (optional)
array[IpAddrPrefix] (internal-use) Discovered subnet for this server. This field is deprecated. Field deprecated in 17.1.1.
enabled (optional)
Boolean Enable, Disable or Graceful Disable determine if new or existing connections to the server are allowed.
external_orchestration_id (optional)
String UID of server in external orchestration systems.
external_uuid (optional)
String UUID identifying VM in OpenStack and other external compute.
hostname (optional)
String DNS resolvable name of the server. May be used in place of the IP address.
ip
IpAddr IP Address of the server. Required if there is no resolvable host name.
location (optional)
GeoLocation (internal-use) Geographic location of the server.Currently only for internal usage. Field introduced in 17.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition.
mac_address (optional)
nw_ref (optional)
String (internal-use) This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrNWRuntime.
port (optional)
Integer Optionally specify the servers port number. This will override the pool's default server port attribute. Allowed values are 1-65535. Special values are 0- 'use backend port in pool'. format: int32
prst_hdr_val (optional)
String Header value for custom header persistence. .
ratio (optional)
Integer Ratio of selecting eligible servers in the pool. Allowed values are 1-20. format: int32
resolve_server_by_dns (optional)
Boolean Auto resolve server's IP using DNS name. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
rewrite_host_header (optional)
Boolean Rewrite incoming Host Header to server name.
server_node (optional)
String Hostname of the node where the server VM or container resides.
static (optional)
verify_network (optional)
Boolean Verify server belongs to a discovered network or reachable via a discovered network. Verify reachable network isn't the OpenStack management network.
vm_ref (optional)
String (internal-use) This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrVMRuntime.
external_uuid (optional)
String This is the external cloud uuid of the Pool server.
ip
IpAddr Placeholder for description of property ip of obj type ServerId field type str type object
port
Integer Number of port. format: int32
reason (optional)
String Reason for the manual scalein.
servers (optional)
uuid (optional)
String Unique object identifier of the object.
reason (optional)
String Reason for the manual scaleout.
uuid (optional)
String Unique object identifier of the object.
tokens (optional)
array[URIParamToken] Token config either for the URI components or a constant string. Minimum of 1 items required.
type
String URI param type. Enum options - URI_PARAM_TYPE_TOKENIZED.
end_index (optional)
Integer Index of the ending token in the incoming URI. Allowed values are 0-65534. Special values are 65535 - 'end of string'. format: int32
start_index (optional)
Integer Index of the starting token in the incoming URI. format: int32
str_value (optional)
String Constant string to use as a token.
type
String Token type for constructing the URI. Enum options - URI_TOKEN_TYPE_HOST, URI_TOKEN_TYPE_PATH, URI_TOKEN_TYPE_STRING, URI_TOKEN_TYPE_STRING_GROUP, URI_TOKEN_TYPE_REGEX.