| addcrvserver |
Use this method to creates a cache redirection virtual server. |
Syntax |
Parameters |
name |
Name for the cache redirection virtual server. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. Can be changed after the cache redirection virtual server is created.
The following requirement applies only to the Citrix ADC CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my server" or 'my server'). This is mandatory parameter. |
servicetype |
Protocol (type of service) handled by the virtual server. This is mandatory parameter. |
ipaddress |
IPv4 or IPv6 address of the cache redirection virtual server. Usually a public IP address. Clients send connection requests to this IP address.
Note: For a transparent cache redirection virtual server, use an asterisk (*) to specify a wildcard virtual server address. |
port |
Port number of the virtual server. Default value = 80. Minimum value = 1. Maximum value = 65534. |
ipset |
The list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current cr vserver |
range |
Number of consecutive IP addresses, starting with the address specified by the IPAddress parameter, to include in a range of addresses assigned to this virtual server. Default value = 1. Minimum value = 1. Maximum value = 254. |
cachetype |
Mode of operation for the cache redirection virtual server. Available settings function as follows:
* TRANSPARENT - Intercept all traffic flowing to the appliance and apply cache redirection policies to determine whether content should be served from the cache or from the origin server.
* FORWARD - Resolve the hostname of the incoming request, by using a DNS server, and forward requests for non-cacheable content to the resolved origin servers. Cacheable requests are sent to the configured cache servers.
* REVERSE - Configure reverse proxy caches for specific origin servers. Incoming traffic directed to the reverse proxy can either be served from a cache server or be sent to the origin server with or without modification to the URL.
The default value for cache type is TRANSPARENT if service is HTTP or SSL whereas the default cache type is FORWARD if the service is HDX. |
redirect |
Type of cache 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. Default value = CRD_POLICY. |
onpolicymatch |
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. Default value = CRD_ORIGIN. |
redirecturl |
URL of the server to which to redirect traffic if the cache redirection virtual server configured on the Citrix ADC becomes unavailable. |
clttimeout |
Time-out value, in seconds, after which to terminate an idle client connection. Maximum value = 31536000. |
arp |
Use ARP to determine the destination MAC address. |
map |
Obsolete. |
format |
via |
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. Default value = ON. |
dnsvservername |
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. |
destinationvserver |
Destination virtual server for a transparent or forward proxy cache redirection virtual server. |
domain |
Default domain for reverse proxies. Domains are configured to direct an incoming request 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. |
sopersistencetimeout |
Time-out, in minutes, for spillover persistence. Minimum value = 2. Maximum value = 24. |
sothreshold |
For CONNECTION (or) DYNAMICCONNECTION spillover, the number of connections above which the virtual server enters spillover mode. For BANDWIDTH spillover, the amount of incoming and outgoing traffic (in Kbps) before spillover. For HEALTH spillover, the percentage of active services (by weight) below which spillover occurs. Minimum value = 1. |
reuse |
Reuse TCP connections to the origin server across client connections. Do not set this parameter unless the Service Type parameter is set to HTTP. If you set this parameter to OFF, the possible settings of the Redirect parameter function as follows:
* CACHE - TCP connections to the cache servers are not reused.
* ORIGIN - TCP connections to the origin servers are not reused.
* POLICY - TCP connections to the origin servers are not reused.
If you set the Reuse parameter to ON, connections to origin servers and connections to cache servers are reused. Default value = ON. |
state |
Initial state of the cache redirection virtual server. Default value = ENABLED. |
downstateflush |
Perform delayed cleanup of connections to this virtual server. Default value = ENABLED. |
backupvserver |
Name of the backup virtual server to which traffic is forwarded if the active server becomes unavailable. |
disableprimaryondown |
Continue sending traffic to a backup virtual server even after the primary virtual server comes UP from the DOWN state. Default value = DISABLED. |
l2conn |
Use L2 parameters, such as MAC, VLAN, and channel to identify a connection. |
backendssl |
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. Default value = DISABLED. |
listenpolicy |
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. Default value = "NONE". |
listenpriority |
Priority of the listen policy specified by the Listen Policy parameter. The lower the number, higher the priority. Default value = 101. Maximum value = 100. |
tcpprofilename |
Name of the profile containing TCP configuration information for the cache redirection virtual server. |
httpprofilename |
Name of the profile containing HTTP configuration information for cache redirection virtual server. |
comment |
Comments associated with this virtual server. |
srcipexpr |
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. |
originusip |
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. Default value = VAL_NOT_SET. |
useportrange |
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. Default value = OFF. |
appflowlog |
Enable logging of AppFlow information. Default value = ENABLED. |
netprofile |
Name of the network profile containing network configurations for the cache redirection virtual server. |
icmpvsrresponse |
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. Default value = NS_VSR_PASSIVE. |
rhistate |
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. Default value = NS_VSR_PASSIVE. |
useoriginipportforcache |
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 Default value = NO. |
probeprotocol |
Citrix ADC provides support for external health check of the vserver status. Select HTTP or TCP probes for healthcheck |
probesuccessresponsecode |
HTTP code to return in SUCCESS case. Default value = "200 OK". |
probeport |
Citrix ADC provides support for external health check of the vserver status. Select port for HTTP/TCP monitring Default value = 0. Range 1 - 65535. |
disallowserviceaccess |
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. Default value = DISABLED. |
Return Value |
Returns simpleResult |
See Also |