Backup and restore

Prev Next

You can back up the AppGate ZTNA system using one of the following methods:

  • Create a virtual machine snapshot, which saves the appliance configuration and file system.

  • Use sdpctl to perform a backup, then use the cz-restore utility with the appropriate backup file to recreate an equivalent system on a new, non-activated appliance.


Backing up a Collective using sdpctl

sdpctl performs an orchestrated backup of some or all appliances in a Collective. It remotely triggers the backup and downloads the files to the local machine. When complete, sdpctl places the backup files in a folder named appgate_backup_xxxxx in the directory where you ran sdpctl. One file is created for each appliance specified.

NOTE

Before starting the backup, verify that you have sufficient disk space. sdpctl estimates the required disk size and proceeds only if enough space is available.

Before restoring an appliance, note the passphrase you set in the Controller admin UI on the Global Settings page (Settings > Global Settings > General Appliance Settings). Backup files are encrypted with this passphrase. This allows a user without elevated privileges to perform a backup and download the files without being able to access the backup data. If the passphrase is lost, the backup files cannot be used.

Restoring an appliance

To restore an appliance:

  1. Upload the appropriate backup file to the appliance using scp, sftp, or another suitable method.

  2. Run the restore process:

   sudo cz-config restore <backup_file>

The command prompts you for the backup passphrase.

A backup can be restored on an appliance running the same API version as the backup file, or up to two API versions higher. For example, a backup taken on API version 19 can be restored on an appliance running API version 19, 20, or 21.

cz-restore utility (internal)

Use the cz-restore utility with the backup file on a new, non-activated appliance to recreate an equivalent system.

Before performing a restore, note the following:

  • All current data on the appliance is permanently destroyed.

  • The restore version follows the same rules as the upgrade version rules. For example, if version A can only be upgraded to version B, a restore can only be applied to version A or version B.

Restoring by function

The restore process differs depending on the appliance function:

  • Single Controller. Restores from a backup file and creates a functional, single Controller.

  • Gateways. Gateways are stateless. The recommended method for restoring a Gateway is to re-seed the appliance from the Controller through the Controller admin UI.

  • Additional Controllers. Restore additional Controllers only when no Controllers are working. This creates a functional, single Controller. Other Controllers still shown in the admin UI must be re-enabled and re-seeded. Go to System > Appliances, create any additional Controllers required, and download the required seed files. If one Controller is still working, deactivate and re-seed to restore any additional Controllers.

The default restore assumes no passphrase was used. To include a passphrase, use the --passphrase-file option described below.

To perform a restore:

  1. Sign in to the Controller using SSH.

  2. Run the restore command:

sudo cz-restore [OPTIONS] FILENAME

Option

Description

-h, --help

Prints help and exits.

--passphrase-file

Specifies a file containing the passphrase. For example, add the passphrase text to a file such as /etc/restore.

--keep-host-network

Uses the current network configuration instead of the configuration in the backup file