Personal tools
Namespaces

Variants
Actions

EasyDCIM Colocation For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Configuration of Product)
Line 257: Line 257:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''12. Before configuring the product, set up the EasyDCIM Colocation cron job.
+
|style="padding: 0px 0px 15px 15px;"|'''11. Before configuring the product, set up the EasyDCIM Colocation cron job.
 
Usually after order placement, the client services are not immediately activated in EasyDCIM (that depends on your EasyDCIM configuration).<br/>
 
Usually after order placement, the client services are not immediately activated in EasyDCIM (that depends on your EasyDCIM configuration).<br/>
 
In those situations the synchronization cron is used to assign a matching colocation when service is ready.<br/>
 
In those situations the synchronization cron is used to assign a matching colocation when service is ready.<br/>
Line 267: Line 267:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''13. The module configuration is partially non-mandatory. The server will be assigned basing on the defined configuration, matching only the filled out options.
+
|style="padding: 0px 0px 20px 15px;"|'''12. The module configuration is partially non-mandatory. The server will be assigned basing on the defined configuration, matching only the filled out options.
 
'''Default Options:'''
 
'''Default Options:'''
 
*Configurable Options - generate if you want to use configurable options instead of the '' Location' and '' 'Model' '' set in product's module settings.
 
*Configurable Options - generate if you want to use configurable options instead of the '' Location' and '' 'Model' '' set in product's module settings.
Line 287: Line 287:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''14. Now, you can optionally generate the default configurable options to allow placing orders tailored to customer needs.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''13. Now, you can optionally generate the default configurable options to allow placing orders tailored to customer needs.<br/>
 
You can find them under '' 'Setup' → 'Products/Services' → 'Configurable Options'.''<br/>
 
You can find them under '' 'Setup' → 'Products/Services' → 'Configurable Options'.''<br/>
 
'' '''Note:''' Any configurable option will overwrite its counterpart from the product's 'Module Settings'.''
 
'' '''Note:''' Any configurable option will overwrite its counterpart from the product's 'Module Settings'.''

Revision as of 10:23, 27 February 2018

Contents

About EasyDCIM Colocation For WHMCS

EasyDCIM Colocation For WHMCS will allow you to xxxxxxxxxxxxxxxxxxxxx.

xxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxx.

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

Installation and Configuration

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

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

Installation

1. Log in to our client area and download the module.
EC1.png
2. Extract the downloaded file into the main WHMCS directory.

The content of the package should look like this.

EC2.png

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.

EC3.png
4. Next, choose 'EasyDCIMColocation' from the 'Type' dropdown menu.

Fill in your server name, address, username and password (API Key). Next check the connection with an EasyDCIM server and press 'Save Changes'.
Note: The password can be found in your EasyDCIM administrator user profile listed as 'API Key'.

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

Configuration of Product

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

Click on 'Create a New Group'.

EC8.png
8. Enter the product group name and press 'Save Changes'.
EC9.png
9. When you have a product group, you can assign your product to it.

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

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

Do not forget to click 'Save Changes'.

EC12.png
11. Before configuring the product, set up the EasyDCIM Colocation cron job.

Usually after order placement, the client services are not immediately activated in EasyDCIM (that depends on your EasyDCIM configuration).
In those situations the synchronization cron is used to assign a matching colocation when service is ready.
We suggest to run cron every 5 minutes. 

php -q yourWHMCS/modules/servers/EasyDCIMColocation/cron/Cron.php
EC13.png
12. The module configuration is partially non-mandatory. The server will be assigned basing on the defined configuration, matching only the filled out options.

Default Options:

  • Configurable Options - generate if you want to use configurable options instead of the Location' and 'Model' set in product's module settings.
  • Location (required) - the desired server location
  • Model (required) - the EasyDCIM server model

Product Configuration

  • Auto Accept - automatically run server matching after order placement. Use only if you have configured your EasyDCIM to automatically accept services.
    If you use cron synchronization you can leave this option unchecked.
  • 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.

Service Actions

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

Options Visible In Client Area

  • Traffic Statistics - display statistics on traffic in the client area.
  • Power Usage Statistics - display statistics on power usage in the client area.
  • Power Outlets - display power outlets in the client area and allows client to manage them.
EC14.png
13. Now, you can optionally generate the default configurable options to allow placing orders tailored to customer needs.

You can find them under 'Setup' → 'Products/Services' → 'Configurable Options'.
Note: Any configurable option will overwrite its counterpart from the product's 'Module Settings'.

EC15.png

Custom Fields

Once the configuration of the module settings has been completed, the following custom fields will be created automatically.
Note: These fields will not be visible to clients by default.
  • OrderID - the number used to link the product with EasyDCIM order number
  • ServerID - the number used to link the product with EasyDCIM server ID
EC7.png

Management

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

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

Admin Area

As soon as you set up a server for a client, you can request various actions and view server details from WHMCS admin area.
The 'Log In To Panel' button allows you to immediately log in to the client's EasyDCIM control panel.

EC16.png
Our module allows you to create/suspend/unsuspend/terminate server.
You can also 'Update Order Information' to check the service synchronization status (same action as performed by cron).
EC17.png
Below the mentioned functions, there are also traffic and power usage statistics with adjustable their time intervals.
EC18.png
Lastly, you can also see the custom fields with currently assigned 'Order ID' and 'Server ID' from the EasyDCIM panel.

An empty 'Server ID' field means that it has not yet been automatically assigned by the cron (e. g. it may not yet be activated in the EasyDCIM panel).
You can also force synchronization by clicking on the 'Update Order Information' module command, or enter ID manually and save the settings.

EC25.png

Client Area

In the main client area, your customers can view basic colocation server details as well as log in to their EasyDCIM control panel with a single click.
EC19.png
You can also view graph information about the traffic statistics with the possibility of defining its time intervals.

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

EC20.png
As well as power usage statistics.
EC21.png
Additionally, you can see the current state of power outlets with the possibility to turn them on, off or restart.
EC22.png

Advanced Billing Integration

The module supports integration with Advanced Billing For WHMCS module. This allows you to billing your customers for total bandwidth, power usage and 95th percentile billing for additional traffic.
EC23.png
Once the relevant options are enabled your clients will also be able to view the current usage billing in their client area.
EC24.png

Tips

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

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

Update Instructions

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

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=EasyDCIM_Colocation_For_WHMCS&oldid=37526"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
EasyDCIM Colocation For WHMCS