Difference between revisions of "CPanel/WHM Import"

Latest revision as of 16:51, 19 April 2022

We removed this feature in WHMCS 7.8. In WHMCS 7.8 and higher, use the Server Sync Tool.

This feature allows you to import all the domains from your existing cPanel & WHM servers.

You can access this feature at Utilities > WHM Import Tool.

Importing from cPanel & WHM

Important
You must perform all of these steps to ensure a complete import. Failure to do so may result in loss of data.

To import domains from cPanel & WHM:

Go to Setup > Products/Services > Servers.
Set up your cPanel & WHM server. For more information, see Adding a cPanel Server.
Go to Setup > Automation Settings.
Disable Enable Suspension and Enable Termination. You can reenable these settings after the import process.
Go to Utilities > cPanel/WHM Import.
Select the server for the accounts you want to import. A list of accounts will display.
Select the accounts to import.
Click Import.

Entering Client & Billing Data

The information cPanel & WHM stores is very limited. Importing requires some manual work, but the importable data, including the domain, username, server, and package, allows for all account management functions.

Imported account usernames and domains are retrieved automatically from the server. Because cPanel & WHM does not store any billing details, the import process initially sets all accounts as free. You must then update the imported domains with the appropriate pricing, billing cycles, next due dates, and client information.

To group domains with a single client, see Moving a Product/Service to another Client and Merging Clients.

Notes

Enabling Show only Domains with Status Mismatch displays cancelled, terminated, or fraudulent products that exist on the server. This allows a you to audit accounts that should not be online according to WHMCS but are still online on the server.

To log in to the Client Area for the first time, clients must use the password reset function to set a password. They can then log in normally.

Common Problems

Import Failed

This error occurs when an account cannot be assigned to a package because the package does not exist in WHMCS. Before importing, make sure to set up all of the packages for the accounts you will import. To do this, go to Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services, click Edit, and, in the Module Settings tab, enter the WHM Package Name such as "demohost_Starter" in the Package Name field on the modules settings tab.

No Accounts Found

This error indicates that WHMCS cannot connect to your server.

If your server requires an SSL connection, enable Secure at Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers. Then, try again.

If the problem persists, try creating a new account using WHMCS. If that also fails, see Troubleshooting Guide.

Could not resolve host: (Code 6)

A Code 6 cURL error indicates that IP Address in the server configuration is empty. To resolve this, edit the server at Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers and enter your server's IP address.

