cachepolicy¶

Statistics for Integrated Cache policy resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
policyname	<String>	Read-write	Name of the cache policy for which to display statistics. If you do not set this parameter, statistics are shown for all cache policies. Minimum length = 1
clearstats	<String>	Read-write	Clear the statsistics / counters. Possible values = basic, full
pipolicyhits	<Double>	Read-only	Number of hits on the policy
pipolicyhitsrate	<Double>	Read-only	Rate (/s) counter for pipolicyhits
pipolicyundefhits	<Double>	Read-only	Number of undef hits on the policy
pipolicyundefhitsrate	<Double>	Read-only	Rate (/s) counter for pipolicyundefhits

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 red and placeholder content is marked in green

get (all)¶

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

Query-parameters:

args

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

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

{  "cachepolicy": [ {
      "policyname":<String_value>,
      "pipolicyundefhitsrate":<Double_value>,
      "pipolicyundefhits":<Double_value>,
      "pipolicyhitsrate":<Double_value>,
      "pipolicyhits":<Double_value>
}]}

get¶

URL: http:// <netscaler-ip-address> /nitro/v1/stat/cachepolicy/ policyname_value><String>