Citrix ADC

Deploy a high availability pair on AWS

You can configure two Citrix ADC VPX instances on AWS as a high-availability (HA) pair, in the same AWS zone where both VPX instances are on the same subnet. HA is achieved by migrating secondary private IP addresses attached to the NICs (client and server-side NICs) of the primary HA node to the secondary HA node after failover. All the Elastic IP addresses associated with the secondary private IP addresses are also migrated.

The following illustration an HA failover scenario by using by migrating secondary private IP addresses.

Figure 1. A Citrix ADC VPX HA Pair on AWS, using private IP migration


Before you start your document, read the following docs:

How to deploy a VPX HA pair in the same zone

Here is the summary of the steps to deploy a VPX HA pair in the same zone:

  1. Create two VPX instances on AWS, each with three NICs
  2. Assign AWS secondary private IP address to VIP and SNIP of primary node
  3. Configure VIP and SNIP on primary node using AWS secondary private IP addresses
  4. Configure HA on both nodes

Step 1. Create two VPX instances (primary and secondary nodes) by using the same VPC, each with three NICs (Ethernet 0, Ethernet 1, Ethernet 2)

Follow the steps given in Deploy a Citrix ADC VPX instance on AWS by using the AWS web console.

Step 2. On the primary node, assign secondary private IP addresses for Ethernet 1 (client IP or VIP) and Ethernet 2 (back-end server IP or SNIP)

The AWS console automatically assigns primary private IP addresses to the configured NICs. Assign more private IP addresses to VIP and SNIP, known as secondary private IP addresses.

To assign a secondary private IPv4 address to a network interface, follow these steps:

  1. Open the Amazon EC2 console at
  2. In the navigation pane, choose Network Interfaces, and then select the network interface attached to the instance.
  3. Choose Actions, Manage IP Addresses.
  4. Under IPv4 Addresses, choose Assign new IP.
  5. Enter a specific IPv4 address that’s within the subnet range for the instance, or leave the field blank to let Amazon select an IP address for you.
  6. (Optional) Choose Allow reassignment to allow the secondary private IP address to be reassigned if it is already assigned to another network interface.
  7. Choose Yes, Update.

Under the instance description, the assigned secondary private IP addresses appear.

Step 3. Configure VIP and SNIP on the primary node, using secondary private IP addresses

Access the primary node using SSH. Open an ssh client and type:

ssh -i <location of your private key> nsroot@<public DNS of the instance>

Next, configure VIP and SNIP.

For VIP, type:

add ns ip <IPAddress> <netmask> -type <type>

For SNIP, type:

add ns ip <IPAddress> <netmask> -type SNIP

Type save config to save.

To see the configured IP addresses, type the following command:

show ns ip

For more information, see the following topics:

Step 4: Configure HA on both instances

On the primary node, open a Shell client and type the following command:

add ha node <id> <private IP address of the management NIC of the secondary node>

On the secondary node, type the following command:

add ha node <id> < private IP address of the management NIC of the primary node >

Type save config to save the configuration.

To see the configured HA nodes, type show ha node.

Upon failover, the secondary private IP addresses configured as VIP and SNIP on the previous primary node are migrated to the new primary node.

To force a failover on a node, type force HAfailover.

Legacy method for deploying a VPX HA pair

Before 13.0 41.x release, HA within the same zone was achieved through AWS elastic network interface (ENI) migration. However, this method is slowly deprecated.

The following figure shows an example of the HA deployment architecture for Citrix ADC VPX instances on AWS.

Figure 1. A Citrix ADC VPX HA Pair on AWS, using ENI migration

High availability using ENI migration

You can deploy two VPX instances on AWS as an HA pair by using one of the following options:

  • Create the instances with IAM Role manually by using the AWS Management Console and then configure HA on them.
  • Or automate the high availability deployment by using the Citrix CloudFormation template.

The CloudFormation template significantly decreases the number of steps involved for creating an HA pair, and it automatically creates an IAM Role. This section shows how to deploy a Citrix ADC VPX HA (active-passive) pair by using the Citrix CloudFormation template.

Keep the following points in mind while deploying two Citrix ADC VPX instances as an HA pair.

Points to note

  • HA on AWS requires the primary node to have at least two ENIs (one for management and the other for data traffic), and the secondary node to have one management ENI. However, for security purposes, create three ENIs on the primary node, because this setup allows you to segregate the private and public network (recommended).
  • The secondary node always has one ENI interface (for management) and the primary node can have up to four ENIs.
  • The NSIP addresses for each VPX instance in a high availability pair must be configured on the default ENI of the instance.
  • Amazon does not allow any broadcast/multicast packets in AWS. As a result, in a HA setup, data-plane ENIs are migrated from the primary to the secondary VPX instance when the primary VPX instance fails.
  • Because the default (management) ENI cannot be moved to another VPX instance, do not use the default ENI for client and server traffic (data-plane traffic).
  • The message AWSCONFIG IOCTL NSAPI_HOTPLUG_INTF success output 0 in the /var/log/ns.log indicates that the two data ENIs have successfully attached to the secondary instance (the new primary).
  • Failover might take up to 20 seconds due to the AWS detach/attach ENI mechanism.
  • Upon failover, the failed instance always restarts.
  • The heartbeat packets are received only on the management interface.
  • The configuration file of the primary and secondary VPX instances is synchronized, including the nsroot password. The nsroot password of the secondary node is set to that of the primary node after the HA configuration synchronization.
  • To have access to the AWS API servers, either the VPX instance must have a public IP address assigned or routing must be set up correctly at VPC subnet level pointing to the internet gateway of the VPC.
  • Nameservers/DNS servers are configured at VPC level using DHCP options.
  • The Citrix CloudFormation template does not create an HA setup between different availability zones.
  • The Citrix CloudFormation template does not create an INC mode.
  • The AWS debug messages are available in the log file, /var/log/ns.log, on the VPX instance.

