Summary

NetScaler VPX is a virtual NetScaler appliance that is hosted on a Citrix XenServer™ system. It supports all the features of a physical NetScaler, except interface related events and tagged VLAN. Before a NetScaler VPX can be deployed to support any of its application optimization features, application security features, or application switching features, it must be properly licensed. License delivery for the NetScaler VPX products will be fulfilled through the Activation System/Manage Licenses tool on MyCitrix.com. This article contains instructions on how to license Citrix NetScaler VPX virtual appliances.

Contents

Summary 2

Who should read this 2

Prerequisites 2

Licensing Overview 2

License Delivery 3

Generating Licenses 3

Retail Licenses 3

Partner / Not-For-Resale Licenses 12

Evaluation Licenses 23

VPX Express Licenses 36

Obtaining the Host ID 40

Sample Licenses 41

Installing Licenses 41

More Information 44

Who should read this

This article is for Citrix customers or partners who purchase any of the Citrix NetScaler VPX 10, VPX 200 and VPX 1000 virtual appliances.

Prerequisites

This article assumes a basic understanding of the Citrix NetScaler configuration utility (GUI) and familiarity with Citrix licensing and the Activation System/Manage Licenses tool on MyCitrix.com. If you are not familiar with Citrix licensing, refer to http://support.citrix.com/proddocs/topic/licensing/lic-library-node-wrapper.html for more information.

[Return to Top]

Licensing Overview

Family Edition Licenses

A NetScaler family edition license provides instructions to the operating system at start up about the available features which can be enabled on the virtual appliance. A NetScaler family edition license is mandatory for proper operation of the virtual appliance. The NetScaler VPX product line has three family editions available supporting the same feature set as the NetScaler appliances:

• Standard Edition

• Enterprise Edition

• and Platinum Edition.

Note: Evaluation and Not For Resale (NFR) licenses are restricted to Platinum Edition only.

For a list of features associated with NetScaler family edition licenses, read the Citrix NetScaler VPX Data Sheet located on the Reference Desk on MyCitrix.com. Family edition licenses are not coupled to the software release running on the virtual appliance, meaning customers are free to upgrade or downgrade the operating system version on the NetScaler VPX without modifying their family edition license.

[Return to Top]

Upgrade Licenses

Customers are able to upgrade their virtual appliance from one family edition to another and from one performance range to another by purchasing an upgrade license.

There are two types of upgrades for this product.

• Edition Upgrades- Standard to Enterprise, Standard to Platinum and Enterprise to Platinum.  Edition upgrades must be within the same bandwidth.

• Performance (Bandwidth) Upgrades- 10Mbps to 200 Mbps, 10Mbps to 1000Mbps and 200Mbps to 1000Mbps.  Performance upgrades can only be performed on the same Edition (Standard, Enterprise, or Platinum).

• Example:  In order to upgrade aNetScaler VPX 10 Mbps Standard Edition license can be upgraded to the NetScaler VPX 200 Mbps Platinum Edition, the upgrade must be done in two steps.

o Citrix NetScaler VPX Upgrade from 10 Mbps Standard Edition to 200 Mbps Standard Edition

o Citrix NetScaler VPX Upgrade from 200 Mbps Standard Edition to 200 Mbps Platinum Edition

[Return to Top]

License Delivery

Delivery of NetScaler VPX feature and upgrade licenses is done through the Activation System/Manage Licenses tool on MyCitrix.com. The NetScaler VPX virtual appliance will start and run the pre-installed operating system version, but the features of the virtual appliance cannot be enabled until a family edition license is installed. The NetScaler VPX family edition license and any additional upgrade licenses (purchased separately) are retrieved through the Activation System/Manage Licenses tool on MyCitrix.com. For each NetScaler VPX virtual appliance purchased, a license authorization code is electronically delivered to the customer’s MyCitrix Account. Customers must use the Activation System/Manage Licenses tool on MyCitrix.com to convert the license entitlement(s) to license file(s) required to run on the Citrix NetScaler VPX virtual appliance(s). Once the license file(s) have been downloaded from MyCitrix.com, the file(s) should be copied to the respective virtual appliance(s). Then the virtual appliance must be restarted for the applied license to activate the NetScaler VPX feature-set.

