Transfer Tool — Select What to Transfer

Valid for versions 124 through the latest version

Version:

124

Last modified: October 22, 2024

Overview

Once you have prepared a source server in WHM’s Transfer Tool interface (WHM » Home » Transfers » Transfer Tool), this section will appear to allow you to select which configurations, packages, and accounts you want to transfer to the destination server.

Accounts

You can view this tab after you prepare a source server to use WHM’s Transfer Tool interface (WHM » Home » Transfers » Transfer Tool). This tab allows you to transfer cPanel accounts to this server.

How to copy accounts

To copy accounts, perform the following steps:

1. Select the checkbox for each cPanel account that you wish to transfer.
   • To copy all of the accounts that the interface currently displays, select the checkbox at the top of the column in the table header.
   • Use the Search text box to filter the list of accounts.
   • Click a column header to sort the accounts by that column.
2. By default, the system adopts the username from the source server. To specify a new username, enter the new username in the User text box.
   Note:

   The User text boxes display the following colors as warning indicators:

   • A red highlight indicates that the username or domain already exists on this server. The account will fail to transfer if you do not change the username, select Overwrite, or select Overwrite with delete. You cannot transfer an account that uses the same domain.
   • A green checkmark () indicates that the account does not already exist.
3. Select the accounts to which the system will assign dedicated IP addresses under the Dedicated IP Address heading. The interface will select the Dedicated IP checkbox for accounts that currently use a dedicated IP address.
   Warning:

   You can only assign available dedicated IP addresses from your server. If your server doesn’t have the required number of available IP addresses, the transfer will fail.

4. Click Default to show the What to Transfer section. The following settings will appear:
   • Home Directory — Transfer the account’s home directory.
     Note:

     When you transfer the home directory, the system checks whether it can run the rsync command. If the system does not find an error, it will rsync the home directory when the system completes the transfer.

   • Reseller Privileges — Retain the account’s reseller privileges.
   • Databases — Transfer the account’s databases.
   • Bandwidth Data — Transfer the account’s bandwidth data.
   • Integration Links — Transfer the account’s integration links.
5. Click Default to show the Live Transfer section.
   Note:

   For more information, read our Live Transfer documentation.

6. If your server uses a linked node, click Default to show the Linked Node Options section. The following settings will appear:
   • Use only this server. Transfer or restore locally. — Transfer the account to the local server.
   • The alias and hostname of an existing cPanel & WHM server node. For example, mailserver (mailnode.example.com). — Transfer the account’s mail services to the selected linked node.
7. Click Apply to save the What to Transfer and Linked Node Options settings for this account. You can click Apply to other selected accounts to apply these settings to all currently selected accounts. To apply the default settings for this account, click Reset.
8. The Overwrite column displays a menu that allows you to overwrite local data for the transfer.
   • Do Not Overwrite — Do not perform an overwrite.
   • Overwrite — Overwrite the home directory on the destination server with the contents of the source server. Do not delete any other files or directories on the destination server.
   • Overwrite with Delete — Overwrite the home directory on the destination server with the contents of the source server. Delete all files and directories on the destination server that don’t exist on the source server.
     Warning:

     This setting will overwrite or delete all files on the destination server for the cPanel account. You cannot reverse this action. We strongly recommend that you first create a backup of the account.

9. Click Copy. The transfer will begin, and the Account Transfer interface will appear.

SNI information

If you do not select the Home Directory setting, the system will not add the necessary SNI information to Dovecot’s configuration files. To manually configure SNI information in Dovecot’s configuration files after an alternative transfer of home directories, run the following command:

/usr/local/cpanel/scripts/build_mail_sni --rebuild_dovecot_sni_conf --restartsrvs

Accounts will retain their mailbox format settings from the source server. For example, if an account uses the maildir format on the source server, it will use the maildir format on the destination server.

Packages

In this section of the Account List interface, select the packages on the source server to copy to your destination server.

How to copy packages

To copy a package, perform the following steps:

1. Select the packages that you wish to copy.
   • Select the checkbox in the table header to select all of the packages from the source server.
   • Use the Search text box to filter the list of packages.
   • Use the navigation controls to page through the list of packages.
   • Click a column header to sort the packages by that column.
2. Click Copy. The transfer will begin. This will also transfer any accounts that you select in the Accounts tab.
   Warning:

   • The system will overwrite any packages or feature lists with the same name that exist on the destination server.
   • If the transfer fails to create a new package or feature list, it will assign the default package or feature list to the account.

Package and feature list naming

The Transfer Tool feature performs the following actions during package transfers:

• The restore system attempts to extract the package information from the cpmove file. If the package does not already exist on the destination system, the system creates the package and assigns it to the account. If the system cannot create the package, the system assigns the default package to the account.
• If the feature list for the account exists on the destination system, the system assigns it to the account. If the feature list does not exist, the system assigns the default feature list to the account.
• You can transfer a new package and feature list with the same name as a package that already exists on the destination server. This package will override the previous package’s settings.

Service Configurations

In this section of the Account List interface, select the configuration settings on the source server that you wish to copy to a destination server.

You can transfer the following configurations:

• AutoSSL Options
  Note:

  This module does not modify the SSL provider. To update your SSL provider, use WHM’s Manage AutoSSL interface (WHM » Home » SSL/TLS » Manage AutoSSL).

• Backups
• cPanel & WHM (whmconf)
  Note:

  This configuration includes WHM’s common settings that aren’t user-specific. For example, the settings from WHM’s Tweak Settings interface (WHM » Home » Server Configuration » Tweak Settings) and WHM’s Basic WebHost Manager Setup interface (WHM » Home » Server Configuration » Basic WebHost Manager Setup).

• Database Server
  Note:

  When you transfer remote MySQL databases, the Transfer Tool feature includes any comments associated with the remote MySQL server. For more information about remote MySQL comments, read our Remote Database Access documentation.

• EasyApache
• Exim
• GreyList
• Hulk
  Note:

  • The Transfer Tool feature does not copy history reports.
  • The Transfer Tool feature appends whitelist- and blacklist-management configuration settings. It does not replace these configuration settings.
• ModSecurity®
  Note:

  The EasyApache service configuration also contains some ModSecurity settings. Use the ModSecurity service configuration to affect only the ModSecurity settings.
• User Interface Themes

For more information about the files that the system transfers for each configuration, read the cpconftool script documentation.

To select your desired configurations, perform the following steps:

1. The Configuration Name and Analysis columns display the available configurations and versions. You may need to click Show for the available configurations to appear.
2. Select the configurations that you wish to transfer to your local server.
   Note:

   • The system displays warning messages in yellow and blocker messages in red text.
   • If you receive a blocker message, the system disables the EasyApache setting.
3. Click Copy. The transfer will begin, and the system will display the progress interface. This will also transfer any accounts that you select in the Accounts tab.
   Note:

   • You cannot click Copy until you select a configuration to transfer.
   • The Transfer column displays the status of all configurations from the source server.
   • The Restore column displays the status of all configurations to the destination server.
   • The system displays any error messages in yellow and warning messages in red text.

The summary bar displays the transferred or restored configurations.