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 {u'lb_algorithm': u'LB_ALGORITHM_LEAST_CONNECTIONS', u'default_server_port': 80, u'name': u'production_pool', u'servers': [{u'ip': {u'type': u'V4', u'addr': u'10.10.90.120'}}, {u'ip': {u'type': u'V4', u'addr': u'10.10.90.121'}}]} ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
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. get /pool
  2. post /pool
  3. get /pool/{uuid}/algo/
  4. post /pool/{uuid}/clear
  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. patch /pool/{uuid}
  14. get /pool/{uuid}/persistence/
  15. put /pool/{uuid}
  16. get /pool/{uuid}/runtime/debug/
  17. get /pool/{uuid}/runtime/detail/
  18. get /pool/{uuid}/runtime/
  19. get /pool/{uuid}/runtime/internal/
  20. post /pool/{uuid}/runtime/request_queue/clear
  21. get /pool/{uuid}/runtime/server/detail/
  22. get /pool/{uuid}/runtime/server/
  23. get /pool/{uuid}/runtime/server/hmonstat/
  24. get /pool/{uuid}/runtime/server/internal/
  25. post /pool/{uuid}/runtime/stats/clear
  26. post /pool/{uuid}/scalein
  27. post /pool/{uuid}/scaleout
  28. get /pool/{uuid}/vs/
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.
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
{
  "count" : 123,
  "results" : [ {
    "ipaddrgroup_ref" : "aeiou",
    "inline_health_monitor" : true,
    "default_server_port" : 123,
    "lookup_server_by_name" : true,
    "fewest_tasks_feedback_delay" : 123,
    "sni_enabled" : true,
    "vrf_ref" : "aeiou",
    "uuid" : "aeiou",
    "domain_name" : [ "aeiou" ],
    "east_west" : true,
    "rewrite_host_header_to_server_name" : true,
    "ssl_key_and_certificate_ref" : "aeiou",
    "cloud_ref" : "aeiou",
    "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",
    "prst_hdr_name" : "aeiou",
    "placement_networks" : [ {
      "subnet" : {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      },
      "network_ref" : "aeiou"
    } ],
    "autoscale_networks" : [ "aeiou" ],
    "created_by" : "aeiou",
    "external_autoscale_groups" : [ "aeiou" ],
    "ab_priority" : 123,
    "capacity_estimation" : 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,
    "a_pool" : "aeiou",
    "server_reselect" : {
      "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" : [ "" ],
        "network_ref" : "aeiou"
      } ],
      "discovered_network_ref" : [ "aeiou" ],
      "ratio" : 123
    } ],
    "fail_action" : {
      "redirect" : {
        "path" : "aeiou",
        "protocol" : "aeiou",
        "status_code" : "aeiou",
        "query" : "aeiou",
        "host" : "aeiou"
      },
      "local_rsp" : {
        "file" : {
          "file_content" : "aeiou",
          "content_type" : "aeiou"
        },
        "status_code" : "aeiou"
      },
      "backup_pool" : {
        "backup_pool_ref" : "aeiou"
      },
      "type" : "aeiou"
    },
    "max_conn_rate_per_server" : {
      "period" : 123,
      "count" : 123,
      "action" : {
        "redirect" : {
          "keep_query" : true,
          "path" : "",
          "protocol" : "aeiou",
          "status_code" : "aeiou",
          "port" : 123,
          "host" : {
            "tokens" : [ {
              "start_index" : 123,
              "str_value" : "aeiou",
              "end_index" : 123,
              "type" : "aeiou"
            } ],
            "type" : "aeiou"
          }
        },
        "file" : "",
        "status_code" : "aeiou",
        "type" : "aeiou"
      },
      "burst_sz" : 123,
      "explicit_tracking" : true,
      "fine_grain" : true,
      "http_cookie" : "aeiou",
      "http_header" : "aeiou"
    },
    "max_concurrent_connections_per_server" : 123,
    "capacity_estimation_ttfb_thresh" : 123,
    "lb_algorithm_hash" : "aeiou",
    "request_queue_enabled" : true,
    "host_check_enabled" : true,
    "url" : "aeiou",
    "nsx_securitygroup" : [ "aeiou" ],
    "pki_profile_ref" : "aeiou",
    "connection_ramp_duration" : 123,
    "tenant_ref" : "aeiou",
    "server_count" : 123,
    "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",
  "inline_health_monitor" : true,
  "default_server_port" : 123,
  "lookup_server_by_name" : true,
  "fewest_tasks_feedback_delay" : 123,
  "sni_enabled" : true,
  "vrf_ref" : "aeiou",
  "uuid" : "aeiou",
  "domain_name" : [ "aeiou" ],
  "east_west" : true,
  "rewrite_host_header_to_server_name" : true,
  "ssl_key_and_certificate_ref" : "aeiou",
  "cloud_ref" : "aeiou",
  "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",
  "prst_hdr_name" : "aeiou",
  "placement_networks" : [ {
    "subnet" : {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    },
    "network_ref" : "aeiou"
  } ],
  "autoscale_networks" : [ "aeiou" ],
  "created_by" : "aeiou",
  "external_autoscale_groups" : [ "aeiou" ],
  "ab_priority" : 123,
  "capacity_estimation" : 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,
  "a_pool" : "aeiou",
  "server_reselect" : {
    "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" : [ "" ],
      "network_ref" : "aeiou"
    } ],
    "discovered_network_ref" : [ "aeiou" ],
    "ratio" : 123
  } ],
  "fail_action" : {
    "redirect" : {
      "path" : "aeiou",
      "protocol" : "aeiou",
      "status_code" : "aeiou",
      "query" : "aeiou",
      "host" : "aeiou"
    },
    "local_rsp" : {
      "file" : {
        "file_content" : "aeiou",
        "content_type" : "aeiou"
      },
      "status_code" : "aeiou"
    },
    "backup_pool" : {
      "backup_pool_ref" : "aeiou"
    },
    "type" : "aeiou"
  },
  "max_conn_rate_per_server" : {
    "period" : 123,
    "count" : 123,
    "action" : {
      "redirect" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "status_code" : "aeiou",
        "port" : 123,
        "host" : {
          "tokens" : [ {
            "start_index" : 123,
            "str_value" : "aeiou",
            "end_index" : 123,
            "type" : "aeiou"
          } ],
          "type" : "aeiou"
        }
      },
      "file" : "",
      "status_code" : "aeiou",
      "type" : "aeiou"
    },
    "burst_sz" : 123,
    "explicit_tracking" : true,
    "fine_grain" : true,
    "http_cookie" : "aeiou",
    "http_header" : "aeiou"
  },
  "max_concurrent_connections_per_server" : 123,
  "capacity_estimation_ttfb_thresh" : 123,
  "lb_algorithm_hash" : "aeiou",
  "request_queue_enabled" : true,
  "host_check_enabled" : true,
  "url" : "aeiou",
  "nsx_securitygroup" : [ "aeiou" ],
  "pki_profile_ref" : "aeiou",
  "connection_ramp_duration" : 123,
  "tenant_ref" : "aeiou",
  "server_count" : 123,
  "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
