| getcrvserverResult Structure Definition |
The getcrvserverResult structure defines the return type for getcrvserver API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
crvserverList |
List of crvservers |
| crvserver Structure Definition |
The crvserver structure defines the actual return type values for getcrvserver API. |
Syntax |
Members |
name |
Name of a cache redirection virtual server about which to display detailed information. |
ipaddress |
ipaddress2 |
The IP address of the virtual server. |
value |
The ssl card status for the transparent ssl cr vserver. |
port |
Port number of the virtual server. |
range |
Number of consecutive IP addresses, starting with the address specified by the IP Address parameter, to include in a range of addresses assigned to this virtual server. |
servicetype |
Protocol (type of service) handled by the virtual server. |
ngname |
Nodegroup devno to which this crvserver belongs to |
type |
Virtual server type. |
state |
The state of the cr vserver. |
status |
Status. |
cachetype |
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. |
redirect |
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. |
onpolicymatch |
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. |
precedence |
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. NOTE: This attribute is deprecated. This attribute is deprecated. Starting from the 13.1 release, only Advanced CS policies are supported and this parameter has no effect on Advanced policies. |
redirecturl |
URL of the server to which to redirect traffic if the cache redirection virtual server configured on the Citrix ADC becomes unavailable. |
authentication |
Authentication. |
homepage |
Home page. |
dnsvservername |
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. |
domain |
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. |
rule |
Rule. |
policyname |
Policies bound to this vserver. |
pipolicyhits |
Number of hits. |
hits |
The hits of default LB vserver |
servicename |
Service name. |
weight |
Weight for this service. |
cachevserver |
Name of the default cache virtual server to which to redirect requests (the default target of the cache redirection virtual server). NOTE: This attribute is deprecated. The functionality is intact, but we advise to use bind method to do default binding for CR |
targetvserver |
The CSW target server names. |
backupvserver |
Name of the backup virtual server to which traffic is forwarded if the active server becomes unavailable. |
priority |
The priority for the policy. |
clttimeout |
Time-out value, in seconds, after which to terminate an idle client connection. |
somethod |
The spillover factor. When the main virtual server reaches this spillover threshold, it will give further traffic to the backupvserver. |
sopersistence |
The state of spillover persistence. |
sopersistencetimeout |
The spillover persistence entry timeout. |
sothreshold |
The spillover threshold value. |
reuse |
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. |
arp |
Use ARP to determine the destination MAC address. |
destinationvserver |
Destination virtual server for a transparent or forward proxy cache redirection virtual server. |
via |
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. |
downstateflush |
Perform delayed clean up of connections on this vserver. |
disableprimaryondown |
Tells whether traffic will continue reaching backup vservers even after primary comes UP from DOWN state. |
l2conn |
Use L2 parameters, such as MAC, VLAN, and channel to identify a connection. |
backendssl |
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. |
comment |
Comments associated with this virtual server. |
listenpolicy |
The string is listenpolicy configured for CR vserver |
listenpriority |
This parameter is the priority for listen policy of CR Vserver. |
tcpprofilename |
Name of the profile containing TCP configuration information for the cache redirection virtual server. |
httpprofilename |
Name of the profile containing HTTP configuration information for cache redirection virtual server. |
srcipexpr |
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. |
originusip |
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. |
useportrange |
Use a port number from the port range (set by using the set ns param method, or in the Create Virtual Server (Cache Redirection) dialog box) as the source port in the requests sent to the origin server. |
appflowlog |
Enable logging of AppFlow information. |
netprofile |
Name of the network profile containing network configurations for the cache redirection virtual server. |
icmpvsrresponse |
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. |
rhistate |
A host route is injected according to the setting on the virtual servers
* If set to PASSIVE on all the virtual servers that share the IP address, the appliance always injects the hostroute.
* If set to ACTIVE on all the virtual servers that share the IP address, the appliance injects even if one virtual server is UP.
* If set to ACTIVE on some virtual servers and PASSIVE on the others, the appliance, injects even if one virtual server set to ACTIVE is UP. |
lbvserver |
The Default target server name. |
inherited |
On State describes that policy bound is inherited from global binding. |
type2 |
The bindpoint to which the policy is bound |
invoke |
Invoke flag. |
labeltype |
The invocation type. |
labelname |
Name of the label invoked. |
gotopriorityexpression |
Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE. |
ipset |
The list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current cr vserver |
nodefaultbindings |
to determine if the configuration will have default ssl CIPHER and ECC curve bindings |
useoriginipportforcache |
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 |
tcpprobeport |
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. NOTE: This attribute is deprecated. The functionality is intact, but we advise to use -probePort and -probeProtocol options |
analyticsprofile |
Name of the analytics profile bound to the CR vserver. |
probeprotocol |
Citrix ADC provides support for external health check of the vserver status. Select HTTP or TCP probes for healthcheck |
probeport |
Citrix ADC provides support for external health check of the vserver status. Select port for HTTP/TCP monitring |
probesuccessresponsecode |
HTTP code to return in SUCCESS case. |
disallowserviceaccess |
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. |
_nextgenapiresource |
cswpolicyname |
The bound CSW policy names. |
cswtargetserver |
The CSW target server names. |
cswpriority |
The priorities of bound CSW policies. |
cswpolicyhits |
The hits of bound CSW policies. |
cswpipolicybindhits |
The hits of bound CSW PI policies. |
cswpolicygotoprioexpr |
The bindpoints of bound CSW policies. |
cswpolicybindpoint |
The bindpoints of bound CSW policies. |
cswinvoke |
The invoke flag of bound CSW policies. |
cswpolicyinvokelabeltype |
The invoke-label-types of bound CSW policies. |
cswpolicyinvokelabelname |
The invoke-labels of bound CSW policies. |
crdpolicyname |
The bound CRD policy names. |
crdpolicypriority |
crdpolicyhits |
The hits of bound CR policies. |
crdpipolicybindhits |
The hits of bound CR PI policies. |
crdpolicygotoprioexpr |
The priorities of bound CR policies. |
crdinvoke |
The invoke flag of bound CR policies. |
crdpolicyinvokelabelname |
The invoke-label-types of bound CR policies. |
crdpolicyinvokelabeltype |
The invoke-labels of bound CR policies. |
crdpolicybindpoint |
The bindpoints of bound CR policies. |
maptable |
The map table names. |
mttargetserver |
The MT target server names. |
cmppolicyname |
cmppolicypriority |
cmppolicygotoprioexpr |
The next_expr-s of bound CMP policies. |
cmppolicybindpoint |
The bindpoints of bound CMP policies. |
cmpinvoke |
The invoke flag of bound CMP policies. |
cmppolicyinvokelabeltype |
The invoke-label-types of bound CMP policies. |
cmppolicyinvokelabelname |
The invoke-labels of bound CMP policies. |
spilloverpolicyname |
The bound spillover policy names. |
spilloverpolicygotoprioexpression |
spilloverpolicyflowtype |
spilloverpolicypriority |
The priorities of bound spillover policies. |
appflowpolicyname |
The bound AppFlow policy names. |
appflowpolicypriority |
The priorities of bound AppFlow policies. |
appflowpolicygotoprioexpression |
The next_expr-s of bound AppFlow policies. |
appflowinvoke |
The invoke flag of bound AppFlow policies. |
appflowpolicyinvokelabeltype |
The invoke-label-types of bound AppFlow policies. |
appflowpolicyinvokelabelname |
The invoke-labels of bound AppFlow policies. |
feopolicyname |
The bound Content optimizatoin policy names. |
feopolicypriority |
The priorities of bound CO policies. |
feopolicynextexpr |
The next_expr-s of bound CO policies. |
feopolicybindpoint |
The bindpoints of bound CO policies. |
rwpolicyname |
The bound rewrite policy names. |
rwpolicypriority |
The priorities of bound rewrite policies. |
rwpolicygotoprioexpression |
The next_expr-s of bound rewrite policies. |
rwpolicybindpoint |
The bindpoints of bound rewrite policies. |
rwinvoke |
The invoke flag of bound rewrite policies. |
rwpolicyinvokelabeltype |
The invoke-label-types of bound rewrite policies. |
rwpolicyinvokelabelname |
The invoke-labels of bound rewrite policies. |
cachepolicyname |
The bound cache policy names. |
cachepolicypriority |
The priorities of bound cache policies. |
cachepolicygotoprioexpression |
The next_expr-s of bound cache policies. |
cachepolicybindpoint |
The bindpoints of bound cache policies. |
cacheinvoke |
The invoke flag of bound cache policies. |
cachepolicyinvokelabeltype |
The invoke-label-types of bound cache policies. |
cachepolicyinvokelabelname |
The invoke-labels of bound cache policies. |
rsppolicyname |
The bound Responder policy names. |
rsppolicypriority |
The priorities of bound Responder policies. |
rsppolicygotoprioexpression |
The next_expr-s of bound Responder policies. |
rspinvoke |
The invoke flag of bound Responder policies. |
rsppolicyinvokelabeltype |
The invoke-label-types of bound Responder policies. |
rsppolicyinvokelabelname |
The invoke-labels of bound Responder policies. |
icapolicyname |
The bound ICA smartaccess2 policy names. |
icapolicypriority |
The priorities of bound ICA smartaccess2 policies. |
icapolicynextexpression |
The next_expr-s of bound ICA smartaccess2 policies. |
appfwpolicyname |
The bound appication firewall policy names. |
appfwpriority |
The priorities of bound application firewall policies. |
appfwpolicygotoprioexpression |
The next_expr-s of bound Application firewall policies. |
appfwbindpoint |
The bindpoints of bound application firewall policies. |
appfwinvoke |
The invoke flag of bound application firewall policies. |
appfwpolicyinvokelabeltype |
The invoke-label-types of bound application firewall policies. |
appfwpolicyinvokelabelname |
The invoke-labels of bound application firewall policies. |
appqospolicyname |
The bound application AppQos policy name. |
appqospolicypriority |
The priority of bound application AppQoS policy. |
appqospolicygotoprioexpr |
The next expression of bound application AppQoS policy. |
appqospolicybindpoint |
The bindpoint of bound application AppQoS policy. |
appqosinvoke |
The invoke flag of bound application AppQoS policy. |
appqospolicyinvokelabeltype |
The invoke label type of bound application AppQoS policy. |
appqospolicyinvokelabelname |
The invoke label name of bound application AppQoS policy. |
defaultlb |
The default target LB Vserver. |
See Also |