XCO System Backup and Restoration

The backup process saves XCO data, including the database, certificates, and multi-access network configuration. The process does not back up northbound certificates.

Manual Backup and Restore

XCO supports backup and restore across the same IP modes. A warning message appears during restore operation.

The following table describes the support matrix for backup and restore operation across the IP modes:

Backup Restore Support
Dual IPv6 No
Dual IPv4 No
IPv4 IPv6 No
IPv4 Dual Yes
IPv6 IPv6 No
IPv6 IPv4 No
IPv4 IPv4 Yes
IPv6 IPv6 Yes
Dual Dual Yes
The backup process creates a backup tar file. You can select from all saved tar files during the restore process. The tar files are saved to one of the following locations.
  • Server: /var/log/efa/backup
  • TPVM: /apps/efa_logs/backup

A backup generated on one XCO system can be restored on another system.

For more information, see Back up and Restore the XCO System.

You can use the efa system backup-list command to see the backup files that are available to use in a restore operation. For example:
$ efa system backup-list
+----+-----------------------------------+---------+----------------+
| ID    | File                           | Version | Generated By   |
+----+-----------------------------------+---------+----------------+
| 1     | EFA-2020.08.20-20.26.46.tar    | 2.3.0-1 | User           |
+----+-----------------------------------+---------+----------------+
| 2     | EFA-2020.08.20-20.27.29.tar    | 2.3.0-GA| System         |
+----+-----------------------------------+---------+----------------+
--- Time Elapsed: 183.69386ms ---

Periodic Backups and Configuration

XCO periodically backs up the system (12 AM by default, but configurable). During the backup process, all the services are locked and APIs return the message "Service is Locked with reason backup". Therefore, you cannot see the location under dropdown for Device Discovery.

The periodic backup process creates a backup tar file that is saved to the same location as the manual backup files. When new backup and supportsave files are created, according to the age of the backup files and maximum number of backup files to save, the system deletes the saved system-generated backup files, supportsave files, and manual backup files.

You can use the efa system settings update command to determine the backup schedule and to change the maximum number of backup files to save.
  • Default backup schedule: 0:*:*:*, meaning every day at midnight.
  • Default maximum number of backup files: Five backup files and five supportsave files.
For more information, see the ExtremeCloud Orchestrator Command Reference, 3.3.1 .

You can use the efa system settings show command to view the current backup settings.

Tip

Tip

You can use the efa system cleanup REST API to delete a specified backup or supportsave file. This feature lets you delete files before they are automatically deleted.

You can use the efa system settings reset command to reset the backup system settings to default values.

Backups During Upgrades

The upgrade process of XCO also backs up the XCO system to recover data if the upgrade fails. For more information, see "Recover from an Upgrade Failure" in the ExtremeCloud Orchestrator Deployment Guide, 3.3.0 .

Logs

Logs for backup, restore, and supportsave operations are saved to the following locations:
  • Server: /var/log/efa/system and /var/log/efa/monitor
  • TPVM: /apps/efa_logs/system and /apps/efa_logs/monitor

The REST APIs for backup, restore, and supportsave are part of the Monitoring Service and can be accessed via port 8078. The logs for the REST APIs are saved to the <log_dir>/monitor/ location.

9037858-01 RevAA