Product Documentation

NetScaler MAS with VMware ESXi

May 24, 2018

To install NetScaler MAS virtual appliances on VMware ESXi, use VMware vSphere client.


Before you begin installing a virtual appliance, verify that the following requirements:

  • Install VMware ESXi version 4.1 or later hardware that meets the minimum requirements.
  • Install VMware Client on a management workstation that meets the minimum system requirements.
  • Install VMware OVF Tool (required for VMware ESXi version 4.1) on a management workstation that meets the minimum system requirements.
  • Download the NetScaler MAS set up files.


VMotion is not support on NetScaler MAS.

VMware ESXi Hardware Requirements

The following table lists the virtual computing resources that you need on your VMware ESXi server to install a NetScaler MAS virtual appliance.

Component Requirement


32 GB

Note: The default value is 8 GB. Citrix recommends that you increase the default value to 32 GB for better performance.

Virtual CPU

8 CPUs

Note: The default is 2 CPUs. Citrix recommends that you increase the default value to 8 CPUs for better performance.

Storage space

Citrix recommends using solid-state drive (SSD) technology for NetScaler MAS deployments.

The default value is 120 GB. Actual storage requirement will depend on NetScaler MAS sizing estimation.

If your NetScaler MAS storage requirement exceeds 120 GB, you to have to attach an additional disk. Note that you can add only one additional disk.

Citrix recommends you to estimate storage and attach additional disk at the time of initial deployment.

For more information, see How to Attach an Additional Disk to NetScaler MAS.

Virtual Network Interfaces



1 Gbps or 100 Mbps

To install NetScaler MAS

  1. Start the VMware vSphere client on your workstation.
  2. In the IP address / Name text box, type the IP address of the VMware ESXi server that you want to connect to.
  3. In the User Name and Password text boxes, type the administrator credentials, and then click Login.
  4. On the File menu, click Deploy OVF Template.
  5. In the Deploy OVF Template dialog box, in Deploy from a file or URL, browse to the location where you saved the NetScaler MAS setup files, select the .ovf file, and click Next.


If a warning message appears with the following text: The operating system identifier is not supported on the selected host, check to see if the VMware server supports FreeBSD operating system. Click Yes.

     6. On the OVF Template Details page, click Next.
     7. Type a name for the NetScaler MAS virtual appliance, and then click Next.
     8. Specify the Disk Format by selecting either Thin provisioned format or Thick provisioned format.


Citrix recommends that you select Thick provisioned format.

     9. Click Finish to start the installation process.

localized image

     10. You are now ready to start the NetScaler MAS virtual appliance. 
     11. In the navigation pane, select the virtual appliance that you just installed and, from the Inventory menu, select Virtual Machine, and then select Upgrade Virtual Hardware. In the Confirm Virtual Machine dialog box, click Yes.

localized image

     12. In the Inventory menu, select Virtual Machine, and then select Edit Settings.
     13. In the Virtual Machine Properties dialog box, on the Hardware tab, click Memory, and then in the right pane specify the Memory Size as 8 GB. 
     14. Click CPUs, and then in the right pane, specify the CPUs as 4. Click OK.
     15. Add an additional disk as per your requirement.

localized image

     16. In the navigation pane, select the virtual appliance that you just installed and, from the Inventory menu, select Virtual Machine, select Power, and then select Power On.
     17. Select the Console tab to display the NetScaler MAS Initial Network Configuration options for specifying the host name, IPv4 address, subnet mask (Netmask), and Gateway IP address for the NetScaler MAS virtual appliance.

localized image
18. After specifying the required IP addresses,  save the configuration settings.
19.  When prompted, logon using nsrecover/nsroot credentials.
localized image

20. Execute the deployment script by typing the command at the shell prompt:


localized image
21. Select the deployment type as NetScaler MAS Server. If you do not select any option, by default, it is deployed as a server.
localized image


Currently, you cannot deploy connector nodes, database nodes, and/or NetScaler MAS agents because NetScaler MAS does not support Scale-Out deployment.

     22. Type Yes to deploy NetScaler MAS as a standalone deployment.

     23. Type Yes to restart the NetScaler MAS server.


After you install NetScaler MAS, you can update the initial configuration settings at a later time.

To update the initial configuration in the NetScaler MAS, type networkconfig in the NetScaler MAS console. The console displays the NetScaler MAS initial network configuration options. You can then update the following parameters on the console:

  • Host name of NetScaler MAS
  • NetScaler MAS IPv4 address 
  • Netmask 
  • Gateway IPv4 address 
  • DNS IPv4 address 


After the server is installed, you can access the graphical user interface (GUI) by typing the IP address of the NetScaler MAS server in the address bar of your browser. The default administrator credentials to log on to the server are nsroot/nsroot.

The browser displays the NetScaler MAS configuration utility.