post /pool/{uuid}/clear
( poolUuidClearPost)

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}/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.
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",
  "inline_health_monitor" : true,
  "default_server_port" : 123,
  "lookup_server_by_name" : true,
  "fewest_tasks_feedback_delay" : 123,
  "sni_enabled" : true,
  "vrf_ref" : "aeiou",
  "uuid" : "aeiou",
  "domain_name" : [ "aeiou" ],
  "east_west" : true,
  "rewrite_host_header_to_server_name" : true,
  "ssl_key_and_certificate_ref" : "aeiou",
  "cloud_ref" : "aeiou",
  "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",
  "prst_hdr_name" : "aeiou",
  "placement_networks" : [ {
    "subnet" : {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    },
    "network_ref" : "aeiou"
  } ],
  "autoscale_networks" : [ "aeiou" ],
  "created_by" : "aeiou",
  "external_autoscale_groups" : [ "aeiou" ],
  "ab_priority" : 123,
  "capacity_estimation" : 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,
  "a_pool" : "aeiou",
  "server_reselect" : {
    "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" : [ "" ],
      "network_ref" : "aeiou"
    } ],
    "discovered_network_ref" : [ "aeiou" ],
    "ratio" : 123
  } ],
  "fail_action" : {
    "redirect" : {
      "path" : "aeiou",
      "protocol" : "aeiou",
      "status_code" : "aeiou",
      "query" : "aeiou",
      "host" : "aeiou"
    },
    "local_rsp" : {
      "file" : {
        "file_content" : "aeiou",
        "content_type" : "aeiou"
      },
      "status_code" : "aeiou"
    },
    "backup_pool" : {
      "backup_pool_ref" : "aeiou"
    },
    "type" : "aeiou"
  },
  "max_conn_rate_per_server" : {
    "period" : 123,
    "count" : 123,
    "action" : {
      "redirect" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "status_code" : "aeiou",
        "port" : 123,
        "host" : {
          "tokens" : [ {
            "start_index" : 123,
            "str_value" : "aeiou",
            "end_index" : 123,
            "type" : "aeiou"
          } ],
          "type" : "aeiou"
        }
      },
      "file" : "",
      "status_code" : "aeiou",
      "type" : "aeiou"
    },
    "burst_sz" : 123,
    "explicit_tracking" : true,
    "fine_grain" : true,
    "http_cookie" : "aeiou",
    "http_header" : "aeiou"
  },
  "max_concurrent_connections_per_server" : 123,
  "capacity_estimation_ttfb_thresh" : 123,
  "lb_algorithm_hash" : "aeiou",
  "request_queue_enabled" : true,
  "host_check_enabled" : true,
  "url" : "aeiou",
  "nsx_securitygroup" : [ "aeiou" ],
  "pki_profile_ref" : "aeiou",
  "connection_ramp_duration" : 123,
  "tenant_ref" : "aeiou",
  "server_count" : 123,
  "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
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",
  "inline_health_monitor" : true,
  "default_server_port" : 123,
  "lookup_server_by_name" : true,
  "fewest_tasks_feedback_delay" : 123,
  "sni_enabled" : true,
  "vrf_ref" : "aeiou",
  "uuid" : "aeiou",
  "domain_name" : [ "aeiou" ],
  "east_west" : true,
  "rewrite_host_header_to_server_name" : true,
  "ssl_key_and_certificate_ref" : "aeiou",
  "cloud_ref" : "aeiou",
  "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",
  "prst_hdr_name" : "aeiou",
  "placement_networks" : [ {
    "subnet" : {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    },
    "network_ref" : "aeiou"
  } ],
  "autoscale_networks" : [ "aeiou" ],
  "created_by" : "aeiou",
  "external_autoscale_groups" : [ "aeiou" ],
  "ab_priority" : 123,
  "capacity_estimation" : 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,
  "a_pool" : "aeiou",
  "server_reselect" : {
    "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" : [ "" ],
      "network_ref" : "aeiou"
    } ],
    "discovered_network_ref" : [ "aeiou" ],
    "ratio" : 123
  } ],
  "fail_action" : {
    "redirect" : {
      "path" : "aeiou",
      "protocol" : "aeiou",
      "status_code" : "aeiou",
      "query" : "aeiou",
      "host" : "aeiou"
    },
    "local_rsp" : {
      "file" : {
        "file_content" : "aeiou",
        "content_type" : "aeiou"
      },
      "status_code" : "aeiou"
    },
    "backup_pool" : {
      "backup_pool_ref" : "aeiou"
    },
    "type" : "aeiou"
  },
  "max_conn_rate_per_server" : {
    "period" : 123,
    "count" : 123,
    "action" : {
      "redirect" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "status_code" : "aeiou",
        "port" : 123,
        "host" : {
          "tokens" : [ {
            "start_index" : 123,
            "str_value" : "aeiou",
            "end_index" : 123,
            "type" : "aeiou"
          } ],
          "type" : "aeiou"
        }
      },
      "file" : "",
      "status_code" : "aeiou",
      "type" : "aeiou"
    },
    "burst_sz" : 123,
    "explicit_tracking" : true,
    "fine_grain" : true,
    "http_cookie" : "aeiou",
    "http_header" : "aeiou"
  },
  "max_concurrent_connections_per_server" : 123,
  "capacity_estimation_ttfb_thresh" : 123,
  "lb_algorithm_hash" : "aeiou",
  "request_queue_enabled" : true,
  "host_check_enabled" : true,
  "url" : "aeiou",
  "nsx_securitygroup" : [ "aeiou" ],
  "pki_profile_ref" : "aeiou",
  "connection_ramp_duration" : 123,
  "tenant_ref" : "aeiou",
  "server_count" : 123,
  "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",
  "inline_health_monitor" : true,
  "default_server_port" : 123,
  "lookup_server_by_name" : true,
  "fewest_tasks_feedback_delay" : 123,
  "sni_enabled" : true,
  "vrf_ref" : "aeiou",
  "uuid" : "aeiou",
  "domain_name" : [ "aeiou" ],
  "east_west" : true,
  "rewrite_host_header_to_server_name" : true,
  "ssl_key_and_certificate_ref" : "aeiou",
  "cloud_ref" : "aeiou",
  "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",
  "prst_hdr_name" : "aeiou",
  "placement_networks" : [ {
    "subnet" : {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    },
    "network_ref" : "aeiou"
  } ],
  "autoscale_networks" : [ "aeiou" ],
  "created_by" : "aeiou",
  "external_autoscale_groups" : [ "aeiou" ],
  "ab_priority" : 123,
  "capacity_estimation" : 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,
  "a_pool" : "aeiou",
  "server_reselect" : {
    "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" : [ "" ],
      "network_ref" : "aeiou"
    } ],
    "discovered_network_ref" : [ "aeiou" ],
    "ratio" : 123
  } ],
  "fail_action" : {
    "redirect" : {
      "path" : "aeiou",
      "protocol" : "aeiou",
      "status_code" : "aeiou",
      "query" : "aeiou",
      "host" : "aeiou"
    },
    "local_rsp" : {
      "file" : {
        "file_content" : "aeiou",
        "content_type" : "aeiou"
      },
      "status_code" : "aeiou"
    },
    "backup_pool" : {
      "backup_pool_ref" : "aeiou"
    },
    "type" : "aeiou"
  },
  "max_conn_rate_per_server" : {
    "period" : 123,
    "count" : 123,
    "action" : {
      "redirect" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "status_code" : "aeiou",
        "port" : 123,
        "host" : {
          "tokens" : [ {
            "start_index" : 123,
            "str_value" : "aeiou",
            "end_index" : 123,
            "type" : "aeiou"
          } ],
          "type" : "aeiou"
        }
      },
      "file" : "",
      "status_code" : "aeiou",
      "type" : "aeiou"
    },
    "burst_sz" : 123,
    "explicit_tracking" : true,
    "fine_grain" : true,
    "http_cookie" : "aeiou",
    "http_header" : "aeiou"
  },
  "max_concurrent_connections_per_server" : 123,
  "capacity_estimation_ttfb_thresh" : 123,
  "lb_algorithm_hash" : "aeiou",
  "request_queue_enabled" : true,
  "host_check_enabled" : true,
  "url" : "aeiou",
  "nsx_securitygroup" : [ "aeiou" ],
  "pki_profile_ref" : "aeiou",
  "connection_ramp_duration" : 123,
  "tenant_ref" : "aeiou",
  "server_count" : 123,
  "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
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. ConnpoolFilter
  3. DiscoveredNetwork
  4. FailAction
  5. FailActionBackupPool
  6. FailActionHTTPLocalResponse
  7. FailActionHTTPRedirect
  8. GeoLocation
  9. HTTPLocalFile
  10. HTTPRedirectAction
  11. HTTPReselectRespCode
  12. HTTPServerReselect
  13. HTTPStatusRange
  14. HttpCacheObjFilter
  15. IpAddr
  16. IpAddrPrefix
  17. NetworkFilter
  18. PersistenceFilter
  19. PlacementNetwork
  20. Pool
  21. PoolApiResponse
  22. RateLimiterAction
  23. RateProfile
  24. Server
  25. ServerId
  26. ServerScaleInParams
  27. ServerScaleOutParams
  28. URIParam
  29. 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.
