GslbServiceConfig

GslbServiceConfig
GslbServiceConfig
JSON Example
{
    "controller_health_status_enabled": false,
    "domain_names": [
        "string"
    ],
    "down_response": {
        "fallback_cname": "string",
        "fallback_ip": {
            "addr": "string",
            "type": "string"
        },
        "fallback_ip6": {
            "addr": "string",
            "type": "string"
        },
        "type": "string"
    },
    "enabled": false,
    "groups": [
        {
            "algorithm": "string",
            "consistent_hash_mask": 0,
            "consistent_hash_mask6": 0,
            "description": "string",
            "enabled": false,
            "fallback_algorithm": "string",
            "manual_resume": false,
            "members": [
                {
                    "cloud_uuid": "string",
                    "cluster_uuid": "string",
                    "description": "string",
                    "enabled": false,
                    "fqdn": "string",
                    "hostname": "string",
                    "ip": {
                        "addr": "string",
                        "type": "string"
                    },
                    "location": {
                        "location": {
                            "latitude": "number",
                            "longitude": "number",
                            "name": "string",
                            "tag": "string"
                        },
                        "source": "string"
                    },
                    "preference_order": 0,
                    "public_ip": {
                        "ip": {
                            "addr": "string",
                            "type": "string"
                        }
                    },
                    "ratio": 0,
                    "resolve_fqdn_to_v6": false,
                    "vs_uuid": "string"
                }
            ],
            "min_health_monitors_up": 0,
            "name": "string",
            "priority": 0
        }
    ],
    "health_monitor_scope": "string",
    "is_federated": false,
    "min_members": 0,
    "name": "string",
    "pool_algorithm": "string",
    "resolve_cname": false,
    "site_persistence_enabled": false,
    "tenant_ref": "string",
    "url": "string",
    "use_edns_client_subnet": false,
    "uuid": "string",
    "wildcard_match": false
}
boolean
controller_health_status_enabled
Optional
Constraints: default: true

GS member's overall health status is derived based on a combination of controller and datapath health-status inputs. Note that the datapath status is determined by the association of health monitor profiles. Only the controller provided status is determined through this configuration. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of string
domain_names
Optional

Fully qualified domain name of the GSLB service. Field introduced in 22.1.1. Minimum of 1 items required. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

down_response
Optional

down_response

boolean
enabled
Optional
Constraints: default: true

Enable or disable the GSLB service. If the GSLB service is enabled, then the VIPs are sent in the DNS responses based on reachability and configured algorithm. If the GSLB service is disabled, then the VIPs are no longer available in the DNS response. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of GslbPool
groups
Optional

Select list of pools belonging to this GSLB service. Field introduced in 22.1.1. Minimum of 1 items required. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
health_monitor_scope
Optional
Constraints: default: GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS

Health monitor probe can be executed for all the members or it can be executed only for third-party members. This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario. In such a case, Avi members can have controller derived status while Non-Avi members can be probed by via health monitor probes in dataplane. Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS. Field introduced in 22.1.1. 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.

integer As uint32 As uint32
min_members
Optional

The minimum number of members to distribute traffic to. Allowed values are 1-65535. Special values are 0 - Disable. 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 Service. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
pool_algorithm
Optional
Constraints: default: GSLB_SERVICE_ALGORITHM_PRIORITY

The load balancing algorithm will pick a GSLB pool within the GSLB service list of available pools. Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
resolve_cname
Optional

This field indicates that for a CNAME query, respond with resolved CNAMEs in the additional section with A records. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
site_persistence_enabled
Optional

Enable site-persistence for the GslbService. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
tenant_ref
Required

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.

string
url
Optional

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

boolean
use_edns_client_subnet
Optional
Constraints: default: true

Use the client ip subnet from the EDNS option as source IPaddress for client geo-location and consistent hash algorithm. Default is true. 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 Service. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
wildcard_match
Optional

Enable wild-card match of fqdn if an exact match is not found in the DNS table, the longest match is chosen by wild-carding the fqdn in the DNS request. Default is false. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.