Product Documentation

cachecontentgroup

Sep 02, 2016

Configuration for Integrated Cache content group resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name for the content group. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the content group is created.
Minimum length = 1
weakposrelexpiry
<Double>
Read-write
Relative expiry time, in seconds, for expiring positive responses with response codes between 200 and 399. Cannot be used in combination with other Expiry attributes. Similar to -relExpiry but has lower precedence.
Minimum value = 0
Maximum value = 31536000
heurexpiryparam
<Double>
Read-write
Heuristic expiry time, in percent of the duration, since the object was last modified.
Minimum value = 0
Maximum value = 100
relexpiry
<Double>
Read-write
Relative expiry time, in seconds, after which to expire an object cached in this content group.
Minimum value = 0
Maximum value = 31536000
relexpirymillisec
<Double>
Read-write
Relative expiry time, in milliseconds, after which to expire an object cached in this content group.
Minimum value = 0
Maximum value = 86400000
absexpiry
<String[]>
Read-write
Local time, up to 4 times a day, at which all objects in the content group must expire.

CLI Users:
For example, to specify that the objects in the content group should expire by 11:00 PM, type the following command: add cache contentgroup <contentgroup name> -absexpiry 23:00
To specify that the objects in the content group should expire at 10:00 AM, 3 PM, 6 PM, and 11:00 PM, type: add cache contentgroup <contentgroup name> -absexpiry 10:00 15:00 18:00 23:00.
absexpirygmt
<String[]>
Read-write
Coordinated Universal Time (GMT), up to 4 times a day, when all objects in the content group must expire.
weaknegrelexpiry
<Double>
Read-write
Relative expiry time, in seconds, for expiring negative responses. This value is used only if the expiry time cannot be determined from any other source. It is applicable only to the following status codes: 307, 403, 404, and 410.
Minimum value = 0
Maximum value = 31536000
hitparams
<String[]>
Read-write
Parameters to use for parameterized hit evaluation of an object. Up to 128 parameters can be specified. Mutually exclusive with the Hit Selector parameter.
Minimum length = 1
invalparams
<String[]>
Read-write
Parameters for parameterized invalidation of an object. You can specify up to 8 parameters. Mutually exclusive with invalSelector.
Minimum length = 1
ignoreparamvaluecase
<String>
Read-write
Ignore case when comparing parameter values during parameterized hit evaluation. (Parameter value case is ignored by default during parameterized invalidation.).
Possible values = YES, NO
matchcookies
<String>
Read-write
Evaluate for parameters in the cookie header also.
Possible values = YES, NO
invalrestrictedtohost
<String>
Read-write
Take the host header into account during parameterized invalidation.
Possible values = YES, NO
polleverytime
<String>
Read-write
Always poll for the objects in this content group. That is, retrieve the objects from the origin server whenever they are requested.
Default value: NO
Possible values = YES, NO
ignorereloadreq
<String>
Read-write
Ignore any request to reload a cached object from the origin server.
To guard against Denial of Service attacks, set this parameter to YES. For RFC-compliant behavior, set it to NO.
Default value: YES
Possible values = YES, NO
removecookies
<String>
Read-write
Remove cookies from responses.
Default value: YES
Possible values = YES, NO
prefetch
<String>
Read-write
Attempt to refresh objects that are about to go stale.
Default value: YES
Possible values = YES, NO
prefetchperiod
<Double>
Read-write
Time period, in seconds before an object's calculated expiry time, during which to attempt prefetch.
Minimum value = 0
Maximum value = 4294967294
prefetchperiodmillisec
<Double>
Read-write
Time period, in milliseconds before an object's calculated expiry time, during which to attempt prefetch.
Minimum value = 0
Maximum value = 4294967290
prefetchmaxpending
<Double>
Read-write
Maximum number of outstanding prefetches that can be queued for the content group.
Minimum value = 0
Maximum value = 4294967294
flashcache
<String>
Read-write
Perform flash cache. Mutually exclusive with Poll Every Time (PET) on the same content group.
Default value: NO
Possible values = YES, NO
expireatlastbyte
<String>
Read-write
Force expiration of the content immediately after the response is downloaded (upon receipt of the last byte of the response body). Applicable only to positive responses.
Default value: NO
Possible values = YES, NO
insertvia
<String>
Read-write
Insert a Via header into the response.
Default value: YES
Possible values = YES, NO
insertage
<String>
Read-write
Insert an Age header into the response. An Age header contains information about the age of the object, in seconds, as calculated by the integrated cache.
Default value: YES
Possible values = YES, NO
insertetag
<String>
Read-write
Insert an ETag header in the response. With ETag header insertion, the integrated cache does not serve full responses on repeat requests.
Default value: YES
Possible values = YES, NO
cachecontrol
<String>
Read-write
Insert a Cache-Control header into the response.
Minimum length = 1
quickabortsize
<Double>
Read-write
If the size of an object that is being downloaded is less than or equal to the quick abort value, and a client aborts during the download, the cache stops downloading the response. If the object is larger than the quick abort size, the cache continues to download the response.
Default value: 4194303
Minimum value = 0
Maximum value = 4194303
minressize
<Double>
Read-write
Minimum size of a response that can be cached in this content group.
Default minimum response size is 0.
Minimum value = 0
Maximum value = 2097151
maxressize
<Double>
Read-write
Maximum size of a response that can be cached in this content group.
Default value: 80
Minimum value = 0
Maximum value = 2097151
memlimit
<Double>
Read-write
Maximum amount of memory that the cache can use. The effective limit is based on the available memory of the NetScaler appliance.
Default value: 65536
ignorereqcachinghdrs
<String>
Read-write
Ignore Cache-Control and Pragma headers in the incoming request.
Default value: YES
Possible values = YES, NO
minhits
<Integer>
Read-write
Number of hits that qualifies a response for storage in this content group.
Default value: 0
alwaysevalpolicies
<String>
Read-write
Force policy evaluation for each response arriving from the origin server. Cannot be set to YES if the Prefetch parameter is also set to YES.
Default value: NO
Possible values = YES, NO
persistha
<String>
Read-write
Setting persistHA to YES causes IC to save objects in contentgroup to Secondary node in HA deployment.
Default value: NO
Possible values = YES, NO
pinned
<String>
Read-write
Do not flush objects from this content group under memory pressure.
Default value: NO
Possible values = YES, NO
lazydnsresolve
<String>
Read-write
Perform DNS resolution for responses only if the destination IP address in the request does not match the destination IP address of the cached response.
Default value: YES
Possible values = YES, NO
hitselector
<String>
Read-write
Selector for evaluating whether an object gets stored in a particular content group. A selector is an abstraction for a collection of PIXL expressions.
invalselector
<String>
Read-write
Selector for invalidating objects in the content group. A selector is an abstraction for a collection of PIXL expressions.
type
<String>
Read-write
The type of the content group.
Default value: HTTP
Possible values = HTTP, MYSQL, MSSQL
query
<String>
Read-write
Query string specifying individual objects to flush from this group by using parameterized invalidation. If this parameter is not set, all objects are flushed from the group.
Minimum length = 1
host
<String>
Read-write
Flush only objects that belong to the specified host. Do not use except with parameterized invalidation. Also, the Invalidation Restricted to Host parameter for the group must be set to YES.
Minimum length = 1
selectorvalue
<String>
Read-write
Value of the selector to be used for flushing objects from the content group. Requires that an invalidation selector be configured for the content group.
Minimum length = 1
tosecondary
<String>
Read-write
content group whose objects are to be sent to secondary.
Default value: NO
Possible values = YES, NO
flags
<Double>
Read-only
Flags.
prefetchcur
<Double>
Read-only
Current outstanding prefetches.
memusage
<Double>
Read-only
Current memory usage.
memdusage
<Double>
Read-only
Current disk memory usage.
disklimit
<Double>
Read-only
Maximum amount of disk that the cache can use. The effective limit is based on the available memory of the NetScaler appliance.
Default value: 0
cachenon304hits
<Double>
Read-only
Cache non 304 hits.
cache304hits
<Double>
Read-only
Cache 304 hits.
cachecells
<Double>
Read-only
Number of cells.
cachegroupincarnation
<Double>
Read-only
Cache group incarnation.
persist
<String>
Read-only
Setting persist to YES causes IC to save objects in contentgroup to disk.
Default value: NO
Possible values = YES, NO
policyname
<String[]>
Read-only
Active cache policies refering to this group.
cachenuminvalpolicy
<Double>
Read-only
Number of active Invalidation policies refering to this group.
markercells
<Double>
Read-only
Numbers of marker cells in this group.
builtin
<String[]>
Read-only
.
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
__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>.

