Skip to content

nspbr

Statistics for Policy Based Routing(PBR) entry resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeName of the PBR whose statistics you want the Citrix ADC to display.
Minimum length = 1
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
pbrtotpktsallowed<Double>Read-onlyTotal packets that matched the PBR (Policy-Based Routes) with action ALLOW
pbrpktsallowedrate<Double>Read-onlyRate (/s) counter for pbrtotpktsallowed
pbrtotpktsdenied<Double>Read-onlyTotal packets that matched the PBR with action DENY
pbrpktsdeniedrate<Double>Read-onlyRate (/s) counter for pbrtotpktsdenied
pbrtothits<Double>Read-onlyTotal packets that matched one of the configured PBR
pbrhitsrate<Double>Read-onlyRate (/s) counter for pbrtothits
pbrtotmisses<Double>Read-onlyTotal packets that did not match any PBR
pbrmissesrate<Double>Read-onlyRate (/s) counter for pbrtotmisses
pbrtotnulldrop<Double>Read-onlyTotal packets that are dropped due to null nexthop
pbrnulldroprate<Double>Read-onlyRate (/s) counter for pbrtotnulldrop
pbrperhits<Double>Read-onlyNumber of times the pbr was hit
pbrperhitsrate<Double>Read-onlyRate (/s) counter for pbrperhits

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/nspbr

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse 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://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse 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>
}]}