GslbService

GslbService
GslbService
JSON Example
{
    "_last_modified": "string",
    "application_persistence_profile_ref": "string",
    "configpb_attributes": {
        "version": 0
    },
    "controller_health_status_enabled": false,
    "created_by": "string",
    "description": "string",
    "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_refs": [
        "string"
    ],
    "health_monitor_scope": "string",
    "hm_off": false,
    "is_federated": false,
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "min_members": 0,
    "name": "string",
    "num_dns_ip": 0,
    "pki_profile_ref": "string",
    "pool_algorithm": "string",
    "resolve_cname": false,
    "site_persistence_enabled": false,
    "tenant_ref": "string",
    "topology_policy_enabled": false,
    "ttl": 0,
    "url": "string",
    "use_edns_client_subnet": false,
    "uuid": "string",
    "wildcard_match": false
}
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string
application_persistence_profile_ref
Optional

The federated application persistence associated with GslbService site persistence functionality. . It is a reference to an object of type ApplicationPersistenceProfile. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

configpb_attributes
Optional

configpb_attributes

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

string
created_by
Optional

Creator name. Field introduced in 17.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
description
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string
domain_names
Optional

Fully qualified domain name of the GSLB service. Minimum of 1 items required. Allowed in Enterprise edition with any value, Essentials, Basic, 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of GslbPool
groups
Optional

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

array of string
health_monitor_refs
Optional

Verify VS health by applying one or more health monitors. Active monitors generate synthetic traffic from DNS Service Engine and to mark a VS up or down based on the response. . It is a reference to an object of type HealthMonitor. Maximum of 6 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
hm_off
Optional

This field is an internal field and is used in SE. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic 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 17.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

markers
Optional

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.

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

string
name
Required

Name for the GSLB service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
num_dns_ip
Optional

Number of IP addresses of this GSLB service to be returned by the DNS Service. Enter 0 to return all IP addresses. Allowed values are 1-20. Special values are 0- Return all IP addresses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
pki_profile_ref
Optional

PKI profile associated with the Gslb Service. It is a reference to an object of type PKIProfile. Field introduced in 22.1.3. 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 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, 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 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
site_persistence_enabled
Optional

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

string
tenant_ref
Optional

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

boolean
topology_policy_enabled
Optional

When enabled, topology policy rules are used for member selection first. If no valid member is found using the topology policy rules, configured GSLB algorithms for pool selection and member selection are used. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
ttl
Optional

TTL value (in seconds) for records served for this GSLB service by the DNS Service. Allowed values are 0-86400. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

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

string
uuid
Optional

UUID of the GSLB service. Allowed in Enterprise edition with any value, Essentials, Basic, 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 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.