Skip to content

csvserver

Configuration for CS virtual server resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeName 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).
Minimum length = 1
td<Double>Read-writeInteger 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<String>Read-writeProtocol used by the virtual server.
Possible values = HTTP, SSL, TCP, FTP, RTSP, SSL_TCP, UDP, DNS, SIP_UDP, SIP_TCP, SIP_SSL, ANY, RADIUS, RDP, MYSQL, MSSQL, DIAMETER, SSL_DIAMETER, DNS_TCP, ORACLE, SMPP, PROXY
ipv46<String>Read-writeIP address of the content switching virtual server.
Minimum length = 1
targettype<String>Read-writeVirtual server target type.
Possible values = GSLB
dnsrecordtype<String>Read-write.
Default value: NSGSLB_IPV4
Possible values = A, AAAA, CNAME, NAPTR
persistenceid<Double>Read-write.
Minimum value = 0
Maximum value = 65535
ippattern<String>Read-writeIP 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<String>Read-writeIP 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<Double>Read-writeNumber 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<Integer>Read-writePort number for content switching virtual server.
Minimum value = 1
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
ipset<String>Read-writeThe list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current cs vserver.
Minimum length = 1
state<String>Read-writeInitial state of the load balancing virtual server.
Default value: ENABLED
Possible values = ENABLED, DISABLED
stateupdate<String>Read-writeEnable 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
Possible values = ENABLED, DISABLED, UPDATEONBACKENDUPDATE
cacheable<String>Read-writeUse 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
Possible values = YES, NO
redirecturl<String>Read-writeURL 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.
Minimum length = 1
clttimeout<Double>Read-writeIdle 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.
Minimum value = 0
Maximum value = 31536000
precedence<String>Read-writeType of precedence to use for both RULE-based and URL-based policies on the content switching virtual server. With the default (RULE) setting, incoming requests are evaluated against the rule-based content switching policies. If none of the rules match, the URL in the request is evaluated against the URL-based content switching policies.
Default value: RULE
Possible values = RULE, URL
casesensitive<String>Read-writeConsider case in URLs (for policies that use URLs instead of RULES). For example, with the ON setting, the URLs /a/1.html and /A/1.HTML are treated differently and can have different targets (set by content switching policies). With the OFF setting, /a/1.html and /A/1.HTML are switched to the same target.
Default value: ON
Possible values = ON, OFF
somethod<String>Read-writeType 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.
Possible values = CONNECTION, DYNAMICCONNECTION, BANDWIDTH, HEALTH, NONE
sopersistence<String>Read-writeMaintain source-IP based persistence on primary and backup virtual servers.
Default value: DISABLED
Possible values = ENABLED, DISABLED
sopersistencetimeout<Double>Read-writeTime-out value, in minutes, for spillover persistence.
Default value: 2
Minimum value = 2
Maximum value = 1440
sothreshold<Double>Read-writeDepending 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 = 4294967287
sobackupaction<String>Read-writeAction to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists.
Possible values = DROP, ACCEPT, REDIRECT
redirectportrewrite<String>Read-writeState of port rewrite while performing HTTP redirect.
Default value: DISABLED
Possible values = ENABLED, DISABLED
downstateflush<String>Read-writeFlush 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
Possible values = ENABLED, DISABLED
backupvserver<String>Read-writeName 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.
Minimum length = 1
disableprimaryondown<String>Read-writeContinue forwarding the traffic to backup virtual server even after the primary server comes UP from the DOWN state.
Default value: DISABLED
Possible values = ENABLED, DISABLED
insertvserveripport<String>Read-writeInsert 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 command.
Possible values = OFF, VIPADDR, V6TOV4MAPPING
vipheader<String>Read-writeName of virtual server IP and port header, for use with the VServer IP Port Insertion parameter.
Minimum length = 1
rtspnat<String>Read-writeEnable network address translation (NAT) for real-time streaming protocol (RTSP) connections.
Default value: OFF
Possible values = ON, OFF
authenticationhost<String>Read-writeFQDN of the authentication virtual server. The service type of the virtual server should be either HTTP or SSL.
Minimum length = 3
Maximum length = 252
authentication<String>Read-writeAuthenticate users who request a connection to the content switching virtual server.
Default value: OFF
Possible values = ON, OFF
listenpolicy<String>Read-writeString 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<Double>Read-writeInteger 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<String>Read-writeEnable HTTP 401-response based authentication.
Default value: OFF
Possible values = ON, OFF
authnvsname<String>Read-writeName of authentication virtual server that authenticates the incoming user requests to this content switching virtual server. .
Minimum length = 1
Maximum length = 252
push<String>Read-writeProcess 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
Possible values = ENABLED, DISABLED
pushvserver<String>Read-writeName 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.
Minimum length = 1
pushlabel<String>Read-writeExpression 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<String>Read-writeAllow multiple Web 2.0 connections from the same client to connect to the virtual server and expect updates.
Default value: NO
Possible values = YES, NO
tcpprofilename<String>Read-writeName of the TCP profile containing TCP configuration settings for the virtual server.
Minimum length = 1
Maximum length = 127
httpprofilename<String>Read-writeName 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.
Minimum length = 1
Maximum length = 127
dbprofilename<String>Read-writeName of the DB profile.
Minimum length = 1
Maximum length = 127
oracleserverversion<String>Read-writeOracle server version.
Default value: 10G
Possible values = 10G, 11G
comment<String>Read-writeInformation about this virtual server.
mssqlserverversion<String>Read-writeThe version of the MSSQL server.
Default value: 2008R2
Possible values = 70, 2000, 2000SP1, 2005, 2008, 2008R2, 2012, 2014
l2conn<String>Read-writeUse L2 Parameters to identify a connection.
Possible values = ON, OFF
mysqlprotocolversion<Double>Read-writeThe protocol version returned by the mysql vserver.
Default value: 10
mysqlserverversion<String>Read-writeThe server version string returned by the mysql vserver.
Minimum length = 1
Maximum length = 31
mysqlcharacterset<Double>Read-writeThe character set returned by the mysql vserver.
Default value: 8
mysqlservercapabilities<Double>Read-writeThe server capabilities returned by the mysql vserver.
Default value: 41613
appflowlog<String>Read-writeEnable logging appflow flow information.
Default value: ENABLED
Possible values = ENABLED, DISABLED
netprofile<String>Read-writeThe name of the network profile.
Minimum length = 1
Maximum length = 127
icmpvsrresponse<String>Read-writeCan be active or passive.
Default value: PASSIVE
Possible values = PASSIVE, ACTIVE
rhistate<String>Read-writeA 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: PASSIVE
Possible values = PASSIVE, ACTIVE
authnprofile<String>Read-writeName of the authentication profile to be used when authentication is turned on.
dnsprofilename<String>Read-writeName 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.
Minimum length = 1
Maximum length = 127
persistencetype<String>Read-writeType 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.
Possible values = SOURCEIP, COOKIEINSERT, SSLSESSION, NONE
persistmask<String>Read-writePersistence mask for IP based persistence types, for IPv4 virtual servers.
Minimum length = 1
v6persistmasklen<Double>Read-writePersistence mask for IP based persistence types, for IPv6 virtual servers.
Default value: 128
Minimum value = 1
Maximum value = 128
timeout<Double>Read-writeTime period for which a persistence session is in effect.
Default value: 2
Minimum value = 0
Maximum value = 1440
cookiename<String>Read-writeUse 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<String>Read-writeBackup persistence type for the virtual server. Becomes operational if the primary persistence mechanism fails.
Possible values = SOURCEIP, NONE
backuppersistencetimeout<Double>Read-writeTime period for which backup persistence is in effect.
Default value: 2
Minimum value = 2
Maximum value = 1440
domainname<String>Read-writeDomain name for which to change the time to live (TTL) and/or backup service IP address.
Minimum length = 1
ttl<Double>Read-write.
Minimum value = 1
backupip<String>Read-write.
Minimum length = 1
cookiedomain<String>Read-write.
Minimum length = 1
cookietimeout<Double>Read-write.
Minimum value = 0
Maximum value = 1440
sitedomainttl<Double>Read-write.
Minimum value = 1
newname<String>Read-writeNew name for the 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.
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 name" or 'my name').
Minimum length = 1
ip<String>Read-onlyThe IP address of the virtual server.
value<String>Read-onlyThe ssl card status for the transparent ssl cs vserver.
Possible values = Certkey not bound, SSL feature disabled
ngname<String>Read-onlyNodegroup devno to which this csvserver belongs to.
type<String>Read-onlyVirtual server type.
Possible values = CONTENT, ADDRESS
curstate<String>Read-onlyThe state of the cs vserver.
Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED
sc<String>Read-onlyThe state of SureConnect the specified virtual server.
Possible values = ON, OFF
status<Integer>Read-onlyStatus.
cachetype<String>Read-onlyCache type.
Possible values = TRANSPARENT, REVERSE, FORWARD
redirect<String>Read-onlyRedirect URL string.
Possible values = CACHE, POLICY, ORIGIN
homepage<String>Read-onlyHome page.
dnsvservername<String>Read-onlyDNS vserver name.
domain<String>Read-onlyDomain.
policyname<String>Read-onlyPolicies bound to this vserver.
servicename<String>Read-onlyService name.
weight<Double>Read-onlyWeight for this service.
cachevserver<String>Read-onlyCache vserver name.
targetvserver<String>Read-onlytarget vserver name.
priority<Double>Read-onlyPriority for the policy.
url<String>Read-onlyURL string.
gotopriorityexpression<String>Read-onlyExpression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
bindpoint<String>Read-onlyThe bindpoint to which the policy is bound.
Possible values = REQUEST, RESPONSE, ICA_REQUEST, OTHERTCP_REQUEST
invoke<Boolean>Read-onlyInvoke flag.
labeltype<String>Read-onlyThe invocation type.
Possible values = reqvserver, resvserver, policylabel
labelname<String>Read-onlyName of the label invoked.
gt2gb<String>Read-onlyThis argument has no effect.
Default value: DISABLED
Possible values = ENABLED, DISABLED
statechangetimesec<String>Read-onlyTime when last state change happened. Seconds part.
statechangetimemsec<Double>Read-onlyTime at which last state change happened. Milliseconds part.
tickssincelaststatechange<Double>Read-onlyTime in 10 millisecond ticks since the last state change.
ruletype<Double>Read-onlyRule type.
lbvserver<String>Read-onlyName of the default lb vserver bound. Use this param for Default binding only. For Example: bind cs vserver cs1 -lbvserver lb1.
Minimum length = 1
targetlbvserver<String>Read-onlytarget vserver name.
analyticsprofile<String>Read-onlyName of the analytics profile bound to the LB vserver.
nodefaultbindings<String>Read-onlyto determine if the configuration will have default ssl CIPHER and ECC curve bindings.
Default value: NO
Possible values = YES, NO
version<Integer>Read-onlyCookie version.
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

