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'} ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 21.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. post /pool/clear
  2. get /pool
  3. post /pool
  4. get /pool/{uuid}/algo/
  5. get /pool/{uuid}/connpool/
  6. post /pool/{uuid}/connpoolstats/clear
  7. delete /pool/{uuid}
  8. get /pool/{uuid}
  9. get /pool/{uuid}/hmon/
  10. get /pool/{uuid}/httpcache/
  11. get /pool/{uuid}/httpcachestats/detail/
  12. get /pool/{uuid}/httpcachestats/
  13. get /pool/{uuid}/objsync/
  14. patch /pool/{uuid}
  15. get /pool/{uuid}/persistence/
  16. put /pool/{uuid}
  17. get /pool/{uuid}/runtime/debug/
  18. get /pool/{uuid}/runtime/detail/
  19. get /pool/{uuid}/runtime/
  20. get /pool/{uuid}/runtime/internal/
  21. post /pool/{uuid}/runtime/request_queue/clear
  22. get /pool/{uuid}/runtime/server/detail/
  23. get /pool/{uuid}/runtime/server/
  24. get /pool/{uuid}/runtime/server/hmonstat/
  25. get /pool/{uuid}/runtime/server/internal/
  26. post /pool/{uuid}/runtime/stats/clear
  27. get /pool/{uuid}/runtime/vs/service/server/map/kv/
  28. get /pool/{uuid}/runtime/vs/service/server/map/table/
  29. post /pool/{uuid}/scalein
  30. post /pool/{uuid}/scaleout
  31. get /pool/{uuid}/vs/
Up 
post /pool/clear
(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 Accept 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
(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

PoolApiResponse

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,
    "server_disable_type" : "aeiou",
    "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",
    "append_port" : "aeiou",
    "cloud_ref" : "aeiou",
    "tier1_lr" : "aeiou",
    "configpb_attributes" : {
      "version" : 123
    },
    "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",
    "lb_algo_rr_per_se" : true,
    "routing_pool" : true,
    "prst_hdr_name" : "aeiou",
    "placement_networks" : [ {
      "subnet" : {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      },
      "network_ref" : "aeiou"
    } ],
    "use_service_ssl_mode" : true,
    "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,
    "http2_properties" : {
      "max_http2_control_frames_per_connection" : 123,
      "max_http2_header_field_size" : 123
    },
    "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",
          "file_length" : 123
        },
        "status_code" : "aeiou"
      },
      "backup_pool" : {
        "backup_pool_ref" : "aeiou"
      },
      "type" : "aeiou"
    },
    "horizon_profile" : {
      "blast_port" : 123,
      "pcoip_port" : 123
    },
    "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",
          "add_string" : "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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PoolApiResponse

401

log in failed
Up 
post /pool
(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

Pool

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,
  "server_disable_type" : "aeiou",
  "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",
  "append_port" : "aeiou",
  "cloud_ref" : "aeiou",
  "tier1_lr" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "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",
  "lb_algo_rr_per_se" : true,
  "routing_pool" : true,
  "prst_hdr_name" : "aeiou",
  "placement_networks" : [ {
    "subnet" : {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    },
    "network_ref" : "aeiou"
  } ],
  "use_service_ssl_mode" : true,
  "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,
  "http2_properties" : {
    "max_http2_control_frames_per_connection" : 123,
    "max_http2_header_field_size" : 123
  },
  "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",
        "file_length" : 123
      },
      "status_code" : "aeiou"
    },
    "backup_pool" : {
      "backup_pool_ref" : "aeiou"
    },
    "type" : "aeiou"
  },
  "horizon_profile" : {
    "blast_port" : 123,
    "pcoip_port" : 123
  },
  "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",
        "add_string" : "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 Accept 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 Accept 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 Accept 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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed
