-
-
-
-
-
-
-
-
-
-
-
-
-
csvserver
-
-
-
-
-
-
-
-
-
-
-
-
-
-
videooptimizationdetectionpolicylabel_videooptimizationdetectionpolicy_binding
-
videooptimizationdetectionpolicy_videooptimizationglobaldetection_binding
-
videooptimizationglobaldetection_videooptimizationdetectionpolicy_binding
-
videooptimizationglobalpacing_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicylabel_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicy_videooptimizationglobalpacing_binding
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
csvserver
Configuration for CS virtual server resource.
Properties
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
name |
|
Read-write | 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). Minimum length = 1 |
td |
|
Read-write | 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 |
|
Read-write | Protocol 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, MONGO, MONGO_TLS, MQTT, MQTT_TLS, HTTP_QUIC |
ipv46 |
|
Read-write | IP address of the content switching virtual server.
Minimum length = 1 |
targettype |
|
Read-write | Virtual server target type.
Possible values = GSLB |
dnsrecordtype |
|
Read-write | .
Default value: NSGSLB_IPV4 Possible values = A, AAAA, CNAME, NAPTR |
persistenceid |
|
Read-write | .
Minimum value = 0 Maximum value = 65535 |
ippattern |
|
Read-write | 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 |
|
Read-write | 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 |
|
Read-write | 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 |
|
Read-write | Port number for content switching virtual server.
Minimum value = 1 Range 1 - 65535 * in CLI is represented as 65535 in NITRO API |
ipset |
|
Read-write | The list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current cs vserver.
Minimum length = 1 |
state |
|
Read-write | Initial state of the load balancing virtual server.
Default value: ENABLED Possible values = ENABLED, DISABLED |
stateupdate |
|
Read-write | 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 Possible values = ENABLED, DISABLED, UPDATEONBACKENDUPDATE |
cacheable |
|
Read-write | 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 Possible values = YES, NO |
redirecturl |
|
Read-write | 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. Minimum length = 1 |
clttimeout |
|
Read-write | 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. Minimum value = 0 Maximum value = 31536000 |
precedence |
|
Read-write | Type 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 |
|
Read-write | Consider 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 |
|
Read-write | 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.
Possible values = CONNECTION, DYNAMICCONNECTION, BANDWIDTH, HEALTH, NONE |
sopersistence |
|
Read-write | Maintain source-IP based persistence on primary and backup virtual servers.
Default value: DISABLED Possible values = ENABLED, DISABLED |
sopersistencetimeout |
|
Read-write | Time-out value, in minutes, for spillover persistence.
Default value: 2 Minimum value = 2 Maximum value = 1440 |
sothreshold |
|
Read-write | 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 = 4294967287 |
sobackupaction |
|
Read-write | Action 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 |
|
Read-write | State of port rewrite while performing HTTP redirect.
Default value: DISABLED Possible values = ENABLED, DISABLED |
downstateflush |
|
Read-write | 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 Possible values = ENABLED, DISABLED |
backupvserver |
|
Read-write | 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. Minimum length = 1 |
disableprimaryondown |
|
Read-write | Continue 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 |
|
Read-write | 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 command. Possible values = OFF, VIPADDR, V6TOV4MAPPING |
vipheader |
|
Read-write | Name of virtual server IP and port header, for use with the VServer IP Port Insertion parameter.
Minimum length = 1 |
rtspnat |
|
Read-write | Enable network address translation (NAT) for real-time streaming protocol (RTSP) connections.
Default value: OFF Possible values = ON, OFF |
authenticationhost |
|
Read-write | FQDN 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 |
|
Read-write | Authenticate users who request a connection to the content switching virtual server.
Default value: OFF Possible values = ON, OFF |
listenpolicy |
|
Read-write | 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 |
|
Read-write | 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 |
|
Read-write | Enable HTTP 401-response based authentication.
Default value: OFF Possible values = ON, OFF |
authnvsname |
|
Read-write | Name of authentication virtual server that authenticates the incoming user requests to this content switching virtual server. .
Minimum length = 1 Maximum length = 252 |
push |
|
Read-write | 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 Possible values = ENABLED, DISABLED |
pushvserver |
|
Read-write | 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.
Minimum length = 1 |
pushlabel |
|
Read-write | 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 |
|
Read-write | Allow 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 |
|
Read-write | Name of the TCP profile containing TCP configuration settings for the virtual server.
Minimum length = 1 Maximum length = 127 |
httpprofilename |
|
Read-write | 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.
Minimum length = 1 Maximum length = 127 |
dbprofilename |
|
Read-write | Name of the DB profile.
Minimum length = 1 Maximum length = 127 |
oracleserverversion |
|
Read-write | Oracle server version.
Default value: 10G Possible values = 10G, 11G |
comment |
|
Read-write | Information about this virtual server. |
mssqlserverversion |
|
Read-write | The version of the MSSQL server.
Default value: 2008R2 Possible values = 70, 2000, 2000SP1, 2005, 2008, 2008R2, 2012, 2014 |
l2conn |
|
Read-write | Use L2 Parameters to identify a connection.
Possible values = ON, OFF |
mysqlprotocolversion |
|
Read-write | The protocol version returned by the mysql vserver.
Default value: 10 |
mysqlserverversion |
|
Read-write | The server version string returned by the mysql vserver.
Minimum length = 1 Maximum length = 31 |
mysqlcharacterset |
|
Read-write | The character set returned by the mysql vserver.
Default value: 8 |
mysqlservercapabilities |
|
Read-write | The server capabilities returned by the mysql vserver.
Default value: 41613 |
appflowlog |
|
Read-write | Enable logging appflow flow information.
Default value: ENABLED Possible values = ENABLED, DISABLED |
netprofile |
|
Read-write | The name of the network profile.
Minimum length = 1 Maximum length = 127 |
icmpvsrresponse |
|
Read-write | Can be active or passive.
Default value: PASSIVE Possible values = PASSIVE, ACTIVE |
rhistate |
|
Read-write | 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: PASSIVE Possible values = PASSIVE, ACTIVE |
authnprofile |
|
Read-write | Name of the authentication profile to be used when authentication is turned on. |
dnsprofilename |
|
Read-write | 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.
Minimum length = 1 Maximum length = 127 |
dtls |
|
Read-write | This option starts/stops the dtls service on the vserver.
Default value: OFF Possible values = ON, OFF |
persistencetype |
|
Read-write | Type of persistence for the virtual server. Available settings function as follows
|
persistmask |
|
Read-write | Persistence mask for IP based persistence types, for IPv4 virtual servers.
Minimum length = 1 |
v6persistmasklen |
|
Read-write | Persistence mask for IP based persistence types, for IPv6 virtual servers.
Default value: 128 Minimum value = 1 Maximum value = 128 |
timeout |
|
Read-write | Time period for which a persistence session is in effect.
Default value: 2 Minimum value = 0 Maximum value = 1440 |
cookiename |
|
Read-write | 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 |
|
Read-write | Backup persistence type for the virtual server. Becomes operational if the primary persistence mechanism fails.
Possible values = SOURCEIP, NONE |
backuppersistencetimeout |
|
Read-write | Time period for which backup persistence is in effect.
Default value: 2 Minimum value = 2 Maximum value = 1440 |
tcpprobeport |
|
Read-write | 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.
Minimum value = 1 Range 1 - 65535 * in CLI is represented as 65535 in NITRO API |
probeprotocol |
|
Read-write | Citrix ADC provides support for external health check of the vserver status. Select HTTP or TCP probes for healthcheck.
Possible values = TCP, HTTP |
probesuccessresponsecode |
|
Read-write | HTTP code to return in SUCCESS case.
Default value: “200 OK” Minimum length = 1 Maximum length = 64 |
probeport |
|
Read-write | Citrix ADC provides support for external health check of the vserver status. Select port for HTTP/TCP monitring.
Default value: 0 Range 1 - 65535 * in CLI is represented as 65535 in NITRO API |
quicprofilename |
|
Read-write | Name of QUIC profile which will be attached to the Content Switching VServer.
Minimum length = 1 Maximum length = 255 |
redirectfromport |
|
Read-write | Port number for the virtual server, from which we absorb the traffic for http redirect.
Minimum value = 1 Range 1 - 65535 * in CLI is represented as 65535 in NITRO API |
httpsredirecturl |
|
Read-write | URL to which all HTTP traffic received on the port specified in the -redirectFromPort parameter is redirected. |
domainname |
|
Read-write | Domain name for which to change the time to live (TTL) and/or backup service IP address.
Minimum length = 1 |
ttl |
|
Read-write | .
Minimum value = 1 |
backupip |
|
Read-write | .
Minimum length = 1 |
cookiedomain |
|
Read-write | .
Minimum length = 1 |
cookietimeout |
|
Read-write | .
Minimum value = 0 Maximum value = 1440 |
sitedomainttl |
|
Read-write | .
Minimum value = 1 |
newname |
|
Read-write | New 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 |
|
Read-only | The IP address of the virtual server. |
value |
|
Read-only | The ssl card status for the transparent ssl cs vserver.
Possible values = Certkey/Certkeybundle not bound, SSL feature disabled |
ngname |
|
Read-only | Nodegroup devno to which this csvserver belongs to. |
type |
|
Read-only | Virtual server type.
Possible values = CONTENT, ADDRESS |
curstate |
|
Read-only | The 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 |
status |
|
Read-only | Status. |
cachetype |
|
Read-only | Cache type.
Possible values = TRANSPARENT, REVERSE, FORWARD |
redirect |
|
Read-only | Redirect URL string.
Possible values = CACHE, POLICY, ORIGIN |
homepage |
|
Read-only | Home page. |
dnsvservername |
|
Read-only | DNS vserver name. |
domain |
|
Read-only | Domain. |
servicename |
|
Read-only | Service name. |
weight |
|
Read-only | Weight for this service. |
cachevserver |
|
Read-only | Cache vserver name. |
targetvserver |
|
Read-only | target vserver name. |
url |
|
Read-only | URL string. |
bindpoint |
|
Read-only | The bindpoint to which the policy is bound.
Possible values = REQUEST, RESPONSE, ICA_REQUEST, OTHERTCP_REQUEST, MQTT_JUMBO_REQ |
gt2gb |
|
Read-only | This argument has no effect.
Default value: DISABLED Possible values = ENABLED, DISABLED |
statechangetimesec |
|
Read-only | Time when last state change happened. Seconds part. |
statechangetimemsec |
|
Read-only | Time at which last state change happened. Milliseconds part. |
tickssincelaststatechange |
|
Read-only | Time in 10 millisecond ticks since the last state change. |
ruletype |
|
Read-only | Rule type. |
lbvserver |
|
Read-only | Name 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 |
|
Read-only | target vserver name. |
nodefaultbindings |
|
Read-only | to determine if the configuration will have default ssl CIPHER and ECC curve bindings.
Default value: NO Possible values = YES, NO |
version |
|
Read-only | Cookie version. |
__count |
|
Read-only | count parameter |
Operations
(click to see Properties )
- ADD
- DELETE
- UPDATE
- UNSET
- ENABLE
- DISABLE
- GET (ALL)
- GET
- COUNT
- RENAME
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 NetScaler appliance, the URL is as follows:
http:// <netscaler-ip-address> /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 NetScaler 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
red
and placeholder content is marked in
green
add
URL: http:// <netscaler-ip-address> /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>,
"dtls":<String_value>,
"persistencetype":<String_value>,
"persistmask":<String_value>,
"v6persistmasklen":<Double_value>,
"timeout":<Double_value>,
"cookiename":<String_value>,
"persistencebackup":<String_value>,
"backuppersistencetimeout":<Double_value>,
"tcpprobeport":<Integer_value>,
"probeprotocol":<String_value>,
"probesuccessresponsecode":<String_value>,
"probeport":<Integer_value>,
"quicprofilename":<String_value>,
"redirectfromport":<Integer_value>,
"httpsredirecturl":<String_value>
}}
Response: HTTP Status Code on Success: 201 Created
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
delete
URL: http:// <netscaler-ip-address> /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 NetScaler-specific errors). The response payload provides details of the error
update
URL: http:// <netscaler-ip-address> /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>,
"dtls":<String_value>,
"persistencetype":<String_value>,
"persistmask":<String_value>,
"v6persistmasklen":<Double_value>,
"timeout":<Double_value>,
"cookiename":<String_value>,
"persistencebackup":<String_value>,
"backuppersistencetimeout":<Double_value>,
"tcpprobeport":<Integer_value>,
"probeprotocol":<String_value>,
"probesuccessresponsecode":<String_value>,
"probeport":<Integer_value>,
"quicprofilename":<String_value>,
"redirectfromport":<Integer_value>,
"httpsredirecturl":<String_value>
}}
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
unset
URL: http:// <netscaler-ip-address> /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,
"tcpprobeport":true,
"probeprotocol":true,
"quicprofilename":true,
"redirectfromport":true,
"httpsredirecturl":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,
"dtls":true,
"persistencetype":true,
"persistmask":true,
"v6persistmasklen":true,
"timeout":true,
"cookiename":true,
"persistencebackup":true,
"backuppersistencetimeout":true,
"probesuccessresponsecode":true
}}
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
enable
URL: http:// <netscaler-ip-address> /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 NetScaler-specific errors). The response payload provides details of the error
disable
URL: http:// <netscaler-ip-address> /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 NetScaler-specific errors). The response payload provides details of the error
rename
URL: http:// <netscaler-ip-address> /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 NetScaler-specific errors). The response payload provides details of the error
get (all)
URL: http:// <netscaler-ip-address> /nitro/v1/config/csvserver Query-parameters: attrs http:// <netscaler-ip-address> /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:// <netscaler-ip-address> /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 NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/csvserver? view=summary
Use this query-parameter to get the summary output of csvserver resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination http:// <netscaler-ip-address> /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 NetScaler-specific errors). The response payload provides details of the error
Response Header:
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>,
"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>,
"servicename":<String_value>,
"weight":<Double_value>,
"cachevserver":<String_value>,
"targetvserver":<String_value>,
"backupvserver":<String_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>,
"redirectportrewrite":<String_value>,
"downstateflush":<String_value>,
"disableprimaryondown":<String_value>,
"bindpoint":<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>,
"dtls":<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>,
"tcpprobeport":<Integer_value>,
"probeprotocol":<String_value>,
"probeport":<Integer_value>,
"probesuccessresponsecode":<String_value>,
"quicprofilename":<String_value>,
"redirectfromport":<Integer_value>,
"httpsredirecturl":<String_value>
}]}
get
URL: http:// <netscaler-ip-address> /nitro/v1/config/csvserver/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /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:// <netscaler-ip-address> /nitro/v1/config/csvserver/ name_value<String> ? view=summary
Use this query-parameter to get the summary output of csvserver resources configured on NetScaler.
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 NetScaler-specific errors). The response payload provides details of the error
Response Header:
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>,
"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>,
"servicename":<String_value>,
"weight":<Double_value>,
"cachevserver":<String_value>,
"targetvserver":<String_value>,
"backupvserver":<String_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>,
"redirectportrewrite":<String_value>,
"downstateflush":<String_value>,
"disableprimaryondown":<String_value>,
"bindpoint":<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>,
"dtls":<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>,
"tcpprobeport":<Integer_value>,
"probeprotocol":<String_value>,
"probeport":<Integer_value>,
"probesuccessresponsecode":<String_value>,
"quicprofilename":<String_value>,
"redirectfromport":<Integer_value>,
"httpsredirecturl":<String_value>
}]}
count
URL: http:// <netscaler-ip-address> /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 NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "csvserver": [ { "__count": "#no"} ] }
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.