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.

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

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

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

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'.

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

Click on 'Create a New Group'.

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

Do not forget to click 'Save Changes'.

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.

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 Management] Unassign Subnet
  • Delete notifications
  • [OS Installation] Reinstall OS
  • [IPMI Integration] Delete Operator Account
  • [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:
  • Continue Provisioning
  • Abort Provisioning

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

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.

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 also be calculated during the execution of the WHMCS system cron.
Important: The 'Bandwidth Limit' configurable option assumes the soft limit unit for it is set to 'MB'. If it is not, the CO will have to be adjusted accordingly.

• 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.

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

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.

• 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

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.

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

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

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.

The action keys allow for settings up a key as default, updating the key or deleting it.

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

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

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.

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!

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.

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.

- 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

• 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';

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.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

• 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.