NetScaler Console service

NetScaler VPX check-in and check-out licensing

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

Install licenses in NetScaler Console

To install license files on the NetScaler Console:

  1. Navigate to NetScaler Licensing > License Management.
  2. In the License Files section, click Add License File and 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 Console.
    • Use license access code: Specify the license access code for the license that you have purchased from Citrix. Click Get Licenses and then click Finish.
  3. Click Finish. The license files are added to NetScaler Console.

    Note

    Make sure you are connected to the internet before using the license access code for installing the licenses.

Allocate NetScaler VPX license to a NetScaler VPX instance by using the NetScaler GUI

  1. Log in to the NetScaler VPX instance and navigate to System > Licenses > Manage Licenses, click Add New License, and select Use remote licensing.

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

    Note

    If you want to manage your instance’s NetScaler VPX licenses through the NetScaler Console, select the Register with NetScaler MA Service checkbox and enter the NetScaler Console credentials.

  3. Click Continue.

  4. In the Allocate licenses window, select the type of license. The window displays the total and the available virtual CPUs and also the CPUs that can be allocated. Click Get Licenses.

  5. Click Reboot on the next page to apply for the license.

    Note

    You can also release the current license and check out from a different edition. For example, you are already running a Standard edition license on your instance. You can release that license and then check out from Advanced edition.

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

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

Allocate a NetScaler VPX license to a NetScaler VPX instance by using the NetScaler CLI

  1. In an 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 >]
    <!--NeedCopy-->
    

    add-license-server-cli-1

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

    sh licenseserverpool
    <!--NeedCopy-->
    

    add-license-server-cli-2

  4. To assign a license to a NetScaler VPX instance, enter the following command:

    set capacity –platform V\[S/E/P\]\[Bandwidth\]
    <!--NeedCopy-->
    

    add-license-server-cli-3

Configure expiry checks for NetScaler VPX check-in/check-out licenses

You can now configure the license expiry threshold for NetScaler VPX licenses. By setting thresholds, NetScaler Console sends notifications via email or SMS when a license is due to expire. An SNMP trap and a notification are also sent when the license has expired on NetScaler Console.

An event is generated when a license expiry notification is sent and this event can be viewed on NetScaler Console.

For more information, see License management.

NetScaler VPX check-in and check-out licensing