CLI Commands for Backups

Device backup is integrated with the existing system backup CLI.

Additional parameters allow you to specify either the fabric name or list of devices for which to run a backup.

Showing and Updating Backup Settings

There are commands for showing and updating backup settings.

Showing Backup Settings

efa system settings show lets you display all the system settings that have been configured.

Example

efa system settings show
+----------------------------+-------------+
|          SETTING           |   VALUE     |
+----------------------------+-------------+
| Max Backup File Limit      | 5           |
+----------------------------+-------------+
| Max Supportsave File Limit | 5           |
+----------------------------+-------------+
| Backup Schedule            | 0 0 * * *   |
+----------------------------+-------------+
| Remote Server IP           | 10.20.241.7 |
+----------------------------+-------------+
| Remote Server Username     | root        |
+----------------------------+-------------+
| Remote Server Password     | ****        |
+----------------------------+-------------+
| Remote Server Directory    | /root/vinod/|
+----------------------------+-------------+
| Remote Transfer Protocol      | scp      |
+-------------------------------+----------+
| Periodic Device Config Backup | yes      |
+-------------------------------+----------+
--- Time Elapsed: 831.836375ms ---

For more information, see efa system settings show in the ExtremeCloud Orchestrator Command Reference, 3.3.1 .

Updating Backup Settings

There are settings for configuring remote server details where the backup is copied. In case remote server details are missing, the backup is copied on the same server where XCO is installed, which is also the current behavior of the system backup.

Passwords are encrypted using an AES algorithm and stored in the database.

Remote server validation is performed to validate whether the provided details of a remote server are valid or reachable (if you enter only an IP address, the application checks in the database for the remaining parameters - if they are missing, then it is treated as an error). All four parameters (IP, username, password, and directory-path) are expected for validation, either from the user or the database.

Transfer of a backup archive on a remote server is done through the SCP protocol.

The efa system settings update command lets you make the updates.

Example

efa system settings update --remote-server-ip ip/ipv6 10.20.241.7 
--remote-server-username root --remote-server-password pass --remote-server-directory /root/vinod/  
Setting Update Successful
--- Time Elapsed: 148.800033ms ---
Resetting System Backup Settings

You can reset the updated system backup settings to default values.

The efa system settings reset command lets you make the updates.

Example

efa system settings reset --max-backup-files 
Reset System Settings is Successful

For more information, see efa system settings reset in the ExtremeCloud Orchestrator Command Reference, 3.3.1 .

Backup

To perform the backup, use the efa system backup command with options for specifying fabric or device details.

For more information, see efa system backup in the ExtremeCloud Orchestrator Command Reference, 3.3.1 .

Backup Scenarios

The following backup scenarios showcase the use of different options with the efa system backup command.

Run system backup on remote

efa system backup --remote
Generating backup of EFA...
Backup Location: /var/log/efa/backup/EFA-3.1.0-110-2022-03-28T11-37-00.936.tar
--- Time Elapsed: 5.741750131s ---

Run system backup without device configuration backup

efa system backup --remote
Generating backup of EFA...
Backup Location: root@10.20.241.7:/root/vinod/EFA--3.1.0-110-2022-03-28T11-37-00.936.tar
--- Time Elapsed: 5.741750131s ---

Run system backup by taking configuration backup of all devices that are part of the fabric specified

efa system backup --fabric default --remote
Generating backup of EFA...
Backup Location: root@10.20.241.7:/root/vinod/EFA--3.1.0-110-2022-03-28T11-37-00.936.tar
--- Time Elapsed: 5.741750131s ---

Run system backup by taking configuration backup of all fabrics and its devices

efa system backup –-fabric-all --remote
Generating backup of EFA...
Backup Location: root@10.20.241.7:/root/vinod/EFA--3.1.0-110-2022-03-28T11-37-00.936.tar
--- Time Elapsed: 5.741750131s ---

Run system backup by taking configuration backup of all devices that are specified

efa system backup --device-ip 10.20.1.2,10.20.1.3,10.20.1.4 --remote
Generating backup of EFA...
Backup Location: root@10.20.241.7:/root/vinod/EFA--3.1.0-110-2022-03-28T11-37-00.936.tar
--- Time Elapsed: 5.741750131s ---

Error message: Fabric does not exist

efa system backup --fabric default --remote
Generating backup of EFA...
Backup Location: root@10.20.241.7:/root/vinod/EFA--3.1.0-110-2022-03-28T11-37-00.936.tar
Backup is partially success: 
    Fabric does not exist 
--- Time Elapsed: 5.741750131s ---

Error message: Device not found

efa system backup --device-ip 10.20.1.5,10.20.1.6 --remote
Generating backup of EFA...
Backup Location: root@10.20.241.7:/root/vinod/EFA--3.1.0-110-2022-03-28T11-37-00.936.tar
Backup is partially success: 
    Device 10.20.1.5 not found
--- Time Elapsed: 5.741750131s ---

Error message: Operation not allowed

efa system backup --device-ip 10.20.1.2,10.20.1.3 --remote
Generating backup of EFA...
Backup Location: root@10.20.241.7:/root/vinod/EFA--3.1.0-110-2022-03-28T11-37-00.936.tar
Backup is partially success: 
    Devices [10.20.1.2] failed to get config backup as its locked for configuration change by process [Firmware download]. 
--- Time Elapsed: 5.741750131s ---

Backup Schedule

Existing features of the wider backup schedule work here, too. Additionally, the backup gets SLX configuration backup of all those devices that are associated with a valid fabric.