Up 
delete /pool/{uuid}
(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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found
Up 
get /pool/{uuid}
(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

Pool

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,
  "server_disable_type" : "aeiou",
  "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",
  "append_port" : "aeiou",
  "cloud_ref" : "aeiou",
  "tier1_lr" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "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",
  "lb_algo_rr_per_se" : true,
  "routing_pool" : true,
  "prst_hdr_name" : "aeiou",
  "placement_networks" : [ {
    "subnet" : {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    },
    "network_ref" : "aeiou"
  } ],
  "use_service_ssl_mode" : true,
  "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,
  "http2_properties" : {
    "max_http2_control_frames_per_connection" : 123,
    "max_http2_header_field_size" : 123
  },
  "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",
        "file_length" : 123
      },
      "status_code" : "aeiou"
    },
    "backup_pool" : {
      "backup_pool_ref" : "aeiou"
    },
    "type" : "aeiou"
  },
  "horizon_profile" : {
    "blast_port" : 123,
    "pcoip_port" : 123
  },
  "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",
        "add_string" : "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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed
Up 
patch /pool/{uuid}
(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

Pool

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,
  "server_disable_type" : "aeiou",
  "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",
  "append_port" : "aeiou",
  "cloud_ref" : "aeiou",
  "tier1_lr" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "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",
  "lb_algo_rr_per_se" : true,
  "routing_pool" : true,
  "prst_hdr_name" : "aeiou",
  "placement_networks" : [ {
    "subnet" : {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    },
    "network_ref" : "aeiou"
  } ],
  "use_service_ssl_mode" : true,
  "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,
  "http2_properties" : {
    "max_http2_control_frames_per_connection" : 123,
    "max_http2_header_field_size" : 123
  },
  "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",
        "file_length" : 123
      },
      "status_code" : "aeiou"
    },
    "backup_pool" : {
      "backup_pool_ref" : "aeiou"
    },
    "type" : "aeiou"
  },
  "horizon_profile" : {
    "blast_port" : 123,
    "pcoip_port" : 123
  },
  "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",
        "add_string" : "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 Accept 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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed
Up 
put /pool/{uuid}
(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

Pool

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,
  "server_disable_type" : "aeiou",
  "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",
  "append_port" : "aeiou",
  "cloud_ref" : "aeiou",
  "tier1_lr" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "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",
  "lb_algo_rr_per_se" : true,
  "routing_pool" : true,
  "prst_hdr_name" : "aeiou",
  "placement_networks" : [ {
    "subnet" : {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    },
    "network_ref" : "aeiou"
  } ],
  "use_service_ssl_mode" : true,
  "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,
  "http2_properties" : {
    "max_http2_control_frames_per_connection" : 123,
    "max_http2_header_field_size" : 123
  },
  "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",
        "file_length" : 123
      },
      "status_code" : "aeiou"
    },
    "backup_pool" : {
      "backup_pool_ref" : "aeiou"
    },
    "type" : "aeiou"
  },
  "horizon_profile" : {
    "blast_port" : 123,
    "pcoip_port" : 123
  },
  "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",
        "add_string" : "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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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/vs/service/server/map/kv/
(poolUuidRuntimeVsServiceServerMapKvGet)

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 Accept 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/vs/service/server/map/table/
(poolUuidRuntimeVsServiceServerMapTableGet)

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 Accept 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 Accept 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 Accept 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}/vs/
(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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed
Up

Models

[ Jump to Methods ]

Table of Contents

  1. AbPool
  2. ConfigPbAttributes
  3. ConnPoolProperties
  4. ConnpoolFilter
  5. DiscoveredNetwork
  6. FailAction
  7. FailActionBackupPool
  8. FailActionHTTPLocalResponse
  9. FailActionHTTPRedirect
  10. GeoLocation
  11. HTTP2PoolProperties
  12. HTTPLocalFile
  13. HTTPRedirectAction
  14. HTTPReselectRespCode
  15. HTTPServerReselect
  16. HTTPStatusRange
  17. HorizonProfile
  18. HttpCacheObjFilter
  19. IpAddr
  20. IpAddrPrefix
  21. KeyValue
  22. NetworkFilter
  23. PersistenceFilter
  24. PlacementNetwork
  25. Pool
  26. PoolAnalyticsPolicy
  27. PoolApiResponse
  28. RateLimiter
  29. RateLimiterAction
  30. RateProfile
  31. RoleFilterMatchLabel
  32. Server
  33. ServerId
  34. ServerScaleInParams
  35. ServerScaleOutParams
  36. URIParam
  37. URIParamToken

AbPool Up

pool_ref
String Pool configured as B pool for A/B testing. It is a reference to an object of type Pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ratio (optional)
Integer Ratio of traffic diverted to the B pool, for A/B testing. Allowed values are 0-100. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

ConfigPbAttributes Up

version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32

ConnPoolProperties Up

upstream_connpool_conn_idle_tmo (optional)
Integer Connection idle timeout. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 60000), Basic edition(Allowed values- 60000), Enterprise with Cloud Services edition. format: int32
upstream_connpool_conn_life_tmo (optional)
Integer Connection life timeout. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 600000), Basic edition(Allowed values- 600000), Enterprise with Cloud Services 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 Enterprise edition with any value, Essentials edition(Allowed values- 0), Basic edition(Allowed values- 0), Enterprise with Cloud Services 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