ADD| DELETE| UPDATE| UNSET| ENABLE| DISABLE| RENAME| GET (ALL)| GET| COUNT

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the Citrix ADC appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note:In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in redand placeholder content is marked in <green>.

add

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"csvserver":{
<b>"name":<String_value>,
</b>"td":<Double_value>,
<b>"servicetype":<String_value>,
</b>"ipv46":<String_value>,
"targettype":<String_value>,
"dnsrecordtype":<String_value>,
"persistenceid":<Double_value>,
"ippattern":<String_value>,
"ipmask":<String_value>,
"range":<Double_value>,
"port":<Integer_value>,
"ipset":<String_value>,
"state":<String_value>,
"stateupdate":<String_value>,
"cacheable":<String_value>,
"redirecturl":<String_value>,
"clttimeout":<Double_value>,
"precedence":<String_value>,
"casesensitive":<String_value>,
"somethod":<String_value>,
"sopersistence":<String_value>,
"sopersistencetimeout":<Double_value>,
"sothreshold":<Double_value>,
"sobackupaction":<String_value>,
"redirectportrewrite":<String_value>,
"downstateflush":<String_value>,
"backupvserver":<String_value>,
"disableprimaryondown":<String_value>,
"insertvserveripport":<String_value>,
"vipheader":<String_value>,
"rtspnat":<String_value>,
"authenticationhost":<String_value>,
"authentication":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"authn401":<String_value>,
"authnvsname":<String_value>,
"push":<String_value>,
"pushvserver":<String_value>,
"pushlabel":<String_value>,
"pushmulticlients":<String_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"dbprofilename":<String_value>,
"oracleserverversion":<String_value>,
"comment":<String_value>,
"mssqlserverversion":<String_value>,
"l2conn":<String_value>,
"mysqlprotocolversion":<Double_value>,
"mysqlserverversion":<String_value>,
"mysqlcharacterset":<Double_value>,
"mysqlservercapabilities":<Double_value>,
"appflowlog":<String_value>,
"netprofile":<String_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"authnprofile":<String_value>,
"dnsprofilename":<String_value>,
"persistencetype":<String_value>,
"persistmask":<String_value>,
"v6persistmasklen":<Double_value>,
"timeout":<Double_value>,
"cookiename":<String_value>,
"persistencebackup":<String_value>,
"backuppersistencetimeout":<Double_value>
}}

