Backup

This function is the recommended alternative for the Backup process to be performed via the VM.
It is advised to perform the Backup using this function in Webconf on the Software Appliance.

On the Backup page, you can configure the backup behavior of your system:

trigger a manual backup
or schedule an automated backup.

A backup is a snapshot of the system at a specific point in time. This makes it possible to restore the device to a stable state if necessary.

It is therefore advisable to create regular backups to ensure that an up-to-date backup is always available.

Backups can be restored, allowing the appliance to be returned to the same state it was in at a specific date/time.

A backup contains the following data:

firmware configuration
system configuration (cluster, network, database, etc…)
internal database

No backup of the HSM or external databases will be created!

To create a backup, you must not be logged into Webconf as an OTP user.
See create an OAuth user account to create an OAuth user account.
Log in as OAuth user and remove the OTP user.

Do not restart or shut down the Software Appliance while the Backup is running.

Backup Status

Log in to your Software Appliance and open the Backup page.
The Backup Status section hosts the Backup Status Information table including:

Current Backup Status: Not Running/In Progress
Last Successful Backup: Timestamp of the last successful backup
Next Scheduled Backup Execution: Timestamp of the next scheduled backup or Schedule Disabled.

In addition, you will find information here in case a backup cannot be created.

Backup Settings

For the basic setup, refer to the following steps.

Backup Protection

For the Backup Protection it is mandatory to define a Domain Master Secret. This is a passphrase used for encrypting all backups.

The Domain Master Secret can only be set once. Therefore, keep a copy of it in a safe place for the entire lifetime of your Software Appliance.

Log in to the Software Appliance.
Open the Backup page.
In the section Backup Settings
click Set Domain Master Secret to open the corresponding form.
Enter the Domain Master Secret. Domain Master Secret must be at least 8 characters long!
Repeat the Domain Master Secret.
Click Set Domain Master Secret to confirm your entries.

Backup Filename (optional)

Use this field to specify a Backup Filename Prefix for your backup filename.

Log in to the Software Appliance.
Open the Backup page.
In the section Backup Settings under Backup Filename enter the prefix for the backup filename.
Click Save Settings to confirm your entries.

Backup Storage

Configure the storage location for backups in the Backup Storage Settings section.

Network File System (NFS)

To store the backup to a NFS located in your network and reachable for the Software Appliance the following NFS versions are supported:

NFS Version 4
NFS Version 4.1
NFS Version 4.2

Log in to your Software Appliance.
Open the Backup page.
In the section Backup Storage Setting you are requested to select the type of storage for the backup.
Storage Type:
None (default)
Network File System (NFS)
Select Network File System (NFS).
1. Enter the NFS URL pointing at the NFS server that will be used to store backups.
  Click Browse Storage to browse the backup location, or enter the entire path directly.
2. The storage browser opens.
  If applicable navigate to the path where the backup is to be saved.
  Therefore click on Directories to browse one level down
  or click .. One level up to return to the previous level.
3. All Storage Information is displayed on the right side of the window.
  Permissions: e.g. read, write
  Used Disk Space: xxx,x GB
  Remaining Disk Space: xxx,x GB
  Total Disk Space: x,xx TB
Click Use This Location to confirm your entries.

After a backup has been created, just return to the Storage Browser Backup Location and click on the backup you saved. In the Storage Information section a table is displayed with all Backup Details.