Avi Gslb Object API
CLI ``` - configure gslb - show gslb ```
Contact Info: support@avinetworks.com
Version: 20.1.9
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /gslbpost /gslbdelete /gslb/{uuid}get /gslb/{uuid}patch /gslb/{uuid}put /gslb/{uuid}get /gslb/{uuid}/runtime/detail/get /gslb/{uuid}/runtime/get /gslb/{uuid}/runtime/internal/
(gslbGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"client_ip_addr_group" : {
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ],
"type" : "aeiou"
},
"async_interval" : 123,
"maintenance_mode" : true,
"leader_cluster_uuid" : "aeiou",
"view_id" : 123456789,
"description" : "aeiou",
"sites" : [ {
"member_type" : "aeiou",
"address" : "aeiou",
"ip_addresses" : [ "" ],
"dns_vs_uuids" : [ "aeiou" ],
"hm_proxies" : [ {
"site_uuid" : "aeiou",
"proxy_type" : "aeiou"
} ],
"uuid" : "aeiou",
"enabled" : true,
"password" : "aeiou",
"dns_vses" : [ {
"dns_vs_uuid" : "aeiou",
"domain_names" : [ "aeiou" ]
} ],
"cluster_uuid" : "aeiou",
"port" : 123,
"name" : "aeiou",
"location" : {
"location" : {
"latitude" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"tag" : "aeiou",
"longitude" : 1.3579000000000001069366817318950779736042022705078125
},
"source" : "aeiou"
},
"suspend_mode" : true,
"hm_shard_enabled" : true,
"ratio" : 123,
"username" : "aeiou"
} ],
"clear_on_max_retries" : 123,
"third_party_sites" : [ {
"cluster_uuid" : "aeiou",
"name" : "aeiou",
"location" : "",
"hm_proxies" : [ "" ],
"uuid" : "aeiou",
"enabled" : true,
"ratio" : 123
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"send_interval_prior_to_maintenance_mode" : 123,
"send_interval" : 123,
"error_resync_interval" : 123,
"tenant_ref" : "aeiou",
"tenant_scoped" : true,
"name" : "aeiou",
"dns_configs" : [ {
"domain_name" : "aeiou"
} ],
"enable_config_by_members" : true,
"is_federated" : true,
"replication_policy" : {
"checkpoint_ref" : "aeiou",
"replication_mode" : "aeiou"
}
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
GslbApiResponse
401
log in failed
(gslbPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Gslb object creation
Return type
Example data
Content-Type: application/json
{
"client_ip_addr_group" : {
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ],
"type" : "aeiou"
},
"async_interval" : 123,
"maintenance_mode" : true,
"leader_cluster_uuid" : "aeiou",
"view_id" : 123456789,
"description" : "aeiou",
"sites" : [ {
"member_type" : "aeiou",
"address" : "aeiou",
"ip_addresses" : [ "" ],
"dns_vs_uuids" : [ "aeiou" ],
"hm_proxies" : [ {
"site_uuid" : "aeiou",
"proxy_type" : "aeiou"
} ],
"uuid" : "aeiou",
"enabled" : true,
"password" : "aeiou",
"dns_vses" : [ {
"dns_vs_uuid" : "aeiou",
"domain_names" : [ "aeiou" ]
} ],
"cluster_uuid" : "aeiou",
"port" : 123,
"name" : "aeiou",
"location" : {
"location" : {
"latitude" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"tag" : "aeiou",
"longitude" : 1.3579000000000001069366817318950779736042022705078125
},
"source" : "aeiou"
},
"suspend_mode" : true,
"hm_shard_enabled" : true,
"ratio" : 123,
"username" : "aeiou"
} ],
"clear_on_max_retries" : 123,
"third_party_sites" : [ {
"cluster_uuid" : "aeiou",
"name" : "aeiou",
"location" : "",
"hm_proxies" : [ "" ],
"uuid" : "aeiou",
"enabled" : true,
"ratio" : 123
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"send_interval_prior_to_maintenance_mode" : 123,
"send_interval" : 123,
"error_resync_interval" : 123,
"tenant_ref" : "aeiou",
"tenant_scoped" : true,
"name" : "aeiou",
"dns_configs" : [ {
"domain_name" : "aeiou"
} ],
"enable_config_by_members" : true,
"is_federated" : true,
"replication_policy" : {
"checkpoint_ref" : "aeiou",
"replication_mode" : "aeiou"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
Gslb
401
log in failed
(gslbUuidDelete)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
(gslbUuidGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"client_ip_addr_group" : {
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ],
"type" : "aeiou"
},
"async_interval" : 123,
"maintenance_mode" : true,
"leader_cluster_uuid" : "aeiou",
"view_id" : 123456789,
"description" : "aeiou",
"sites" : [ {
"member_type" : "aeiou",
"address" : "aeiou",
"ip_addresses" : [ "" ],
"dns_vs_uuids" : [ "aeiou" ],
"hm_proxies" : [ {
"site_uuid" : "aeiou",
"proxy_type" : "aeiou"
} ],
"uuid" : "aeiou",
"enabled" : true,
"password" : "aeiou",
"dns_vses" : [ {
"dns_vs_uuid" : "aeiou",
"domain_names" : [ "aeiou" ]
} ],
"cluster_uuid" : "aeiou",
"port" : 123,
"name" : "aeiou",
"location" : {
"location" : {
"latitude" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"tag" : "aeiou",
"longitude" : 1.3579000000000001069366817318950779736042022705078125
},
"source" : "aeiou"
},
"suspend_mode" : true,
"hm_shard_enabled" : true,
"ratio" : 123,
"username" : "aeiou"
} ],
"clear_on_max_retries" : 123,
"third_party_sites" : [ {
"cluster_uuid" : "aeiou",
"name" : "aeiou",
"location" : "",
"hm_proxies" : [ "" ],
"uuid" : "aeiou",
"enabled" : true,
"ratio" : 123
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"send_interval_prior_to_maintenance_mode" : 123,
"send_interval" : 123,
"error_resync_interval" : 123,
"tenant_ref" : "aeiou",
"tenant_scoped" : true,
"name" : "aeiou",
"dns_configs" : [ {
"domain_name" : "aeiou"
} ],
"enable_config_by_members" : true,
"is_federated" : true,
"replication_policy" : {
"checkpoint_ref" : "aeiou",
"replication_mode" : "aeiou"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
Gslb
401
log in failed
(gslbUuidPatch)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Gslb object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"client_ip_addr_group" : {
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ],
"type" : "aeiou"
},
"async_interval" : 123,
"maintenance_mode" : true,
"leader_cluster_uuid" : "aeiou",
"view_id" : 123456789,
"description" : "aeiou",
"sites" : [ {
"member_type" : "aeiou",
"address" : "aeiou",
"ip_addresses" : [ "" ],
"dns_vs_uuids" : [ "aeiou" ],
"hm_proxies" : [ {
"site_uuid" : "aeiou",
"proxy_type" : "aeiou"
} ],
"uuid" : "aeiou",
"enabled" : true,
"password" : "aeiou",
"dns_vses" : [ {
"dns_vs_uuid" : "aeiou",
"domain_names" : [ "aeiou" ]
} ],
"cluster_uuid" : "aeiou",
"port" : 123,
"name" : "aeiou",
"location" : {
"location" : {
"latitude" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"tag" : "aeiou",
"longitude" : 1.3579000000000001069366817318950779736042022705078125
},
"source" : "aeiou"
},
"suspend_mode" : true,
"hm_shard_enabled" : true,
"ratio" : 123,
"username" : "aeiou"
} ],
"clear_on_max_retries" : 123,
"third_party_sites" : [ {
"cluster_uuid" : "aeiou",
"name" : "aeiou",
"location" : "",
"hm_proxies" : [ "" ],
"uuid" : "aeiou",
"enabled" : true,
"ratio" : 123
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"send_interval_prior_to_maintenance_mode" : 123,
"send_interval" : 123,
"error_resync_interval" : 123,
"tenant_ref" : "aeiou",
"tenant_scoped" : true,
"name" : "aeiou",
"dns_configs" : [ {
"domain_name" : "aeiou"
} ],
"enable_config_by_members" : true,
"is_federated" : true,
"replication_policy" : {
"checkpoint_ref" : "aeiou",
"replication_mode" : "aeiou"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
Gslb
401
log in failed
(gslbUuidPut)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Gslb object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"client_ip_addr_group" : {
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ],
"type" : "aeiou"
},
"async_interval" : 123,
"maintenance_mode" : true,
"leader_cluster_uuid" : "aeiou",
"view_id" : 123456789,
"description" : "aeiou",
"sites" : [ {
"member_type" : "aeiou",
"address" : "aeiou",
"ip_addresses" : [ "" ],
"dns_vs_uuids" : [ "aeiou" ],
"hm_proxies" : [ {
"site_uuid" : "aeiou",
"proxy_type" : "aeiou"
} ],
"uuid" : "aeiou",
"enabled" : true,
"password" : "aeiou",
"dns_vses" : [ {
"dns_vs_uuid" : "aeiou",
"domain_names" : [ "aeiou" ]
} ],
"cluster_uuid" : "aeiou",
"port" : 123,
"name" : "aeiou",
"location" : {
"location" : {
"latitude" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"tag" : "aeiou",
"longitude" : 1.3579000000000001069366817318950779736042022705078125
},
"source" : "aeiou"
},
"suspend_mode" : true,
"hm_shard_enabled" : true,
"ratio" : 123,
"username" : "aeiou"
} ],
"clear_on_max_retries" : 123,
"third_party_sites" : [ {
"cluster_uuid" : "aeiou",
"name" : "aeiou",
"location" : "",
"hm_proxies" : [ "" ],
"uuid" : "aeiou",
"enabled" : true,
"ratio" : 123
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"send_interval_prior_to_maintenance_mode" : 123,
"send_interval" : 123,
"error_resync_interval" : 123,
"tenant_ref" : "aeiou",
"tenant_scoped" : true,
"name" : "aeiou",
"dns_configs" : [ {
"domain_name" : "aeiou"
} ],
"enable_config_by_members" : true,
"is_federated" : true,
"replication_policy" : {
"checkpoint_ref" : "aeiou",
"replication_mode" : "aeiou"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
Gslb
401
log in failed
Up
get /gslb/{uuid}/runtime/detail/
(gslbUuidRuntimeDetailGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /gslb/{uuid}/runtime/
(gslbUuidRuntimeGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /gslb/{uuid}/runtime/internal/
(gslbUuidRuntimeInternalGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
[ Jump to Methods ]
Table of Contents
DNSConfigGeoLocationGslbGslbApiResponseGslbClientIpAddrGroupGslbGeoLocationGslbHealthMonitorProxyGslbSiteGslbSiteDnsVsGslbThirdPartySiteIpAddrIpAddrPrefixIpAddrRangeReplicationPolicy
domain_name
String GSLB subdomain used for GSLB service FQDN match and placement. .
latitude (optional)
Float Latitude of the location. This is represented as degrees.minutes. The range is from -90.0 (south) to +90.0 (north). Allowed values are -90.0-+90.0. Field introduced in 17.1.1. format: float
longitude (optional)
Float Longitude of the location. This is represented as degrees.minutes. The range is from -180.0 (west) to +180.0 (east). Allowed values are -180.0-+180.0. Field introduced in 17.1.1. format: float
name (optional)
String Location name in the format Country/State/City. Field introduced in 17.1.1.
tag (optional)
String Location tag string - example USEast. Field introduced in 17.1.1.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
async_interval (optional)
Integer 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 18.2.3. Unit is SEC. format: int32
clear_on_max_retries (optional)
Integer 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. format: int32
client_ip_addr_group (optional)
GslbClientIpAddrGroup Group to specify if the client ip addresses are public or private. Field introduced in 17.1.2.
description (optional)
String User defined description for the object.
dns_configs (optional)
array[DNSConfig] Sub domain configuration for the GSLB. GSLB service's FQDN must be a match one of these subdomains. .
enable_config_by_members (optional)
Boolean Allows enable/disable of GslbService pool groups and pool members from the gslb follower members. Field introduced in 20.1.5.
error_resync_interval (optional)
Integer 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 18.2.3. Unit is SEC. format: int32
is_federated (optional)
Boolean This field indicates that this object is replicated across GSLB federation. Field introduced in 17.1.3.
leader_cluster_uuid
String Mark this Site as leader of GSLB configuration. This site is the one among the Avi sites.
maintenance_mode (optional)
Boolean 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 17.2.1.
name
String Name for the GSLB object.
replication_policy (optional)
ReplicationPolicy Policy for replicating configuration to the active follower sites. Field introduced in 20.1.1.
send_interval (optional)
Integer Frequency with which group members communicate. Allowed values are 1-3600. Unit is SEC. format: int32
send_interval_prior_to_maintenance_mode (optional)
Integer The user can specify a send-interval while entering maintenance mode. The validity of this 'maintenance send-interval' is only during maintenance mode. When the user leaves maintenance mode, the original send-interval is reinstated. This internal variable is used to store the original send-interval. . Field introduced in 18.2.3. Unit is SEC. format: int32
sites (optional)
array[GslbSite] Select Avi site member belonging to this Gslb. Minimum of 1 items required.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
tenant_scoped (optional)
Boolean This field indicates tenant visibility for GS pool member selection across the Gslb federated objects. Field introduced in 20.1.4.
third_party_sites (optional)
url (optional)
uuid (optional)
String UUID of the GSLB object.
view_id (optional)
Long 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. format: int64
count
results
next (optional)
addrs (optional)
array[IpAddr] Configure IP address(es). Field introduced in 17.1.2.
prefixes (optional)
ranges (optional)
type
String Specify whether this client IP address range is public or private. Enum options - GSLB_IP_PUBLIC, GSLB_IP_PRIVATE. Field introduced in 17.1.2.
location (optional)
GeoLocation Geographic location of the site. Field introduced in 17.1.1.
source
String This field describes the source of the GeoLocation. . Enum options - GSLB_LOCATION_SRC_USER_CONFIGURED, GSLB_LOCATION_SRC_INHERIT_FROM_SITE, GSLB_LOCATION_SRC_FROM_GEODB. Field introduced in 17.1.1.
proxy_type (optional)
String This field identifies the health monitor proxy behavior. The designated site for health monitor proxy can monitor public or private or all the members of a given site. . Enum options - GSLB_HEALTH_MONITOR_PROXY_ALL_MEMBERS, GSLB_HEALTH_MONITOR_PROXY_PRIVATE_MEMBERS. Field introduced in 17.1.1.
site_uuid (optional)
String This field identifies the site that will health monitor on behalf of the current site. i.e. it will be a health monitor proxy and monitor members of the current site. . Field introduced in 17.1.1.
address (optional)
String IP Address or a DNS resolvable, fully qualified domain name of the Site Controller Cluster.
cluster_uuid
String UUID of the 'Cluster' object of the Controller Cluster in this site.
dns_vs_uuids (optional)
array[String] The DNS VSes on which the GslbServices shall be placed. The site has to be an ACTIVE member. This field is deprecated in 17.2.3 and replaced by 'dns_vses' field. . Field deprecated in 17.2.3.
dns_vses (optional)
array[GslbSiteDnsVs] This field identifies the DNS VS and the subdomains it hosts for Gslb services. . Field introduced in 17.2.3.
enabled (optional)
Boolean 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.
hm_proxies (optional)
array[GslbHealthMonitorProxy] 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.
hm_shard_enabled (optional)
Boolean This field enables the health monitor shard functionality on a site-basis. Field introduced in 18.2.2.
ip_addresses (optional)
array[IpAddr] 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.
location (optional)
GslbGeoLocation Geographic location of the site. Field introduced in 17.1.1.
member_type (optional)
String 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.
name
String 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.
password
String The password used when authenticating with the Site.
port (optional)
Integer The Site Controller Cluster's REST API port number. Allowed values are 1-65535. format: int32
ratio (optional)
Integer 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. format: int32
suspend_mode (optional)
Boolean 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.
username
String The username used when authenticating with the Site. .
uuid (optional)
String 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.
dns_vs_uuid
String This field identifies the DNS VS uuid for this site. Field introduced in 17.2.3.
domain_names (optional)
array[String] This field identifies the subdomains that are hosted on the DNS VS. GslbService(s) whose FQDNs map to one of the subdomains will be hosted on this DNS VS. If no subdomains are configured, then the default behavior is to host all the GslbServices on this DNS VS. Field introduced in 17.2.3.
cluster_uuid (optional)
String Third-party-site identifier generated by Avi. Field introduced in 17.1.1.
enabled (optional)
Boolean Enable or disable the third-party 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. VIPs associated with the disabled site shall not be sent in DNS response. . Field introduced in 17.1.1.
hm_proxies (optional)
array[GslbHealthMonitorProxy] 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.
location (optional)
GslbGeoLocation Geographic location of the site. Field introduced in 17.1.1.
name
String Name of the third-party Site. Field introduced in 17.1.1.
ratio (optional)
Integer User can overide the individual GslbPoolMember ratio for all the VIPs 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. format: int32
uuid (optional)
String This field is used as a key in the datastore for the GslbThirdPartySite table to encapsulate site-related info. . Field introduced in 17.2.5.
addr
type
String Enum options - V4, DNS, V6.
ip_addr
IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object
mask
Integer Number of mask. format: int32
begin
IpAddr Starting IP address of the range.
end
IpAddr Ending IP address of the range.
checkpoint_ref (optional)
String Leader's checkpoint. Follower attempt to replicate configuration till this checkpoint. It is a reference to an object of type FederationCheckpoint. Field introduced in 20.1.1.
replication_mode (optional)
String Replication mode. Enum options - REPLICATION_MODE_CONTINUOUS, REPLICATION_MODE_MANUAL, REPLICATION_MODE_ADAPTIVE. Field introduced in 20.1.1.