Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Workflow - From Order To Created Server)
(→‎Management)
Line 146: Line 146:
 
{|
 
{|
 
|style="padding: 10px 0px 30px 15px;"|'''At this section we will show you possibilities of EasyDCIM For WHMCS.'''<br />
 
|style="padding: 10px 0px 30px 15px;"|'''At this section we will show you possibilities of EasyDCIM For WHMCS.'''<br />
−
Our module allows you to offer EasyDCIM via your WHMCS system.<br />
+
Our module allows you to offer EasyDCIM via your WHMCS system.
−
In addition to that, you can easily manage your servers owing to SoftLayer Control Panel addon.
+
 
|}
 
|}
 
==Admin Area==
 
==Admin Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|As soon as you set up server for client, you can request various actions and server details from WHMCS admin area.<br />
+
|style="padding: 10px 0px 15px 15px;"|As soon as you set up server for client, you can request various actions and view server details from WHMCS admin area.<br />
−
'' 'Suspend' ''/'' 'Unsuspend' '' actions change status of user account at the SoftLayer server.<br />
+
'' 'Change Password' '' action changes SSH access details to clients server while '' 'Update Order Information' '' allows you to manually check if server matching order have been found and assigned.
−
'' 'Create' ''/'' 'Terminate' ''/'' 'Change Package' '' actions send an email to admin with specific requests.
+
 
|}
 
|}
 
{|
 
{|
Line 159: Line 157:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Our module allows you to check server power status (1), do commands like: default/soft/hard reboot (2) and even power it on/off (3).
+
|style="padding: 0px 0px 20px 15px;"|Our module allows you to boot/reboot/shutdown server, as well as view its details.
 
|}
 
|}
 
{|
 
{|
Line 165: Line 163:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|With our module, you are able to view server details.<br />
+
|style="padding: 0px 0px 15px 15px;"|Below them, various usage graphs are available at your disposal.
−
Simply, press '' 'Show Server Details' ''.
+
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:ED_18.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:ED_18.png]]
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|As you can see on the following screen, under server details you can find various details about server assigned to your client.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_19.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|You can also access server bandwidth graphs through pressing '' 'Show Bandwidth Graph'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_20.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Both, private and public network bandwidth graphs can be accessed that way.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:ED_21.png]]
 
 
|}
 
|}
  
 
==Client Area==
 
==Client Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the client area of module your customer can view all details concerning his server as well as bandwidth graphs.<br />
+
|style="padding: 10px 0px 15px 15px;"|In the client area of the module your customer can view all details concerning his server as well as manage its status.
−
They can even manage rDNS records, of course if you only give them such permission.<br />
+
−
Your clients can view server power status (4), switch their servers on/off (5) and order various types of reboot (6-8).  
+
 
|}
 
|}
 
{|
 
{|
Line 200: Line 177:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Let's look at '' 'Server Details' ''(1) to you. As you can see, your clients can find here complete server specification.
+
|style="padding: 0px 0px 20px 15px;"|Additionally, below you can find various usage graphs.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED_17_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Your clients can view bandwidth of public and private networks in the '' 'Bandwidth Graphs' '' (2).
+
|style="padding: 0px 0px 15px 15px;"|You can also view information about traffic billing.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_24.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ED_18.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'' 'rDNS Management' '' (3) page allows your customers to easily update and remove existing rDNS records.
+
|style="padding: 0px 0px 15px 15px;"|And reinstall OS on your server.
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_25.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Our module also allows your clients to add new rDNS records.<br />
+
−
Adding a new rDNS record includes choosing rDNS IP address, providing TTL and hostname and pressing '' 'Add'. ''
+
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:ED_26.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:ED_26.png]]
−
|}
 
−
==EasyDCIM Addon==
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|In '' 'EasyDCIM' '' addon you can view the list of all orders of SoftLayer product and the list of available dedicated servers.<br/>
 
−
Let's proceed to further possibilities of our addon.
 
−
|}
 
−
===SoftLayer Product Orders===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|'' 'Ordered Services' '' tab allows you to view the list of all ordered EasyDCIM products.<br/>
 
−
Orders are sorted by their status, each tab contains orders with different statuses.<br/>
 
−
In addition, you can view basic details of each order, such as client who made it, hosting id or assigned server.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_27.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|From here you can also easily assign server to hosting or change assigned server if hosting already have one assigned.<br />
 
−
Server assignment is shown at the [[#Workflow_-_From_Order_To_Created_Server|'''Workflow''']] section.<br />
 
−
Let's see how to easily remove assigned server.<br />
 
−
For that purpose press '' 'Change Assignment' '' button.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_28.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, press '' 'Remove Assignment' '' button.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:ED_29.png]]
 
