Personal tools
Namespaces

Variants
Actions

EasyDCIM Dedicated Servers For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Client Area)
(→‎About EasyDCIM Dedicated Servers For WHMCS)
 
(143 intermediate revisions by 8 users not shown)
Line 2: Line 2:
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The EasyDCIM Dedicated Servers For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The EasyDCIM Dedicated Servers For WHMCS Module."></meta>
  
−
=About [http://www.modulesgarden.com/products/whmcs/easydcim_dedicated_servers/features EasyDCIM Dedicated Servers For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/easydcim-dedicated-servers EasyDCIM Dedicated Servers For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''EasyDCIM Dedicated Servers For WHMCS''' will allow you to move provisioning and management of EasyDCIM servers directly to your WHMCS.<br/>
+
|style="padding: 10px 0px 10px 0px;"|'''EasyDCIM Dedicated Servers For WHMCS''' will allow you to move the provisioning and management of [https://www.easydcim.com EasyDCIM] servers directly to your WHMCS.<br/>
−
Module will let your clients overview and manage their servers directly from your client area.<br/> They will be able to for example reboot servers or view resource usage graphs.
+
The module will let you handle all crucial aspects of created servers, including the bandwidth usage calculation intervals and the percentile billing of its overages.<br/>
 +
Concurrently, your customers will be able to overview their servers, access KVM console, manage rDNS records and more, all without leaving your website.<br/>
 +
<br/>
 +
If you are still using the module in version 1.x and need its documentation, you will find it under [https://www.docs.modulesgarden.com/EasyDCIM_Dedicated_Servers_V1.X_For_WHMCS this page].
 
|}
 
|}
 
<!-- fixed -->
 
<!-- fixed -->
Line 13: Line 16:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Boot/Reboot/Shutdown Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Update Order Information
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Server SSH Access Details
+
|style="padding: 0px 0px 0px 30px;"|✔ Start/Stop/Reset/BMC Cold Reset Server
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Server Details
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Rescue Mode
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Server Resource Usage Graphs
+
|style="padding: 0px 0px 0px 30px;"|✔ Access KVM Java Console (Dell And Supermicro Servers)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Generate Default Configurable Options
+
|style="padding: 0px 0px 0px 30px;"|✔ Access noVNC KVM Console (AMI, Dell, HP And Supermicro)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Configure Server:
+
|style="padding: 0px 0px 0px 30px;"|✔ One Click Login To User Control Panel
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Server Model
+
|style="padding: 0px 0px 0px 30px;"|✔ View Server, General And Location Information:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Server Location
+
|style="padding: 0px 0px 0px 45px;"|✔ View Server ID And Order ID In EasyDCIM Panel
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ OS Template
+
|style="padding: 0px 0px 0px 30px;"|✔ View Server Resource Statistics:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Server Resources
+
|style="padding: 0px 0px 0px 45px;"|✔ Bandwidth Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Automatic Order Accepting And Server Matching
+
|style="padding: 0px 0px 0px 45px;"|✔ Aggregate Traffic
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Required Devices
+
|style="padding: 0px 0px 0px 45px;"|✔ Ping
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Required Item Models:
+
|style="padding: 0px 0px 0px 45px;"|✔ Status
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ HDD Model
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Product Details:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ SSD Model
+
|style="padding: 0px 0px 0px 45px;"|✔ Default Server Options:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ RAM Model
+
|style="padding: 0px 0px 0px 60px;"|✔ Server Model
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ CPU Model
+
|style="padding: 0px 0px 0px 60px;"|✔ Server Location
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Client Area Features
+
|style="padding: 0px 0px 0px 60px;"|✔ OS Template
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Toggle Debug Mode
+
|style="padding: 0px 0px 0px 60px;"|✔ Number Of Additional IP Addresses
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Disk Layout
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Extras
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Automation Settings:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Automatic Order Acceptance And Server Matching
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Define Required Devices:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 75px;"|✔ PDU
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 75px;"|✔ Switch
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Block Automatic WHMCS Suspension/Unsuspension/Termination
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Block Automatic Update Of Additional/Dedicated IP Addresses
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Toggle WHMCS Order Actions
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Define Bandwidth Notification Limit
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Control Service Access Level
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Replacements For EasyDCIM Order Actions On:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Activation
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Suspension
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Unsuspension
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Termination
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Additional Part Requirements:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ HDD Models
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ SSD Models
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ RAM Models
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ CPU Models
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Additional Metadata Requirements
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Client Area Features:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Service/General/Location Information
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Graphs
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Server Actions
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Overview Tables
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Extensions Access
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ OS Installation Actions
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 60px;"|✔ Available OS Templates For Rebuilding
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Control Service Actions And Email Notifications
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Generate Default And Additional Parts Configurable Options
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Determine Monthly Interval Of Bandwidth Usage
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Percentile Billing Of Bandwidth Overages
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Use EasyDCIM Merge Fields In Email Templates
 
|}
 
|}
  
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Boot/Reboot/Shutdown Server
+
|style="padding: 10px 0px 0px 30px;"|✔ Create/Terminate/Suspend/Unsuspend Server
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Server SSH Password
+
|style="padding: 0px 0px 0px 30px;"|✔ Receive Email Notification On Complete Server Creation
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Server Details
+
|style="padding: 0px 0px 0px 30px;"|✔ Start/Stop/Reset/BMC Cold Reset Server
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Reinstall Server OS Using OS Templates
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Rescue Mode
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Server Resource Usage Graphs
+
|style="padding: 0px 0px 0px 30px;"|✔ Access KVM Java Console (Dell And Supermicro Servers)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ View Traffic Statistics
+
|style="padding: 0px 0px 0px 30px;"|✔ Access noVNC KVM Console (AMI, Dell, HP And Supermicro)
 
|}
 
|}
−
 
−
*'''General Info:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 30px;"|✔ One Click Login To User Control Panel
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7
+
|style="padding: 0px 0px 0px 30px;"|✔ View Server, General And Location Information
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|style="padding: 0px 0px 0px 30px;"|✔ View Bandwidth Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V6 and V7
+
|style="padding: 0px 0px 0px 30px;"|✔ View Server Resource Statistics:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Aggregate Traffic
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Ping
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Status
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Add Custom ISO Images To Server
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Rebuild Server Using OS Templates And Your Own Credentials
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Manage Reverse DNS Records
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ View Access List With Stored Passwords
 
|}
 
|}
  
Line 115: Line 245:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Monthly Traffic Limit
+
|style="padding: 0px 0px 0px 30px;"|✔ Disk Layout
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Additional IP Addresses
+
|style="padding: 0px 0px 0px 30px;"|✔ Bandwidth
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ HDD Size
+
|style="padding: 0px 0px 0px 30px;"|✔ Number Of Additional IP Addresses
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ SSD Size
+
|style="padding: 0px 0px 0px 30px;"|✔ Custom Device
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ RAM Size
+
|style="padding: 0px 0px 0px 30px;"|✔ Metadata
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ CPU Cores
+
|style="padding: 0px 0px 0px 30px;"|✔ HDD Size (Of Any Additional Parts)
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ SSD Size (Of Any Additional Parts)
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ RAM Size (Of Any Additional Parts)
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ CPU Cores (Of Any Additional Parts)
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Custom - To Be Displayed In EasyDCIM Service Configuration
 +
|}
 +
 
 +
*'''Advanced Billing Integration:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Bill For Current In/Out/Total Bandwidth Usage
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Apply 95th Percentile Billing Of In/Out/Total Bandwidth Overages
 +
|}
 +
 
 +
*'''Supported Server Manufacturers:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ AMI
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Dell
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ HP
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Supermicro
 +
|}
 +
 
 +
*'''General Info:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"| ✔ Integrated With [https://www.modulesgarden.com/products/whmcs/advanced-billing#features Advanced Billing For WHMCS] - Actual Server Resource Usage Billing
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"| ✔ Integrated With [https://www.modulesgarden.com/products/whmcs/products-reseller#features Products Reseller For WHMCS] - End-To-End Solution For Products And Servers Reselling
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"| ✔ Integrated With [https://www.modulesgarden.com/products/whmcs/server-allocator#features Server Allocator For WHMCS] - Automatic Assignment Of Most Suitable Servers To Products
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports [https://www.easydcim.com EasyDCIM] v1.9.6 And Later
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.6
 +
|}
 +
 
 +
