Citrix ADC VPX check-in and check-out licensing

You can allocate VPX licenses to Citrix ADC VPX instances on demand from Citrix Application Delivery Management (ADM). The ADM software stores and manages the licenses, which have a licensing framework that provides scalable and automated license provisioning. A Citrix ADC VPX instance can check out the license from the Citrix ADM when a Citrix ADC VPX instance is provisioned. When an instance is removed or destroyed, the instance checks back in its license to the Citrix ADM software.

Prerequisites

Make sure that the following prerequisites are met:

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

Note

To manage existing VPX licenses by Citrix ADM, you need to rehost the licenses to Citrix ADM.

Installing Licenses in Citrix ADM

Note

Before installing licenses, restart the Citrix ADM virtual appliance if you have changed the software edition or bandwidth.

To install license files on Citrix ADM:

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

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

  3. Navigate to Networks > Licenses.

  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 Citrix ADM.
      To add license files, click Browse and select the license file (.lic) that you want to 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.

    install-license

    At any time, you can add more licenses to the Citrix ADM from the License Settings.

Verification

You can view the available and allocated licenses in the Citrix ADM GUI.

To display the licenses:

  1. In a web browser, type the IP address of Citrix ADM (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.

    verify-license

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

Allocating VPX Licenses to a Citrix ADC VPX Instance by using the Citrix ADC GUI

  1. In a web browser, type the IP address of the Citrix ADC 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 > CICO Licensing.

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

  5. In the Username and Password fields on the above screen, enter Citrix ADM credentials and click Continue.

    allocate-license-gui-1

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

    allocate-license-gui-2

  7. Click Reboot, your Citrix ADC VPX instance reboots.

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

    allocate-license-gui-3

  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.

    allocate-license-gui-4

Allocating VPX Licenses to a Citrix ADC VPX Instance by using the Citrix ADC CLI

  1. In an SSH client, enter the IP address of the Citrix ADC 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 >]
    

    add-license-server-cli-1

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

    sh licenseserverpool
    

    add-license-server-cli-2

  4. To assign a license to the Citrix ADC VPX appliance, enter the following command:

    set capacity –platform V\[S/E/P\]\[Bandwidth\]
    

    add-license-server-cli-3

Allocating VPX Licenses to a Citrix ADC VPX Instance by using API

In a web browser or an API client, log on to the Citrix ADC 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”:”\<Citrix ADM IP\>”, “port”:”27000”}}\\r\\n
    

    add-license-server-api-1

    Citrix ADM responds to the request. The following sample response shows success.

    add-license-server-api-2

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

    view-license-api-1

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

    view-license-api-2

To assign a license to the Citrix ADC 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
    

    assign-license-api-1

    Citrix ADM responds to the request. The following sample response shows success.

    assign-license-api-2

Update a licensing server IP address

You can update the licensing server IP address in the VPX instance, without any impact on the allocated license bandwidth on the instance and data loss.

Update using the CLI: To update the licensing server IP address using the CLI, type the following command on the VPX instance:

add licenseserver <licensing server IP address> -forceUpdateIP

This command connects to the new server and release the resources associated with the previous licensing server.

Update using the GUI: To update the licensing server IP address using the GUI, navigate to System > Licenses > Manage Licenses, click Add New License For more information, see Allocating VPX Licenses to a Citrix ADC VPX Instance by using the Citrix ADC GUI.

Configure Expiry Checks for Citrix ADC VPX Check-In/ Check-Out Licenses

You can now configure license expiry threshold for Citrix ADC VPX licenses. By setting thresholds, Citrix ADM 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 Citrix ADM.

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

To configure license expiry checks:

  1. Navigate to Networks > Licenses.

  2. In the License Settings page, under the License Expiry Information section, you can find the details of the licenses that are going to expire:

    • Feature: Type of license that is going to expire.

    • Count: Number of virtual servers or instances that are affected.

    • Days to expiry: Number of days before license expiry.

    expiry-check-1

  3. In the Notification Settings section, click the Edit icon and specify the alert threshold. You can set a percentage of pooled licenses capacity to be used to notify administrators.

  4. Choose the type of notification you want to send by selecting the appropriate check box. The notification types are as follows:

    1. Email Profile: Specify a mail server and profile details. An email is triggered when your licenses are about to expire.

    2. SMS Profile: Specify a Short Message Service (SMS) server and profile details. An SMS message is triggered when your licenses are about to expire.

    expiry-check-1

  5. Then, specify when you want to send the notification in terms of number of days before license expiry.

  6. Click Save.