Product Documentation
Application Delivery Management
14.1 - Current Release 13.1 13.0
View PDF

NetScaler ADM on Linux KVM server

March 11, 2024
Contributed by: 
R C

Virtualization platforms on which the NetScaler Application Delivery Management (ADM) can be provisioned include Linux-KVM.

Before you install NetScaler ADM on Linux-KVM, make sure that your system has the hardware virtualization extensions, and verify that the CPU virtualization extensions are available. Verify that virsh (a command-line tool for managing virtual machines) is available on the hypervisor.

Use your administrator credentials to log on to Citrix.com website, access the latest NetScaler ADM setup files, and download them onto your computer. Then, install the NetScaler ADM on your Linux-KVM platform and configure it for your network.

Prerequisites

Before installing the NetScaler ADM virtual appliance, verify that Linux-KVM version 3.6.11-4 and later is installed on hardware that meets the minimum requirements.

Hardware requirements

Component Requirement
CPU A 64-bit x86 processor with the hardware virtualization features that are included in the Intel VT-X processor. Provide at least 2 CPU cores to host Linux-KVM. Note To test whether your CPU supports Linux host, enter the following command at the host Linux shell prompt: *. egrep'^flags.\* ( vmx | svm ) '/proc/cpuinfo* If the BIOS settings for the extension are disabled, you must enable them in BIOS. There is no specific recommendation for processor speed, but higher the speed, the better is the performance of the NetScaler ADM.
Memory (RAM) Minimum 4 GB for the host Linux kernel. Add additional memory as required by the VMs.
Hard Disk Calculate the space for Host Linux kernel and VM requirements. A single NetScaler ADM VM requires 120 GB of disk space.

Note

The memory and hard disk requirements specified are for deploying NetScaler ADM on the OpenStack platform, considering that there are no other virtual machines running on the host. The hardware requirements for OpenStack depend on the number of virtual machines running on it.

Software requirements

Citrix recommends newer kernels, such as the 64-bit version of the 3.6.11-4 kernel or later.

Network requirements

NetScaler ADM supports only one virtIO para-virtualized network interface. Ensure to connect this interface to the management network of the Linux-KVM host, so that the NetScaler ADM and Linux-KVM can communicate.

Download NetScaler ADM setup files

To download the NetScaler ADM setup files from www.citrix.com:

  1. Open a web browser and type www.citrix.com in the address bar.

  2. Hover over the Sign In option and click My Account, enter your Citrix credentials, and then again click Sign In.

  3. Navigate to Downloads section.

  4. From the Downloads list, select NetScaler Application Delivery Management.

  5. On the NetScaler Application Delivery Management page, select the release. For example, select Release 13.0.

  6. Click Product Software to expand it, and click the latest build. For example, select NetScaler MAS Release (Feature Phase) 13.0 Build 36.27.

    The selected build page is displayed.

  7. On the Jump to Download list, select NetScaler MAS image for KVM, 13.0 Build xx.xx

  8. Click Download File, accept the EULA, and download the compressed image file to any folder on your local machine.  

Install the NetScaler Application Delivery Management on Linux-KVM

  1. Using SSH, log on to the KVM host.

  2. At the CLI prompt, by using any of the file transfer programs, copy the image to a folder on the server.

  3. Navigate to the directory where you have saved the downloaded image.

  4. Perform these at the command line:

    1. List the files in the directory verify the presence of the image file.

    2. Use the tar command to untar the NetScaler Application Delivery Management image file. The unzipped package contains the following components:

      1. A domain XML file that specifies the NetScaler ADM attributes

      2. A text file that specifies the check sum of the domain disk image

      3. A domain disk image

        tar -xvfz MAS-KVM.tgz
MAS-KVM.xml
MAS-KVM.qcow2
checksum.txt
<!--NeedCopy-->

        A domain disk image

      4. Create a copy of MAS-KVM.xml as MAS1-KVM.xml, as a back-up option. Open the MAS1-KVM.xml file by using the vi editor.

      5. Edit MAS1-KVM.xml for the following networking attributes:

        1. name - Specify the name.

        2. mac - Specify the MAC address.

        3. source file - Specify the absolute disk-image source path. The file path has to be absolute.

          Note

          The domain name and the MAC address must be unique.

        4. mode - Specify the mode.

        5. model type - Set to virtIO.

        6. source dev - Specify the interface.

          <name> MAS1-KVM</name>
