ADC CLI Commands

cr-vserver

The following operations can be performed on “cr-vserver”:

rm bind rename unset unbind set stat disable show add enable

rm cr vserver

Removes a virtual server.

Synopsis

rm cr vserver @ ...

Arguments

name Name of the virtual server to be removed.

Example

rm vserver cr_vip

bind cr vserver

Binds a cache redirection policy to a cache redirection virtual server.

Synopsis

bind cr vserver \(-lbvserver | \(-policyName \[-priority <positive\_integer>] \[-gotoPriorityExpression ] \[-type ] \[-invoke \( ) ] ) | | -analyticsProfile )

Arguments

name Name of the cache redirection virtual server to which to bind the cache redirection policy.

lbvserver Name of the virtual server to which content is forwarded. Applicable only if the policy is a map policy and the cache redirection virtual server is of type REVERSE.

policyName Name of the cache redirection policy that you are binding.

targetVserver Name of the virtual server to which content is forwarded. Applicable only if the policy is a map policy and the cache redirection virtual server is of type REVERSE.

priority An unsigned integer that determines the priority of the policy relative to other policies bound to this cache redirection virtual server. The lower the value, higher the priority. Note: This option is available only when binding content switching, filtering, and compression policies to a cache redirection virtual server. Minimum value: 0

gotoPriorityExpression Expression or other value specifying the next policy to be evaluated if the current policy evaluates to TRUE. Specify one of the following values:

  • NEXT - Evaluate the policy with the next higher priority number.
  • END - End policy evaluation.
  • USE_INVOCATION_RESULT - Applicable if this policy invokes another policy label. If the final goto in the invoked policy label has a value of END, the evaluation stops. If the final goto is anything other than END, the current policy label performs a NEXT.
  • An expression that evaluates to a number. If you specify an expression, the number to which it evaluates determines the next policy to evaluate, as follows:
  • If the expression evaluates to a higher numbered priority, the policy with that priority is evaluated next.
  • If the expression evaluates to the priority of the current policy, the policy with the next higher numbered priority is evaluated next.
  • If the expression evaluates to a priority number that is numerically higher than the highest numbered priority, policy evaluation ends. An UNDEF event is triggered if:
  • The expression is invalid.
  • The expression evaluates to a priority number that is numerically lower than the current policy’s priority.
  • The expression evaluates to a priority number that is between the current policy’s priority number (say, 30) and the highest priority number (say, 100), b ut does not match any configured priority number (for example, the expression evaluates to the number 85). This example assumes that the priority number incr ements by 10 for every successive policy, and therefore a priority number of 85 does not exist in the policy label.

type For a rewrite policy, the bind point to which to bind the policy. Note: This parameter applies only to rewrite policies, because content switching policies are evaluated only at request time.

Possible values: REQUEST, RESPONSE, ICA_REQUEST

invoke Invoke a policy label if this policy’s rule evaluates to TRUE.

labelType Type of label to be invoked.

Possible values: reqvserver, resvserver, policylabel

labelName Name of the label to be invoked.

analyticsProfile Bind an analytics profile to a CR vserver.

rename cr vserver

Renames a cache redirection virtual server.

Synopsis

rename cr vserver @ @

Arguments

name Existing name of the cache redirection virtual server.

newName New 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. If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my name” or ‘my name’).

Example

rename cr vserver vscr1 vscrnew

unset cr vserver

Restores the specified parameters of a cache redirection virtual server to their default values. To unset all except the Name parameter, do not specify a value for any other parameter. Refer to the set cr vserver command for a description of the parameters..Refer to the set cr vserver command for meanings of the arguments.

Synopsis

unset cr vserver [-dnsVserverName] [-destinationVServer] [-domain] [-backupVServer] [-cltTimeout] [-redirectURL] [-l2Conn] [-backendssl] [-originUSIP] [-usePortRange] [-srcIPExpr] [-tcpProfileName] [-httpProfileName] [-appflowLog] [-netProfile] [-icmpVsrResponse] [-probeProtocol] [-ipset] [-redirect] [-onPolicyMatch] [-arp] [-via] [-reuse] [-disablePrimaryOnDown] [-downStateFlush] [-Listenpolicy] [-Listenpriority] [-comment] [-RHIstate] [-UseOriginIpPortForCache] [-probeSuccessResponseCode] [-disallowServiceAccess]

unbind cr vserver

