License Configuration

VSP Licenses can be procured from an On-premise or a Cloud License server. The information related to the procured licenses can be viewed in CMS. VSP uses the Flexera licensing tool to issue the required number of licenses.

1. On-premise License server can be used when internet connection is not available for CMS
2. Cloud License server can be used when CMS has internet connectivity and can able to access Flexera Cloud license server

How many licenses to acquire?

1. Virtual Machines - Each Probe instance requires one license
2. Containers - Ten containers can be secured using one license

Once a license is issued to an account holder, an Activation ID is sent to the registered email ID along with the information about the number of instances that can be activated using that ID.

On-Premise License Server

The on-premise license server is available as a pod.

1. Execute the below commands for Container only to get the On-premise license server up and running

   cd serviceperpod/infra
   kubectl apply -f vsp_licenseserver.yaml -n virsec

2. Log in to the worker node for containers OR the CMS VM for VMs and execute the below command to verify that the server is ready and running

   docker ps | grep license
   docker exec -it <container_ID> bash
   cd /usr/bin/flexnetls-x64_linux-2022.12.0/enterprise
   ./flexnetlsadmin.sh -server http://localhost:7070/api/1.0/instances/~ -status

3. Execute the below commands to add a license
   1. Create a capability request bin file using the below command and copy the file to the local system

      ./flexnetlsadmin.sh -server http://localhost:7070/api/1.0/instances/~ -activate -id <activation ID> -count <Number of licenses> -o caprequest.bin

   2. Log in to the Flexera portal URL - https://flex1298.flexnetoperations.com/flexnet/operationsportal using Activation ID or Virsec-provided user credentials
   3. Navigate to Devices > Offline Device Management
   4. Select Generate License and choose capability request bin file from the local directory. Click Upload
   5. Execute the below commands to load the license

      docker cp capabilityResponse.bin <container_ID>:usr/bin/flexnetls-x64_linux-2022.12.0/enterprise
      docker exec -it <container_ID> bash
      cd /usr/bin/flexnetls-x64_linux-2022.12.0/enterprise
      ./flexnetlsadmin.sh -server http://localhost:7070/api/1.0/instances/~ -activate -load capabilityResponse.bin

   6. Execute the below command to list the number of licenses

      ./flexnetlsadmin.sh -server http://localhost:7070/api/1.0/instances/~ -features

      
4. Once the licenses are loaded, they are listed in CMS under Administration > Licenses

Persistence of Licenses

Whenever there is a restart of CMS, license server or CMS VM, the persistence behavior for licenses varies in VMs and Containers:

1. VMs: The licenses maintain persistence except in case of a VM crash with a file system wipeout
2. Containers: The licenses lose persistence
3. In cases where the licenses lose their persistence, generate a capability request to load the licenses

Cloud License Server

1. Log in to the Flexera portal URL - https://flex1298.flexnetoperations.com/flexnet/operationsportal using Activation ID or Virsec-provided user credentials. All the products and the respective activation IDs will be listed
2. To create a Cloud server, navigate to Devices > Create Device. Provide the required information as described below and click Save
   1. Name
   2. Check the checkbox to indicate “Runs License Server”
   3. Choose the deployment type as Cloud
   4. Select the appropriate Account from the drop-down list
   5. Site Name (Optional).
3. The newly created device is listed under Devices > Devices
4. Click on the newly created device to view the device information. Note down the License Server ID
5. To add licenses to the server, navigate to Action > Map Entitlements in the displayed device information
   1. Add the number of licenses to be added from the list and click Save
6. The selected licenses with the desired quantity is added to the device and listed with Status as License generated
7. Follow the below steps to enable Cloud License Manager in CMS
   1. Navigate to Configurations under Administration in the left navigation pane of CMS
   2. Expand License Manager and click Enable
   3. Update the Cloud License Server URL as https://flex1298.compliance.flexnetoperations.com/instances/<LicenseServerID> /request. Click SAVE 
8. Once the licenses are loaded, they are listed in CMS under Administration > Licenses

View License Information

1. Navigate to Administration > Licenses in the left navigation pane in CMS
2. Once an application is secured, the number of licenses required by the application is automatically used. This information is displayed on the licenses page in CMS
3. When an application is stopped in the Applications Provisioning page, the used licenses are freed automatically
4. Once a license expires or its count is reduced on the license server, the displayed license type may change since (only) the required license type is listed and NOT the previously active license

Revoke License

1. Navigate to Administration > Licenses in the left navigation pane in CMS
2. All licenses including used licenses are displayed
3. For any Probe in Unknown status for more than two days, license can be revoked using the button shown below: