Product Documentation

cacheobject

Sep 02, 2016

Configuration for cache object resource.

Properties (click to see Operations)

Name Data Type Permissions Description
url
<String>
Read-write
URL of the particular object whose details is required. Parameter "host" must be specified along with the URL.
Minimum length = 1
locator
<Double>
Read-write
ID of the cached object.
httpstatus
<Double>
Read-write
HTTP status of the object.
host
<String>
Read-write
Host name of the object. Parameter "url" must be specified.
Minimum length = 1
port
<Integer>
Read-write
Host port of the object. You must also set the Host parameter.
Default value: 80
Minimum value = 1
groupname
<String>
Read-write
Name of the content group to which the object belongs. It will display only the objects belonging to the specified content group. You must also set the Host parameter.
httpmethod
<String>
Read-write
HTTP request method that caused the object to be stored.
Default value: GET
Possible values = GET, POST
group
<String>
Read-write
Name of the content group whose objects should be listed.
ignoremarkerobjects
<String>
Read-write
Ignore marker objects. Marker objects are created when a response exceeds the maximum or minimum response size for the content group or has not yet received the minimum number of hits for the content group.
Possible values = ON, OFF
includenotreadyobjects
<String>
Read-write
Include responses that have not yet reached a minimum number of hits before being cached.
Possible values = ON, OFF
tosecondary
<String>
Read-write
Object will be saved onto Secondary.
Default value: NO
Possible values = YES, NO
cacheressize
<Double>
Read-only
Cache response size of the object.
cachereshdrsize
<Double>
Read-only
Cache response header size of the object.
cacheetag
<String>
Read-only
Cache ETag of the object.
httpstatusoutput
<Double>
Read-only
HTTP status of the object.
cachereslastmod
<String>
Read-only
Value of "Last-modified" header.
cachecontrol
<String>
Read-only
Cache-Control header of the object.
cacheresdate
<String>
Read-only
Value of "Date" header.
contentgroup
<String>
Read-only
Name of the contentgroup in which it is stored.
destipv46
<String>
Read-only
Destination IP.
destport
<Integer>
Read-only
Destination Port.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
cachecellcomplex
<String>
Read-only
The state of the parameterized caching on this cell.
Possible values = YES, NO
hitparams
<String[]>
Read-only
Parameterized hit evaluation of an object.
hitvalues
<String[]>
Read-only
Values of hitparams for this object.
cachecellreqtime
<Double>
Read-only
Required time of the cache cell object.
cachecellrestime
<Double>
Read-only
Response time to the cache cell object.
cachecurage
<Double>
Read-only
Current age of the cache object.
cachecellexpires
<Double>
Read-only
Expiry time of the cache cell object in seconds.
cachecellexpiresmillisec
<Double>
Read-only
Expiry time of the cache cell object in milliseconds.
flushed
<String>
Read-only
Specifies whether the object is flushed.
Possible values = YES, NO
prefetch
<String>
Read-only
Specifies whether Integrated Cache should attempt to refresh an object immediately before it goes stale.
Possible values = YES, NO
prefetchperiod
<Double>
Read-only
The duration in seconds of the period during which prefetch should be attempted, immediately before the object's calculated expiry time.
prefetchperiodmillisec
<Double>
Read-only
The duration in milliseconds of the period during which prefetch should be attempted, immediately before the object's calculated expiry time.
cachecellcurreaders
<Double>
Read-only
Current readers of the cache cell object.
cachecellcurmisses
<Double>
Read-only
Current misses of the cache cell object.
cachecellhits
<Double>
Read-only
Cache cell hits.
cachecellmisses
<Double>
Read-only
Cache cell misses.
cachecelldhits
<Double>
Read-only
Cache cell disk hits.
cachecellcompressionformat
<String>
Read-only
Compression format of this object. Identity means not compressed.
cachecellappfwmetadataexists
<String>
Read-only
AppFirewall cache object.
Possible values = YES, NO
cachecellhttp11
<String>
Read-only
The state of the response to be HTTP/1.1.
Possible values = YES, NO
cachecellweaketag
<String>
Read-only
The state of the weak HTTP Entity Tag in the cell.
Possible values = YES, NO
cachecellresbadsize
<String>
Read-only
The marked state of the cell.
Possible values = YES, NO
markerreason
<String>
Read-only
Reason for marking the cell.
Possible values = Waiting for min hit, Response header is too big, Content-length header said response size is not in group size limit, Content-length response received more data, Content-length response received less data, Content-length response data is not in group size limit, Chunk response received more data, Chunk response data is not in group size limit, Bad chunk format, Fin terminated response data is not in group size limit
cachecellpolleverytime
<String>
Read-only
The state to poll every time on object.
Possible values = YES, NO
cachecelletaginserted
<String>
Read-only
The state of the ETag to be inserted by IC for this object.
Possible values = YES, NO
cachecellreadywithlastbyte
<String>
Read-only
The state of the complete arrived response.
Possible values = YES, NO
cacheinmemory
<String>
Read-only
The cache data is available in memory.
Possible values = YES, NO
cacheindisk
<String>
Read-only
The cache data is available in disk.
Possible values = YES, NO
cacheinsecondary
<String>
Read-only
The cache data is available in secondary in HA deployment.
Possible values = YES, NO
cachedirname
<String>
Read-only
The directory name used if saved.
cachefilename
<String>
Read-only
The filename used if saved.
cachecelldestipverified
<String>
Read-only
The state of DNS verification.
Possible values = YES, NO
cachecellfwpxyobj
<String>
Read-only
The state of the object to be stored on a request to a forward proxy.
Possible values = YES, NO
cachecellbasefile
<String>
Read-only
The state of delta being used as a basefile.
Possible values = YES, NO
cachecellminhitflag
<String>
Read-only
The state of the minhit feature on this cell.
Possible values = YES, NO
cachecellminhit
<Integer>
Read-only
Min hit value for the object.
policy
<Integer>
Read-only
Policy info for the object.
policyname
<String>
Read-only
Policy which created the object.
selectorname
<String[]>
Read-only
The hit selector for the object.
rule
<String[]>
Read-only
Selectors for this object.
selectorvalue
<String[]>
Read-only
The HTTP request method that caused the object to be stored.
cacheurls
<String>
Read-only
List of cache object URLs.
warnbucketskip
<Double>
Read-only
Bucket skipped warning.
totalobjs
<Double>
Read-only
Total objects.
httpcalloutcell
<String>
Read-only
Is it a http callout cell ?.
Possible values = YES, NO
httpcalloutname
<String>
Read-only
Name of the http callout.
returntype
<String>
Read-only
Return type of the http callout.
Possible values = BOOL, NUM, TEXT
httpcalloutresult
<String>
Read-only
First few bytes of http callout response.
locatorshow
<Double>
Read-only
ID of the cached object.
ceflags
<Double>
Read-only
Indicates state and type of cached cell.
__count
<Double>
Read-only
count parameter

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>.