*'''Exclusive Promo Code From ModulesGarden:'''
 +
{|
 +
|style="padding: 10px 0px 30px 30px;"|✔ '''Save 20%''' For '''3 Months''' On The EasyDCIM Control Panel With Coupon: '''WHMCS20%_ED'''
 
|}
 
|}
  
 
=Installation and Configuration=
 
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure EasyDCIM For WHMCS.'''<br/>
+
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/easydcim-dedicated-servers EasyDCIM V2 For WHMCS.]'''<br/>
 
We will guide you step by step through the whole installation and configuration process.
 
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 
==Installation==
 
==Installation==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download EasyDCIM For WHMCS.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_1.png]]
 
|}
 
|}
 +
<!-- z uwagi na opensource paczki nie sa juz kodowane wiec OUT
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br/>
+
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/>
−
Files in your WHMCS directory should look like these.
+
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ED_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP74_81.png]]
 
|}
 
|}
 +
-->
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''2. Extract the package and upload its content into the main WHMCS directory.'''<br />
 +
The content of the package to upload should look like this.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px; color: #ff0000;"|If you are about to update your '''EasyDCIM Dedicated Servers''' module from '''v1 to v2'''? Remember to '''strictly follow the update instructions''' described at the bottom of this '''[[#Update_Instructions|documentation]]'''!
 +
|}
 +
 
==Configuration of Server==
 
==Configuration of Server==
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'''3. Now, we will show you how to configure a new product.'''<br/>
 
|style="padding: 10px 0px 15px 15px;"|'''3. Now, we will show you how to configure a new product.'''<br/>
−
Go to '' 'Setup' → 'Products/Services' → 'Servers' '' and press '' 'Add New Server' '' button.
+
Go to '' 'Setup' → 'Products/Services' → 'Servers' '' and press the '' 'Add New Server' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. Next, choose '' 'EasyDCIM' '' from '' 'Type' '' dropdown menu.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''4. Next, choose '' 'EasyDCIMv2' '' from the '' 'Module' '' dropdown menu.<br/>
−
Fill in your server name, IP address, username and password and press '' 'Save Changes'.''<br/>
+
Fill in your server "Name", "IP address" or "Hostname", and the "Password", then press '' 'Save Changes'.''<br/> Remember '''not''' to use SSL Mode for Connection, keep this option disabled or otherwise you will encounter errors when testing the server connection. <br/>
−
Password can be found in your EasyDCIM administrator user profile listed as '' 'API Key'.''
+
'' '''Note:''' The password can be found in your EasyDCIM administrator user profile listed as '[https://www.docs.modulesgarden.com/images/9/99/E_API_Key.png API Key]'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. After configuring your server, you can check connection.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''5. After configuring your server, you can check the connection.'''<br/>
−
In order to check connection with a EasyDCIM server, edit server configuration and press '' 'Test Connection' '' as shown on the screen below.  
+
In order to check the connection with an EasyDCIM server, edit the server configuration and press '' 'Test Connection' '' as shown on the screen below.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''6. It is time to create a server group, to do so click on '' 'Create Server Group'.''
+
|style="padding: 0px 0px 20px 15px;"|'''6. The next step is creating a server group. To do so, click on '' 'Create Server Group'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_6.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''7. Enter name, click on your previously created server, press '' 'Add' '' and afterwards '' 'Save Changes'.'''''
+
|style="padding: 0px 0px 20px 15px;"|'''7. Enter the name, click on your previously created server, press '' 'Add' '' and '' 'Save Changes' '' afterwards.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ED_7.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ED2_7.png]]
 
|}
 
|}
  
 
==Configuration of Product==
 
==Configuration of Product==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''8. In order to create and configure a product go to '' 'Setup' → 'Products/Services' → 'Products/Services'.'''''<br/>
+
|style="padding: 10px 0px 15px 15px;"|'''9. In order to create and configure a product, go to '' 'Setup' → 'Products/Services' → 'Products/Services'.'''''<br/>
 
Click on '' 'Create a New Group'.''
 
Click on '' 'Create a New Group'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_8.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''9. Enter product group name and press '' 'Save Changes'.'''''
+
|style="padding: 0px 0px 20px 15px;"|'''10. Enter the product group name and press '' 'Save Changes'.'''''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''10. When you have a product group, you can assign your product to it.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''11. Once you have a product group, you can assign your product to it.'''<br/>
−
To create a product click on '' 'Create a New Product'.''
+
To create a product, click on '' 'Create a New Product'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''11.  Afterwards, choose your product group, enter your product name and then press '' 'Continue'.'''''
+
|style="padding: 0px 0px 15px 15px;"|'''12.  Next, choose your the product type, assign it to a group of similar products, enter your product name, select module: '' 'EasyDCIMv2' '' and then press '' 'Continue'.'''''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_11.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_11.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''12. Now go to '' 'Module Settings' '' section, choose both '' 'EasyDCIM' '' and your previously created server group from dropdown menus.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''13. Now, go to the '' 'Module Settings' '' section, choose both '' 'EasyDCIM' '' and your previously created server group from dropdown menus.<br/>
−
Next, '' 'Save Changes'.'''''
+
Do not forget to click '' 'Save Changes'.'''''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_12.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''13. Before configuring product, set up EasyDCIM cron job which can be found here.
+
|style="padding: 0px 0px 20px 15px;"|'''14. 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.<br/>
 +
 
 +
''Default Options'' - these options will be used for an order placement in EasyDCIM when the service is ordered and activated in WHMCS:
 +
*'''Server 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
 +
*'''Additional IP Addresses Number''' - the number of additional IP addresses assigned to a server
 +
*'''Disk Layout''' - choose the disk layout addons for the chosen template and location
 +
*'''Extras''' - choose additional addons for the chosen template and location
 +
 
 +
''Automation Settings'' - define actions related to this product, they will be executed automatically based on the actions taken in WHMCS:
 +
