Home > Configuration > Content Switching

Use this method to creates an action that indicates the target load balancing virtual server. This action is used to specify the target load balancing virtual server while defining a policy to support multiple policy bind support.

Use this method to creates a new content switching policy. You use this policy to manage content switching on a virtual server.

Use this method to adds a content switching policy label.

Use this method to creates a content switching virtual server.

Use this method to bind gotopriorityexpression to cs policylabel.

Use this method to bind invoke to cs policylabel.

Use this method to bind targetvserver to cs policylabel.

Use this method to bind analyticsprofile to cs vserver.

Use this method to bind domain to cs vserver.

Use this method to bind lbvserver to cs vserver.

Use this method to bind policy to cs vserver.

Use this method to bind targetvserver to cs vserver.

Use this method to bind vserver to cs vserver.

Use this method to disables a content switching virtual server.

Use this method to enables a content switching virtual server.

Use this method to get the configuration settings of the specified content switching action or lists all the content switching actions configured on the appliance.

Use this method to get CS parameters

Use this method to get all existing content switching policies, or just the specified policy.

Use this method to get all the content switching policy labels, or just the specified policy label.

Use this method to get all existing content switching virtual servers, or just the specified virtual server.

Use this method to renames a content switching action.

Use this method to rename a content switching policy.

Use this method to rename a content switching policy label.

Use this method to renames a content switching virtual server.

Use this method to removes a content switching action.

Use this method to removes a content switching policy. You can delete a user-defined content switching policy that is not bound to a content switching 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 content switching policy label.

Use this method to removes a content switching virtual server.

Use this method to set comments associated with this cs action.

Use this method to set name of the load balancing virtual server to which the content is switched.

Use this method to set name of the VPN, GSLB or Authentication virtual server to which the content is switched.

Use this method to set information about this content switching action.

Use this method to set specifies whether the virtual server checks the attached load balancing server for state information.

Use this method to set the content switching action name.

Use this method to set the log action associated with the content switching policy

Use this method to set the condition for applying this policy.

Use this method to set the API profile where one or more API specs are bounded to.

Use this method to set enable logging appflow flow information

Use this method to set authenticate users who request a connection to the content switching virtual server.

Use this method to set fQDN of the authentication virtual server. The service type of the virtual server should be either HTTP or SSL.

Use this method to set enable HTTP 401-response based authentication.

Use this method to set name of the authentication profile to be used when authentication is turned on.

Use this method to set name of authentication virtual server that authenticates the incoming user requests to this content switching virtual server.

Use this method to set time period for which backup persistence is in effect.

Use this method to set name of the backup virtual server that you are configuring. 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 backup virtual server is created. You can assign a different backup virtual server or rename the existing virtual server.
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.

Use this method to set the option to specify whether a virtual server used for content switching will route requests to the cache redirection virtual server before sending it to the configured servers.

Use this method to set the URL lookup case option on the content switching vserver.
If case sensitivity of a content switching virtual server is set to 'ON', the URLs /a/1.html and /A/1.HTML are treated differently and may have different targets (set by content switching policies).
If case sensitivity is set to 'OFF', the URLs /a/1.html and /A/1.HTML are treated the same, and will be switched to the same target.
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 client timeout in seconds.

Use this method to set information about this virtual server.

Use this method to set use this parameter to specify the cookie name for COOKIE peristence type. It specifies the name of cookie with a maximum of 32 characters. If not specified, cookie name is internally generated.

Use this method to set name of the DB profile.

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

Use this method to set this option is used to enable/disable DNS over HTTPS (DoH) processing.

Use this method to set name of the DNS profile to be associated with the VServer. DNS profile properties will applied to the transactions processed by a VServer. This parameter is valid only for DNS and DNS-TCP VServers.

Use this method to set domain name for which to change the time to live (TTL) and/or backup service IP address.

Use this method to set flush all active transactions associated with a virtual server whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions.

Use this method to set this option starts/stops the dtls service on the vserver

Use this method to set name of the HTTP profile containing HTTP configuration settings for the virtual server. The service type of the virtual server should be either HTTP or SSL.

Use this method to set uRL to which all HTTP traffic received on the port specified in the -redirectFromPort parameter is redirected.

Use this method to set can be active or passive

Use this method to set the virtual IP and port header insertion option for the vserver.
* VIPADDR - Header contains the vserver's IP address and port number without any translation.
* OFF - The virtual IP and port header insertion option is disabled.
* V6TOV4MAPPING - Header contains the mapped IPv4 address that corresponds to the IPv6 address of the vserver and the port number. An IPv6 address can be mapped to a user-specified IPv4 address using the set ns ip6 method.

