Product Documentation

nspbr

Sep 08, 2016

Statistics for Policy Based Routing(PBR) entry resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name of the PBR whose statistics you want the NetScaler appliance to display.
Minimum length = 1
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
pbrtotpktsallowed
<Double>
Read-only
Total packets that matched the PBR (Policy-Based Routes) with action ALLOW
pbrpktsallowedrate
<Double>
Read-only
Rate (/s) counter for pbrtotpktsallowed
pbrtotpktsdenied
<Double>
Read-only
Total packets that matched the PBR with action DENY
pbrpktsdeniedrate
<Double>
Read-only
Rate (/s) counter for pbrtotpktsdenied
pbrtothits
<Double>
Read-only
Total packets that matched one of the configured PBR
pbrhitsrate
<Double>
Read-only
Rate (/s) counter for pbrtothits
pbrtotmisses
<Double>
Read-only
Total packets that did not match any PBR
pbrmissesrate
<Double>
Read-only
Rate (/s) counter for pbrtotmisses
pbrtotnulldrop
<Double>
Read-only
Total packets that are dropped due to null nexthop
pbrnulldroprate
<Double>
Read-only
Rate (/s) counter for pbrtotnulldrop
pbrperhits
<Double>
Read-only
Number of times the pbr was hit
pbrperhitsrate
<Double>
Read-only
Rate (/s) counter for pbrperhits

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

get (all)

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

Query-parameters:

args

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

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

Content-Type:application/json

Response Payload:

{ "nspbr": [ {
      "name":<String_value>,
      "pbrpktsdeniedrate":<Double_value>,
      "pbrmissesrate":<Double_value>,
      "pbrnulldroprate":<Double_value>,
      "pbrtothits":<Double_value>,
      "pbrperhitsrate":<Double_value>,
      "pbrtotnulldrop":<Double_value>,
      "pbrhitsrate":<Double_value>,
      "pbrperhits":<Double_value>,
      "pbrtotmisses":<Double_value>,
      "pbrtotpktsallowed":<Double_value>,
      "pbrtotpktsdenied":<Double_value>,
      "pbrpktsallowedrate":<Double_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/stat/nspbr/name_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 error

Response Headers:

Content-Type:application/json

Response Payload:

{ "nspbr": [ {
      "name":<String_value>,
      "pbrpktsdeniedrate":<Double_value>,
      "pbrmissesrate":<Double_value>,
      "pbrnulldroprate":<Double_value>,
      "pbrtothits":<Double_value>,
      "pbrperhitsrate":<Double_value>,
      "pbrtotnulldrop":<Double_value>,
      "pbrhitsrate":<Double_value>,
      "pbrperhits":<Double_value>,
      "pbrtotmisses":<Double_value>,
      "pbrtotpktsallowed":<Double_value>,
      "pbrtotpktsdenied":<Double_value>,
      "pbrpktsallowedrate":<Double_value>
}]}