ADC NITRO APIs

gslbvserver

August 17, 2023

Contributed by:

Configuration for Global Server Load Balancing Virtual Server resource.

Properties

(click to see Operations )

Name	Permissions	Description
name	Read-write	Name for the GSLB virtual server. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Can be changed after the virtual server is created. CLI Users If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my vserver” or ‘my vserver’). Minimum length = 1
servicetype	Read-write	Protocol used by services bound to the virtual server. Possible values = HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, NNTP, ANY, SIP_UDP, SIP_TCP, SIP_SSL, RADIUS, RDP, RTSP, MYSQL, MSSQL, ORACLE
iptype	Read-write	The IP type for this GSLB vserver. Default value: IPV4 Possible values = IPV4, IPV6
dnsrecordtype	Read-write	DNS record type to associate with the GSLB virtual server’s domain name. Default value: A Possible values = A, AAAA, CNAME, NAPTR
lbmethod	Read-write	Load balancing method for the GSLB virtual server. Default value: LEASTCONNECTION Possible values = ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, SOURCEIPHASH, LEASTBANDWIDTH, LEASTPACKETS, STATICPROXIMITY, RTT, CUSTOMLOAD, API
backupsessiontimeout	Read-write	A non zero value enables the feature whose minimum value is 2 minutes. The feature can be disabled by setting the value to zero. The created session is in effect for a specific client per domain. Minimum value = 0 Maximum value = 1440
backuplbmethod	Read-write	Backup load balancing method. Becomes operational if the primary load balancing method fails or cannot be used. Valid only if the primary method is based on either round-trip time (RTT) or static proximity. Possible values = ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, SOURCEIPHASH, LEASTBANDWIDTH, LEASTPACKETS, STATICPROXIMITY, RTT, CUSTOMLOAD, API
netmask	Read-write	IPv4 network mask for use in the SOURCEIPHASH load balancing method. Minimum length = 1
v6netmasklen	Read-write	Number of bits to consider, in an IPv6 source IP address, for creating the hash that is required by the SOURCEIPHASH load balancing method. Default value: 128 Minimum value = 1 Maximum value = 128
rule	Read-write	Expression, or name of a named expression, against which traffic is evaluated. This field is applicable only if gslb method or gslb backup method are set to API. The following requirements apply only to the Citrix ADC CLI If the expression includes one or more spaces, enclose the entire expression in double quotation marks. If the expression itself includes double quotation marks, escape the quotations by using the \ character. Alternatively, you can use single quotation marks to enclose the rule, in which case you do not have to escape the double quotation marks. Default value: “none”
tolerance	Read-write	Site selection tolerance, in milliseconds, for implementing the RTT load balancing method. If a site’s RTT deviates from the lowest RTT by more than the specified tolerance, the site is not considered when the Citrix ADC makes a GSLB decision. The appliance implements the round robin method of global server load balancing between sites whose RTT values are within the specified tolerance. If the tolerance is 0 (zero), the appliance always sends clients the IP address of the site with the lowest RTT. Minimum value = 0 Maximum value = 100
persistencetype	Read-write	Use source IP address based persistence for the virtual server. After the load balancing method selects a service for the first packet, the IP address received in response to the DNS query is used for subsequent requests from the same client. Possible values = SOURCEIP, NONE
persistenceid	Read-write	The persistence ID for the GSLB virtual server. The ID is a positive integer that enables GSLB sites to identify the GSLB virtual server, and is required if source IP address based or spill over based persistence is enabled on the virtual server. Minimum value = 0 Maximum value = 65535
persistmask	Read-write	The optional IPv4 network mask applied to IPv4 addresses to establish source IP address based persistence. Minimum length = 1
v6persistmasklen	Read-write	Number of bits to consider in an IPv6 source IP address when creating source IP address based persistence sessions. Default value: 128 Minimum value = 1 Maximum value = 128
timeout	Read-write	Idle time, in minutes, after which a persistence entry is cleared. Default value: 2 Minimum value = 2 Maximum value = 1440
edr	Read-write	Send clients an empty DNS response when the GSLB virtual server is DOWN. Default value: DISABLED Possible values = ENABLED, DISABLED
ecs	Read-write	If enabled, respond with EDNS Client Subnet (ECS) option in the response for a DNS query with ECS. The ECS address will be used for persistence and spillover persistence (if enabled) instead of the LDNS address. Persistence mask is ignored if ECS is enabled. Default value: DISABLED Possible values = ENABLED, DISABLED
ecsaddrvalidation	Read-write	Validate if ECS address is a private or unroutable address and in such cases, use the LDNS IP. Default value: DISABLED Possible values = ENABLED, DISABLED
mir	Read-write	Include multiple IP addresses in the DNS responses sent to clients. Default value: DISABLED Possible values = ENABLED, DISABLED
disableprimaryondown	Read-write	Continue to direct traffic to the backup chain even after the primary GSLB virtual server returns to the UP state. Used when spillover is configured for the virtual server. Default value: DISABLED Possible values = ENABLED, DISABLED
dynamicweight	Read-write	Specify if the appliance should consider the service count, service weights, or ignore both when using weight-based load balancing methods. The state of the number of services bound to the virtual server help the appliance to select the service. Default value: DISABLED Possible values = SERVICECOUNT, SERVICEWEIGHT, DISABLED
state	Read-write	State of the GSLB virtual server. Default value: ENABLED Possible values = ENABLED, DISABLED
considereffectivestate	Read-write	If the primary state of all bound GSLB services is DOWN, consider the effective states of all the GSLB services, obtained through the Metrics Exchange Protocol (MEP), when determining the state of the GSLB virtual server. To consider the effective state, set the parameter to STATE_ONLY. To disregard the effective state, set the parameter to NONE. The effective state of a GSLB service is the ability of the corresponding virtual server to serve traffic. The effective state of the load balancing virtual server, which is transferred to the GSLB service, is UP even if only one virtual server in the backup chain of virtual servers is in the UP state. Default value: NONE Possible values = NONE, STATE_ONLY
comment	Read-write	Any comments that you might want to associate with the GSLB virtual server.
somethod	Read-write	Type of threshold that, when exceeded, triggers spillover. Available settings function as follows CONNECTION - Spillover occurs when the number of client connections exceeds the threshold. DYNAMICCONNECTION - Spillover occurs when the number of client connections at the GSLB virtual server exceeds the sum of the maximum client (Max Clients) settings for bound GSLB services. Do not specify a spillover threshold for this setting, because the threshold is implied by the Max Clients settings of the bound GSLB services. BANDWIDTH - Spillover occurs when the bandwidth consumed by the GSLB virtual server’s incoming and outgoing traffic exceeds the threshold. HEALTH - Spillover occurs when the percentage of weights of the GSLB services that are UP drops below the threshold. For example, if services gslbSvc1, gslbSvc2, and gslbSvc3 are bound to a virtual server, with weights 1, 2, and 3, and the spillover threshold is 50%, spillover occurs if gslbSvc1 and gslbSvc3 or gslbSvc2 and gslbSvc3 transition to DOWN. NONE - Spillover does not occur. Possible values = CONNECTION, DYNAMICCONNECTION, BANDWIDTH, HEALTH, NONE
sopersistence	Read-write	If spillover occurs, maintain source IP address based persistence for both primary and backup GSLB virtual servers. Default value: DISABLED Possible values = ENABLED, DISABLED
sopersistencetimeout	Read-write	Timeout for spillover persistence, in minutes. Default value: 2 Minimum value = 2 Maximum value = 1440
sothreshold	Read-write	Threshold at which spillover occurs. Specify an integer for the CONNECTION spillover method, a bandwidth value in kilobits per second for the BANDWIDTH method (do not enter the units), or a percentage for the HEALTH method (do not enter the percentage symbol). Minimum value = 1 Maximum value = 4294967287
sobackupaction	Read-write	Action to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists. Possible values = DROP, ACCEPT, REDIRECT
appflowlog	Read-write	Enable logging appflow flow information. Default value: ENABLED Possible values = ENABLED, DISABLED
backupvserver	Read-write	Name of the backup GSLB virtual server to which the appliance should to forward requests if the status of the primary GSLB virtual server is down or exceeds its spillover threshold. Minimum length = 1
servicename	Read-write	Name of the GSLB service for which to change the weight. Minimum length = 1
weight	Read-write	Weight to assign to the GSLB service. Minimum value = 1 Maximum value = 100
domainname	Read-write	Domain name for which to change the time to live (TTL) and/or backup service IP address. Minimum length = 1
ttl	Read-write	Time to live (TTL) for the domain. Minimum value = 1
backupip	Read-write	The IP address of the backup service for the specified domain name. Used when all the services bound to the domain are down, or when the backup chain of virtual servers is down. Minimum length = 1
cookie_domain	Read-write	The cookie domain for the GSLB site. Used when inserting the GSLB site cookie in the HTTP response. Minimum length = 1
cookietimeout	Read-write	Timeout, in minutes, for the GSLB site cookie. Minimum value = 0 Maximum value = 1440
sitedomainttl	Read-write	TTL, in seconds, for all internally created site domains (created when a site prefix is configured on a GSLB service) that are associated with this virtual server. Minimum value = 1
newname	Read-write	New name for the GSLB virtual server. Minimum length = 1
curstate	Read-only	State of the gslb vserver. Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED
status	Read-only	Current status of the gslb vserver. During the initial phase if the configured lb method is not round robin , the vserver will adopt round robin to distribute traffic for a predefined number of requests.
lbrrreason	Read-only	Reason why a vserver is in RR. The following are the reasons 1 - MEP is DOWN (GSLB) 2 - LB method has changed 3 - Bound service’s state changed to UP 4 - A new service is bound 5 - Startup RR factor has changed 6 - LB feature is enabled 7 - Load monitor is not active on a service 8 - Vserver is Enabled 9 - SSL feature is Enabled 10 - All bound services have reached threshold. Using effective state to load balance (GSLB) 11 - Primary state of bound services are not UP. Using effective state to load balance (GSLB) 12 - No LB decision can be made as all bound services have either reached threshold or are not UP (GSLB) 13 - All load monitors are active .
iscname	Read-only	is cname feature set on vserver. Possible values = ENABLED, DISABLED
sitepersistence	Read-only	Type of Site Persistence set. Possible values = ConnectionProxy, HTTPRedirect, NONE
totalservices	Read-only	Total number of services bound to the vserver.
activeservices	Read-only	Total number of active services bound to the vserver.
statechangetimesec	Read-only	Time when last state change happened. Seconds part.
statechangetimemsec	Read-only	Time at which last state change happened. Milliseconds part.
tickssincelaststatechange	Read-only	Time in 10 millisecond ticks since the last state change.
health	Read-only	Health of vserver based on percentage of weights of active svcs/all svcs. This does not consider administratively disabled svcs.
policyname	Read-only	Name of the policy bound to the GSLB vserver.
priority	Read-only	Priority. Minimum value = 1 Maximum value = 2147483647
gotopriorityexpression	Read-only	Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE. o If gotoPriorityExpression is not present or if it is equal to END then the policy bank evaluation ends here o Else if the gotoPriorityExpression is equal to NEXT then the next policy in the priority order is evaluated. o Else gotoPriorityExpression is evaluated. The result of gotoPriorityExpression (which has to be a number) is processed as follows An UNDEF event is triggered if . gotoPriorityExpression cannot be evaluated . gotoPriorityExpression evaluates to number which is smaller than the maximum priority in the policy bank but is not same as any policy’s priority . gotoPriorityExpression evaluates to a priority that is smaller than the current policy’s priority If the gotoPriorityExpression evaluates to the priority of the current policy then the next policy in the priority order is evaluated. If the gotoPriorityExpression evaluates to the priority of a policy further ahead in the list then that policy will be evaluated next. This field is applicable only to rewrite and responder policies.
type	Read-only	The bindpoint to which the policy is bound. Possible values = REQUEST, RESPONSE
vsvrbindsvcip	Read-only	used for showing the ip of bound entities.
vsvrbindsvcport	Read-only	used for showing ports of bound entities. Range 1 - 65535 * in CLI is represented as 65535 in NITRO API
servername	Read-only	This field is used to display server name in case of GSLB servicegroup binding to GSLB vserver .
nodefaultbindings	Read-only	to determine if the configuration will have default ssl CIPHER and ECC curve bindings. Default value: NO Possible values = YES, NO
__count	Read-only	count parameter