Unbinds a cache redirection policy from a cache redirection virtual server.

Synopsis

unbind cr vserver \(\(-policyName \[-type ] \[-priority <positive\_integer>]) | -lbvserver | -analyticsProfile )

Arguments

name Name of the cache redirection virtual server from which to unbind the policy.

policyName Name of the cache redirection policy that you are unbinding.

type For rewrite policies, the traffic flow to which the policy applies. Note: This parameter applies only to rewrite policies, because cache redirection policies are evaluated only at request time.

Possible values: REQUEST, RESPONSE, ICA_REQUEST

priority Priority number of the policy from which to unbind the content switching virtual server. Minimum value: 1

lbvserver The virtual server name (created with the add lb vserver command) to which content will be switched. Default value: “default_lb”

analyticsProfile Unbind an analytics profile from CR vserver.

set cr vserver

Changes the specified settings of the cache redirection virtual server.

Synopsis

set cr vserver \[-IPAddress <ip\_addr|ipv6\_addr|\*>] \[-ipset ] \[-redirect ] \[-onPolicyMatch \( CACHE | ORIGIN )] \[-arp \( ON | OFF )] \[-via \( ON | OFF )] \[-dnsVserverName ] \[-destinationVServer ] \[-domain ] \[-reuse \( ON | OFF )] \[-backupVServer ] \[-disablePrimaryOnDown \( ENABLED | DISABLED )] \[-redirectURL ] \[-cltTimeout ] \[-downStateFlush \( ENABLED | DISABLED )] \[-l2Conn \( ON | OFF )] \[-backendssl \( ENABLED | DISABLED )] \[-Listenpolicy ] \[-Listenpriority <positive\_integer>] \[-tcpProfileName ] \[-httpProfileName ] \[-netProfile ] \[-comment ] \[-srcIPExpr ] \[-originUSIP \( ON | OFF )] \[-usePortRange \( ON | OFF )] \[-appflowLog \( ENABLED | DISABLED )] \[-icmpVsrResponse \( PASSIVE | ACTIVE )] \[-RHIstate \( PASSIVE | ACTIVE )] \[-UseOriginIpPortForCache \( YES | NO )] \[-probeProtocol \( TCP | HTTP ) \[-probeSuccessResponseCode ]] \[-probePort <port|\*>] \[-disallowServiceAccess \( ENABLED | DISABLED )]

Arguments

name Name of the cache redirection virtual server.

IPAddress New IPv4 or IPv6 address of the cache redirection virtual server. Usually a public IP address. Clients send connection requests to this IP address.

ipset The list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current cr vserver

redirect 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.

Possible values: CACHE, POLICY, ORIGIN Default value: 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.

Possible values: CACHE, ORIGIN Default value: ORIGIN

arp 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.

Possible values: ON, OFF

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.

Possible values: ON, OFF 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 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.

reuse Reuse TCP connections to the origin server across client connections

Possible values: ON, OFF Default value: ON

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.

Possible values: ENABLED, DISABLED Default value: DISABLED

redirectURL URL of the server to which to redirect traffic if the cache redirection virtual server in the Citrix ADC becomes unavailable.

cltTimeout Time-out value, in seconds, after which an idle client connection is terminated. Maximum value: 31536000

downStateFlush Perform delayed cleanup of connections to this virtual server.

Possible values: ENABLED, DISABLED Default value: ENABLED

l2Conn Use L2 parameters, such as MAC, VLAN, and channel to identify a connection.

Possible values: ON, OFF

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.

Possible values: ENABLED, DISABLED 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 Minimum value: 0 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.

netProfile Name of the network profile containing network configurations for the 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.

Possible values: ON, OFF Default value: VAL_NOT_SET

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

Possible values: ON, OFF Default value: OFF

appflowLog Enable logging of AppFlow information.

Possible values: ENABLED, DISABLED Default value: ENABLED

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.

Possible values: PASSIVE, ACTIVE Default value: 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.

Possible values: PASSIVE, ACTIVE Default value: 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

Possible values: YES, NO Default value: NO

probeProtocol Citrix ADC provides support for external health check of the vserver status. Select HTTP or TCP probes for healthcheck

Possible values: TCP, HTTP

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

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.

Possible values: ENABLED, DISABLED Default value: DISABLED

stat cr vserver

Displays statistics for all cache redirection virtual servers or for the cache redirection virtual server specified by the name parameter.

Synopsis

