Product Features
...
Device Management
Backup/Restore

Back Up a Device

8min

You can backup your Litmus Edge with its configurations by navigating to System > Device Management > Backup/Restore.

Important:

  • You must have a valid license to enable this page. See Licenses.
  • If you create a backup on an instance of Litmus Edge running on a virtual machine, you can't use the same backup to restore an instance of Litmus Edge running on a physical device.

There are two ways to back up a device: Manually and Cloud.

Back Up a Device Manually

You can back up a device manually and save a copy of the device to your local drive.

Before You Begin

Review the following resources before manually backing up a device.

How To Back Up a Device Manually

To manually back up a device:

  1. In Litmus Edge, navigate to System > Device Management.
  2. Click the Backup/Restore tab.
  3. From the Backup/Restore Configuration section, click Backup. A backup.dat file is saved to the Downloads folder.

    Document image
    
  4. Move the backup.dat file to a designated folder on your local drive.
  5. Rename the backup.dat file according to your naming convention.

Recommended Alternative: Use Litmus Edge Manager to Backup Device

As instructed above, backing up a Litmus Edge device is a manual process. Litmus Edge Manager offers an automatic backing up feature for your Litmus Edge devices. This option automatically creates a new backup every time a Litmus Edge device’s configuration setting changes. This includes setting changes such as saving a flow, adding a new user, or adding a new Analytics processor.

See Backup from the Litmus Edge Manager documentation to learn more.

Back Up a Device to the Cloud

Backup to the Cloud facilitates backups to Litmus Edge Manager. Backups allow you to save a Litmus Edge device configuration to the cloud and later restore the configuration for the same device.

You can save the current device configuration to the cloud. This enables you to store full license and configuration information within a backup JSON file. You can later restore the full license and configuration to the same Litmus Edge device.

  • Use this option to save a Litmus Edge device configuration so that you can later revert to a previous configuration.
  • Use this option to store a local backup of the Litmus Edge device configuration.

Before You Begin

Before completing the steps below, make sure you do the following:

  • Obtain a license for backup and restore.
  • Activate the device with Litmus Edge Manager. See Activate an Edge Device for more information.

How To Back Up a Device to the Cloud

Important: When you configure a device backup to the Cloud, you have the option of selecting the backup time interval. The selection you make determines the frequency of the backup mechanism that checks the device configuration for changes. If a configuration change is detected before the configured time, a backup automatically occurs.

To save a device configuration to the cloud:

  1. In Litmus Edge, navigate to System > Device Management.
  2. Click the Backup/Restore tab. The Backup/Restore pane appears.
  3. From the Restore/Backup to the Cloud section, click Configure and select an option from the drop-down list: None, 1 Day, 1 Hour, 10 minutes, custom interval in minutes.

    Document image
    
  4. After you have made your selection or entered an interval in minutes into the Interval field, click Set Custom.
  5. From the Restore/Backup to the Cloud section, click Save. The backup configuration is saved to the cloud according to your selections. The backup files appear as files in the Restore/Backup to the Cloud section for the interval you have selected.