NetScaler VPX

Support matrix and usage guidelines

September 13, 2024

Contributed by:

This document lists the different hypervisors, and features supported on a Citrix ADC VPX instance. The document also describes their usage guidelines, and known limitations.

Table 1. VPX instance on Citrix Hypervisor

Citrix Hypervisor version	SysID	VPX models
8.2 supported 13.0 64.x onwards, 8.0, 7.6, 7.1	450000	VPX 10, VPX 25, VPX 200, VPX 1000, VPX 3000, VPX 5000, VPX 8000, VPX 10G, VPX 15G, VPX 25G, VPX 40G

Table 2. VPX instance on VMware ESXi hypervisor

The following VPX models with 450010 (Sys ID) supports the VMware ESX versions listed in the table.

VPX models: VPX 10, VPX 25, VPX 200, VPX 1000, VPX 3000, VPX 5000, VPX 8000, VPX 10G, VPX 15G, VPX 25G, VPX 40G, and VPX 100G.

ESXi version	ESXi release date in `MM/DD/YYYY` format	ESXi build number	Citrix ADC VPX version
ESXi 8.0 update 2	09/21/2023	22380479	13.0-92.x and higher builds
ESXi 8.0 update 1	04/18/2023	21495797	13.0-90.x and higher builds
ESXi 8.0c	03/30/2023	21493926	13.0-90.x and higher builds
ESXi 8.0	10/11/2022	20513097	13.0-90.x and higher builds
ESXi 7.0 update 3n	07/06/2023	21930508	13.0-91.x and higher builds
ESXi 7.0 update 3m	05/03/2023	21686933	13.0-91.x and higher builds
ESXi 7.0 update 3i	12/08/2022	20842708	13.0-90.x and higher builds
ESXi 7.0 update 3f	07/12/2022	20036589	13.0-86.x and higher builds
ESXi 7.0 update 3d	03/29/2022	19482537	13.0-86.x and higher builds
ESXi 7.0 update 3c	01/27/2022	19193900	13.0-85.x and higher builds
ESXi 7.0 update 2d	09/14/2021	18538813	13.0-83.x and higher builds
ESXi 7.0 update 2a	12/17/2020	17867351	13.0-82.x and higher builds
ESXi 6.7 P04	11/19/2020	17167734	13.0-67.x and higher builds
ESXi 6.7 P03	08/20/2020	16713306	13.0-67.x and higher builds
ESXi 6.7 P02	04/28/2020	16075168	13.0-67.x and higher builds
ESXi 6.7 update 3	08/20/2019	14320388	13.0-58.x and higher builds
ESXi 6.5 U1g	3/20/2018	7967591	13.0 47.x and higher builds

Note:

Each ESXi patch support is validated on the Citrix ADC VPX version specified in the preceding table and is applicable for all the higher builds of Citrix ADC 13.0 version.

Table 3. VPX on Microsoft Hyper-V

Hyper-V version	SysID	VPX models
2012, 2012R2, 2016, 2019	450020	VPX 10, VPX 25, VPX 200, VPX 1000, VPX 3000

VPX instance on Nutanix AHV

NetScaler VPX is supported on Nutanix AHV through the Citrix Ready partnership. Citrix Ready is a technology partner program that helps software and hardware vendors develop and integrate their products with NetScaler technology for digital workspace, networking, and analytics.

For more information on a step-by-step method to deploy a NetScaler VPX instance on Nutanix AHV, see Deploying a NetScaler VPX on Nutanix AHV.

Third-party support:

If you experience any issues with a particular third-party (Nutanix AHV) integration on a NetScaler environment, open a support incident directly with the third-party partner (Nutanix).

If the partner determines that the issue appears to be with NetScaler, the partner can approach NetScaler support for further assistance. A dedicated technical resource from partners works with the NetScaler support until the issue is resolved.

Table 4. VPX instance on generic KVM

Generic KVM version	SysID	VPX models
RHEL 7.6, RHEL 8.0, RHEL 9.3	450070	VPX 10, VPX 25, VPX 200, VPX 1000, VPX 3000, VPX 5000, VPX 8000, VPX 10G, VPX 15G. VPX 25G, VPX 40G, VPX 100G
Ubuntu 16.04, Ubuntu 18.04, RHV 4.2	450070