This article provides step-by-step instructions to generate, download, and install NetScaler VPX platform, upgrade, and option licenses using the Activation System/Manage Licenses tool on MyCitrix.com. If you encounter problems with your license allocation, contact Citrix Customer Service. To locate a Customer Service or Technical Support center near you, visit http://www.citrix.com/English/SS/supportThird.asp?slID=11553&tlID=11610 .

[Return to Top]

Generating Licenses

License delivery for the NetScaler VPX 10, VPX 200 and VPX 1000 products will be fulfilled through MyCitrix.com in the Activation System/Manage Licenses tool on MyCitrix.com.

Have the following information available prior to accessing the MyCitrix.com site:

• Your user ID and password for MyCitrix. You can register for this password on MyCitrix.com.

• The host ID of the NetScaler appliance on which you install the license. Instructions for locating the host ID are found in the section Obtaining the Host ID.

Note: If you cannot locate either of these items, contact Citrix Customer Service.

Use the Activation System/Manage Licenses tool to convert your license entitlements to license files that you install on the Citrix NetScaler VPX virtual appliance. Once you navigate to MyCitrix.com and log on to your account, you will allocate your licenses using the license code(s) under your organization’s account, generate the license file, manually download the file, and copy it to the /nsconfig/license directory on the NetScaler VPX virtual appliance.

For further instructions on using Activation System/Manage Licenses tool on MyCitrix.com, refer to http://support.citrix.com/proddocs/index.jsp?topic=/licensing/lic-obtaining-your-license-files.html .

[Return to Top]

Retail Licenses

1. Under My Tools, select Choose a Toolbox > Activation System/Manage Licenses.

2. From the Current Tool drop-down list, select View Licenses to locate the license code for your NetScaler VPX virtual appliance(s).

3. A list of product licenses will be shown. Locate the Citrix NetScaler VPX license which you ordered, and click Click to Allocate to insert the license code into the allocation screen. NetScaler VPX licenses are offered in varying performance levels (10 Mbps, 200 Mbps and 1000Mbps) and family editions (Standard, Enterprise and Platinum).

4. The License Code is populated in the Your License Code field on the Activation System/Manage Licenses page. Click Continue.

5. The Citrix Activation System screen appears. The host name or Host ID reference will be required in order to activate a NetScaler VPX license. Click Continue.

6. The hostname or Host ID required is based on the MAC address of the NetScaler VPX virtual machine. The host ID of the NetScaler appliance on which you install the license. Instructions for locating the host ID are found in the section Obtaining the Host ID

7. From the Select Licenses to Allocate screen, highlight the appropriate NetScaler VPX license from the list and click Filter Products button. Note: Steps 1 and 2 on the screen do not apply to the NetScaler VPX license allocation.

8. The next screen will display the specific license code. Enter 1 as the quantity of licenses to allocate. Note: Allocate only 1 license at a time. Each license is tied to a specific MAC address of the NetScaler virtual appliance, and therefore licenses should be allocated individually.
In the Hostname of your Citrix license server field, enter the MAC address of the virtual machine as a string of digits with the separating colons removed. Click the Allocate button.

9. To confirm your selection, click Confirm.

10. The Download License File screen will appear listing the MAC address of the VPX virtual appliance, the license file type, and license code. Click the Download License File button and save the file to a directory on your workstation. Remember the location to which you downloaded the file, you will need this location when copying the license file to the NetScaler VPX virtual machine.

11. Save the file to a safe location on your workstation or network. Remember the location to which you downloaded the file, you will need this location when copying the license file to the NetScaler VPX virtual machine.

12. You are returned to the Download License File page where a check mark and the words Download Complete appear. Click the Citrix NetScaler, click here to learn how to install your license file link to read more about installing the license file on the NetScaler VPX virtual appliance. For complete license installation instructions, see Chapter 2 of the Citrix NetScaler Migration Guide - Release 9.1 - CTX1121822 - Citrix NetScaler Migration Guide - Release 9.1..

13. Repeat Steps 1 – 13 for each NetScaler VPX virtual appliance which you’ve purchased.

[Return to Top]

Partner / Not-For-Resale Licenses

Not-for-Resale licenses are for internal use by partners and resellers to demonstrate Citrix Products in a non-production environment. Not-for-Resale licenses cannot to be transferred to any other organization, either temporarily or permanently. Partners can retrieve their Not for Resale (NFR) licenses using the Partner Use Licenses toolbox on MyCitrix.com.

You need the following information available prior to accessing the MyCitrix site:

• Your user ID and password for MyCitrix. You can register for this password on MyCitrix.com.

