Backup system to file

Create a backup of the device's configuration and data. The backup file is saved to a filesystem on the device, and can be retrieved using any of the file access methods such as the web interface.

The backup file can be restored using the Operations / Restore system from backup file command.

Command parameters

  • contents - Select the data to include in the backup file.

Properties

Filesystem

The filesystem that the backup file will be saved to.

  • Data type: reference path
  • References instances of: Storage / Filesystems
  • Configuration
  • Required

CLI: (cli)> run system operations backup filesystem <value>

Filename

The name of the backup file to create on the filesystem.

The filename will have the following patterns substituted:

  • ${serial} - The device's serial number.

  • ${mac} - The device's primary MAC address.

  • ${class} - The device's model name.

  • ${version} - The version of the firmware that the device is currently running.

  • ${date} - The date string in YYYYMMDD format.

  • ${timestamp} - The time in YYYYMMDD-HH-MM-SS format.

  • Data type: string

  • Default: backup-${serial}-${timestamp}.bin

  • Configuration

  • Required

CLI: (cli)> run system operations backup filename <value>

Encryption

Encrypt the backup file to secure sensitive device information.

OptionLabelDescription
noneNoneDo not encrypt the backup file.
passwordPasswordEncrypt the backup file with a password. The password must be provided when restoring the backup file to a device.
  • Data type: string select
  • Default: none
  • Configuration
  • Required

CLI: (cli)> run system operations backup encryption <value>

Password

The password to encrypt the backup file with.

The password must be provided when restoring the backup file to a device.

  • Data type: string
  • Configuration
  • Required

CLI: (cli)> run system operations backup password <value>