Points to note:

Consider the following points while using KVM hypervisors.

The VPX instance is qualified for hypervisor release versions mentioned in table 1–4, and not for patch releases within a version. However, the VPX instance is expected to work seamlessly with patch releases of a supported version. If it does not, log a support case for troubleshooting and debugging.
Use the ip link commands to configure RHEL 8.2 network bridges.
Before using RHEL 7.6, complete the following steps on the KVM host:
1. Edit /etc/default/grub and append "kvm_intel.preemption_timer=0" to GRUB_CMDLINE_LINUX variable.
2. Regenerate grub.cfg with the command "# grub2-mkconfig -o /boot/grub2/grub.cfg".
3. Restart the host machine.
Before using Ubuntu 18.04, complete the following steps on the KVM host:
1. Edit /etc/default/grub and append "kvm_intel.preemption_timer=0" to GRUB_CMDLINE_LINUX variable.
2. Regenerate grub.cfg with the command "# grub-mkconfig -o /boot/grub/grub.cfg “.
3. Restart the host machine.

Table 5. VPX instance on AWS

AWS version	SysID	VPX models
N/A	450040	VPX 10, VPX 200, VPX 1000, VPX 3000, VPX 5000, VPX BYOL, VPX 8000, VPX 10G, VPX 15G, and VPX 25G are available only with BYOL with EC2 instance types (C5, M5, and C5n)

Note:

The VPX 25G offering doesn’t give the desired 25G throughput in AWS but can give higher SSL transactions rate compared to VPX 15G offering.

Table 6. VPX instance on Azure

Azure version	SysID	VPX models
N/A	450020	VPX 10, VPX 200, VPX 1000, VPX 3000, VPX 5000, VPX BYOL

Table 7. VPX feature matrix

VPX-feature

The superscript numbers (1, 2, 3) used in the preceding table refers to the following points with respective numbering:

Clustering support is available on SRIOV for client-facing and server-facing interfaces and not for the backplane.
Interface DOWN events are not recorded in Citrix ADC VPX instances.
For Static LA, traffic might still be sent on the interface whose physical status is DOWN.
For LACP, the peer device knows the interface DOWN event based on the LACP timeout mechanism.
- Short timeout: 3 seconds
- Long timeout: 90 seconds
For LACP, do not share interfaces across VMs.
For Dynamic routing, convergence time depends on the Routing Protocol since link events are not detected.
Monitored static Route functionality fails if you do not bind monitors to static routes because the Route state depends on the VLAN status. The VLAN status depends on the link status.
Partial failure detection does not happen in high availability if there’s link failure. High availability-split brain condition might happen if there’s link failure.
- When any link event (disable/enable, reset) is generated from a VPX instance, the physical status of the link does not change. For static LA, any traffic initiated by the peer gets dropped on the instance.
- For the VLAN tagging feature to work, do the following:
On the VMware ESX, set the port group’s VLAN ID to 1–4095 on the vSwitch of the VMware ESX server.

Table 8. Supported browsers

Operating system	Browser and versions
Windows 7	Internet Explorer- 8, 9, 10, and 11; Mozilla Firefox 3.6.25 and above; Google Chrome- 15 and above
Windows 64 bit	Internet Explorer - 8, 9; Google Chrome - 15 and above
MAC	Mozilla Firefox - 12 and above; Safari - 5.1.3; Google Chrome - 15 and above

Usage guidelines

Follow these usage guidelines:

We recommend you to deploy a VPX instance on local disks of the server or SAN-based storage volumes.

See the VMware ESXi CPU Considerations section in the document Performance Best Practices for VMware vSphere 6.5. Here’s an extract:

It is not recommended that virtual machines with high CPU/Memory demand sit on a Host/Cluster that is overcommitted.
In most environments, ESXi allows significant levels of CPU overcommitment without impacting virtual machine performance. On a host, you can run more vCPUs than the total number of physical processor cores in that host.
If an ESXi host becomes CPU saturated, that is, the virtual machines and other loads on the host demand all the CPU resources the host has, latency-sensitive workloads might not perform well. In this case you might want to reduce the CPU load, for example, by powering off some virtual machines or migrating them to a different host, or allowing DRS to migrate them automatically.
Citrix recommends the latest hardware compatibility version to avail the latest feature sets of the ESXi hypervisor for the virtual machine. For more information about the hardware and ESXi version compatibility, see VMware documentation.
The Citrix ADC VPX is a latency-sensitive, high-performance virtual appliance. To deliver its expected performance, the appliance requires vCPU reservation, memory reservation, vCPU pinning on the host. Also, hyper threading must be disabled on the host. If the host does not meet these requirements, issues such as high-availability failover, CPU spike within the VPX instance, sluggishness in accessing the VPX CLI, pit boss daemon crash, packet drops, and low throughput occur.