*'''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
 +
*'''Block Automatic Suspension by WHMCS''' - when activated, this feature '''prevents automatic suspension of the server''' in EasyDCIM when a suspension occurs in WHMCS. An email notification will be sent to the administrator only.
 +
*'''Block Automatic Unsuspension by WHMCS''' - when activated, this feature '''prevents automatic unsuspension of the server''' in EasyDCIM when an unsuspension action occurs in WHMCS. An email notification will be sent to the administrator only.
 +
*'''Block Automatic Termination by WHMCS''' - when activated, this feature '''prevents automatic termination of the server''' in EasyDCIM when the server is termianted in WHMCS. An email notification will be sent to the administrator only.
 +
*'''Block Automatic Update Of Additional IP Addresses''' - if enabled, the service '''additional IP addresses will not be automatically updated''' when the service is synchronized or updated by cron.
 +
*'''Block Automatic Update Of Dedicated IP Address''' - if enabled, the service '''dedicated IP address will not be automatically updated''' when the service is synchronized or updated by cron.
 +
*'''WHMCS Order Actions''' - enabling this feature allows WHMCS module actions to take precedence over EasyDCIM's default order actions. To specify these actions, please refer below to the dedicated exclusively to 'Order Actions' section.
 +
*'''Bandwidth Notification Limit [GB]''' - set up the limit of bandwidth per month. When exceeded, the administrator will be notified about it directly in EasyDCIM.<br/> Note that it is '''NOT a HARD limit of bandwidth''' nor is it used for any billing. To enable billing, please use the Usage Billing feature.
 +
<!--*'''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' → '[[Media:ED_Easy_1.png|Access Level]]' tab.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_14.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''14. Module configuration is partially non-mandatory. The server will be assigned basing on the defined configuration and matching only the filled out options.
+
|style="padding: 0px 0px 20px 15px;"|In the ''Order Actions'' section, you can specify the exact action to be applied to an EasyDCIM order based on specific actions in WHMCS.<br/>
−
'''Default Options:'''
+
Please note that the 'WHMCS Order Actions' feature in the Automation Settings section above must be enabled. Once activated, the actions configured below will replace EasyDCIM's default order actions.
−
*Model (required) - EasyDCIM server model
+
*'''Order Activation Actions''' - choose from below the actions that will be applied to EasyDCIM order '''on the WHMCS product activation''':
−
*Location (required) - desired server location
+
**[OS Installation] Install Operating System
−
*OS Template - reinstall server with a chosen OS template before delivering it to client
+
**Ebanle Traffic Aggregation ports
−
*Monthly Traffic Limit - bandwidth limit per server
+
**Boot a device
−
*Additional IP Addresses - number of additional IP addresses assigned to a server
+
**Delete RRD files with graphs and traffic data
−
*HDD/SSD/RAM Size - required amount of memory in specific parts, note 1GB is equal to 1024 MB
+
**Delete notifications
−
*CPU cores - number of CPU cores<br/>
+
**[IPMI Integration] Crate Operator Account
−
'''Product Configuration'''
+
**[IP Address Management] Assign Subnet
−
*Auto Accept - automatically run server matching, server will be provisioned in a few moments
+
**[DNS Management] Crate Zone
−
*Require PDU - provisioned server must be connected to a PDU device
+
**[DNS Management] Delete zones and rDNS records
−
*Require Switch - provisioned server must be connected to a Switch device
+
**[DNS Management] Create rDNS records
−
*Debug Mode - use only if you are troubleshooting<br/>
+
**[Usage Collector]Set the monthly traffic limit (IN/OUT)
−
'''Item Model'''<br/>
+
*'''Order Suspension Actions''' - choose from below the actions that will be applied to EasyDCIM order '''on the WHMCS product suspension''':
−
Basically, define if a chosen part has to be of a specific model, for example match server using `Intel Xeon E3-1220 v5` CPU.<br/>
+
**Shut down a device
−
'''Client Area Features'''<br/>
+
**Disable traffic aggregation ports
−
Define elements available to your client in your WHMCS client area.
+
**[IPMI Integration] Delete Operator Account
 +
*'''Order Unsuspension Actions''' - choose from below the actions that will be applied to EasyDCIM order '''on the WHMCS product unsuspension''':
 +
**Boot a device
 +
**Enable traffic aggregation ports
 +
**[IPMI Integration] Create Operator Account
 +
*'''Order Termination Actions''' - choose from below the actions that will be applied to EasyDCIM order '''on the WHMCS product termination''':
 +
** Shut down a device
 +
**Disable traffic aggregation ports
 +
**Delete RRD files with graphs and traffic data
 +
**Clear Hostname Value
 +
**Clear Additional IP Addresses Value
 +
**Unassign DEvice Parts
 +
**[IP Addresses Managemnt] Unassign Subnet
 +
**Delete notifications
 +
**[OS Insatllation] REinstall OS
 +
**[IPMI Integartion] Delete Operator Account
 +
**[DNS Management] Delete zones and rDNS record
 +
**[Usage Collector] Remove the monthly traffic limit (IN/OUT)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_14_0.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''15. Now, optionally you can generate default configurable options to allow orders tailored to your clients needs.<br/>
+
|style="padding: 0px 0px 20px 15px;"|''Client Area Features'' - define the features and information that will be available for customers in the client area. <br/>
−
We recommend viewing and modifying them to fit your provisioning capabilities. You can find them under '' 'Setup' → 'Products/Services' → 'Configurable Options'.''<br/>
+
Select elements for every section in the client area that will be available to your customers:
−
''Note: Any configurable option will overwrite its counterpart from product 'Module Settings'.''
+
*'''Service Information'''  
 +
**Server ID
 +
**Label
 +
**Device Status
 +
**Hostaname
 +
**Change Hostane
 +
**IP Address
 +
**OS Template
 +
**MAC Address
 +
**Installation Status
 +
**Custom Metadata (choose from dropdown menu)
 +
*'''General Information'''
 +
**Status
 +
**Order ID
 +
**Service Model
 +
**Serial Number
 +
**Purchase Date
 +
**Warranty Months
 +
*'''Location Information'''
 +
**Location Name
 +
**Labeled Rock with position
 +
**Floor
 +
**Address
 +
**Phone Number
 +
**Description
 +
*'''Graphs'''
 +
**Ping
 +
**Status
 +
**Aggregate Traffic
 +
*'''Server Actions'''
 +
**Reboot Server
 +
**Shut Down Server
 +
**BMC Cold Reset
 +
**Enable Rescue Mode
 +
**Auto Login Link
 +
**KVM Java Console
 +
**noVNC KVM Console
 +
*'''Overview Tables'''
 +
**Hide Server Information Table
 +
**Hide General Information Table
 +
**Hide Location Table
 +
**Hide Bandwidth Usage Table
 +
*'''Extensions'''
 +
**Device Statistics
 +
**OS Installation
 +
**DNS Management
 +
**Password Management
 +
*'''OS Installation Actions'''
 +
**Rebuild Server
 +
**ISO Images
  
 +
*'''OS Templates''' - selects the OS Templates that will be available for clients to choose from when reinstalling the server
 +
 +
'''Email Notification'''
 +
*'''Create Server Action Notification (To Client)''' - Choose the email template that will be sent to the client when creation of the ordered server is finished.
 +
*'''Notified Administrator''' - choose the WHCMCS administrator who will receive the below described notifications about certain actions performed on the services
 +
*'''Suspend Action Notification''' - select the email template that will be used to notify about suspending the service
 +
*'''Unsuspend Action Notification''' - select the email template that will be used to notify about unsuspending the service
 +
*'''Terminate Action Notification''' - select the email template that will be used to notify about terminating the service
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_14_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''15. Choose parts from the dropdown menu and provide their values. They will be available for clients while placing an order.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_13.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_13_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''16. Alike parts, you may configure extra metadata that will be required to choose for clients while placing an order.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_13_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_13_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''17. Now, you can optionally generate the default configurable options to allow placing orders tailored to your customers' needs.<br/>
 +
We recommend viewing and modifying them to fit your provisioning capabilities. You can find them under '' 'System Settings' → 'Configurable Options'.''<br/>
 +
'' '''Note:''' You can also add '''your own''' configurable options which will be then displayed under 'Service Configuration' in your EasyDCIM backend.''<br/>
 +
'' '''Important:''' Any configurable option will overwrite its counterpart from the 'Module Settings' of a product.''<br/>
 +
