systembw
Statistics for bw resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| clearstats | <String> | Read-write | Clear the statsistics / counters.
Possible values = basic, full |
| httpcltpoolinactive | <Double> | Read-only | No of requests sent from BW client. |
| httpcltpooloutactive | <Double> | Read-only | No of responses Received. |
| httpsvr200okresp | <Double> | Read-only | Number of 200 Ok response sent from the BW appliance. |
| httpsvr200okresprate | <Double> | Read-only | Rate (/s) counter for httpsvr200okresp |
| httpsvr404notfound | <Double> | Read-only | Number of 404 Not Found responses sent |
| httpsvr404notfoundrate | <Double> | Read-only | Rate (/s) counter for httpsvr404notfound |
| httpclterrstray | <Double> | Read-only | Number of stray packets received from server without HTTP request |
| httpclterrstrayrate | <Double> | Read-only | Rate (/s) counter for httpclterrstray |
| httpcltttfplwm | <Double> | Read-only | Number of Responses Falling on LWM for TTFP. |
| httpcltttfplwmrate | <Double> | Read-only | Rate (/s) counter for httpcltttfplwm |
| httpcltttfp_0 | <Double> | Read-only | Number of Responses Falling on Band-0 for TTFP. |
| httpcltttfp_0rate | <Double> | Read-only | Rate (/s) counter for httpcltttfp_0 |
| httpcltttfp_1 | <Double> | Read-only | Number of Responses Falling on Band-1 for TTFP. |
| httpcltttfp_1rate | <Double> | Read-only | Rate (/s) counter for httpcltttfp_1 |
| httpcltttfp_2 | <Double> | Read-only | Number of Responses Falling on Band-2 for TTFP. |
| httpcltttfp_2rate | <Double> | Read-only | Rate (/s) counter for httpcltttfp_2 |
| httpcltttfp_3 | <Double> | Read-only | Number of Responses Falling on Band-3 for TTFP. |
| httpcltttfp_3rate | <Double> | Read-only | Rate (/s) counter for httpcltttfp_3 |
| httpcltttfp_4 | <Double> | Read-only | Number of Responses Falling on Band-4 for TTFP. |
| httpcltttfp_4rate | <Double> | Read-only | Rate (/s) counter for httpcltttfp_4 |
| httpcltttfp_5 | <Double> | Read-only | Number of Responses Falling on Band-5 for TTFP. |
| httpcltttfp_5rate | <Double> | Read-only | Rate (/s) counter for httpcltttfp_5 |
| httpcltttfp_6 | <Double> | Read-only | Number of Responses Falling on Band-6 for TTFP. |
| httpcltttfp_6rate | <Double> | Read-only | Rate (/s) counter for httpcltttfp_6 |
| httpcltttfp_7 | <Double> | Read-only | Number of Responses Falling on Band-7 for TTFP. |
| httpcltttfp_7rate | <Double> | Read-only | Rate (/s) counter for httpcltttfp_7 |
| httpcltttfphwm | <Double> | Read-only | Number of Responses Falling on HWM for TTFP. |
| httpcltttfphwmrate | <Double> | Read-only | Rate (/s) counter for httpcltttfphwm |
| httpcltttfpmax | <Double> | Read-only | Peak RTT observed for Time to First response packet. |
| httpcltttlplwm | <Double> | Read-only | Number of Responses Falling on LWM for TTLP. |
| httpcltttlplwmrate | <Double> | Read-only | Rate (/s) counter for httpcltttlplwm |
| httpcltttlp_0 | <Double> | Read-only | Number of Responses Falling on Band-0 for TTLP. |
| httpcltttlp_0rate | <Double> | Read-only | Rate (/s) counter for httpcltttlp_0 |
| httpcltttlp_1 | <Double> | Read-only | Number of Responses Falling on Band-1 for TTLP. |
| httpcltttlp_1rate | <Double> | Read-only | Rate (/s) counter for httpcltttlp_1 |
| httpcltttlp_2 | <Double> | Read-only | Number of Responses Falling on Band-2 for TTLP. |
| httpcltttlp_2rate | <Double> | Read-only | Rate (/s) counter for httpcltttlp_2 |
| httpcltttlp_3 | <Double> | Read-only | Number of Responses Falling on Band-3 for TTLP. |
| httpcltttlp_3rate | <Double> | Read-only | Rate (/s) counter for httpcltttlp_3 |
| httpcltttlp_4 | <Double> | Read-only | Number of Responses Falling on Band-4 for TTLP. |
| httpcltttlp_4rate | <Double> | Read-only | Rate (/s) counter for httpcltttlp_4 |
| httpcltttlp_5 | <Double> | Read-only | Number of Responses Falling on Band-5 for TTLP. |
| httpcltttlp_5rate | <Double> | Read-only | Rate (/s) counter for httpcltttlp_5 |
| httpcltttlp_6 | <Double> | Read-only | Number of Responses Falling on Band-6 for TTLP. |
| httpcltttlp_6rate | <Double> | Read-only | Rate (/s) counter for httpcltttlp_6 |
| httpcltttlp_7 | <Double> | Read-only | Number of Responses Falling on Band-7 for TTLP. |
| httpcltttlp_7rate | <Double> | Read-only | Rate (/s) counter for httpcltttlp_7 |
| httpcltttlphwm | <Double> | Read-only | Number of Responses Falling on HWM for TTLP. |
| httpcltttlphwmrate | <Double> | Read-only | Rate (/s) counter for httpcltttlphwm |
| httpcltttlpmax | <Double> | Read-only | Peak RTT observed for Time to Last response packet. |
Operations
(click to see Properties )
- GET (ALL)
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 (all)
URL: http:// <netscaler-ip-address> /nitro/v1/stat/systembw
Query-parameters:
args
http:// <netscaler-ip-address> /nitro/v1/stat/systembw? args=detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>
Use this query-parameter to get systembw 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 error
Response Header:
Content-Type:application/json
Response Payload:
{ "systembw": [ {
"httpcltttfp_4rate":<Double_value>,
"httpcltttlp_5rate":<Double_value>,
"httpcltttlphwmrate":<Double_value>,
"httpcltttfp_0rate":<Double_value>,
"httpcltttlplwmrate":<Double_value>,
"httpcltpooloutactive":<Double_value>,
"httpcltttlp_1rate":<Double_value>,
"httpcltpoolinactive":<Double_value>,
"httpcltttlp_3":<Double_value>,
"httpcltttfp_1rate":<Double_value>,
"httpcltttfphwmrate":<Double_value>,
"httpcltttfp_6":<Double_value>,
"httpcltttfpmax":<Double_value>,
"httpcltttlp_7rate":<Double_value>,
"httpcltttfp_0":<Double_value>,
"httpcltttfp_3":<Double_value>,
"httpcltttlp_0rate":<Double_value>,
"httpcltttfplwm":<Double_value>,
"httpclterrstrayrate":<Double_value>,
"httpcltttlp_4":<Double_value>,
"httpcltttfp_7":<Double_value>,
"httpsvr404notfound":<Double_value>,
"httpcltttlp_3rate":<Double_value>,
"httpcltttfp_6rate":<Double_value>,
"httpcltttfp_5rate":<Double_value>,
"httpcltttlp_7":<Double_value>,
"httpcltttfp_2rate":<Double_value>,
"httpcltttfp_7rate":<Double_value>,
"httpcltttfp_4":<Double_value>,
"httpcltttlplwm":<Double_value>,
"httpcltttlp_1":<Double_value>,
"httpsvr404notfoundrate":<Double_value>,
"httpcltttlp_6":<Double_value>,
"httpcltttlphwm":<Double_value>,
"httpcltttlp_5":<Double_value>,
"httpcltttlp_6rate":<Double_value>,
"httpsvr200okresprate":<Double_value>,
"httpcltttfp_1":<Double_value>,
"httpcltttfp_5":<Double_value>,
"httpcltttlpmax":<Double_value>,
"httpcltttlp_4rate":<Double_value>,
"httpcltttfphwm":<Double_value>,
"httpclterrstray":<Double_value>,
"httpcltttlp_0":<Double_value>,
"httpcltttfplwmrate":<Double_value>,
"httpcltttlp_2":<Double_value>,
"httpcltttfp_2":<Double_value>,
"httpcltttlp_2rate":<Double_value>,
"httpsvr200okresp":<Double_value>,
"httpcltttfp_3rate":<Double_value>
}]}
<!--NeedCopy-->