−
|}
 
−
 
−
===SoftLayer Devices===
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|In order to view list of your EasyDCIM proceed to '' 'SoftLayer Devices' '' → '' 'All'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_30.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|List of all unassigned EasyDCIM can be accessed under '' 'SoftLayer Devices' '' → '' 'Unassigned'. ''<br />
 
−
From here you can even assign server to hosting through pressing '' 'Assign To Hosting''' button.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ED_31.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, choose hosting you wish to assign server to, fill API access details of SoftLayer user created for your customer and press '' 'Save'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:ED_32.png]]
 
 
|}
 
|}
  

Revision as of 12:04, 3 November 2016

Contents

About EasyDCIM For WHMCS

EasyDCIM For WHMCS will allow you to move provisioning and management of bare metal servers directly to your WHMCS.

Module will let your clients overview and manage their servers directly from your client area. They will be able to e.g. reboot servers or view resource usage graphs.
You will be also allowed to monitor, assign and manage all your EasyDCIM regardless of whether they are already ordered by your WHMCS customers or not.

  • Client Area Features:
✔ Power On/Off Server
✔ Assign SoftLayer Server To Hosting
✔ Assign Hosting To Unassigned SoftLayer Server
  • General Info:
✔ Supports Bare Metal Servers
✔ Multi-Language Support
✔ Supports PHP 5.3 Up To PHP 7
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V6 and V7

Installation and Configuration

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

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

Installation

1. Log in to your client area and download EasyDCIM For WHMCS.
ED 1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like these.

ED 2.png


Configuration of Server

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

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

ED 7.png
9. Next, choose 'EasyDCIM' from 'Type' dropdown menu.

Fill in your server name, IP address, username and password and press 'Save Changes'.

ED 8.png
10. After configuring your server correctly, you will see a following screen.

In order to check connection with a EasyDCIM server, simply press 'Test Connection' as shown on the screen below.

ED 9.png
11. It is time to create a server group, to do so click on 'Create Server Group'.
ED 10.png
12. Enter name, click on your previously created server, press 'Add' and afterwards 'Save Changes'.
ED 11.png

Configuration of Product

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

Click on 'Create a New Group'.

ED 12.png
14. Enter product group name and press 'Save Changes'.
ED 13.png
15. When you have a product group, you can assign your product to it.

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

ED 14.png
16. Afterwards, choose your product group and enter your product name and press 'Continue'.
ED 15.png
17. Now go to 'Module Settings' section, choose both 'EasyDCIM' and your previously created server group from dropdown menus.

Next, 'Save Changes'.

ED 17.png
17. Next, it is time to configure product. On ToDo!!!!
ED 17.png


9. Now, optionally you can generate default configurable options to allow orders tailored to your clients needs.

We recommend viewing and modyfying them to fit your provisioning capabilities. You can find them under 'Setup' → 'Products/Services' → 'Configurable Options' .

ED 9.png

Management

At this section we will show you possibilities of EasyDCIM For WHMCS.

Our module allows you to offer EasyDCIM via your WHMCS system.

Admin Area

As soon as you set up server for client, you can request various actions and view server details from WHMCS admin area.

'Change Password' action changes SSH access details to clients server while 'Update Order Information' allows you to manually check if server matching order have been found and assigned.

ED 17.png
Our module allows you to boot/reboot/shutdown server, as well as view its details.
File:ED 17 1.png
Below them, various usage graphs are available at your disposal.
ED 18.png

Client Area

In the client area of the module your customer can view all details concerning his server as well as manage its status.
ED 22.png
Additionally, below you can find various usage graphs.
File:ED 17 1.png
You can also view information about traffic billing.
ED 18.png
And reinstall OS on your server.
ED 26.png

Tips

1. We advice to create one SoftLayer user per each order.

Currently, suspending SoftLayer hosting suspends SoftLayer user bounded to it.

2. If a reboot command has been issued successfully in the past 20 minutes, another remote management command will not be allowed.

This is to avoid any type of server failures.

3. If you want to disable displaying of API access details form in your template there is two things you need to do.

1. Check 'Hide API Access Details' checkbox at your SoftLayer product → 'Module Settings' .
2. Modify your template → 'clientareaproductdetails.tpl' as shown below: 

{if $username}
//code responsible for displaying form with API access details
{/if}

Note: Portal template already has such solution in its clientareaproductdetails.tpl file, so you can view how it's implemented.

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=Hosting_Quota_Notifications_1.X_For_WHMCS&oldid=28677"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community