Home > Configuration > Cache Redirection

Cache Redirection

cache redirection configuration. the cache redirection feature can transparently redirect cacheable http requests to a cache and send non-cacheable or dynamic http requests to the origin server. a cache stores or caches frequently requested web content and serves such web content to a client on behalf of the origin servers, alleviating the load on the origin server farm.

Configuration APIs


Use this method to creates a cache redirection policy. To associate the new policy with a cache redirection virtual server, use the bind cr vserver method.


Use this method to creates a cache redirection virtual server.


Use this method to bind analyticsprofile to cr vserver.


Use this method to bind lbvserver to cr vserver.


Use this method to bind policy to cr vserver.


Use this method to disables a cache redirection virtual server.


Use this method to enables a cache redirection virtual server.
Note: Virtual servers, when added, are enabled by default.


Use this method to get information about all the built-in or user defined cache redirection actions.


Use this method to get all existing cache redirection policies, or just the specified policy.


Use this method to get cache redirection virtual server information. To display information about all configured cache redirection virtual servers, do not include a parameter. To display detailed information about a specific virtual server, use the name parameter to specify the name of the virtual server.


Use this method to rename a cache redirection policy.


Use this method to renames a cache redirection virtual server.


Use this method to removes a cache redirection policy. You can delete a user-defined cache redirection policy that is not bound to a cache redirection virtual server. If the policy is bound to a virtual server, you must first unbind the policy, and then remove it.


Use this method to removes a virtual server.


Use this method to set the cache redirection action name.


Use this method to set the log action associated with the cache redirection policy


Use this method to set expression, or name of a named expression, against which 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 enable logging of AppFlow information.


Use this method to set use ARP to determine the destination MAC address. Specify OFF to use the incoming destination MAC address, or ON to use ARP to determine the destination MAC address.


Use this method to set decides whether the backend connection made by Citrix ADC to the origin server will be HTTP or SSL. Applicable only for SSL type CR Forward proxy vserver.


Use this method to set name of the backup virtual server to which traffic is forwarded if the active server becomes unavailable.


Use this method to set name of the default target cache virtual server to which to redirect requests.
NOTE: This attribute is deprecated.
The functionality is intact, but we advise to use bind method to do default binding for CR


Use this method to set time-out value, in seconds, after which an idle client connection is terminated.


Use this method to set comments associated with this virtual server.


Use this method to set destination virtual server for a transparent or forward proxy cache redirection virtual server.


Use this method to set continue sending traffic to a backup virtual server even after the primary virtual server comes UP from the DOWN state.


Use this method to set this is effective when a FORWARD type cr vserver is added. By default, this parameter is DISABLED. When it is ENABLED, backend services cannot be accessed through a FORWARD type cr vserver.


Use this method to set name of the DNS virtual server that resolves domain names arriving at the forward proxy virtual server.
Note: This parameter applies only to forward proxy virtual servers, not reverse or transparent.


Use this method to set default domain for reverse proxies. Domains are configured to direct incoming requests from a specified source domain to a specified target domain. There can be several configured pairs of source and target domains. You can select one pair to be the default. If the host header or URL of an incoming request does not include a source domain, this option sends the request to the specified target domain.


Use this method to set perform delayed cleanup of connections to this virtual server.


Use this method to set name of the profile containing HTTP configuration information for cache redirection virtual server.


Use this method to set criterion for responding to PING requests sent to this virtual server. If ACTIVE, respond only if the virtual server is available. If PASSIVE, respond even if the virtual server is not available.


Use this method to set new IPv4 or IPv6 address of the cache redirection virtual server. Usually a public IP address. Clients send connection requests to this IP address.


Use this method to set use L2 parameters, such as MAC, VLAN, and channel to identify a connection.


Use this method to set string specifying the listen policy for the cache redirection virtual server. Can be either an in-line expression or the name of a named expression.


Use this method to set priority of the listen policy specified by the Listen Policy parameter. The lower the number, higher the priority.


Use this method to set name of the network profile containing network configurations for the cache redirection virtual server.


Use this method to set redirect requests that match the policy to either the cache or the origin server, as specified.
Note: For this option to work, you must set the cache redirection type to POLICY.


Use this method to set use the client's IP address as the source IP address in requests sent to the origin server.
Note: You can enable this parameter to implement fully transparent CR deployment.


