License server management
Litmus uses an integrated license server to manage site-based licenses for Litmus Edge and Litmus Edge Manager. This system enables efficient activation and monitoring of your instances across different sites.
After obtaining a valid site license key from the Customer Portal, a corresponding site license is generated and added to the embedded license server. This site license is automatically applied when activating an edge device through Litmus Edge Manager. See Activate Edge Device for further details.
The License Server Management pane includes the following sections.
- Core License List: Displays all activated site licenses and their statuses for connected edge devices.
- Feature License List: Displays a list of features enabled with the activated site license.
- Offline Activation: Enables you to activate a site license key with the license portal and add the respective site license.
To access the license server management UI:
- Log in to the Litmus Edge Manager (LEM) Admin Console at the following URL: https://[LEM IP address]:8446.
- From the Navigation panel, select License Server Management. The License Server Management pane appears.
License server
You can view and manage the following sections in the License Server tab.
Core license list
The Core License list includes the following information.
- Status: The current operational status of the site license.
- License Name: Identifier for the license feature enabled for your edge devices.
- Expiry Date: The date on which the license will expire.
Action | Details |
|---|---|
[1] Show filter / Hide filter | Search by License Name, Expiry Date |
[2] Action menu |
|
Feature license list
This list includes the features enabled under the activated site license:
- Status: The status for each site-license feature
- License Name: The name of license features included for your connected edge devices
- In use: The number of iterations that are currently in use for your license features
- Available: The number of iterations that are available for your license features
- Total Count: The total number of iterations that are available for your license features
- Expiry Date: The expiration date for the license feature
This section lists available features with the activated site license for edge devices. The License SKU determines the available site-license features and may include:
- Analytics
- Backup
- Core
- Catalog
- Devices
- Marketplace
- License Core
- OPCUA
- Tags
- Updates
Use the Show filter / Hide filter button to search by License Name, Total Count, or Expiry Date. The action menu also provides an option to remove a license when necessary.
Offline activation
- You can add a Core or an Add-on license for edge devices from the Offline Activation section in the License Server Management pane.
- Once the licenses are added, edge devices that have been or will be activated with a Site license will receive the Core and all the Add-on Site licenses.
- While multiple Add-on licenses can be added as needed, only one Core license can exist.
Before you begin
Ensure you have a site license key, which you can request from the Customer Portal.
Add a Site license offline
To add a site-based license offline:
- From the Create Activation Request section:
- In the License Key field, enter the Site-License Key.
- (Optional) Select a License Type to add from the drop-down menu.
- Click Generate request. The activation request appears in the Activation request field.
- Next to the Activation request field, Click the Copy Activation Request icon. The activation request is copied to your clipboard.
- Click Next.
- From the Make license file section, click the License Portal link. The Licensing Portal page (https://litmus.activate.id/offline) opens in a new tab.
- Paste the activation request in the Activation Request field, and then click Make License. (You may need to verify I'm not a robot) The encoded license appears in the Activation Result field.
- Next to the Activation Result field, click the Copy content to clipboard icon.
- Return to the Make license file section in the Offline Activation browser tab and click Next.
- From the Add License section, in the License field, paste the encoded license, and then click Add License. The License is added.
- Once a site license is activated, the user must choose the license type; otherwise, the site license will not be applied. This selection can be made in Settings > License > License Settings.
License allocation
You can now allocate data points at the company/project level within a site license. This lets you control and manage data usage across multiple sites or divisions. It's important to note that this feature is only available for site licenses, so the associated edge device allocation is done per site license.
To access the license allocation UI:
- From the Navigation panel, select License Allocation. The License Allocation pane appears.
Action | Details |
|---|---|
[1] Show filter / Hide filter | Search for Licenses to allocate in the table. |
[2] Add allocation | Add or edit a license allocation. To configure:
|
[3] Export allocations (CSV) | Download the list of licenses allocated in CSV format. |
[4] Refresh list | Update the display for the license allocated in the list table. |
[5] Action | Select the following options:
|
License clients
Note: For Litmus Edge Manager version 2.12.0 and later, the user interface is split into two tabs: License Server and License Clients.
You can create and manage edge devices connected to the license server from the License Clients tab.
The License Clients tab allows you to manage the list of Litmus Edge instances that are clients to the license server. You can also add license clients directly without first activating through Litmus Edge Manager and connecting it through a proxy.
To create an activation request for a device on the license server:
- From the License Clients tab, click the Add icon. The Create New Request dialog box displays.
- Configure the details for the request.
- Label: Enter a label to identify the activated device.
- URL: Review and confirm the license server URL. Update the port value as needed.
- Click Create. The New Request Created dialog box displays.
- Click the Copy icon for the activation request.
- Log in to the Litmus Edge instance you want to activate and navigate to System > License.
- In the License Server Settings section, click Set Server. The Set License Server Configuration dialog box displays.
- In the Configuration field, paste the request you copied earlier and click Save.
If the activation is successful, a success message is displayed.
Click the Action menu to remove an activated device from the list and select Revoke activation.
