Avi PoolGroup Object API
CLI ``` - configure poolgroup - show poolgroup - clear poolgroup ```
Contact Info: support@avinetworks.com
Version: 20.1.9
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
post /poolgroup/clearget /poolgrouppost /poolgroupdelete /poolgroup/{uuid}post /poolgroup/{uuid}/enable_primary_pool/clearget /poolgroup/{uuid}patch /poolgroup/{uuid}put /poolgroup/{uuid}get /poolgroup/{uuid}/runtime/detail/
(poolgroupClearPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — empty
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
(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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
cloud_uuid (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.
cloud_ref.name (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud usings its name. This uses cloud name rather than uuid. Eg. cloud_ref.name=Default-Cloud.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"deployment_policy_ref" : "aeiou",
"priority_labels_ref" : "aeiou",
"service_metadata" : "aeiou",
"deactivate_primary_pool_on_down" : true,
"description" : "aeiou",
"enable_http2" : true,
"created_by" : "aeiou",
"implicit_priority_labels" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "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",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
PoolGroupApiResponse
401
log in failed
(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
Example data
Content-Type: application/json
{
"deployment_policy_ref" : "aeiou",
"priority_labels_ref" : "aeiou",
"service_metadata" : "aeiou",
"deactivate_primary_pool_on_down" : true,
"description" : "aeiou",
"enable_http2" : true,
"created_by" : "aeiou",
"implicit_priority_labels" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "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",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
post /poolgroup/{uuid}/enable_primary_pool/clear
(poolgroupUuidEnablePrimaryPoolClearPost)
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 — PrimaryPool
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
(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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"deployment_policy_ref" : "aeiou",
"priority_labels_ref" : "aeiou",
"service_metadata" : "aeiou",
"deactivate_primary_pool_on_down" : true,
"description" : "aeiou",
"enable_http2" : true,
"created_by" : "aeiou",
"implicit_priority_labels" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "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",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
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
Example data
Content-Type: application/json
{
"deployment_policy_ref" : "aeiou",
"priority_labels_ref" : "aeiou",
"service_metadata" : "aeiou",
"deactivate_primary_pool_on_down" : true,
"description" : "aeiou",
"enable_http2" : true,
"created_by" : "aeiou",
"implicit_priority_labels" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "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",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
PoolGroup
401
log in failed
(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
Example data
Content-Type: application/json
{
"deployment_policy_ref" : "aeiou",
"priority_labels_ref" : "aeiou",
"service_metadata" : "aeiou",
"deactivate_primary_pool_on_down" : true,
"description" : "aeiou",
"enable_http2" : true,
"created_by" : "aeiou",
"implicit_priority_labels" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "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",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
PoolGroup
401
log in failed
Up
get /poolgroup/{uuid}/runtime/detail/
(poolgroupUuidRuntimeDetailGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
[ Jump to Methods ]
Table of Contents
FailActionFailActionBackupPoolFailActionHTTPLocalResponseFailActionHTTPRedirectHTTPLocalFileKeyValuePoolGroupPoolGroupApiResponsePoolGroupMemberPrimaryPoolRoleFilterMatchLabel
backup_pool (optional)
local_rsp (optional)
redirect (optional)
type
String Enables a response to client when pool experiences a failure. By default TCP connection is closed. Enum options - FAIL_ACTION_HTTP_REDIRECT, FAIL_ACTION_HTTP_LOCAL_RSP, FAIL_ACTION_CLOSE_CONN, FAIL_ACTION_BACKUP_POOL. Allowed in Basic(Allowed values- FAIL_ACTION_CLOSE_CONN,FAIL_ACTION_HTTP_REDIRECT) edition, Essentials(Allowed values- FAIL_ACTION_CLOSE_CONN) edition, Enterprise edition.
backup_pool_ref
String Specifies the UUID of the Pool acting as backup pool. It is a reference to an object of type Pool.
file (optional)
HTTPLocalFile Placeholder for description of property file of obj type FailActionHTTPLocalResponse field type str type object
status_code (optional)
String Enum options - FAIL_HTTP_STATUS_CODE_200, FAIL_HTTP_STATUS_CODE_503.
host
String host of FailActionHTTPRedirect.
path (optional)
String path of FailActionHTTPRedirect.
protocol (optional)
String Enum options - HTTP, HTTPS. Allowed in Basic(Allowed values- HTTP) edition, Enterprise edition. Special default for Basic edition is HTTP, Enterprise is HTTPS.
query (optional)
String query of FailActionHTTPRedirect.
status_code (optional)
String Enum options - HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307. Allowed in Basic(Allowed values- HTTP_REDIRECT_STATUS_CODE_302) edition, Enterprise edition.
content_type
String Mime-type of the content in the file.
file_content
String File content to used in the local HTTP response body.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
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.
deactivate_primary_pool_on_down (optional)
Boolean Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7.
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.
enable_http2 (optional)
Boolean Enable HTTP/2 for traffic from VirtualService to all the backend servers in all the pools configured under this PoolGroup. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
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.
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.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Basic edition, Essentials edition, Enterprise edition.
members (optional)
min_servers (optional)
Integer The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - 'Disable'. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. 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.
service_metadata (optional)
String Metadata pertaining to the service provided by this PoolGroup. 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.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
uuid (optional)
String UUID of the pool group.
count
results
next (optional)
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'. Allowed in Basic(Allowed values- 1) edition, Essentials(Allowed values- 1) edition, Enterprise edition. format: int32
pool_uuid
String Pool's ID. Field introduced in 20.1.7.
key
String Key for filter match. Field introduced in 20.1.3.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3.