Back up the system

The File System Backup page enables you to schedule backups of the system configuration. You can perform one-off or regularly scheduled backups to local or remote destinations, and you can also restore backups.

There are two key backup tasks relating to:

  • Web Administration Interface settings (users, groups, access control, backup tasks, module configuration) backup
  • System backup

The WAI settings backup can be used to duplicate WAI module settings across multiple machines in the same environment. For example, if you configure a new user with restricted WAI module access, you can duplicate that configuration across multiple appliances using the WAI settings backup.

The system backup utility wraps key system configuration files into a tar and gzip compressed file. The files backed up contain configurations related to the:

  • Firewall
  • Clock, timezone and NTP
  • Network settings
  • sysctl parameters
  • API Gateway configuration and settings

The system backup can be used to aid in server reconfiguration in the case of total failure requiring reinstallation, for example, due to hardware failure, or some disaster scenario. You should store the system backup remotely.

To back up other files or directories, you can create your own backups (see Create a new backup). For more information on the critical file systems that you should back up, see the API Gateway Administrator Guide.

Set up system backup

The appliance system backup package is preinstalled on the API Gateway Appliance 7.5.3 release. No additional installation steps are needed.

Select Filesystem Backup to see the WAI settings backup and system backup tasks.


By default the system backup is configured to backup the files locally to /opt/backups/system-backup.tar.gz. It is configured (but not scheduled) to run every Sunday night at 2:13 am. Change this to a remote backup and either run it after any system adjustments, or schedule it to run automatically at a suitable time for your environment.

Follow these steps:

  1. To edit the backup task, click the /opt/backups/sysbackup link in the Directory to backup column.
  2. Edit system backup
  3. Select the Host option, and enter the IP address or host name of the host, along with a user, and a file name for the backup.
  4. Select SSH as the Remote backup command.
  5. Enter the password for the remote user in the Password for SSH/FTP login field.
  6. Click the green arrow next to Backup schedule to enable scheduled backup.
  7. Backup schedule
  8. Select Enabled, at times chosen below. Times can be edited, or left at 02:13 every Sunday.
  9. Click the Save button.

The Filesystem Backup page shows the modifications. To take an immediate backup, click Backup.. in the Action column.

Create a new backup

To create a new backup job, perform the following steps:

  1. In the Add a new backup of directory field, enter the full path to the directory that you want to back up.
  2. Click the Add a new backup of directory button.
  3. On the Add New Backup form, enter any additional paths to back up in the Directories to backup field.
  4. In the Backup to section, you can select File or tape device to save to a file on the same system. In the adjacent field, enter a path such as /backup/myfiles.tar, or if you have an attached tape drive, enter the path of the tape drive (for example, /dev/st0). Alternatively, select the Host option, and enter a remote host name, login name, and remote file in the adjacent fields. Remote backups are preferable in most cases because they can be restored if the system being backed up completely fails.
  5. If performing a remote backup, use the Remote backup command field to select the protocol for transferring the backup. The default SSH is most commonly used, but FTP is a suitable alternative if you do not have an SSH login on the remote system.
  6. If backing up over SSH or FTP, you must enter a password in the Password for SSH/FTP login field. You can omit this if the root user on the source system has its .ssh directory set up to allow logins without password as the destination user.
  7. Most of the fields in the Backup options section can use their defaults. The only exception is Compress archive, which should be set to Yes, with gzip or Yes, with bzip if your backup is not to a tape drive.
  8. In the Backup schedule section, for the backup to be run on a regular schedule, select the Enabled, at times chosen below.. option, and enter an email address to notify in the Email scheduled output to field.
  9. Select a schedule to run from the time/date chooser. Ctrl-Click to select or deselect minutes, hours, days, and months.
  10. Click the Create button at the bottom of the form.

Run a backup

When you have defined a backup job, you can start it by clicking the Backup.. link in the Action column on the right of the Scheduled Backups table. This starts the job as a foreground process so that you can view its progress in the browser.

Backup jobs that run on a regular schedule are run in the background. These are displayed on the File System Backup page under the Running Backup Jobs header. By clicking a link in the Action column, you can terminate running jobs, or if required, signal to the job that a new backup tape is available.

Edit a backup

When a backup job has been defined, you can edit it by clicking the source directories in the Directory to Backup column of the Scheduled Backups table on the File System Backup page. This displays the form on which you can adjust all of the backup job settings.

To delete a backup job, select it on the File System Backup page, and click the Delete Selected Backups button.

Restore a backup

If disaster strikes, you can restore backups created using the File System Backup page, or even backups made manually. To restore a backup, perform the following steps:

  1. Select the backup job to restore in the Scheduled Backups table.
  2. At the bottom of the form, click the Restore backup of filesystem button. This displays the Restore Backup form.
  3. To restore only some files in the backup, in the Files to restore field, select the Listed files option, and enter a space-separated list of paths in the text box. These are typically absolute paths (for example, /etc/passwd/).
  4. Enter a destination path in the Restore to directory field. You can enter / to restore to the original paths, or something like /tmp to restore elsewhere before manually verifying the files and copying them to their correct locations.
  5. Change the Only show files in backup option to No to restore files. When this is set to Yes , instead of restoring, the WAI displays the files that the backup contains.
  6. Click the Restore Backup Now button.

Restore a backup on a new system

To restore a system backup file on a new system follow these steps:

  1. Log in as root to the new system.
  2. Stop the API Gateway service if it is running.
  3. Copy the system backup .tar.gz file to the new system.
  4. Run the script, giving the name of the backup file as an argument. For example:
  5. my-system-backup.tar.gz 
  6. Reboot the system for the changes to take effect.
Note   This might change network settings.

Related Links