Product Documentation

NetScaler VPX Check-In/Check-Out Licensing

Apr 21, 2017

You can allocate VPX licenses to NetScaler VPX instances on demand from NetScaler MAS. The Licenses are stored and managed by NetScaler MAS, which has a licensing framework that provides scalable and automated license provisioning. A NetScaler VPX instance can check out the license from the NetScaler MAS when a NetScaler VPX instance is provisioned, or check back in its license to NetScaler MAS when an instance is removed or destroyed.

This document includes the following information:

Prerequisites

Make sure that the following prerequisites are met:

  • You are using a NetScaler VPX image running software version 12.0.
    For example: NSVPX-ESX-12.0-xx.xx_nc.zip
  • You have installed NetScaler MAS running version 12.0.
    For example: MAS-ESX-12.0-xx.xx.zip 

Note

To manage existing VPX licenses by NetScaler MAS, you need to rehost the licenses to NetScaler MAS.

Installing Licenses in NetScaler MAS

Note: Before installing licenses, restart the NetScaler MAS virtual appliance if you have changed the software edition or bandwidth.

To install license files on the NetScaler Management and Analytics System:

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

2. In User Name and Password, enter the administrator credentials.

3. On the Configuration tab, navigate to Networks > Licenses, and click Add License File.

4. In the License Files section, select one of the following options:

  • Upload license files from a local computer - If a license file is already present on your local computer, you can upload it to the NetScaler MAS.
    To add license files, click Browse and select the license file (.lic) that you want add. Then click Finish.
  • Use License Access Code - Citrix emails the License Access Code (LAC) for the licenses that you purchase.
    To add license files, enter the LAC in the text box and then click Get Licenses.

Note: Make sure you are connected to internet before using LAC code for installing the licenses. 

localized image

At any time, you can add more licenses to the NetScaler MAS from the License Settings.

Verification

You can view the available and allocated licenses in the NetScaler MAS GUI.

To display the licenses

1. In a web browser, type the IP address of the NetScaler Management and Analytics System (for example, http://192.168.100.1).

2. In User Name and Password, enter the administrator credentials.

3. On the Configuration tab, navigate to Networks > Licenses > VPX Licenses.

localized image

4. You can view the allocated licenses in the table under the available licenses section.

Allocating VPX Licenses to a NetScaler VPX Instance by using the NetScaler GUI

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

2. In the User Name and Password fields, enter the administrator credentials.

3. On the Configuration tab, navigate to System > Licenses > Manage Licenses, click Add New License and select Use Remote Licensing.

4. Enter the details of the license server in the Server Name/IP Address field.

5. If you want to manage your instance’s VPX licenses through the NetScaler MAS), select the Register with NetScaler MAS check box and enter the NetScaler MAS credentials.

localized image

6. Select the license edition with the required bandwidth, click Get Licenses.

localized image

7. Click Reboot, your NetScaler VPX instance will reboot.

8. You can change or release the license allocation by navigating to System > Licenses > Manage Licenses, and selecting Change allocation or Release allocation.

localized image

9. If you click Change allocation, a pop-up window shows the licenses available on the license server. Select the required license, click Get Licenses.

localized image

Allocating VPX Licenses to a NetScaler VPX Instance by using the NetScaler CLI

1. In a SSH client, enter the IP address of the NetScaler instance, and log on by using administrator credentials.

2. To add a licensing server, enter the following command
add ns licenseserver (<licenseServerIP> | <serverName>) [-port <port number >]

localized image

3. To show the available licenses on the licensing server, enter the following command
sh licenseserverpool

localized image

4. To assign a license to the NetScaler VPX appliance, enter the following command
set capacity –platform V[S/E/P][Bandwidth]

localized image

Allocating VPX Licenses to a NetScaler VPX Instance by using API

In a web browser or an API client, log on to the NetScaler VPX instance by using the administrator credentials.

To add a licensing server

1. Set the request type to Post.

2. Set the path to /nitro/v1/config/nslicensingserver.

3. Set the payload as follows:
content-type: application/x-www-form-urlencoded\r\n
\r\n
object= {“params”;{warning”:”yes”},”nslicensing server”;{servername”:”<NetScaler MAS IP>”, “port”:”27000”}}\r\n

localized image

NetScaler MAS responds to the request. The following sample response shows success.

localized image

To view the available licenses on the licensing server

1. Set the request type to Get.

2. Set the path to /nitro/v1/config/nslicenseserverpool

localized image

NetScaler MAS responds to the request. The following sample response shows success, and the list of available licenses on the license server.

localized image

To assign a license to the NetScaler VPX appliance

1. Set the request type to Post.

2. Set the path to /nitro/v1/config/nscapacity.

3. Set the payload as follows:
content-type: application/x-www-form-urlencoded\r\n
\r\n
{“nscapacity:{“platform”:”VE8000”}}\r\n

localized image

NetScaler MAS responds to the request. The following sample response shows success.

localized image