Download full document:

gslbvserver_gslbservicegroupmember_binding

Binding object showing the gslbservicegroupmember 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
servicegroupname<String>Read-writeThe GSLB service group name bound to the selected GSLB virtual server.
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.
servicetype<String>Read-onlyProtocol used by services bound to the virtual 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
gslbthreshold<Integer>Read-onlyIndicates if gslb svc has reached threshold.
port<Integer>Read-onlyPort number.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
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
dynamicweight<String>Read-onlySpecify if the appliance should consider the service count, service weights, or ignore both when using weight-based load balancing methods. The state of the number of services bound to the virtual server help the appliance to select the service.
Default value: DISABLED
Possible values = SERVICECOUNT, SERVICEWEIGHT, 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)

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 redand placeholder content is marked in <green>.

get

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

Query-parameters:

filter

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

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

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

Content-Type:application/json

Response Payload:

{ "gslbvserver_gslbservicegroupmember_binding": [ {
"weight":<Double_value>,
"name":<String_value>,
"servicegroupname":<String_value>,
"preferredlocation":<String_value>,
"servicetype":<String_value>,
"gslbthreshold":<Integer_value>,
"port":<Integer_value>,
"curstate":<String_value>,
"svreffgslbstate":<String_value>,
"dynamicweight":<String_value>,
"thresholdvalue":<Integer_value>,
"ipaddress":<String_value>
}]}

get (all)

URL:http://<netscaler-ip-address>/nitro/v1/config/gslbvserver_gslbservicegroupmember_binding

Query-parameters:

bulkbindings

http://<netscaler-ip-address>/nitro/v1/config/gslbvserver_gslbservicegroupmember_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 NetScaler-specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "gslbvserver_gslbservicegroupmember_binding": [ {
"weight":<Double_value>,
"name":<String_value>,
"servicegroupname":<String_value>,
"preferredlocation":<String_value>,
"servicetype":<String_value>,
"gslbthreshold":<Integer_value>,
"port":<Integer_value>,
"curstate":<String_value>,
"svreffgslbstate":<String_value>,
"dynamicweight":<String_value>,
"thresholdvalue":<Integer_value>,
"ipaddress":<String_value>
}]}

count

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

Content-Type:application/json

Response Payload:

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