EasyDCIM Dedicated Servers For WHMCS
(→About EasyDCIM Dedicated Servers For WHMCS) |
(→About EasyDCIM Dedicated Servers For WHMCS) |
||
(One intermediate revision by one user not shown) | |||
Line 101: | Line 101: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 60px;"|✔ Automatic Domain Update | |style="padding: 0px 0px 0px 60px;"|✔ Automatic Domain Update | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 60px;"|✔ Enable Stock Control | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 60px;"|✔ Enable WHMCS Order Actions | ||
|} | |} | ||
{| | {| | ||
Line 107: | Line 113: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 60px;"|✔ Control Service Access Level | |style="padding: 0px 0px 0px 60px;"|✔ Control Service Access Level | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 60px;"|✔ Select Service Activation Condition | ||
|} | |} | ||
{| | {| | ||
Line 166: | Line 175: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 60px;"|✔ Available | + | |style="padding: 0px 0px 0px 60px;"|✔ Available Operating Sysytem Templates For Rebuilding |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 60px;"|✔ Apply Client Area Feature Settings to Admin Area | ||
|} | |} | ||
{| | {| | ||
Line 223: | Line 235: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 45px;"|✔ Status | |style="padding: 0px 0px 0px 45px;"|✔ Status | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ View Server Sensors Data: | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 45px;"|✔ Power Watts Supplies | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 45px;"|✔ Power Voltages | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 45px;"|✔ Fans RPM | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 45px;"|✔ Temperatures | ||
|} | |} | ||
{| | {| | ||
Line 338: | Line 365: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8. | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.3 Back To PHP 8.1 |
|} | |} | ||
{| | {| | ||
Line 344: | Line 371: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V8.13 Back To WHMCS V8.10 |
− | + | ||
− | + | ||
− | + | ||
|} | |} | ||
+ | |||
*'''Exclusive Promo Code From ModulesGarden:''' | *'''Exclusive Promo Code From ModulesGarden:''' | ||
Line 390: | Line 415: | ||
{| | {| | ||
|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 '' ' | + | Go to '' 'System Settings' → 'Servers' '' and press the '' 'Add New Server' '' button. |
|} | |} | ||
{| | {| | ||
Line 425: | Line 450: | ||
==Configuration of Product== | ==Configuration of Product== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|'''9. In order to create and configure a product, go to '' ' | + | |style="padding: 10px 0px 15px 15px;"|'''9. In order to create and configure a product, go to '' 'System Settings' → 'Products/Services'.'''''<br/> |
Click on '' 'Create a New Group'.'' | Click on '' 'Create a New Group'.'' | ||
|} | |} | ||
Line 455: | Line 480: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:ED2x_12.png]] |
|} | |} | ||
{| | {| | ||
Line 463: | Line 488: | ||
*'''Server Model''' ''(required)'' - the EasyDCIM server model | *'''Server Model''' ''(required)'' - the EasyDCIM server model | ||
*'''Location''' ''(required)'' - a desired server location | *'''Location''' ''(required)'' - a desired server location | ||
− | *''' | + | *'''Operating System Template''' - reinstall the server with a chosen OS template before delivering it to the client |
− | *'''Additional IP Addresses | + | *'''Number of Additional IP Addresses''' - the number of additional IP addresses assigned to a server |
*'''Disk Layout''' - choose the disk layout addons for the chosen template and location | *'''Disk Layout''' - choose the disk layout addons for the chosen template and location | ||
*'''Extras''' - choose additional addons for the chosen template and location | *'''Extras''' - choose additional addons for the chosen template and location | ||
Line 477: | Line 502: | ||
*'''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 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. | *'''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. | ||
+ | *'''Automatic Update of Domain''' - if enabled, the service domain is automatically updated with the EasyDCIM hostname during synchronization or cron updates. | ||
+ | *'''Enable Stock Control''' - activates automatic stock quantity updates every five minutes via cron, based on module settings such as model, location, switch and PDU requirements, metadata, and parts. | ||
*'''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. | *'''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. | *'''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--> | <!--*'''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. | *'''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. | ||
+ | *'''Service Activation Condition''' - based on the selection here, the module will activate the service in WHMCS and send the notification email accordingly. | ||
+ | **'''Activate service when the order status is activated in EasyDCIM (default)''' | ||
+ | **'''Activate service when the order status is activated in EasyDCIM and the OS installation has finished successfully''' | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:ED2x_14.png]] |
|} | |} | ||
{| | {| | ||
Line 490: | Line 520: | ||
*'''Order Activation Actions''' - choose from below the actions that will be applied to EasyDCIM order '''on the WHMCS product activation''': | *'''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 | **[OS Installation] Install Operating System | ||
− | ** | + | **Enable Traffic Aggregation ports |
**Boot a device | **Boot a device | ||
**Delete RRD files with graphs and traffic data | **Delete RRD files with graphs and traffic data | ||
Line 496: | Line 526: | ||
**[IPMI Integration] Crate Operator Account | **[IPMI Integration] Crate Operator Account | ||
**[IP Address Management] Assign Subnet | **[IP Address Management] Assign Subnet | ||
+ | **[IP Address Management] Assign Primary IP to Device | ||
**[DNS Management] Crate Zone | **[DNS Management] Crate Zone | ||
**[DNS Management] Delete zones and rDNS records | **[DNS Management] Delete zones and rDNS records | ||
**[DNS Management] Create rDNS records | **[DNS Management] Create rDNS records | ||
**[Usage Collector]Set the monthly traffic limit (IN/OUT) | **[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''': | *'''Order Suspension Actions''' - choose from below the actions that will be applied to EasyDCIM order '''on the WHMCS product suspension''': | ||
**Shut down a device | **Shut down a device | ||
**Disable traffic aggregation ports | **Disable traffic aggregation ports | ||
**[IPMI Integration] Delete Operator Account | **[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''': | *'''Order Unsuspension Actions''' - choose from below the actions that will be applied to EasyDCIM order '''on the WHMCS product unsuspension''': | ||
**Boot a device | **Boot a device | ||
**Enable traffic aggregation ports | **Enable traffic aggregation ports | ||
**[IPMI Integration] Create Operator Account | **[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''': | *'''Order Termination Actions''' - choose from below the actions that will be applied to EasyDCIM order '''on the WHMCS product termination''': | ||
** Shut down a device | ** Shut down a device | ||
− | **Disable traffic aggregation ports | + | ** Disable traffic aggregation ports |
− | **Delete RRD files with graphs and traffic data | + | ** Delete RRD files with graphs and traffic data |
− | **Clear Hostname Value | + | ** Clear Hostname Value |
− | **Clear Additional IP Addresses Value | + | ** Clear Additional IP Addresses Value |
− | **Unassign Device Parts | + | ** Unassign Device Parts |
− | **[IP Addresses Management] Unassign Subnet | + | ** [IP Addresses Management] Unassign Subnet |
− | **Delete notifications | + | ** Delete notifications |
− | **[OS Installation] Reinstall OS | + | ** Change Inventory Status |
− | **[IPMI Integration] Delete Operator Account | + | ** [OS Installation] Reinstall OS |
− | **[DNS Management] Delete zones and rDNS record | + | ** [IPMI Integration] Delete Operator Account |
− | **[Usage Collector] Remove the monthly traffic limit (IN/OUT) | + | ** [DNS Management] Delete zones and rDNS record |
+ | ** [Usage Collector] Remove the monthly traffic limit (IN/OUT) | ||
+ | |||
*'''Global Error Configuration''' - choose from below the actions that will be applied to EasyDCIM order '''when error is encountered''': | *'''Global Error Configuration''' - choose from below the actions that will be applied to EasyDCIM order '''when error is encountered''': | ||
**Continue Provisioning | **Continue Provisioning | ||
Line 538: | Line 574: | ||
**Change Hostane | **Change Hostane | ||
**IP Address | **IP Address | ||
− | ** | + | **Operating System Template |
**MAC Address | **MAC Address | ||
**Installation Status | **Installation Status | ||
− | **Custom Metadata | + | **Custom Metadata for Client Area |
+ | **Custom Metadata for Admin Area | ||
+ | |||
*'''General Information''' | *'''General Information''' | ||
**Status | **Status | ||
**Order ID | **Order ID | ||
+ | **Service Status | ||
**Service Model | **Service Model | ||
**Serial Number | **Serial Number | ||
**Purchase Date | **Purchase Date | ||
**Warranty Months | **Warranty Months | ||
+ | |||
*'''Location Information''' | *'''Location Information''' | ||
**Location Name | **Location Name | ||
− | **Labeled Rock with | + | **Labeled Rock with Position |
**Floor | **Floor | ||
**Address | **Address | ||
**Phone Number | **Phone Number | ||
**Description | **Description | ||
+ | |||
+ | *'''Overview Tables''' | ||
+ | **Hide Server Information Table | ||
+ | **Hide General Information Table | ||
+ | **Hide Location Table | ||
+ | **Hide Bandwidth Usage Table | ||
+ | |||
*'''Graphs''' | *'''Graphs''' | ||
**Ping | **Ping | ||
**Status | **Status | ||
**Aggregate Traffic | **Aggregate Traffic | ||
+ | |||
*'''Server Actions''' | *'''Server Actions''' | ||
**Reboot Server | **Reboot Server | ||
+ | **Boot Server | ||
**Shut Down Server | **Shut Down Server | ||
**BMC Cold Reset | **BMC Cold Reset | ||
Line 568: | Line 617: | ||
**KVM Java Console | **KVM Java Console | ||
**noVNC KVM Console | **noVNC KVM Console | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
*'''Extensions''' | *'''Extensions''' | ||
**Device Statistics | **Device Statistics | ||
− | ** | + | **Operating System Installation |
**DNS Management | **DNS Management | ||
**Password Management | **Password Management | ||
+ | |||
*'''OS Installation Actions''' | *'''OS Installation Actions''' | ||
**Rebuild Server | **Rebuild Server | ||
**ISO Images | **ISO Images | ||
+ | **SSH Keys | ||
+ | |||
+ | *'''Device Statistics Actions''' | ||
+ | **View Graphs | ||
+ | **Sensors | ||
+ | |||
+ | *'''Operating System Templates''' - selects the OS Templates that will be available for clients to choose from when reinstalling the server | ||
− | *''' | + | *'''Apply Client Area Feature Settings to Admin Area''' - if enabled, the client area settings configuration will be copied and used for the admin area product page view. <br/> '''''Note:''' Extensions, OS Installation Actions, Device Statistics Actions, and Operating System Templates are exceptions, and cannot be mirrored in the admin area.'' |
'''Email Notification''' | '''Email Notification''' | ||
Line 592: | Line 645: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:ED2x_14_1.png]] |
|} | |} | ||
{| | {| | ||
Line 665: | Line 718: | ||
==Admin Area== | ==Admin Area== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"| | + | |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 the WHMCS admin area.<br/> |
− | 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 '' '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. | The '' 'Update Order Information' '' allows you to manually check if a server matching the one specified in the order has been found and assigned. | ||
Line 695: | Line 747: | ||
==Client Area== | ==Client Area== | ||
{| | {| | ||
− | |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/> | + | |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, | + | Other available actions on the server: Start, Stop, Reboot, BMC Cold Reset, and Enable Rescue Mode. |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:ED2x_19.png]] |
|} | |} | ||
Line 709: | Line 761: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:ED2x_21_1.png]] |
+ | |} | ||
+ | |||
+ | ====Sensors==== | ||
+ | {| | ||
+ | |style="padding: 10px 0px 15px 15px;"|The "Sensors" section provides detailed insight into hardware performance and environmental conditions of the server.<br> Clients can view available sensors, along with clear graphs and up-to-date readings.<br/> | ||
+ | |||
+ | Displayed information includes: | ||
+ | |||
+ | * Sensor list with current reading type, class and last poll information | ||
+ | * Graphs illustrating historical data and trends | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 25px;"|[[File:ED2x_21_2.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 25px;"|[[File:ED2x_21_3.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 15px 15px;"|You can adjust the sensor visibility scope by clicking the pencil icon and defining a custom range. The available filters include: | ||
+ | * From-To Date - manually set the start and end dates | ||
+ | * Predefined Period - choose from today, yesterday, this week, last week, this month, last month, this year, or last year | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 25px;"|[[File:ED2x_21_4.png]] | ||
|} | |} | ||
Line 717: | Line 793: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:ED2x_22.png]] |
|} | |} | ||
{| | {| | ||
Line 732: | Line 808: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:ED2x_21_0.png]] |
|} | |} | ||
{| | {| | ||
Line 747: | Line 823: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:ED2x_22_2.png]] |
|} | |} | ||
{| | {| | ||
Line 753: | Line 829: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:ED2x_22_3.png]] |
|} | |} | ||
===DNS Management=== | ===DNS Management=== | ||
Line 760: | Line 836: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:ED2x_23.png]] |
|} | |} | ||
{| | {| | ||
Line 767: | Line 843: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:ED2x_24.png]] |
|} | |} | ||
Line 775: | Line 851: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:ED2x_25.png]] |
|} | |} | ||
Line 806: | Line 882: | ||
==Email Templates Merge Fields== | ==Email Templates Merge Fields== | ||
{| | {| | ||
− | |style="padding: 10px 0px 5px 15px;"| | + | |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. | 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. | ||
|} | |} | ||
Line 919: | Line 995: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:ED2x_29.png]] |
|} | |} | ||
{| | {| | ||
Line 925: | Line 1,001: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:ED2x_39.png]] |
|} | |} | ||
Latest revision as of 13:39, 3 September 2025
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. |
- 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 |
✔ Automatic Domain Update |
✔ Enable Stock Control |
✔ Enable WHMCS Order Actions |
✔ Define Bandwidth Notification Limit |
✔ Control Service Access Level |
✔ Select Service Activation Condition |
✔ Define Replacements For EasyDCIM Order Actions On: |
✔ Activation |
✔ Suspension |
✔ Unsuspension |
✔ Termination |
✔ Error Occurring |
✔ 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 Operating Sysytem Templates For Rebuilding |
✔ Apply Client Area Feature Settings to Admin Area |
✔ 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 |
✔ View Server Sensors Data: |
✔ Power Watts Supplies |
✔ Power Voltages |
✔ Fans RPM |
✔ Temperatures |
✔ Add Custom ISO Images To Server |
✔ Rebuild Server Using OS Templates And Your Own Credentials |
✔ Add And Manage SSH Keys |
✔ Manage Reverse DNS Records |
✔ View Access List With Stored Passwords |
- Configurable Options:
✔ Disk Layout |
✔ Extras |
✔ Server Model |
✔ Server Location |
✔ OS Template |
✔ Bandwidth Limit |
✔ Bandwidth OUT Limit |
✔ Bandwidth IN Limit |
✔ Power Usage |
✔ 95th Percentile |
✔ 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 |
✔ ASUS |
- 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.13.0 And Later |
✔ Supports PHP 8.3 Back To PHP 8.1 |
✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme" |
✔ Supports WHMCS V8.13 Back To WHMCS V8.10 |
- Exclusive Promo Code From ModulesGarden:
✔ Save 25% For 3 Months On The EasyDCIM Control Panel With Coupon: WHMCS25%_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. |
![]() |
2. Extract the package and upload its content into the main WHMCS directory. The content of the package to upload should look like this. |
![]() |
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 'System Settings' → 'Servers' and press the 'Add New Server' button. |
![]() |
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'. |
![]() |
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. |
![]() |
6. The next step is creating a server group. To do so, click on 'Create Server Group'. |
![]() |
7. Enter the name, click on your previously created server, press 'Add' and 'Save Changes' afterwards. |
![]() |
[edit] Configuration of Product
9. In order to create and configure a product, go to 'System Settings' → 'Products/Services'. Click on 'Create a New Group'. |
![]() |
10. Enter the product group name and press 'Save Changes'. |
![]() |
11. Once you have a product group, you can assign your product to it. To create a product, click on 'Create a New Product'. |
![]() |
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'. |
![]() |
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'. |
![]() |
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:
Automation Settings - define actions related to this product, they will be executed automatically based on the actions taken in WHMCS:
|
![]() |
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.
|
![]() |
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:
Email Notification
|
![]() |
15. Choose parts from the dropdown menu and provide their values. They will be available for clients while placing an order. |
![]() |
![]() |
16. Alike parts, you may configure extra metadata that will be required to choose for clients while placing an order. |
![]() |
![]() |
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'. |
![]() |
![]() |
![]() |
![]() |
[edit] Billing Configuration
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.
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). |
![]() |
[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.
|
![]() |
[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. |
![]() |
Our module allows you to:
|
![]() |
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. |
![]() |
[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, Reboot, BMC Cold Reset, and Enable Rescue Mode. |
![]() |
[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. |
![]() |
[edit] Sensors
The "Sensors" section provides detailed insight into hardware performance and environmental conditions of the server. Clients can view available sensors, along with clear graphs and up-to-date readings. Displayed information includes:
|
![]() |
![]() |
You can adjust the sensor visibility scope by clicking the pencil icon and defining a custom range. The available filters include:
|
![]() |
[edit] OS Installation
The OS Installation section gives the possibility to reinstall OS on the client's server. |
![]() |
Select the OS template to reinstall and provide all the necessary details to proceed with the reinstallation. Confirm your decision in the end. |
![]() |
[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. |
![]() |
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. |
![]() |
[edit] SSH Keys
In the 'SSH Keys' clients can add and manage their keys.
The action keys allow for settings up a key as default, updating the key or deleting it. |
![]() |
To create a new SSH key, all your clients need to do provide its name and the key itself. The newly created record will immediately appear on the list. |
![]() |
[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. |
![]() |
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. |
![]() |
[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. |
![]() |
[edit] KVM Java Console
If your clients are using Dell or SuperMicro servers, they can access the KVM Java console. |
![]() |
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. |
![]() |
[edit] noVNC KVM Console
For clients using the 'American Megatrends', 'Dell', HP' and 'Supermicro' servers there is available access to the noVNC KVM console. |
![]() |
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:
|
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). |
![]() |
Once the relevant options are enabled, your clients will also be able to view billing for the current usage in your client area. |
![]() |
[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. |
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 |
[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:
~/langs/overrides/english.php.
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. |
[edit] Update Instructions
[edit] General Guidelines
An essential guidance through the process of updating the module from version 2.x to a higher one is offered here. Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues. |
[edit] Migration From 'V1' To 'V2' Module Version
If you are updating your EasyDCIM Dedicated Servers For WHMCS module from version 1.x to 2.x, follow the steps below to ensure a smooth migration without errors. |
Important: Back up your WHMCS files and database before starting the update to avoid data loss in case of failure. |
1. Create a backup of your WHMCS files and database to prevent data loss. |
2. Log in to the client area and download the latest version of the module. |
3. Upload and extract the new module files into your WHMCS root directory. |
4. Navigate to System Settings → Servers. Create a new server and server group for the EasyDCIM V2 module. |
5. Go to System Settings → Products/Services. Find and open the product you wish to update. |
6. Open the Custom Fields section, and correct the existing custom fields names as shown below:
|
7. Open the Module Settings section of the product of your interest, find and open the product you are going to update. |
8. Change the 'Module Name' from "EasyDCIM" to "EasDCIMv2". Change the 'Server Group' to the created in the 4th step. |
9. Configure the module settings from scratch and save the changes. |
10. Generate any configurable options if needed. |
11.* Regarding billing methods update:
|
[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. |