Avi GslbService Object API
CLI ``` - configure gslbservice - show gslbservice ```
Version: 22.1.5
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /gslbservicepost /gslbservicedelete /gslbservice/{uuid}get /gslbservice/{uuid}patch /gslbservice/{uuid}put /gslbservice/{uuid}get /gslbservice/{uuid}/runtime/
(gslbserviceGet)
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" : [ {
"site_persistence_enabled" : true,
"pool_algorithm" : "aeiou",
"description" : "aeiou",
"uuid" : "aeiou",
"enabled" : true,
"_last_modified" : "aeiou",
"down_response" : {
"fallback_ip6" : "",
"fallback_ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"type" : "aeiou",
"fallback_cname" : "aeiou"
},
"hm_off" : true,
"wildcard_match" : true,
"use_edns_client_subnet" : true,
"configpb_attributes" : {
"version" : 123
},
"health_monitor_refs" : [ "aeiou" ],
"num_dns_ip" : 123,
"is_federated" : true,
"resolve_cname" : true,
"topology_policy_enabled" : true,
"application_persistence_profile_ref" : "aeiou",
"groups" : [ {
"min_health_monitors_up" : 123,
"consistent_hash_mask" : 123,
"members" : [ {
"public_ip" : {
"ip" : ""
},
"fqdn" : "aeiou",
"ip" : "",
"preference_order" : 123,
"description" : "aeiou",
"enabled" : true,
"resolve_fqdn_to_v6" : true,
"cloud_uuid" : "aeiou",
"hostname" : "aeiou",
"vs_uuid" : "aeiou",
"cluster_uuid" : "aeiou",
"location" : {
"location" : {
"latitude" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"tag" : "aeiou",
"longitude" : 1.3579000000000001069366817318950779736042022705078125
},
"source" : "aeiou"
},
"ratio" : 123
} ],
"name" : "aeiou",
"description" : "aeiou",
"priority" : 123,
"fallback_algorithm" : "aeiou",
"consistent_hash_mask6" : 123,
"enabled" : true,
"algorithm" : "aeiou",
"manual_resume" : true
} ],
"min_members" : 123,
"controller_health_status_enabled" : true,
"created_by" : "aeiou",
"ttl" : 123,
"url" : "aeiou",
"domain_names" : [ "aeiou" ],
"pki_profile_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"health_monitor_scope" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "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
GslbServiceApiResponse
401
log in failed
(gslbservicePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — GslbService object creation
Return type
Example data
Content-Type: application/json
{
"site_persistence_enabled" : true,
"pool_algorithm" : "aeiou",
"description" : "aeiou",
"uuid" : "aeiou",
"enabled" : true,
"_last_modified" : "aeiou",
"down_response" : {
"fallback_ip6" : "",
"fallback_ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"type" : "aeiou",
"fallback_cname" : "aeiou"
},
"hm_off" : true,
"wildcard_match" : true,
"use_edns_client_subnet" : true,
"configpb_attributes" : {
"version" : 123
},
"health_monitor_refs" : [ "aeiou" ],
"num_dns_ip" : 123,
"is_federated" : true,
"resolve_cname" : true,
"topology_policy_enabled" : true,
"application_persistence_profile_ref" : "aeiou",
"groups" : [ {
"min_health_monitors_up" : 123,
"consistent_hash_mask" : 123,
"members" : [ {
"public_ip" : {
"ip" : ""
},
"fqdn" : "aeiou",
"ip" : "",
"preference_order" : 123,
"description" : "aeiou",
"enabled" : true,
"resolve_fqdn_to_v6" : true,
"cloud_uuid" : "aeiou",
"hostname" : "aeiou",
"vs_uuid" : "aeiou",
"cluster_uuid" : "aeiou",
"location" : {
"location" : {
"latitude" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"tag" : "aeiou",
"longitude" : 1.3579000000000001069366817318950779736042022705078125
},
"source" : "aeiou"
},
"ratio" : 123
} ],
"name" : "aeiou",
"description" : "aeiou",
"priority" : 123,
"fallback_algorithm" : "aeiou",
"consistent_hash_mask6" : 123,
"enabled" : true,
"algorithm" : "aeiou",
"manual_resume" : true
} ],
"min_members" : 123,
"controller_health_status_enabled" : true,
"created_by" : "aeiou",
"ttl" : 123,
"url" : "aeiou",
"domain_names" : [ "aeiou" ],
"pki_profile_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"health_monitor_scope" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "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
GslbService
401
log in failed
Up
delete /gslbservice/{uuid}
(gslbserviceUuidDelete)
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
Up
get /gslbservice/{uuid}
(gslbserviceUuidGet)
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
{
"site_persistence_enabled" : true,
"pool_algorithm" : "aeiou",
"description" : "aeiou",
"uuid" : "aeiou",
"enabled" : true,
"_last_modified" : "aeiou",
"down_response" : {
"fallback_ip6" : "",
"fallback_ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"type" : "aeiou",
"fallback_cname" : "aeiou"
},
"hm_off" : true,
"wildcard_match" : true,
"use_edns_client_subnet" : true,
"configpb_attributes" : {
"version" : 123
},
"health_monitor_refs" : [ "aeiou" ],
"num_dns_ip" : 123,
"is_federated" : true,
"resolve_cname" : true,
"topology_policy_enabled" : true,
"application_persistence_profile_ref" : "aeiou",
"groups" : [ {
"min_health_monitors_up" : 123,
"consistent_hash_mask" : 123,
"members" : [ {
"public_ip" : {
"ip" : ""
},
"fqdn" : "aeiou",
"ip" : "",
"preference_order" : 123,
"description" : "aeiou",
"enabled" : true,
"resolve_fqdn_to_v6" : true,
"cloud_uuid" : "aeiou",
"hostname" : "aeiou",
"vs_uuid" : "aeiou",
"cluster_uuid" : "aeiou",
"location" : {
"location" : {
"latitude" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"tag" : "aeiou",
"longitude" : 1.3579000000000001069366817318950779736042022705078125
},
"source" : "aeiou"
},
"ratio" : 123
} ],
"name" : "aeiou",
"description" : "aeiou",
"priority" : 123,
"fallback_algorithm" : "aeiou",
"consistent_hash_mask6" : 123,
"enabled" : true,
"algorithm" : "aeiou",
"manual_resume" : true
} ],
"min_members" : 123,
"controller_health_status_enabled" : true,
"created_by" : "aeiou",
"ttl" : 123,
"url" : "aeiou",
"domain_names" : [ "aeiou" ],
"pki_profile_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"health_monitor_scope" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "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
GslbService
401
log in failed
Up
patch /gslbservice/{uuid}
(gslbserviceUuidPatch)
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 — GslbService object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"site_persistence_enabled" : true,
"pool_algorithm" : "aeiou",
"description" : "aeiou",
"uuid" : "aeiou",
"enabled" : true,
"_last_modified" : "aeiou",
"down_response" : {
"fallback_ip6" : "",
"fallback_ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"type" : "aeiou",
"fallback_cname" : "aeiou"
},
"hm_off" : true,
"wildcard_match" : true,
"use_edns_client_subnet" : true,
"configpb_attributes" : {
"version" : 123
},
"health_monitor_refs" : [ "aeiou" ],
"num_dns_ip" : 123,
"is_federated" : true,
"resolve_cname" : true,
"topology_policy_enabled" : true,
"application_persistence_profile_ref" : "aeiou",
"groups" : [ {
"min_health_monitors_up" : 123,
"consistent_hash_mask" : 123,
"members" : [ {
"public_ip" : {
"ip" : ""
},
"fqdn" : "aeiou",
"ip" : "",
"preference_order" : 123,
"description" : "aeiou",
"enabled" : true,
"resolve_fqdn_to_v6" : true,
"cloud_uuid" : "aeiou",
"hostname" : "aeiou",
"vs_uuid" : "aeiou",
"cluster_uuid" : "aeiou",
"location" : {
"location" : {
"latitude" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"tag" : "aeiou",
"longitude" : 1.3579000000000001069366817318950779736042022705078125
},
"source" : "aeiou"
},
"ratio" : 123
} ],
"name" : "aeiou",
"description" : "aeiou",
"priority" : 123,
"fallback_algorithm" : "aeiou",
"consistent_hash_mask6" : 123,
"enabled" : true,
"algorithm" : "aeiou",
"manual_resume" : true
} ],
"min_members" : 123,
"controller_health_status_enabled" : true,
"created_by" : "aeiou",
"ttl" : 123,
"url" : "aeiou",
"domain_names" : [ "aeiou" ],
"pki_profile_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"health_monitor_scope" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "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
GslbService
401
log in failed
Up
put /gslbservice/{uuid}
(gslbserviceUuidPut)
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 — GslbService object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"site_persistence_enabled" : true,
"pool_algorithm" : "aeiou",
"description" : "aeiou",
"uuid" : "aeiou",
"enabled" : true,
"_last_modified" : "aeiou",
"down_response" : {
"fallback_ip6" : "",
"fallback_ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"type" : "aeiou",
"fallback_cname" : "aeiou"
},
"hm_off" : true,
"wildcard_match" : true,
"use_edns_client_subnet" : true,
"configpb_attributes" : {
"version" : 123
},
"health_monitor_refs" : [ "aeiou" ],
"num_dns_ip" : 123,
"is_federated" : true,
"resolve_cname" : true,
"topology_policy_enabled" : true,
"application_persistence_profile_ref" : "aeiou",
"groups" : [ {
"min_health_monitors_up" : 123,
"consistent_hash_mask" : 123,
"members" : [ {
"public_ip" : {
"ip" : ""
},
"fqdn" : "aeiou",
"ip" : "",
"preference_order" : 123,
"description" : "aeiou",
"enabled" : true,
"resolve_fqdn_to_v6" : true,
"cloud_uuid" : "aeiou",
"hostname" : "aeiou",
"vs_uuid" : "aeiou",
"cluster_uuid" : "aeiou",
"location" : {
"location" : {
"latitude" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"tag" : "aeiou",
"longitude" : 1.3579000000000001069366817318950779736042022705078125
},
"source" : "aeiou"
},
"ratio" : 123
} ],
"name" : "aeiou",
"description" : "aeiou",
"priority" : 123,
"fallback_algorithm" : "aeiou",
"consistent_hash_mask6" : 123,
"enabled" : true,
"algorithm" : "aeiou",
"manual_resume" : true
} ],
"min_members" : 123,
"controller_health_status_enabled" : true,
"created_by" : "aeiou",
"ttl" : 123,
"url" : "aeiou",
"domain_names" : [ "aeiou" ],
"pki_profile_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"health_monitor_scope" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "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
GslbService
401
log in failed
Up
get /gslbservice/{uuid}/runtime/
(gslbserviceUuidRuntimeGet)
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
ConfigPbAttributesGeoLocationGslbGeoLocationGslbHealthMonitorProxyGslbIpAddrGslbPoolGslbPoolMemberGslbServiceGslbServiceApiResponseGslbServiceDownResponseIpAddrKeyValueRoleFilterMatchLabel
version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: float
name (optional)
String Location name in the format Country/State/City. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tag (optional)
String Location tag string - example USEast. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
location (optional)
GeoLocation Geographic location of the site. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip (optional)
IpAddr Public IP address of the pool member. Field introduced in 17.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
algorithm
String 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.
consistent_hash_mask (optional)
Integer 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. format: int32
consistent_hash_mask6 (optional)
Integer 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. format: int32
description (optional)
String 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.
enabled (optional)
Boolean 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.
fallback_algorithm (optional)
String 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.
manual_resume (optional)
Boolean 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)
array[GslbPoolMember] 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.
min_health_monitors_up (optional)
Integer 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. format: int32
name
String Name of the GSLB service pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
priority (optional)
Integer 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. format: int32
cloud_uuid (optional)
String The Cloud UUID of the Site. Field introduced in 17.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cluster_uuid (optional)
String The Cluster UUID of the Site. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
description (optional)
String 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.
enabled (optional)
Boolean Enable or Disable member to decide if this address should be provided in DNS responses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
fqdn (optional)
String The pool member is configured with a fully qualified domain name. The FQDN is resolved to an IP address by the controller. DNS service shall health monitor the resolved IP address while it will return the fqdn(cname) in the DNS response.If the user has configured an IP address (in addition to the FQDN), then the IP address will get overwritten whenever periodic FQDN refresh is done by the controller. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hostname (optional)
String Hostname to be used as host header for http health monitors and as TLS server name for https health monitors.(By default, the fqdn of the GSLB pool member or GSLB service is used.) Note this field is not used as http host header when exact_http_request is set in the health monitor. . Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip (optional)
IpAddr IP address of the pool member. If this IP address is hosted via an AVI virtual service, then the user should configure the cluster uuid and virtual service uuid. If this IP address is hosted on a third-party device and the device is tagged/tethered to a third-party site, then user can configure the third-party site uuid. User may configure the IP address without the cluster uuid or the virtual service uuid. In this option, some advanced site related features cannot be enabled. If the user has configured a fqdn for the pool member, then it takes precedence and will overwrite the configured IP address. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
location (optional)
GslbGeoLocation Geographic location of the pool member. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
preference_order (optional)
Integer Preference order of this member in the group. The DNS Service chooses the member with the lowest preference that is operationally up. Allowed values are 1-128. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
public_ip (optional)
GslbIpAddr Alternate IP addresses of the pool member. In usual deployments, the VIP in the virtual service is a private IP address. This gets configured in the 'ip' field of the GSLB service. This field is used to host the public IP address for the VIP, which gets NATed to the private IP by a firewall. Client DNS requests coming in from within the intranet should have the private IP served in the A record, and requests from outside this should be served the public IP address. Field introduced in 17.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ratio (optional)
Integer Overrides the default ratio of 1. Reduces the percentage the LB algorithm would pick the server in relation to its peers. Range is 1-20. Allowed values are 1-20. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
resolve_fqdn_to_v6 (optional)
Boolean This field indicates if the fqdn should be resolved to a v6 or a v4 address family. . Field introduced in 18.2.8, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vs_uuid (optional)
String Select local virtual service in the specified controller cluster belonging to this GSLB service. The virtual service may have multiple IP addresses and FQDNs. User will have to choose IP address or FQDN and configure it in the respective field. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
application_persistence_profile_ref (optional)
String 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)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
controller_health_status_enabled (optional)
Boolean 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.
created_by (optional)
String Creator name. Field introduced in 17.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
description (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
domain_names (optional)
array[String] 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)
GslbServiceDownResponse Response to the client query when the GSLB service is DOWN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enabled (optional)
Boolean 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.
groups (optional)
array[GslbPool] 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.
health_monitor_refs (optional)
array[String] 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.
health_monitor_scope (optional)
String 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.
hm_off (optional)
Boolean 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.
is_federated (optional)
Boolean 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)
array[RoleFilterMatchLabel] 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.
min_members (optional)
Integer 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. format: int32
name
String Name for the GSLB service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
num_dns_ip (optional)
Integer 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. format: int32
pki_profile_ref (optional)
String 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.
pool_algorithm (optional)
String 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.
resolve_cname (optional)
Boolean 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.
site_persistence_enabled (optional)
Boolean 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.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
topology_policy_enabled (optional)
Boolean 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.
ttl (optional)
Integer 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. format: int32
url (optional)
use_edns_client_subnet (optional)
Boolean 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.
uuid (optional)
String UUID of the GSLB service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
wildcard_match (optional)
Boolean 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.
count
results
next (optional)
fallback_cname (optional)
String Fallback CNAME to use in response to the client query when the GSLB service is DOWN. Field introduced in 22.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
fallback_ip (optional)
IpAddr Fallback IP address to use in A response to the client query when the GSLB service is DOWN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
fallback_ip6 (optional)
IpAddr Fallback IPV6 address to use in AAAA response to the client query when the GSLB service is DOWN. Field introduced in 18.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Response from DNS service towards the client when the GSLB service is DOWN. Enum options - GSLB_SERVICE_DOWN_RESPONSE_NONE, GSLB_SERVICE_DOWN_RESPONSE_ALL_RECORDS, GSLB_SERVICE_DOWN_RESPONSE_FALLBACK_IP, GSLB_SERVICE_DOWN_RESPONSE_EMPTY, GSLB_SERVICE_DOWN_RESPONSE_CNAME. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
addr
String IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key
String Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String Value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key
String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.