Adding a cPanel Server and Products
cPanel is an online Linux-based graphical interface (GUI) used as a control panel to simplify website and server management.
First, you need to configure the plugin in Clientexec's server section.
Go to Settings > Products > Servers. Now you need to add your cPanel server by clicking Add Server.
Normally these will be your main domain's name servers, but if you are unsure you can check: Server Configuration > Basic cPanel & WHM Setup > Nameservers
These will be used for dedicated IP's for your customers, this allows you to show the correct information to your customers inside Clientexec and your Welcome Emails.
API tokens in cPanel & WHM allow you to restrict the actions that an API token can perform. The following permissions must be granted for Clientexec in WHM at Development >> Manage API Tokens.
basic-whm-functions
basic-system-info
cpanel-api
create-acct
create-user-session
suspend-acct
upgrade-account
kill-acct
passwd
acct-summary
list-accts
show-bandwidth
list-pkgs
If you have not already added any products, follow these instructions here.
Then the Next step is that we need to allow your products to use the cPanel server we just created.
In your ClientExec admin area, click: Settings > Product > Products.
Sort your list by the Product Group that will be using cPanel.
Now, you need to setup your packages to utilize the server you just setup.
Click on Settings > Products > Products
Now choose the first product you will be using with cPanel, Example: Basic Package. This will be assuming you have setup your packages already.
Now click on the Advanced & Plugin Settings tab.
Click the box, and choose the drop-down option that says cPanel or whatever title you put in the server name field.
For the Package Name, you need to enter it exactly how it appears in your WHM.
To check the exact package name you can go to: Main >> Packages >> Edit a Package inside WHM.
*Note. You do NOT need to fill out any of the info below the package name UNLESS it is indeed a reseller package.
If you wish to have the package created automatically after the Order Processor service has been ran, go back to the General Tab and check the "Automatically Activate package?" box.
Important: In the package settings, do not uncheck Hide Hosting Custom Fields
Please keep in mind you will need to repeat this process for each package that will be using the cPanel server.
Supported Features
| Create | Suspend | Unsuspend | Terminate | Change Package | Change Password | Client Area Link |
|---|---|---|---|---|---|---|
| Yes | Yes | Yes | Yes | Yes | Yes | Yes |
Get Started
First, you need to configure the plugin in Clientexec's server section.
Go to Settings > Products > Servers. Now you need to add your cPanel server by clicking Add Server.
Add Server Menu
| Field Name | Description |
|---|---|
| Server Name | Friendly name, How you will see it inside Clientexec. |
| Hostname | Found in your WHM, Networking Setup >> Change Hostname >> Current Hostname (Ex. server.yourdomain.com) |
| Shared IP | Found in your WHM, Server Configuration >> Basic cPanel & WHM Setup >> "The IP address (only one address) that will be used for setting up shared IP virtual hosts." Box. |
| Plugin | cPanel. |
| Maximum # of Accounts | Set this to 0(unlimited) unless limited by your Host. |
Name Servers:
Normally these will be your main domain's name servers, but if you are unsure you can check: Server Configuration > Basic cPanel & WHM Setup > Nameservers
IP Addresses (one per line):
These will be used for dedicated IP's for your customers, this allows you to show the correct information to your customers inside Clientexec and your Welcome Emails.
API Token Permissions
API tokens in cPanel & WHM allow you to restrict the actions that an API token can perform. The following permissions must be granted for Clientexec in WHM at Development >> Manage API Tokens.
basic-whm-functions
basic-system-info
cpanel-api
create-acct
create-user-session
suspend-acct
upgrade-account
kill-acct
passwd
acct-summary
list-accts
show-bandwidth
list-pkgs
Plugin Configuration:
| Field Name | Description |
|---|---|
| Username | The same username you use when logging into WHM.(VPS Owners is normally "root") |
| API Token | API Tokens can be found at "Manage API Tokens" in WHM. |
| Use SSL | Recommended, this will allow you to send all data with encryption. |
| Failure Email | Anytime there is an error received from cPanel, it will be sent to this email. (Ex. Username already taken!) |
Add Products
If you have not already added any products, follow these instructions here.
Then the Next step is that we need to allow your products to use the cPanel server we just created.
In your ClientExec admin area, click: Settings > Product > Products.
Sort your list by the Product Group that will be using cPanel.
Now, you need to setup your packages to utilize the server you just setup.
Click on Settings > Products > Products
Now choose the first product you will be using with cPanel, Example: Basic Package. This will be assuming you have setup your packages already.
Now click on the Advanced & Plugin Settings tab.
Click the box, and choose the drop-down option that says cPanel or whatever title you put in the server name field.
For the Package Name, you need to enter it exactly how it appears in your WHM.
To check the exact package name you can go to: Main >> Packages >> Edit a Package inside WHM.
*Note. You do NOT need to fill out any of the info below the package name UNLESS it is indeed a reseller package.
If you wish to have the package created automatically after the Order Processor service has been ran, go back to the General Tab and check the "Automatically Activate package?" box.
Important: In the package settings, do not uncheck Hide Hosting Custom Fields
Please keep in mind you will need to repeat this process for each package that will be using the cPanel server.
Updated on: 10/08/2024
Thank you!