Product Documentation

NetScaler Licensing Overview

Dec 20, 2017

The process of allocating your NetScaler licenses has been greatly simplified. The new licensing framework allows you to focus on getting maximum value from Citrix products.

In the NetScaler configuration utility (GUI), you can use your hardware serial number (HSN) or your license activation code (LAC) to allocate your licenses. Alternatively, if a license is already present on your local computer, you can upload it to the appliance.

For all other functionality, such as returning or reallocating your license, you must use the licensing portal. Optionally, you can still use the licensing portal for license allocation. For more information about the licensing portal, see "http://support.citrix.com/article/CTX131110".

Note: You must purchase separate licenses for each appliance in a high availability (HA) pair. Make sure that the same type of licenses are installed on both the appliances. For example, if you purchase a platinum license for one appliance, you must purchase another platinum license for the other appliance.

Prerequisites

To use the hardware serial number or license activation code to allocate your licenses:
  • You must be able to access public domains through the appliance. For example, the appliance should be able to access www.citrix.com. The license allocation software internally accesses the Citrix licensing portal for your license. To access a public domain, you can either use a proxy server or set up a DNS server and, on your NetScaler appliance, configure a NetScaler IP (NSIP) address or a subnet IP (SNIP) address.
  • Your license must be linked to your hardware, or you must have a valid license activation code (LAC). Citrix sends your LAC by email when you purchase a license.

Allocating your License by using the Configuration Utility

If your license is already linked to your hardware, the license allocation process can use the hardware serial number. Otherwise, you must type the license activation code (LAC).

You can partially allocate licenses as required for your deployment. For example, if your license file contains ten licenses, but your current requirement is for only six licenses, you can allocate six licenses now, and allocate additional licenses later. You cannot allocate more than the total number of licenses present in your license file.

