Download full document:

gslbservice

Statistics for GSLB service resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
servicename<String>Read-writeName of the GSLB service.
Minimum length = 1
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
establishedconn<Double>Read-onlyNumber of client connections in ESTABLISHED state.
primaryipaddress<String>Read-onlyThe IP address on which the service is running.
primaryport<Integer>Read-onlyThe port on which the service is running.
servicetype<String>Read-onlyThe service type of this service.Possible values are ADNS, DNS, MYSQL, RTSP, SSL_DIAMETER, ADNS_TCP, DNS_TCP, NNTP, SIP_UDP, SSL_TCP, ANY, FTP, RADIUS, SNMP, TCP, DHCPRA, HTTP, RDP, SSL, TFTP, DIAMETER, MSSQL, RPCSVR, SSL_BRIDGE, UDP
state<String>Read-onlyCurrent state of the server. Possible values are UP, DOWN, UNKNOWN, OFS(Out of Service), TROFS(Transition Out of Service), TROFS_DOWN(Down When going Out of Service)
totalrequestbytes<Double>Read-onlyTotal number of request bytes received on this service or virtual server.
requestbytesrate<Double>Read-onlyRate (/s) counter for totalrequestbytes
totalresponsebytes<Double>Read-onlyNumber of response bytes received by this service or virtual server.
responsebytesrate<Double>Read-onlyRate (/s) counter for totalresponsebytes
curload<Double>Read-onlyLoad on the service that is calculated from the bound load based monitor.
totalrequests<Double>Read-onlyTotal number of requests received on this service or virtual server. (This applies to HTTP/SSL services and servers.)
requestsrate<Double>Read-onlyRate (/s) counter for totalrequests
totalresponses<Double>Read-onlyNumber of responses received on this service or virtual server. (This applies to HTTP/SSL services and servers.)
responsesrate<Double>Read-onlyRate (/s) counter for totalresponses
curclntconnections<Double>Read-onlyNumber of current client connections.
cursrvrconnections<Double>Read-onlyNumber of current connections to the actual servers behind the virtual server.
vsvrservicehits<Double>Read-onlyNumber of times that the service has been provided.
vsvrservicehitsrate<Double>Read-onlyRate (/s) counter for vsvrservicehits

Operations

(click to see Properties)

GET (ALL)| GET

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 (all)

URL:http://<netscaler-ip-address>/nitro/v1/stat/gslbservice

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/stat/gslbservice?args=servicename:<String_value>,detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get gslbservice resources based on additional properties.

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:

{ "gslbservice": [ {
"servicename":<String_value>,
"curclntconnections":<Double_value>,
"servicetype":<String_value>,
"establishedconn":<Double_value>,
"totalrequests":<Double_value>,
"responsebytesrate":<Double_value>,
"totalresponses":<Double_value>,
"requestbytesrate":<Double_value>,
"cursrvrconnections":<Double_value>,
"primaryipaddress":<String_value>,
"responsesrate":<Double_value>,
"curload":<Double_value>,
"totalrequestbytes":<Double_value>,
"state":<String_value>,
"vsvrservicehits":<Double_value>,
"totalresponsebytes":<Double_value>,
"primaryport":<Integer_value>,
"requestsrate":<Double_value>,
"vsvrservicehitsrate":<Double_value>
}]}

get

URL:http://<netscaler-ip-address>/nitro/v1/stat/gslbservice/servicename_value><String>

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:

{ "gslbservice": [ {
"servicename":<String_value>,
"curclntconnections":<Double_value>,
"servicetype":<String_value>,
"establishedconn":<Double_value>,
"totalrequests":<Double_value>,
"responsebytesrate":<Double_value>,
"totalresponses":<Double_value>,
"requestbytesrate":<Double_value>,
"cursrvrconnections":<Double_value>,
"primaryipaddress":<String_value>,
"responsesrate":<Double_value>,
"curload":<Double_value>,
"totalrequestbytes":<Double_value>,
"state":<String_value>,
"vsvrservicehits":<Double_value>,
"totalresponsebytes":<Double_value>,
"primaryport":<Integer_value>,
"requestsrate":<Double_value>,
"vsvrservicehitsrate":<Double_value>
}]}