Skip to content

gslbdomain_gslbservice_binding

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

Properties

(click to see Operations )

Name Data Type Permissions Description
name <String> Read-write Name of the Domain.

Minimum length = 1
servicename <String> Read-write The service name.
cnameentry <String> Read-only The cname of the gslb service.
gslbthreshold <Integer> Read-only The threshold value of the service.
port <Integer> Read-only Port Number.

Minimum value = 1

Range 1 - 65535

* in CLI is represented as 65535 in NITRO API
state <String> 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
vservername <String> Read-only .
svreffgslbstate <String> Read-only GSLB server state.

Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED
dynamicconfwt <Double> Read-only dynamic weight.
weight <Double> Read-only weight assigned.

Minimum value = 1

Maximum value = 100
ipaddress <String> Read-only The Ip address of the service.
servicetype <String> 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
cumulativeweight <Double> Read-only cumlative weight.
__count <Double> 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 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

get

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

Query-parameters:

filter

http:// <netscaler-ip-address> /nitro/v1/config/gslbdomain_gslbservice_binding/ name_value<String> ? filter=property-name1:property-value1,property-name2:property-value2

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

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

{  "gslbdomain_gslbservice_binding": [ {
      "name":<String_value>,
      "servicename":<String_value>,
      "cnameentry":<String_value>,
      "gslbthreshold":<Integer_value>,
      "port":<Integer_value>,
      "state":<String_value>,
      "vservername":<String_value>,
      "svreffgslbstate":<String_value>,
      "dynamicconfwt":<Double_value>,
      "weight":<Double_value>,
      "ipaddress":<String_value>,
      "servicetype":<String_value>,
      "cumulativeweight":<Double_value>
}]}

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbdomain_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/gslbdomain_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:

{  "gslbdomain_gslbservice_binding": [ {
      "name":<String_value>,
      "servicename":<String_value>,
      "cnameentry":<String_value>,
      "gslbthreshold":<Integer_value>,
      "port":<Integer_value>,
      "state":<String_value>,
      "vservername":<String_value>,
      "svreffgslbstate":<String_value>,
      "dynamicconfwt":<Double_value>,
      "weight":<Double_value>,
      "ipaddress":<String_value>,
      "servicetype":<String_value>,
      "cumulativeweight":<Double_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbdomain_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:

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