Skip to content

crvserver

Configuration for CR virtual server resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name <String> 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 <Double> 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 <String> Read-write Protocol (type of service) handled by the virtual server.

Possible values = HTTP, SSL, NNTP, HDX
ipv46 <String> 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 <Integer> Read-write Port number of the virtual server.

Default value: 80

Minimum value = 1

Maximum value = 65534
ipset <String> 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 <Double> 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 <String> Read-write Mode of operation for the cache redirection virtual server. Available settings function as follows:

* TRANSPARENT - Intercept all traffic flowing to the appliance and apply cache redirection policies to determine whether content should be served from the cache or from the origin server.

* FORWARD - Resolve the hostname of the incoming request, by using a DNS server, and forward requests for non-cacheable content to the resolved origin servers. Cacheable requests are sent to the configured cache servers.

* REVERSE - Configure reverse proxy caches for specific origin servers. Incoming traffic directed to the reverse proxy can either be served from a cache server or be sent to the origin server with or without modification to the URL.

The default value for cache type is TRANSPARENT if service is HTTP or SSL whereas the default cache type is FORWARD if the service is HDX.

Possible values = TRANSPARENT, REVERSE, FORWARD
redirect <String> Read-write Type of cache server to which to redirect HTTP requests. Available settings function as follows:

* CACHE - Direct all requests to the cache.

* POLICY - Apply the cache redirection policy to determine whether the request should be directed to the cache or to the origin.

* ORIGIN - Direct all requests to the origin server.

Default value: POLICY

Possible values = CACHE, POLICY, ORIGIN
onpolicymatch <String> 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 <String> 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 <Double> Read-write Time-out value, in seconds, after which to terminate an idle client connection.

Minimum value = 0

Maximum value = 31536000
precedence <String> 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:

1. Domain and exact URL

2. Domain, prefix and suffix

3. Domain and suffix

4. Domain and prefix

5. Domain only

6. Exact URL

7. Prefix and suffix

8. Suffix only

9. Prefix only

10. Default

If you specify RULE, the rule based policies are applied before URL based policies are applied.

Default value: RULE

Possible values = RULE, URL
arp <String> Read-write Use ARP to determine the destination MAC address.

Possible values = ON, OFF
ghost <String> Read-write .

Possible values = ON, OFF
map <String> Read-write Obsolete.

Possible values = ON, OFF
format <String> Read-write .

Possible values = ON, OFF
via <String> 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 <String> 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 <String> 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 <String> Read-write Destination virtual server for a transparent or forward proxy cache redirection virtual server.

Minimum length = 1
domain <String> 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 <Double> Read-write Time-out, in minutes, for spillover persistence.

Minimum value = 2

Maximum value = 24
sothreshold <Double> 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 <String> 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:

* CACHE - TCP connections to the cache servers are not reused.

* ORIGIN - TCP connections to the origin servers are not reused.

* POLICY - TCP connections to the origin servers are not reused.

If you set the Reuse parameter to ON, connections to origin servers and connections to cache servers are reused.

Default value: ON

Possible values = ON, OFF
state <String> Read-write Initial state of the cache redirection virtual server.

Default value: ENABLED

Possible values = ENABLED, DISABLED
downstateflush <String> Read-write Perform delayed cleanup of connections to this virtual server.

Default value: ENABLED

Possible values = ENABLED, DISABLED
backupvserver <String> Read-write Name of the backup virtual server to which traffic is forwarded if the active server becomes unavailable.

Minimum length = 1
disableprimaryondown <String> 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 <String> Read-write Use L2 parameters, such as MAC, VLAN, and channel to identify a connection.

Possible values = ON, OFF
backendssl <String> 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 <String> 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 <Double> 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 <String> Read-write Name of the profile containing TCP configuration information for the cache redirection virtual server.

Minimum length = 1

Maximum length = 127
httpprofilename <String> Read-write Name of the profile containing HTTP configuration information for cache redirection virtual server.

Minimum length = 1

Maximum length = 127
comment <String> Read-write Comments associated with this virtual server.

Maximum length = 256
srcipexpr <String> 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 <String> 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 <String> 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 <String> Read-write Enable logging of AppFlow information.

Default value: ENABLED

Possible values = ENABLED, DISABLED
netprofile <String> Read-write Name of the network profile containing network configurations for the cache redirection virtual server.

Minimum length = 1

Maximum length = 127
icmpvsrresponse <String> 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 <String> 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 <String> 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 <Integer> 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
newname <String> 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 <String> Read-only .
value <String> Read-only The ssl card status for the transparent ssl cr vserver.

Possible values = Certkey not bound, SSL feature disabled
ngname <String> Read-only Nodegroup devno to which this crvserver belongs to.
type <String> Read-only Virtual server type.

Possible values = CONTENT, ADDRESS
curstate <String> 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 <Integer> Read-only Status.
sc <String> Read-only The state of SureConnect the specified virtual server.

Possible values = ON, OFF
authentication <String> Read-only Authentication.

Possible values = ON, OFF
homepage <String> Read-only Home page.
rule <String> Read-only Rule.
policyname <String> Read-only Policies bound to this vserver.
pipolicyhits <Double> Read-only Number of hits.
servicename <String> Read-only Service name.
weight <Double> Read-only Weight for this service.
targetvserver <String> Read-only The CSW target server names.
priority <Double> Read-only The priority for the policy.
somethod <String> 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 <String> Read-only The state of spillover persistence.

Possible values = ENABLED, DISABLED
lbvserver <String> Read-only The Default target server name.

Minimum length = 1
bindpoint <String> Read-only The bindpoint to which the policy is bound.

Possible values = REQUEST, RESPONSE, ICA_REQUEST
invoke <Boolean> Read-only Invoke flag.
labeltype <String> Read-only The invocation type.

Possible values = reqvserver, resvserver, policylabel
labelname <String> Read-only Name of the label invoked.
gotopriorityexpression <String> Read-only Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
nodefaultbindings <String> Read-only to determine if the configuration will have default ssl CIPHER and ECC curve bindings.

Default value: NO

Possible values = YES, NO
__count <Double> 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>
}}

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>
}}

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,
      "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
}}

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>,
      "sc":<String_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>
}]}

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>,
      "sc":<String_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>
}]}

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"} ] }