add

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"cachecontentgroup":{
      "name":<String_value>,
      "weakposrelexpiry":<Double_value>,
      "heurexpiryparam":<Double_value>,
      "relexpiry":<Double_value>,
      "relexpirymillisec":<Double_value>,
      "absexpiry":<String[]_value>,
      "absexpirygmt":<String[]_value>,
      "weaknegrelexpiry":<Double_value>,
      "hitparams":<String[]_value>,
      "invalparams":<String[]_value>,
      "ignoreparamvaluecase":<String_value>,
      "matchcookies":<String_value>,
      "invalrestrictedtohost":<String_value>,
      "polleverytime":<String_value>,
      "ignorereloadreq":<String_value>,
      "removecookies":<String_value>,
      "prefetch":<String_value>,
      "prefetchperiod":<Double_value>,
      "prefetchperiodmillisec":<Double_value>,
      "prefetchmaxpending":<Double_value>,
      "flashcache":<String_value>,
      "expireatlastbyte":<String_value>,
      "insertvia":<String_value>,
      "insertage":<String_value>,
      "insertetag":<String_value>,
      "cachecontrol":<String_value>,
      "quickabortsize":<Double_value>,
      "minressize":<Double_value>,
      "maxressize":<Double_value>,
      "memlimit":<Double_value>,
      "ignorereqcachinghdrs":<String_value>,
      "minhits":<Integer_value>,
      "alwaysevalpolicies":<String_value>,
      "persistha":<String_value>,
      "pinned":<String_value>,
      "lazydnsresolve":<String_value>,
      "hitselector":<String_value>,
      "invalselector":<String_value>,
      "type":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created
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

delete

URL: http://<netscaler-ip-address>/nitro/v1/config/cachecontentgroup/name_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

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

update

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

HTTP Method: PUT

Request Headers:

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

Request Payload:

{"cachecontentgroup":{
      "name":<String_value>,
      "weakposrelexpiry":<Double_value>,
      "heurexpiryparam":<Double_value>,
      "relexpiry":<Double_value>,
      "relexpirymillisec":<Double_value>,
      "absexpiry":<String[]_value>,
      "absexpirygmt":<String[]_value>,
      "weaknegrelexpiry":<Double_value>,
      "hitparams":<String[]_value>,
      "invalparams":<String[]_value>,
      "ignoreparamvaluecase":<String_value>,
      "matchcookies":<String_value>,
      "invalrestrictedtohost":<String_value>,
      "polleverytime":<String_value>,
      "ignorereloadreq":<String_value>,
      "removecookies":<String_value>,
      "prefetch":<String_value>,
      "prefetchperiod":<Double_value>,
      "prefetchperiodmillisec":<Double_value>,
      "prefetchmaxpending":<Double_value>,
      "flashcache":<String_value>,
      "expireatlastbyte":<String_value>,
      "insertvia":<String_value>,
      "insertage":<String_value>,
      "insertetag":<String_value>,
      "cachecontrol":<String_value>,
      "quickabortsize":<Double_value>,
      "minressize":<Double_value>,
      "maxressize":<Double_value>,
      "memlimit":<Double_value>,
      "ignorereqcachinghdrs":<String_value>,
      "minhits":<Integer_value>,
      "alwaysevalpolicies":<String_value>,
      "persistha":<String_value>,
      "pinned":<String_value>,
      "lazydnsresolve":<String_value>,
      "hitselector":<String_value>,
      "invalselector":<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

unset

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"cachecontentgroup":{
      "name":<String_value>,
      "weakposrelexpiry":true,
      "heurexpiryparam":true,
      "relexpiry":true,
      "relexpirymillisec":true,
      "absexpiry":true,
      "absexpirygmt":true,
      "weaknegrelexpiry":true,
      "hitparams":true,
      "invalparams":true,
      "ignoreparamvaluecase":true,
      "matchcookies":true,
      "invalrestrictedtohost":true,
      "polleverytime":true,
      "ignorereloadreq":true,
      "removecookies":true,
      "prefetch":true,
      "prefetchperiod":true,
      "prefetchperiodmillisec":true,
      "prefetchmaxpending":true,
      "flashcache":true,
      "expireatlastbyte":true,
      "insertvia":true,
      "insertage":true,
      "insertetag":true,
      "cachecontrol":true,
      "quickabortsize":true,
      "minressize":true,
      "maxressize":true,
      "memlimit":true,
      "ignorereqcachinghdrs":true,
      "minhits":true,
      "alwaysevalpolicies":true,
      "persistha":true,
      "pinned":true,
      "lazydnsresolve":true,
      "hitselector":true,
      "invalselector":true
}}

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

expire

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"cachecontentgroup":{
      "name":<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/cachecontentgroup?action=flush

HTTP Method: POST

Request Headers:

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

Request Payload:

{"cachecontentgroup":{
      "name":<String_value>,
      "query":<String_value>,
      "host":<String_value>,
      "selectorvalue":<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/cachecontentgroup?action=save

HTTP Method: POST

Request Headers:

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

Request Payload:

{"cachecontentgroup":{
      "name":<String_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/cachecontentgroup

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/cachecontentgroup?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/cachecontentgroup?filter=property-name1:property-val1,property-name2:property-val2

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

view

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

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

pagination

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

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

{ "cachecontentgroup": [ {
      "name":<String_value>,
      "flags":<Double_value>,
      "type":<String_value>,
      "relexpiry":<Double_value>,
      "relexpirymillisec":<Double_value>,
      "absexpiry":<String[]_value>,
      "absexpirygmt":<String[]_value>,
      "heurexpiryparam":<Double_value>,
      "weakposrelexpiry":<Double_value>,
      "weaknegrelexpiry":<Double_value>,
      "hitparams":<String[]_value>,
      "invalparams":<String[]_value>,
      "ignoreparamvaluecase":<String_value>,
      "matchcookies":<String_value>,
      "invalrestrictedtohost":<String_value>,
      "polleverytime":<String_value>,
      "ignorereloadreq":<String_value>,
      "removecookies":<String_value>,
      "prefetch":<String_value>,
      "prefetchperiod":<Double_value>,
      "prefetchperiodmillisec":<Double_value>,
      "prefetchcur":<Double_value>,
      "prefetchmaxpending":<Double_value>,
      "flashcache":<String_value>,
      "expireatlastbyte":<String_value>,
      "insertvia":<String_value>,
      "insertage":<String_value>,
      "insertetag":<String_value>,
      "cachecontrol":<String_value>,
      "quickabortsize":<Double_value>,
      "minressize":<Double_value>,
      "maxressize":<Double_value>,
      "memusage":<Double_value>,
      "memdusage":<Double_value>,
      "disklimit":<Double_value>,
      "memlimit":<Double_value>,
      "ignorereqcachinghdrs":<String_value>,
      "cachenon304hits":<Double_value>,
      "cache304hits":<Double_value>,
      "cachecells":<Double_value>,
      "cachegroupincarnation":<Double_value>,
      "minhits":<Integer_value>,
      "alwaysevalpolicies":<String_value>,
      "persist":<String_value>,
      "persistha":<String_value>,
      "pinned":<String_value>,
      "lazydnsresolve":<String_value>,
      "hitselector":<String_value>,
      "invalselector":<String_value>,
      "policyname":<String[]_value>,
      "cachenuminvalpolicy":<Double_value>,
      "markercells":<Double_value>,
      "builtin":<String[]_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/cachecontentgroup/name_value<String>

Query-parameters:

attrs

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

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

view

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

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

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:

{ "cachecontentgroup": [ {
      "name":<String_value>,
      "flags":<Double_value>,
      "type":<String_value>,
      "relexpiry":<Double_value>,
      "relexpirymillisec":<Double_value>,
      "absexpiry":<String[]_value>,
      "absexpirygmt":<String[]_value>,
      "heurexpiryparam":<Double_value>,
      "weakposrelexpiry":<Double_value>,
      "weaknegrelexpiry":<Double_value>,
      "hitparams":<String[]_value>,
      "invalparams":<String[]_value>,
      "ignoreparamvaluecase":<String_value>,
      "matchcookies":<String_value>,
      "invalrestrictedtohost":<String_value>,
      "polleverytime":<String_value>,
      "ignorereloadreq":<String_value>,
      "removecookies":<String_value>,
      "prefetch":<String_value>,
      "prefetchperiod":<Double_value>,
      "prefetchperiodmillisec":<Double_value>,
      "prefetchcur":<Double_value>,
      "prefetchmaxpending":<Double_value>,
      "flashcache":<String_value>,
      "expireatlastbyte":<String_value>,
      "insertvia":<String_value>,
      "insertage":<String_value>,
      "insertetag":<String_value>,
      "cachecontrol":<String_value>,
      "quickabortsize":<Double_value>,
      "minressize":<Double_value>,
      "maxressize":<Double_value>,
      "memusage":<Double_value>,
      "memdusage":<Double_value>,
      "disklimit":<Double_value>,
      "memlimit":<Double_value>,
      "ignorereqcachinghdrs":<String_value>,
      "cachenon304hits":<Double_value>,
      "cache304hits":<Double_value>,
      "cachecells":<Double_value>,
      "cachegroupincarnation":<Double_value>,
      "minhits":<Integer_value>,
      "alwaysevalpolicies":<String_value>,
      "persist":<String_value>,
      "persistha":<String_value>,
      "pinned":<String_value>,
      "lazydnsresolve":<String_value>,
      "hitselector":<String_value>,
      "invalselector":<String_value>,
      "policyname":<String[]_value>,
      "cachenuminvalpolicy":<Double_value>,
      "markercells":<Double_value>,
      "builtin":<String[]_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/cachecontentgroup?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:

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