Set up an activation configuration
An activation configuration can be configured with limits, license keys, template and/or template variables. These configurations are all entirely optional. Some of these configurations have existing default values while others can be left blank. These configurations are all implemented in the first four steps and can be skipped if no additional customization is needed.
Generating the details for an activation configuration occurs only in Step 6: Save while retrieving the key details are in Step 7: Retrieve Activation Code/URL.
Before you begin
- If you are using a node-locked license, make sure you have a license key for deployment. To get a license key, contact your Litmus account executive.
- If you are using a site-based license, make sure you have the URL and port for the license server. See License server management.
Step 1: Configure limits
After navigating to Activation > Configuration and clicking the Add activation config icon, you can start configuring the limits.
You have the option of configuring limits, specifically number of edge devices, lease TTL and expiration date. If no changes are needed, proceed to the next step.
- Number of Edge devices: Enter the number of devices that will share the activation code. The activation code (created after saving) can be used for multiple edge device activation.
- Lease TTL for identity certificate: Enter the number of days the identity certificate for the activation will be valid from the day you activate the edge device.
- Expiration Date: Select the expiration date when the activation code can no longer be used.
Step 2: Configure licenses and license types
You have the option of using either a node-locked or a site license. By default, a node-locked license is selected.
- A node-locked license associates and attaches a license with a Litmus Edge instance. Use this option for assigning one license to each edge device.
- A site license is when Litmus Edge obtains a license from a Litmus Edge License Server. Use this option to specify the IP address of the license server.
See Site and Node-Locked License Overview for Litmus Edge to learn more.
If no changes are needed, proceed to the next sub-step.
Configure a Site-based license
Ensure the site-based license has already been applied in Litmus Edge Manager before activating the device. The site license must be created through Offline activation in License server management.
Configure a Node-locked License
You have the option of adding node-locked license SKUs manually or uploading them in a file.
Add License SKU Manually
To manually add a node-locked license key:
- Select the checkbox for License SKU. Only one core license SKU can be selected.
Upload License Keys
To upload node-locked license CSV:
- Click the Upload icon. The Upload license keys dialog box appears.
- Click the SELECT FILE button and navigate to select the file from your local computer.
- File Name: (Optional) Rename the file if needed.
- Example of the CSV file is available here.
- Click UPLOAD.
Step 3: Add templates
You have the option of applying templates when activating a Litmus Edge instance. Learn more about Templates.
If the Litmus Edge instance doesn't need a template, proceed to the next step.
To add at least one template:
- From the Template section, click the Add icon. The Template Select dialog box appears.
- Select one or more templates from the list, and then click Select. The selected template appears in the Templates list.
Step 4: Add template variables
You have the option of applying template variables when activating a Litmus Edge instance. Before using template variables, you need to Parameterize a template.
If the Litmus Edge instance doesn't need any template variables, proceed to the next step.
Adding template variables manually
To add at least one template variable manually:
- From the Template Variables section, click the Add icon. The Add new variable set dialog box appears.
Adding template variables for all devices
In order to add template variables for all devices:
- From the Add new variable set dialog box, click the Variable set type toggle so it displays All Devices.
- Click Add. The Variable set: All devices appears in the Template Variables list.
- Click the Add icon next to the variable set. The Variables line items drop down.
- In the Variable Name field, enter a variable name.
- In the Variable Value field, enter a variable value.
Adding template variables for individual Edge device
- From the Add new variable set dialog box, click the Variable set type toggle so it displays Per Edge Device.
- In the Host Name field, enter the host name for an edge device. To find host name for an edge device, see Configure the Network Settings' Host Information.
- Click Add. The Variable set: per Edge Device: <hostname> appears in the Template Variables list.
- Click the Add icon next to the variable set. The Variables line items drop down.
- In the Variable Name field, enter a variable name.
- In the Variable Value field, enter a variable value.
Adding template variables using .csv file
Multiple template variables can be uploaded using a .csv file. A sample .csv file is available to download for customization.
To add at least one template variable using a .csv file :
- From the Template Variables section, click the Upload icon. The Upload variable sets dialog box appears.
- (Optional) Click the here link to download a sample .csv file.
- Click Select File, navigate to a variable set .csv file, and then click Open. The selected .csv file appears in the File Name field.
- Click Upload. The variable sets listed in the .csv file appear in the Variable Sets list.
Step 5: Provision options
Note: The Provision Options feature is available for Litmus Edge Manager 2.12.0 and later.
To apply the AWS Sitewise Edge integration during activation, select the AWS SiteWise Edge Integration checkbox. This feature enables Litmus Edge to connect with the AWS Sitewise Edge MQTT broker when deploying LE components using the AWS Sitewise console.
To apply the default password policy during activation, select the Password Policy checkbox. If there are multiple password policies, the master default password policy that can't be deleted is implemented.
After activation, you can update the default password policy for individual edge devices.
Step 6: Configure advanced settings
Note: The Advanced Settings feature is available for Litmus Edge Manager 2.11.0 and later.
When Litmus Edge Manger (LEM) connects to a Litmus Edge (LE), it uses Remote Access. Remote Access has a parameter PersistentKeepalive that you can reconfigure on how often to send an authenticated empty packet to a Litmus Edge for the purpose of maintaining the LEM-LE connection. By default, Remote Access uses 22 seconds.
To set advanced settings, from the Remote Network Persistent Keepalive field, enter a number of seconds between 1-25.
Step 7: Save
When done configuring the Activation Configuration, click Save. Once saved, the activation code will then be generated at the Activation Code field.
Step 8: Retrieve activation code and URL
After saving, the activation code will display underneath the Activation Code section. This code and the Activation URL will be needed when activating a Litmus Edge instance.
To retrieve the activation code/URL:
- Copy to clipboard the Activation Code. It will be needed for activating a Litmus Edge instance.
- Copy to clipboard the Activation URL. It will be needed for configuring a Litmus Edge instance.
Next steps
Use the copied Activation Code and Activation URL to Activate an Edge Device.