Product Documentation

Licensing Requirement

Jul 19, 2017

A license gives you access to a set of features on a NetScaler Secure Web Gateway (SWG) appliance.

The Citrix licensing framework allows you to focus on getting maximum value from Citrix products. The process of allocating your licenses is very simple. In the SWG configuration utility (GUI), you can use your hardware serial number (HSN) or your license activation code (LAC) to allocate your licenses. 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 (which you can also use for initial license allocation if you prefer). For more information about the licensing portal, see http://support.citrix.com/article/CTX131110.

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.

Before using your SWG appliance, you should install the following licenses by using either the GUI or the CLI:

  • NetScaler Secure Web Gateway platform license. This license is the minimum requirement for using your SWG appliance. 
  • URL Threat Intelligence feature license. This license is required for use of the URL filtering, URL categorization, and URL reputation score features.

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.

 

Licenses for Appliances in a High Availability Setup

You must purchase a separate license for each appliance in a high availability (HA) pair. Make sure that the same type of license is installed on both appliances.

Allocating and Installing your licenses

You can allocate and install your licenses by using the GUI. Installing your licenses by using the CLI requires copying the licenses to the /nsconfig/license/ directory. 

To allocate your licenses by using the NetScaler SWG GUI

In a web browser, type the IP address of the NetScaler SWG appliance.

In User Name and Password, type the administrator credentials.

On the Configuration tab, navigate to System > Licenses.

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 license activation code (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 Connect through Proxy Server and specify the IP address and port of your proxy server.

Click Get Licenses.

Select the license file that you want to use to allocate your licenses.

In the Allocate column, enter the number of licenses to be allocated. Then click Get.

Click Reboot for the license to take effect.

In the Reboot dialog box, click OK.

To install your licenses by using the NetScaler SWG GUI

In a web browser, type the IP address of the NetScaler SWG appliance (for example, http://192.168.100.1).

In User Name and Password, type the administrator credentials.

On the Configuration tab, navigate to System > Licenses.

In the details pane, click Manage Licenses.

Click Add New License, and then select Upload license files.

Click Browse. Navigate to the location of the license files, select the license file, and then click Open.

Click Reboot to apply the license.

In the Reboot dialog box, click OK.

To install your licenses by using the NetScaler SWG CLI

Open an SSH connection to the NetScaler SWG appliance by using an SSH client, such as PuTTY.

Log on to the appliance by using the administrator credentials.

Switch to the shell prompt and copy the new license file(s) to the license subdirectory of the nsconfig directory. If the subdirectory does not exist, create it before copying the file(s).

Example Copy

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 CLI does not prompt you to reboot the appliance to activate 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 NetScaler SWG GUI

  1. In a Web browser, type the IP address of the NetScaler SWG appliance (for example, http://192.168.100.1).
  2. In User Name and Password, type the administrator credentials.
  3. Navigate to System > Licenses.
    The screen has a green check mark next to each licensed feature.

To verify the licensed features by using the NetScaler SWG CLI

  1. Open an SSH connection to the NetScaler SWG appliance by using an SSH client, such as PuTTY.
  2. Log on to the appliance 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 Copy

> sh license

        License status:

                           Web Logging: NO

                      Surge Protection: NO

                        Load Balancing: YES

             …

            Forward Proxy: YES

                      SSL Interception: YES

                       Model Number ID: 25000

                        Licensing mode: Local

 Done

Enabling or Disabling a Feature

When you use the NetScaler Secure Web Gateway appliance for the first time, you have to enable a feature before you can use it. If you configure a feature before it is enabled, a warning message appears. The configuration is saved, but it does not apply until the feature is enabled.

To enable a feature by using the NetScaler SWG GUI

  1. In a Web browser, type the IP address of the NetScaler SWG appliance (for example, http://192.168.100.1).
  2. In User Name and Password, type the administrator credentials.
  3. Navigate to System > Settings > Configure Advanced Features.
  4. Select the features (for example, Forward Proxy, SSL Interception, and URL Filtering) that you want to enable.
 

To enable a feature by using the NetScaler SWG CLI

At the NetScaler command prompt, type the following commands to enable a feature and verify the configuration:

enable feature <FeatureName>

show feature

The following example shows how to enable the SSL interception, forward proxy, and URL filtering features. 

Example Copy

> enable feature forwardProxy sslinterception urlfiltering

 Done

 >show feature

    Feature                        Acronym              Status

        -------                        -------              ------

 1)     Web Logging                    WL                   OFF

 2)     Surge Protection               SP                   OFF

36)    URL Filtering                  URLFiltering         ON

37)    Video Optimization             VideoOptimization    OFF

38)    Forward Proxy                  ForwardProxy         ON

39)    SSL Interception               SSLInterception      ON

Done

Note

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

ERROR: feature(s) not licensed