Backup Restoration in WHM

Home » Backups » Backup Restoration

Overview

Backup Restoration allows you to restore accounts from the backup archives that the system stores in the backup directory. You can restore a single account, several accounts, or accounts from a specific date.

Note: The blue border around a section indicates the next required step.

In this example, the blue border indicates that the next step is to select a date from the calendar.

Restore by Account

This option allows you to choose which accounts to restore. You can restore multiple accounts, but you must add each account separately.

To restore an account, perform the following steps:

1. Select one or more accounts that you wish to restore

Notes: This menu includes accounts that have at least one backup archive. Enter an account name in the Filter Accounts text box to filter the list. You can select multiple accounts. If you add an account to the queue, it will appear in gray and you cannot select it again. You can restore an account as many times as you wish, but you must wait for the restoration process to finish before you add that account to the queue again.

2. Select a date from the Available Restoration Dates calendar.

3. Select any desired options from the Additional Options section Restore Subdomains — Restores any subdomains that appear in the account’s backup archive. Restore Mail Config — Restores the account’s email. Restore MySQL — Restores the account’s MySQL® databases.

• Give Dedicated IP Address — Assigns the account a dedicated IP address during the restoration process.Note: If an account has a dedicated IP address at the time of restoration, it maintains that same IP address.

4. Click Add Account to Queue. The account will appear with a status of Pending in the Restoration Queue table below. This table shows the status of the restoration.

5. Click  Restore to start the restoration process.

Restore by date

This option allows you to restore accounts with backup archives from a specific date. You can restore multiple accounts, but you must add each account separately.

To restore an account’s backup archives from a specific date, perform the following steps:

1. Select  a date from the Available Restoration Dates calendar.

Note: You can only click a date that has a backup for the selected account.

2. Select one or more accounts that you wish to restore.

Notes: This list includes accounts that have at least one backup archive. Enter an account name in the Filter Accounts field to filter the list. You may select multiple accounts. If you add an account to the queue, it will appear in gray and you cannot select it again. You can restore an account as many times as you wish, but you must wait for the restoration process to finish before you add that account to the queue again.

3. Select  any desired Additional Options. Restore Subdomains — Restores any subdomains that appear in the account’s backup archive. Restore Mail Config — Restores the account’s email. Restore MySQL — Restores the account’s MySQL databases.

• Give Dedicated IP Address — Assigns the account a dedicated IP address during the restore process.Note: If an account has a dedicated IP address at the time of restoration, it maintains that same IP address.4. Click Add Account to Queue. The account will appear with a status of Pending in the Restoration Queue table below. This table shows the status of the restoration.

  5. Click Restore to start the restoration process.

  Note: You may add more accounts to the queue during the restoration process, and the system automatically restores them.

Give Dedicated IP Address behaviour

The following table shows potentially unexpected behaviour of the Give Dedicated IP Address option in certain circumstances.

Restoration Queue

The Restoration Queue table contains the following columns:

Restoration Queue Script

Advanced users can use the backup_restore_manager script to manage the Restoration Queue table.

Run the /usr/local/cPanel/bin/backup_restore_manager command via the command line to see available arguments, information, and examples.