Page tree
Skip to end of metadata
Go to start of metadata

This document is for a previous release of cPanel & WHM. To view our latest documentation, visit our Home page.

For cPanel & WHM 11.44

(Home >> Backups >> Backup Restoration)

Overview

Important:

For this feature to work, you must enable account backups in WHM's  Backup Configuration interface (Home >> Backup >> Backup Configuration).

This feature allows you to restore accounts from the backup archives stored in the backups 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.

  1. Select an account that you wish to restore.

    Notes:

    • The 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 the account to the queue again.
  2. Select a date from the Available Restoration Dates calendar.

    Note:

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

  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 will maintain 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. Repeat steps 1-4 to add multiple accounts to the queue.
  6. Click Restore to start the restoration process.

    Note:

    You may add additional accounts to the queue while restoration is in progress, and the system automatically restores them.

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.

  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 an account that you wish to restore.

    Notes:

    • The 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 the 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 will maintain 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. Repeat steps 1-4 to add multiple accounts to the queue.
  6. Click Restore to start the restoration process.

    Note:

    You may add additional accounts to the queue while restoration is in progress, and the system automatically restores them.

Give Dedicated IP Address behavior

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

The Account Exists 
at the Time of the Restoration
The Account had a Dedicated IP 
Address at the time of the Backup
Give Dedicated IP Address 
Is Selected
Result
YesYesNoThe system gives the account the same dedicated IP address.
YesNoYesThe system gives the account a dedicated IP address.
NoYesYes

The system gives the account a new dedicated IP address, which may or may not match the IP address that the account had when you backed it up.

Note:

When an account does not exist at the time of restoration, the system behaves as though the account does not have a dedicated IP address.

Restoration Queue

The Restoration Queue table contains the following columns:

ColumnDescription
AccountThe name of the account.
Restoration DateThe date of the backup archive.
Status
  • Pending – The account is ready to be restored.
  • Restoring Account – The restoration is in process. You cannot remove an account from the queue during the restoration process. 
  • Completed – The restoration is complete and successful. 
  • Failed – The restoration failed. The red failure notice  box includes a reason for the failure. Click the X button on the right to close the red box.
Actions

Clear This option clears the associated entry from the queue. 

Note:

To clear an account that failed to restore, you must click the X button on the failure notice.


  • Clear pending accounts – This option clears all Pending restores from the queue.
  • Clear completed accounts – This option clears all Complete and Failed restores from the queue.
  • Clear all error notices - This option clears all error notices from the queue.
  • Clear all accounts – This option clears all Pending, Complete, and Failed restores. It will not clear an account that has a status of Restoring Account.

Note:

Completed accounts automatically move to the bottom of the Restoration Queue.

Restoration Queue Script

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

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

Additional documentation

  • Remote Restoration  — How to restore backups from Additional Destinations that you configure in WHM's Backup Configuration interface (Home >> Backups >> Backup Configuration).