Manually Collecting a Gateway Backup
The easiest way to create a backup of the Gateway is using the Gateway Webpage.
- Go to the Config tab of the Gateway Webpage, and click on System > Backup/Restore.
The System Backup/Restore page will be displayed. Make sure the Backup tab is selected, then click Download Backup.
By default, this downloads a
.gwbkfile extension to your local file system in your Downloads folder.
Note: The Gateway Backup default filename will look like GatewayName_Ignition-backup-YYYYMMDD-HHMM.gwbk where YYYYMMDD-HHMM is the timestamp of when it was created.
In Windows and Linux, you can use the command-line utility to create a Gateway backup. To run the Command-line Utility, open a shell and enter the command below.
Go to the Config tab and click on System > Backup/Restore.
The System Backup/Restore screen will be displayed. Click on the Restore tab. Read carefully through the restoration settings, and check the ones you wish to enable.
Restore Disabled Checkbox
If you check the Restore Disabled box, the imported resources will be disabled upon restoration.
Click Choose File, then navigate to your Gateway backup file (*.gwbk). By default, all your Gateway backup files are saved in your Downloads folder unless you select another folder location to choose an exisiting Gateway Backup file (
*.gwbk) to restore.
- Choose your Ignition backup file (
.gwbk), and click Open.
- Click Restore at the bottom of the System Backup/Restore screen. The Gateway stops while restoring the backup file. When restoring is complete, the Gateway restarts itself to apply the restored settings. The Gateway Webpage is refreshed and your projects are loaded and your whole Gateway is restored in less than a minute.
The following table describes different Gateway restoration settings.
|Restore Disabled||Checkbox for toggling if the Gateway Backup file's contents such as projects, database connections, OPC connections, Tag Providers, etc will be disabled upon restore.|
|Disable Temp Project Backup||Checkbox for toggling if the projects directory will have a temporary backup created during the restore process.|
|Override Gateway Name|
Checkbox for toggling if the name of the Gateway should be overridden before the Gateway is restored.
|New Gateway Name||The name of the new Gateway. Requires "Override Gateway Name" to be enabled.|
In Windows and Linux, you can use the command-line utility to restore a Gateway backup. To run the Command-line Utility, open a shell and enter the command below. Refer to the Command-line Utility page for a complete list of 'gwcmd' options.