Response:

HTTP Status Code on Success: 201 Created HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

delete

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver/name_value<String>

HTTP Method:DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

update

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"csvserver":{
<b>"name":<String_value>,
</b>"ipv46":<String_value>,
"ipset":<String_value>,
"ippattern":<String_value>,
"ipmask":<String_value>,
"stateupdate":<String_value>,
"precedence":<String_value>,
"casesensitive":<String_value>,
"backupvserver":<String_value>,
"redirecturl":<String_value>,
"cacheable":<String_value>,
"clttimeout":<Double_value>,
"somethod":<String_value>,
"sopersistence":<String_value>,
"sopersistencetimeout":<Double_value>,
"sothreshold":<Double_value>,
"sobackupaction":<String_value>,
"redirectportrewrite":<String_value>,
"downstateflush":<String_value>,
"disableprimaryondown":<String_value>,
"insertvserveripport":<String_value>,
"vipheader":<String_value>,
"rtspnat":<String_value>,
"authenticationhost":<String_value>,
"authentication":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"authn401":<String_value>,
"authnvsname":<String_value>,
"push":<String_value>,
"pushvserver":<String_value>,
"pushlabel":<String_value>,
"pushmulticlients":<String_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"dbprofilename":<String_value>,
"comment":<String_value>,
"l2conn":<String_value>,
"mssqlserverversion":<String_value>,
"mysqlprotocolversion":<Double_value>,
"oracleserverversion":<String_value>,
"mysqlserverversion":<String_value>,
"mysqlcharacterset":<Double_value>,
"mysqlservercapabilities":<Double_value>,
"appflowlog":<String_value>,
"netprofile":<String_value>,
"authnprofile":<String_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"dnsprofilename":<String_value>,
"dnsrecordtype":<String_value>,
"persistenceid":<Double_value>,
"domainname":<String_value>,
"ttl":<Double_value>,
"backupip":<String_value>,
"cookiedomain":<String_value>,
"cookietimeout":<Double_value>,
"sitedomainttl":<Double_value>,
"persistencetype":<String_value>,
"persistmask":<String_value>,
"v6persistmasklen":<Double_value>,
"timeout":<Double_value>,
"cookiename":<String_value>,
"persistencebackup":<String_value>,
"backuppersistencetimeout":<Double_value>
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

unset

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver?action=unset

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"csvserver":{
<b>"name":<String_value>,
</b>"casesensitive":true,
"backupvserver":true,
"clttimeout":true,
"redirecturl":true,
"authn401":true,
"authentication":true,
"authenticationhost":true,
"authnvsname":true,
"pushvserver":true,
"pushlabel":true,
"tcpprofilename":true,
"httpprofilename":true,
"dbprofilename":true,
"l2conn":true,
"mysqlprotocolversion":true,
"mysqlserverversion":true,
"mysqlcharacterset":true,
"mysqlservercapabilities":true,
"appflowlog":true,
"netprofile":true,
"icmpvsrresponse":true,
"authnprofile":true,
"sothreshold":true,
"dnsprofilename":true,
"ipset":true,
"stateupdate":true,
"precedence":true,
"cacheable":true,
"somethod":true,
"sopersistence":true,
"sopersistencetimeout":true,
"sobackupaction":true,
"redirectportrewrite":true,
"downstateflush":true,
"disableprimaryondown":true,
"insertvserveripport":true,
"vipheader":true,
"rtspnat":true,
"listenpolicy":true,
"listenpriority":true,
"push":true,
"pushmulticlients":true,
"comment":true,
"mssqlserverversion":true,
"oracleserverversion":true,
"rhistate":true,
"dnsrecordtype":true,
"persistenceid":true,
"persistencetype":true,
"persistmask":true,
"v6persistmasklen":true,
"timeout":true,
"cookiename":true,
"persistencebackup":true,
"backuppersistencetimeout":true
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

enable

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver?action=enable

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"csvserver":{
<b>"name":<String_value>
</b>}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

disable

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver?action=disable

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"csvserver":{
<b>"name":<String_value>
</b>}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

rename

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver?action=rename

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"csvserver":{
<b>"name":<String_value>,
</b><b>"newname":<String_value>
</b>}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of csvserver resources configured on Citrix ADC. Filtering can be done on any of the properties of the resource.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver?pagesize=#no;pageno=#no

Use this query-parameter to get the csvserver resources in chunks.

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "csvserver": [ {
"name":<String_value>,
"insertvserveripport":<String_value>,
"vipheader":<String_value>,
"ip":<String_value>,
"td":<Double_value>,
"ipv46":<String_value>,
"ippattern":<String_value>,
"ipmask":<String_value>,
"value":<String_value>,
"port":<Integer_value>,
"ipset":<String_value>,
"range":<Double_value>,
"servicetype":<String_value>,
"ngname":<String_value>,
"type":<String_value>,
"curstate":<String_value>,
"sc":<String_value>,
"stateupdate":<String_value>,
"status":<Integer_value>,
"cachetype":<String_value>,
"redirect":<String_value>,
"precedence":<String_value>,
"redirecturl":<String_value>,
"authentication":<String_value>,
"authn401":<String_value>,
"authnvsname":<String_value>,
"casesensitive":<String_value>,
"homepage":<String_value>,
"dnsvservername":<String_value>,
"domain":<String_value>,
"policyname":<String_value>,
"servicename":<String_value>,
"weight":<Double_value>,
"cachevserver":<String_value>,
"targetvserver":<String_value>,
"backupvserver":<String_value>,
"priority":<Double_value>,
"clttimeout":<Double_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"somethod":<String_value>,
"sopersistence":<String_value>,
"sopersistencetimeout":<Double_value>,
"sothreshold":<Double_value>,
"sobackupaction":<String_value>,
"cacheable":<String_value>,
"url":<String_value>,
"gotopriorityexpression":<String_value>,
"redirectportrewrite":<String_value>,
"downstateflush":<String_value>,
"disableprimaryondown":<String_value>,
"bindpoint":<String_value>,
"invoke":<Boolean_value>,
"labeltype":<String_value>,
"labelname":<String_value>,
"gt2gb":<String_value>,
"statechangetimesec":<String_value>,
"statechangetimemsec":<Double_value>,
"tickssincelaststatechange":<Double_value>,
"rtspnat":<String_value>,
"authenticationhost":<String_value>,
"push":<String_value>,
"pushvserver":<String_value>,
"pushlabel":<String_value>,
"pushmulticlients":<String_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"dbprofilename":<String_value>,
"comment":<String_value>,
"oracleserverversion":<String_value>,
"mssqlserverversion":<String_value>,
"l2conn":<String_value>,
"ruletype":<Double_value>,
"mysqlprotocolversion":<Double_value>,
"mysqlserverversion":<String_value>,
"mysqlcharacterset":<Double_value>,
"mysqlservercapabilities":<Double_value>,
"appflowlog":<String_value>,
"netprofile":<String_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"lbvserver":<String_value>,
"targetlbvserver":<String_value>,
"authnprofile":<String_value>,
"dnsprofilename":<String_value>,
"targettype":<String_value>,
"domainname":<String_value>,
"ttl":<Double_value>,
"backupip":<String_value>,
"cookiedomain":<String_value>,
"cookietimeout":<Double_value>,
"sitedomainttl":<Double_value>,
"dnsrecordtype":<String_value>,
"persistenceid":<Double_value>,
"analyticsprofile":<String_value>,
"nodefaultbindings":<String_value>,
"persistencetype":<String_value>,
"persistmask":<String_value>,
"v6persistmasklen":<Double_value>,
"timeout":<Double_value>,
"cookiename":<String_value>,
"version":<Integer_value>,
"persistencebackup":<String_value>,
"backuppersistencetimeout":<Double_value>
}]}

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver/name_value<String>

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver/name_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver/name_value<String>?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "csvserver": [ {
"name":<String_value>,
"insertvserveripport":<String_value>,
"vipheader":<String_value>,
"ip":<String_value>,
"td":<Double_value>,
"ipv46":<String_value>,
"ippattern":<String_value>,
"ipmask":<String_value>,
"value":<String_value>,
"port":<Integer_value>,
"ipset":<String_value>,
"range":<Double_value>,
"servicetype":<String_value>,
"ngname":<String_value>,
"type":<String_value>,
"curstate":<String_value>,
"sc":<String_value>,
"stateupdate":<String_value>,
"status":<Integer_value>,
"cachetype":<String_value>,
"redirect":<String_value>,
"precedence":<String_value>,
"redirecturl":<String_value>,
"authentication":<String_value>,
"authn401":<String_value>,
"authnvsname":<String_value>,
"casesensitive":<String_value>,
"homepage":<String_value>,
"dnsvservername":<String_value>,
"domain":<String_value>,
"policyname":<String_value>,
"servicename":<String_value>,
"weight":<Double_value>,
"cachevserver":<String_value>,
"targetvserver":<String_value>,
"backupvserver":<String_value>,
"priority":<Double_value>,
"clttimeout":<Double_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"somethod":<String_value>,
"sopersistence":<String_value>,
"sopersistencetimeout":<Double_value>,
"sothreshold":<Double_value>,
"sobackupaction":<String_value>,
"cacheable":<String_value>,
"url":<String_value>,
"gotopriorityexpression":<String_value>,
"redirectportrewrite":<String_value>,
"downstateflush":<String_value>,
"disableprimaryondown":<String_value>,
"bindpoint":<String_value>,
"invoke":<Boolean_value>,
"labeltype":<String_value>,
"labelname":<String_value>,
"gt2gb":<String_value>,
"statechangetimesec":<String_value>,
"statechangetimemsec":<Double_value>,
"tickssincelaststatechange":<Double_value>,
"rtspnat":<String_value>,
"authenticationhost":<String_value>,
"push":<String_value>,
"pushvserver":<String_value>,
"pushlabel":<String_value>,
"pushmulticlients":<String_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"dbprofilename":<String_value>,
"comment":<String_value>,
"oracleserverversion":<String_value>,
"mssqlserverversion":<String_value>,
"l2conn":<String_value>,
"ruletype":<Double_value>,
"mysqlprotocolversion":<Double_value>,
"mysqlserverversion":<String_value>,
"mysqlcharacterset":<Double_value>,
"mysqlservercapabilities":<Double_value>,
"appflowlog":<String_value>,
"netprofile":<String_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"lbvserver":<String_value>,
"targetlbvserver":<String_value>,
"authnprofile":<String_value>,
"dnsprofilename":<String_value>,
"targettype":<String_value>,
"domainname":<String_value>,
"ttl":<Double_value>,
"backupip":<String_value>,
"cookiedomain":<String_value>,
"cookietimeout":<Double_value>,
"sitedomainttl":<Double_value>,
"dnsrecordtype":<String_value>,
"persistenceid":<Double_value>,
"analyticsprofile":<String_value>,
"nodefaultbindings":<String_value>,
"persistencetype":<String_value>,
"persistmask":<String_value>,
"v6persistmasklen":<Double_value>,
"timeout":<Double_value>,
"cookiename":<String_value>,
"version":<Integer_value>,
"persistencebackup":<String_value>,
"backuppersistencetimeout":<Double_value>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/csvserver?count=yes

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "csvserver": [ { "__count": "#no"} ] }