Download full document:

gslbsite

Statistics for GSLB site resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
sitename<String>Read-writeName of the GSLB site for which to display detailed statistics. If a name is not specified, basic information about all GSLB sites is displayed.
Minimum length = 1
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
sitepublicip<String>Read-onlyThe public IP address of this GSLB site.
siteip<String>Read-onlyThe private IP address of this GSLB site.
sitemepstatus<String>Read-onlyIndicates the status of the Metric Exchange Policy at this GSLB site.
persexchange<String>Read-onlyIndicates whether Persistence entries exchange is enabled or disabled at this GSLB site.
nwmetricexchange<String>Read-onlyIndicates whether network metric exchange is enabled or disabled at this GSLB site.
sitemetricexchange<String>Read-onlyIndicates whether metric exchange is enabled or disabled at this GSLB site.
sitetype<String>Read-onlyIndicates whether this GSLB site is local or remote.
siteipstr<String>Read-onlyThe private IP address of this GSLB site.
sitepublicipstr<String>Read-onlyThe public IP address of this GSLB site.
sitemetricmepstatus<String>Read-onlyIndicates the status of the site metric Metric Exchange connection at this GSLB site.
nwmetricmepstatus<String>Read-onlyIndicates the status of the network metric Metric Exchange connection at this GSLB site.
sitetotalrequestbytes<Double>Read-onlyTotal number of request bytes received by the virtual servers represented by all GSLB services associated with this GSLB site.
siterequestbytesrate<Double>Read-onlyRate (/s) counter for sitetotalrequestbytes
sitetotalresponsebytes<Double>Read-onlyNumber of response bytes received by the virtual servers represented by all GSLB services associated with this GSLB site.
siteresponsebytesrate<Double>Read-onlyRate (/s) counter for sitetotalresponsebytes
sitetotalrequests<Double>Read-onlyTotal number of requests received by the virtual servers represented by all GSLB services associated with this GSLB site.
siterequestsrate<Double>Read-onlyRate (/s) counter for sitetotalrequests
sitetotalresponses<Double>Read-onlyNumber of responses received by the virtual servers represented by all GSLB services associated with this GSLB site.
siteresponsesrate<Double>Read-onlyRate (/s) counter for sitetotalresponses
sitecurclntconnections<Double>Read-onlyNumber of current client connections to the virtual servers represented by all GSLB services associated with this GSLB site.
sitecursrvrconnections<Double>Read-onlyNumber of current connections to the real servers behind the virtual servers represented by all GSLB services associated with this GSLB site.

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/gslbsite

Query-parameters:

args

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

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

{ "gslbsite": [ {
"sitename":<String_value>,
"siteresponsesrate":<Double_value>,
"siteipstr":<String_value>,
"sitetotalrequests":<Double_value>,
"siterequestsrate":<Double_value>,
"nwmetricmepstatus":<String_value>,
"sitemetricexchange":<String_value>,
"sitepublicip":<String_value>,
"sitetotalresponsebytes":<Double_value>,
"sitecursrvrconnections":<Double_value>,
"sitepublicipstr":<String_value>,
"sitetotalrequestbytes":<Double_value>,
"siteip":<String_value>,
"sitemepstatus":<String_value>,
"sitecurclntconnections":<Double_value>,
"sitetype":<String_value>,
"nwmetricexchange":<String_value>,
"persexchange":<String_value>,
"siterequestbytesrate":<Double_value>,
"siteresponsebytesrate":<Double_value>,
"sitetotalresponses":<Double_value>,
"sitemetricmepstatus":<String_value>
}]}

get

URL:http://<netscaler-ip-address>/nitro/v1/stat/gslbsite/sitename_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:

{ "gslbsite": [ {
"sitename":<String_value>,
"siteresponsesrate":<Double_value>,
"siteipstr":<String_value>,
"sitetotalrequests":<Double_value>,
"siterequestsrate":<Double_value>,
"nwmetricmepstatus":<String_value>,
"sitemetricexchange":<String_value>,
"sitepublicip":<String_value>,
"sitetotalresponsebytes":<Double_value>,
"sitecursrvrconnections":<Double_value>,
"sitepublicipstr":<String_value>,
"sitetotalrequestbytes":<Double_value>,
"siteip":<String_value>,
"sitemepstatus":<String_value>,
"sitecurclntconnections":<Double_value>,
"sitetype":<String_value>,
"nwmetricexchange":<String_value>,
"persexchange":<String_value>,
"siterequestbytesrate":<Double_value>,
"siteresponsebytesrate":<Double_value>,
"sitetotalresponses":<Double_value>,
"sitemetricmepstatus":<String_value>
}]}