Skip to content

cacheobject

Configuration for cache object resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
url<String>Read-writeURL of the particular object whose details is required. Parameter "host" must be specified along with the URL.
Minimum length = 1
locator<Double>Read-writeID of the cached object.
httpstatus<Double>Read-writeHTTP status of the object.
host<String>Read-writeHost name of the object. Parameter "url" must be specified.
Minimum length = 1
port<Integer>Read-writeHost port of the object. You must also set the Host parameter.
Default value: 80
Minimum value = 1
groupname<String>Read-writeName 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-writeHTTP request method that caused the object to be stored.
Default value: GET
Possible values = GET, POST
group<String>Read-writeName of the content group whose objects should be listed.
ignoremarkerobjects<String>Read-writeIgnore 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-writeInclude responses that have not yet reached a minimum number of hits before being cached.
Possible values = ON, OFF
nodeid<Double>Read-writeUnique number that identifies the cluster node.
Minimum value = 0
Maximum value = 31
tosecondary<String>Read-writeObject will be saved onto Secondary.
Default value: NO
Possible values = YES, NO
cacheressize<Double>Read-onlyCache response size of the object.
cachereshdrsize<Double>Read-onlyCache response header size of the object.
cacheetag<String>Read-onlyCache ETag of the object.
httpstatusoutput<Double>Read-onlyHTTP status of the object.
cachereslastmod<String>Read-onlyValue of "Last-modified" header.
cachecontrol<String>Read-onlyCache-Control header of the object.
cacheresdate<String>Read-onlyValue of "Date" header.
contentgroup<String>Read-onlyName of the contentgroup in which it is stored.
destipv46<String>Read-onlyDestination IP.
destport<Integer>Read-onlyDestination Port.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
cachecellcomplex<String>Read-onlyThe state of the parameterized caching on this cell.
Possible values = YES, NO
hitparams<String[]>Read-onlyParameterized hit evaluation of an object.
hitvalues<String[]>Read-onlyValues of hitparams for this object.
cachecellreqtime<Double>Read-onlyRequired time of the cache cell object.
cachecellrestime<Double>Read-onlyResponse time to the cache cell object.
cachecurage<Double>Read-onlyCurrent age of the cache object.
cachecellexpires<Double>Read-onlyExpiry time of the cache cell object in seconds.
cachecellexpiresmillisec<Double>Read-onlyExpiry time of the cache cell object in milliseconds.
flushed<String>Read-onlySpecifies whether the object is flushed.
Possible values = YES, NO
prefetch<String>Read-onlySpecifies whether Integrated Cache should attempt to refresh an object immediately before it goes stale.
Possible values = YES, NO
prefetchperiod<Double>Read-onlyThe duration in seconds of the period during which prefetch should be attempted, immediately before the object's calculated expiry time.
prefetchperiodmillisec<Double>Read-onlyThe duration in milliseconds of the period during which prefetch should be attempted, immediately before the object's calculated expiry time.
cachecellcurreaders<Double>Read-onlyCurrent readers of the cache cell object.
cachecellcurmisses<Double>Read-onlyCurrent misses of the cache cell object.
cachecellhits<Double>Read-onlyCache cell hits.
cachecellmisses<Double>Read-onlyCache cell misses.
cachecelldhits<Double>Read-onlyCache cell disk hits.
cachecellcompressionformat<String>Read-onlyCompression format of this object. Identity means not compressed.
cachecellappfwmetadataexists<String>Read-onlyAppFirewall cache object.
Possible values = YES, NO
cachecellhttp11<String>Read-onlyThe state of the response to be HTTP/1.1.
Possible values = YES, NO
cachecellweaketag<String>Read-onlyThe state of the weak HTTP Entity Tag in the cell.
Possible values = YES, NO
cachecellresbadsize<String>Read-onlyThe marked state of the cell.
Possible values = YES, NO
markerreason<String>Read-onlyReason 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-onlyThe state to poll every time on object.
Possible values = YES, NO
cachecelletaginserted<String>Read-onlyThe state of the ETag to be inserted by IC for this object.
Possible values = YES, NO
cachecellreadywithlastbyte<String>Read-onlyThe state of the complete arrived response.
Possible values = YES, NO
cacheinmemory<String>Read-onlyThe cache data is available in memory.
Possible values = YES, NO
cacheindisk<String>Read-onlyThe cache data is available in disk.
Possible values = YES, NO
cacheinsecondary<String>Read-onlyThe cache data is available in secondary in HA deployment.
Possible values = YES, NO
cachedirname<String>Read-onlyThe directory name used if saved.
cachefilename<String>Read-onlyThe filename used if saved.
cachecelldestipverified<String>Read-onlyThe state of DNS verification.
Possible values = YES, NO
cachecellfwpxyobj<String>Read-onlyThe state of the object to be stored on a request to a forward proxy.
Possible values = YES, NO
cachecellbasefile<String>Read-onlyThe state of delta being used as a basefile.
Possible values = YES, NO
cachecellminhitflag<String>Read-onlyThe state of the minhit feature on this cell.
Possible values = YES, NO
cachecellminhit<Integer>Read-onlyMin hit value for the object.
policy<Integer>Read-onlyPolicy info for the object.
policyname<String>Read-onlyPolicy which created the object.
selectorname<String[]>Read-onlyThe hit selector for the object.
rule<String[]>Read-onlySelectors for this object.
selectorvalue<String[]>Read-onlyThe HTTP request method that caused the object to be stored.
cacheurls<String>Read-onlyList of cache object URLs.
warnbucketskip<Double>Read-onlyBucket skipped warning.
totalobjs<Double>Read-onlyTotal objects.
httpcalloutcell<String>Read-onlyIs it a http callout cell ?.
Possible values = YES, NO
httpcalloutname<String>Read-onlyName of the http callout.
returntype<String>Read-onlyReturn type of the http callout.
Possible values = BOOL, NUM, TEXT
httpcalloutresult<String>Read-onlyFirst few bytes of http callout response.
locatorshow<Double>Read-onlyID of the cached object.
ceflags<Double>Read-onlyIndicates state and type of cached cell.
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

EXPIRE| FLUSH| SAVE| GET (ALL)| COUNT

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

expire

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

flush

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

save

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

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/cacheobject

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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>,nodeid:<Double_value>

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

attrs

http://<Citrix-ADC-IP-address(NSIP)>/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://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC. Filtering can be done on any of the properties of the resource.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/cacheobject?view=summary

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

pagination

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

Content-Type:application/json

Response Payload:

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