Manage Templates
You can upload and download device configuration templates by navigating to System > Device Management > Template.
The following component categories are available for selection. You can select a whole category, or individual components within a category, for download. Each category will show the list of component that you have configured or installed on the device. For example, the connectors category will show the list of connectors that are on the device.
- Auth: Configurations of LDAP/AD Authentication Providers. This doesn't include roles, groups, and users created in Litmus Edge. See LDAP/AD Auth.
- Connectors: Installed connectors and configurations. Connectors with the same name that exist in both the template and the Litmus Edge device will be duplicated with a unique name after uploading the template. The default connector that connects Litmus Edge and Litmus Edge Manager is not included. See Integration.
- Docker Binding IP: Contains the IP address and netmask to use for Docker’s default bridge using standard CIDR notation. See Applications.
Example: "bip":"10.30.50.1/24"
Note: When you upload a template, the existing flows in the instance are replaced with the flows in the template configuration. If you would like to ensure existing flows are maintained after uploading a template, confirm that any flows you want to keep are part of the template configuration.
- Marketplace: Installed catalogs and registries. Only applications deployed using a catalog can be part of a template. For example, If you deployed an application from the catalog, it is part of a template file. If you use the docker run command to deploy an application, it is not part of a template file. See Marketplace.
- NTP: Saved Network Time Protocol (NTP) servers. See Configure DNS/NTP Servers and Troubleshooting - Time Synchronization.
You can download multiple device configuration templates, selecting different configurations from a single Litmus Edge device.
These device configuration files are then available on your hard drive for upload to other Litmus Edge devices. The template files can also be uploaded to a Litmus Edge Manager to be applied to groups of Litmus Edge devices. See Edge Software Update to learn more.
You can customize the template prior to downloading by selecting components individually or by category.
To enable this page you need a valid license. See Licenses.
To download a template:
- In Litmus Edge, navigate to System > Device Management.
- Click the Template tab.
- Select the checkboxes for the configurations you want to include in the device configuration template or select the Select All checkbox.
Click Download Template. The JSON file downloads to your hard drive.
Notes:
- If one component fails during a template upload, an error message will display and the upload process will continue with the remaining components.
- If you upload a template with the same connectors that are already existing in the Litmus Edge device, then duplicate connectors will be created with unique names. For example, if the template and the Litmus Edge device both have a MySQL connector with the name MySQL_integration, a duplicate connector will be created with the name MySQL_integration (1).
- If you upload a template with the same device and tags as the Litmus Edge device, any additional tags that are in the Litmus Edge device but are not in the template will be automatically deleted when the template is uploaded.
You can upload a device configuration template by navigating to System > Device Management > Template.
When you upload a device configuration template, it applies the configuration in the file to the Litmus Edge device.
You can also apply templates to Litmus Edge devices using Litmus Edge Manager, potentially changing the configurations for hundreds of Litmus Edge devices.
- To access the features on the Backup/Restore page, you need a valid license.
- Download a device configuration template. See the Download a Template section.
To upload a template:
- In Litmus Edge, navigate to System > Device Management.
- Click the Template tab.
- Click Upload Template.
- Navigate to a <date>-template.json file saved on your hard drive, and then click Open. The selected template successfully updates in the Templates section and applies the configurations to the Litmus Edge device.