Citrix ADC 12.1 NITRO API Reference

gslbdomain_gslbvserver_binding

August 17, 2023

Contributed by:

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

Properties

(click to see Operations)

Name	Permissions	Description
name	Read-write	Name of the Domain. Minimum length = 1
vservername	Read-write	.
sitename	Read-only	Name of the site to which the service belongs.
backuplbmethod	Read-only	Indicates the backup method in case the primary fails. Possible values = ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, SOURCEIPHASH, LEASTBANDWIDTH, LEASTPACKETS, STATICPROXIMITY, RTT, CUSTOMLOAD
customheaders	Read-only	The string that is sent to the service. Applicable to HTTP ,HTTP-ECV and RTSP monitor types.
persistenceid	Read-only	Persistence id of the gslb vserver.
state	Read-only	The state of the 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
edr	Read-only	Send clients an empty DNS response when the GSLB virtual server is DOWN. Default value: DISABLED Possible values = ENABLED, DISABLED
lbmethod	Read-only	The load balancing method set for the virtual server. Possible values = ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, SOURCEIPHASH, LEASTBANDWIDTH, LEASTPACKETS, STATICPROXIMITY, RTT, CUSTOMLOAD
cip	Read-only	Indicates if Client IP option is enabled. Possible values = ENABLED, DISABLED
statechangetimesec	Read-only	Time since last state change.
netmask	Read-only	Netmask. Minimum length = 1
dnsrecordtype	Read-only	The IP type for this GSLB vserver. Possible values = A, AAAA, CNAME, NAPTR
persistmask	Read-only	The optional IPv4 network mask applied to IPv4 addresses to establish source IP address based persistence. Minimum length = 1
sitepersistence	Read-only	Indicates the type of cookie persistence set. Possible values = ConnectionProxy, HTTPRedirect, NONE
servicetype	Read-only	The type GSLB service. 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
v6persistmasklen	Read-only	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
v6netmasklen	Read-only	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
persistencetype	Read-only	Indicates if persistence is set on the gslb vserver. Possible values = SOURCEIP, NONE
siteprefix	Read-only	The site prefix string.
dynamicweight	Read-only	Dynamic weight method of the vserver. Default value: DISABLED Possible values = SERVICECOUNT, SERVICEWEIGHT, DISABLED
mir	Read-only	. Default value: DISABLED Possible values = ENABLED, DISABLED
__count	Read-only	count parameter

Operations

(click to see Properties)

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>.

get

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

Query-parameters:

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/gslbdomain_gslbvserver_binding/name_value<String>?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of gslbdomain_gslbvserver_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/gslbdomain_gslbvserver_binding/name_value<String>?pagesize=#no;pageno=#no

Use this query-parameter to get the gslbdomain_gslbvserver_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:

{ "gslbdomain_gslbvserver_binding": [ {
"name":<String_value>,
"vservername":<String_value>,
"sitename":<String_value>,
"backuplbmethod":<String_value>,
"customheaders":<String_value>,
"persistenceid":<Double_value>,
"state":<String_value>,
"edr":<String_value>,
"lbmethod":<String_value>,
"cip":<String_value>,
"statechangetimesec":<String_value>,
"netmask":<String_value>,
"dnsrecordtype":<String_value>,
"persistmask":<String_value>,
"sitepersistence":<String_value>,
"servicetype":<String_value>,
"v6persistmasklen":<Double_value>,
"v6netmasklen":<Double_value>,
"persistencetype":<String_value>,
"siteprefix":<String_value>,
"dynamicweight":<String_value>,
"mir":<String_value>
}]}

<!--NeedCopy-->

get (all)

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

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/gslbdomain_gslbvserver_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:

Content-Type:application/json

Response Payload:

{ "gslbdomain_gslbvserver_binding": [ {
"name":<String_value>,
"vservername":<String_value>,
"sitename":<String_value>,
"backuplbmethod":<String_value>,
"customheaders":<String_value>,
"persistenceid":<Double_value>,
"state":<String_value>,
"edr":<String_value>,
"lbmethod":<String_value>,
"cip":<String_value>,
"statechangetimesec":<String_value>,
"netmask":<String_value>,
"dnsrecordtype":<String_value>,
"persistmask":<String_value>,
"sitepersistence":<String_value>,
"servicetype":<String_value>,
"v6persistmasklen":<Double_value>,
"v6netmasklen":<Double_value>,
"persistencetype":<String_value>,
"siteprefix":<String_value>,
"dynamicweight":<String_value>,
"mir":<String_value>
}]}

<!--NeedCopy-->

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/gslbdomain_gslbvserver_binding/name_value<String>?count=yes

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

Content-Type:application/json

Response Payload:

{"gslbdomain_gslbvserver_binding": [ { "__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

gslbdomain_gslbvserver_binding

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

gslbdomain_gslbvserver_binding

Properties

Operations

get

get (all)

count

In this article