How to Backup and Restore IP Fabric via CLI

Warning

For performing a backup, there needs to be more than 50% free space on the root filesystem.

You can check the free space with the df -h command in the IP Fabric VM’s shell.

Important

Backups are encrypted with the osadmin user password configured with IPF CLI Config. If you lose the osadmin user password, the backups are also lost!

Username and Password Character Restrictions

Username must match the following regular expression: /^[A-Za-z0-9_][A-Za-z0-9\._-]*\$?$/

It must start with one of these characters: A-Z a-z 0-9 _
It may contain any of these characters: A-Z a-z 0-9 ._-
$ is only allowed once at the very end.

Password must match the following regular expression: /^[A-Za-z0-9\.,\/_@%^:=+ -]*$/

It must contain only these characters: A-Z a-z 0-9 .,/_@%^:=+ -

Backup via CLI

IP Fabric offers two options for backing up the appliance data:

Local backup
Remote backup (FTP, SFTP)

To configure the destination server and backup options, go to the main GUI and navigate to Settings → System → Backup & Maintenance. For more details, see Schedule System Backup.

Warning

Ensure that the backup destination and credentials are correctly configured in the main GUI under Settings → System → Backup & Maintenance. These values cannot be adjusted using the CLI backup/restore script.

Trigger a Backup Manually (On-Demand)

To initiate a manual (on-demand) backup, execute the following command in the IP Fabric CLI:

sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -b

Below is an example of a successful local backup output triggered via CLI:

Example

root@system-backup:/# sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -b
find: ‘/root/.cache/duplicity/’: Permission denied
Nov 18 14:27:00 [INFO] Backup destination: local
Nov 18 14:27:00 [INFO] Storage status: OK
Nov 18 14:27:00 [INFO] ** Backup has started **
Nov 18 14:27:00 [INFO] Cleaning up backup
Nov 18 14:27:00 [INFO] Dumping up ArangoDB
Nov 18 14:27:06 [INFO] Creating backups list
Nov 18 14:27:14 [INFO] ** Backup has finished **
Nov 18 14:27:14 [INFO] Removing temp backup files.

Restore via CLI

To restore a backup, perform the following two steps:

Configure the backup server in the main GUI, navigate to Settings → System → Backup & Maintenance. For more details, see Schedule System Backup.

Warning

Ensure that the backup destination and credentials are correctly configured in the main GUI under Settings → System → Backup & Maintenance. These values cannot be adjusted using the CLI backup/restore script.

Have a list of available backups ready for restore.

Backup List Format

Any backup list has the following format:

## LIST ##
<item to restore>; <date&time of the item to restore>
## LIST END ##

Example of a Full Backup List

## LIST ##
backup-Full; 2024-11-18T13:49:28
## LIST END ##

You can restore:

Data & all system services – This option restores the database, snapshots, and system files. It is useful for recovering from general system failures or upgrade issues.
Database only – Only the database is restored. This option is sufficient for database failures or accidental database drops.
Specific snapshot – A specific snapshot can be restored.

Restore Data & All System Services

To restore data & all system services (full backups, databases, snapshots), use the following command format:

sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -r backup-Full -d <date&time of the backup>

To list full backups for restoration, run the following command in the IP Fabric CLI:

sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -l backup

List Example

root@system-backup:/# sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -l backup
Nov 18 13:54:02 [INFO] Backup destination: local
Nov 18 13:54:02 [INFO] Storage status: OK
Nov 18 13:54:02 [INFO] Removing temp backup files.

## LIST ##
backup-Full; 2024-11-18T13:49:28
## LIST END ##

Restore Data & All System Services Command Example

sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -r backup-Full -d 2024-11-18T13:49:28

Restore Database

To restore only the database, use the following command format:

sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -r arangodb-xxx -d <date&time of the backup>

To list database backups for restoration, run the following command in the IP Fabric CLI:

sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -l arangodb

List Example

root@system-backup:/# sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -l arangodb
Nov 18 13:54:30 [INFO] Backup destination: local
Nov 18 13:54:30 [INFO] Storage status: OK
Nov 18 13:54:30 [INFO] Removing temp backup files.
Nov 18 13:54:31 [INFO] Local backup DB same as online list

## LIST ##
arangodb-zsindylek-mq-70-20241118-1349-7_0_4+0; 2024-11-18T13:49:28
## LIST END ##

Restore Database Command Example

sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -r arangodb-zsindylek-mq-70-20241118-1349-7_0_4+0 -d 2024-11-18T13:49:28

Restore Specific Snapshot

To restore only one specific snapshot, use the following command format:

sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -r snapshot-xxx -d <date&time of the backup>

To list snapshots for restoration, run the following command in the IP Fabric CLI:

sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -l snapshots

List Example

root@system-backup:/# sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -l snapshots
Nov 18 13:54:14 [INFO] Backup destination: local
Nov 18 13:54:14 [INFO] Storage status: OK
Nov 18 13:54:14 [INFO] Removing temp backup files.
Nov 18 13:54:15 [INFO] Local backup DB same as online list

## LIST ##
snapshot-e71519b9-b7fc-488d-841f-67983a12f6af; 2024-11-18T13:49:28
snapshot-e09c6b70-b232-4dd1-bec9-97ad1f96d40c; 2024-11-18T13:49:28
snapshot-d49e9715-3eb3-4b21-b41f-1ef9b6c5bead; 2024-11-18T13:49:28
snapshot-ab7e4ed6-e07f-47d0-8d95-a7581ec29acc; 2024-11-18T13:49:28
snapshot-45cf7507-ab1e-42f2-a18d-0ae26d5f4e61; 2024-11-18T13:49:28
snapshot-41844ce8-cc7a-4b60-b4a5-c59149e42d69; 2024-11-18T13:49:28
snapshot-12dd8c61-129c-431a-b98b-4c9211571f89; 2024-11-18T13:49:28
## LIST END ##

Restore Specific Snapshot Command Example

sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -r snapshot-e71519b9-b7fc-488d-841f-67983a12f6af -d 2024-11-18T13:49:28