EasyDCIM Dedicated Servers For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search


About EasyDCIM Dedicated Servers For WHMCS

EasyDCIM Dedicated Servers For WHMCS will allow you to move the provisioning and management of EasyDCIM servers directly to your WHMCS.

The module will let you handle all crucial aspects of created servers, including their status and the SSH password.
Concurrently, your customers will be able to overview their servers, access KVM console, manage rDNS records and more, all without leaving your website.

  • Admin Area Features:
✔ Create/Terminate/Suspend/Unsuspend Server
✔ Boot/Reboot/Shutdown Server
✔ Change Server SSH Access Details
✔ View Server Details
✔ View Server Resource Usage Graphs
✔ Generate Default Configurable Options
✔ Configure Server:
✔ Server Model
✔ Server Location
✔ OS Template
✔ Server Resources
✔ Toggle Automatic Order Acceptance And Server Matching
✔ Define Required Devices
✔ Define Required Item Models:
✔ HDD Model
✔ SSD Model
✔ RAM Model
✔ CPU Model
✔ Define Client Area Features
✔ Choose OS Templates Available For Rebuilding
✔ Choose OS Templates Available For Rebuilding
✔ Control Service Actions And Email Notifications
✔ Determine Monthly Interval Of Bandwidth Usage
✔ Define Percentile Billing Of Bandwidth Overage
✔ One Click Login To EasyDCIM:
✔ User Control Panel
✔ Admin Panel
✔ Toggle Debug Mode
  • Client Area Features:
✔ Boot/Reboot/Shutdown Server
✔ Receive Email Notification On Complete Server Creation
✔ Change Server Hostname
✔ Change Server SSH Password
✔ View Server Details
✔ Access KVM Console (Dell And SuperMicro Servers)
✔ Rebuild Server OS Using OS Templates And Your Own Credentials
✔ View Server Resource Usage Graphs
✔ View Traffic Statistics
✔ One Click Login To User Control Panel
  • Configurable Options:
✔ Server Model
✔ Server Location
✔ OS Template
✔ Bandwidth
✔ Additional IP Addresses
✔ HDD Size
✔ SSD Size
✔ RAM Size
✔ CPU Cores
  • General Info:
✔ Multi-Language Support
✔ Supports EasyDCIM v1.4.1 and Later
✔ Supports PHP 5.4 Up To PHP 7
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V6 and V7

Installation and Configuration

This tutorial will show you how to successfully install and configure EasyDCIM For WHMCS.

We will guide you step by step through the whole installation and configuration process.


1. Log in to our client area and download the module.
ED 1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.

Note: You can check current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.

ED 2.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

ED 2 2.png

Configuration of Server

4. Now, we will show you how to configure a new product.

Go to 'Setup' → 'Products/Services' → 'Servers' and press the 'Add New Server' button.

ED 3.png
5. Next, choose 'EasyDCIM' from the 'Type' dropdown menu.

Fill in your server name, IP address, username and password, then press 'Save Changes'.
Note: The password can be found in your EasyDCIM administrator user profile listed as 'API Key'.

ED 4.png
6. After configuring your server, you can check the connection.

In order to check the connection with an EasyDCIM server, edit the server configuration and press 'Test Connection' as shown on the screen below.

ED 5.png
7. The next step is creating a server group. To do so, click on 'Create Server Group'.
ED 6.png
8. Enter the name, click on your previously created server, press 'Add' and 'Save Changes' afterwards.
ED 7.png

Configuration of Product

9. In order to create and configure a product, go to 'Setup' → 'Products/Services' → 'Products/Services'.

Click on 'Create a New Group'.

ED 8.png
10. Enter the product group name and press 'Save Changes'.
ED 9.png
11. Once you have a product group, you can assign your product to it.

To create a product, click on 'Create a New Product'.

ED 10.png
12. Next, choose your product group, enter your product name and then press 'Continue'.
ED 11.png
13. Now, go to the 'Module Settings' section, choose both 'EasyDCIM' and your previously created server group from dropdown menus.

Do not forget to click 'Save Changes'.

ED 12.png
14. Before configuring the product, set up the EasyDCIM cron job which can be found here.
ED 13.png
15. The module configuration is only partly obligatory. The server will be assigned based on the provided configuration, and will therefore match only those options that have been specified.

Default Options:

  • Model (required) - the EasyDCIM server model
  • Location (required) - a desired server location
  • OS Template - reinstall server with a chosen OS template before delivering it to client
  • Bandwidth - define traffic limitation per server in a preferred monthly cycle
  • Additional IP Addresses - the number of additional IP addresses assigned to a server
  • HDD/SSD/RAM Size - a required amount of memory in specific parts (note: 1GB is equal to 1024 MB)
  • CPU Cores - the number of CPU cores

