Learn WHM

The Web Host Manager will allow you to control your VPS/DS services via your Internet Browser!

• Last Updated: 02/19/2020
• ( 15 minutes reading )

How to use the Transfer Tool feature in WHM

Introduction

The “Transfer Tool” feature in the WHM control panel allows you to transfer multiple accounts from a different server. It is really flexible in terms of the control panels it can perform the migrations from, more specifically Plesk, DirectAdmin, Ensim, and of course cPanel/WHM. The requirements in order for this functionality to work are the root password for the remote server and an operational openSSH service on both the remote and the source servers. Our VPS and Dedicated Servers have fully operational openSSH services so you have nothing to worry about in these regards. If you are not sure about the remote server, please contact the service provider managing it so they can let you know.

The main focus of this tutorial will be the transfers from a cPanel/WHM server, as this is the product that we offer support for. Additionally, this method ensures that the migration is done 100% correctly and there is no missing content when it is finalized.  Let’s get started.

 

Accessing the Transfer Tool feature

First, you need to log into the WHM service for your VPS or Dedicated Server. If you are not sure how to do that, please check our How to access the WHM service tutorial. After you have logged in, please use the search bar on the left side of the page and type “Transfer Tool”.

 

Accessing the Transfer Tool feature

 

When the functionality shows up below the search bar, please click on it so you can be redirected to the “Transfer Tool” page.

 

Preparing the transfer process using the Transfer Tool

Before we begin, we would like to touch upon a few important things you need to be aware of when using this feature.

  • Please, do not shut down, reboot, or restart any services during the transfer process.
  • Do not start a transfer process during a system update. There is a big chance that the system update will fail in this case.
  • If any domains on the accounts you are migrating are utilizing a DS record and have DNSSEC enabled you MUST remove it from the Registrar before the migration and after it is done, re-add it back. 
  • The transfer tool will not transfer DNS zone templates. If such exist on the remote server the destination server will ignore them and apply the default DNS records in the domain’s DNS zone.
  • You need to make sure both servers are able to communicate with each other using port 2087. They also need to be able to communicate using the port where the openSSH service is working - typically, this will be port 22, however, some providers use custom ports.


Now that you have been acquainted with a few specifics of this tool, we can continue forward.

Upon landing on the “Transfer Tool” page, the first thing you will come across is the “Remote Server Information” section. It will contain two fields.

  • Remote Server Address: In this text field, you need to either provide the IP address of the remote server or its fully qualified domain name (FQDN).
  • Remote SSH Port: In this text field you need to enter the SSH port of the remote server. As mentioned above, this will typically be 22, however, if this does not work, please contact your remote service provider and ask them for the correct port.

 

Remote Server Information section

 

The next section will be the “Authentication” section. Here, what will be requested from you is the following.

  • Login - This section will have a radio button that has selected the “root” user as the default choice. You will have the option to select a different user on your remote server as well. When you select the “User” option, a text field will appear below it, requesting that you type the username instead.
  • Authentication Method - This section will have a radio button as well and the “Password” authentication method will be the default choice. Upon selecting the “SSH Public Key” option a dropdown will appear that will let you select the public key and the “Root Password” text field will turn into “SSH Key Passphrase”.

 

Authentication section Root option

 

Here is what this section looks like when the “User” and the “SSH Public Key” options are selected with the radio button below.

 

Authentication section User option

 

Another new thing you will find in this example is the “Root Escalation Method” if the “su” option is selected via the radio button, a “Root Password” text field will appear where you need to enter the root password for your server. If the “sudo” option is selected, the “Root Password” text field will disappear and only the “Username Password:” field will remain.

Note that the user from the remote server needs to have “sudo” privileges there, otherwise, the link between the two servers will not be established and the transfer process will not go through.

 

Root Escalation Method sudo option

 

Scrolling the page downwards, you will reach the “Security” section. It contains a single checkbox option - “Restricted Restore”. At this point, you should avoid using it, as it is still experimental and should not be considered an effective security control method. Its intent is to allow the restoration of backups from untrusted sources. We STRONGLY discourage you from transferring and restoring any account backups from providers whom you do not trust.

 

Security section

 

The last section available on this page is the “Advanced” section. In order to expand it, please click on the “Show” button located on its right side.

 

Show Advanced section

 

This will open a whole lot of options, so, let’s explain what each one of them does.

  • Remote Server Type - This will be a dropdown menu, that will let you select the control panel of the remote server. The options are as follows: “Auto Detect”, which will automatically fetch the remote server’s control panel. The rest of the options are “WHM & cPanel”, “DirectAdmin”, “Ensim” and “Plesk”.
  • Unencrypted - This is a checkbox that if left unticked will encrypt the session for the transfer. If it is ticked, this session will be unencrypted. We do not recommend selecting this option.
  • Compressed Transfers - Selecting this checkbox will compress the files during the rsync process when the files are being transferred between the two destinations.
  • Low Priority - This checkbox will perform the transfer using less CPU and a lesser disk IO priority. Note that this will reduce the number of resources needed for the transfer but it will also reduce the speed in which it is performed.
  • Number of Transfer Threads - This text field allows you to specify the number of CPU processes for the transfer session. WHM does not allow you to select a number higher than 5.
  • Number of Restore Threads - This text field allows you to specify the number of CPU processes for the restore session. WHM does not allow you to select a number higher than 5.
  • Transfer Session Timeout - The last text field will allow you to define the number of seconds in which the transfer session will remain open before it eventually times out. 

 

Advanced section options

 

When you have selected all of the options you need and set the login and authentication information, please press the “Scan Remote Server” button located on the bottom of the page.

 