Use this method to set the new IP address of the virtual server.

Use this method to set iP mask, in dotted decimal notation, for the IP Pattern parameter. Can have leading or trailing non-zero octets (for example, 255.255.240.0 or 0.0.255.255). Accordingly, the mask specifies whether the first n bits or the last n bits of the destination IP address in a client request are to be matched with the corresponding bits in the IP pattern. The former is called a forward mask. The latter is called a reverse mask.

Use this method to set iP address pattern, in dotted decimal notation, for identifying packets to be accepted by the virtual server. The IP Mask parameter specifies which part of the destination IP address is matched against the pattern. Mutually exclusive with the IP Address parameter.
For example, if the IP pattern assigned to the virtual server is 198.51.100.0 and the IP mask is 255.255.240.0 (a forward mask), the first 20 bits in the destination IP addresses are matched with the first 20 bits in the pattern. The virtual server accepts requests with IP addresses that range from 198.51.96.1 to 198.51.111.254. You can also use a pattern such as 0.0.2.2 and a mask such as 0.0.255.255 (a reverse mask).
If a destination IP address matches more than one IP pattern, the pattern with the longest match is selected, and the associated virtual server processes the request. For example, if the virtual servers, vs1 and vs2, have the same IP pattern, 0.0.100.128, but different IP masks of 0.0.255.255 and 0.0.224.255, a destination IP address of 198.51.100.128 has the longest match with the IP pattern of vs1. If a destination IP address matches two or more virtual servers to the same extent, the request is processed by the virtual server whose port number matches the port number in the request.

Use this method to set the list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current cs vserver

Use this method to set use L2 Parameters to identify a connection

Use this method to set string specifying the listen policy for the content switching virtual server. Can be either the name of an existing expression or an in-line expression.

Use this method to set integer specifying the priority of the listen policy. A higher number specifies a lower priority. If a request matches the listen policies of more than one virtual server the virtual server whose listen policy has the highest priority (the lowest priority number) accepts the request.

Use this method to set the version of the MSSQL server

Use this method to set the character set returned by the mysql vserver.

Use this method to set the protocol version returned by the mysql vserver.

Use this method to set the server capabilities returned by the mysql vserver.

Use this method to set the server version string returned by the mysql vserver.

Use this method to set the name of the network profile.

Use this method to set oracle server version

Use this method to set backup persistence type for the virtual server. Becomes operational if the primary persistence mechanism fails.

Use this method to set Type of persistence for the virtual server. Available settings function as follows:
* SOURCEIP - Connections from the same client IP address belong to the same persistence session.
* COOKIEINSERT - Connections that have the same HTTP Cookie, inserted by a Set-Cookie directive from a server, belong to the same persistence session.
* SSLSESSION - Connections that have the same SSL Session ID belong to the same persistence session.

Use this method to set persistence mask for IP based persistence types, for IPv4 virtual servers.

Use this method to set the precedence on the content switching virtual server between rule-based and URL-based policies. The default precedence is set to RULE.
If the precedence is configured as RULE, the incoming request is applied against the content switching policies created with the -rule argument. If none of the rules match, then the URL in the request is applied against the content switching policies created with the -url option.
For example, this precedence can be used if certain client attributes (such as a specific type of browser) need to be served different content and all other clients can be served from the content distributed among the servers.
If the precedence is configured as URL, the incoming request URL is applied against the content switching policies created with the -url option. If none of the policies match, then the request is applied against the content switching policies created with the -rule option.
Also, this precedence can be used if some content (such as images) is the same for all clients, but other content (such as text) is different for different clients. In this case, the images will be served to all clients, but the text will be served to specific clients based on specific attributes, such as Accept-Language.
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 process traffic with the push virtual server that is bound to this content switching virtual server (specified by the Push VServer parameter). The service type of the push virtual server should be either HTTP or SSL.

Use this method to set expression for extracting the label from the response received from server. This string can be either an existing rule name or an inline expression. The service type of the virtual server should be either HTTP or SSL.

Use this method to set allow multiple Web 2.0 connections from the same client to connect to the virtual server and expect updates.

Use this method to set name of the load balancing virtual server, of type PUSH or SSL_PUSH, to which the server pushes updates received on the client-facing load balancing virtual server.

Use this method to set name of QUIC profile which will be attached to the Content Switching VServer.

Use this method to set port number for the virtual server, from which we absorb the traffic for http redirect

