POST /gslb
/gslb
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.
Gslb object creation
Show optional properties
{
"leader_cluster_uuid": "string",
"name": "string"
}{
"_last_modified": "string",
"async_interval": 0,
"clear_on_max_retries": 0,
"client_ip_addr_group": {
"addrs": [
{
"addr": "string",
"type": "string"
}
],
"prefixes": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"ranges": [
{
"begin": {
"addr": "string",
"type": "string"
},
"end": {
"addr": "string",
"type": "string"
}
}
],
"type": "string"
},
"configpb_attributes": {
"version": 0
},
"description": "string",
"dns_configs": [
{
"domain_name": "string"
}
],
"enable_config_by_members": false,
"error_resync_interval": 0,
"fileobject_max_file_versions": 0,
"is_federated": false,
"leader_cluster_uuid": "string",
"maintenance_mode": false,
"name": "string",
"replication_policy": {
"checkpoint_ref": "string",
"replication_mode": "string"
},
"send_interval": 0,
"send_interval_prior_to_maintenance_mode": 0,
"sites": [
{
"address": "string",
"cluster_uuid": "string",
"dns_vses": [
{
"dns_vs_uuid": "string",
"domain_names": [
"string"
]
}
],
"enabled": false,
"hm_proxies": [
{
"proxy_type": "string",
"site_uuid": "string"
}
],
"hm_shard_enabled": false,
"ip_addresses": [
{
"addr": "string",
"type": "string"
}
],
"location": {
"location": {
"latitude": "number",
"longitude": "number",
"name": "string",
"tag": "string"
},
"source": "string"
},
"member_type": "string",
"name": "string",
"password": "string",
"port": 0,
"ratio": 0,
"suspend_mode": false,
"username": "string",
"uuid": "string"
}
],
"tenant_ref": "string",
"tenant_scoped": false,
"third_party_sites": [
{
"cluster_uuid": "string",
"enabled": false,
"hm_proxies": [
{
"proxy_type": "string",
"site_uuid": "string"
}
],
"location": {
"location": {
"latitude": "number",
"longitude": "number",
"name": "string",
"tag": "string"
},
"source": "string"
},
"name": "string",
"ratio": 0,
"uuid": "string"
}
],
"url": "string",
"uuid": "string",
"view_id": 0
}OK
"Gslb Object"UNIX time since epoch in microseconds. Units(MICROSECONDS).
Frequency with which messages are propagated to Vs Mgr. Value of 0 disables async behavior and RPC are sent inline. Allowed values are 0-5. Field introduced in 18.2.3. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Max retries after which the remote site is treated as a fresh start. In fresh start all the configs are downloaded. Allowed values are 1-1024. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
client_ip_addr_group
configpb_attributes
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Sub domain configuration for the GSLB. GSLB service's FQDN must be a match one of these subdomains. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allows enable/disable of GslbService pool groups and pool members from the gslb follower members. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Frequency with which errored messages are resynced to follower sites. Value of 0 disables resync behavior. Allowed values are 60-3600. Special values are 0 - Disable. Field introduced in 18.2.3. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
This is the max number of file versions that will be retained for a file referenced by the federated FileObject. Subsequent uploads of file will result in the file rotation of the older version and the latest version retained. Example When a file Upload is done for the first time, there will be a v1 version. Subsequent uploads will get mapped to v1, v2 and v3 versions. On the fourth upload of the file, the v1 will be file rotated and v2, v3 and v4 will be retained. Allowed values are 1-5. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
This field indicates that this object is replicated across GSLB federation. Field introduced in 17.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Mark this Site as leader of GSLB configuration. This site is the one among the Avi sites. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
This field disables the configuration operations on the leader for all federated objects. CUD operations on Gslb, GslbService, GslbGeoDbProfile and other federated objects will be rejected. The rest-api disabling helps in upgrade scenarios where we don't want configuration sync operations to the Gslb member when the member is being upgraded. This configuration programmatically blocks the leader from accepting new Gslb configuration when member sites are undergoing upgrade. . Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Name for the GSLB object. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
replication_policy
Frequency with which group members communicate. Allowed values are 1-3600. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
The user can specify a send-interval while entering maintenance mode. The validity of this 'maintenance send-interval' is only during maintenance mode. When the user leaves maintenance mode, the original send-interval is reinstated. This internal variable is used to store the original send-interval. . Field introduced in 18.2.3. Unit is SEC. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
Select Avi site member belonging to this Gslb. Minimum of 1 items required. 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.
This field indicates tenant visibility for GS pool member selection across the Gslb federated objects.Tenant scope can be set only during the Gslb create and cannot be changed once it is set. Field introduced in 18.2.12,20.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Third party site member belonging to this Gslb. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url
UUID of the GSLB object. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
The view-id is used in change-leader mode to differentiate partitioned groups while they have the same GSLB namespace. Each partitioned group will be able to operate independently by using the view-id. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
log in failed
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"leader_cluster_uuid:"string","name:"string"}' https://{api_host}/api/gslb