<mac address='52:54:00:29:74:b3'/>
<source file='/var/ MAS-KVM.qcow2'/>
<source dev='eth0' mode='bridge'/>
<model type='virtio'/>
<!--NeedCopy-->

      6. Define the VM attributes in the MAS1-KVM.xml file by using the following command: virsh define \<FileName\>.xml

        virsh define MAS-KVM.xml
Domain MAS defined from MAS-KVM.xml
<!--NeedCopy-->

        Define VM attributes in KVM

      7. Start the NetScaler ADM by entering the following command: virsh start \[\<DomainName\> | \<DomainUUID\>\]

        virsh start MAS
Domain MAS started
<!--NeedCopy-->

        Start NetScaler ADM

      8. You can connect to the NetScaler ADM virtual machine by using the following command: virsh console \<DomainName\>

        virsh console MAS
Connected to domain MAS
Escape character is ^]
<!--NeedCopy-->

        Connected to NetScaler ADM

Configure the NetScaler Application Delivery Management

Note

On some Linux KVM hosts, FreeBSD guests fail to restart properly if they have more than one CPU. When The NetScaler ADM virtual appliance is restarted, the NetScaler ADM CLI and GUI become unresponsive. For details, see https://bugs.launchpad.net/qemu/+bug/1329956

To avoid the NetScaler ADM CLI and GUI from becoming unresponsive when the NetScaler ADM virtual appliance is restarted, shut down all the virtual machines on the KVM host, and perform the following on the KVM host:

  1. Remove the kvm_intel module using the following command: rmmod kvm\_intel

  2. Disable APICv and reload kvm_intel module using the following command: modprobe kvm\_intel enable\_apicv=N

  3. Start the virtual machines on the KVM host.

After installing the NetScaler ADM, allow about 10 minutes for the services to become available, and then log on to the NetScaler ADM.

  1. At the command line, use the default system administrator credentials to log on to the system:

    • User name: nsroot

    • Password: nsroot

    Note

    After logging on for the first time, change the administrative password. Then, configure the MAS to function in your network. You can change the password from the NetScaler ADM user interface. From the NetScaler ADM home page, navigate to Settings > User Administration > Users. Select the user and click Edit, and then update the password in the Password field.

  2. At the prompt, type: shell

  3. Type networkconfig to enter the NetScaler ADM initial network configuration menu. Configure the management IP address.

  4. To complete the initial network configuration of NetScaler ADM, follow the prompts. The console displays the NetScaler ADM initial network configuration options for setting the following parameters for the NetScaler ADM. The host name is populated by default.

    1. Enter 2 to update NetScaler ADM IPv4 address - management IP address at which you access a NetScaler ADM

    2. Enter 3 to update Netmask - subnet mask associated with the Management IP address

    3. Enter 4 to update Gateway IPv4 address - default gateway IP address for the subnet of the Management IP address of the NetScaler ADM

    4. Enter 7 to save and quit - saves your configuration changes and exits the system.

      Network configuration

  5. Run the deployment script by typing the command at the shell prompt: deployment_type.py

  6. In the deployment screen that appears, select the deployment type as NetScaler ADM server.

    Select NetScaler ADM as a deployment server

  7. Type Yes to deploy NetScaler ADM as a standalone deployment.

  8. Type Yes to restart the NetScaler ADM server.

  9. After NetScaler ADM server restarts, log on to NetScaler ADM by using the default administrator credentials as nsroot/nsroot through the command line or the GUI.

    You can later access the NetScaler ADM by typing the IP address of the NetScaler ADM server in the address bar of your browser. The default administrator credentials to log on to the server are nsroot/nsroot.

NetScaler ADM on Linux KVM server
March 11, 2024
Contributed by: 
R C
March 11, 2024
Contributed by: 
R C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.