ratio (optional)
Integer Ratio of traffic diverted to the B pool, for A/B testing. Allowed values are 0-100. format: int32

ConnpoolFilter Up

ip_addr (optional)
String Backend or SE IP address.
ip_mask (optional)
String Backend or SE IP address mask.
port (optional)
Integer Backend or SE port. format: int32
type (optional)
String cache type. Enum options - CP_ALL, CP_FREE, CP_BIND, CP_CACHED.

DiscoveredNetwork Up

network_ref
String Discovered network for this IP. It is a reference to an object of type Network.
subnet (optional)
array[IpAddrPrefix] Discovered subnet for this IP.

FailAction Up

backup_pool (optional)
FailActionBackupPool Backup Pool when pool experiences a failure.
local_rsp (optional)
FailActionHTTPLocalResponse Local response to HTTP requests when pool experiences a failure.
redirect (optional)
FailActionHTTPRedirect URL to redirect HTTP requests to when pool experiences a failure.
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.

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.

FailActionHTTPLocalResponse Up

file (optional)
HTTPLocalFile Placeholder for description of property file of obj type FailActionHTTPLocalResponse field type str type object
status_code (optional)
String Enum options - FAIL_HTTP_STATUS_CODE_200, FAIL_HTTP_STATUS_CODE_503.