ConnpoolFilter Up

ip_addr (optional)
String Backend or SE IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_mask (optional)
String Backend or SE IP address mask. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
port (optional)
Integer Backend or SE port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
type (optional)
String cache type. Enum options - CP_ALL, CP_FREE, CP_BIND, CP_CACHED. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

DiscoveredNetwork Up

network_ref
String Discovered network for this IP. It is a reference to an object of type Network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subnet (optional)
array[IpAddrPrefix] Discovered subnet for this IP. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subnet6 (optional)
array[IpAddrPrefix] Discovered IPv6 subnet for this IP. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

FailAction Up

backup_pool (optional)
FailActionBackupPool Backup Pool when pool experiences a failure. Field deprecated in 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
local_rsp (optional)
FailActionHTTPLocalResponse Local response to HTTP requests when pool experiences a failure. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
redirect (optional)
FailActionHTTPRedirect URL to redirect HTTP requests to when pool experiences a failure. Allowed in Enterprise edition with any value, Basic, Enterprise with Cloud Services edition.
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 Enterprise edition with any value, Essentials edition(Allowed values- FAIL_ACTION_CLOSE_CONN), Basic edition(Allowed values- FAIL_ACTION_CLOSE_CONN,FAIL_ACTION_HTTP_REDIRECT), Enterprise with Cloud Services edition.

FailActionBackupPool Up

backup_pool_ref
String Specifies the UUID of the Pool acting as backup pool. It is a reference to an object of type Pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

FailActionHTTPLocalResponse Up

file (optional)
HTTPLocalFile Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
status_code (optional)
String Enum options - FAIL_HTTP_STATUS_CODE_200, FAIL_HTTP_STATUS_CODE_503. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

FailActionHTTPRedirect Up

host
String The host to which the redirect request is sent. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
path (optional)
String Path configuration for the redirect request. If not set the path from the original request's URI is preserved in the redirect on pool failure. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
protocol (optional)
String Enum options - HTTP, HTTPS. Allowed in Enterprise edition with any value, Basic edition(Allowed values- HTTP), Essentials, Enterprise with Cloud Services edition. Special default for Basic edition is HTTP, Enterprise is HTTPS.
query (optional)
String Query configuration for the redirect request URI. If not set, the query from the original request's URI is preserved in the redirect on pool failure. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
status_code (optional)
String Enum options - HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307. Allowed in Enterprise edition with any value, Basic edition(Allowed values- HTTP_REDIRECT_STATUS_CODE_302), Essentials, Enterprise with Cloud Services edition.

GeoLocation Up

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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: float
name (optional)
String Location name in the format Country/State/City. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tag (optional)
String Location tag string - example USEast. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTP2PoolProperties Up

max_http2_control_frames_per_connection (optional)
Integer The max number of control frames that server can send over an HTTP/2 connection. '0' means unlimited. Allowed values are 0-10000. Special values are 0- Unlimited control frames on a server side HTTP/2 connection. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
max_http2_header_field_size (optional)
Integer The maximum size in bytes of the compressed request header field. The limit applies equally to both name and value. Allowed values are 1-8192. Field introduced in 21.1.1. Unit is BYTES. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32

HTTPLocalFile Up

content_type
String Mime-type of the content in the file. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
file_content
String File content to used in the local HTTP response body. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
file_length (optional)
Integer File content length. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32

HTTPRedirectAction Up