Product Configuration

  • Auto Accept - automatically run server matching, server will be provisioned in a few moments
  • Require PDU - the provisioned server has to be connected to a PDU device
  • Require Switch - the provisioned server has to be connected to a Switch device
  • Debug Mode - use only when performing troubleshooting
  • Service Access Level - configure the access level to control the features available to your clients. These levels and features are defined in your EasyDCIM at 'Clients' → 'Services' → 'Access Level' tab.

Items Model

  • Specify whether a chosen part has to be of a specific model, e.g. match the server using `Intel Xeon E3-1220 v5` CPU.

Client Area Features

  • Define elements available to your customers in your WHMCS client area.

Service Actions

  • Choose service actions to send chosen email notifications to selected administrators instead of performing provisioning actions immediately.
    Leave the fields unchecked to perform WHMCS module commands in a default manner.

Service Notification

  • Choose the email template that will be sent to the client when creation of the ordered server is finished.
ED 14.png
15. Now, you can optionally generate the default configurable options to allow placing orders tailored to customer needs.

We recommend viewing and modifying them to fit your provisioning capabilities. You can find them under 'Setup' → 'Products/Services' → 'Configurable Options'.
Note: Any configurable option will overwrite its counterpart from the product's 'Module Settings'.

ED 15.png
16. Additionally, you can set up a percentile billing for additional traffic.

Go to the 'Other' tab, enable 'Overages Billing' . First, define the standard overages bandwidth billing and then set the following percentile values:

  • Soft Limit - bandwidth usage in Mbps, after which the customer will be additionally charged for the used transfer
  • Cost - price per Mbps unit above the 'Soft Limit' value

E.g. If 'Soft Limit = 100' and 'Cost = 0.500' and the client exceed the bandwidth to '110 Mbps' , it means that they will be additionally charged with $5 USD amount (10 x 0.500).
Note: The percentile billing required the standard overages bandwidth billing to be enabled. It will be also calculated during the execution of the WHMCS system cron.

ED 15 1.png

Custom Fields

Once the configuration of the module settings has been completed, the following custom fields will be created automatically.
Note: These fields will not be visible to clients by default.
  • OrderID - the number used to link the product with EasyDCIM order number
  • ServerID - the number used to link the product with EasyDCIM server ID
  • bandwidthUsageFromRegistrationDate - if set to 'on' , the billing cycle for transfer usage will be billed monthly starting from the date of product registration (e.g. from the 15th to the 15th of the following month).
    Otherwise, usage charges will be calculated on the last day of each month as in default WHMCS cycle.
  • percentileUsage - the entire current usage, basing on which the value above the one specified previously in the percentile configuration will be calculated.
ED 15 2.png


In this section we will show you all the possibilities of EasyDCIM Dedicated Servers For WHMCS.

Our module allows you to offer and manage EasyDCIM servers right in your WHMCS system.

Admin Area

As soon as you set up a server for a client, you can request various actions and view server details from WHMCS admin area.
The 'Log In To Panel' button allows you to immediately log in to the client's EasyDCIM control panel.
The 'Change Password' action alters the SSH access details to the client's server while 'Update Order Information' allows you to manually check if the server's matching order has been found and assigned.

ED 16.png
Our module allows you to boot/reboot/shutdown server as well as view its details.
ED 17.png
Below the mentioned functions, there are various usage graphs available at your disposal.
ED 18.png

Client Area

In the client area, your customers can view all details concerning their servers, manage their status remotely as well as log in to their EasyDCIM control panel with a single click.
ED 19.png
Additionally, you can explore several usage graphs.
ED 20.png
You can also view information about the traffic billing.

Note: Available time intervals depend on the date of the product registration.

ED 21.png
As well as reinstall OS on your server.
ED 22.png
Moreover, it is possible to control your reverse DNS. You can either edit the already existing records or create new ones.
ED 23.png
To create a record, just fill in the necessary information.
ED 24.png
Your newly created record will appear on the list.
ED 25.png
If you are using Dell or SuperMicro servers you can also access the KVM console.
ED 26.png
It will launch a Java applet that will automatically connect to your server.

Note: Your browser needs to have Java enabled with the correct permissions to make the console functioning.

ED 27.png


1. Note that placing two identical orders may result in assigning servers with slightly different parameters.

It stems from the way EasyDCIM server matching works. It matches a server basing on the resources and models mentioned in the order, without considering other resources.
While it attempts to find a server matching the order completely, in case it fails, server that fulfills more requirements than others will be assigned.
More information about server provisioning flow can be found on EasyDCIM documentation page.

2. As this server supports the templates system, any changes made in the server's templates files will be saved after the upgrade process.
3. Since the 1.3.0 version, the 'monthlyTrafficLimit|Monthly Traffic Limit' configurable option has been changed to 'Bandwidth|Bandwidth' .
Remember to change it manually after updating the module.

Update Instructions

Essential guidance through the process of updating the module is offered here.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Personal tools

WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
EasyDCIM Dedicated Servers For WHMCS