GslbConfig

GslbConfig
GslbConfig
JSON Example
{
    "async_interval": 0,
    "clear_on_max_retries": 0,
    "enable_config_by_members": false,
    "error_resync_interval": 0,
    "is_federated": false,
    "leader_cluster_uuid": "string",
    "maintenance_mode": false,
    "name": "string",
    "replication_policy": {
        "checkpoint_ref": "string",
        "replication_mode": "string"
    },
    "send_interval": 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,
    "url": "string",
    "uuid": "string",
    "view_id": 0
}
integer As uint32 As uint32
async_interval
Optional

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 22.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
clear_on_max_retries
Optional
Constraints: default: 20

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. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
enable_config_by_members
Optional

Allows enable/disable of GslbService pool groups and pool members from the gslb follower members. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
error_resync_interval
Optional
Constraints: default: 300

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 22.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
is_federated
Optional
Constraints: default: true

This field indicates that this object is replicated across GSLB federation. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
leader_cluster_uuid
Required

Mark this Site as leader of GSLB configuration. This site is the one among the Avi sites. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
maintenance_mode
Optional

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 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
name
Required

Name of the GSLB. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

replication_policy
Optional

replication_policy

integer As uint32 As uint32
send_interval
Optional
Constraints: default: 15

Frequency with which group members communicate. Allowed values are 1-3600. Field introduced in 22.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of GslbSite
sites
Optional

Select Avi site member belonging to this Gslb. Field introduced in 22.1.1. Minimum of 1 items required. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
tenant_scoped
Optional
Constraints: default: true

This field indicates tenant visibility for GS pool member selection across the Gslb federated objects. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
url
Optional

URL of the GSLB. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
uuid
Optional

UUID of the GSLB. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint64 As uint64
view_id
Optional

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. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.