FailActionHTTPRedirect Up

host
String host of FailActionHTTPRedirect.
path (optional)
String path of FailActionHTTPRedirect.
protocol (optional)
String Enum options - HTTP, HTTPS.
query (optional)
String query of FailActionHTTPRedirect.
status_code (optional)
String Enum options - HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307.

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. format: float
longitude (optional)
Float Longitude of the location. This is represented as degrees.minutes. The range is from -180.0 (west) to +180.0 (east). Allowed values are -180.0-+180.0. Field introduced in 17.1.1. format: float
name (optional)
String Location name in the format Country/State/City. Field introduced in 17.1.1.
tag (optional)
String Location tag string - example USEast. Field introduced in 17.1.1.

HTTPLocalFile Up

content_type
String Mime-type of the content in the file.
file_content
String File content to used in the local HTTP response body.

HTTPRedirectAction Up

host (optional)
URIParam Host config.
keep_query (optional)
Boolean Keep or drop the query of the incoming request URI in the redirected URI.
path (optional)
URIParam Path config.
port (optional)
Integer Port to which redirect the request. Allowed values are 1-65535. format: int32
protocol
String Protocol type. Enum options - HTTP, HTTPS.
status_code (optional)
String HTTP redirect status code. Enum options - HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307.

HTTPReselectRespCode Up