Scan Remote Server button

 

Once this is done, please allow a few moments for the process to be successfully completed.

 

Final steps before starting the migration process

After a brief loading screen, you will be sent to the “Account List” page. On top of the page, you will see a blue bar, and inside, you will find information about the “Source” server and the “Target” server, such as their hostname and the WHM version they are using. Below, you will find the “Rescan Source Server” button which will allow you to do an additional scan of the accounts on the remote server. This can be useful if an update to the accounts on the “Source” server was made after the initial scan or a new account was added.

 

Source and Target server information

 

Underneath the blue bar, you will find three tabs. The “Accounts” tab, the “Packages” tab, and the “Service Configurations” tab. Let’s go over them.

 

Accounts, Packages and Server Configuration tabs

 

The first tab we are going to be going over is the “Accounts” tab. It will be the first thing that will be selected by default. 

 

The Accounts Tab

 

Right Under the tabs, you will find a search field, allowing you to filter the accounts on the “Source” server and locate only the ones you need. Beneath this search field, you will see a table section containing all of the accounts on the “Source” server.



Accounts tab overview

 

Now, let’s explain all of the columns inside this table section.

  • Domain - This column will show the primary domain name of the cPanel hosting account on the “Source” server.
  • User - This column will display the username of the account on the “Source” server.
  • Disk Usage - Displays the current disk usage of the account on the “Source” server.
  • Reseller - Shows who is the Reseller or the owner of the hosting account on the “Source” server.
  • Dedicated IP - This checkbox will allow you to apply a dedicated IP address to the account when it is migrated over to the “Target” server. If you select this option, please make sure that the “Target” server has available IP addresses, otherwise, the account WILL NOT BE transferred.
  • Copy Home Directory - Ticking this checkbox will make it so all of the files from your cPanel account’s home directory are migrated.
  • Copy Reseller Privileges - Checking this will make sure that the Reseller Privileges of the account are copied over to the “Target” server as well.
  • Copy Databases - Selecting this option will enable the transfer process to migrate all of the databases located on the cPanel account.
  • Copy Bandwidth Data - Ticking this checkbox will transfer all of the account’s bandwidth data.
  • Express Transfer - You will be able to select this option ONLY if you are migrating accounts between two cPanel & WHM Servers. Additionally, please only use this if the domains are already pointed towards the “Target” server, otherwise, you will experience DNS resolution issues.


At the very top of the table, you will see that the first row is greyed out. You may use the checkboxes inside it, in order to enable the option for every account.

 

Applying actions in bulk

 

The checkbox at the far left side of the grayed-out row will select all of the accounts for migration.

 

The Packages Tab

 

In order to access this, please click on the “Packages” tab which will be located on the right side of the “Accounts” tab.

 

Packages tab overview

 

When you are redirected there, you will see a search field below the tabs. You may use it to search for a specific package. Below this, you will find the packages section where you will see all of the “Package Names”. The first row will be grayed out once again and on the far left side, there will be a checkbox, which will allow you to select all of the packages from this list. 

 

The Service Configurations Tab

 

This is the last tab we are going to discuss. In order to access it, please click on the “Service Configuration” tab which is located on the right side of the “Packages” tab.

 

Server Configuration tab overview

 

It will display configurations that you can migrate over to the “Target” server. Here is the list of all the options.

  • AutoSSL Options
  • Backups
  • cPanel & WHM
  • Database Server
  • EasyApache
  • Exim
  • GreyList
  • Hulk
  • ModSecurity
  • User Interface Themes


Additionally, you will also find an “
Analysis” column that will show the versions of all the above for the “Target” and “Source” server or in this case the “Remote” and “Local”.

 

Analysis column overview

 

When you are done with choosing your accounts, selecting your packages and service configurations you want to transfer, please press the “Copy” button located on the bottom of the screen, regardless of the tab you are currently viewing.

 

Initiating the transfer process

 

Above the “Copy” button, you will find a short summary of what you are going to move. In our case, we have selected two accounts and two packages.

When the button is pressed the “Account Transfer” functionality will appear, displaying the status and progress of your account restoration along with any warnings if such are present. Account transfers appear on the left side of the page, while site restorations appear on the right side of the page.

 

Transfer summary

 

Under the transfer and restore sections, you will see a blue bar containing a message informing you that this process continues even after this page is closed and you may view this in real-time through the terminal by executing the provided command. Below it, there will be a summary section letting you know what happened after the process is finalized.

Now, we would like to point your attention to the “Account “username”: Success” links, located below the blue progress bar inside the “Transfer” or “Restore” sections. 

 

Transfer and Restore log links

 

Upon clicking one of the above-mentioned links, you will be forwarded to a page, containing the log of the entire process from it’s beginning.

 

Restore log output

 

Located at the bottom of the page, you will find the “View Session Summary” button, which will bring you back to the “Summary” page you were previously on.

 

View Session Summary button

 

This sums up the entirety behind the “Transfer Tool” feature inside the WHM control panel. If you are a person constantly moving accounts from different servers, you will really appreciate this functionality and you will be using it with ease, now that you have read our tutorial! As always, if you experience any issues with this feature, please, do not hesitate to contact our Technical Support Team. They are reachable 24/7 over the ticketing system in your Client Area.

 

 

...
Sebahat
Content Marketing Specialist

Sebahat is a young and bright woman who has become an invaluable part of our team. She started as a Customer Care Representative, mastering that role and, along the way, growing into a tech-savvy individual who is well acquainted with every support layer of the company. Driven by her aim to improve our customers’ experience constantly, she is committed to enhancing the extraordinary support we deliver.