Operations

(click to see Properties )

ADD
DELETE
UPDATE
UNSET
ENABLE
DISABLE
GET (ALL)
GET
COUNT
RENAME

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

To do this, you must specify the username and password in the request header of the NITRO request as follows:

X-NITRO-USER: <username>

X-NITRO-PASS: <password>

Note: In such cases, make sure that the request header DOES not include the following:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note:*

Mandatory parameters are marked in red and placeholder content is marked in green

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"gslbvserver":{
<b>      "name":<String_value>,
</b><b>      "servicetype":<String_value>,
</b>      "iptype":<String_value>,
      "dnsrecordtype":<String_value>,
      "lbmethod":<String_value>,
      "backupsessiontimeout":<Double_value>,
      "backuplbmethod":<String_value>,
      "netmask":<String_value>,
      "v6netmasklen":<Double_value>,
      "rule":<String_value>,
      "tolerance":<Double_value>,
      "persistencetype":<String_value>,
      "persistenceid":<Double_value>,
      "persistmask":<String_value>,
      "v6persistmasklen":<Double_value>,
      "timeout":<Double_value>,
      "edr":<String_value>,
      "ecs":<String_value>,
      "ecsaddrvalidation":<String_value>,
      "mir":<String_value>,
      "disableprimaryondown":<String_value>,
      "dynamicweight":<String_value>,
      "state":<String_value>,
      "considereffectivestate":<String_value>,
      "comment":<String_value>,
      "somethod":<String_value>,
      "sopersistence":<String_value>,
      "sopersistencetimeout":<Double_value>,
      "sothreshold":<Double_value>,
      "sobackupaction":<String_value>,
      "appflowlog":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver/ name_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"gslbvserver":{
<b>      "name":<String_value>,
</b>      "iptype":<String_value>,
      "dnsrecordtype":<String_value>,
      "backupvserver":<String_value>,
      "backupsessiontimeout":<Double_value>,
      "lbmethod":<String_value>,
      "backuplbmethod":<String_value>,
      "netmask":<String_value>,
      "v6netmasklen":<Double_value>,
      "tolerance":<Double_value>,
      "persistencetype":<String_value>,
      "persistenceid":<Double_value>,
      "persistmask":<String_value>,
      "v6persistmasklen":<Double_value>,
      "timeout":<Double_value>,
      "edr":<String_value>,
      "ecs":<String_value>,
      "ecsaddrvalidation":<String_value>,
      "mir":<String_value>,
      "disableprimaryondown":<String_value>,
      "dynamicweight":<String_value>,
      "considereffectivestate":<String_value>,
      "somethod":<String_value>,
      "sopersistence":<String_value>,
      "sopersistencetimeout":<Double_value>,
      "sothreshold":<Double_value>,
      "sobackupaction":<String_value>,
      "servicename":<String_value>,
      "weight":<Double_value>,
      "domainname":<String_value>,
      "ttl":<Double_value>,
      "backupip":<String_value>,
      "cookie_domain":<String_value>,
      "cookietimeout":<Double_value>,
      "sitedomainttl":<Double_value>,
      "comment":<String_value>,
      "appflowlog":<String_value>,
      "rule":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"gslbvserver":{
<b>      "name":<String_value>,
</b>      "backupvserver":true,
      "sothreshold":true,
      "iptype":true,
      "dnsrecordtype":true,
      "backupsessiontimeout":true,
      "lbmethod":true,
      "backuplbmethod":true,
      "netmask":true,
      "v6netmasklen":true,
      "tolerance":true,
      "persistencetype":true,
      "persistenceid":true,
      "persistmask":true,
      "v6persistmasklen":true,
      "timeout":true,
      "edr":true,
      "ecs":true,
      "ecsaddrvalidation":true,
      "mir":true,
      "disableprimaryondown":true,
      "dynamicweight":true,
      "considereffectivestate":true,
      "somethod":true,
      "sopersistence":true,
      "sopersistencetimeout":true,
      "sobackupaction":true,
      "servicename":true,
      "weight":true,
      "comment":true,
      "appflowlog":true,
      "rule":true
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

enable

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver? action=enable

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"gslbvserver":{
<b>      "name":<String_value>
</b>}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

disable

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver? action=disable

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"gslbvserver":{
<b>      "name":<String_value>
</b>}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

rename

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver? action=rename

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"gslbvserver":{
<b>      "name":<String_value>,
</b><b>      "newname":<String_value>
</b>}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of gslbvserver resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver? view=summary

Use this query-parameter to get the summary output of gslbvserver resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver? pagesize=#no;pageno=#no

Use this query-parameter to get the gslbvserver resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "gslbvserver": [ {
      "name":<String_value>,
      "servicetype":<String_value>,
      "state":<String_value>,
      "iptype":<String_value>,
      "dnsrecordtype":<String_value>,
      "persistencetype":<String_value>,
      "persistenceid":<Double_value>,
      "lbmethod":<String_value>,
      "backuplbmethod":<String_value>,
      "tolerance":<Double_value>,
      "timeout":<Double_value>,
      "curstate":<String_value>,
      "netmask":<String_value>,
      "v6netmasklen":<Double_value>,
      "persistmask":<String_value>,
      "v6persistmasklen":<Double_value>,
      "servicename":<String_value>,
      "weight":<Double_value>,
      "domainname":<String_value>,
      "ttl":<Double_value>,
      "backupip":<String_value>,
      "cookie_domain":<String_value>,
      "cookietimeout":<Double_value>,
      "sitedomainttl":<Double_value>,
      "status":<Integer_value>,
      "lbrrreason":<Integer_value>,
      "backupvserver":<String_value>,
      "backupsessiontimeout":<Double_value>,
      "edr":<String_value>,
      "ecs":<String_value>,
      "ecsaddrvalidation":<String_value>,
      "mir":<String_value>,
      "disableprimaryondown":<String_value>,
      "dynamicweight":<String_value>,
      "iscname":<String_value>,
      "sitepersistence":<String_value>,
      "considereffectivestate":<String_value>,
      "totalservices":<Double_value>,
      "activeservices":<Double_value>,
      "statechangetimesec":<String_value>,
      "statechangetimemsec":<Double_value>,
      "tickssincelaststatechange":<Double_value>,
      "comment":<String_value>,
      "sopersistencetimeout":<Double_value>,
      "somethod":<String_value>,
      "sobackupaction":<String_value>,
      "sopersistence":<String_value>,
      "sothreshold":<Double_value>,
      "health":<Double_value>,
      "appflowlog":<String_value>,
      "policyname":<String_value>,
      "priority":<Double_value>,
      "gotopriorityexpression":<String_value>,
      "type":<String_value>,
      "vsvrbindsvcip":<String_value>,
      "vsvrbindsvcport":<Integer_value>,
      "servername":<String_value>,
      "nodefaultbindings":<String_value>,
      "rule":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver/ name_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver/ name_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of gslbvserver resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "gslbvserver": [ {
      "name":<String_value>,
      "servicetype":<String_value>,
      "state":<String_value>,
      "iptype":<String_value>,
      "dnsrecordtype":<String_value>,
      "persistencetype":<String_value>,
      "persistenceid":<Double_value>,
      "lbmethod":<String_value>,
      "backuplbmethod":<String_value>,
      "tolerance":<Double_value>,
      "timeout":<Double_value>,
      "curstate":<String_value>,
      "netmask":<String_value>,
      "v6netmasklen":<Double_value>,
      "persistmask":<String_value>,
      "v6persistmasklen":<Double_value>,
      "servicename":<String_value>,
      "weight":<Double_value>,
      "domainname":<String_value>,
      "ttl":<Double_value>,
      "backupip":<String_value>,
      "cookie_domain":<String_value>,
      "cookietimeout":<Double_value>,
      "sitedomainttl":<Double_value>,
      "status":<Integer_value>,
      "lbrrreason":<Integer_value>,
      "backupvserver":<String_value>,
      "backupsessiontimeout":<Double_value>,
      "edr":<String_value>,
      "ecs":<String_value>,
      "ecsaddrvalidation":<String_value>,
      "mir":<String_value>,
      "disableprimaryondown":<String_value>,
      "dynamicweight":<String_value>,
      "iscname":<String_value>,
      "sitepersistence":<String_value>,
      "considereffectivestate":<String_value>,
      "totalservices":<Double_value>,
      "activeservices":<Double_value>,
      "statechangetimesec":<String_value>,
      "statechangetimemsec":<Double_value>,
      "tickssincelaststatechange":<Double_value>,
      "comment":<String_value>,
      "sopersistencetimeout":<Double_value>,
      "somethod":<String_value>,
      "sobackupaction":<String_value>,
      "sopersistence":<String_value>,
      "sothreshold":<Double_value>,
      "health":<Double_value>,
      "appflowlog":<String_value>,
      "policyname":<String_value>,
      "priority":<Double_value>,
      "gotopriorityexpression":<String_value>,
      "type":<String_value>,
      "vsvrbindsvcip":<String_value>,
      "vsvrbindsvcport":<Integer_value>,
      "servername":<String_value>,
      "nodefaultbindings":<String_value>,
      "rule":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver? count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "gslbvserver": [ { "__count": "#no"} ] }

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

gslbvserver

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

gslbvserver

Properties

Operations

add

delete

update

unset

enable

disable

rename

get (all)

get

count

In this article