codes (optional)
array[Integer] HTTP response code to be matched. Allowed values are 400-599.
ranges (optional)
array[HTTPStatusRange] HTTP response code ranges to match.
resp_code_block (optional)
array[String] Block of HTTP response codes to match for server reselect. Enum options - HTTP_RSP_4XX, HTTP_RSP_5XX.

HTTPServerReselect Up

enabled
Boolean Enable HTTP request reselect when server responds with specific response codes.
num_retries (optional)
Integer Number of times to retry an HTTP request when server responds with configured status codes. format: int32
retry_nonidempotent (optional)
Boolean Allow retry of non-idempotent HTTP requests.
svr_resp_code (optional)
HTTPReselectRespCode Server response codes which will trigger an HTTP request retry.

HTTPStatusRange Up

begin
Integer Starting HTTP response status code. format: int32
end
Integer Ending HTTP response status code. format: int32

HttpCacheObjFilter Up

key (optional)
String HTTP cache object's exact key.
raw_key (optional)
String HTTP cache object's exact raw key.
resource_name (optional)
String HTTP cache object's resource name.
resource_type (optional)
String objects with resource type.
type (optional)
String HTTP cache object type. Enum options - CO_ALL, CO_IN, CO_OUT.

IpAddr Up

addr
String IP address.
type
String Enum options - V4, DNS.

