Configure backup on a Gateway appliance - version 1.10 and newer

You use the private network command line interface (CLI) to perform backup configuration and one time backup on a Gateway appliance version 1.10 and newer. Local or remote terminal access is required to create and maintain Gateway backups.

Backup files are stored to the local file system. The Gateway is automatically backed up on a weekly schedule. See Backup schedule

Backup files can be stored on a remote system of your choice, independent of the Gateway appliance, as a one time or recurring task.
See Mount a remote filesystem on the Gateway appliance - version 1.10 and newer

Create a one-time backup

1. To access the private network CLI:

   1. Connect a computer to the same private network as the Gateway appliance. 
   2. Use an SSH client to log in to the Gateway CLI using your Gateway user credentials, default ssh port 22.
   3. Type backup run
      Output is displayed with the Gateway backup id, name, date, and other version information.

Backup files are stored locally on the Gateway server file system. From here, the file can be copied or configured for export to a remote file share.

Backup config options

Some aspects of the backup are configurable by adding the config parameter to the backup command.

View the backup configuration

backup config

View the backup configuration settings.

 

Press Tab after a command to see command suggestions.

 

Configure the backup password

You will be prompted for a new password to use for encrypting backups.

backup config --archive-password

Configure the backup destination

Set the directory used to store backup file contents.

backup config --destination <file path>

Configure the maximum number of backups to keep

Set the maximum number of backup entries to store before rotating older entries.

backup config --rotation <maximum number of backups to store>

Backup schedule

Set the schedule of backups. The default settings are to backup on Sunday at midnight each week.

--repeat accepts one of the following values: monthly, weekly, daily, or hourly.

--on accepts one of the following values when repeat is weekly: monday, tuesday, wednesday, thursday, friday, saturday, or sunday. When repeat is monthly it accepts the day of the month instead (see examples below).

--at accepts time in twelve or twenty four hour format with hours separated by a colon. Valid examples: 8:00am, 14:00, 2:00pm, or 03:00pm. 

Weekly backup example

Backup will run every Tuesday at 14:00 (2pm).

backup schedule --repeat weekly --on tuesday --at 14:00

Monthly backup example

Backup will run on the 15th of each month at 08:00 (8am).

backup schedule --repeat monthly --on 15 --at 8:00am

Daily backup example

Backup will run every day at 14:00 (2pm)

backup schedule --repeat daily --at 2:00pm

Hourly backup example

Backup will run every hour

backup schedule --repeat hourly

Disabling scheduled backup

Scheduled backup will be disabled

backup schedule false

Re-enabling scheduled backup

Scheduled backup will be enabled with the default backup schedule.

backup schedule true --repeat weekly