PUT /poolgroup/{uuid}
/poolgroup/{uuid}
UUID of the object to fetch
object name
Avi Tenant Header
Avi Tenant Header UUID
The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
PoolGroup object creation
Show optional properties
{
"name": "string"
}{
"_last_modified": "string",
"cloud_config_cksum": "string",
"cloud_ref": "string",
"configpb_attributes": {
"version": 0
},
"created_by": "string",
"deactivate_primary_pool_on_down": false,
"deployment_policy_ref": "string",
"description": "string",
"enable_http2": false,
"fail_action": {
"local_rsp": {
"file": {
"content_type": "string",
"file_content": "string",
"file_length": 0
},
"status_code": "string"
},
"redirect": {
"host": "string",
"path": "string",
"protocol": "string",
"query": "string",
"status_code": "string"
},
"type": "string"
},
"implicit_priority_labels": false,
"markers": [
{
"key": "string",
"values": [
"string"
]
}
],
"members": [
{
"deployment_state": "string",
"pool_ref": "string",
"priority_label": "string",
"ratio": 0
}
],
"min_servers": 0,
"name": "string",
"priority_labels_ref": "string",
"service_metadata": "string",
"tenant_ref": "string",
"url": "string",
"uuid": "string"
}OK
"PoolGroup Object"UNIX time since epoch in microseconds. Units(MICROSECONDS).
Checksum of cloud configuration for PoolGroup. Internally set by cloud connector. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
configpb_attributes
Name of the user who created the object. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Description of Pool Group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Enable HTTP/2 for traffic from VirtualService to all the backend servers in all the pools configured under this PoolGroup. Field deprecated in 30.2.1. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
fail_action
Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
List of pool group members object of type PoolGroupMember. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - Disable. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0), Basic edition(Allowed values- 0), Enterprise with Cloud Services edition.
The name of the pool group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url
UUID of the pool group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
log in failed
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}' https://{api_host}/api/poolgroup/{uuid}