'' '''Important:''' If you create general configurable options, remember to refresh the page in order to successfully assign the newly generated configurable options to a product<br/> and then to be able to generate and allot configurable options to additional parts. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_15.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_15_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_15_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_15_5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''18. Additionally, you can set up a percentile billing for additional traffic.'''<br />
 +
'' '''Note:''' This option is possible only if you do '''not''' have [https://www.modulesgarden.com/products/whmcs/advanced-billing Advanced Billing Form WHMCS] module installed. If you need a bit more advanced billing integration, please go [[#Advanced Billing Integration|here]] for more information. <br/>
 +
Go to the '' 'Other' '' tab and enable '' 'Overages Billing'''. First, define the standard [https://docs.whmcs.com/Disk_Space_and_Bandwidth_Overage_Billing overages bandwidth billing] and then set the following percentile values:
 +
*Soft Limit - bandwidth usage in Mbps above 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 exceeds the bandwidth by 10 Mbps, reaching to '' '110 Mbps' '', they will be additionally charged with ''$5 USD'' (''10 x 0.500''). <br />
 +
'' '''Note:''' The percentile billing requires the standard billing of bandwidth  overages to be enabled. It will be also calculated during the execution of the [https://docs.whmcs.com/Crons#System_Cron WHMCS system cron].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:ED2_15_3.png]]
 +
|}
 +
 +
==Custom Fields==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|'''Once the configuration of the module settings has been completed, the following custom fields will be created automatically.''' <br />'' '''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). <br />Otherwise, usage charges will be calculated on the last day of each month as in [https://docs.whmcs.com/Disk_Space_and_Bandwidth_Overage_Billing default WHMCS cycle].-->
 +
*percentileUsage - the entire current usage. If the value specified previously in the percentile configuration is exceeded, the additional charge will be calculated accordingly.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ED_15.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ED2_15_4.png]]
 
|}
 
|}
  
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you all the possibilities of EasyDCIM For WHMCS.'''<br/>
+
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you all possibilities of EasyDCIM Dedicated Servers For WHMCS.'''<br/>
−
Our module allows you to offer EasyDCIM via your WHMCS system.
+
Our module allows you to offer and manage EasyDCIM servers right in your WHMCS system.
 
|}
 
|}
 
==Admin Area==
 
==Admin Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|As soon as you set up a server for a client, you can request various actions and view server details from WHMCS admin area.<br/>
+
|style="padding: 10px 0px 15px 15px;"|
−
'' 'Change Password' '' action changes SSH access details to the client's server while '' 'Update Order Information' '' allows you to manually check if server matching order has been found and assigned.
+
As soon as you set up a server for a client, you can request various actions and view server details from the WHMCS admin area.<br/>
 +
The '' 'Log In To Panel' '' button allows you to immediately log in to the client's EasyDCIM control panel.<br/>
 +
The '' 'Update Order Information' '' allows you to manually check if a server matching the one specified in the order has been found and assigned.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_16.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Our module allows you to boot/reboot/shutdown server as well as view its details.
+
|style="padding: 0px 0px 20px 15px;"|Our module allows you to:
 +
* start/stop/reset server,
 +
* force BMC cold reset of the server
 +
* enable rescue mode
 +
* use KVM Java console/ no VNC KVM console
 +
* view and edit server information
 +
* view general and server location information
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_17.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Below them, there are various usage graphs are available at your disposal.
+
|style="padding: 0px 0px 15px 15px;"|Below the mentioned functions, there are various usage graphs and statistics available at your disposal.<br/>
 +
'' '''Note:''' By default, there are 4 types of statistics generated and updated live. If you need more, you can add them through the '''configuration.json''' file located in /yourWHMCS/modules/servers/EasyDCIMv2/Config. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ED_18.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ED2_18.png]]
 
|}
 
|}
  
 
==Client Area==
 
==Client Area==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In the client area of the module your customers can view all details concerning their servers as well as manage the status.
+
|style="padding: 10px 0px 15px 15px;"|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.<br/>
 +
Other available actions on the server: Start, Stop, Reset, BMC Cold reset, Enable Rescue Mode.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_19.png]]
 
|}
 
|}
 +
 +
===Device Statistics===
 +
====View Graphs====
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Additionally, below you can find numerous usage graphs.
+
|style="padding: 10px 0px 15px 15px;"|This section allows to view information on the total traffic on all of your devices in a form of a clear graph.<br />
 +
'' '''Note:''' Available time intervals depend on the date of the product registration.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_20.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ED2_21_1.png]]
 
|}
 
|}
 +
 +
===ISO Images===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can also view information about traffic billing.
+
|style="padding: 10px 0px 20px 15px;"|In the ''ISO Images'' section you may add custom ISO images to their servers.<br/>
 +
'''''Important:''' ISO images are used to manually install the operating system. If you want to use an ISO image, you cannot perform an automatic OS installation within EasyDCIM.<br/> Available ISO images are accessible when a noVNC session is used. The images will be automatically mounted when creating a noVNC session in the “/home/iso” directory.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_21.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_21_0.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|As well as reinstall OS on your server.
+
|style="padding: 0px 0px 20px 15px;"|Type in your custom name of the ISO image and provide a direct URL to the .iso files. <br/> Press the adequate button to confirm the action.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_22.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ED2_22_0.png]]
 
|}
 
|}
 +
===OS Installation===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Moreover, it is possible to control your reverse DNS. You can either edit the already existing records or create new ones.  
+
|style="padding: 10px 0px 20px 15px;"|The ''OS Installation'' section gives the possibility to reinstall OS on the client's server.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_22.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To create a record just fill in the necessary information.
+
|style="padding: 0px 0px 15px 15px;"|Select the OS template to reinstall and provide all the necessary details to proceed with the reinstallation. <br/> Confirm your decision in the end.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_24.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ED2_22_1.png]]
 
|}
 
|}
 +
 +
===DNS Management===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Your newly created record will appear on the list.
+
|style="padding: 10px 0px 20px 15px;"|It is possible for your clients to control their reverse DNS. They can either edit the already existing records or create new ones.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ED_25.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_23.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|To create a record, all your clients need to do is fill in the necessary information. The newly created record will immediately appear on the list.
 +
If you want to create just one record, then please leave the '' 'Mask' '' field empty.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:ED2_24.png]]
 
|}
 
|}
 +
 +
===Password Management===
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Move to the ''Password Management'' section to see a full list of all stored passwords. Press the icon next to the password to show/hide it.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:ED2_25.png]]
 +
|}
 +
 +
===KVM Java Console===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|If your clients are using ''Dell'' or ''SuperMicro'' servers, they can access the KVM Java console.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_26.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|It will launch a ''Java'' applet that will automatically connect to your client's server.<br/>
 +
'' '''Note:''' The browser needs to have Java enabled with the correct permissions to make the console functioning.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:ED2_27.png]]
 +
|}
 +
 +
===noVNC KVM Console===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|For clients using the '' 'American Megatrends', 'Dell', HP' '' and '' 'Supermicro' '' servers there is available access to the noVNC KVM console.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_28.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|noVNC KVM Console in contrast to KVM Console is not downloaded directly on the client's device, EasyDCIM connects with proxy server via VNC to allow the remote session.
 +
|}
 +
 +
==Email Templates Merge Fields==
 +
{|
 +
|style="padding: 10px 0px 5px 15px;"|Whmcs [https://docs.whmcs.com/Email_Templates#Merge_Fields Email Templates] are compatible with EasyDCIM and you may easily include EasyDCIM data in their content. <br/>
 +
In this section you will learn how to create merge fields that then can be used in email templates that you send to your clients.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 5px 15px;"|The pattern of creating acceptable by WHMCS merge fields is very easy:
 +
Let's take '''IP address'''  as an exemplary EasyDCIM metadata. The WHMCS variable will be '''{$easydcim_ip_address}'''. As you have surely noticed:
 +
*variables use lower case only
 +
 +
*use underscore '_' in place of every free space
 +
 +
*insert '' 'easydcim_' '' prefix in the beginning
 +
<br/>
 +
A WHMCS variable with information on EasyDCIM matadata is ready to use!
 +
|}
 +
{|
 +
|style="padding: 0px 0px 5px 15px;"|Here you can find a list of exemplary ready made variables:
 +
|}
 +
{| class="wikitable"  style="margin-left: 25px; margin-bottom: 30px;  width: 30%;"
 +
! style="font-weight:bold; background-color:#c0c0c0;" | EasyDCIM Metadata
 +
! style="font-weight:bold; background-color:#c0c0c0;" | WHMCS Merge Fields
 +
|-
 +
| style="background-color:#efefef;" | Hostname
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_hostname}
 +
|-
 +
| style="background-color:#efefef;" | IP Address
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ip_address}
 +
|-
 +
| style="background-color:#efefef;" | Additional IP Addresses
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_additional_ip_addresses}
 +
|-
 +
| style="background-color:#efefef;" | All IP Addresses
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_all_ip_addresses}
 +
|-
 +
| style="background-color:#efefef;" | IPMI Enabled
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_enabled}
 +
|-
 +
| style="background-color:#efefef;" | IPMI IP Address
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_ip_address}
 +
|-
 +
| style="background-color:#efefef;" | IPMI Username
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_username}
 +
|-
 +
| style="background-color:#efefef;" | IPMI Password
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_password}
 +
|-
 +
| style="background-color:#efefef;" | IPMI Board Type
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_board_type}
 +
|-
 +
| style="background-color:#efefef;" | IPMI Protocol Version
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_protocol_version}
 +
|-
 +
| style="background-color:#efefef;" | IPMI Driver
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_driver}
 +
|-
 +
| style="background-color:#efefef;" | IPMI Proxy Server
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_proxy_server}
 +
|-
 +
| style="background-color:#efefef;" | IPMI Console Port
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_console_port}
 +
|-
 +
| style="background-color:#efefef;" | IPMI Console Login URL
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_console_login_url}
 +
|-
 +
| style="background-color:#efefef;" | IPMI Port
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_port} ''=> string''
 +
|-
 +
| style="background-color:#efefef;" | IPMI Privilege Level
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_privilege_level}
 +
|-
 +
| style="background-color:#efefef;" | IPMI VPN IP Address
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_vpn_ip_address}
 +
|-
 +
| style="background-color:#efefef;" | IPMI VPN Username
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_vpn_username}
 +
|-
 +
| style="background-color:#efefef;" | IPMI VPN Password
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_vpn_password}
 +
|-
 +
| style="background-color:#efefef;" | IPMI VPN Instructions
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ipmi_vpn_instructions}
 +
|-
 +
| style="background-color:#efefef;" | Downtime
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_downtime}
 +
|-
 +
| style="background-color:#efefef;" | SSH Password
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ssh_password}
 +
|-
 +
| style="background-color:#efefef;" | SSH Username
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ssh_username}
 +
|-
 +
| style="background-color:#efefef;" | SSH Port
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ssh_port}
 +
|-
 +
| style="background-color:#efefef;" | SSH Private Key
 +
| style="font-weight:bold; background-color:#efefef;" | {$easydcim_ssh_private_key}
 +
|}
 +
<!--
 +
{|
 +
|style="padding: 10px 0px 5px 15px;"|Use the variables in default email templates by inserting or replacing the WHMCS variables with the EasyDCIM ones.<br/> Compose your own custom templates with information you need to pass to your clients.<br/>
 +
Underneath you can see an exemplary email message with such variables used.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_18_1.png]]
 +
|}
 +
-->
 +
 +
=Advanced Billing Integration=
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|EasyDCIM Dedicated Servers For WHMCS supports integration with the [https://www.modulesgarden.com/products/whmcs/advanced-billing Advanced Billing For WHMCS] module.<br/>This allows you to charge your customers for bandwidth ''(In, Out and Total)'' and apply 95th percentile ''(In, Out and Total)'' billing for additional traffic.<br/>
 +
 +
'' '''Note:''' We suggest to run the cron '''only once per hour''' (with the interval of 3600 seconds).<br/>This is due to the fact that while generating an invoice, '''only the last billed record''' is taken into account, so there is no need to collect data more often.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_29.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Once the [https://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS#Usage_Records relevant options] are enabled, your clients will also be able to view billing for the current usage in your client area.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:ED2_39.png]]
 +
|}
 +
 +
<!--
 +
=Products Reseller For WHMCS Integration - Servers Reselling=
 +
{|
 +
|style="padding: 10px 0px 5px 15px;"|EasyDCIM Dedicated Servers For WHMCS supports integration with the [https://www.modulesgarden.com/products/whmcs/products-reseller Products Reseller For WHMCS] module which, in short, has been designed to let clients resell your products via any preferred platform.<br/>The combination of these two products exactly, allows you to easily resell and then charge for your dedicated servers, all that thanks to smart integration between EasyDCIM and WHMCS platforms. <br/>
 +
You may find any details regarding the supported integration fields by entering and reading the EasyDCIM article on [https://www.docs.easydcim.com/whmcs-integration/servers-reselling/ Servers Reselling].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Take a look at the below screenshot to see how the client area page looks like with the EasyDCIM Dedicated Servers product resold.<br/>
 +
Supported by the integration actions:
 +
* Get VM Details
 +
* Get VM Graphs
 +
* Boot VM
 +
* Reboot VM
 +
* Shutdown VM
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ED2_28_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Exemplary graph section view:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:ED2_28_2.png]]
 +
|}
 +
-->
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|1. Note that two identical orders may result in assigning server with slightly different parameters.
+
|style="padding: 10px 0px 5px 15px;"|1. Note that placing two identical orders may result in assigning servers with slightly different parameters.
−
It is the result of the way EasyDCIM server matching works. It matches a server basing on the resources and models mentioned in the order, without considering other resources.<br />
+
It is a natural result of how server matching in EasyDCIM works. In brief, it matches a server basing on the resources and models precised in the order, without considering other resources.<br />
−
While it attempts to find a server matching the order completely, in case it fails, server fulfilling more requirements than others will be assigned.<br />
+
In the first place the process aims at identifying the server matching the order 100%. When it fails, the server fulfilling the highest number of specifications will be assigned instead.<br />
−
More information about server provisioning flow can be found on [http://www.docs.easydcim.com/provisioning/flow/index.html EasyDCIM documentation page].
+
More information about server provisioning flow can be found on [http://www.docs.easydcim.com/provisioning/flow EasyDCIM documentation page].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|2. As this server supports the templates system, any changes made in the server's templates files will be saved after the upgrade process.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|4. In '' '/yourWHMCS/modules/servers/EasyDCIMv2/Config' '' location you can find 3 additional config files:<br/>
 +
- ''configuration.json'' - where you can set created user role ('2' by default) as well as add and manage graphs displayed in both client and admin area<br/>
 +
- ''emailTemplates.json''  - where you can edit email templates that are automatically created after first run of EasyDCIM module<br/>
 +
- ''hooks.json'' - where you can activate/deactivate hooks used by the module or add your own
 +
|}
 +
 
 +
==How To Use Language Overrides==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|'''Incorporating language customizations - the module readily accommodates language overrides, allowing you to tailor the language files to your preferences.'''<br/> The language file english.php remains unencoded and can be modified to suit your needs. However, it's recommended to avoid altering the core file itself, and instead, leverage the capability of using overrides.<br/>
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Here's how to apply language overrides:
 +
* Navigate to the ''~/langs/'' directory located within the following ''yourWHMCS/modules/servers/moduleName/langs/'' path.
 +
* Within this directory, create a new file or duplicate the language file you intend to modify. For instance, if you wish to create an override for the English language, establish the following directory structure:
 +
  ''~/langs/overrides/english.php''.
 +
* Open the newly created override file to edit its contents.
 +
* At the beginning of the file, indicate the used code, for instance, you can use: '''<?php''' for PHP code.
 +
* Adapt the file content according to your requirements. You can either selectively modify specific variables or opt to revise the entire content of the language file.
 +
 
 +
For example:
 +
 
 +
'''Original ''yourWHMCS/modules/servers/moduleName/langs/english.php:'''''
 +
 
 +
  $_LANG['Search'] = 'Search';
 +
 
 +
'''Override ''yourWHMCS/modules/servers/moduleName/langs/overrides/english.php:''''' 
 +
 
 +
  $_LANG['Search'] = 'Look for';
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|By following these steps, you can seamlessly implement language customizations without altering the core language file, ensuring your changes will not be lost after every module update.<br/>
 +
 
 +
Remember that some of the modules have more than one language file, located under ''/addons'' and ''/servers'' paths. You may create the override files for both of them.<br/> Note that you do not need to paste all the original content of the lang file into the override file. Enter there only the lines that you wish to change, every other line will be fetched from the original module lang file.<br/> Consequently, the override lang file might include only one or just a few lines.
 +
|}
 +
 
 +
=Update Instructions=
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|If you are updating your EasyDCIM Dedicated Servers For WHMCS module and wish to migrate your data to the new V2 module version, please familiarize yourself with the below instructions firstly.<br/> Please follow the instructions step by step to avoid any unexpected errors.
 +
|}
 +
{|
 +
|style="color: #ff0000; padding: 0px 0px 15px 15px;"|'''Start with making a backup copy of your WHMCS files and database.'''<br/> This step is crucial as it will let you avoid losing any data in case of unexpected update failure or other issues.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|1. Download the latest version of the module from our [https://www.modulesgarden.com/client-area/products client area].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|2. Upload and extract the new module files into your WHMCS root directory.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|3. Move to the ''System Settings → Servers'', create a new server and a new server group dedicated to the EasyDCIM V2 module.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|4. Move to the ''System Settings → Products/Services'', and find and open the product you are going to update.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|5. Open the ''Module Settings'' section of the product of your interest, find and open the product you are going to update.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 5px 15px;"|6. Change the '' 'Module Name' '' from "EasyDCIM" to '''"EasDCIMv2"'''.<br/> Change the '' 'Server Group' '' to the created in the '''3rd''' step.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|7. Configure the module settings from scratch and save the changes.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|8. Generate any configurable options if need any.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|9.* Regarding billing methods update:<br/>
 +
*Advanced Billing For WHMCS:<br/> If the Advanced Billing For WHMCS module is used to calculate the billing, move to this module addon and set up the product pricing again, as described [[#Advanced_Billing_Integration|here]].
 +
*WHMCS inbuilt system is used:<br/> If you '''do not''' use the Advanced Billing For WHMCS module to calculate the billing, move to the ''System Settings → Products/Services → Other'' tab and configure the ''"Percentile Usage"'' and ''"Percentile Cost"'' fields from scratch.  
 
|}
 
|}
  
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 +
|}
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|2. '''Error:''' "Malformed Response" when testing the server connection<br/> '''Solution:''' Make sure the '' 'Secure' '' option is disabled and SSL mode is '''not''' used for connection.
 
|}
 
|}

Latest revision as of 13:47, 26 April 2024

Contents

[edit] 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 the bandwidth usage calculation intervals and the percentile billing of its overages.
Concurrently, your customers will be able to overview their servers, access KVM console, manage rDNS records and more, all without leaving your website.

If you are still using the module in version 1.x and need its documentation, you will find it under this page.

  • Admin Area Features:
✔ Create/Terminate/Suspend/Unsuspend Server
✔ Update Order Information
✔ Start/Stop/Reset/BMC Cold Reset Server
✔ Toggle Rescue Mode
✔ Access KVM Java Console (Dell And Supermicro Servers)
✔ Access noVNC KVM Console (AMI, Dell, HP And Supermicro)
✔ One Click Login To User Control Panel
✔ View Server, General And Location Information:
✔ View Server ID And Order ID In EasyDCIM Panel
✔ View Server Resource Statistics:
✔ Bandwidth Usage
✔ Aggregate Traffic
✔ Ping
✔ Status
✔ Configure Product Details:
✔ Default Server Options:
✔ Server Model
✔ Server Location
✔ OS Template
✔ Number Of Additional IP Addresses
✔ Disk Layout
✔ Extras
✔ Automation Settings:
✔ Automatic Order Acceptance And Server Matching
✔ Define Required Devices:
✔ PDU
✔ Switch
✔ Block Automatic WHMCS Suspension/Unsuspension/Termination
✔ Block Automatic Update Of Additional/Dedicated IP Addresses
✔ Toggle WHMCS Order Actions
✔ Define Bandwidth Notification Limit
✔ Control Service Access Level
✔ Define Replacements For EasyDCIM Order Actions On:
✔ Activation
✔ Suspension
✔ Unsuspension
✔ Termination
✔ Define Additional Part Requirements:
✔ HDD Models
✔ SSD Models
✔ RAM Models
✔ CPU Models
✔ Define Additional Metadata Requirements
✔ Define Client Area Features:
✔ Service/General/Location Information
✔ Graphs
✔ Server Actions
✔ Overview Tables
✔ Extensions Access
✔ OS Installation Actions
✔ Available OS Templates For Rebuilding
✔ Control Service Actions And Email Notifications
✔ Generate Default And Additional Parts Configurable Options
✔ Determine Monthly Interval Of Bandwidth Usage
✔ Define Percentile Billing Of Bandwidth Overages
✔ Use EasyDCIM Merge Fields In Email Templates
  • Client Area Features:
✔ Create/Terminate/Suspend/Unsuspend Server
✔ Receive Email Notification On Complete Server Creation
✔ Start/Stop/Reset/BMC Cold Reset Server
✔ Toggle Rescue Mode
✔ Access KVM Java Console (Dell And Supermicro Servers)
✔ Access noVNC KVM Console (AMI, Dell, HP And Supermicro)
✔ One Click Login To User Control Panel
✔ View Server, General And Location Information
✔ View Bandwidth Usage
✔ View Server Resource Statistics:
✔ Aggregate Traffic
✔ Ping
✔ Status
✔ Add Custom ISO Images To Server
✔ Rebuild Server Using OS Templates And Your Own Credentials
✔ Manage Reverse DNS Records
✔ View Access List With Stored Passwords
  • Configurable Options:
✔ Server Model
✔ Server Location
✔ OS Template
✔ Disk Layout
✔ Bandwidth
✔ Number Of Additional IP Addresses
✔ Custom Device
✔ Metadata
✔ HDD Size (Of Any Additional Parts)
✔ SSD Size (Of Any Additional Parts)
✔ RAM Size (Of Any Additional Parts)
✔ CPU Cores (Of Any Additional Parts)
✔ Custom - To Be Displayed In EasyDCIM Service Configuration
  • Advanced Billing Integration:
✔ Bill For Current In/Out/Total Bandwidth Usage
✔ Apply 95th Percentile Billing Of In/Out/Total Bandwidth Overages
  • Supported Server Manufacturers:
✔ AMI
✔ Dell
✔ HP
✔ Supermicro
  • General Info:
✔ Integrated With Advanced Billing For WHMCS - Actual Server Resource Usage Billing
✔ Integrated With Products Reseller For WHMCS - End-To-End Solution For Products And Servers Reselling
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Most Suitable Servers To Products
✔ Multi-Language Support
✔ Supports EasyDCIM v1.9.6 And Later
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
✔ Supports WHMCS V8.10 Back To WHMCS V8.6
  • Exclusive Promo Code From ModulesGarden:
✔ Save 20% For 3 Months On The EasyDCIM Control Panel With Coupon: WHMCS20%_ED

[edit] Installation and Configuration

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

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

[edit] Installation

1. Log in to our client area and download the module.
ED2 1.png
2. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

ED2 2.png
If you are about to update your EasyDCIM Dedicated Servers module from v1 to v2? Remember to strictly follow the update instructions described at the bottom of this documentation!

[edit] Configuration of Server

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

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

ED2 3.png
4. Next, choose 'EasyDCIMv2' from the 'Module' dropdown menu.

Fill in your server "Name", "IP address" or "Hostname", and the "Password", then press 'Save Changes'.
Remember not to use SSL Mode for Connection, keep this option disabled or otherwise you will encounter errors when testing the server connection.
Note: The password can be found in your EasyDCIM administrator user profile listed as 'API Key'.

ED2 4.png
5. 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.

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

[edit] 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'.

ED2 8.png
10. Enter the product group name and press 'Save Changes'.
ED2 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'.

ED2 10.png
12. Next, choose your the product type, assign it to a group of similar products, enter your product name, select module: 'EasyDCIMv2' and then press 'Continue'.
ED2 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'.

ED2 12.png
14. 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 - these options will be used for an order placement in EasyDCIM when the service is ordered and activated in WHMCS:

  • Server 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
  • Additional IP Addresses Number - the number of additional IP addresses assigned to a server
  • Disk Layout - choose the disk layout addons for the chosen template and location
  • Extras - choose additional addons for the chosen template and location

Automation Settings - define actions related to this product, they will be executed automatically based on the actions taken in WHMCS:

  • 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
  • Block Automatic Suspension by WHMCS - when activated, this feature prevents automatic suspension of the server in EasyDCIM when a suspension occurs in WHMCS. An email notification will be sent to the administrator only.
  • Block Automatic Unsuspension by WHMCS - when activated, this feature prevents automatic unsuspension of the server in EasyDCIM when an unsuspension action occurs in WHMCS. An email notification will be sent to the administrator only.
  • Block Automatic Termination by WHMCS - when activated, this feature prevents automatic termination of the server in EasyDCIM when the server is termianted in WHMCS. An email notification will be sent to the administrator only.
  • Block Automatic Update Of Additional IP Addresses - if enabled, the service additional IP addresses will not be automatically updated when the service is synchronized or updated by cron.
  • Block Automatic Update Of Dedicated IP Address - if enabled, the service dedicated IP address will not be automatically updated when the service is synchronized or updated by cron.
  • WHMCS Order Actions - enabling this feature allows WHMCS module actions to take precedence over EasyDCIM's default order actions. To specify these actions, please refer below to the dedicated exclusively to 'Order Actions' section.
  • Bandwidth Notification Limit [GB] - set up the limit of bandwidth per month. When exceeded, the administrator will be notified about it directly in EasyDCIM.
    Note that it is NOT a HARD limit of bandwidth nor is it used for any billing. To enable billing, please use the Usage Billing feature.
  • 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.
ED2 14.png
In the Order Actions section, you can specify the exact action to be applied to an EasyDCIM order based on specific actions in WHMCS.

Please note that the 'WHMCS Order Actions' feature in the Automation Settings section above must be enabled. Once activated, the actions configured below will replace EasyDCIM's default order actions.

  • Order Activation Actions - choose from below the actions that will be applied to EasyDCIM order on the WHMCS product activation:
    • [OS Installation] Install Operating System
    • Ebanle Traffic Aggregation ports
    • Boot a device
    • Delete RRD files with graphs and traffic data
    • Delete notifications
    • [IPMI Integration] Crate Operator Account
    • [IP Address Management] Assign Subnet
    • [DNS Management] Crate Zone
    • [DNS Management] Delete zones and rDNS records
    • [DNS Management] Create rDNS records
    • [Usage Collector]Set the monthly traffic limit (IN/OUT)
  • Order Suspension Actions - choose from below the actions that will be applied to EasyDCIM order on the WHMCS product suspension:
    • Shut down a device
    • Disable traffic aggregation ports
    • [IPMI Integration] Delete Operator Account
  • Order Unsuspension Actions - choose from below the actions that will be applied to EasyDCIM order on the WHMCS product unsuspension:
    • Boot a device
    • Enable traffic aggregation ports
    • [IPMI Integration] Create Operator Account
  • Order Termination Actions - choose from below the actions that will be applied to EasyDCIM order on the WHMCS product termination:
    • Shut down a device
    • Disable traffic aggregation ports
    • Delete RRD files with graphs and traffic data
    • Clear Hostname Value
    • Clear Additional IP Addresses Value
    • Unassign DEvice Parts
    • [IP Addresses Managemnt] Unassign Subnet
    • Delete notifications
    • [OS Insatllation] REinstall OS
    • [IPMI Integartion] Delete Operator Account
    • [DNS Management] Delete zones and rDNS record
    • [Usage Collector] Remove the monthly traffic limit (IN/OUT)
ED2 14 0.png
Client Area Features - define the features and information that will be available for customers in the client area.

Select elements for every section in the client area that will be available to your customers:

  • Service Information
    • Server ID
    • Label
    • Device Status
    • Hostaname
    • Change Hostane
    • IP Address
    • OS Template
    • MAC Address
    • Installation Status
    • Custom Metadata (choose from dropdown menu)
  • General Information
    • Status
    • Order ID
    • Service Model
    • Serial Number
    • Purchase Date
    • Warranty Months
  • Location Information
    • Location Name
    • Labeled Rock with position
    • Floor
    • Address
    • Phone Number
    • Description
  • Graphs
    • Ping
    • Status
    • Aggregate Traffic
  • Server Actions
    • Reboot Server
    • Shut Down Server
    • BMC Cold Reset
    • Enable Rescue Mode
    • Auto Login Link
    • KVM Java Console
    • noVNC KVM Console
  • Overview Tables
    • Hide Server Information Table
    • Hide General Information Table
    • Hide Location Table
    • Hide Bandwidth Usage Table
  • Extensions
    • Device Statistics
    • OS Installation
    • DNS Management
    • Password Management
  • OS Installation Actions
    • Rebuild Server
    • ISO Images
  • OS Templates - selects the OS Templates that will be available for clients to choose from when reinstalling the server

Email Notification

  • Create Server Action Notification (To Client) - Choose the email template that will be sent to the client when creation of the ordered server is finished.
  • Notified Administrator - choose the WHCMCS administrator who will receive the below described notifications about certain actions performed on the services
  • Suspend Action Notification - select the email template that will be used to notify about suspending the service
  • Unsuspend Action Notification - select the email template that will be used to notify about unsuspending the service
  • Terminate Action Notification - select the email template that will be used to notify about terminating the service
ED2 14 1.png
15. Choose parts from the dropdown menu and provide their values. They will be available for clients while placing an order.
ED2 13.png
ED2 13 1.png
16. Alike parts, you may configure extra metadata that will be required to choose for clients while placing an order.
ED2 13 2.png
ED2 13 3.png
17. Now, you can optionally generate the default configurable options to allow placing orders tailored to your customers' needs.

We recommend viewing and modifying them to fit your provisioning capabilities. You can find them under 'System Settings' → 'Configurable Options'.
Note: You can also add your own configurable options which will be then displayed under 'Service Configuration' in your EasyDCIM backend.
Important: Any configurable option will overwrite its counterpart from the 'Module Settings' of a product.
Important: If you create general configurable options, remember to refresh the page in order to successfully assign the newly generated configurable options to a product
and then to be able to generate and allot configurable options to additional parts.

ED2 15.png
ED2 15 1.png
ED2 15 2.png
ED2 15 5.png
18. Additionally, you can set up a percentile billing for additional traffic.

Note: This option is possible only if you do not have Advanced Billing Form WHMCS module installed. If you need a bit more advanced billing integration, please go here for more information.
Go to the 'Other' tab and enable 'Overages Billing'. First, define the standard overages bandwidth billing and then set the following percentile values:

  • Soft Limit - bandwidth usage in Mbps above 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 exceeds the bandwidth by 10 Mbps, reaching to '110 Mbps' , they will be additionally charged with $5 USD (10 x 0.500).
Note: The percentile billing requires the standard billing of bandwidth overages to be enabled. It will be also calculated during the execution of the WHMCS system cron.

ED2 15 3.png

[edit] 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
  • percentileUsage - the entire current usage. If the value specified previously in the percentile configuration is exceeded, the additional charge will be calculated accordingly.
ED2 15 4.png

[edit] Management

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

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

[edit] Admin Area

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

ED2 16.png
Our module allows you to:
  • start/stop/reset server,
  • force BMC cold reset of the server
  • enable rescue mode
  • use KVM Java console/ no VNC KVM console
  • view and edit server information
  • view general and server location information
ED2 17.png
Below the mentioned functions, there are various usage graphs and statistics available at your disposal.

Note: By default, there are 4 types of statistics generated and updated live. If you need more, you can add them through the configuration.json file located in /yourWHMCS/modules/servers/EasyDCIMv2/Config.

ED2 18.png

[edit] 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.

Other available actions on the server: Start, Stop, Reset, BMC Cold reset, Enable Rescue Mode.

ED2 19.png

[edit] Device Statistics

[edit] View Graphs

This section allows to view information on the total traffic on all of your devices in a form of a clear graph.

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

ED2 21 1.png

[edit] ISO Images

In the ISO Images section you may add custom ISO images to their servers.

Important: ISO images are used to manually install the operating system. If you want to use an ISO image, you cannot perform an automatic OS installation within EasyDCIM.
Available ISO images are accessible when a noVNC session is used. The images will be automatically mounted when creating a noVNC session in the “/home/iso” directory.

ED2 21 0.png
Type in your custom name of the ISO image and provide a direct URL to the .iso files.
Press the adequate button to confirm the action.
ED2 22 0.png

[edit] OS Installation

The OS Installation section gives the possibility to reinstall OS on the client's server.
ED2 22.png
Select the OS template to reinstall and provide all the necessary details to proceed with the reinstallation.
Confirm your decision in the end.
ED2 22 1.png

[edit] DNS Management

It is possible for your clients to control their reverse DNS. They can either edit the already existing records or create new ones.
ED2 23.png
To create a record, all your clients need to do is fill in the necessary information. The newly created record will immediately appear on the list.

If you want to create just one record, then please leave the 'Mask' field empty.

ED2 24.png

[edit] Password Management

Move to the Password Management section to see a full list of all stored passwords. Press the icon next to the password to show/hide it.
ED2 25.png

[edit] KVM Java Console

If your clients are using Dell or SuperMicro servers, they can access the KVM Java console.
ED2 26.png
It will launch a Java applet that will automatically connect to your client's server.

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

ED2 27.png

[edit] noVNC KVM Console

For clients using the 'American Megatrends', 'Dell', HP' and 'Supermicro' servers there is available access to the noVNC KVM console.
ED2 28.png
noVNC KVM Console in contrast to KVM Console is not downloaded directly on the client's device, EasyDCIM connects with proxy server via VNC to allow the remote session.

[edit] Email Templates Merge Fields

Whmcs Email Templates are compatible with EasyDCIM and you may easily include EasyDCIM data in their content.

In this section you will learn how to create merge fields that then can be used in email templates that you send to your clients.

The pattern of creating acceptable by WHMCS merge fields is very easy:

Let's take IP address as an exemplary EasyDCIM metadata. The WHMCS variable will be {$easydcim_ip_address}. As you have surely noticed:

  • variables use lower case only
  • use underscore '_' in place of every free space
  • insert 'easydcim_' prefix in the beginning


A WHMCS variable with information on EasyDCIM matadata is ready to use!

Here you can find a list of exemplary ready made variables:
EasyDCIM Metadata WHMCS Merge Fields
Hostname {$easydcim_hostname}
IP Address {$easydcim_ip_address}
Additional IP Addresses {$easydcim_additional_ip_addresses}
All IP Addresses {$easydcim_all_ip_addresses}
IPMI Enabled {$easydcim_ipmi_enabled}
IPMI IP Address {$easydcim_ipmi_ip_address}
IPMI Username {$easydcim_ipmi_username}
IPMI Password {$easydcim_ipmi_password}
IPMI Board Type {$easydcim_ipmi_board_type}
IPMI Protocol Version {$easydcim_ipmi_protocol_version}
IPMI Driver {$easydcim_ipmi_driver}
IPMI Proxy Server {$easydcim_ipmi_proxy_server}
IPMI Console Port {$easydcim_ipmi_console_port}
IPMI Console Login URL {$easydcim_ipmi_console_login_url}
IPMI Port {$easydcim_ipmi_port} => string
IPMI Privilege Level {$easydcim_ipmi_privilege_level}
IPMI VPN IP Address {$easydcim_ipmi_vpn_ip_address}
IPMI VPN Username {$easydcim_ipmi_vpn_username}
IPMI VPN Password {$easydcim_ipmi_vpn_password}
IPMI VPN Instructions {$easydcim_ipmi_vpn_instructions}
Downtime {$easydcim_downtime}
SSH Password {$easydcim_ssh_password}
SSH Username {$easydcim_ssh_username}
SSH Port {$easydcim_ssh_port}
SSH Private Key {$easydcim_ssh_private_key}

[edit] Advanced Billing Integration

EasyDCIM Dedicated Servers For WHMCS supports integration with the Advanced Billing For WHMCS module.
This allows you to charge your customers for bandwidth (In, Out and Total) and apply 95th percentile (In, Out and Total) billing for additional traffic.

Note: We suggest to run the cron only once per hour (with the interval of 3600 seconds).
This is due to the fact that while generating an invoice, only the last billed record is taken into account, so there is no need to collect data more often.

ED2 29.png
Once the relevant options are enabled, your clients will also be able to view billing for the current usage in your client area.
ED2 39.png


[edit] Tips

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

It is a natural result of how server matching in EasyDCIM works. In brief, it matches a server basing on the resources and models precised in the order, without considering other resources.
In the first place the process aims at identifying the server matching the order 100%. When it fails, the server fulfilling the highest number of specifications will be assigned instead.
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.
4. In '/yourWHMCS/modules/servers/EasyDCIMv2/Config' location you can find 3 additional config files:

- configuration.json - where you can set created user role ('2' by default) as well as add and manage graphs displayed in both client and admin area
- emailTemplates.json - where you can edit email templates that are automatically created after first run of EasyDCIM module
- hooks.json - where you can activate/deactivate hooks used by the module or add your own

[edit] How To Use Language Overrides

Incorporating language customizations - the module readily accommodates language overrides, allowing you to tailor the language files to your preferences.
The language file english.php remains unencoded and can be modified to suit your needs. However, it's recommended to avoid altering the core file itself, and instead, leverage the capability of using overrides.
Here's how to apply language overrides:
  • Navigate to the ~/langs/ directory located within the following yourWHMCS/modules/servers/moduleName/langs/ path.
  • Within this directory, create a new file or duplicate the language file you intend to modify. For instance, if you wish to create an override for the English language, establish the following directory structure: 
 ~/langs/overrides/english.php.
  • Open the newly created override file to edit its contents.
  • At the beginning of the file, indicate the used code, for instance, you can use: <?php for PHP code.
  • Adapt the file content according to your requirements. You can either selectively modify specific variables or opt to revise the entire content of the language file.

For example:

Original yourWHMCS/modules/servers/moduleName/langs/english.php: 

 $_LANG['Search'] = 'Search';

Override yourWHMCS/modules/servers/moduleName/langs/overrides/english.php: 

 $_LANG['Search'] = 'Look for';
By following these steps, you can seamlessly implement language customizations without altering the core language file, ensuring your changes will not be lost after every module update.

Remember that some of the modules have more than one language file, located under /addons and /servers paths. You may create the override files for both of them.
Note that you do not need to paste all the original content of the lang file into the override file. Enter there only the lines that you wish to change, every other line will be fetched from the original module lang file.
Consequently, the override lang file might include only one or just a few lines.

[edit] Update Instructions

If you are updating your EasyDCIM Dedicated Servers For WHMCS module and wish to migrate your data to the new V2 module version, please familiarize yourself with the below instructions firstly.
Please follow the instructions step by step to avoid any unexpected errors.
Start with making a backup copy of your WHMCS files and database.
This step is crucial as it will let you avoid losing any data in case of unexpected update failure or other issues.
1. Download the latest version of the module from our client area.
2. Upload and extract the new module files into your WHMCS root directory.
3. Move to the System Settings → Servers, create a new server and a new server group dedicated to the EasyDCIM V2 module.
4. Move to the System Settings → Products/Services, and find and open the product you are going to update.
5. Open the Module Settings section of the product of your interest, find and open the product you are going to update.
6. Change the 'Module Name' from "EasyDCIM" to "EasDCIMv2".
Change the 'Server Group' to the created in the 3rd step.
7. Configure the module settings from scratch and save the changes.
8. Generate any configurable options if need any.
9.* Regarding billing methods update:
  • Advanced Billing For WHMCS:
    If the Advanced Billing For WHMCS module is used to calculate the billing, move to this module addon and set up the product pricing again, as described here.
  • WHMCS inbuilt system is used:
    If you do not use the Advanced Billing For WHMCS module to calculate the billing, move to the System Settings → Products/Services → Other tab and configure the "Percentile Usage" and "Percentile Cost" fields from scratch.

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. Error: "Malformed Response" when testing the server connection
Solution: Make sure the 'Secure' option is disabled and SSL mode is not used for connection.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=EasyDCIM_Dedicated_Servers_For_WHMCS&oldid=66705"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
EasyDCIM Dedicated Servers For WHMCS