Back up and restore files from the XBee Gateway web interface
The Backup/Restore page allows you to back up and restore the following device configuration settings to a file:
- XBee Gateway
- (Optional) XBee RF module
Back up files
To back up files from the XBee Gateway web interface:
- Access and log into the web interface.
- Click Administration > Backup/Restore.
- In the Volume Information section, review the amount of free space available.
- If you want to save the configuration settings for the XBee RF module along with the device configuration settings, select the Include XBee gateway radio settings in the backup file option.
- In the Backup field, enter the name of the back up file.
- Click OK to start the process.
Restore files
To restore files from the XBee Gateway web interface:
- Access the XBee Gateway web interface. You are required to log in to the web interface.
- Click Backup/Restore under Administration.
- Click Choose File in the Restore Configuration section.
- Select the configuration file you want to restore.
- Click OK.
- Click Restore to restore the configuration from the selected file.
Backup/Restore page
The following fields and buttons appear on the Backup/Restore page:
Volume Information section: Displays information about the user file system, /userfs.
- Current Directory: The backup file is temporarily saved in this directory on the device. Note that navigating to the file system is not possible on this page. To go to the file system, click File Management under Administration and then go to the file system.
- Free Space: The amount of free space on the user file system. The typical size of a backup file is about 8 KB.
Backup Configuration section: Downloads the gateway configuration file through the web browser and allows you to save the file on your computer.
- Include XBee gateway radio settings in the backup file: If enabled, the configuration settings for the XBee RF module are saved along with the device configuration settings.
- Backup: The name of the backup file. The default file name is backup.cfg. You can change the file name from the save file dialog box. Any name is allowed.
Restore Configuration section: Restores configuration settings from a backup file on your computer or a server.
- Choose File: Opens a browse dialog for locating and selecting the appropriate configuration file.
- Restore: Click Restore to restore the configuration from the selected file.
Errors
Any errors that occur during the restore process appear in a red banner at the top of the Backup/Restore page. Typically, the only reason an error occurs is if a user has modified the backup file. The following list provides some of the possible error messages.
- Invalid file contents: The file contents are not a valid backup format. This may be caused by invalid XML syntax.
- Element set_setting has extra content (name): The settings group name is not recognized.
- Element set_setting failed to validate content (name): Incorrect value for setting name.
- Other RCI errors are possible, but are less common.