gslbvserver_gslbservice_binding

Last published : Oct 30, 2026
Binding object showing the gslbservice that can be bound to gslbvserver.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
servicename <String> Read-write Name of the GSLB service for which to change the weight.
Minimum length = 1
domainname <String> Read-write Domain name for which to change the time to live (TTL) and/or backup service IP address.
Minimum length = 1
order <Integer> Read-write Order number to be assigned to the service when it is bound to the lb vserver.
Minimum value = 1
Maximum value = 8192
name <String> Read-write Name of the virtual server on which to perform the binding operation.
Minimum length = 1
weight <Integer> Read-write Weight for the service.
Minimum value = 1
Maximum value = 100
gslbthreshold <Integer> Read-only Indicates if gslb svc has reached threshold.
thresholdvalue <Integer> Read-only Tells whether threshold exceeded for this service participating in CUSTOMLB.
orderstr <String> Read-only Order number in string form assigned to the service when it is bound to the lb vserver.
dynamicconfwt <Integer> Read-only Weight obtained by the virtue of bound service count or weight.
svreffgslbstate <String> Read-only Effective state of the gslb svc.
Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED
preferredlocation <String> Read-only The target site to be returned in the DNS response when a policy is successfully evaluated against the incoming DNS request. Target site is specified in dotted notation with up to 6 qualifiers. Wildcard `*' is accepted as a valid qualifier token.
iscname <String> Read-only is cname feature set on vserver.
Possible values = ENABLED, DISABLED
gslbboundsvctype <String> Read-only Protocol used by services bound to the GSLBvirtual 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
cnameentry <String> Read-only The cname of the gslb service.
svcsitepersistence <String> Read-only Type of Site Persistence set on the bound service.
Possible values = ConnectionProxy, HTTPRedirect, NONE
cumulativeweight <Integer> Read-only Cumulative weight is the weight of GSLB service considering both its configured weight and dynamic weight. It is equal to product of dynamic weight and configured weight of the gslb service .
port <Integer> Read-only Port number.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
ipaddress <String> Read-only IP address.
sitepersistcookie <String> Read-only This field is introduced for displaying the cookie in cluster setup.
Minimum length = 1
curstate <String> 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
__count <Double> Read-only count parameter

Operations

(click to see Properties )
  • ADD
  • DELETE
  • GET
  • GET (ALL)
  • COUNT
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_gslbservice_binding HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{
"gslbvserver_gslbservice_binding":{
<b>"name":<String_value>,
</b>"servicename":<String_value>,
"weight":<Integer_value>,
"domainname":<String_value>,
"order":<Integer_value>
}}
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_gslbservice_binding/ name_value<String> Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver_gslbservice_binding/ name_value<String> ? args=servicename: <String_value> ,domainname: <String_value>
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

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver_gslbservice_binding/ name_value<String> Query-parameters: filter http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver_gslbservice_binding/ name_value<String> ? filter=property-name1:property-value1,property-name2:property-value2
Use this query-parameter to get the filtered set of gslbvserver_gslbservice_binding resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
pagination http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver_gslbservice_binding/ name_value<String> ? pagesize=#no;pageno=#no
Use this query-parameter to get the gslbvserver_gslbservice_binding 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_gslbservice_binding": [ {
"servicename":<String_value>,
"domainname":<String_value>,
"order":<Integer_value>,
"name":<String_value>,
"weight":<Integer_value>,
"gslbthreshold":<Integer_value>,
"thresholdvalue":<Integer_value>,
"orderstr":<String_value>,
"dynamicconfwt":<Integer_value>,
"svreffgslbstate":<String_value>,
"preferredlocation":<String_value>,
"iscname":<String_value>,
"gslbboundsvctype":<String_value>,
"cnameentry":<String_value>,
"svcsitepersistence":<String_value>,
"cumulativeweight":<Integer_value>,
"port":<Integer_value>,
"ipaddress":<String_value>,
"sitepersistcookie":<String_value>,
"curstate":<String_value>
}]}

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver_gslbservice_binding HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Query-parameters: bulkbindings http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver_gslbservice_binding? bulkbindings=yes
NITRO allows you to fetch bindings in bulk.
Note: get (all) method can be used only in conjuction with bulkbindings query parameter.
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_gslbservice_binding": [ {
"servicename":<String_value>,
"domainname":<String_value>,
"order":<Integer_value>,
"name":<String_value>,
"weight":<Integer_value>,
"gslbthreshold":<Integer_value>,
"thresholdvalue":<Integer_value>,
"orderstr":<String_value>,
"dynamicconfwt":<Integer_value>,
"svreffgslbstate":<String_value>,
"preferredlocation":<String_value>,
"iscname":<String_value>,
"gslbboundsvctype":<String_value>,
"cnameentry":<String_value>,
"svcsitepersistence":<String_value>,
"cumulativeweight":<Integer_value>,
"port":<Integer_value>,
"ipaddress":<String_value>,
"sitepersistcookie":<String_value>,
"curstate":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver_gslbservice_binding/ name_value<String> ? 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_gslbservice_binding": [ { "__count": "#no"} ] }