getcsvserverResult Structure Definition

The getcsvserverResult structure defines the return type for getcsvserver 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.

csvserverList

List of csvservers


csvserver Structure Definition

The csvserver structure defines the actual return type values for getcsvserver API.

Syntax



Members

name

Name of a content switching virtual server for which to display information, including the policies bound to the virtual server.

insertvserveripport

The virtual IP and port header insertion option for the vserver.

vipheader

The name of virtual IP and port header.

ipaddress

The IP address of the virtual server.
NOTE: This attribute is deprecated.
This is no more in use.

ipaddress2

IP address of the content switching virtual server.

value

The ssl card status for the transparent ssl cs vserver.

port

Port number for content switching virtual server.

ipset

The list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current cs vserver

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 used by the virtual server.

ngname

Nodegroup devno to which this csvserver belongs to

type

Virtual server type.

state

The state of the cs vserver.

stateupdate

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.

status

Status.

cachetype

Cache type.

redirect

Redirect URL string.

precedence

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

The redirect URL for content switching.

authentication

Authentication.

authn401

HTTP 401 response based authentication.

authnvsname

Name of authentication virtual server that authenticates the incoming user requests to this content switching virtual server.

casesensitive

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

homepage

Home page.

dnsvservername

DNS vserver name.

domain

Domain.

rule

The next_expr-s of bound content switching policies.

policyname

The bound BOT policy names.

hits

The hits of bound CSW policies.

pipolicyhits

The hits of bound CSW policies.

servicename

Service name.

weight

Weight for this service.

cachevserver

Cache vserver name.

targetvserver

target vserver name.

backupvserver

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.

priority

The priorities of bound BOT policies.

clttimeout

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.

listenpolicy

The string is listenpolicy configured for lb vserver

listenpriority

This parameter is the priority for listen policy of LB Vserver.

somethod

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.

sopersistence

Maintain source-IP based persistence on primary and backup virtual servers.

sopersistencetimeout

Time-out value, in minutes, for spillover persistence.

sothreshold

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.

sobackupaction

Action to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists

cacheable

The state of caching.

url

URL string.

gotopriorityexpression

The next_expr-s of bound BOT policies.

redirectportrewrite

Redirect port rewrite.

downstateflush

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.

disableprimaryondown

Tells whether traffic will continue reaching backup vservers even after primary comes UP from DOWN state.

type2

The bindpoint to which the policy is bound

invoke

The invoke flag of bound BOT policies.

labeltype

The invoke-label-types of bound BOT policies.

labelname

The invoke-labels of bound BOT policies.

gt2gb

This argument has no effect.

statechangetimesec

Time when last state change happened. Seconds part.

statechangetimemsec

Time at which last state change happened. Milliseconds part.

tickssincelaststatechange

Time in 10 millisecond ticks since the last state change.

rtspnat

Enable network address translation (NAT) for real-time streaming protocol (RTSP) connections.

authenticationhost

FQDN of the authentication virtual server. The service type of the virtual server should be either HTTP or SSL.

push

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.

pushvserver

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.

pushlabel

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.

pushmulticlients

Allow multiple Web 2.0 connections from the same client to connect to the virtual server and expect updates.

tcpprofilename

Name of the TCP profile containing TCP configuration settings for the virtual server.

httpprofilename

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.

dbprofilename

Name of the DB profile.

comment

Information about this virtual server.

oracleserverversion

Oracle server version

mssqlserverversion

The version of the MSSQL server

l2conn

Use L2 Parameters to identify a connection

ruletype

Rule type.

mysqlprotocolversion

The protocol version returned by the mysql vserver.

mysqlserverversion

The server version string returned by the mysql vserver.

mysqlcharacterset

The character set returned by the mysql vserver.

mysqlservercapabilities

The server capabilities returned by the mysql vserver.

appflowlog

Enable logging appflow flow information

netprofile

The name of the network profile.

icmpvsrresponse

Can be active or passive

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

Name of the default lb vserver bound. Use this param for Default binding only. For Example: bind cs vserver cs1 -lbvserver lb1

vserver

Name of the default gslb or vpn vserver bound to CS vserver of type GSLB/VPN. For Example: bind cs vserver cs1 -vserver gslb1 or bind cs vserver cs1 -vserver vpn1

