Citrix ADC

Virtual server based expressions

July 16, 2021

Contributed by:

The SYS.VSERVER("<vserver-name>") expression prefix enables you to identify a virtual server. You can use the following functions with this prefix to retrieve information related to the specified virtual server:

THROUGHPUT. Returns the throughput of the virtual server in Mbps (Megabits per second). The value returned is an unsigned long number.

Usage: SYS.VSERVER(“vserver”).THROUGHPUT
CONNECTIONS. Returns the number of connections being managed by the virtual server. The value returned is an unsigned long number.

Usage: SYS.VSERVER(“vserver”).CONNECTIONS
STATE. Returns the state of the virtual server. The value returned is UP, DOWN, or OUT_OF_SERVICE. One of these values can therefore be passed as an argument to the EQ() operator to perform a comparison that results in a Boolean TRUE or FALSE.

Usage: SYS.VSERVER(“vserver”).STATE
HEALTH. Returns the percentage of services in an UP state for the specified virtual server. The value returned is an integer.

Usage: SYS.VSERVER(“vserver”).HEALTH
RESPTIME. Returns the response time as an integer representing the number of microseconds. Response time is the average TTFB (Time To First Byte) from all the services bound to the virtual server.

Usage: SYS.VSERVER(“vserver”).RESPTIME
SURGECOUNT. Returns the number of requests in the surge queue of the virtual server. The value returned is an integer.

Usage: SYS.VSERVER(“vserver”).SURGECOUNT

Example 1:

The following rewrite policy aborts rewrite processing if the number of connections at the load balancing virtual server LBvserver exceeds 10000:

add rewrite policy norewrite_pol sys.vserver("LBvserver").connections.gt(10000) norewrite

Example 2:

The following rewrite action inserts a custom header, TP, whose value is the throughout at the virtual server LBvserver:

add rewrite action tp_header insert_http_header TP SYS.VSERVER("LBvserver").THROUGHPUT

Example 3:

The following audit log message action writes the average TTFB of the services bound to a virtual server, to the newnslog log file:

add audit messageaction log_vserver_resptime_act INFORMATIONAL "\"NS Response Time to Servers:\" + sys.vserver(\"ssllb\").resptime + \" millisec\"" -logtoNewnslog YES

The official version of this content is in English. Some of the Citrix documentation content is machine translated for your convenience only. Citrix has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Citrix product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Citrix, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Citrix will not be held responsible for any damage or issues that may arise from using machine-translated content.

Virtual server based expressions

July 16, 2021

Contributed by:

July 16, 2021

Contributed by:

Virtual server based expressions

In this article