Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

cacheparameter

August 17, 2023
Contributed by: 
C

Configuration for cache parameter resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
memlimit Read-write Amount of memory available for storing the cache objects. In practice, the amount of memory available for caching can be less than half the total memory of the Citrix ADC.
via Read-write String to include in the Via header. A Via header is inserted into all responses served from a content group if its Insert Via flag is set.

Minimum length = 1
verifyusing Read-write Criteria for deciding whether a cached object can be served for an incoming HTTP request. Available settings function as follows HOSTNAME - The URL, host name, and host port values in the incoming HTTP request header must match the cache policy. The IP address and the TCP port of the destination host are not evaluated. Do not use the HOSTNAME setting unless you are certain that no rogue client can access a rogue server through the cache. HOSTNAME_AND_IP - The URL, host name, host port in the incoming HTTP request header, and the IP address and TCP port of the destination server, must match the cache policy. DNS - The URL, host name and host port in the incoming HTTP request, and the TCP port must match the cache policy. The host name is used for DNS lookup of the destination server’s IP address, and is compared with the set of addresses returned by the DNS lookup. Possible values = HOSTNAME, HOSTNAME_AND_IP, DNS
maxpostlen Read-write Maximum number of POST body bytes to consider when evaluating parameters for a content group for which you have configured hit parameters and invalidation parameters.

Default value: 4096

Minimum value = 0

Maximum value = 131072
prefetchmaxpending Read-write Maximum number of outstanding prefetches in the Integrated Cache.
enablebypass Read-write Evaluate the request-time policies before attempting hit selection. If set to NO, an incoming request for which a matching object is found in cache storage results in a response regardless of the policy configuration.

If the request matches a policy with a NOCACHE action, the request bypasses all cache processing.

This parameter does not affect processing of requests that match any invalidation policy.

Possible values = YES, NO
undefaction Read-write Action to take when a policy cannot be evaluated.

Possible values = NOCACHE, RESET
enablehaobjpersist Read-write The HA object persisting parameter. When this value is set to YES, cache objects can be synced to Secondary in a HA deployment. If set to NO, objects will never be synced to Secondary node.

Default value: NO

Possible values = YES, NO
disklimit Read-only The disk limit for the Integrated Cache.
maxdisklimit Read-only The maximum value of the memory limit for the Integrated Cache.
memlimitactive Read-only Active value of the memory limit for the Integrated Cache.
maxmemlimit Read-only The maximum value of the memory limit for the Integrated Cache.
prefetchcur Read-only Number of current outstanding prefetches in the IC.

Operations

(click to see Properties )

  • UPDATE
  • UNSET
  • 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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/cacheparameter

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"cacheparameter":{
      "memlimit":<Double_value>,
      "via":<String_value>,
      "verifyusing":<String_value>,
      "maxpostlen":<Double_value>,
      "prefetchmaxpending":<Double_value>,
      "enablebypass":<String_value>,
      "undefaction":<String_value>,
      "enablehaobjpersist":<String_value>
}}

<!--NeedCopy-->

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

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/cacheparameter? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"cacheparameter":{
      "memlimit":true,
      "via":true,
      "verifyusing":true,
      "maxpostlen":true,
      "prefetchmaxpending":true,
      "enablebypass":true,
      "undefaction":true,
      "enablehaobjpersist":true
}}

<!--NeedCopy-->

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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/cacheparameter

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: 


{ "cacheparameter": [ {
      "disklimit":<Double_value>,
      "maxdisklimit":<Double_value>,
      "memlimit":<Double_value>,
      "memlimitactive":<Double_value>,
      "maxmemlimit":<Double_value>,
      "via":<String_value>,
      "verifyusing":<String_value>,
      "maxpostlen":<Double_value>,
      "prefetchcur":<Double_value>,
      "prefetchmaxpending":<Double_value>,
      "enablebypass":<String_value>,
      "undefaction":<String_value>,
      "enablehaobjpersist":<String_value>
}]}

<!--NeedCopy-->
cacheparameter
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.