NetScaler CPX Licensing

Licensing your CPX instance can enhance you NetScaler 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 you have purchased from CITRIX. To allocate licenses to your CPX instances, you can use Configuration Jobs or CPX’s Nitro.

The following table describes the differences between a Licensed and Un-licensed CPX (CPX Express):

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. On the Configuration tab, navigate to Infrastructure > Licenses > Settings.

4. In the details pane, go to License Files, and select Upload license files from a local computer.

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

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

Verification

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

Licensing a NetScaler CPX Instance by Using MAS Configuration Jobs

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

To allocate licenses on NetScaler CPX by using Jobs:

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

2. Navigate to Infrastructure > 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.

   

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

   

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

   

To remove licenses on NetScaler CPX by using Jobs:

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

2. Navigate to Infrastructure > 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:

   

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

   

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

Licensing a NetScaler CPX Instance by Using the Nitro API

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

To add license server to a NetScaler 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 as following:

   Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
   Content-Type:application/json
   

4. Enter the Request Payload as following:

   {"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 NetScaler 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":{
         "bandwidth":<Double_value>,
         "edition":<String_value>,
         "unit":<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 NetScaler CPX Instance, you can download the NITRO API Documentation available on the NetScaler appliance Downloads section.