-
-
-
-
-
-
-
-
-
-
-
-
crvserver
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
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!
crvserver
Configuration for CR virtual server resource.
Properties
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
name |
|
Read-write | Name for the cache redirection virtual server. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. Can be changed after the cache redirection virtual server is created. The following requirement applies only to the Citrix ADC CLI If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my server” or ‘my server’). 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 (type of service) handled by the virtual server.
Possible values = HTTP, SSL, NNTP, HDX |
ipv46 |
|
Read-write | IPv4 or IPv6 address of the cache redirection virtual server. Usually a public IP address. Clients send connection requests to this IP address.
Note: For a transparent cache redirection virtual server, use an asterisk (*) to specify a wildcard virtual server address. |
port |
|
Read-write | Port number of the virtual server.
Default value: 80 Minimum value = 1 Maximum value = 65534 |
ipset |
|
Read-write | The list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current cr vserver.
Minimum length = 1 |
range |
|
Read-write | Number of consecutive IP addresses, starting with the address specified by the IPAddress parameter, to include in a range of addresses assigned to this virtual server.
Default value: 1 Minimum value = 1 Maximum value = 254 |
cachetype |
|
Read-write | Mode of operation for the cache redirection virtual server. Available settings function as follows
|
redirect |
|
Read-write | Type of cache server to which to redirect HTTP requests. Available settings function as follows
|
onpolicymatch |
|
Read-write | Redirect requests that match the policy to either the cache or the origin server, as specified.
Note: For this option to work, you must set the cache redirection type to POLICY. Default value: ORIGIN Possible values = CACHE, ORIGIN |
redirecturl |
|
Read-write | URL of the server to which to redirect traffic if the cache redirection virtual server configured on the Citrix ADC becomes unavailable.
Minimum length = 1 Maximum length = 128 |
clttimeout |
|
Read-write | Time-out value, in seconds, after which to terminate an idle client connection.
Minimum value = 0 Maximum value = 31536000 |
precedence |
|
Read-write | Type of policy (URL or RULE) that takes precedence on the cache redirection virtual server. Applies only to cache redirection virtual servers that have both URL and RULE based policies. If you specify URL, URL based policies are applied first, in the following order
|
arp |
|
Read-write | Use ARP to determine the destination MAC address.
Possible values = ON, OFF |
ghost |
|
Read-write | .
Possible values = ON, OFF |
map |
|
Read-write | Obsolete.
Possible values = ON, OFF |
format |
|
Read-write | .
Possible values = ON, OFF |
via |
|
Read-write | Insert a via header in each HTTP request. In the case of a cache miss, the request is redirected from the cache server to the origin server. This header indicates whether the request is being sent from a cache server.
Default value: ON Possible values = ON, OFF |
cachevserver |
|
Read-write | Name of the default cache virtual server to which to redirect requests (the default target of the cache redirection virtual server).
Minimum length = 1 |
dnsvservername |
|
Read-write | Name of the DNS virtual server that resolves domain names arriving at the forward proxy virtual server.
Note: This parameter applies only to forward proxy virtual servers, not reverse or transparent. Minimum length = 1 |
destinationvserver |
|
Read-write | Destination virtual server for a transparent or forward proxy cache redirection virtual server.
Minimum length = 1 |
domain |
|
Read-write | Default domain for reverse proxies. Domains are configured to direct an incoming request from a specified source domain to a specified target domain. There can be several configured pairs of source and target domains. You can select one pair to be the default. If the host header or URL of an incoming request does not include a source domain, this option sends the request to the specified target domain.
Minimum length = 1 |
sopersistencetimeout |
|
Read-write | Time-out, in minutes, for spillover persistence.
Minimum value = 2 Maximum value = 24 |
sothreshold |
|
Read-write | For CONNECTION (or) DYNAMICCONNECTION spillover, the number of connections above which the virtual server enters spillover mode. For BANDWIDTH spillover, the amount of incoming and outgoing traffic (in Kbps) before spillover. For HEALTH spillover, the percentage of active services (by weight) below which spillover occurs.
Minimum value = 1 |
reuse |
|
Read-write | Reuse TCP connections to the origin server across client connections. Do not set this parameter unless the Service Type parameter is set to HTTP. If you set this parameter to OFF, the possible settings of the Redirect parameter function as follows
|
state |
|
Read-write | Initial state of the cache redirection virtual server.
Default value: ENABLED Possible values = ENABLED, DISABLED |
downstateflush |
|
Read-write | Perform delayed cleanup of connections to this virtual server.
Default value: ENABLED Possible values = ENABLED, DISABLED |
backupvserver |
|
Read-write | Name of the backup virtual server to which traffic is forwarded if the active server becomes unavailable.
Minimum length = 1 |
disableprimaryondown |
|
Read-write | Continue sending traffic to a backup virtual server even after the primary virtual server comes UP from the DOWN state.
Default value: DISABLED Possible values = ENABLED, DISABLED |
l2conn |
|
Read-write | Use L2 parameters, such as MAC, VLAN, and channel to identify a connection.
Possible values = ON, OFF |
backendssl |
|
Read-write | Decides whether the backend connection made by Citrix ADC to the origin server will be HTTP or SSL. Applicable only for SSL type CR Forward proxy vserver.
Default value: DISABLED Possible values = ENABLED, DISABLED |
listenpolicy |
|
Read-write | String specifying the listen policy for the cache redirection virtual server. Can be either an in-line expression or the name of a named expression.
Default value: “NONE” |
listenpriority |
|
Read-write | Priority of the listen policy specified by the Listen Policy parameter. The lower the number, higher the priority.
Default value: 101 Minimum value = 0 Maximum value = 100 |
tcpprofilename |
|
Read-write | Name of the profile containing TCP configuration information for the cache redirection virtual server.
Minimum length = 1 Maximum length = 127 |
httpprofilename |
|
Read-write | Name of the profile containing HTTP configuration information for cache redirection virtual server.
Minimum length = 1 Maximum length = 127 |
comment |
|
Read-write | Comments associated with this virtual server.
Maximum length = 256 |
srcipexpr |
|
Read-write | Expression used to extract the source IP addresses from the requests originating from the cache. Can be either an in-line expression or the name of a named expression.
Minimum length = 1 Maximum length = 1500 |
originusip |
|
Read-write | Use the client’s IP address as the source IP address in requests sent to the origin server.
Note: You can enable this parameter to implement fully transparent CR deployment. Possible values = ON, OFF |
useportrange |
|
Read-write | Use a port number from the port range (set by using the set ns param command, or in the Create Virtual Server (Cache Redirection) dialog box) as the source port in the requests sent to the origin server.
Default value: OFF Possible values = ON, OFF |
appflowlog |
|
Read-write | Enable logging of AppFlow information.
Default value: ENABLED Possible values = ENABLED, DISABLED |
netprofile |
|
Read-write | Name of the network profile containing network configurations for the cache redirection virtual server.
Minimum length = 1 Maximum length = 127 |
icmpvsrresponse |
|
Read-write | Criterion for responding to PING requests sent to this virtual server. If ACTIVE, respond only if the virtual server is available. If PASSIVE, respond even if the virtual server is not available.
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 |
useoriginipportforcache |
|
Read-write | Use origin ip/port while forwarding request to the cache. Change the destination IP, destination port of the request came to CR vserver to Origin IP and Origin Port and forward it to Cache.
Default value: NO Possible values = YES, NO |
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 |
disallowserviceaccess |
|
Read-write | This is effective when a FORWARD type cr vserver is added. By default, this parameter is DISABLED. When it is ENABLED, backend services cannot be accessed through a FORWARD type cr vserver.
Default value: DISABLED Possible values = ENABLED, DISABLED |
newname |
|
Read-write | New name for the cache redirection virtual server. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my name” or ‘my name’).
Minimum length = 1 |
ip |
|
Read-only | . |
value |
|
Read-only | The ssl card status for the transparent ssl cr vserver.
Possible values = Certkey/Certkeybundle not bound, SSL feature disabled |
ngname |
|
Read-only | Nodegroup devno to which this crvserver belongs to. |
type |
|
Read-only | Virtual server type.
Possible values = CONTENT, ADDRESS |
curstate |
|
Read-only | The state of the cr 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. |
authentication |
|
Read-only | Authentication.
Possible values = ON, OFF |
homepage |
|
Read-only | Home page. |
rule |
|
Read-only | Rule. |
policyname |
|
Read-only | Policies bound to this vserver. |
pipolicyhits |
|
Read-only | Number of hits. |
servicename |
|
Read-only | Service name. |
weight |
|
Read-only | Weight for this service. |
targetvserver |
|
Read-only | The CSW target server names. |
priority |
|
Read-only | The priority for the policy. |
somethod |
|
Read-only | The spillover factor. When the main virtual server reaches this spillover threshold, it will give further traffic to the backupvserver.
Possible values = CONNECTION, DYNAMICCONNECTION, BANDWIDTH, HEALTH, NONE |
sopersistence |
|
Read-only | The state of spillover persistence.
Possible values = ENABLED, DISABLED |
lbvserver |
|
Read-only | The Default target server name.
Minimum length = 1 |
bindpoint |
|
Read-only | The bindpoint to which the policy is bound.
Possible values = REQUEST, RESPONSE, ICA_REQUEST |
invoke |
|
Read-only | Invoke flag. |
labeltype |
|
Read-only | The invocation type.
Possible values = reqvserver, resvserver, policylabel |
labelname |
|
Read-only | Name of the label invoked. |
gotopriorityexpression |
|
Read-only | Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE. |
nodefaultbindings |
|
Read-only | to determine if the configuration will have default ssl CIPHER and ECC curve bindings.
Default value: NO Possible values = YES, NO |
__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/crvserver HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"crvserver":{
<b>"name":<String_value>,
</b>"td":<Double_value>,
<b>"servicetype":<String_value>,
</b>"ipv46":<String_value>,
"port":<Integer_value>,
"ipset":<String_value>,
"range":<Double_value>,
"cachetype":<String_value>,
"redirect":<String_value>,
"onpolicymatch":<String_value>,
"redirecturl":<String_value>,
"clttimeout":<Double_value>,
"precedence":<String_value>,
"arp":<String_value>,
"ghost":<String_value>,
"map":<String_value>,
"format":<String_value>,
"via":<String_value>,
"cachevserver":<String_value>,
"dnsvservername":<String_value>,
"destinationvserver":<String_value>,
"domain":<String_value>,
"sopersistencetimeout":<Double_value>,
"sothreshold":<Double_value>,
"reuse":<String_value>,
"state":<String_value>,
"downstateflush":<String_value>,
"backupvserver":<String_value>,
"disableprimaryondown":<String_value>,
"l2conn":<String_value>,
"backendssl":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"comment":<String_value>,
"srcipexpr":<String_value>,
"originusip":<String_value>,
"useportrange":<String_value>,
"appflowlog":<String_value>,
"netprofile":<String_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"useoriginipportforcache":<String_value>,
"tcpprobeport":<Integer_value>,
"probeprotocol":<String_value>,
"probesuccessresponsecode":<String_value>,
"probeport":<Integer_value>,
"disallowserviceaccess":<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/crvserver/ 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/crvserver HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"crvserver":{
<b>"name":<String_value>,
</b>"ipv46":<String_value>,
"ipset":<String_value>,
"redirect":<String_value>,
"onpolicymatch":<String_value>,
"precedence":<String_value>,
"arp":<String_value>,
"via":<String_value>,
"cachevserver":<String_value>,
"dnsvservername":<String_value>,
"destinationvserver":<String_value>,
"domain":<String_value>,
"reuse":<String_value>,
"backupvserver":<String_value>,
"disableprimaryondown":<String_value>,
"redirecturl":<String_value>,
"clttimeout":<Double_value>,
"downstateflush":<String_value>,
"l2conn":<String_value>,
"backendssl":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"netprofile":<String_value>,
"comment":<String_value>,
"srcipexpr":<String_value>,
"originusip":<String_value>,
"useportrange":<String_value>,
"appflowlog":<String_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"useoriginipportforcache":<String_value>,
"tcpprobeport":<Integer_value>,
"probeprotocol":<String_value>,
"probesuccessresponsecode":<String_value>,
"probeport":<Integer_value>,
"disallowserviceaccess":<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/crvserver? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"crvserver":{
<b>"name":<String_value>,
</b>"cachevserver":true,
"dnsvservername":true,
"destinationvserver":true,
"domain":true,
"backupvserver":true,
"clttimeout":true,
"redirecturl":true,
"l2conn":true,
"backendssl":true,
"originusip":true,
"useportrange":true,
"srcipexpr":true,
"tcpprofilename":true,
"httpprofilename":true,
"appflowlog":true,
"netprofile":true,
"icmpvsrresponse":true,
"tcpprobeport":true,
"probeprotocol":true,
"ipset":true,
"redirect":true,
"onpolicymatch":true,
"precedence":true,
"arp":true,
"via":true,
"reuse":true,
"disableprimaryondown":true,
"downstateflush":true,
"listenpolicy":true,
"listenpriority":true,
"comment":true,
"rhistate":true,
"useoriginipportforcache":true,
"probesuccessresponsecode":true,
"disallowserviceaccess":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/crvserver? action=enable HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"crvserver":{
<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/crvserver? action=disable HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"crvserver":{
<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/crvserver? action=rename HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"crvserver":{
<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/crvserver Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/crvserver? 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/crvserver? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of crvserver resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/crvserver? view=summary
Use this query-parameter to get the summary output of crvserver 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/crvserver? pagesize=#no;pageno=#no
Use this query-parameter to get the crvserver 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:
{ "crvserver": [ {
"name":<String_value>,
"ip":<String_value>,
"td":<Double_value>,
"ipv46":<String_value>,
"value":<String_value>,
"port":<Integer_value>,
"range":<Double_value>,
"servicetype":<String_value>,
"ngname":<String_value>,
"type":<String_value>,
"curstate":<String_value>,
"status":<Integer_value>,
"cachetype":<String_value>,
"redirect":<String_value>,
"onpolicymatch":<String_value>,
"precedence":<String_value>,
"redirecturl":<String_value>,
"authentication":<String_value>,
"homepage":<String_value>,
"dnsvservername":<String_value>,
"domain":<String_value>,
"rule":<String_value>,
"policyname":<String_value>,
"pipolicyhits":<Double_value>,
"servicename":<String_value>,
"weight":<Double_value>,
"cachevserver":<String_value>,
"targetvserver":<String_value>,
"backupvserver":<String_value>,
"priority":<Double_value>,
"clttimeout":<Double_value>,
"somethod":<String_value>,
"sopersistence":<String_value>,
"sopersistencetimeout":<Double_value>,
"sothreshold":<Double_value>,
"reuse":<String_value>,
"arp":<String_value>,
"destinationvserver":<String_value>,
"via":<String_value>,
"downstateflush":<String_value>,
"disableprimaryondown":<String_value>,
"l2conn":<String_value>,
"backendssl":<String_value>,
"comment":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"srcipexpr":<String_value>,
"originusip":<String_value>,
"useportrange":<String_value>,
"appflowlog":<String_value>,
"netprofile":<String_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"lbvserver":<String_value>,
"bindpoint":<String_value>,
"invoke":<Boolean_value>,
"labeltype":<String_value>,
"labelname":<String_value>,
"gotopriorityexpression":<String_value>,
"ipset":<String_value>,
"nodefaultbindings":<String_value>,
"useoriginipportforcache":<String_value>,
"tcpprobeport":<Integer_value>,
"probeprotocol":<String_value>,
"probeport":<Integer_value>,
"probesuccessresponsecode":<String_value>,
"disallowserviceaccess":<String_value>
}]}
get
URL: http:// <netscaler-ip-address> /nitro/v1/config/crvserver/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/crvserver/ 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/crvserver/ name_value<String> ? view=summary
Use this query-parameter to get the summary output of crvserver 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:
{ "crvserver": [ {
"name":<String_value>,
"ip":<String_value>,
"td":<Double_value>,
"ipv46":<String_value>,
"value":<String_value>,
"port":<Integer_value>,
"range":<Double_value>,
"servicetype":<String_value>,
"ngname":<String_value>,
"type":<String_value>,
"curstate":<String_value>,
"status":<Integer_value>,
"cachetype":<String_value>,
"redirect":<String_value>,
"onpolicymatch":<String_value>,
"precedence":<String_value>,
"redirecturl":<String_value>,
"authentication":<String_value>,
"homepage":<String_value>,
"dnsvservername":<String_value>,
"domain":<String_value>,
"rule":<String_value>,
"policyname":<String_value>,
"pipolicyhits":<Double_value>,
"servicename":<String_value>,
"weight":<Double_value>,
"cachevserver":<String_value>,
"targetvserver":<String_value>,
"backupvserver":<String_value>,
"priority":<Double_value>,
"clttimeout":<Double_value>,
"somethod":<String_value>,
"sopersistence":<String_value>,
"sopersistencetimeout":<Double_value>,
"sothreshold":<Double_value>,
"reuse":<String_value>,
"arp":<String_value>,
"destinationvserver":<String_value>,
"via":<String_value>,
"downstateflush":<String_value>,
"disableprimaryondown":<String_value>,
"l2conn":<String_value>,
"backendssl":<String_value>,
"comment":<String_value>,
"listenpolicy":<String_value>,
"listenpriority":<Double_value>,
"tcpprofilename":<String_value>,
"httpprofilename":<String_value>,
"srcipexpr":<String_value>,
"originusip":<String_value>,
"useportrange":<String_value>,
"appflowlog":<String_value>,
"netprofile":<String_value>,
"icmpvsrresponse":<String_value>,
"rhistate":<String_value>,
"lbvserver":<String_value>,
"bindpoint":<String_value>,
"invoke":<Boolean_value>,
"labeltype":<String_value>,
"labelname":<String_value>,
"gotopriorityexpression":<String_value>,
"ipset":<String_value>,
"nodefaultbindings":<String_value>,
"useoriginipportforcache":<String_value>,
"tcpprobeport":<Integer_value>,
"probeprotocol":<String_value>,
"probeport":<Integer_value>,
"probesuccessresponsecode":<String_value>,
"disallowserviceaccess":<String_value>
}]}
count
URL: http:// <netscaler-ip-address> /nitro/v1/config/crvserver? 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:
{ "crvserver": [ { "__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.