Use this method to set type of policy (URL or RULE) that takes precedence on the cache redirection virtual server. You can use this argument only when configuring cache redirection on the specified virtual server. It applies only if both URL and RULE based policies have been configured on the same virtual server. Available settings function as follows:URL - The incoming request is matched against the URL-based policies before it is matched against the rule-based policies.
For URL based policies, the precedence hierarchy is:
1. Domain and exact URL
2. Domain, prefix and suffix
3. Domain and suffix
4. Domain and prefix
5. Domain only
6. Exact URL
7. Prefix and suffix
8. Suffix only
9. Prefix only
10. Default
RULE - The incoming request is matched against the rule-based policies before it is matched against the URL-based policies.
NOTE: This attribute is deprecated.
This attribute is deprecated. Starting from the 13.1 release, only Advanced CS policies are supported and this parameter has no effect on Advanced policies.


Use this method to set citrix ADC provides support for external health check of the vserver status. Select port for HTTP/TCP monitring


Use this method to set citrix ADC provides support for external health check of the vserver status. Select HTTP or TCP probes for healthcheck


Use this method to set type of server to which to redirect HTTP requests. Available settings function as follows: * CACHE - Direct all requests to the cache.* POLICY - Apply the cache redirection policy to determine whether the request should be directed to the cache or to the origin.* ORIGIN - Direct all requests to the origin server.


Use this method to set uRL of the server to which to redirect traffic if the cache redirection virtual server in the Citrix ADC becomes unavailable.


Use this method to set reuse TCP connections to the origin server across client connections


Use this method to set a host route is injected according to the setting on the virtual servers
* If set to PASSIVE on all the virtual servers that share the IP address, the appliance always injects the hostroute.
* If set to ACTIVE on all the virtual servers that share the IP address, the appliance injects even if one virtual server is UP.
* If set to ACTIVE on some virtual servers and PASSIVE on the others, the appliance, injects even if one virtual server set to ACTIVE is UP.


Use this method to set expression used to extract the source IP addresses from the requests originating from the cache. Can be either an in-line expression or the name of a named expression.


Use this method to set port number for external TCP probe. NetScaler provides support for external TCP health check of the vserver status over the selected port. This option is only supported for vservers assigned with an IPAddress or ipset.
NOTE: This attribute is deprecated.
The functionality is intact, but we advise to use -probePort and -probeProtocol options


Use this method to set name of the profile containing TCP configuration information for the cache redirection virtual server.


Use this method to set use origin ip/port while forwarding request to the cache. Change the destination IP, destination port of the request came to CR vserver to Origin IP and Origin Port and forward it to Cache


Use this method to set use a port number from the port range (set by using the set ns param method, or in the Create Virtual Server (Cache Redirection) dialog box) as the source port in the requests sent to the origin server.


Use this method to set insert a via header in each HTTP request. In the case of a cache miss, the request is redirected from the cache server to the origin server. This header indicates whether the request is being sent from a cache server.


Use this method to unbind analyticsprofile from cr vserver.


Use this method to unbind lbvserver from cr vserver.


Use this method to unbind policy from cr vserver.


Remove cr policy logaction setting.


Remove cr vserver appflowlog setting.


Remove cr vserver arp setting.


Remove cr vserver backendssl setting.


Remove cr vserver backupvserver setting.


Remove cr vserver cachevserver setting.


Remove cr vserver clttimeout setting.


Remove cr vserver comment setting.


Remove cr vserver destinationvserver setting.


Remove cr vserver disableprimaryondown setting.


Remove cr vserver disallowserviceaccess setting.


Remove cr vserver dnsvserver setting.


Remove cr vserver domain setting.


Remove cr vserver downstateflush setting.


Remove cr vserver httpprofile setting.


Remove cr vserver icmpvsrresponse setting.


Remove cr vserver ipset setting.


Remove cr vserver l2conn setting.


Remove cr vserver listenpolicy setting.


Remove cr vserver listenpriority setting.


Remove cr vserver netprofile setting.


Remove cr vserver onpolicymatch setting.


Remove cr vserver originusip setting.


Remove cr vserver precedence setting.


Remove cr vserver probeprotocol setting.


Remove cr vserver probesuccessresponsecode setting.


Remove cr vserver redirect setting.


Remove cr vserver redirecturl setting.


Remove cr vserver reuse setting.


Remove cr vserver rhistate setting.


Remove cr vserver srcipexpr setting.


Remove cr vserver tcpprobeport setting.


Remove cr vserver tcpprofile setting.


Remove cr vserver useoriginipportforcache setting.


Remove cr vserver useportrange setting.


Remove cr vserver via setting.