IpAddrPrefix Up

ip_addr
IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object
mask
Integer Number of mask. format: int32

NetworkFilter Up

network_ref
String It is a reference to an object of type VIMgrNWRuntime.
server_filter (optional)
String server_filter of NetworkFilter.

PersistenceFilter Up

persistence_cookie (optional)
String Persistence cookie.
persistence_end_ip (optional)
IpAddr Placeholder for description of property persistence_end_ip of obj type PersistenceFilter field type str type object
persistence_ip (optional)
IpAddr Placeholder for description of property persistence_ip of obj type PersistenceFilter field type str type object
persistence_mask (optional)
Integer Number of persistence_mask. format: int32
server_end_ip (optional)
IpAddr Placeholder for description of property server_end_ip of obj type PersistenceFilter field type str type object
server_ip (optional)
IpAddr Placeholder for description of property server_ip of obj type PersistenceFilter field type str type object
server_mask (optional)
Integer Number of server_mask. format: int32
server_port (optional)
Integer Number of server_port. format: int32

PlacementNetwork Up

network_ref
String It is a reference to an object of type Network.
subnet (optional)
IpAddrPrefix Placeholder for description of property subnet of obj type PlacementNetwork field type str type object

Pool Up

a_pool (optional)
String Name of container cloud application that constitutes A pool in a A-B pool configuration, if different from VS app.
ab_pool (optional)
AbPool A/B pool configuration.
ab_priority (optional)
Integer Priority of this pool in a A-B pool pair. Internally used. format: int32
apic_epg_name (optional)
String Synchronize Cisco APIC EPG members with pool servers.
application_persistence_profile_ref (optional)
String Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type ApplicationPersistenceProfile.
autoscale_launch_config_ref (optional)
String If configured then Avi will trigger orchestration of pool server creation and deletion. It is only supported for container clouds like Mesos, Opensift, Kubernates, Docker etc. It is a reference to an object of type AutoScaleLaunchConfig.
autoscale_networks (optional)
array[String] Network Ids for the launch configuration.
autoscale_policy_ref (optional)
String Reference to Server Autoscale Policy. It is a reference to an object of type ServerAutoScalePolicy.
capacity_estimation (optional)
Boolean Inline estimation of capacity of servers.
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'. format: int32
cloud_config_cksum (optional)
String Checksum of cloud configuration for Pool. Internally set by cloud connector.
cloud_ref (optional)
String It is a reference to an object of type Cloud.
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'. format: int32
created_by (optional)
String Creator name.
default_server_port (optional)
Integer Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The SSL checkbox enables Avi to server encryption. Allowed values are 1-65535. format: int32
description (optional)
String A description of the pool.
domain_name (optional)
array[String] Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled.
east_west (optional)
Boolean Inherited config from VirtualService.
enabled (optional)
Boolean Enable or disable the pool. Disabling will terminate all open connections and pause health monitors.
external_autoscale_groups (optional)
array[String] Names of external auto-scale groups for pool servers. Currently available only for AWS. Field introduced in 17.1.2.
fail_action (optional)
FailAction Enable an action - Close Connection, HTTP Redirect or Local HTTP Response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure.
fewest_tasks_feedback_delay (optional)
Integer Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. 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'. format: int32
gslb_sp_enabled (optional)
Boolean Indicates if the pool is a site-persistence pool. . Field introduced in 17.2.1.
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.
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.
inline_health_monitor (optional)
Boolean The Passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the LB method, such as Round Robin.
ipaddrgroup_ref (optional)
String Use list of servers from Ip Address Group. It is a reference to an object of type IpAddrGroup.
lb_algorithm (optional)
String The load balancing algorithm will pick a server within the pool's list of available servers. 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_consistent_hash_hdr (optional)
String HTTP header name to be used for the hash key.
lb_algorithm_core_nonaffinity (optional)
Integer Degree of non-affinity for core afffinity based server selection. Allowed values are 1-65535. Field introduced in 17.1.3. 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.
lookup_server_by_name (optional)
Boolean Allow server lookup by name. Field introduced in 17.1.11,17.2.4.
max_concurrent_connections_per_server (optional)
Integer The maximum number of concurrent connections allowed to each server within the pool. NOTE applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. format: int32
max_conn_rate_per_server (optional)
RateProfile Rate Limit connections to each server.
name
String The name of the pool.
networks (optional)
array[NetworkFilter] (internal-use) Networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by Avi, not editable by the user.
nsx_securitygroup (optional)
array[String] A list of NSX Service Groups where the Servers for the Pool are created . Field introduced in 17.1.1.
pki_profile_ref (optional)
String Avi will validate the SSL certificate present by a server against the selected PKI Profile. It is a reference to an object of type PKIProfile.
placement_networks (optional)
array[PlacementNetwork] Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the Subnet using the following syntax 10-1-1-0/24. Use static routes in VRF configuration when pool servers are not directly connected butroutable from the service engine.
prst_hdr_name (optional)
String Header name for custom header persistence.
request_queue_depth (optional)
Integer Minimum number of requests to be queued when pool is full. format: int32
request_queue_enabled (optional)
Boolean Enable request queue when pool is full.
rewrite_host_header_to_server_name (optional)
Boolean Rewrite incoming Host Header to server name of the server to which the request is proxied. Enabling this feature rewrites Host Header for requests to all servers in the pool.
rewrite_host_header_to_sni (optional)
Boolean If SNI server name is specified, rewrite incoming host header to the SNI server name.
server_auto_scale (optional)
Boolean Server AutoScale. Not used anymore.
server_count (optional)
Integer Number of server_count. format: int32
server_name (optional)
String Fully qualified DNS hostname which will be used in the TLS SNI extension in server connections if SNI is enabled. If no value is specified, Avi will use the incoming host header instead.
server_reselect (optional)
HTTPServerReselect Server reselect configuration for HTTP requests.
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.
sni_enabled (optional)
Boolean Enable TLS SNI for server connections. If disabled, Avi will not send the SNI extension as part of the handshake.
ssl_key_and_certificate_ref (optional)
String Service Engines will present a client SSL certificate to the server. It is a reference to an object of type SSLKeyAndCertificate.
ssl_profile_ref (optional)
String When enabled, Avi re-encrypts traffic to the backend servers. The specific SSL profile defines which ciphers and SSL versions will be supported. It is a reference to an object of type SSLProfile.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
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.
uuid (optional)
String UUID of the pool.
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.