stat cr vserver [] \[-detail] \[-fullValues] \[-ntimes <positive\_integer>] \[-logFile <input\_filename>] \[-clearstats \( basic | full )]

Arguments

name Name of a specific cache redirection virtual server.

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

Output

count devno stateflag

Counters

IP address (IP) The IP address on which the service is running.

Port (port) The port on which the service is running.

Vserver protocol (Protocol) Protocol associated with the vserver

State Current state of the server. There are seven possible values: UP(7), DOWN(1), UNKNOWN(2), BUSY(3), OFS(Out of Service)(4), TROFS(Transition Out of Service)(5), TROFS_DOWN(Down When going Out of Service)(8)

Vserver hits (Hits) Total vserver hits

Requests (Req) Total number of requests received on this service or virtual server. (This applies to HTTP/SSL services and servers.)

Responses (Rsp) Number of responses received on this service or virtual server. (This applies to HTTP/SSL services and servers.)

Request bytes (Reqb) Total number of request bytes received on this service or virtual server.

Response bytes (Rspb) Number of response bytes received by this service or virtual server.

Total Packets rcvd (PktRx) Total number of packets received by this service or virtual server.

Total Packets sent (PktTx) Total number of packets sent.

Invalid Request/Response (IvldReqRsp) Number invalid requests/responses on this vserver

Invalid Request/Response Dropped (IvldReqRspDrp) Number invalid requests/responses dropped on this vserver

disable cr vserver

Disables a cache redirection virtual server.

Synopsis

disable cr vserver @

Arguments

name Name of the cache redirection virtual server to be disabled. (Because the virtual server is still configured, you can reenable it.) Note: The appliance still responds to ARP and ping requests sent to the IP address of this virtual server.

Example

disable vserver cr_vip

show cr vserver

Displays 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.

Synopsis

show cr vserver []

Arguments

name Name of a cache redirection virtual server about which to display detailed information.

Output

IPAddress td Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.

IPAddress The IP address of the virtual server.

stateflag value The ssl card status for the transparent ssl cr vserver.

port Port number of the virtual server.

range Number of consecutive IP addresses, starting with the address specified by the IP Address parameter, to include in a range of addresses assigned to this virtual server.

serviceType Protocol (type of service) handled by the virtual server.

ngname Nodegroup devno to which this crvserver belongs to

type Virtual server type.

vsvrcfgflags Contains the config info of vserver to be used at validation

state The state of the cr vserver.

status Status.

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.

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.

precedence Type of policy (URL or RULE) that takes precedence on the cache redirection virtual server. Applies only to cache redirection virtual servers that have both URL and RULE based policies. If you specify URL, URL based policies are applied first, in the following order:

  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 If you specify RULE, the rule based policies are applied before URL based policies are applied.

redirectURL URL of the server to which to redirect traffic if the cache redirection virtual server configured on the Citrix ADC becomes unavailable.

authentication Authentication.

homePage Home page.

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.

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.

rule Rule.

policyName Policies bound to this vserver.

piPolicyhits Number of hits.

hits Number of hits.

serviceName Service name.

weight Weight for this service.

cacheVserver Name of the default cache virtual server to which to redirect requests (the default target of the cache redirection virtual server).

targetVserver The CSW target server names.

backupVServer Name of the backup virtual server to which traffic is forwarded if the active server becomes unavailable.

priority The priority for the policy.

cltTimeout Time-out value, in seconds, after which to terminate an idle client connection.

soMethod The spillover factor. When the main virtual server reaches this spillover threshold, it will give further traffic to the backupvserver.

soPersistence The state of spillover persistence.

soPersistenceTimeOut The spillover persistence entry timeout.

soThreshold The spillover threshold value.

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.

arp destinationVServer Destination virtual server for a transparent or forward proxy cache redirection virtual server.

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.

downStateFlush Perform delayed clean up of connections on this vserver.

disablePrimaryOnDown Tells whether traffic will continue reaching backup vservers even after primary comes UP from DOWN state.

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.

comment Comments associated with this virtual server.

Listenpolicy The string is listenpolicy configured for CR vserver

Listenpriority This parameter is the priority for listen policy of CR Vserver.

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.

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.

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

appflowLog Enable logging of AppFlow information.

netProfile Name of the network profile containing network configurations for the cache redirection virtual server.

state Initial state of 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.

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.

lbvserver The Default target server name.

inherited On State describes that policy bound is inherited from global binding.