@@ Line 1: / Line 1: @@
-The WHM Import Tool can be accessed using the Utilities menu.  This will allow you to import all the domains from your existing cPanel/WHM servers.  It can save hours of time and is very easy to use.  Here is how:
+<div class="docs-alert-danger">
+We removed this feature in WHMCS 7.8. In WHMCS 7.8 and higher, use the [https://docs.whmcs.com/Server_Sync_Tool Server Sync Tool].
+</div>
+This feature allows you to import all the domains from your existing cPanel & WHM servers.
-==Importing from cPanel/WHM==
+You can access this feature at '''Utilities > WHM Import Tool'''.
-===Preparation===
-*First you must enter the details of your cPanel server and packages into WHMCS. Please refer to [[CPanel/WHM#Adding_a_cPanel_Server|Adding a cPanel server]]
-*Disable the ''Enable Suspension'' and ''Enable Termination'' settings under '''Setup > Automation Settings''' until the entire import process has been completed
-===Importing===
+==Importing from cPanel & WHM==
-[[File:Whm_import.png|thumb|WHM Import List]]
-#You must first ensure you have setup the server you wish to import accounts from in '''Setup > Products/Services > Servers'''
-#Next, go to '''Utilities > cPanel/WHM Import'''
-#Now choose the server you want to import accounts from in the dropdown box
-#A list of the accounts on that server will now be displayed
-#From here you can select the accounts you wish to import - it will highlight domains that already exist in your WHMCS system so you don't create duplicates - and you can select all the accounts in one go by clicking the checkbox in the header row
-#Then simply click the '''Import''' button at the bottom of the page an the accounts will be imported
-===Entering Client & Billing Data===
 <div class="docs-alert-danger">
 <span class="title">Important</span><br />
-These final steps must be performed to ensure a complete import. Failure to do so may result in loss of data</div>
+You '''must''' perform '''all''' of these steps to ensure a complete import. Failure to do so may result in loss of data.
-The information cPanel stores is very limited, for example it doesn't hold the clients name, the amount they pay or their next due date.  So importing does require some manual work too but what can be imported (domain, username, server & package) does mean that all the cPanel account management functions are possible from WHMCS, for example Suspend/Unsuspend/Terminate/Upgrades/Downgrades & Password Resets.
+</div>
+To import domains from cPanel & WHM:
+# Go to '''Setup > Products/Services > [[Servers]]'''.
+# Set up your cPanel & WHM server. For more information, see [[CPanel/WHM#Adding_a_cPanel_Server|Adding a cPanel Server]].
+# Go to '''Setup > [[Automation Settings]]'''.
+# Disable '''Enable Suspension''' and '''Enable Termination'''. You can reenable these settings after the import process.
+# Go to '''Utilities > cPanel/WHM Import'''.
+# Select the server for the accounts you want to import. A list of accounts will display.
+# Select the accounts to import.
+# Click '''Import'''.
+===Entering Client & Billing Data===
+The information cPanel & WHM stores is very limited. Importing requires some manual work, but the importable data, including the domain, username, server, and package, allows for all account management functions.
-Accounts created by the import process have their domains & usernames retrieved automatically from the server, as well as being assigned to the appropriate package and server within WHMCS.  But due to no billing details being stored in cpanel, initially all accounts will be set to free and you will then need to go through and update the imported domains with the appropriate pricing, billing cycles, next due dates and client information.
+Imported account usernames and domains are retrieved automatically from the server. Because cPanel & WHM does not store any billing details, the import process initially sets all accounts as free. You must then update the imported domains with the appropriate pricing, billing cycles, next due dates, and client information.
-Quite often you may find you need to move the domains around and group more than one domain to certain clients.  To do this, see the [[Products_Management#Moving_a_Product.2FService_to_another_Client|Moving a Product/Service to another Client]] article in the Products Management section. or [[Client_Management#Merging_Clients|Merging Clients]] in the Client Management section.
+To group domains with a single client, see [[Products_Management#Moving_a_Product.2FService_to_another_Client|Moving a Product/Service to another Client]] and [[Client_Management#Merging_Clients|Merging Clients]].
 ===Notes===
-The '''Show only Domains with Status Mismatch''' button will display products set to Cancelled, Terminated or Fraud in your WHMCS but exist on the server. This allows a quick audit of accounts that should not be online according to WHMCS but are still online on the server.
-In order to '''login to the client area''' for the first time, clients will need to use the password reset function to set a password. They will then be able to login as normal.
+Enabling '''Show only Domains with Status Mismatch''' displays cancelled, terminated, or fraudulent products that exist on the server. This allows a you to audit accounts that should not be online according to WHMCS but are still online on the server.
+To log in to the Client Area for the first time, clients must use the password reset function to set a password. They can then log in normally.
 ==Common Problems==
 ===Import Failed===
-This error occurs when an account cannot be assigned to a package in WHMCS.  This happens when there is no package setup for the WHM Package Name in WHMCS.  Before performing an import, you must ensure you have setup all the packages in use on the server by accounts you are wanting to import on a package in WHMCS.  To do this, go to '''Setup > Products/Services > Products/Services > Edit > Module Settings tab''', and enter the WHM Package Name such as "demohost_Starter" in the Package Name field on the modules settings tab.
+This error occurs when an account cannot be assigned to a package because the package does not exist in WHMCS. Before importing, make sure to set up all of the packages for the accounts you will import.  To do this, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products and Services|Products/Services]]''' or, prior to WHMCS 8.0,  '''Setup > Products/Services > Products/Services''', click '''Edit''', and, in the '''Module Settings''' tab, enter the WHM Package Name such as "demohost_Starter" in the Package Name field on the modules settings tab.
 ===No Accounts Found===
-Seeing this message suggests WHMCS in unable to connect to your server. If your server requires an SSL connection ensure the Setup > Products/Services > Servers > Edit > Secure checkbox is ticked and try again.
-If the problem persists try creating a new account on the account using WHMCS and if that fails please refer to our [[Troubleshooting Guide]] for what to do next.
+This error indicates that WHMCS cannot connect to your server.
+If your server requires an SSL connection, enable '''Secure''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''. Then, try again.
+If the problem persists, try creating a new account using WHMCS. If that also fails, see [[Troubleshooting Guide]].
 ===Could not resolve host: (Code 6)===
-Encountering a Code 6 cURL error indicates that the ''IP Address'' field in the server configuration is empty. To resolve, navigate to '''Setup > Products/Services > Servers > Edit''' and complete the IP Address field with your server's IP address.
+A Code 6 cURL error indicates that '''IP Address''' in the server configuration is empty. To resolve this, edit the server at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers''' and enter your server's IP address.

Documentation