Restoring from a microSD card backup

Restoring from a microSD card backup returns the controller to the state it was in when the system made the backup. You may restore to a controller other than the one on which the backup was made, provided that the target controller is the same model. The restore procedure does not require access to Workbench. Launch the System Shell and use the shell menu to initiate a back up the data to the microSD card from the controller's Embedded MultiMediaCard (eMMC), where it is stored.
Prerequisites: You have a MicroSD card with a backup.
  1. Connect your PC to the Debug serial port using a USB-C cable.
  2. Log in to System Shell menu.
    The Restore Menu opens. If more than one backup exists, the Restore Menu lists the files.
    Restore Menu
    ----------------------
    1. backup-20230502141937-v1
    Select Backup file for Restore from list(Eg: 1) : 1
    Selected backup file for restore: backup-20230502141937-v1
  3. Select the backup file to restore from the list and press Enter.
    The System Shell displays the file to restore and prompts with:
    Is backup passphrase same as the system passphrase  [Y/n]? n
    Enter the passphrase used to encrypt the backup :
    
    Confirm passphrase :
  4. Do one of the following:
    • Enter Y if the backup passphrase is the same as the system passphrase.
    • Enter n if the backup passphrase is not the same as the system passphrase.
    The restore operation resets the controller to its factory state, then restores the backup.
    Restore operation will take several minutes and performs a few reboots when required
    
    Restore operation will initiate after reboot
    Waiting for device to reboot
    Press ENTER to continue
    Importing Backup
    Snapshot backup imported
    Snap backup imported
    System Configuration backup imported
    Restore operation is ongoing
    Wait for system installation to complete    
    <-NOTE:  There is currently a long wait with no user feedback after this step
    Restoring snapshot of core20
    Restoring snapshot of hbt-imx-kernel
    Restoring snapshot of network-manager
    Restoring snapshot of snapd
    Restoring snapshot of tridium-atlas-gadget
    Restoring snapshot of tridium-atlas-protod
    Restoring snapshot of tridium-atlas-updatemgr
    Restoring snapshot of tridium-niagara
    Restoring snapshot of tridium-usermgr
    Restoring system configuration
    Restore Succeeded
    Rebooting system
    After the backup is restored, the system reboots. This process can take up to five minutes or longer.