Deploy a high availability pair by using the Citrix CloudFormation template

Before starting the CloudFormation template, ensure that you complete the following requirements:

  • A VPC
  • Three subnets within the VPC
  • A security group with UDP 3003, TCP 3009–3010, HTTP, SSH ports open
  • A key pair
  • Create an internet gateway
  • Edit route tables for client and management networks to point to the internet gateway


The Citrix CloudFormation template automatically creates an IAM Role. Existing IAM Roles do not appear in the template.

To launch the Citrix CloudFormation template:

  1. Log on to the AWS marketplace by using your AWS credentials.
  2. In the search field, type Citrix ADC VPX to search for the Citrix ADC AMI, and click Go.
  3. On the search result page, click the desired Citrix ADC VPX offering.
  4. Click the Pricing tab, to go to Pricing Information.
  5. Select the region and Fulfillment Option as Citrix ADC VPX – Customer Licensed.
  6. Click Continue to Subscribe.
  7. Check the details in the Subscribe page and click Continue to Configuration.
  8. Select Delivery Method as CloudFormation Template.
  9. Select the required CloudFormation template.
  10. Select Software Version and Region, and click Continue to Launch.

    AWS CloudFormation template

  11. Under Choose Action, select Launch CloudFormation, and click Launch.
  12. The Create stack page appears, and click Next.

    Create stack

  13. The Specify stack details page appears. Enter the following details.

    • Type a Stack name. The name must be within 25 characters.
    • Under Network Configuration, perform the following:
      • Select Management Subnetwork, Client Subnetwork, and Server Subnetwork. Ensure that you select the correct subnetworks you created within the VPC that you selected under VPC ID.
      • Add Primary Management IP, Secondary Management IP, Client IP, and Server IP. The IP addresses must belong to the same subnets of the respective subnetworks. Alternatively, you can let the template assign the IP addresses automatically.
      • Select default for VPCTenancy.
    • Under Citrix ADC Configuration, perform the following:
      • Select m5.xlarge for Instance type.
      • Select the key pair that you’ve already created from the menu for Key Pair.
      • By default, the Publish custom metrics to CloudWatch? option is set to Yes. If you want to disable this option, select No.

        For more information about CloudWatch metrics, see Monitor your instances using Amazon CloudWatch.

    • Under Optional Configuration, perform the following:
      • By default, the Should publicIP(EIP) be assigned to management interfaces? option is set to No.
      • By default, the Should publicIP(EIP) be assigned to client interface? option is set to No.

    Specify stack details

  14. Click Next.
  15. The Configure stack options page appears. This is an optional page.

    Configure stack options

  16. Click Next.

  17. The Options page appears. (This is an optional page.). Click Next.

  18. The Review page appears. Take a moment to review the settings and make any changes, if necessary.

  19. Select the I acknowledge that AWS CloudFormation might create IAM resources. check box, and then click Create stack.

  20. The CREATE-IN-PROGRESS status appears. Wait until the status is CREATE-COMPLETE. If the status does not change to COMPLETE, check the Events tab for the reason of failure, and recreate the instance with proper configurations.

    CloudFormation stack complete

  21. After an IAM resource is created, navigate to EC2 Management Console > Instances. You find two VPX instances created with IAM role. The primary and secondary nodes are created each with three private IP addresses and three network interfaces.
  22. Log on to the primary node with user name nsroot and the instance ID as the password. From the GUI, navigate to System > High Availability > Nodes. The Citrix ADC VPX is already configured in HA pair by the CloudFormation template.

  23. The Citrix ADC VPX HA pair appears.

    CloudFormation VPX HA pair configured

Monitor your instances using Amazon CloudWatch

You can use the Amazon CloudWatch service to monitor a set of Citrix ADC VPX metrics such as CPU and memory utilization, and throughput. CloudWatch monitors resources and applications that run on AWS, in real time. You can access the Amazon CloudWatch dashboard by using the AWS Management console. For more information, see Amazon CloudWatch.

Points to note

  • If you deploy a Citrix ADC VPX instance on AWS by using the AWS web console, the CloudWatch service is enabled by default.
  • If you deploy a Citrix ADC VPX instance by using the Citrix CloudFormation template, the default option is “Yes.” If you want to disable the CloudWatch service, select “No.”
  • Metrics are available for CPU (management and packet CPU usage), memory, and throughput (inbound and outbound).

How to view CloudWatch metrics

To view CloudWatch metrics for your instance, follow these steps:

  1. Log on to AWS Management console > EC2 > Instances.
  2. Select the instance.
  3. Click Monitoring.
  4. Click View all CloudWatch metrics.

    CloudWatch metrics

  5. Under All metrics, click your instance ID.

    CloudWatch metrics for your instance

  6. Click the metrics you want to view, set the duration (by minutes, hours, days, weeks, months).
  7. Click Graphed metrics to view the statistics of usage. Use the Graph options to customize your graph.

Figure. Graphed metrics for CPU usage

CloudWatch graphed metrics

Configuring SR-IOV on a high availability setup

Support for SR-IOV interfaces in a high availability setup is available from Citrix ADC release 12.0 57.19 onwards. For more information about how to configure SR-IOV, see Configuring Citrix ADC VPX instances to Use SR-IOV Network Interface.

How high availability on AWS works