Product Documentation

nspbr6

Sep 08, 2016

Statistics for PBR6 entry resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name of the PBR6 whose statistics you want the NetScaler appliance to display.
Minimum length = 1
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
pbr6totpktsallowed
<Double>
Read-only
Total packets that matched the PBR6 with action ALLOW
pbr6pktsallowedrate
<Double>
Read-only
Rate (/s) counter for pbr6totpktsallowed
pbr6totpktsdenied
<Double>
Read-only
Total packets that matched PBR6 with action DENY
pbr6pktsdeniedrate
<Double>
Read-only
Rate (/s) counter for pbr6totpktsdenied
pbr6tothits
<Double>
Read-only
Total packets that matched one of the configured PBR6
pbr6hitsrate
<Double>
Read-only
Rate (/s) counter for pbr6tothits
pbr6totmisses
<Double>
Read-only
Total packets that did not match any PBR6
pbr6missesrate
<Double>
Read-only
Rate (/s) counter for pbr6totmisses
pbr6totnulldrop
<Double>
Read-only
Total packets that are dropped due to null next hop
pbr6nulldroprate
<Double>
Read-only
Rate (/s) counter for pbr6totnulldrop
pbr6perhits
<Double>
Read-only
Number of times the pbr6 was hit
pbr6perhitsrate
<Double>
Read-only
Rate (/s) counter for pbr6perhits

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

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/stat/nspbr6?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 nspbr6 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:

{ "nspbr6": [ {
      "name":<String_value>,
      "pbr6nulldroprate":<Double_value>,
      "pbr6totnulldrop":<Double_value>,
      "pbr6pktsallowedrate":<Double_value>,
      "pbr6pktsdeniedrate":<Double_value>,
      "pbr6perhits":<Double_value>,
      "pbr6totpktsallowed":<Double_value>,
      "pbr6missesrate":<Double_value>,
      "pbr6tothits":<Double_value>,
      "pbr6perhitsrate":<Double_value>,
      "pbr6totpktsdenied":<Double_value>,
      "pbr6hitsrate":<Double_value>,
      "pbr6totmisses":<Double_value>
}]}

get

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

{ "nspbr6": [ {
      "name":<String_value>,
      "pbr6nulldroprate":<Double_value>,
      "pbr6totnulldrop":<Double_value>,
      "pbr6pktsallowedrate":<Double_value>,
      "pbr6pktsdeniedrate":<Double_value>,
      "pbr6perhits":<Double_value>,
      "pbr6totpktsallowed":<Double_value>,
      "pbr6missesrate":<Double_value>,
      "pbr6tothits":<Double_value>,
      "pbr6perhitsrate":<Double_value>,
      "pbr6totpktsdenied":<Double_value>,
      "pbr6hitsrate":<Double_value>,
      "pbr6totmisses":<Double_value>
}]}