add_string (optional)
String Add a query string to the redirect URI. If keep_query is set, concatenates the add_string to the query of the incoming request. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
host (optional)
URIParam Host config. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
keep_query (optional)
Boolean Keep or drop the query of the incoming request URI in the redirected URI. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
path (optional)
URIParam Path config. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
port (optional)
Integer Port to which redirect the request. Allowed values are 1-65535. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
protocol
String Protocol type. Enum options - HTTP, HTTPS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTPReselectRespCode Up

codes (optional)
array[Integer] HTTP response code to be matched. Allowed values are 400-599. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ranges (optional)
array[HTTPStatusRange] HTTP response code ranges to match. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
resp_code_block (optional)
array[String] Block of HTTP response codes to match for server reselect. Enum options - HTTP_RSP_4XX, HTTP_RSP_5XX. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTPServerReselect Up

enabled
Boolean Enable HTTP request reselect when server responds with specific response codes. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
num_retries (optional)
Integer Number of times to retry an HTTP request when server responds with configured status codes. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
retry_nonidempotent (optional)
Boolean Allow retry of non-idempotent HTTP requests. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
svr_resp_code (optional)
HTTPReselectRespCode Server response codes which will trigger an HTTP request retry. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTPStatusRange Up

begin
Integer Starting HTTP response status code. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
end
Integer Ending HTTP response status code. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

HorizonProfile Up

blast_port (optional)
Integer Horizon blast port of the UAG server. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
pcoip_port (optional)
Integer Horizon pcoip port of the UAG server. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32

HttpCacheObjFilter Up

key (optional)
String HTTP cache object's exact key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
raw_key (optional)
String HTTP cache object's exact raw key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
resource_name (optional)
String HTTP cache object's resource name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
resource_type (optional)
String objects with resource type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type (optional)
String HTTP cache object type. Enum options - CO_ALL, CO_IN, CO_OUT. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IpAddr Up

addr
String IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IpAddrPrefix Up

ip_addr
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mask
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

KeyValue Up

key
String Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String Value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

NetworkFilter Up

