Using the Built-in Agent to License NetScalers Using Flexed Licensing

With the new conversion to Flex Licensing for NetScaler, many smaller companies were faced with the requirement to install a NetScaler Console or a NetScaler Console Service Agent to license their appliances. Both options required a large VM to be running and maintained with a minimum size of 4 CPU and 8 GB of RAM. This was especially challenging for customers who hosted their environments in the public cloud as they now required a large VM to run all the time, resulting in a minimum of approximately $50 US expense. For those customers who need the connection simply for licensing purposes, the built-in agent on the NetScaler can accomplish this. In this blog, we will learn how to use the built-in agent for Flexed licensing.

Note: The built-in agent can only be used in NetScaler Console or NetScaler Console Service where a License Server Agent (LSA) already exists. This method will permit proxy licensing of additional appliances in other sites that do not have a NetScaler Agent to act as the proxy. 

Configuring the agent 

In the NetScaler Console Service screen. 

1. 1. Navigate to “Infrastructure”, “Instances”, “Agents” and choose “Setup Agent”
   2. Then choose “Get Started.”
   3. Then choose “Custom deployment.”
   4. Select “On Premises.”
   5. Select “Traditional/Tiered.”
   6. Select “Built-in Agent.”
   7. This will present you with the “Service URL” and “Activation Code.”
   8. Now you will need to proceed to the NetScaler CLI.
   9. On the NetScaler, start the shell commands and navigate to the /var/mastools/ directory.
   10. Issue the command “./mastools_init.sh <device_profile_name> <service_url> <activation_code> -profile” if using a device profile or “./mastools_init.sh <user_name> <pwd> <service_url> <activation_code>” without a profile where:
       a. <device_profile_name> – The profile name from the NetScaler Console Service
       b. <user_name> – The user name of the NetScaler login (usually nsroot)
       c. <pwd> – The password for the chosen user
       d. <service_url> and <activation_code> – The Service URL and Activation Code from the Console Service
       
   11. Execute the command. This will take some time and requires the NetScaler to be able to resolve the service URL via DNS and be able to contact the service through the internet. If either of these are not permitted, then the NetScaler Console or NetScaler Console Agent will have to be utilized.
       
   12. Choose “Register Instance” on the NetScaler Console Service.
   13. On the next screen, you should see your new instance. Choose “Next.”
   14. On the “Enable Communication Screen, choose “Done.”
   15. Your new instance will now show under the “NetScaler” instances.
   16. On the NetScaler instance GUI, navigate to “System”, “Licenses” and select “Manage Licenses.”
   17. Select “Add New License.”
   18. Choose “Use remote licensing.” Then, choose “Pooled Licensing” and enter the license server name/IP address as 127.0.0.1. The standard license port of 2700 should be  used, and enter the username and password, and uncheck the “Validate Certificate” checkbox. Then choose “Continue.”
   19. You will get the error “Registration of device failed.” This is a known bug, you can safely choose “Ok”
   20. You will be presented with the “Allocate licenses” screen. Here you can choose the bandwidth to assign. The Instances will auto-populate 1 instance. Allocate the desired bandwidth and choose “Get Licenses.”
   21. You will then be prompted to reboot the appliance. A warm reboot is sufficient.
   22. After rebooting, you will see the proper licenses allocated.
       
   23. You will receive a warning that you are operating in a grace period. The remaining configuration needs to be completed from the NetScaler Console Service.
   24. On the NetScaler Console Service dashboard, select the instance you just added and choose “Edit Throughput Capacity.”
   25. On the following screen, choose “Platinum Edition” and set the desired bandwidth. Then choose “Submit”
   26. The instance will now show licensed with the assigned throughput capacity

The device is now successfully licensed and prepared for use.

NetScaler Documentation:

Configure Flexed Licensing

Transition to Flex Licensing

Other Ferroque Licensing Articles

HowTo: Install and Apply NetScaler Flex Licensing

Understanding and Transitioning to NetScaler Flex Licensing