Home > Configuration > Integrated Caching

Use this method to creates a new content group for grouping cached objects on the basis of some unique property.

Use this method to allows the cache to act as a forward proxy for other Citrix ADCs or cache servers.

Use this method to creates an integrated caching policy.
The newly created policy is in inactive state. To activate the policy, use the bind cache global method.

Use this method to creates a user-defined cache policy label. A policy label is a bind point of a group of policies.

Use this method to creates an Integrated Cache selector. A selector is an abstraction for a collection of PIXL expressions. After creating a selector, you can use it as a hit selector, invalidation selector, or both. You must specify at least one expression when you create a selector.

Use this method to bind policy to cache global.

Use this method to bind policy to cache policylabel.

Use this method to 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.

Use this method to forces expiry of a cached object. You have to specify the locator ID of the cached object by using the -locator parameter.

Use this method to flush the objects in the specified content group.

Use this method to removes a cached object from memory and from disk (if it has a disk copy). You have to specify the locator ID of the cached object by using the -locator parameter

Use this method to get information about all content groups, or about the specified content group.

Use this method to get the IP address and the corresponding ports for which the cache acted as a forward proxy.

Use this method to get the global bindings for cache policies.

Use this method to get a list of all cached objects. The list displays the unique locator ID of each cached object along with the content group in which it was cached, and other details. To view more details of a specific cached object, use the -locator parameter along with this method.

Use this method to get the global configuration of the Integrated Cache.

Use this method to get all configured cache policies. To display details about a particular cache policy, specify the name of the policy. When all caching policies are displayed, the order of the displayed policies within each group is the same as the evaluation order of the policies. There are three groups: request policies, response policies, and dynamic invalidation policies.

Use this method to get information about all cache-policy labels or about the specified cache-policy label.

Use this method to get all cache selectors, or the specified.

Use this method to renames an existing cache policy.

Use this method to renames a cache-policy label.

Use this method to 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.

Use this method to removes the forward proxy address from the Integrated Cache. The cache does not act as a proxy to the specified IP address.

Use this method to removes the specified caching policy. Make sure that the policy is not bound globally or to a virtual server. A bound policy cannot be removed.

Use this method to removes the specified integrated caching policy label.

Use this method to removes cache selectors. Note: A selector being used as a hit or invalidation selector in any content group cannot be removed without unsetting it from the content group.

Use this method to save the objects in the specified content group.

Use this method to save a cached object to local disk.

Use this method to set 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 method: add cache contentgroup -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 -absexpiry 10:00 15:00 18:00 23:00

Use this method to set coordinated Universal Time (GMT), up to 4 times a day, when all objects in the content group must expire.

Use this method to set 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.

Use this method to set insert a Cache-Control header into the response.

Use this method to set 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.

Use this method to set perform flash cache. Mutually exclusive with Poll Every Time (PET) on the same content group.

Use this method to set heuristic expiry time, in percent of the duration, since the object was last modified.

Use this method to set parameters to use for parameterized hit evaluation of an object. Up to 128 parameters can be specified. Mutually exclusive with the Hit Selector parameter.

Use this method to set selector for evaluating whether an object gets stored in a particular content group. A selector is an abstraction for a collection of PIXL expressions.

Use this method to set ignore case when comparing parameter values during parameterized hit evaluation. (Parameter value case is ignored by default during parameterized invalidation.)

Use this method to set 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.

Use this method to set ignore Cache-Control and Pragma headers in the incoming request.

Use this method to set 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.

Use this method to set insert an ETag header in the response. With ETag header insertion, the integrated cache does not serve full responses on repeat requests.

Use this method to set insert a Via header into the response.

Use this method to set parameters for parameterized invalidation of an object. You can specify up to 8 parameters. Mutually exclusive with invalSelector.

Use this method to set take the host header into account during parameterized invalidation.

Use this method to set selector for invalidating objects in the content group. A selector is an abstraction for a collection of PIXL expressions.

Use this method to set 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.

Use this method to set evaluate for parameters in the cookie header also.

Use this method to set maximum size of a response that can be cached in this content group.

Use this method to set maximum amount of memory that the cache can use. The effective limit is based on the available memory of the Citrix ADC.

Use this method to set number of hits that qualifies a response for storage in this content group.

Use this method to set minimum size of a response that can be cached in this content group.
Default minimum response size is 0.

Use this method to set the option for IC objects to save objects to Secondary in a HA deployment. Set YES for IC to take this state.

Use this method to set the option for IC from flushing objects from this contentgroup under memory pressure. Set YES for IC to take this state.

Use this method to set always poll for the objects in this content group. That is, retrieve the objects from the origin server whenever they are requested.

Use this method to set attempt to refresh objects that are about to go stale.

Use this method to set maximum number of outstanding prefetches that can be queued for the content group.

