| addcsvserver |
Use this method to creates a content switching virtual server. |
Syntax |
Parameters |
name |
Name for the content switching 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.
Cannot be changed after the CS 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 used by the virtual server. This is mandatory parameter. |
ipaddress |
IP address of the content switching virtual server. |
targettype |
Virtual server target type. Default value = VAL_NOT_SET. |
dnsrecordtype |
Default value = NSGSLB_IPV4. |
persistenceid |
Maximum value = 65535. |
ippattern |
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. |
ipmask |
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. |
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. Default value = 1. Minimum value = 1. Maximum value = 254. |
port |
Port number for content switching virtual server. Minimum value = 1. Range 1 - 65535. |
ipset |
The list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current cs vserver |
state |
Initial state of the load balancing virtual server. Default value = ENABLED. |
stateupdate |
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. Default value = DISABLED. |
cacheable |
Use this option to specify whether a virtual server, used for load balancing or content switching, routes requests to the cache redirection virtual server before sending it to the configured servers. Default value = NO. |
redirecturl |
URL to which traffic is redirected if the virtual server becomes unavailable. The service type of the virtual server should be either HTTP or SSL.
Caution: Make sure that the domain in the URL does not match the domain specified for a content switching policy. If it does, requests are continuously redirected to the unavailable virtual server. |
clttimeout |
Idle time, in seconds, after which the client connection is terminated. The default values are:
180 seconds for HTTP/SSL-based services.
9000 seconds for other TCP-based services.
120 seconds for DNS-based services.
120 seconds for other UDP-based services. Default value = VAL_NOT_SET. Maximum value = 31536000. |
somethod |
Type of spillover used to divert traffic to the backup virtual server when the primary virtual server reaches the spillover threshold. Connection spillover is based on the number of connections. Bandwidth spillover is based on the total Kbps of incoming and outgoing traffic. |
sopersistence |
Maintain source-IP based persistence on primary and backup virtual servers. Default value = DISABLED. |
sopersistencetimeout |
Time-out value, in minutes, for spillover persistence. Default value = 2. Minimum value = 2. Maximum value = 1440. |
sothreshold |
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. Minimum value = 1. Maximum value = NS_MAX_BW_AND_CLIENT. |
sobackupaction |
Action to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists |
redirectportrewrite |
State of port rewrite while performing HTTP redirect. Default value = DISABLED. |
downstateflush |
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. Default value = ENABLED. |
backupvserver |
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. |
disableprimaryondown |
Continue forwarding the traffic to backup virtual server even after the primary server comes UP from the DOWN state. Default value = DISABLED. |
insertvserveripport |
Insert the virtual server's VIP address and port number in the request header. Available values function as follows:
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 corresponding 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. |
vipheader |
Name of virtual server IP and port header, for use with the VServer IP Port Insertion parameter. |
rtspnat |
Enable network address translation (NAT) for real-time streaming protocol (RTSP) connections. Default value = OFF. |
authenticationhost |
FQDN of the authentication virtual server. The service type of the virtual server should be either HTTP or SSL. |
authentication |
Authenticate users who request a connection to the content switching virtual server. Default value = OFF. |
listenpolicy |
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. Default value = "NONE". |
listenpriority |
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. Default value = 101. Minimum value = 0. Maximum value = 100. |
authn401 |
Enable HTTP 401-response based authentication. Default value = OFF. |
authnvsname |
Name of authentication virtual server that authenticates the incoming user requests to this content switching virtual server. |
push |
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. Default value = DISABLED. |
pushvserver |
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. |
pushlabel |
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. Default value = "none". |
pushmulticlients |
Allow multiple Web 2.0 connections from the same client to connect to the virtual server and expect updates. Default value = NO. |
tcpprofilename |
Name of the TCP profile containing TCP configuration settings for the virtual server. |
httpprofilename |
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. |
dbprofilename |
Name of the DB profile. |
oracleserverversion |
Oracle server version Default value = ORACLE_SERVER_10G. |
comment |
Information about this virtual server. |
mssqlserverversion |
The version of the MSSQL server Default value = TDS_PROT_2008B. |
l2conn |
Use L2 Parameters to identify a connection |
mysqlprotocolversion |
The protocol version returned by the mysql vserver. Default value = 10. |
mysqlserverversion |
The server version string returned by the mysql vserver. Default value = NSA_MYSQL_SERVER_VER_DEFAULT. |
mysqlcharacterset |
The character set returned by the mysql vserver. Default value = 8. |
mysqlservercapabilities |
The server capabilities returned by the mysql vserver. Default value = 41613. |
appflowlog |
Enable logging appflow flow information Default value = ENABLED. |
netprofile |
The name of the network profile. |
icmpvsrresponse |
Can be active or passive 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. |
authnprofile |
Name of the authentication profile to be used when authentication is turned on. |
dnsprofilename |
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. |
dtls |
This option starts/stops the dtls service on the vserver Default value = OFF. |
persistencetype |
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. |
persistmask |
Persistence mask for IP based persistence types, for IPv4 virtual servers. Default value = 0xFFFFFFFF. |
v6persistmasklen |
Persistence mask for IP based persistence types, for IPv6 virtual servers. Default value = 128. Minimum value = 1. Maximum value = 128. |
timeout |
Time period for which a persistence session is in effect. Default value = 2. Maximum value = 1440. |
cookiename |
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. |
persistencebackup |
Backup persistence type for the virtual server. Becomes operational if the primary persistence mechanism fails. |
backuppersistencetimeout |
Time period for which backup persistence is in effect. Default value = 2. Minimum value = 2. Maximum value = 1440. |
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. |
quicprofilename |
Name of QUIC profile which will be attached to the Content Switching VServer. |
redirectfromport |
Port number for the virtual server, from which we absorb the traffic for http redirect Minimum value = 1. Range 1 - 65535. |
dnsoverhttps |
This option is used to enable/disable DNS over HTTPS (DoH) processing. Default value = DISABLED. |
httpsredirecturl |
URL to which all HTTP traffic received on the port specified in the -redirectFromPort parameter is redirected. |
apiprofile |
The API profile where one or more API specs are bounded to. |
Return Value |
Returns simpleResult |
See Also |