Transfer or Restore a cPanel Account

Valid for versions 88 through the latest version

Version:

88


Last modified: October 8, 2020

Overview

The Transfer or Restore a cPanel Account interface lets you transfer a cPanel account or restore one from an account archive file. An archive file is a cPanel account’s backup file or a cpmove file.

Important:
  • When you transfer or restore an account, make certain your server has at least double the archive file’s size available in disk space. The system requires the available disk space to extract the file.
  • If you possess root access or privileges to the source and destination servers, use WHM’s Transfer Tool interface (WHM >> Home >> Transfers >> Transfer Tool). Only use the Transfer or Restore a cPanel Account interface as a last resort.
Warning:

Do not use the skip-name-resolve setting in your server’s MySQL® configuration. This setting will cause serious issues with server operations. If you are not an advanced MySQL administrator, expect issues with this setting. For example, you will see issues with account transfers and restorations. This setting will also cause issues with phpMyAdmin.

Archive file requirements

If you transfer or restore an account from an archive file, the file must meet certain criteria. The archive filename must use one of the following formats:

  • cpmove-{USER}
  • cpmove-{USER}.tar
  • cpmove-{USER}.tar.gz
  • {USER}.tar
  • {USER}.tar.gz
  • backup-{MM.DD.YYYY}{HH-MM-SS}{USER}.tar
  • backup-{MM.DD.YYYY}{HH-MM-SS}{USER}.tar.gz
  • backup-{MM.DD.YYYY}_{HH-MM-SS}_{USER}.tar
  • backup-{MM.DD.YYYY}_{HH-MM-SS}_{USER}.tar.gz

The file must also reside in one of the following directories:

  • /home
  • /home2
  • /home3
  • /root
  • /usr
  • /usr/home
  • /web

Restricted Restore

Warning:

This feature is experimental. Do not consider it an effective security control. Exercise extreme caution when using the Restricted Restore feature.

The Restricted Restore feature lets the system perform extra security checks on the archive file. If part of the file has a security issue, the system will not restore that part of the archive file. This helps mitigate the risk of transfers from unfamiliar sources. The system enables this feature by default.

If you use the Restricted Restore feature, be advised that:

  • The Restricted Restore feature only allows restored accounts to use noshell or jailshell environments. If the restored account uses another shell, the system will set the account to use noshell environment.

  • The Restricted Restore feature will not restore parked (aliased) or addon domains.

  • If you use this feature to restore an account that contains PostgreSQL® databases, the target server must use PostgreSQL version 8.4 or newer.

Transfer Options

You can select from one of the following options:

Restore from a local cpmove file

The Restore from a local cpmove file option lets you restore an account with an existing cpmove file on the server.

To restore a cPanel account from a local cpmove file, select the Restore from a local cpmove file option and perform the following steps:

  1. In the Select a File menu, enter the name of or select the cpmove file on the server to use for the restoration.
    • Check the Overwrite if the cPanel user already exists setting to overwrite any cPanel accounts with the same username. This is optional.
  2. In the A records section, select one of the following settings:
    • Replace All Matching A Records — The system will replace all instances of the source server’s IP address with the destination server’s IP address. For example, a custom A record. This is the default setting.
    • cPanel-provided A Records — Only replace the basic cPanel-provided A records in the cPanel account’s zone files.
  3. Click Restore. The Account Restore interface will appear. The system begins the account restoration process. You can use this interface to monitor the restoration progress.

Upload a file to restore

The Upload a file to restore option lets you upload a cpmove file to the server.

To restore a cPanel account with an uploaded cpmove file, select the Upload a file to restore option and perform the following steps:

  1. In the Upload File section, click Choose File. A new window will appear.
  2. Locate and select the cpmove file that you want to upload to the server.
    • Check the Overwrite if the cPanel user already exists setting to overwrite any cPanel accounts with the same username. This is optional.
  3. In the A records section, select one of the following settings:
    • Replace All Matching A Records — The system will replace all instances of the source server’s IP address with the destination server’s IP address. For example, a custom A record. This is the default setting.
    • cPanel-provided A Records — Only replace the basic cPanel-provided A records in the cPanel account’s zone files.
  4. In the IP Address section, select whether to assign a dedicated IP address to the cPanel account on your server. Your server must have at least one available IP address to perform this action.
  5. Click Restore. The Account Restore interface will appear. The system begins the account restoration process. You can use this interface to monitor the restoration progress.

Transfer from Remote cPanel Account

The Transfer from Remote cPanel Account option lets you transfer a cPanel account from a remote server’s archive file. To perform a remote transfer, select the Transfer from Remote cPanel Account option and perform the following steps:

  1. In the Remote Server section, enter the server’s IP address or hostname. If you use a hostname, you must include a valid top level domain (TLD) in the domain’s name.
  2. In the Remote username section, enter cPanel account’s username on the remote server.
  3. In the Remote password section, enter the cPanel account’s password on the remote server.
  4. In the IP Address section, select whether to assign a dedicated IP address to the cPanel account on your server. Your server must have at least one available IP address to assign a dedicated IP address.
  5. Click Transfer. The Account Restore interface will appear. The system begins the account restoration process. You can use this interface to monitor the restoration progress.

Linked Nodes Options

Important:
  • Server linkages are experimental. We do not recommend using this feature in production environments. Proceed with caution.
  • The Linked Nodes Options section is only available if your server uses cPanel & WHM linked server nodes.

If your server uses linked cPanel & WHM server nodes, the Linked Nodes Options section lets you link the cPanel account to a child node. You can select from the following settings:

  • Use the archive file’s stored configuration — This setting uses an archive file’s stored configuration. If the file indicates the use of one of the local server’s linked cPanel & WHM server nodes, the system will attempt to use that linked node. Otherwise, the account restores to the local server.
  • Use only this server. Transfer or restore locally — This setting will transfer or restore the account to the local server.
  • example-alias (servernode.example.com) — The alias and hostname of a linked cPanel & WHM server node. This will transfer or restore the account to the selected cPanel & WHM server node.

Additional Documentation