Skip to content

gslbdomain_gslbvserver_binding

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

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeName of the Domain.
Minimum length = 1
vservername<String>Read-write.
sitename<String>Read-onlyName of the site to which the service belongs.
backuplbmethod<String>Read-onlyIndicates the backup method in case the primary fails.
Possible values = ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, SOURCEIPHASH, LEASTBANDWIDTH, LEASTPACKETS, STATICPROXIMITY, RTT, CUSTOMLOAD
customheaders<String>Read-onlyThe string that is sent to the service. Applicable to HTTP ,HTTP-ECV and RTSP monitor types.
persistenceid<Double>Read-onlyPersistence id of the gslb vserver.
state<String>Read-onlyThe 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<String>Read-onlySend clients an empty DNS response when the GSLB virtual server is DOWN.
Default value: DISABLED
Possible values = ENABLED, DISABLED
lbmethod<String>Read-onlyThe load balancing method set for the virtual server.
Possible values = ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, SOURCEIPHASH, LEASTBANDWIDTH, LEASTPACKETS, STATICPROXIMITY, RTT, CUSTOMLOAD
cip<String>Read-onlyIndicates if Client IP option is enabled.
Possible values = ENABLED, DISABLED
statechangetimesec<String>Read-onlyTime since last state change.
netmask<String>Read-onlyNetmask.
Minimum length = 1
dnsrecordtype<String>Read-onlyThe IP type for this GSLB vserver.
Possible values = A, AAAA, CNAME, NAPTR
persistmask<String>Read-onlyThe optional IPv4 network mask applied to IPv4 addresses to establish source IP address based persistence.
Minimum length = 1
sitepersistence<String>Read-onlyIndicates the type of cookie persistence set.
Possible values = ConnectionProxy, HTTPRedirect, NONE
servicetype<String>Read-onlyThe 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<Double>Read-onlyNumber 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<Double>Read-onlyNumber 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<String>Read-onlyIndicates if persistence is set on the gslb vserver.
Possible values = SOURCEIP, NONE
siteprefix<String>Read-onlyThe site prefix string.
dynamicweight<String>Read-onlyDynamic weight method of the vserver.
Default value: DISABLED
Possible values = SERVICECOUNT, SERVICEWEIGHT, DISABLED
mir<String>Read-only.
Default value: DISABLED
Possible values = ENABLED, DISABLED
__count<Double>Read-onlycount 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>
}]}

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:

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>
}]}

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:

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": [ { "__count": "#no"} ] }