A hypervisor is considered over-provisioned if one of the following two conditions is met:

The total number of virtual cores (vCPU) provisioned on the host is greater than the total number of physical cores (pCPUs).
The total number of provisioned VMs consume more vCPUs than the total number of pCPUs.

If an instance is over-provisioned, the hypervisor might not guarantee the resources reserved (such as CPU, memory, and others) for the instance due to hypervisor scheduling over-heads, bugs, or limitations with the hypervisor. This behavior can cause lack of CPU resource for Citrix ADC and might lead to the issues mentioned in the first point under Usage guidelines. As administrators, you’re recommended to reduce the tenancy on the host so that the total number of vCPUs provisioned on the host is lesser or equal to the total number of pCPUs.

Example

For ESX hypervisor, if the %RDY% parameter of a VPX vCPU is greater than 0 in the esxtop command output, the ESX host is said to be having scheduling overheads, which can cause latency related issues for the VPX instance.

In such a situation, reduce the tenancy on the host so that %RDY% returns to 0 always. Alternatively, contact the hypervisor vendor to triage the reason for not honoring the resource reservation done.
Hot adding is supported only for PV and SRIOV interfaces with Citrix ADC on AWS. VPX instances with ENA interfaces do not support hot-plug, and the behavior of the instances can be unpredictable if hot-plugging is attempted.
Hot removing either through the AWS Web console or AWS CLI interface is not supported with PV, SRIOV, and ENA interfaces for Citrix ADC. The behavior of the instances can be unpredictable if hot-removal is attempted.

Commands to control the packet engine CPU usage

You can use two commands (set ns vpxparam and show ns vpxparam) to control the packet engine (non-management) CPU usage behavior of VPX instances in hypervisor and cloud environments:

set ns vpxparam [-cpuyield (YES | NO | DEFAULT)] [-masterclockcpu1 (YES | NO)]

Allow each VM to use CPU resources that have been allocated to another VM but are not being used.

Set ns vpxparam parameters:

-cpuyield: Release or do not release of allocated but unused CPU resources.
- YES: Allow allocated but unused CPU resources to be used by another VM.
- NO: Reserve all CPU resources for the VM to which they have been allocated. This option shows higher percentage in hypervisor and cloud environments for VPX CPU usage.
- DEFAULT: No.
Note:

On all the Citrix ADC VPX platforms, the vCPU usage on the host system is 100 percent. Type the set ns vpxparam –cpuyield YES command to override this usage.

If you want to set the cluster nodes to “yield”, you must perform the following extra configurations on CCO:
- If a cluster is formed, all the nodes come up with “yield=DEFAULT”.
- If a cluster is formed using the nodes that are already set to “yield=YES”, then the nodes are added to cluster using the “DEFAULT” yield.
Note:

If you want to set the cluster nodes to “yield=YES”, you can configure only after forming the cluster but not before the cluster is formed.

-masterclockcpu1: You can move the main clock source from CPU0 (management CPU) to CPU1. This parameter has the following options:
- YES: Allow the VM to move the main clock source from CPU0 to CPU1.
- NO: VM uses CPU0 for the main clock source. By default, CPU0 is the main clock source.
show ns vpxparam

Display the current vpxparam settings.

Other References

For Citrix Ready products, visit Citrix Ready Marketplace.
For Citrix Ready product support, see the FAQ page.
For VMware ESX hardware versions, see Upgrading VMware Tools.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group 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 Cloud Software Group 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 Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Support matrix and usage guidelines

September 13, 2024

Contributed by:

September 13, 2024

Contributed by:

Support matrix and usage guidelines

VPX instance on Nutanix AHV

Usage guidelines

Commands to control the packet engine CPU usage

Other References

In this article