targetlbvserver

target vserver name.

authnprofile

Name of the authentication profile to be used when authentication is turned on.

dnsprofilename

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.

targettype

Virtual server target type.

domainname

Domain name for which to change the time to live (TTL) and/or backup service IP address.

ttl


backupip


cookiedomain


cookietimeout


sitedomainttl


dnsrecordtype


persistenceid


analyticsprofile

Name of the analytics profile bound to the LB vserver.

dtls

This option starts/stops the dtls service on the vserver

nodefaultbindings

to determine if the configuration will have default ssl CIPHER and ECC curve bindings

persistencetype

Type of persistence for the virtual server. Available settings function as follows: * SOURCEIP - Connections from the same client IP address belong to the same persistence session. * COOKIEINSERT - Connections that have the same HTTP Cookie, inserted by a Set-Cookie directive from a server, belong to the same persistence session. * SSLSESSION - Connections that have the same SSL Session ID belong to the same persistence session.

persistmask

Persistence mask for IP based persistence types, for IPv4 virtual servers.

v6persistmasklen

Persistence mask for IP based persistence types, for IPv6 virtual servers.

timeout

Time period for which a persistence session is in effect.

cookiename

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.

version

Cookie version

vserverid

Vserver Id of vserver

cookieipport

Vserver id of the lb vserver that is inserted into the set-cookie HTTP header

persistencebackup

Backup persistence type for the virtual server. Becomes operational if the primary persistence mechanism fails.

backuppersistencetimeout

Time period for which backup persistence is in effect.

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

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.

quicprofilename

Name of QUIC profile which will be attached to the Content Switching VServer.

redirectfromport

Port number for the virtual server, from which we absorb the traffic for http redirect

httpsredirecturl

URL to which all HTTP traffic received on the port specified in the -redirectFromPort parameter is redirected.

apiprofile

The API profile where one or more API specs are bounded to.

dnsoverhttps

This option is used to enable/disable DNS over HTTPS (DoH) processing.

_nextgenapiresource


syslogpolicyname


syslogpriority


nslogpolicyname


nslogpriority


authorpolicyname

The bound authorization policy names.

authorpolicypriority

The priorities of bound authorization policies.

authorpolicygotoprioexpr

The next_expr-s of bound AUTHOR policies.

authorpolicybindpoint

The bindpoints of bound AUTHOR policies.

authorinvoke

The invoke flag of bound AUTHOR policies.

authorpolicyinvokelabeltype

The invoke-label-types of bound AUTHOR policies.

authorpolicyinvokelabelname

The invoke-labels of bound AUTHOR 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.

transformpolicyname

The bound transform policy names.

transformpolicypriority

The priorities of bound transform policies.

transformpolicygotoprioexpression

The next_expr-s of bound transform policies.

transformpolicybindpoint

The bindpoints of bound transform policies.

transforminvoke

The invoke flag of bound application policies.

transformpolicyinvokelabeltype

The invoke-label-types of bound transform policies.

transformpolicyinvokelabelname

The invoke-labels of bound transform 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.

rsppolicybindpoint

The bind point of bound Responder policies.

tmtrafficpolicyname

The bound tm traffic policy names.

tmtrafficpolicypriority

The priorities of bound tm traffic policies.

spilloverpolicyname

The bound spillover policy names.

spilloverpolicygotoprioexpression


spilloverpolicyflowtype


spilloverpolicypriority

The priorities of bound spillover policies.

cmppolicyname

The bound Compression policy names.

cmppolicypriority

The priorities of bound Compression policies.

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.

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.

cswpolicyname

The bound CSW policy name.

cswtargetserver

The Target LB Vserver name.

cswpriority

The priorities of bound CSW policies.

cswpolicygotoprioexpr

The next_expr-s 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.

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.

cipolicyname

The bound CI policy names.

cipolicypriority

The priorities of bound CI policies.

cipolicygotoprioexpression

The next_expr-s of bound CI policies.

cipolicybindpoint

The bindpoints of bound CI policies.

ciinvoke

The invoke flag of bound CI policies.

cipolicyinvokelabeltype

The invoke-label-types of bound CI policies.

cipolicyinvokelabelname

The invoke-labels of bound CI 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