• The host ID of the NetScaler appliance on which you install the license. Instructions for locating the host ID are found in the section Obtaining the Host ID.Note: If you cannot locate either of these items, contact Citrix Customer Service.

1. Under My Tools, select Choose a Toolbox > Partner Use Licenses.

2. From the Current Tool drop-down list, select Not-for-Resale. Then click Get Software.

3. From the Partner Use Licenses page, use the drop down menus to select the NetScaler VPX license from the Product and Language drop-down menu. Then click Retrieve New Serial Numbers.

4. Select the NetScaler VPX license from the Product drop-down menu and corresponding Language. Click Retrieve New Serial Numbers to view the available license codes.

5. The NFR Assigned Licenses page will list the available licenses. A list of license codes appears in the column labeled Serial Number. Choose one of the codes to use for license allocation. Not For Resale licenses are 1000 Mbps Platinum Edition.

6. Copy the serial number of one of the licenses and then return to the Activation System/Manage Licenses toolbox.

7. From the Current Tool drop-down list, select Activate/Allocate.

8. A Reseller Warning will appear to explain that license activation will be tied to your organization. Click I Agree.

9. Next, input your license code from Step 5 into the field Your License Code and click Continue.

10. The Citrix Activation System screen appears. The host name or Host ID reference will be required in order to activate a NetScaler VPX license. Click Continue.

11. The hostname or Host ID required is based on the MAC address of the NetScaler VPX virtual machine. The host ID of the NetScaler appliance on which you install the license. Instructions for locating the host ID are found in the section Obtaining the Host ID

12. From the Select Licenses to Allocate screen, highlight the appropriate NetScaler VPX license from the list and click Filter Products button. In the Hostname of your Citrix license server field, enter the MAC address of the virtual machine as a string of digits with the separating colons removed. Click the Allocate button. Note: Steps 1 and 2 on the screen do not apply to the NetScaler VPX license allocation.

13. To confirm your selection, click Confirm.

14. The Download License File screen will appear listing the MAC address of the VPX virtual appliance, the license file type, and license code. Click the Download License File button and save the file to a directory on your workstation. Remember the location to which you downloaded the file, you will need this location when copying the license file to the NetScaler VPX virtual machine.

15. Save the file to a safe location on your workstation or network. Remember the location to which you downloaded the file, you will need this location when copying the license file to the NetScaler VPX virtual machine.

16. You are returned to the Download License File page where a check mark and the words Download Complete appear. Click the Citrix NetScaler, click here to learn how to install your license file link to read more about installing the license file on the NetScaler VPX virtual appliance. For complete license installation instructions, see Chapter 2 of the Citrix NetScaler Migration Guide - Release 9.1 - CTX1121822 - Citrix NetScaler Migration Guide - Release 9.1..

17. Repeat Steps 5 – 16 for each NetScaler VPX virtual appliance which you’ve purchased as a lab system for resellers.

[Return to Top]

Evaluation Licenses

Evaluation licenses are for limited term use by customers and sales engineers to demonstrate Citrix Products in a proof of concept or pre-sales environment. Evaluation licenses are specific to the virtual appliance on which they are installed and cannot to be transferred to any other virtual appliance or organization. Evaluation licenses are downloaded from the Downloads pages on MyCitrix.com. The evaluation license allocation process requires the host name or host ID of the NetScaler VPX virtual appliance.

Before going to the Citrix Web site, you need the following items at hand:

• Your user ID and password for MyCitrix. You can register for this password on MyCitrix.com.

• The host ID of the NetScaler appliance on which you install the license. Instructions for locating the host ID are found in the section Obtaining the Host ID.Note: If you cannot locate either of these items, contact Citrix Customer Service
.

1. From the MyCitrix.com home page, click the Downloads link at the top of the page.

2. From the Search Downloads by Product pull-down menu, select Citrix NetScaler. From Select Product Version, use the pull-down menu to select 9.1. From the Select OS/Hardware pull-down menu, select Evaluation Virtual Appliance.

3. Click on the NetScaler VPX Evaluation Virtual Appliance link.

4. The following screen appears. From this screen, you can download the .xva software package for the virtual appliance by clicking Download Here, and you can also download the NetScaler VPX 90-day EVAL license by clicking Get License. Click Get License.

5. This will open a second browser window with a selection of one or more available evaluation licenses for your company. Click on one of the serial numbers.