type The bindpoint to which the policy is bound

invoke Invoke flag.

labelType The invocation type.

labelName Name of the label invoked.

gotoPriorityExpression Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.

ipset The list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current cr vserver

noDefaultBindings to determine if the configuration will have default ssl CIPHER and ECC curve bindings

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

tcpProbePort 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.

analyticsProfile Name of the analytics profile bound to the CR vserver.

probeProtocol Citrix ADC provides support for external health check of the vserver status. Select HTTP or TCP probes for healthcheck

probePort Citrix ADC provides support for external health check of the vserver status. Select port for HTTP/TCP monitring

probeSuccessResponseCode HTTP code to return in SUCCESS case.

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.

devno count

add cr vserver

Creates a cache redirection virtual server.

Synopsis

add cr vserver \[-td <positive\_integer>] \[ \(-ipset | -range <positive\_integer>) ] \[-cacheType \[-disallowServiceAccess \( ENABLED | DISABLED )]] \[-redirect ] \[-onPolicyMatch \( CACHE | ORIGIN )] \[-redirectURL ] \[-cltTimeout ] \[-arp \( ON | OFF )] \[-map \( ON | OFF )] \[-format \( ON | OFF )] \[-via \( ON | OFF )] \[-dnsVserverName ] \[-destinationVServer ] \[-domain ] \[-soPersistenceTimeOut <positive\_integer>] \[-soThreshold <positive\_integer>] \[-reuse \( ON | OFF )] \[-state \( ENABLED | DISABLED )] \[-downStateFlush \( ENABLED | DISABLED )] \[-backupVServer ] \[-disablePrimaryOnDown \( ENABLED | DISABLED )] \[-l2Conn \( ON | OFF )] \[-backendssl \( ENABLED | DISABLED )] \[-Listenpolicy \[-Listenpriority <positive\_integer>]] \[-tcpProfileName ] \[-httpProfileName ] \[-comment ] \[-srcIPExpr ] \[-originUSIP \( ON | OFF )] \[-usePortRange \( ON | OFF )] \[-appflowLog \( ENABLED | DISABLED )] \[-netProfile ] \[-icmpVsrResponse \( PASSIVE | ACTIVE )] \[-RHIstate \( PASSIVE | ACTIVE )] \[-UseOriginIpPortForCache \( YES | NO )] \[-probeProtocol \( TCP | HTTP ) \[-probeSuccessResponseCode ]] \[-probePort <port|\*>]

Arguments

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’).

td Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0. Minimum value: 0 Maximum value: 4094

serviceType Protocol (type of service) handled by the virtual server.

Possible values: HTTP, SSL, NNTP, HDX

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.

Possible values: TRANSPARENT, REVERSE, FORWARD

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.

Possible values: CACHE, POLICY, ORIGIN Default value: 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.

Possible values: CACHE, ORIGIN Default value: 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.

Possible values: ON, OFF

map Obsolete.

Possible values: ON, OFF

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.

Possible values: ON, OFF 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.

Possible values: ON, OFF Default value: ON

state Initial state of the cache redirection virtual server.

Possible values: ENABLED, DISABLED Default value: ENABLED

downStateFlush Perform delayed cleanup of connections to this virtual server.

Possible values: ENABLED, DISABLED 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.

Possible values: ENABLED, DISABLED Default value: DISABLED

l2Conn Use L2 parameters, such as MAC, VLAN, and channel to identify a connection.

Possible values: ON, OFF

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.

Possible values: ENABLED, DISABLED 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 Minimum value: 0 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.

Possible values: ON, OFF Default value: VAL_NOT_SET

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

Possible values: ON, OFF Default value: OFF

appflowLog Enable logging of AppFlow information.

Possible values: ENABLED, DISABLED 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.

Possible values: PASSIVE, ACTIVE Default value: 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.

Possible values: PASSIVE, ACTIVE Default value: 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

Possible values: YES, NO Default value: NO

probeProtocol Citrix ADC provides support for external health check of the vserver status. Select HTTP or TCP probes for healthcheck

Possible values: TCP, HTTP

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

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.

Possible values: ENABLED, DISABLED Default value: DISABLED

enable cr vserver

Enables a cache redirection virtual server. Note: Virtual servers, when added, are enabled by default.

Synopsis

enable cr vserver @

Arguments

name Name of the cache redirection virtual server to be enabled.

Example

enable vserver cr_vip

cr-vserver