network_ref
String It is a reference to an object of type VIMgrNWRuntime. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_filter (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

PersistenceFilter Up

persistence_cookie (optional)
String Persistence cookie. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
persistence_end_ip (optional)
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
persistence_ip (optional)
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
persistence_mask (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
server_end_ip (optional)
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_ip (optional)
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_mask (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
server_port (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

PlacementNetwork Up

network_ref
String It is a reference to an object of type Network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subnet
IpAddrPrefix Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Pool Up

_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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ab_pool (optional)
AbPool A/B pool configuration. Field deprecated in 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ab_priority (optional)
Integer Priority of this pool in a A-B pool pair. Internally used. Field deprecated in 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
analytics_policy (optional)
PoolAnalyticsPolicy Determines analytics settings for the pool. Field introduced in 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
apic_epg_name (optional)
String Synchronize Cisco APIC EPG members with pool servers. Field deprecated in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
append_port (optional)
String Allows the option to append port to hostname in the host header while sending a request to the server. By default, port is appended for non-default ports. This setting will apply for Pool's 'Rewrite Host Header to Server Name', 'Rewrite Host Header to SNI' features and Server's 'Rewrite Host Header' settings as well as HTTP healthmonitors attached to pools. Enum options - NON_DEFAULT_80_443, NEVER, ALWAYS. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- NEVER), Basic edition(Allowed values- NEVER), Enterprise with Cloud Services edition. Special default for Essentials edition is NEVER, Basic edition is NEVER, Enterprise is NON_DEFAULT_80_443.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
autoscale_networks (optional)
array[String] Network Ids for the launch configuration. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
autoscale_policy_ref (optional)
String Reference to Server Autoscale Policy. It is a reference to an object of type ServerAutoScalePolicy. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
capacity_estimation (optional)
Boolean Inline estimation of capacity of servers. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services 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 Enterprise edition with any value, Essentials edition(Allowed values- 0), Basic edition(Allowed values- 0), Enterprise with Cloud Services edition. format: int32
cloud_config_cksum (optional)
String Checksum of cloud configuration for Pool. Internally set by cloud connector. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cloud_ref (optional)
String It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
conn_pool_properties (optional)
ConnPoolProperties Connnection pool properties. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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 Enterprise edition with any value, Essentials edition(Allowed values- 0), Basic edition(Allowed values- 0), Enterprise with Cloud Services edition. Special default for Essentials edition is 0, Basic edition is 0, Enterprise is 10. format: int32
created_by (optional)
String Creator name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. 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 Enterprise edition with any value, Essentials edition(Allowed values- true), Basic edition(Allowed values- true), Enterprise with Cloud Services edition.
description (optional)
String A description of the pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
east_west (optional)
Boolean Inherited config from VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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 Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
enabled (optional)
Boolean Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
fewest_tasks_feedback_delay (optional)
Integer Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
gslb_sp_enabled (optional)
Boolean Indicates if the pool is a site-persistence pool. . Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
horizon_profile (optional)
HorizonProfile Horizon UAG configuration. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
http2_properties (optional)
HTTP2PoolProperties HTTP2 pool properties. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipaddrgroup_ref (optional)
String Use list of servers from Ip Address Group. It is a reference to an object of type IpAddrGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
lb_algo_rr_per_se (optional)
Boolean Do Round Robin load load balancing at SE level instead of the default per core load balancing. Field introduced in 21.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
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 Enterprise edition with any value, Essentials edition(Allowed values- LB_ALGORITHM_LEAST_CONNECTIONS,LB_ALGORITHM_ROUND_ROBIN,LB_ALGORITHM_CONSISTENT_HASH), Basic edition(Allowed values- LB_ALGORITHM_LEAST_CONNECTIONS,LB_ALGORITHM_ROUND_ROBIN,LB_ALGORITHM_CONSISTENT_HASH), Enterprise with Cloud Services edition.
lb_algorithm_consistent_hash_hdr (optional)
String HTTP header name to be used for the hash key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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 Enterprise edition with any value, Essentials edition(Allowed values- 2), Basic edition(Allowed values- 2), Enterprise with Cloud Services 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 Enterprise edition with any value, Essentials edition(Allowed values- LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS), Basic edition(Allowed values- LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS), Enterprise with Cloud Services edition.
lookup_server_by_name (optional)
Boolean Allow server lookup by name. Field introduced in 17.1.11,17.2.4. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_conn_rate_per_server (optional)
RateProfile Rate Limit connections to each server. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
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 Enterprise edition with any value, Enterprise with Cloud Services 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
name
String The name of the pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
nsx_securitygroup (optional)
array[String] A list of NSX Groups where the Servers for the Pool are created . Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prst_hdr_name (optional)
String Header name for custom header persistence. Field deprecated in 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
request_queue_depth (optional)
Integer Minimum number of requests to be queued when pool is full. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 128), Basic edition(Allowed values- 128), Enterprise with Cloud Services edition. format: int32
request_queue_enabled (optional)
Boolean Enable request queue when pool is full. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services 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. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
rewrite_host_header_to_sni (optional)
Boolean If SNI server name is specified, rewrite incoming host header to the SNI server name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_auto_scale (optional)
Boolean Server AutoScale. Not used anymore. Field deprecated in 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_count (optional)
Integer Field deprecated in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
server_disable_type (optional)
String Server graceful disable timeout behaviour. Enum options - DISALLOW_NEW_CONNECTION, ALLOW_NEW_CONNECTION_IF_PERSISTENCE_PRESENT. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_reselect (optional)
HTTPServerReselect Server reselect configuration for HTTP requests. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sni_enabled (optional)
Boolean Enable TLS SNI for server connections. If disabled, Avi will not send the SNI extension as part of the handshake. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tier1_lr (optional)
String This tier1_lr field should be set same as VirtualService associated for NSX-T. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
String url
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 Enterprise edition with any value, Essentials edition(Allowed values- false), Basic, Enterprise with Cloud Services edition.
use_service_ssl_mode (optional)
Boolean This applies only when use_service_port is set to true. If enabled, SSL mode of the connection to the server is decided by the SSL mode on the Virtualservice service port, on which the request was received. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
uuid (optional)
String UUID of the pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

PoolAnalyticsPolicy Up

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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

PoolApiResponse Up

count
Integer format: int32
results
array[Pool]
next (optional)
String

RateLimiter Up

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. Allowed in Enterprise edition with any value, Basic edition(Allowed values- 0), Essentials, Enterprise with Cloud Services edition. 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
name (optional)
String Identifier for Rate Limit. Constructed according to context. Field introduced in 18.2.9. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
period
Integer Time value in seconds to enforce rate count. Allowed values are 1-1000000000. Field introduced in 18.2.9. Unit is SEC. Allowed in Enterprise edition with any value, Basic edition(Allowed values- 1), Essentials, Enterprise with Cloud Services edition. format: int32

RateLimiterAction Up

file (optional)
HTTPLocalFile File to be used for HTTP Local response rate limit action. Allowed in Enterprise edition with any value, Essentials, Enterprise with Cloud Services edition.
redirect (optional)
HTTPRedirectAction Parameters for HTTP Redirect rate limit action. Allowed in Enterprise edition with any value, Essentials, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Basic edition(Allowed values- HTTP_LOCAL_RESPONSE_STATUS_CODE_429), Essentials, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Basic edition(Allowed values- RL_ACTION_NONE,RL_ACTION_DROP_CONN), Essentials, Enterprise with Cloud Services edition.

RateProfile Up

action
RateLimiterAction Action to perform upon rate limiting. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
explicit_tracking (optional)
Boolean Explicitly tracks an attacker across rate periods. Allowed in Enterprise edition with any value, Basic edition(Allowed values- false), Essentials, Enterprise with Cloud Services edition.
fine_grain (optional)
Boolean Enable fine granularity. Allowed in Enterprise edition with any value, Basic edition(Allowed values- false), Essentials, Enterprise with Cloud Services edition.
http_cookie (optional)
String HTTP cookie name. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Enterprise with Cloud Services edition.
http_header (optional)
String HTTP header name. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
rate_limiter (optional)
RateLimiter The rate limiter configuration for this rate profile. Field introduced in 18.2.9. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

RoleFilterMatchLabel Up

key
String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

Server Up

autoscaling_group_name (optional)
String Name of autoscaling group this server belongs to. Field introduced in 17.1.2. Allowed in Enterprise edition with any value, Basic, Enterprise with Cloud Services edition.
availability_zone (optional)
String Availability-zone of the server VM. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
description (optional)
String A description of the Server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
discovered_subnet (optional)
array[IpAddrPrefix] (internal-use) Discovered subnet for this server. This field is deprecated. Field deprecated in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enabled (optional)
Boolean Enable, Disable or Graceful Disable determine if new or existing connections to the server are allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
external_orchestration_id (optional)
String UID of server in external orchestration systems. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
external_uuid (optional)
String UUID identifying VM in OpenStack and other external compute. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hostname (optional)
String DNS resolvable name of the server. May be used in place of the IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip
IpAddr IP Address of the server. Required if there is no resolvable host name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
location (optional)
GeoLocation (internal-use) Geographic location of the server.Currently only for internal usage. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
mac_address (optional)
String MAC address of server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
prst_hdr_val (optional)
String Header value for custom header persistence. . Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ratio (optional)
Integer Ratio of selecting eligible servers in the pool. Allowed values are 1-20. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
resolve_server_by_dns (optional)
Boolean Auto resolve server's IP using DNS name. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
rewrite_host_header (optional)
Boolean Rewrite incoming Host Header to server name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_node (optional)
String Hostname of the node where the server VM or container resides. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
static (optional)
Boolean If statically learned. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ServerId Up

external_uuid (optional)
String This is the external cloud uuid of the Pool server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
port
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

ServerScaleInParams Up

reason (optional)
String Reason for the manual scale-in. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
servers (optional)
array[ServerId] List of server IDs that should be scaled in. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ServerScaleOutParams Up

reason (optional)
String Reason for the manual scale-out. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

URIParam Up

tokens (optional)
array[URIParamToken] Token config either for the URI components or a constant string. Minimum of 1 items required. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String URI param type. Enum options - URI_PARAM_TYPE_TOKENIZED. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

URIParamToken Up

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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
start_index (optional)
Integer Index of the starting token in the incoming URI. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
str_value (optional)
String Constant string to use as a token. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.