To allocate your license

  1. In a web browser, type the IP address of the NetScaler appliance (for example, http://192.168.100.1).
  2. In User Name and Password, type the administrator credentials.
  3. On the Configuration tab, navigate to System > Licenses.
  4. In the details pane, click Manage Licenses, click Add New License, and then select one of the following options:
    • Use Serial Number. The software internally fetches the serial number of your appliance and uses this number to display your license(s).
    • Use License Activation Code. Citrix emails the LAC for the license that you purchased. Enter the LAC in the text box.

      If you do not want to configure internet connectivity on the NetScaler appliance, you can use a proxy server. Select the Connect through Proxy Server check box and specify the IP address and port of your proxy server.

  5. Click Get Licenses. Depending on the option that you selected, one of the following dialog boxes appears.
    • The following dialog box appears if you selected Hardware Serial Number.

    • The following dialog box appears if you selected License Activation Code.

  6. Select the license file that you want to use to allocate your licenses.
  7. In the Allocate column, enter the number of licenses to be allocated. Then click Get.
    • If you selected Hardware Serial Number, enter the number of licenses, as shown in the following screen shot.
    • If you selected License Activation Code, enter the number of licenses, as shown in the following screen shot.

  8. Click Reboot for the license to take effect.
  9. In the Reboot dialog box, click OK to proceed with the changes, or click Close to cancel the changes.

Installing the License

If you downloaded your license file to your local computer by accessing the licensing portal, you must upload the license to the appliance.

To install a license file by using the configuration utility

  1. In a web browser, type the IP address of the NetScaler (for example, http://192.168.100.1).
  2. In User Name and Password, type the administrator credentials.
  3. On the Configuration tab, navigate to System > Licenses .
  4. In the details pane, click Manage Licenses.
  5. Click Add New License, then select Upload license files from a local computer.
  6. Click Browse. Navigate to the location of the license files, select the license file, and then click Open.
  7. Click Reboot to apply the license.
  8. In the Reboot dialog box, click OK to proceed with the changes, or click Close to cancel the changes.

To install the licenses by using the command line interface

  1. Open an SSH connection to the NetScaler by using an SSH client, such as PuTTY.
  2. Log on to the NetScaler by using the administrator credentials.
  3. Switch to the shell prompt, create a license subdirectory in the nsconfig directory, if it does not exist, and copy the new license file(s) to this directory.

    Example

    login: nsroot 
    Password: nsroot 
    Last login: Mon Aug  4 03:37:27 2008 from 10.102.29.9 
    Done 
    > shell 
    Last login: Mon Aug  4 03:51:42 from 10.103.25.64 
    root@ns# mkdir /nsconfig/license 
    root@ns# cd /nsconfig/license 
    
    Copy the new license file(s) to this directory.
    Note: The NetScaler appliance does not prompt for a reboot option when you use the command line interface to install the licenses. Run the reboot -w command to warm reboot the system, or run the reboot command to reboot the system normally.

Verifying the Licensed Features

Before using a feature, make sure that your license supports the feature.

To verify the licensed features by using the command line interface

  1. Open an SSH connection to the NetScaler by using an SSH client, such as PuTTY.
  2. Log on to the NetScaler by using the administrator credentials.
  3. At the command prompt, enter the sh ns license command to display the features supported by the license.

    Example

    sh ns license 
            License status: 
                               Web Logging: YES 
                          Surge Protection: YES 
                            ....... 
     
                            HTML Injection: YES 
     Done 
    

To verify the licensed features by using the configuration utility

  1. In a Web browser, type the IP address of the NetScaler, such as http://192.168.100.1.
  2. In User Name and Password, type the administrator credentials.
  3. Provide the User name and Password and click Login.
  4. In the navigation pane, expand System, and then click Licenses. You will see a green check mark next to the licensed features.

Enabling or Disabling a Feature

When you use the NetScaler appliance for the first time, you need to enable a feature before you can use its functionality. If you configure a feature before it is enabled, a warning message appears. The configuration is saved but it will apply only after the feature is enabled.

To enable a feature by using the command line interface

At the NetScaler command prompt, type the following commands to enable a feature and verify the configuration:
  • enable feature <FeatureName>
  • show feature

    Example

    enable feature lb cs 
    done 
     >show feature 
     
            Feature                        Acronym              Status 
            -------                        -------              ------ 
     1)     Web Logging                    WL                   OFF 
     2)     Surge Protection               SP                   ON 
     3)     Load Balancing                 LB                   ON 
     4)     Content Switching              CS                   ON 
     5)     Cache Redirection              CR                   ON 
     . 
     . 
     . 
     24)    NetScaler Push                 push                 OFF 
     Done
    
    The example shows how to enable load balancing (lb) and content switching (cs).

    If the license key is not available for a particular feature, the following error message appears for that feature:

    ERROR: feature(s) not licensed
    Note: To enable an optional feature, you need a feature-specific license. For example, if you have purchased and installed the Citrix NetScaler Enterprise Edition license and need to enable the Integrated Caching feature, you first need to purchase and install the AppCache license.

To disable a feature by using the command line interface

At the NetScaler command prompt, type the following commands to disable a feature and verify the configuration:
  • disable feature <FeatureName>
  • show feature

    Example

    The following example shows how to disable load balancing (LB).

    > disable feature lb 
     Done 
    > show feature 
     
            Feature                        Acronym              Status 
            -------                        -------              ------ 
     1)     Web Logging                    WL                   OFF 
     2)     Surge Protection               SP                   ON 
     3)     Load Balancing                 LB                   OFF 
     4)     Content Switching              CS                   ON 
     . 
     . 
     . 
     24)    NetScaler Push                 push                 OFF 
     Done 
    >
    

NetScaler VPX Express License

NetScaler VPX Express license is a license offering for NetScaler VPX on-prem and cloud deployments. If the VPX instance does not have any license, it comes up with the VPX Express license by default.

The VPX Express license includes:

  • 20 Mbps bandwidth
  • All NetScaler standard license features, except NetScaler Gateway
  • Maximum 250 SSL sessions
  • 20 Mbps SSL throughput

You can upgrade the VPX Express License to the following two options:

1. A standalone NetScaler VPX license

2. NetScaler Pooled Capacity license for VPX instances. For more information, see NetScaler Pooled Capacity.