expire

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"cacheobject":{
      "locator":<Double_value>,
      "url":<String_value>,
      "host":<String_value>,
      "port":<Integer_value>,
      "groupname":<String_value>,
      "httpmethod":<String_value>
}}

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

flush

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"cacheobject":{
      "locator":<Double_value>,
      "url":<String_value>,
      "host":<String_value>,
      "port":<Integer_value>,
      "groupname":<String_value>,
      "httpmethod":<String_value>
}}

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

save

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"cacheobject":{
      "locator":<Double_value>,
      "tosecondary":<String_value>
}}

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

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/config/cacheobject?args=url:<String_value>,locator:<Double_value>,httpstatus:<Double_value>,host:<String_value>,port:<Integer_value>,groupname:<String_value>,httpmethod:<String_value>,group:<String_value>,ignoremarkerobjects:<String_value>,includenotreadyobjects:<String_value>

Use this query-parameter to get cacheobject resources based on additional properties.

attrs

http://<netscaler-ip-address>/nitro/v1/config/cacheobject?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<netscaler-ip-address>/nitro/v1/config/cacheobject?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of cacheobject resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<netscaler-ip-address>/nitro/v1/config/cacheobject?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<netscaler-ip-address>/nitro/v1/config/cacheobject?pagesize=#no&pageno=#no

Use this query-parameter to get the cacheobject resources in chunks.

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:

{ "cacheobject": [ {
url:<String_value>,locator:<Double_value>,httpstatus:<Double_value>,host:<String_value>,port:<Integer_value>,groupname:<String_value>,httpmethod:<String_value>,group:<String_value>,ignoremarkerobjects:<String_value>,includenotreadyobjects:<String_value>      "cacheressize":<Double_value>,
      "cachereshdrsize":<Double_value>,
      "cacheetag":<String_value>,
      "httpstatusoutput":<Double_value>,
      "cachereslastmod":<String_value>,
      "cachecontrol":<String_value>,
      "cacheresdate":<String_value>,
      "contentgroup":<String_value>,
      "destip":<Double_value>,
      "destipv46":<String_value>,
      "destport":<Integer_value>,
      "cachecellcomplex":<String_value>,
      "hitparams":<String[]_value>,
      "hitvalues":<String[]_value>,
      "cachecellreqtime":<Double_value>,
      "cachecellrestime":<Double_value>,
      "cachecurage":<Double_value>,
      "cachecellexpires":<Double_value>,
      "cachecellexpiresmillisec":<Double_value>,
      "flushed":<String_value>,
      "prefetch":<String_value>,
      "prefetchperiod":<Double_value>,
      "prefetchperiodmillisec":<Double_value>,
      "cachecellcurreaders":<Double_value>,
      "cachecellcurmisses":<Double_value>,
      "cachecellhits":<Double_value>,
      "cachecellmisses":<Double_value>,
      "cachecelldhits":<Double_value>,
      "cachecellgzipcompressed":<String_value>,
      "cachecelldeflatecompressed":<String_value>,
      "cachecellcompressionformat":<String_value>,
      "cachecellappfwmetadataexists":<String_value>,
      "cachecellhttp11":<String_value>,
      "cachecellweaketag":<String_value>,
      "cachecellresbadsize":<String_value>,
      "markerreason":<String_value>,
      "cachecellpolleverytime":<String_value>,
      "cachecelletaginserted":<String_value>,
      "cachecellreadywithlastbyte":<String_value>,
      "cacheinmemory":<String_value>,
      "cacheindisk":<String_value>,
      "cacheinsecondary":<String_value>,
      "cachedirname":<String_value>,
      "cachefilename":<String_value>,
      "cachecelldestipverified":<String_value>,
      "cachecellfwpxyobj":<String_value>,
      "cachecellbasefile":<String_value>,
      "cachecellminhitflag":<String_value>,
      "cachecellminhit":<Integer_value>,
      "policy":<Integer_value>,
      "policyname":<String_value>,
      "selectorname":<String[]_value>,
      "rule":<String[]_value>,
      "selectorvalue":<String[]_value>,
      "cacheurls":<String_value>,
      "warnbucketskip":<Double_value>,
      "totalobjs":<Double_value>,
      "httpcalloutcell":<String_value>,
      "httpcalloutname":<String_value>,
      "returntype":<String_value>,
      "httpcalloutresult":<String_value>,
      "locatorshow":<Double_value>,
      "ceflags":<Double_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/cacheobject?count=yes

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:

{ "cacheobject": [ { "__count": "#no"} ] }