PoolApiResponse Up

count
Integer format: int32
results

RateLimiterAction Up

file (optional)
HTTPLocalFile File to be used for HTTP Local response rate limit action.
redirect (optional)
HTTPRedirectAction Parameters for HTTP Redirect rate limit action.
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_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429.
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.

RateProfile Up

action (optional)
RateLimiterAction Action to perform upon rate limiting.
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'. format: int32
count (optional)
Integer Maximum number of connections or requests or packets. Allowed values are 10-2500. Special values are 0- 'unlimited'. format: int32
explicit_tracking (optional)
Boolean Explicitly tracks an attacker across rate periods.
fine_grain (optional)
Boolean Enable fine granularity.
http_cookie (optional)
String HTTP cookie name. Field introduced in 17.1.1.
http_header (optional)
String HTTP header name. Field introduced in 17.1.1.
period (optional)
Integer Time value in seconds to enforce rate count. Allowed values are 1-300. format: int32

Server Up

autoscaling_group_name (optional)
String Name of autoscaling group this server belongs to. Field introduced in 17.1.2.
availability_zone (optional)
String Availability-zone of the server VM.
description (optional)
String A description of the Server.
discovered_network_ref (optional)
array[String] (internal-use) Discovered network for this server. This field is deprecated. It is a reference to an object of type Network. Field deprecated in 17.1.1.
discovered_networks (optional)
array[DiscoveredNetwork] (internal-use) Discovered networks providing reachability for server IP. This field is used internally by Avi, not editable by the user.
discovered_subnet (optional)
array[IpAddrPrefix] (internal-use) Discovered subnet for this server. This field is deprecated. Field deprecated in 17.1.1.
enabled (optional)
Boolean Enable, Disable or Graceful Disable determine if new or existing connections to the server are allowed.
external_orchestration_id (optional)
String UID of server in external orchestration systems.
external_uuid (optional)
String UUID identifying VM in OpenStack and other external compute.
hostname (optional)
String DNS resolvable name of the server. May be used in place of the IP address.
ip
IpAddr IP Address of the server. Required if there is no resolvable host name.
location (optional)
GeoLocation (internal-use) Geographic location of the server.Currently only for internal usage. Field introduced in 17.1.1.
mac_address (optional)
String MAC address of server.
nw_ref (optional)
String (internal-use) This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrNWRuntime.
port (optional)
Integer Optionally specify the servers port number. This will override the pool's default server port attribute. Allowed values are 1-65535. Special values are 0- 'use backend port in pool'. format: int32
prst_hdr_val (optional)
String Header value for custom header persistence. .
ratio (optional)
Integer Ratio of selecting eligible servers in the pool. Allowed values are 1-20. format: int32
resolve_server_by_dns (optional)
Boolean Auto resolve server's IP using DNS name.
rewrite_host_header (optional)
Boolean Rewrite incoming Host Header to server name.
server_node (optional)
String Hostname of the node where the server VM or container resides.
static (optional)
Boolean If statically learned.
verify_network (optional)
Boolean Verify server belongs to a discovered network or reachable via a discovered network. Verify reachable network isn't the OpenStack management network.
vm_ref (optional)
String (internal-use) This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrVMRuntime.

ServerId Up

external_uuid (optional)
String This is the external cloud uuid of the Pool server.
ip
IpAddr Placeholder for description of property ip of obj type ServerId field type str type object
port
Integer Number of port. format: int32

ServerScaleInParams Up

reason (optional)
String Reason for the manual scalein.
servers (optional)
array[ServerId] List of server IDs that should be scaled in.
uuid (optional)
String Unique object identifier of the object.

ServerScaleOutParams Up

reason (optional)
String Reason for the manual scaleout.
uuid (optional)
String Unique object identifier of the object.

URIParam Up

tokens (optional)
array[URIParamToken] Token config either for the URI components or a constant string.
type
String URI param type. Enum options - URI_PARAM_TYPE_TOKENIZED.

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'. format: int32
start_index (optional)
Integer Index of the starting token in the incoming URI. format: int32
str_value (optional)
String Constant string to use as a token.
type
String Token type for constructing the URI. Enum options - URI_TOKEN_TYPE_HOST, URI_TOKEN_TYPE_PATH, URI_TOKEN_TYPE_STRING, URI_TOKEN_TYPE_STRING_GROUP, URI_TOKEN_TYPE_REGEX.