Use this method to set sSL redirect port rewrite.

Use this method to set the redirect URL for content switching.

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 enable network address translation (NAT) for real-time streaming protocol (RTSP) connections.

Use this method to set action to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists

Use this method to set the spillover factor. When traffic on the main virtual server reaches this threshold, additional traffic is sent to the backupvserver.

Use this method to set maintain source-IP based persistence on primary and backup virtual servers.

Use this method to set the spillover persistency entry timeout.

Use this method to set depending on the spillover method, the maximum number of connections or the maximum total bandwidth (Kbps) that a virtual server can handle before spillover occurs.

Use this method to set enable state updates for a specific content switching virtual server. By default, the Content Switching virtual server is always UP, regardless of the state of the Load Balancing virtual servers bound to it. This parameter interacts with the global setting as follows:
Global Level | Vserver Level | Result
ENABLED ENABLED ENABLED
ENABLED DISABLED ENABLED
DISABLED ENABLED ENABLED
DISABLED DISABLED DISABLED
If you want to enable state updates for only some content switching virtual servers, be sure to disable the state update parameter.

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 TCP profile containing TCP configuration settings for the virtual server.

Use this method to set time period for which a persistence session is in effect.

Use this method to set persistence mask for IP based persistence types, for IPv6 virtual servers.

Use this method to unbind policy from cs policylabel.

Use this method to unbind analyticsprofile from cs vserver.

Use this method to unbind domain from cs vserver.

Use this method to unbind lbvserver from cs vserver.

Use this method to unbind policy from cs vserver.

Use this method to unbind vserver from cs vserver.

Remove cs action comment setting.

Remove cs parameter stateupdate setting.

Remove cs policy logaction setting.

Remove cs vserver apiprofile setting.

Remove cs vserver appflowlog setting.

Remove cs vserver authentication setting.

Remove cs vserver authenticationhost setting.

Remove cs vserver authn401 setting.

Remove cs vserver authnprofile setting.

Remove cs vserver authnvs setting.

Remove cs vserver backuppersistencetimeout setting.

Remove cs vserver backupvserver setting.

Remove cs vserver cacheable setting.

Remove cs vserver casesensitive setting.

Remove cs vserver clttimeout setting.

Remove cs vserver comment setting.

Remove cs vserver cookie setting.

Remove cs vserver dbprofile setting.

Remove cs vserver disableprimaryondown setting.

Remove cs vserver dnsoverhttps setting.

Remove cs vserver dnsprofile setting.

Remove cs vserver dnsrecordtype setting.

Remove cs vserver downstateflush setting.

Remove cs vserver dtls setting.

Remove cs vserver httpprofile setting.

Remove cs vserver httpsredirecturl setting.

Remove cs vserver icmpvsrresponse setting.

Remove cs vserver insertvserveripport setting.

Remove cs vserver ipset setting.

Remove cs vserver l2conn setting.

Remove cs vserver listenpolicy setting.

Remove cs vserver listenpriority setting.

Remove cs vserver mssqlserverversion setting.

Remove cs vserver mysqlcharacterset setting.

Remove cs vserver mysqlprotocolversion setting.

Remove cs vserver mysqlservercapabilities setting.

Remove cs vserver mysqlserverversion setting.

Remove cs vserver netprofile setting.

Remove cs vserver oracleserverversion setting.

Remove cs vserver persistencebackup setting.

Remove cs vserver persistenceid setting.

Remove cs vserver persistencetype setting.

Remove cs vserver persistmask setting.

Remove cs vserver precedence setting.

Remove cs vserver probeprotocol setting.

Remove cs vserver probesuccessresponsecode setting.

Remove cs vserver push setting.

Remove cs vserver pushlabel setting.

Remove cs vserver pushmulticlients setting.

Remove cs vserver pushvserver setting.

Remove cs vserver quicprofile setting.

Remove cs vserver redirectfromport setting.

Remove cs vserver redirectportrewrite setting.

Remove cs vserver redirecturl setting.

Remove cs vserver rhistate setting.

Remove cs vserver rtspnat setting.

Remove cs vserver sobackupaction setting.

Remove cs vserver somethod setting.

Remove cs vserver sopersistence setting.

Remove cs vserver sopersistencetimeout setting.

Remove cs vserver sothreshold setting.

Remove cs vserver stateupdate setting.

Remove cs vserver tcpprobeport setting.

Remove cs vserver tcpprofile setting.

Remove cs vserver timeout setting.

Remove cs vserver v6persistmasklen setting.

Remove cs vserver vipheader setting.