Product Documentation

Installing Citrix NetScaler Virtual Appliances on Microsoft Hyper-V Servers

May 25, 2017
To install Citrix NetScaler virtual appliances on Microsoft Windows Server, you must first install Windows Server, with the Hyper-V role enabled, on a machine with adequate system resources. While installing the Hyper-V role, be sure to specify the network interface cards (NICs) on the server that Hyper-V will use to create the virtual networks. You can reserve some NICs for the host. Use Hyper-V Manager to perform the NetScaler virtual appliance installation.

NetScaler virtual appliance for Hyper-V is delivered in virtual hard disk (VHD) format. It includes the default configuration for elements such as CPU, network interfaces, and hard-disk size and format. After you install NetScaler virtual appliance, you can configure the network adapters on virtual appliance, add virtual NICs, and then assign the NetScaler IP address, subnet mask, and gateway, and complete the basic configuration of the virtual appliance.

After the initial configuration of the NetScaler appliance, if you want to upgrade the appliance to the latest software release, see "Upgrading or Downgrading the System Software."


Intermediate System-to-Intermediate System (ISIS) protocol is not supported on the NetScaler VPX virtual appliance hosted on the HyperV-2012 platform.

Prerequisites for Installing NetScaler Virtual Appliance on Microsoft Servers

Before you begin installing a virtual appliance, do the following:

Microsoft Server Hardware Requirements

The following table describes the minimum system requirements for Microsoft Servers .

Table 1. Minimum System Requirements for Microsoft Servers




1.4 GHz 64-bit processor


3 GB

Disk Space

32 GB or greater

The following table lists the virtual computing resources for each NetScaler virtual appliance.

Table 2. Minimum Virtual Computing Resources Required for Running NetScaler Virtual Appliance




2 GB

Virtual CPU


Disk Space

20 GB

Virtual Network Interfaces


Downloading the NetScaler Virtual Appliance Setup Files

NetScaler virtual appliance for Hyper-V is delivered in virtual hard disk (VHD) format. You can download the files from You will need a My Citrix account to log on. If you do not have a My Citrix account, access the home page at, click the New Users link, and follow the instructions to create a new My Citrix account.

To download the NetScaler virtual appliance setup files

  1. In a Web browser, go to and click My Citrix.

  2. Type your user name and password.

  3. Click Downloads.
  4. In Search Downloads by Product, select NetScaler.
  5. Under Virtual Appliances, click NetScaler VPX.
  6. Copy the compressed file to your server.

Installing NetScaler Virtual Appliance on Microsoft Servers

After you have enabled the Hyper-V role on Microsoft Server and extracted the virtual appliance files, you can use Hyper-V Manager to install NetScaler virtual appliance. After you import the virtual machine, you need to configure the virtual NICs by associating them to the virtual networks created by Hyper-V.

You can configure a maximum of eight virtual NICs. Even if the physical NIC is DOWN, the virtual appliance assumes that the virtual NIC is UP, because it can still communicate with the other virtual appliances on the same host (server).


You cannot change any settings while the virtual appliance is running. Shut down the virtual appliance and then make changes.

To install NetScaler Virtual Appliance on Microsoft Server by using Hyper-V Manager:

  1. To start Hyper-V Manager, click Start, point to Administrative Tools, and then click Hyper-V Manager.
  2. In the navigation pane, under Hyper-V Manager, select the server on which you want to install NetScaler virtual appliance.
  3. On the Action menu, click Import Virtual Machine.
  4. In the Import Virtual Machine dialog box, in Location, specify the path of the folder that contains the NetScaler virtual appliance software files, and then select Copy the virtual machine (create a new unique ID). This folder is the parent folder that contains the Snapshots, Virtual Hard Disks, and Virtual Machines folders.
  5. Note: If you received a compressed file, make sure that you extract the files into a folder before you specify the path to the folder.
  6. Click Import.
  7. Verify that the virtual appliance that you imported is listed under Virtual Machines.
  8. To install another virtual appliance, repeat steps 2 through 6.


Make sure that you extract the files to a different folder in step 4.

Auto-provisioning NetScaler Virtual Appliance on Hyper-V

Auto-provisioning of NetScaler virtual appliance is optional. If auto-provisioning is not done, the virtual appliance provides an option to configure the IP address and so on.

To auto-provision NetScaler Virtual Appliance on Hyper-V:

1. Create an ISO9660 compliant ISO image using the xml file as depicted in the example. Make sure that the name of the xml file is userdata.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<Environment xmlns:oe=""











<Property oe:key="com.citrix.netscaler.ovf.version" oe:value="1.0"/>

<Property oe:key="com.citrix.netscaler.platform" oe:value="NS1000V"/>

<Property oe:key="com.citrix.netscaler.orch_env" oe:value="cisco-orch-env"/>

<Property oe:key="com.citrix.netscaler.mgmt.ip" oe:value=""/>

<Property oe:key="com.citrix.netscaler.mgmt.netmask" oe:value=""/>

<Property oe:key="com.citrix.netscaler.mgmt.gateway" oe:value=""/></PropertySection>


2. Copy the ISO image to hyper-v server.

3. Select the virtual appliance that you imported, and then on the Action menu, select Settings. You can also select the virtual appliance and then right click and select Settings. The Settings window for the selected virtual appliance is displayed.

4. In the Settings window, under the hardware section, click on IDE Controller.

5. In the right window pane, select DVD Drive and click on Add. The DVD Drive is added under the IDE Controller section in the left window pane.

6. Select the DVD Drive added in step 5. In the right window pane, select the Image file radio button and click on Browse and select the ISO image that you copied on Hyper-V server,
in step 2.

7. Click Apply.


The virtual appliance instance comes up in the default IP address, when:

  • The DVD drive is attached and the ISO file is not provided.
  • The ISO file does not inculde the userdata file 
  • The userdata file name or format is not correct

To configure virtual NICs on the NetScaler Virtual Appliance:

  1. Select the virtual appliance that you imported, and then on the Action menu, select Settings.
  2. In the Settings for <virtual appliance name> dialog box, click Add Hardware in the left pane.
  3. In the right pane, from the list of devices, select Network Adapter.
  4. Click Add.
  5. Verify that Network Adapter (not connected) appears in the left pane.
  6. Select the network adapter in the left pane.
  7. In the right pane, from the Network drop-down list, select the virtual network to connect the adapter to.
  8. To select the virtual network for additional network adapters that you want to use, repeat steps and 7.
  9. Click Apply, and then click OK.

To configure NetScaler Virtual Appliance:

  1. Right-click the virtual appliance that you previously installed, and then select Start.
  2. Access the console by double-clicking the virtual appliance.
  3. Type the NetScaler IP address, subnet mask, and gateway for your virtual appliance.

You have completed the basic configuration of your virtual appliance. Type the IP address in a Web browser to access the virtual appliance.


You can also use virtual machine (VM) template to provision NetScaler virtual appliance using SCVMM.