Avi PoolGroup Object API

##CLI## ``` - configure poolgroup - show poolgroup ```
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 /poolgroup
  2. post /poolgroup
  3. delete /poolgroup/{uuid}
  4. get /poolgroup/{uuid}
  5. patch /poolgroup/{uuid}
  6. put /poolgroup/{uuid}
Up
get /poolgroup
(poolgroupGet)

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

PoolGroupApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "deployment_policy_ref" : "aeiou",
    "priority_labels_ref" : "aeiou",
    "description" : "aeiou",
    "created_by" : "aeiou",
    "implicit_priority_labels" : true,
    "uuid" : "aeiou",
    "url" : "aeiou",
    "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"
    },
    "cloud_ref" : "aeiou",
    "members" : [ {
      "pool_ref" : "aeiou",
      "priority_label" : "aeiou",
      "deployment_state" : "aeiou",
      "ratio" : 123
    } ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "min_servers" : 123,
    "cloud_config_cksum" : "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 PoolGroupApiResponse

401

log in failed

Up
post /poolgroup
(poolgroupPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — PoolGroup object creation

Return type

PoolGroup

Example data

Content-Type: application/json
{
  "deployment_policy_ref" : "aeiou",
  "priority_labels_ref" : "aeiou",
  "description" : "aeiou",
  "created_by" : "aeiou",
  "implicit_priority_labels" : true,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "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"
  },
  "cloud_ref" : "aeiou",
  "members" : [ {
    "pool_ref" : "aeiou",
    "priority_label" : "aeiou",
    "deployment_state" : "aeiou",
    "ratio" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "min_servers" : 123,
  "cloud_config_cksum" : "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 PoolGroup

401

log in failed

Up
delete /poolgroup/{uuid}
(poolgroupUuidDelete)

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 /poolgroup/{uuid}
(poolgroupUuidGet)

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

PoolGroup

Example data

Content-Type: application/json
{
  "deployment_policy_ref" : "aeiou",
  "priority_labels_ref" : "aeiou",
  "description" : "aeiou",
  "created_by" : "aeiou",
  "implicit_priority_labels" : true,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "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"
  },
  "cloud_ref" : "aeiou",
  "members" : [ {
    "pool_ref" : "aeiou",
    "priority_label" : "aeiou",
    "deployment_state" : "aeiou",
    "ratio" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "min_servers" : 123,
  "cloud_config_cksum" : "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 PoolGroup

401

log in failed

Up
patch /poolgroup/{uuid}
(poolgroupUuidPatch)

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 — PoolGroup object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

PoolGroup

Example data

Content-Type: application/json
{
  "deployment_policy_ref" : "aeiou",
  "priority_labels_ref" : "aeiou",
  "description" : "aeiou",
  "created_by" : "aeiou",
  "implicit_priority_labels" : true,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "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"
  },
  "cloud_ref" : "aeiou",
  "members" : [ {
    "pool_ref" : "aeiou",
    "priority_label" : "aeiou",
    "deployment_state" : "aeiou",
    "ratio" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "min_servers" : 123,
  "cloud_config_cksum" : "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 PoolGroup

401

log in failed

Up
put /poolgroup/{uuid}
(poolgroupUuidPut)

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 — PoolGroup object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

PoolGroup

Example data

Content-Type: application/json
{
  "deployment_policy_ref" : "aeiou",
  "priority_labels_ref" : "aeiou",
  "description" : "aeiou",
  "created_by" : "aeiou",
  "implicit_priority_labels" : true,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "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"
  },
  "cloud_ref" : "aeiou",
  "members" : [ {
    "pool_ref" : "aeiou",
    "priority_label" : "aeiou",
    "deployment_state" : "aeiou",
    "ratio" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "min_servers" : 123,
  "cloud_config_cksum" : "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 PoolGroup

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. FailAction
  2. FailActionBackupPool
  3. FailActionHTTPLocalResponse
  4. FailActionHTTPRedirect
  5. HTTPLocalFile
  6. PoolGroup
  7. PoolGroupApiResponse
  8. PoolGroupMember

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.

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.

PoolGroup Up

cloud_config_cksum (optional)
String Checksum of cloud configuration for PoolGroup. Internally set by cloud connector.
cloud_ref (optional)
String It is a reference to an object of type Cloud.
created_by (optional)
String Name of the user who created the object.
deployment_policy_ref (optional)
String When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type PoolGroupDeploymentPolicy.
description (optional)
String Description of Pool Group.
fail_action (optional)
FailAction Enable an action - Close Connection, HTTP Redirect, or Local HTTP Response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure.
implicit_priority_labels (optional)
Boolean Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3.
members (optional)
array[PoolGroupMember] List of pool group members object of type PoolGroupMember.
min_servers (optional)
Integer The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - 'Disable'. format: int32
name
String The name of the pool group.
priority_labels_ref (optional)
String UUID of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type PriorityLabels.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String UUID of the pool group.

PoolGroupApiResponse Up

count
Integer format: int32
results

PoolGroupMember Up

deployment_state (optional)
String Pool deployment state used with the PG deployment policy. Enum options - EVALUATION_IN_PROGRESS, IN_SERVICE, OUT_OF_SERVICE, EVALUATION_FAILED.
pool_ref
String UUID of the pool. It is a reference to an object of type Pool.
priority_label (optional)
String All pools with same label are treated similarly in a pool group. A pool with a higher priority is selected, as long as the pool is eligible or an explicit policy chooses a different pool.
ratio (optional)
Integer Ratio of selecting eligible pools in the pool group. . Allowed values are 1-1000. Special values are 0 - 'Do not select this pool for new connections'. format: int32