GslbSite

GslbSite
GslbSite
JSON Example
{
    "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"
}
string
address
Optional

IP Address or a DNS resolvable, fully qualified domain name of the Site Controller Cluster. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
cluster_uuid
Required

UUID of the 'Cluster' object of the Controller Cluster in this site. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

dns_vses
Optional

This field identifies the DNS VS and the subdomains it hosts for Gslb services. . Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
enabled
Optional
Constraints: default: true

Enable or disable the Site. This is useful in maintenance scenarios such as upgrade and routine maintenance. A disabled site's configuration shall be retained but it will not get any new configuration updates. It shall not participate in Health-Status monitoring. VIPs of the Virtual Services on the disabled site shall not be sent in DNS response. When a site transitions from disabled to enabled, it is treated similar to the addition of a new site. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

hm_proxies
Optional

User can designate certain Avi sites to run health monitor probes for VIPs/VS(es) for this site. This is useful in network deployments where the VIPs/VS(es) are reachable only from certain sites. A typical scenario is a firewall between two GSLB sites. User may want to run health monitor probes from sites on either side of the firewall so that each designated site can derive a datapath view of the reachable members. If the health monitor proxies are not configured, then the default behavior is to run health monitor probes from all the active sites. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
hm_shard_enabled
Optional

This field enables the health monitor shard functionality on a site-basis. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of IpAddr
ip_addresses
Optional

IP Address(es) of the Site's Cluster. For a 3-node cluster, either the cluster vIP is provided, or the list of controller IPs in the cluster are provided. Maximum of 3 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

location
Optional

location

string
member_type
Optional
Constraints: default: GSLB_PASSIVE_MEMBER

The site's member type A leader is set to ACTIVE while allmembers are set to passive. . Enum options - GSLB_ACTIVE_MEMBER, GSLB_PASSIVE_MEMBER. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

Name for the Site Controller Cluster. After any changes to site name, references to GSLB site name should be updated manually. Ex Site name used in DNS policies or Topology policies should be updated to use the new site name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
password
Required

The password used when authenticating with the Site. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
port
Optional
Constraints: default: 443

The Site Controller Cluster's REST API port number. Allowed values are 1-65535. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
ratio
Optional

User can overide the individual GslbPoolMember ratio for all the VIPs/VS(es) of this site. If this field is not configured then the GslbPoolMember ratio gets applied. . Allowed values are 1-20. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
suspend_mode
Optional

This modes applies to follower sites. When an active site is in suspend mode, the site does not receive any further federated objects. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
username
Required

The username used when authenticating with the Site. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
uuid
Optional

This field is used as a key in the datastore for the GslbSite table to encapsulate site-related info. . Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.