6. You will be directed to the Citrix Activation System/Manage Licenses tool. The License Code selected from the previous screen will be filled in for you. Click Continue.

7. From the Citrix Activation System page, select the correct country then scroll to the bottom of the screen and click Continue.

8. Select the appropriate name from the list of contacts, and click Submit.

9. Verify your contact information and then scroll to the bottom of the screen and click Submit.

10. The Citrix Activation System screen appears. The host name or Host ID reference will be required in order to activate a NetScaler VPX license. Click Continue.

11. The hostname or Host ID required is based on the MAC address of the NetScaler VPX virtual machine. The host ID of the NetScaler appliance on which you install the license. Instructions for locating the host ID are found in the section Obtaining the Host ID.

12. The evaluation license name, the license code and quantity will be displayed. In the Hostname of your Citrix license server field, enter the MAC address of the virtual machine as a string of digits with the separating colons removed. Click the Allocate button. Note: Steps 1 and 2 on the screen do not apply to the NetScaler VPX license allocation.

18. To confirm your selection, click Confirm. Evaluation licenses are 90-day 1000 Mbps Platinum Edition.

13. The Download License File screen will appear listing the MAC address of the VPX virtual appliance, the license file type, and license code. Click the Download License File button and save the file to a directory on your workstation. Remember the location to which you downloaded the file, you will need this location when copying the license file to the NetScaler VPX virtual machine.

14. Save the file to a safe location on your workstation or network. Remember the location to which you downloaded the file, you will need this location when copying the license file to the NetScaler VPX virtual machine.

15. You are returned to the Download License File page where a check mark and the words Download Complete appear. Click the Citrix NetScaler, click here to learn how to install your license file link to read more about installing the license file on the NetScaler VPX virtual appliance. For complete license installation instructions, see Chapter 2 of the Citrix NetScaler Migration Guide - Release 9.1 - CTX1121822 - Citrix NetScaler Migration Guide - Release 9.1..

16. Repeat Steps 1 – 15 for each evaluation NetScaler VPX virtual appliance.

[Return to Top]

VPX Express Licenses

NetScaler VPX Express licenses are free for download from the Downloads pages on MyCitrix.com and provide NetScaler Standard Edition functionality at 1 Mbps (full duplex) throughput. NetScaler VPX Express supports full strength encryption for both SSL offload and the Access Gateway Enterprise SSL VPN. The license allocation process requires the host name or host ID of the NetScaler VPX virtual appliance.

Before going to the Citrix Web site, you need the following items at hand:

• Your user ID and password for MyCitrix. You can register for this password on MyCitrix.com.

• The host ID of the NetScaler appliance on which you install the license. Instructions for locating the host ID are found in the section Obtaining the Host ID.
Note: If you cannot locate either of these items, contact Citrix Customer Service.

1. From the MyCitrix.com home page, click the Downloads link at the top of the page.

2. From the Search Downloads by Product pull-down menu, select Citrix NetScaler.

3. From the Select OS/Hardware pull-down menu, select Evaluation Virtual Appliance.

4. Click on NetScaler VPX Express link.

5. The following screen appears. From this screen, you can download the .xva software package for the virtual appliance by clicking Download Here, and you can also download the NetScaler VPX Express 1 Mbps Standard Edition license by clicking Get License.

6. This will open a second browser window with a selection of one or more available evaluation licenses for your company. Click on one of the serial numbers.

7. You will be taken to the Activation System/Manage Licenses screen. Follow Steps 6 - 17 of the Evaluation License instructions to complete the license download process.

Obtaining the Host ID

Each of the license codes will generate one Citrix NetScaler VPX license. You will repeat the process of allocating a license with a unique license key for each device. Each license file will be unique for a specific NetScaler VPX virtual appliance and must be installed only on that virtual machine.

To obtain the Host ID:

1. Log on to the NetScaler CLI using SSH or the console.

2. Drop to the BSD shell by typing the shell command.

3. From the shell, use the following command:
lmutil lmhostid –ether

Example:

root@ns1# lmutil lmhostid –ether
lmutil - Copyright (c) 1989-2006 Macrovision Europe Ltd. and/or Macrovision
Corporation. All Rights Reserved.
The FLEXlm host ID of this machine is "00d068107316"
NOTE: lmutil command needs to be run on both boxes in an HA pair

[Return to Top]

Sample Licenses

VPX 200 Standard Edition Family Edition License

