Citrix NetScaler · Schema

Citrix NetScaler Virtual Server

A virtual server (vserver) object from the Citrix NetScaler NITRO API, representing either a load balancing or content switching virtual server that accepts incoming client traffic and distributes or routes it to backend services.

API GatewayApplication Delivery ControllerApplication SecurityLoad BalancingSSL OffloadingTraffic ManagementWeb Application Firewall

Properties

Name Type Description
name string Name for the virtual server. Must begin with a letter, number, or underscore character and must contain only alphanumeric, hyphen, period, hash, space, at, equals, colon, and underscore characters.
servicetype string Protocol of the service running on the virtual server.
ipv46 string IPv4 or IPv6 address to assign to the virtual server. This is typically a Virtual IP (VIP) address on the NetScaler used as the entry point for client traffic.
port integer Port number on which the virtual server listens for client connections.
td integer Traffic domain identifier to isolate traffic for this virtual server from other traffic domains on the appliance.
ipset string Name of the IP set to bind to the virtual server, providing multiple IP addresses for the virtual server.
range integer Number of consecutive IP addresses that the appliance must generate beginning from the VIP address.
ippattern string IP address pattern for identifying packets to be accepted by the virtual server. Used together with ipmask.
ipmask string IP address mask applied with the IP pattern to form an IP address range for packet matching.
lbmethod string Load balancing method used to select the backend service for each client request. Applicable only to load balancing virtual servers.
backuplbmethod string Backup load balancing method used when the primary method fails to select a service.
persistencetype string Type of persistence for the virtual server. Ensures requests from the same client are directed to the same backend service.
persistencebackup string Backup persistence type for the virtual server.
timeout integer Persistence timeout in minutes. Duration for which persistence sessions are maintained after the last matching request.
clttimeout integer Client idle timeout in seconds. Time the NetScaler waits before closing an idle client connection.
cookiename string Name of the HTTP cookie generated by the NetScaler for cookie-insert persistence.
comment string Informational description or comments about the virtual server.
state string Administrative state of the virtual server.
curstate string Current operational state of the virtual server. This is a read-only property reflecting the runtime status.
effectivestate string Effective state of the virtual server considering all contributing factors.
status integer Current status code of the virtual server. A value of 1 indicates the virtual server is UP.
statechangetimesec string Timestamp of the last state change for the virtual server.
tickssincelaststatechange integer Number of system ticks elapsed since the last state change.
totalservices integer Total number of services bound to this virtual server.
activeservices integer Number of currently active (UP) services bound to this virtual server.
health integer Health of the virtual server expressed as a percentage of UP services relative to total bound services.
somethod string Spillover method that defines the condition under which traffic overflows to the backup virtual server.
sothreshold integer Threshold value for the spillover method. The meaning varies based on the spillover method selected.
sopersistence string Whether to maintain persistence sessions when spillover occurs.
sopersistencetimeout integer Persistence timeout in minutes during spillover conditions.
healththreshold integer Minimum percentage of UP services required for the virtual server to be considered UP.
redirecturl string URL to which client requests are redirected when all bound services are DOWN.
downstateflush string Whether to flush all active transactions on all bound services when the virtual server transitions to DOWN.
insertvserveripport string Whether to insert the virtual server VIP address and port number into the HTTP request header.
vipheader string Name of the HTTP header in which the VIP address and port are inserted.
disableprimaryondown string Whether to continue directing traffic to the virtual server when it is DOWN in an HA deployment.
authentication string Whether authentication is enabled for the virtual server.
authenticationhost string Fully qualified domain name of the authentication virtual server to which users are redirected for authentication.
authn401 string Whether to use HTTP 401-based authentication instead of redirect-based authentication.
authnvsname string Name of the authentication virtual server to use for 401-based authentication.
push string Whether to process traffic with the push virtual server bound to this virtual server.
pushlabel string Expression for extracting a label from the incoming request for push functionality.
pushmulticlients string Whether to allow multiple clients to connect to the push virtual server.
icmpvsrresponse string How the NetScaler appliance responds to ICMP ping requests directed at the VIP address.
rhistate string Route Health Injection state. Controls whether the route to the VIP is advertised via dynamic routing protocols when the server is UP.
appflowlog string Whether to enable AppFlow logging for the virtual server to capture traffic analytics.
connfailover string Connection failover mode for the virtual server in HA deployments.
precedence string Type of precedence to apply for content switching policy evaluation. Applicable only to content switching virtual servers.
casesensitive string Whether URL-based content switching is case sensitive. Applicable only to content switching virtual servers.
lbvserver string Name of the default load balancing virtual server bound to this content switching virtual server.
targetlbvserver string Name of the target load balancing virtual server to which matching content is switched.
cachetype string Cache type for integrated caching on the virtual server.
isgslb boolean Whether this virtual server is a GSLB (Global Server Load Balancing) virtual server.
View JSON Schema on GitHub