GslbPool

GslbPool
GslbPool
JSON Example
{
    "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
}
string
algorithm
Required
Constraints: default: GSLB_ALGORITHM_ROUND_ROBIN

The load balancing algorithm will pick a local member within the GSLB service list of available Members. Enum options - GSLB_ALGORITHM_ROUND_ROBIN, GSLB_ALGORITHM_CONSISTENT_HASH, GSLB_ALGORITHM_GEO, GSLB_ALGORITHM_TOPOLOGY, GSLB_ALGORITHM_PREFERENCE_ORDER. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
consistent_hash_mask
Optional

Mask to be applied on client IP for consistent hash algorithm. Allowed values are 1-31. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
consistent_hash_mask6
Optional

Mask to be applied on client IPV6 address for consistent hash algorithm. Allowed values are 1-127. Field introduced in 18.2.8, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
description
Optional

User provided information that records member details such as application owner name, contact, etc. Field introduced in 17.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
enabled
Optional
Constraints: default: true

Enable or disable a GSLB service pool. 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.

string
fallback_algorithm
Optional

The fallback load balancing algorithm used to pick a member when the pool algorithm fails to find a valid member. For instance when algorithm is Geo and client/server do not have valid geo location. Enum options - GSLB_ALGORITHM_ROUND_ROBIN, GSLB_ALGORITHM_CONSISTENT_HASH, GSLB_ALGORITHM_GEO, GSLB_ALGORITHM_TOPOLOGY, GSLB_ALGORITHM_PREFERENCE_ORDER. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
manual_resume
Optional

Manually resume traffic to a pool member once it goes down. If enabled a pool member once goes down is kept in admin down state unless admin re enables it. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

members
Optional

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

integer As uint32 As uint32
min_health_monitors_up
Optional

Minimum number of health monitors in UP state to mark the member UP. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

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

integer As uint32 As uint32
priority
Optional
Constraints: default: 10

Priority of this pool of Members. The higher the number, the higher is the priority of the pool. The DNS Service chooses the pool with the highest priority that is operationally up. Allowed values are 0-100. Special values are 0 - Do not choose members from this pool.A priority of 0 is equivalent to disabling the pool.. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.