Director Console Backup

You can create multiple backups of the Director Console UI and restore them. The backup consist of the following Director Console entities:

• License and license management information

• Tasks status

• Hardware information

• Device count

• LDAP and ADFS Authentication information

• Director Console sessions

• Director Component settings information

• Uploaded certificates

You can also configure SFTP from the Director Console UI to store the backups.

Create a Director Console Backup

1. Log in as the root user.

2. Go to Settings >> Backup.

   

3. Enter a Backup Filename.

4. Select a Backup Mode.

   4.1. Select Backup Now to create a backup of the current state of the Director Console configuration.

   4.2. Select Schedule Backup:

   4.2.1. Select Daily, Weekly, or Monthly as the Schedule Backup Type.

   In the Weekly backup type, select the Weekly day when you want the backup to take place.

   4.2.2. Enter a Backup Run Hour (UTC).

   4.2.3. Enter a Backup Retention (Days). The application keeps your backup file for the number of days entered and deletes it after the retention period is complete.

5. Click Finish.

The Director Console UI backup is stored in the following format:

<entered_backup_filename>_<date_of_the_backup_taken><time_stamp>.tar.gz

Here, the date_of_the_backup_taken must be in YYYYMMDD format and the timestamp is in the HHMMSS format. For example: test_Backup_20191021083711.tar.gz

Restore a Director Console Backup

When you restore a backup, it replaces the existing configuration with the state when you took the backup.

• When you restore a backup, Director Console version must be the same as when you took the backup.

• When you restore a backup, Director Console also replaces the license management information with the information from when you took the backup.

If you want to restore backup files from the SFTP server, you must first save the backup files in the API server then copy the files in the Director Console backup directory using the following command as cmdr-admin:

upload-dc-backup <file_path>

Here, <file_path> is the path to the backup file on the API server.

1. Log in as the root user.

2. Go to Settings >> Restore.

3. Select the Restore () icon from the Action column of the backup you want to restore.

   • Every time you restore a backup, the Director Console UI restarts.

   • You can also restore the backups taken from the API in the Director Console UI.

4. Click Finish.

5. Click OK.

Delete a Director Console Backup

1. Log in as the root user.

2. Go to Settings >> Restore

3. Select the Delete () icon from the Action column of the backup you want to delete.

   You can also delete the backups taken from the API in the Director Console UI.

4. Click Finish.

5. Click OK.

Configure SFTP in Director Console UI

Configuring Secure File Transfer Protocol (SFTP) allows you to store your Director Console UI backups in a remote SFTP server. It gives you access to the backup files even after the API server deletes them.

1. Log in as the root user.

2. Go to Settings >> SFTP Configuration.

3. Enter the IP Address of the SFTP server.

4. Enter the Username and the Password of the SFTP server.

5. Click Finish.

Configuring SFTP in the Director Console UI updates the SFTP configuration of the API server, and vice-versa.