# This file is in UTF-8 format.

#

SERVER this_host 0204de74aabb

VENDOR CITRIX

USE_SERVER

INCREMENT CNS_V200_SERVER CITRIX 2010.0902 permanent 1 \

VENDOR_STRING=;LT=Retail;GP=720;CL=V200,STRONG;SA=1;ODP=0 \

ISSUED=08-Sep-2009 NOTICE="abc company" \

SN=LA-0000970389-04836:2306461 START=2-sep-2009 SIGN="038B \

D646 7FE4 B293 8012 0A2C 595E CE9E 3444 10B3 8B81 A2AD 4F5D \

6335 F509 068A 1767 D7A4 CA72 EC44 F1DA B330 180F 5E49 8317 \

786C 23A7 F760 236F BE4D"

INCREMENT CNS_SSE_SERVER CITRIX 2010.0902 permanent 1 \

VENDOR_STRING=;LT=Retail;GP=720;CL=SSE;SA=1;ODP=0 \

ISSUED=08-Sep-2009 NOTICE="abc company" \

SN=LA-0000970389-04836:2306461 START=2-sep-2009 SIGN="080B \

9533 FCC7 3310 6891 6F96 6DE7 2304 CFD9 EE0F 7EE4 125D 847D \

[text deleted]

[Return to Top]

Installing Licenses

Licenses must be copied to the /nsconfig/license directory on the NetScaler VPX virtual appliance using secure copy or FTP. Create the /nsconfig/license directory if it does not exist. Licenses are read at startup, allowing features to be enabled by the NetScaler VPX. For complete license installation instructions, see Chapter 2 of CTX1121822 - Citrix NetScaler Migration Guide - Release 9.1.

To install the licenses using the configuration utility:

1. In a Web browser, type the IP address of the NetScaler VPX, such as http://192.168.100.1.

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

3. In the navigation pane, expand System, and then click Licenses. In the Licenses pane, click Manage Licenses.

4. In the Manage Licenses dialog box, click Add.

5. In the Select License Files dialog box, navigate to the location of the license file(s) and select the file you want to upload. Click Select.

6. After your file is uploaded to the license directory, click OK.

7. When prompted to restart the NetScaler VPX, do one of the following:

• If you plan to upgrade your software, click No. Instructions for upgrading the NetScaler VPX operating software, refer to Chapter 2 of the Citrix NetScaler Migration Guide - Release 9.1 - CTX1121822 - Citrix NetScaler Migration Guide - Release 9.1.

• If you do not plan to upgrade your software, click Yes to restart the NetScaler VPX.

8. After reboot, verify that the license file has been successfully read by the NetScaler VPX by expanding System and clicking Licenses.

[Return to Top]

To install the licenses using the NetScaler command line:

1. Open an SSH connection to the NetScaler VPX using an SSH client such as PuTTY.

2. Log on to the NetScaler VPX using administrator credentials.

3. Switch to the shell prompt and create a license subdirectory in the nsconfig directory.

4. Using SCP or FTP or any third-party program, copy the new license file(s) to this directory.

Example:

[Return to Top]

More Information

Refer to additional information at the following locations:

• Citrix Licensing: http://support.citrix.com/proddocs/topic/licensing/lic-library-node-wrapper.html NOT POPULATED FOR NETSCALER VPX!!

• Obtaining License Files from MyCitrix.com: http://support.citrix.com/proddocs/index.jsp?topic=/licensing/lic-obtaining-your-license-files.html

• Citrix NetScaler Software and Documentation: https://www.citrix.com/English/ss/downloads/results.asp?productID=21679

Who to call for licensing questions

Customer Service:

• Assistance with MyCitrix logons

• Assistance with license portal navigation

• Assistance with verifying existing entitlements show for a specific Org ID

• Assistance with locating the proper license code

• Assistance with retrieving a platform, upgrade or option license

• Assistance with license upgrades for customers on pre-8.x software (legacy process)

• For assistance with purchasing platform, upgrades or option licenses contact Citrix Sales or your Solution Advisor.

Technical Support:

• Assistance with copying the license to the virtual appliance

• Assistance with installing the license on the virtual appliance

• Assistance with verifying that the license has been properly read by the virtual appliance at boot time

• Assistance with boot issues relating to reading the installed license

To locate a Customer Service or Technical Support center near you, visit http://www.citrix.com/English/SS/supportThird.asp?slID=11553&tlID=11610 .