Citrix ADC CPX Licensing

Licensing your CPX instance can enhance you Citrix ADC CPX’s performance. You can use NetScaler MAS to pool your CPX licenses and use it as a licensing server. You can install licenses in MAS using the GUI by uploading the license file or using the License Access Code (LAC) that you have purchased from Citrix. To allocate licenses to your CPX instances, you can use Configuration Jobs or CPX’s Nitro. If you are provisioning the Citrix ADC CPX with multiple vCPU cores, then each core is allocated with a CPX licence from the license pool. For example, if you have provisioned the Citrix ADC CPX with 4 vCPU cores then 4 licenses are allocated to the Citrix ADC CPX instance.

To install CPX license files on NetScaler MAS:

  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. Navigate to Networks > Licenses.

  4. In the details pane, go to License Files, and select one of the following options:

    • Upload license files from a local computer - If a license is already present on your local computer, click Browse and select the license file (.lic) that you want to use to allocate your licenses. Click Finish.

    • Use license access code - Citrix emails the LAC for the license that you purchased. Enter the LAC in the text box and then click Get Licenses.

      Note: If you select this option, the NetScaler Management and Analytics System must be connected to the Internet, or a proxy server must be available.

    localized image

  5. Click Browse and select the license file (.lic) that you want to use to allocate your licenses. Click Finish.

At any time you can add more licenses to the NetScaler Management and Analytics System, from the License Settings.

localized image

Verification

You can verify the licenses installed on your NetScaler MAS by navigating to Networks > Licenses > CPX Licenses.

localized image

Licensing a Citrix ADC CPX Instance by Using MAS Configuration Jobs

You can use NetScaler MAS to license Citrix ADC CPX instances by configuring jobs.

To allocate licenses on Citrix ADC CPX by using Jobs:

  1. Log on to NetScaler MAS by using the administrative credentials.

  2. Navigate to Networks > Configuration Jobs, and then click Create Job.

  3. Specify the required values, and select the configuration source, and type the following commands as shown in the image below:

    Note:

    By default the license server port number in NetScaler MAS is 27000.

    localized image

  4. Select the Citrix ADC CPX instance(s) on which you want to run the configuration and click Next.

    localized image

  5. Specify the execution settings and click Finish to run the commands on the Citrix ADC CPX instance. If you want to save the configuration and run it at a later time, click Save and Exit.

    localized image

To remove licenses on Citrix ADC CPX by using Jobs:

  1. Log on to NetScaler MAS by using the administrative credentials.

  2. Navigate to Networks > Configuration Jobs, and then click Create Job.

  3. Specify the required values, and select the configuration source, and type the following commands as shown in the image below:

    localized image

  4. Select the Citrix ADC CPX instance(s) on which you want to run the configuration and click Next.

    localized image

5. Specify the execution settings and click Finish to run the commands on the Citrix ADC CPX instance. If you want to save the configuration and run it at a later time, click Save and Exit.

Licensing a Citrix ADC CPX Instance by Using the Nitro API

You can use the NetScaler Nitro API to license Citrix ADC CPX instances.

To add license server to a Citrix ADC CPX instances:

  1. Go to http://\<netscaler-ip-address\>/nitro/v1/config/nslicenseserver.

  2. Set the HTTP method as POST.

  3. Add the Request Headers:

        Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
        Content-Type:application/json
    
  4. Enter the Request Payload:

        {"nslicenseserver":{"licenseserverip":<String_value>,"servername":<String_value>,"port":<Double_value>}}
    
  5. You can view the following Response:

         HTTP Status Code on Success: 201 Created

         HTTP Status Code on Failure: 4xx \<string\> (for general HTTP errors) or 5xx \<string\> (for NetScaler-specific errors). The response payload provides details of the error

To set capacity on a Citrix ADC CPX instances:

  1. Go to http://\<netscaler-ip-address\>/nitro/v1/config/nscapacity.

  2. Set the HTTP method as PUT.

  3. Add the Request Headers as following:

        Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
        Content-Type:application/json
    
  4. Enter the Request Payload as following:

        {"nscapacity":{
    
              "platform":<String_value>
    
        }}
    
  5. You can view the following Response:

         HTTP Status Code on Success: 200 OK

         HTTP Status Code on Failure: 4xx \<string\> (for general HTTP errors) or 5xx \<string\> (for NetScaler-specific errors). The response payload provides details of the error

For more information about licensing a Citrix ADC CPX Instance, you can download the NITRO API Documentation available on the NetScaler appliance Downloads section.