Skip to content

gslbvserver_gslbservice_binding

Binding object showing the gslbservice that can be bound to gslbvserver.

Properties

(click to see Operations)

NameData TypePermissionsDescription
weight<Double>Read-writeWeight to assign to the GSLB service.
Minimum value = 1
Maximum value = 100
name<String>Read-writeName of the virtual server on which to perform the binding operation.
Minimum length = 1
servicename<String>Read-writeName of the GSLB service for which to change the weight.
Minimum length = 1
domainname<String>Read-writeDomain name for which to change the time to live (TTL) and/or backup service IP address.
Minimum length = 1
cnameentry<String>Read-onlyThe cname of the gslb service.
svcsitepersistence<String>Read-onlyType of Site Persistence set on the bound service.
Possible values = ConnectionProxy, HTTPRedirect, NONE
gslbboundsvctype<String>Read-onlyProtocol 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
preferredlocation<String>Read-onlyThe 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.
dynamicconfwt<Double>Read-onlyWeight obtained by the virtue of bound service count or weight.
cumulativeweight<Double>Read-onlyCumulative 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 .
gslbthreshold<Integer>Read-onlyIndicates if gslb svc has reached threshold.
sitepersistcookie<String>Read-onlyThis field is introduced for displaying the cookie in cluster setup.
Minimum length = 1
port<Integer>Read-onlyPort number.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
iscname<String>Read-onlyis cname feature set on vserver.
Possible values = ENABLED, DISABLED
curstate<String>Read-onlyState 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
svreffgslbstate<String>Read-onlyEffective 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
thresholdvalue<Integer>Read-onlyTells whether threshold exceeded for this service participating in CUSTOMLB.
ipaddress<String>Read-onlyIP address.
__count<Double>Read-onlycount 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

add:

URL:http://<Citrix-ADC-IP-address(NSIP)/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":<Double_value>,
"domainname":<String_value>
}}

Response:

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

delete:

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/gslbvserver_gslbservice_binding/name_value<String>

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the error

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/gslbvserver_gslbservice_binding/name_value<String>

Query-parameters:

filter

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC. Filtering can be done on any of the properties of the resource.

pagination

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "gslbvserver_gslbservice_binding": [ {
"weight":<Double_value>,
"name":<String_value>,
"servicename":<String_value>,
"domainname":<String_value>,
"cnameentry":<String_value>,
"svcsitepersistence":<String_value>,
"gslbboundsvctype":<String_value>,
"preferredlocation":<String_value>,
"dynamicconfwt":<Double_value>,
"cumulativeweight":<Double_value>,
"gslbthreshold":<Integer_value>,
"sitepersistcookie":<String_value>,
"port":<Integer_value>,
"iscname":<String_value>,
"curstate":<String_value>,
"svreffgslbstate":<String_value>,
"thresholdvalue":<Integer_value>,
"ipaddress":<String_value>
}]}

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/gslbvserver_gslbservice_binding

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/gslbvserver_gslbservice_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "gslbvserver_gslbservice_binding": [ {
"weight":<Double_value>,
"name":<String_value>,
"servicename":<String_value>,
"domainname":<String_value>,
"cnameentry":<String_value>,
"svcsitepersistence":<String_value>,
"gslbboundsvctype":<String_value>,
"preferredlocation":<String_value>,
"dynamicconfwt":<Double_value>,
"cumulativeweight":<Double_value>,
"gslbthreshold":<Integer_value>,
"sitepersistcookie":<String_value>,
"port":<Integer_value>,
"iscname":<String_value>,
"curstate":<String_value>,
"svreffgslbstate":<String_value>,
"thresholdvalue":<Integer_value>,
"ipaddress":<String_value>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

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