Citrix NetScaler · Schema

CsVserver

A content switching virtual server that directs client requests to different load balancing virtual servers based on content switching policies evaluating request attributes such as URL, HTTP header, or source IP address.

API GatewayApplication Delivery ControllerApplication SecurityLoad BalancingSSL OffloadingTraffic ManagementWeb Application Firewall

Properties

Name Type Description
name string Name for the content switching virtual server. Must be unique and begin with a letter, number, or underscore. Maximum 127 characters.
td integer Traffic domain identifier. Range 0-4094.
servicetype string Protocol of the service running on the virtual server.
ipv46 string IPv4 or IPv6 address of the content switching virtual server.
port integer Port number on which the content switching virtual server listens.
ipset string Name of the IP set to bind to the virtual server.
range integer Number of consecutive IP addresses for the virtual server. Range 2-254.
ippattern string IP address pattern for matching incoming requests.
ipmask string IP mask applied with ippattern to form an address range.
stateupdate string Whether the virtual server checks the backend server state for updates.
precedence string Type of precedence for content switching policies. RULE means policies are evaluated in priority order. URL means URL-based switching takes precedence.
casesensitive string Whether URL-based content switching is case sensitive.
somethod string Spillover method for the content switching virtual server.
sopersistence string Whether to maintain persistence during spillover.
sopersistencetimeout integer Persistence timeout in minutes during spillover. Range 2-1440.
sothreshold integer Threshold value for the spillover method.
redirecturl string URL to redirect requests to when the virtual server is DOWN.
clttimeout integer Client idle timeout in seconds. Range 0-31536000.
downstateflush string Flush all active transactions when the virtual server goes DOWN.
insertvserveripport string Insert the virtual server VIP address and port into the HTTP header of the request.
vipheader string Name of the HTTP header in which the VIP is inserted.
disableprimaryondown string Continue to direct traffic to the virtual server even when DOWN in HA mode.
authentication string Whether authentication is enabled for the virtual server.
authenticationhost string FQDN of the authentication virtual server.
authn401 string Whether HTTP 401-based authentication is enabled.
authnvsname string Name of the authentication virtual server.
push string Whether push functionality is enabled.
pushlabel string Expression for extracting a label from the request.
pushmulticlients string Allow multiple clients to connect to the push vserver.
comment string Description or comments about the content switching virtual server.
l2conn string Whether Layer 2 connectivity is enabled between the client and server.
icmpvsrresponse string How the appliance responds to ICMP ping requests for the VIP.
rhistate string Route health injection state for the virtual server.
appflowlog string Whether to log AppFlow records for the virtual server.
state string Administrative state of the virtual server.
lbvserver string Name of the default load balancing virtual server bound to this content switching virtual server. Requests that do not match any policy are sent here.
targetlbvserver string Name of the target load balancing virtual server to which content is switched.
cachetype string Cache type for integrated caching.
redirect string Type of cache redirect for the virtual server.
curstate string Current operational state of the virtual server.
status integer Current status of the virtual server. 1 indicates UP.
statechangetimesec string Time when the virtual server state last changed.
tickssincelaststatechange integer Number of ticks since the last state change.
type string Virtual server type (e.g., content-based or IP-address based).
ngname string Node group name to which the virtual server is bound.
value string The value of the IP address, based on the virtual server type.
View JSON Schema on GitHub