QuickStart Guide
Installation and Deployments
Software Updates
15 min
the upgrade process preserves your data and existing configurations however, we recommend that you create a backup after you install litmus edge software on a device, you can use this upgrade process throughout the lifetime of your device you have several options to upgrade litmus edge if you need to download an updated version of litmus edge, visit https //portal litmus io/ important for a seamless upgrade experience, you must follow the correct upgrade path skipping a significant lts version may cause issues with the upgrade process when you upgrade, you must upgrade to version 3 16 10, 3 16 11, or 4 0 3 for specific upgrade paths, see /#upgrade paths important before you upgrade, note that you can u pgrade to an internal prerelease version however, if you do so remember that you will not be able to upgrade again from that prerelease version upgrade to the same version you're currently on, if needed for example, if your current version is 3 3 1 , you can upload the 3 3 1 upd file again to your litmus edge instance use a template to apply configuration and setup settings from an existing edge device to a fresh installation or to update another device see docid\ me1x3i4rpt iignpcy1ga for more information you cannot downgrade to a lower version upgrade if your controller is ide you must h caution software upgrades on unvalidated virtualbox versions may result in a corrupted and unrecoverable litmus edge instance litmus edge supports oracle virtualbox versions up to version 7 2 0 upgrade paths refer to the following table for specific upgrade paths depending on your current version the general upgrade path is earlier litmus edge version > 3 5 6 > 3 11 6 > latest litmus edge version important before upgrading, review the list of planned docid\ er7j0mogtlktbxyupdcd so that you can migrate to any recommended replacement drivers current version latest version ( 4 0 3 ) 3 2 x 3 2 3 > 3 2 8 > 3 2 11 > 3 2 12 > 3 5 6 > 3 11 6 > 3 16 11 3 3 1 and 3 3 2 3 5 6 > 3 11 6 > 3 16 11 3 5 4 and 3 5 5 3 5 6 > 3 11 6 > 3 16 11 3 5 6 3 11 6 > 3 16 11 3 11 0 to 3 11 5 3 11 6 > 3 16 11 3 16 x 3 16 11 3 16 11 4 0 3 litmus edge litmus edge manager compatibility refer to the following table to review which versions of litmus edge and litmus edge manager are compatible litmus edge version (right) 3 0 x 3 1 x 3 2 x 3 3 x 3 5 x 3 11 x 3 16 x litmus edge manager version (below) 2 x yes yes yes yes yes yes yes upgrade litmus edge you have three options for upgrading litmus edge uploading a local file this is the recommended method upgrading through litmus edge manager downloading an upgrade file choose this when the first two methods are unavailable uploading the litmus edge upd file in a chrome browser can sometimes cause an out of memory error if this occurs, use a different browser or the download with url option in litmus edge backup checklist for backup purposes, you have the option of downloading a backup while doing an upgrade all configurations and settings are maintained and carried over after upgrading to a new version download all tags in a csv file from devicehub > tags see docid\ qm0urcltmysimhm2 5kmx download flows files from flows manager see docid\ zdgqja b11ojg 5oqxsuc export all flows from your analytics groups see docid\ xkf9tncbgiuw9sg6jrosr for more information export the opc ua hierarchy configuration json file from the opc > hierarchy pane see docid 7 tx2bcyluop6qlsllhyl for more information create a template from the template tab in system > backup / restore see the download a template section in docid\ hzrdtg9aqwzvnwg mr 9f create a support bundle from the support section in system > support see docid\ vm0do5mirm8msdfy4lw4q make a backup of your system from the backup / restore configuration section in settings > backup / restore see docid 0vq7trdzovh1ersgzpkxm option 1 upload local file this is the recommended upgrade method before you begin verify the current software version running on litmus edge in system > info under the general section download the correct version of the upd file you want to upgrade to from the https //portal litmus io/ if needed, review the upgrade paths section above upload a new version of litmus edge software once you have the correct upd file, complete the following steps to upload it to your litmus edge instance to upload a new version of litmus edge in litmus edge, navigate to system > device management the device management pane appears from the software update section, click upload file select the upd file and click open click ok follow the prompts to download a backup before proceeding with the upgrade you have the option to skip the downloading of a backup but is not recommended the software loads and installs the progress of the upload will display once finished, the system reboots once the system has restarted, close your browser and open the browser again clear your browser cache log in to litmus edge and navigate to system > info verify the software version is the updated version option 2 upgrade through litmus edge manager if you have access to litmus edge manager, see the following for upgrading remotely docid\ i24b2shva4eeoxupftj m option 3 download upgrade file if the two options above are not available, then you can download the upgrade file from a url before you begin visit https //portal litmus io/ to download the correct upd file locally to your computer and get the checksum value you will need then, upload the file to your preferred file storage service you will use the url to access the file when entering the download url in litmus edge download the upgrade file in litmus edge to download the upgrade file in litmus edge in litmus edge, navigate to system > device management the device management pane appears in the software update section, click download from url the download software update dialog box appears enter or paste the download url and checksum value in the required fields then, click start download when the download successfully completes, the file displays in the update files section for the downloaded file, click update follow the prompts to download a backup before proceeding with the upgrade you have the option to skip the downloading of a backup but is not recommended