deviceWISE Backup Utility

The deviceWISE Backup Utility provides an alternative to using the Workbench's node backup feature for nodes accessed through a network scan.

You can download it from the Management Portal at: Developer -> Resources -> Build-Number -> Telit -> Workbench -> deviceWISE_Backup_Utility

The utility consists of a configurator used to configure what gets backed up and when, and execution programs to perform those backups on a schedule or on demand.

Configurator

The configurator consists of the following:

1. Configuration Tab – general properties
   • User – user name to use for login into the node
   • Password – password for login
   • Backup Directory – where to put backups
   • Filename Format – Format to use for the backup files, can include subdirectories. See section below.
   • Example Format – An example of how a filename created by the defined format will look
   • Backups to Retain – how many backup files to retain. Oldest files will be deleted
   • Backup Mode – type of backup to perform:
     • Zipped Database – deviceWISE configuration database files from the node placed into a zip file
     • Export Backup – Equivalent to running a backup for a node using the Workbench. Produces a .dbk file that can be used by the Workbench Restore feature.
     • Both Zipped and Export – Both of the above, will retain n of each as set by the "Backups to Retain" field.
   • Run as Service - Available on Windows only. Will run the scheduled backups as a system service once the configuration has been saved.


2. Schedule Tab – defines the schedule
   • Use Internal Scheduler – Uncheck if you don't want scheduled backups or want to use an external scheduler to perform backups.
   • Time – time of day to run the backup
   • Day – one or more days when to run
   • Week – which occurrence of day to run
   • Month – months to run
     


3. Node list – list of nodes to be backed up
   1. Context menu available for performing some actions (right click in list)
      


4. Button Actions
   • Scan – scan network for nodes;
   • Save – save current settings, stored in "backup.properties" in the same directory;
   • Backup Now – run a backup of the listed nodes immediately;
   • Close – close the configuration tool.


5. Tools Menu
   • Documentation – Open help documentation
   • Show Diagnostic Log - Used for tracking results of a backup execution in the configurator.
   • About - Product information
   • Close – close the configuration tool.

On non-windows platforms the configurator can be launched using launchBackupConfig.sh

Filename Format

The filename used for backups can be customized to include node as well as date and time information.

The format is fully editable, and some predefined formats are included:

Filename formats should always include a time element and a node/ip element to ensure that filenames are unique between nodes and across multiple backups.

The full set of formatting characters is listed below.  This table is also viewable as tooltip text for the format field.

All alphabetic characters are reserved for formatting purposes. Any custom plain text should be enclosed in single quotes as shown in the last predefined format example above.

Formatting characters

Performing Backups

Once a configuration has been saved, there are several options used to execute backups. The listed executables are for Windows platforms. Comparable scripts (*.sh) exist in the install directory for non-Windows platforms. Running on a non-windows platform requires a separate installation of Java 11 or higher.

Backup Run Now

Backup Run Now is found in the installation folder, named DWBackupRunNow.exe (launchBackupRunNow.sh for non-Windows platforms).

When run it will immediately execute the backups as defined in the configuration and stored in backup.properties. It will display the mode it is in, the nodes that will be backed up, and the status of the backup. It will then exit.

A schedule does not need to be configured to use this utility. This is useful if you want to use an external scheduler to schedule backups or simply run manually on demand.

Backup Console

Backup Console is found in the installation folder, named DWBackupConsole.exe (launchConsole.sh for non-Windows platforms).

When run it will schedule the backups as defined in the configuration and stored in backup.properties. It will display the mode it is in, the nodes that will be backed up, and when the next ten executions of the schedule will fire.

Note this program requires the command line it is run from to remain open for it to continue to run.

It may also be run with a single parameter runonce which will have the same effect as using the DWBackupRunNow utility.

It can also be run with a parameter kill, which will stop any running instance of the backup utility.

Backup Service Launcher - Windows only

Backup Service Launcher is found in the installation folder, and is named DWBackupService.exe. It will install the backup service to perform backups as defined by the schedule.

It does not require the command line window to remain open.

It can be run without parameters or with the stop parameter to uninstall the background service.

Backup Daemon - Non-Windows Platforms

Backup Daemon is found in the installation folder, called using launchDaemon.sh. It behaves the same as the backup console program, except that it executes in the background.

It does not require the command line window to remain open.

Logging

Logs of backup activity will be placed in the logs directory within the installation directory.