Child pages
  • The backup_restore_manager Script
For cPanel & WHM version 74

Skip to end of metadata
Go to start of metadata

Overview

The /usr/local/cpanel/bin/backup_restore_manager script manages the backup restoration queue. You can use this script to:

  • Show the current state of the backup restoration process.
  • Add or remove users from the restoration queue.
  • Show which accounts the system is restoring.
  • Remove finished restorations from the queue.

Run the script

To run this script on the command line, use the following format:

/usr/local/cpanel/bin/backup_restore_manager [options]

Options

OptionsDescriptionExample
activateProcess the current queue.

/usr/local/cpanel/bin/backup_restore_manager activate

add

Add a cPanel account to the restoration queue for a specific date.

  • Pass the user option with this option to specify the cPanel account to add.
  • Pass the restore-point option with this option to add a specific restoration date. Enter the date in YYYY-MM-DD human-readable format, where:
    • YYYY is the year.
    • MM is the month.
    • DD is the day.

/usr/local/cpanel/bin/backup_restore_manager add user=username restore_point=2018-03-25

give_ip

Assign the cPanel account a dedicated IP address during the backup restoration process.

Note:

  • You can only combine this option with the add option.
  • This option's default value is 0.
/usr/local/cpanel/bin/backup_restore_manager add user=username restore_point=2018-03-25 give_ip=1

mail_config

Restores the cPanel account's email configuration.

Note:

  • You can only combine this option with the add option.
  • This option's default value is 0.
/usr/local/cpanel/bin/backup_restore_manager add user=username restore_point=2018-03-25 mail_config=1

mysql

Restores the cPanel account's MySQL® databases.

Note:

  • You can only combine this option with the add option.
  • This option's default value is 0.
/usr/local/cpanel/bin/backup_restore_manager add user=username restore_point=2018-03-25 mysql=1

subdomains

Restores any subdomains that appear in the cPanel account's backup.

Note:

  • You can only combine this option with the add option.
  • This option's default value is 0 and will restore aliases when set to 0.
/usr/local/cpanel/bin/backup_restore_manager add user=username restore_point=2018-03-25 subdomains=1
delete

Delete a user from the pending restoration queue.

Pass the user option to specify the cPanel account to delete.

/usr/local/cpanel/bin/backup_restore_manager delete user=username

delete_all_failedDelete all failed entries in the finished restoration queue.

/usr/local/cpanel/bin/backup_restore_manager delete_all_failed

delete_all_finishedDelete all passed entries in the finished restoration queue.

/usr/local/cpanel/bin/backup_restore_manager delete_all_finished

delete_all_pendingDelete all entries in the pending queue.

/usr/local/cpanel/bin/backup_restore_manager delete_all_pending

delete_all_regardlessDelete all entries in all queues regardless of their status.

/usr/local/cpanel/bin/backup_restore_manager delete_all_regardless

delete_finished

Delete a user from the finished restorations queue.

  • Pass the user option with this option to specify the cPanel account to delete.
  • Pass the start_time option with this option to specify the cPanel account to delete. Enter the date in Universal Time, Coordinated (UTC) format.

/usr/local/cpanel/bin/backup_restore_manager delete_finished user=username start_time=1355336425

is_activeShows whether a current restoration process is in progress.

/usr/local/cpanel/bin/backup_restore_manager is_active

listShow all entries in the restoration queue.

/usr/local/cpanel/bin/backup_restore_manager list

list_activeShow the currently restoring accounts.

/usr/local/cpanel/bin/backup_restore_manager list_active

list_finishedShow all accounts with completed backup restorations.

/usr/local/cpanel/bin/backup_restore_manager list_finished

stateShow all restoration information and determine the status of the restoration process.

/usr/local/cpanel/bin/backup_restore_manager state

Additional documentation