Use this method to set time period, in seconds before an object's calculated expiry time, during which to attempt prefetch.

Use this method to set time period, in milliseconds before an object's calculated expiry time, during which to attempt prefetch.

Use this method to set 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.

Use this method to set relative expiry time, in seconds, after which to expire an object cached in this content group.

Use this method to set relative expiry time, in milliseconds, after which to expire an object cached in this content group.

Use this method to set remove cookies from responses.

Use this method to set 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.

Use this method to set 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.

Use this method to set the cacheEvictionPolicy determines the threshold for preemptive eviction of cache objects using the LRU (Least Recently Used) algorithm. If set to AGGRESSIVE, eviction is triggered when free cache memory drops to 40%. MODERATE triggers eviction at 25%, and RELAXED triggers eviction at 10%.

Use this method to set 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.

Use this method to set 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.

Use this method to set 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.

Use this method to set 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.

Use this method to set maximum number of outstanding prefetches in the Integrated Cache.

Use this method to set action to take when a policy cannot be evaluated.

Use this method to set 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.

Use this method to set 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.

Use this method to set action to apply to content that matches the policy.
* CACHE or MAY_CACHE action - positive cachability policy
* NOCACHE or MAY_NOCACHE action - negative cachability policy
* INVAL action - Dynamic Invalidation Policy

Use this method to set content group(s) to be invalidated when the INVAL action is applied. Maximum number of content groups that can be specified is 16.

Use this method to set content groups(s) in which the objects will be invalidated if the action is INVAL.

Use this method to set expression against which the traffic is evaluated.
The following requirements apply only to the Citrix ADC CLI:
* If the expression includes one or more spaces, enclose the entire expression in double quotation marks.
* If the expression itself includes double quotation marks, escape the quotations by using the \ character.
* Alternatively, you can use single quotation marks to enclose the rule, in which case you do not have to escape the double quotation marks.

Use this method to set name of the content group in which to store the object when the final result of policy evaluation is CACHE. The content group must exist before being mentioned here. Use the "show cache contentgroup" method to view the list of existing content groups.

Use this method to set action to be performed when the result of rule evaluation is undefined.

Use this method to set one or multiple PIXL expressions for evaluating an HTTP request or response.
This is mandatory parameter.

Use this method to unbind policy from cache global.

Use this method to unbind priority from cache global.

Use this method to unbind policy from cache policylabel.

Use this method to unbind priority from cache policylabel.

Remove cache contentGroup absexpiry setting.

Remove cache contentGroup absexpirygmt setting.

Remove cache contentGroup alwaysevalpolicies setting.

Remove cache contentGroup cachecontrol setting.

Remove cache contentGroup expireatlastbyte setting.

Remove cache contentGroup flashcache setting.

Remove cache contentGroup heurexpiryparam setting.

Remove cache contentGroup hitparams setting.

Remove cache contentGroup hitselector setting.

Remove cache contentGroup ignoreparamvaluecase setting.

Remove cache contentGroup ignorereloadreq setting.

Remove cache contentGroup ignorereqcachinghdrs setting.

Remove cache contentGroup insertage setting.

Remove cache contentGroup insertetag setting.

Remove cache contentGroup insertvia setting.

Remove cache contentGroup invalparams setting.

Remove cache contentGroup invalrestrictedtohost setting.

Remove cache contentGroup invalselector setting.

Remove cache contentGroup lazydnsresolve setting.

Remove cache contentGroup matchcookies setting.

Remove cache contentGroup maxressize setting.

Remove cache contentGroup memlimit setting.

Remove cache contentGroup minhits setting.

Remove cache contentGroup minressize setting.

Remove cache contentGroup persistha setting.

Remove cache contentGroup pinned setting.

Remove cache contentGroup polleverytime setting.

Remove cache contentGroup prefetch setting.

Remove cache contentGroup prefetchmaxpending setting.

Remove cache contentGroup prefetchperiod setting.

Remove cache contentGroup prefetchperiodmillisec setting.

Remove cache contentGroup quickabortsize setting.

Remove cache contentGroup relexpiry setting.

Remove cache contentGroup relexpirymillisec setting.

Remove cache contentGroup removecookies setting.

Remove cache contentGroup weaknegrelexpiry setting.

Remove cache contentGroup weakposrelexpiry setting.

Remove cache parameter cacheevictionpolicy setting.

Remove cache parameter enablebypass setting.

Remove cache parameter enablehaobjpersist setting.

Remove cache parameter maxpostlen setting.

Remove cache parameter memlimit setting.

Remove cache parameter prefetchmaxpending setting.

Remove cache parameter undefaction setting.

Remove cache parameter verifyusing setting.

Remove cache parameter via setting.

Remove cache policy invalgroups setting.

Remove cache policy invalobjects setting.

Remove cache policy storeingroup setting.

Remove cache policy undefaction setting.