This function restores an account backup. You can use this function to restore daily, weekly, or monthly backups.
On servers with a custom
Whostmgr::Transfers module, the function may not return XML output. To properly return XML output, the
Whostmgr::Transfers module must allow the system to use the
Cpanel::Demultiplexer module to capture output.
In cPanel & WHM version 11.50 and earlier, this function returned data after the restoration process completed. However, we changed this behavior in version 11.52 so that the function reports that it found the backup file and will attempt to restore it. Then, the function performs the restoration asynchronously in the background. We made this change to resolve issues from restorations that ran for very long times or crashed before they completed.
If you use this function to restore legacy backups to accounts, use the
functions to check the transfer session and log file to determine whether the restoration process completed successfully.
On servers that run CentOS 7, you may see a
named warning about the absence of SPF resource records on DNS.
- This warning is not relevant on CentOS 7 servers, because RFC 7208 deprecated SPF records. CentOS 7 servers use TXT records instead of SPF records.
- Red Hat 7.1 and CentOS 7.1 both contain
bind-9.9.4-23.el7, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the Red Hat Bugzilla case about SPF record errors.
You must include at least one of the
mysql parameters when you call this function.
The account's username.
|A valid username.|
The type of backup to restore.
The function restores the most recent backup of the type that you specify.
Whether to create the account before restoration.
|Boolean||Whether to assign a dedicated IP address to the restored account.|
Whether to restore account-level filters (vfilters) and forwarders (valiases).
Whether to restore the account's MySQL® databases.
Whether to restore the account's subdomains.
This function only returns metadata.
The function's metadata includes a long
output message that may contain HTML.