Backup and Restore Data

Backup and Restore Configuration and Data

The backup and restore feature is provided to protect the data in case of its hardware or software failure that corrupts or destroys configuration or performance data. Manage server supports two types of backups, which are:

• Daily backup – occurs every night at 1:00 am and 4:00 am
• Admin initiated – occurs when the admin user explicitly creates a backup.

The daily backup is performed every night at 1:00 am and 4:00 am. The backup is stored on an external device attached to Manage or a remote server using SFTP (SSH File Transfer Protocol). If there is not enough space on the attached storage drive, the oldest file with an extension of “.tar.gz” is deleted. If there is still not enough space, then the next oldest file with a “.tar.gz” is deleted. This process continues until enough free space is present, or no more files with a “.tar.gz” exist. If enough free space is present, the backup is stored on the external drive. Likewise, if the remote server connection is available, the backup is stored on the remote server. Otherwise, the backup is stored in the directory /opt/enLighted/DB/DBBK on the Manage server.

The “Admin initiated” backup is an on-demand backup initiated by an administrator. Based on the storage option selected, if there is enough free space present on the external drive, the backup file is stored on the external drive or to a remote server using SFTP. If not, a backup is stored in directory /opt/enLighted/DB/DBBK on the Manage server. These backup types do not delete files on the external drive.

Only users with the 'Admin' role can access the Backup and Restore screen. Sign in to Manage using your admin login credentials. 

After the password for user admin has been re-verified, go to Administration > Backup and Restore. The Backup and Restore screen is displayed. The Backup and Restore screen contains four sub-panels. An example is:

The following operations are possible:

• Selecting a Backup
• Creating a Backup
• Downloading a Backup File
• Uploading a Backup File
• Restoring from Backup File
• Deleting a Backup File
• Recovering from System Failure

Summary

The backup and restore capabilities provide the means to recover from minor and major problems. Best practice includes creating backup files before and after system configuration changes and a periodic download of a backup file to store in a separate physical location from the Manage server.

Selecting a Backup

Only admin users can access the Backup and Restore screen.

1. Sign in to Manage using your admin login credentials. Re-verify the password for user admin.
2. Go to Administration > Backup and Restore. The Backup and Restore screen is displayed.

The first sub-panel, Select Backup Option, supports two backup options:

• Attached Storage -  If the Attached Storage option is selected, choose from the list of external devices connected to Manage. The default attached storage is /media/usb1. 
• SFTP Remote Backup - For the SFTP option, specify details of the remote server.

    3. Click Save to save the backup option. 

 

Creating a Backup

Only admin users can access the Backup and Restore screen.

1. Sign in to Manage using your admin login credentials. Re-verify the password for the user
    admin.

2. Go to Administration > Backup and Restore. The Backup and Restore screen is displayed. The second
    sub-panel, Backup, is for a backup to be done immediately by an administrator.

3. Enter a preferable filename in the Backup File Name field.

The filename specified in the input field is the prefix of the resulting filename, which will have a suffix added: the date and time with a “tar.gz” extension.

4. Click Backup Now. The backup is initiated, and the following pop-up appears.

After the backup is completed, the bottom line in the pop-up will display the line Click here to refresh the page. Following is an example:

5. Click on the word here to exit the pop-up and update the backup and restore the screen.

The generated backup file is stored in the external device or uploaded to the remote server, depending on the backup option selected. If enough space is not available on the external hard drive or if the server cannot connect to the SFTP server, the file is stored in the directory /opt/enLighted/DB/DBBK on the Manage server.

 

Downloading a Backup File

Only admin users can access the Backup and Restore screen.

1. Sign in to Manage using your admin login credentials. Re-verify the password for user admin.
2. Go to Administration > Backup and Restore. The Backup and Restore screen is displayed.
3. Navigate towards the end of the Backup and Restore screen to the List of all backup files section.
4. Locate the appropriate backup file that you prefer to download and click on the Download button available in the Action column. A pop-up appears as shown in the following image.

Complete the download by following the browser-specific messages with the progress and completion of the download.

 

Uploading a Backup File

Only admin users can access the Backup and Restore screen.

1. Sign in to Manage using your admin login credentials. Re-verify the password for user admin.

2. Go to Administration > Backup and Restore. The Backup and Restore screen is displayed. 

In the second section of the Backup and Restore screen,

3. Click on the Browse button and select the required file in the file chooser pop-up,

4. Click the Upload button to initiate the upload process.

When the operation completes, a message is displayed. The following illustrates the buttons and the resulting message on successful upload:

Note: The Browse button changes to Choose File after uploading the backup file.

Restoring from the Backup File

Note: When restoring the database from a Backup file, we recommend you restore to the same version of the Manage software and then upgrade the Manage software if needed.

Only admin users can access the Backup and Restore screen.

1. Sign in to Manage using your admin login credentials. Re-verify the password for user admin.
2. Go to Administration > Backup and Restore. The Backup and Restore screen is displayed.
3. Navigate towards the end of the Backup and Restore screen to the List of all backup files section.
4. Locate the appropriate backup file that you prefer to restore and click on the Restore button available in the Action column. A confirmation message appears, as shown on the following screen.

Click OK. A pop-up appears showing the restoration progress, as shown in the following image.

As progress is made in the process, completed steps are turned green, as shown in the following example:

After restoring, the bottom line in the pop-up will display the line Click here to refresh the page. As shown in the following example.

Click on the word here to exit the pop-up and update the backup and restore the screen. To get back to the main page after a restore, close the previous tab for the main page, and click the Go back to main page button as shown on the following screen:

The sign-in screen will be displayed. After signing in, you should see the upgraded build number and version in the Web browser display.

To refresh network settings after a restore,

1. Click on Administration > Network Settings menu item.
2. In the network settings display, click on Save and Apply Configuration.

 

Deleting a Backup File

Only users with the 'Admin' role can access the Backup and Restore screen.

1. Sign in to Manage using your admin login credentials. Re-verify the password for user admin.
2. Go to Administration > Backup and Restore. The Backup and Restore screen is displayed.
3. Navigate towards the end of the Backup and Restore screen to the List of all backup files section.
4. Locate the appropriate backup file that you prefer to delete and click on the Delete button available in the Action column. A confirmation message appears, as shown on the following screen.

A success message appears after deletion. A sample message is given below.
File beforeFixtureUpgrade_2.2.0-3446_2013-03-12_16-12.tar.gz deleted successfully

Recovering from System Failure

If the Manage server hardware has failed, it must be replaced. If the system files have become corrupted, reinstall the Manage server software.

In both cases, if a backup file is on the USB flash drive, use the drive to restore the system configuration and performance data. On first access to the Manage server, if the USB flash drive contains backups, then it can be used to set up the system, skipping re-entering the information about the organization, campus, building, and floors. However, if no backup is available on the USB flash drive, but a backup has been downloaded from the system before it failed, it can be used after placeholder values have been entered for first access to the system.

The backup and restore provides the means to recover from minor and major problems. Best practice includes creating backup files before and after system configuration changes and a periodic download of a backup file to store in a separate physical location.