cache contentGroup¶
The following operations can be performed on "cache contentGroup":
add | rm | set | unset | show | expire | flush | stat | save
add cache contentGroup¶
Creates a new content group for grouping cached objects on the basis of some unique property.
Synopsys¶
add cache contentGroup <name> [-weakPosRelExpiry <secs> | -relExpiry <secs> | -relExpiryMilliSec <msecs> | -absExpiry <HH:MM> ... | -absExpiryGMT <HH:MM> ...] [-heurExpiryParam <positive_integer>] [-weakNegRelExpiry <secs>] [(-hitParams <string> ... [-ignoreParamValueCase ( YES | NO ) | -hitSelector <string> | -invalSelector <string>] [-matchCookies ( YES | NO )])] [-invalParams <string> ... [-invalRestrictedToHost ( YES | NO )]] [-pollEveryTime ( YES | NO )] [-ignoreReloadReq ( YES | NO )] [-removeCookies ( YES | NO )] [-prefetch ( YES | NO ) [-prefetchPeriod <secs> | -prefetchPeriodMilliSec <msecs>]] [-prefetchMaxPending <positive_integer>] [-flashCache ( YES | NO )] [-expireAtLastByte ( YES | NO )] [-insertVia ( YES | NO )] [-insertAge ( YES | NO )] [-insertETag ( YES | NO )] [-cacheControl <string>] [-quickAbortSize <KBytes>] [-minResSize <KBytes>] [-maxResSize <KBytes>] [-memLimit <MBytes>] [-ignoreReqCachingHdrs ( YES | NO )] [-minHits <integer>] [-alwaysEvalPolicies ( YES | NO )] [-persistHA ( YES | NO )] [-pinned ( YES | NO )] [-lazyDnsResolve ( YES | NO )] [-type <type>]
Arguments¶
name
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.
weakPosRelExpiry
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.
Default value: -1
Maximum value: 31536000
heurExpiryParam
Heuristic expiry time, in percent of the duration, since the object was last modified.
Default value: -1
Minimum value: 0
Maximum value: 100
relExpiry
Relative expiry time, in seconds, after which to expire an object cached in this content group.
Default value: -1
Maximum value: 31536000
relExpiryMilliSec
Relative expiry time, in milliseconds, after which to expire an object cached in this content group.
Default value: -1
Maximum value: 86400000
absExpiry
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
Coordinated Universal Time (GMT), up to 4 times a day, when all objects in the content group must expire.
weakNegRelExpiry
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.
Default value: -1
Maximum value: 31536000
hitParams
Parameters to use for parameterized hit evaluation of an object. Up to 128 parameters can be specified. Mutually exclusive with the Hit Selector parameter.
invalParams
Parameters for parameterized invalidation of an object. You can specify up to 8 parameters. Mutually exclusive with invalSelector.
ignoreParamValueCase
Ignore case when comparing parameter values during parameterized hit evaluation. (Parameter value case is ignored by default during parameterized invalidation.)
Possible values: YES, NO
Default value: VAL_NOT_SET
matchCookies
Evaluate for parameters in the cookie header also.
Possible values: YES, NO
Default value: VAL_NOT_SET
invalRestrictedToHost
Take the host header into account during parameterized invalidation.
Possible values: YES, NO
Default value: VAL_NOT_SET
pollEveryTime
Always poll for the objects in this content group. That is, retrieve the objects from the origin server whenever they are requested.
Possible values: YES, NO
Default value: NO
ignoreReloadReq
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.
Possible values: YES, NO
Default value: YES
removeCookies
Remove cookies from responses.
Possible values: YES, NO
Default value: YES
prefetch
Attempt to refresh objects that are about to go stale.
Possible values: YES, NO
Default value: YES
prefetchPeriod
Time period, in seconds before an object's calculated expiry time, during which to attempt prefetch.
Default value: -1
Maximum value: 4294967294
prefetchPeriodMilliSec
Time period, in milliseconds before an object's calculated expiry time, during which to attempt prefetch.
Default value: -1
Maximum value: 4294967290
prefetchMaxPending
Maximum number of outstanding prefetches that can be queued for the content group.
Default value: -1
Minimum value: 0
Maximum value: 4294967294
flashCache
Perform flash cache. Mutually exclusive with Poll Every Time (PET) on the same content group.
Possible values: YES, NO
Default value: NO
expireAtLastByte
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.
Possible values: YES, NO
Default value: NO
insertVia
Insert a Via header into the response.
Possible values: YES, NO
Default value: YES
insertAge
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.
Possible values: YES, NO
Default value: YES
insertETag
Insert an ETag header in the response. With ETag header insertion, the integrated cache does not serve full responses on repeat requests.
Possible values: YES, NO
Default value: YES
cacheControl
Insert a Cache-Control header into the response.
quickAbortSize
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
Maximum value: 4194303
minResSize
Minimum size of a response that can be cached in this content group.
Default minimum response size is 0.
Maximum value: 2097151
maxResSize
Maximum size of a response that can be cached in this content group.
Default value: 80
Maximum value: 2097151
memLimit
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
Ignore Cache-Control and Pragma headers in the incoming request.
Possible values: YES, NO
Default value: YES
minHits
Number of hits that qualifies a response for storage in this content group.
Default value: 0
alwaysEvalPolicies
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.
Possible values: YES, NO
Default value: NO
persistHA
Setting persistHA to YES causes IC to save objects in contentgroup to Secondary node in HA deployment.
Possible values: YES, NO
Default value: NO
pinned
Do not flush objects from this content group under memory pressure.
Possible values: YES, NO
Default value: NO
lazyDnsResolve
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.
Possible values: YES, NO
Default value: YES
hitSelector
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
Selector for invalidating objects in the content group. A selector is an abstraction for a collection of PIXL expressions.
type
The type of the content group.
Possible values: HTTP, MYSQL, MSSQL
Default value: HTTP
rm cache contentGroup¶
Removes the specified content group. Before removing, make sure that no cache policy has its storeInGroup attribute set to this group, otherwise the group cannot be removed.
Synopsys¶
rm cache contentGroup <name>
Arguments¶
name
Name of the content group to be removed.
set cache contentGroup¶
Modifies the specified attributes of the content group.
Synopsys¶
set cache contentGroup <name> [-weakPosRelExpiry <secs> | -relExpiry <secs> | -relExpiryMilliSec <msecs> | -absExpiry <HH:MM> ... | -absExpiryGMT <HH:MM> ...] [-heurExpiryParam <positive_integer>] [-weakNegRelExpiry <secs>] [-hitParams <string> ... | -hitSelector <string> | -invalSelector <string>] [-invalParams <string> ...] [-ignoreParamValueCase ( YES | NO )] [-matchCookies ( YES | NO )] [-invalRestrictedToHost ( YES | NO )] [-pollEveryTime ( YES | NO )] [-ignoreReloadReq ( YES | NO )] [-removeCookies ( YES | NO )] [-prefetch ( YES | NO )] [-prefetchPeriod <secs> | -prefetchPeriodMilliSec <msecs>] [-prefetchMaxPending <positive_integer>] [-flashCache ( YES | NO )] [-expireAtLastByte ( YES | NO )] [-insertVia ( YES | NO )] [-insertAge ( YES | NO )] [-insertETag ( YES | NO )] [-cacheControl <string>] [-quickAbortSize <KBytes>] [-minResSize <KBytes>] [-maxResSize <KBytes>] [-memLimit <MBytes>] [-ignoreReqCachingHdrs ( YES | NO )] [-minHits <integer>] [-alwaysEvalPolicies ( YES | NO )] [-persistHA ( YES | NO )] [-pinned ( YES | NO )] [-lazyDnsResolve ( YES | NO )]
Arguments¶
name
Name of the content group to be modified.
weakPosRelExpiry
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.
Maximum value: 31536000
heurExpiryParam
Heuristic expiry time, in percent of the duration, since the object was last modified.
Minimum value: 0
Maximum value: 100
relExpiry
Relative expiry time, in seconds, after which to expire an object cached in this content group.
Default value: -1
Maximum value: 31536000
relExpiryMilliSec
Relative expiry time, in milliseconds, after which to expire an object cached in this content group.
Default value: -1
Maximum value: 86400000
absExpiry
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
Coordinated Universal Time (GMT), up to 4 times a day, when all objects in the content group must expire.
weakNegRelExpiry
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.
Maximum value: 31536000
hitParams
Parameters to use for parameterized hit evaluation of an object. Up to 128 parameters can be specified. Mutually exclusive with the Hit Selector parameter.
invalParams
Parameters for parameterized invalidation of an object. You can specify up to 8 parameters. Mutually exclusive with invalSelector.
ignoreParamValueCase
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
Evaluate for parameters in the cookie header also.
Possible values: YES, NO
invalRestrictedToHost
Take the host header into account during parameterized invalidation.
Possible values: YES, NO
pollEveryTime
Always poll for the objects in this content group. That is, retrieve the objects from the origin server whenever they are requested.
Possible values: YES, NO
Default value: NO
ignoreReloadReq
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.
Possible values: YES, NO
Default value: YES
removeCookies
Remove cookies from responses.
Possible values: YES, NO
Default value: YES
prefetch
Attempt to refresh objects that are about to go stale.
Possible values: YES, NO
Default value: YES
prefetchPeriod
Time period, in seconds before an object's calculated expiry time, during which to attempt prefetch.
Default value: -1
Maximum value: 4294967294
prefetchPeriodMilliSec
Time period, in milliseconds before an object's calculated expiry time, during which to attempt prefetch.
Default value: -1
Maximum value: 4294967290
prefetchMaxPending
Maximum number of outstanding prefetches that can be queued for the content group.
Minimum value: 0
Maximum value: 4294967294
flashCache
Perform flash cache. Mutually exclusive with Poll Every Time (PET) on the same content group.
Possible values: YES, NO
Default value: NO
expireAtLastByte
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.
Possible values: YES, NO
Default value: NO
insertVia
Insert a Via header into the response.
Possible values: YES, NO
Default value: YES
insertAge
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.
Possible values: YES, NO
Default value: YES
insertETag
Insert an ETag header in the response. With ETag header insertion, the integrated cache does not serve full responses on repeat requests.
Possible values: YES, NO
Default value: YES
cacheControl
Insert a Cache-Control header into the response.
quickAbortSize
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.
Maximum value: 4194303
minResSize
Minimum size of a response that can be cached in this content group.
Default minimum response size is 0.
Maximum value: 2097151
maxResSize
Maximum size of a response that can be cached in this content group.
Default value: 80
Maximum value: 2097151
memLimit
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
Ignore Cache-Control and Pragma headers in the incoming request.
Possible values: YES, NO
Default value: YES
minHits
Number of hits that qualifies a response for storage in this content group.
alwaysEvalPolicies
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.
Possible values: YES, NO
Default value: NO
persistHA
The option for IC objects to save objects to Secondary in a HA deployment. Set YES for IC to take this state.
Possible values: YES, NO
Default value: NO
pinned
The option for IC from flushing objects from this contentgroup under memory pressure. Set YES for IC to take this state.
Possible values: YES, NO
Default value: NO
lazyDnsResolve
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.
Possible values: YES, NO
Default value: YES
hitSelector
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
Selector for invalidating objects in the content group. A selector is an abstraction for a collection of PIXL expressions.
unset cache contentGroup¶
Use this command to remove cache contentGroup settings.Refer to the set cache contentGroup command for meanings of the arguments.
Synopsys¶
unset cache contentGroup <name> [-weakPosRelExpiry] [-heurExpiryParam] [-relExpiry] [-relExpiryMilliSec] [-absExpiry] [-absExpiryGMT] [-weakNegRelExpiry] [-hitParams] [-invalParams] [-ignoreParamValueCase] [-matchCookies] [-invalRestrictedToHost] [-pollEveryTime] [-ignoreReloadReq] [-removeCookies] [-prefetch] [-prefetchPeriod] [-prefetchPeriodMilliSec] [-prefetchMaxPending] [-flashCache] [-expireAtLastByte] [-insertVia] [-insertAge] [-insertETag] [-cacheControl] [-quickAbortSize] [-minResSize] [-maxResSize] [-memLimit] [-ignoreReqCachingHdrs] [-minHits] [-alwaysEvalPolicies] [-persistHA] [-pinned] [-lazyDnsResolve] [-hitSelector] [-invalSelector]
show cache contentGroup¶
Displays information about all content groups, or about the specified content group.
Synopsys¶
show cache contentGroup [<name>]
Arguments¶
name
Name of the content group about which to display information.
Outputs¶
flags
Flags.
type
The type of the content group.
relExpiry
The relative expiry time in seconds.
relExpiryMilliSec
Relative expiry time, in milliseconds, after which to expire an object cached in this content group.
absExpiry
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
Coordinated Universal Time (GMT), up to 4 times a day, when all objects in the content group must expire.
heurExpiryParam
Heuristic expiry time, in percent of the duration, since the object was last modified.
weakPosRelExpiry
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.
weakNegRelExpiry
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.
hitParams
Parameters to use for parameterized hit evaluation of an object. Up to 128 parameters can be specified. Mutually exclusive with the Hit Selector parameter.
invalParams
Parameters for parameterized invalidation of an object. You can specify up to 8 parameters. Mutually exclusive with invalSelector.
ignoreParamValueCase
Ignore case when comparing parameter values during parameterized hit evaluation. (Parameter value case is ignored by default during parameterized invalidation.)
matchCookies
Evaluate for parameters in the cookie header also.
invalRestrictedToHost
Take the host header into account during parameterized invalidation.
pollEveryTime
Always poll for the objects in this content group. That is, retrieve the objects from the origin server whenever they are requested.
ignoreReloadReq
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.
removeCookies
Remove cookies from responses.
prefetch
Attempt to refresh objects that are about to go stale.
prefetchPeriod
Time period, in seconds before an object's calculated expiry time, during which to attempt prefetch.
prefetchPeriodMilliSec
Time period, in milliseconds before an object's calculated expiry time, during which to attempt prefetch.
prefetchCur
Current outstanding prefetches.
prefetchMaxPending
Maximum number of outstanding prefetches that can be queued for the content group.
flashCache
Perform flash cache. Mutually exclusive with Poll Every Time (PET) on the same content group.
expireAtLastByte
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.
insertVia
Insert a Via header into the response.
insertAge
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.
insertETag
Insert an ETag header in the response. With ETag header insertion, the integrated cache does not serve full responses on repeat requests.
cacheControl
Insert a Cache-Control header into the response.
quickAbortSize
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.
minResSize
Minimum size of a response that can be cached in this content group.
Default minimum response size is 0.
maxResSize
Maximum size of a response that can be cached in this content group.
memUsage
Current memory usage.
memDUsage
Current disk memory usage.
diskLimit
Maximum amount of disk that the cache can use. The effective limit is based on the available memory of the NetScaler appliance.
memLimit
Maximum amount of memory that the cache can use. The effective limit is based on the available memory of the NetScaler appliance.
ignoreReqCachingHdrs
Ignore Cache-Control and Pragma headers in the incoming request.
cacheNon304Hits
Cache non 304 hits.
cache304Hits
Cache 304 hits.
cacheCells
Number of cells.
cacheGroupIncarnation
Cache group incarnation.
minHits
Number of hits that qualifies a response for storage in this content group.
alwaysEvalPolicies
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.
persist
Setting persist to YES causes IC to save objects in contentgroup to disk.
persistHA
Setting persistHA to YES causes IC to save objects in contentgroup to Secondary node in HA deployment.
pinned
Do not flush objects from this content group under memory pressure.
lazyDnsResolve
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.
hitSelector
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
Selector for invalidating objects in the content group. A selector is an abstraction for a collection of PIXL expressions.
policyName
Active cache policies refering to this group.
cacheNumInvalPolicy
Number of active Invalidation policies refering to this group.
markerCells
Numbers of marker cells in this group.
builtin
devno
count
stateflag
expire cache contentGroup¶
Forces expiration of all the objects in the specified content group. The next request for any object in the group is sent to the origin server.
Synopsys¶
expire cache contentGroup <name>
Arguments¶
name
Name of the content group whose objects are to be expired.
flush cache contentGroup¶
Flush the objects in the specified content group.
Synopsys¶
flush cache contentGroup <name> [-query <string> | -selectorValue <string>] [-host <string>]
Arguments¶
name
Name of the content group from which to flush objects, or "all" to flush all content groups.
query
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.
host
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.
selectorValue
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.
stat cache contentGroup¶
Displays a summary of cache group statistics.
Synopsys¶
stat cache contentGroup [<name>] [-detail] [-fullValues] [-ntimes <positive_integer>] [-logFile <input_filename>] [-clearstats ( basic | full )]
Arguments¶
name
Name of the cache contentgroup for which to display statistics. If you do not set this parameter, statistics are shown for all cache contentgroups.
detail
Specifies detailed output (including more statistics). The output can be quite voluminous. Without this argument, the output will show only a summary.
fullValues
Specifies that numbers and strings should be displayed in their full form. Without this option, long strings are shortened and large numbers are abbreviated
ntimes
The number of times, in intervals of seven seconds, the statistics should be displayed.
Default value: 1
Minimum value: 0
logFile
The name of the log file to be used as input.
clearstats
Clear the statsistics / counters
Possible values: basic, full
Outputs¶
count
devno
stateflag
Outputs¶
non304 Hits for Content group (non304hit)
Non304 hits for ContentGroup
304 Hits for Content group (304hit)
304 hits for ContentGroup
Number of objects in contentgroup (cell)
Number of objects in contentgroup
Number of marker objects in contentgroup (Mrkcell)
Number of marker objects in contentgroup
Number of times contentgroup is flushed (flushed)
Number of times contentgroup is flushed
current memory usage (CurMem)
current memory usage
maximum memory usage limit (MaxMem)
maximum memory usage limit
Example¶
stat cache contentgroup
Related Commands¶
save cache contentGroup¶
Save the objects in the specified content group.
Synopsys¶
save cache contentGroup <name> [-tosecondary ( YES | NO )]
Arguments¶
name
The name of the content group whose objects are to be save.
tosecondary
content group whose objects are to be sent to secondary.
Possible values: YES, NO
Default value: NO