SoftLayer Servers For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About SoftLayer Servers For WHMCS

SoftLayer Servers 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, manage rDNS records or view bandwidth graphs.
You will be also allowed to monitor, assign and manage all your SoftLayer servers regardless of whether they are already ordered by your WHMCS customers or not.

  • Admin Area Features:
✔ Power On/Off Server
✔ Reboot Server - Default/Soft/Hard
✔ Refresh Server Status
✔ Send Email To Administrator Upon Requesting Server Creation/Termination/Upgrade
✔ Deactivate/Activate SoftLayer User Upon Module Suspension/Unsuspension
✔ View Full Specification Of Server
✔ View Private And Public Network Bandwidth Graphs
  • Client Area Features:
✔ Power On/Off Server
✔ Reboot Server - Default/Soft/Hard
✔ Refresh Server Status
✔ View Full Specification Of Server
✔ View Private And Public Network Bandwidth Graphs
✔ Manage rDNS Records
  • SoftLayer Control Panel Addon Features:
✔ View All SoftLayer Orders Grouped By Status
✔ View Full List Of SoftLayer Servers
✔ Access List Of SoftLayer Servers Not Assigned To Any SoftLayer Hosting
✔ 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 SoftLayer Servers 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 the module.
SL 1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.3 up to PHP 5.6.
It does not apply to open source versions.

Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'.

SL 2.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

We4r5.png
4. When you install SoftLayer Servers For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/servers/softLayer/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

SL 3.png
5. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → 'My Products' .

SL 4.png

Configuration of Product

6. Proceed to 'Setup' 'Products/Services' 'Products/Services' and press 'Create a New Group'.
SL 5.png
7. Enter product group name and press 'Save Changes'.
SL 6.png
8. When you have a product group, you can create your product.

To do so, click on 'Create a New Product'.

SL 7.png
9. Fill in product name, select previously created product group and press 'Continue'.
SL 8.png
10. Go to 'Module Settings' tab, choose 'SoftLayer' from 'Module Name' dropdown menu and fill in the fields with your SoftLayer API access details.

Additionally, you can enable features available in the client area.
These features are: bandwidth graphs, rDNS management, reboot management and power management.
Press 'Save Changes' as soon as you have finished.
Note: You should use API access details of main user (which can be recognized by 'SL' prefix in the username) otherwise servers status will not be displayed correctly.

SL 9.png

Configuration of Addon

11. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to the 'Setup' 'Addon Modules'. Afterwards, find 'SoftLayer Control Panel' and press 'Activate' button.

SL 10.png
12. In the next step you need to permit access to this module.

To do so click on 'Configure' button, tick 'Access Control' near desired admin role groups and press 'Save Changes'.

SL 11.png
13. It is time to configure addon API connection.

Go to 'Addons' 'SoftLayer Control Panel' 'Configure'.
Now, choose previously created SoftLayer Servers product and press 'Save' to load API access details from it.

SL 12.png
14. You have just successfully installed SoftLayer Servers For WHMCS!

Management

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

Our module allows you to offer SoftLayer servers via your WHMCS system.
In addition to that, you can easily manage your servers owing to SoftLayer Control Panel addon.

Workflow - From Order To Created Server

Now, we will show you what steps need to be taken to prepare server to be used by a client.

1. Client orders SoftLayer Servers from your WHMCS client area.

SL 13.png
2. You will receive an email with server creation request.
SL 14.png
3. Log in to your SoftLayer panel.
4. Create user account (or use the existing one if an account for specified client already exists).

Remember to set up sufficient account permissions to use all of the client area features of SoftLayer Servers For WHMCS module.

5. Assign client to machine.
6. Save client username and API key.
7. Go back to your WHMCS admin area and proceed to the 'SoftLayer Control Panel' 'Ordered Devices' 'All'.

Press 'Assign Server' as shown on the following screen.

SL 15.png
8. Provide here primary IP address of server and previously created user API access details.

Confirm assignment through pressing 'Save' button.
Note 1: Primary IP address of server can be found in 'SoftLayer Control Panel' 'SoftLayer Devices' 26 'Unassigned'.
Note 2: User API access details can be found in SoflLayer panel → 'Account' 'Users'. '

SL 16.png
If you assigned server to user correctly, a you should see something similar to the following screen in the client are.
SL 16 1.png

Admin Area

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

'Suspend' / 'Unsuspend' actions change status of user account at the SoftLayer server.
'Create' / 'Terminate' / 'Change Package' actions send an email to admin with specific requests.

SL 17.png
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).
SL 17 1.png
With our module, you are able to view server details.

Simply, press 'Show Server Details' .

SL 18.png
As you can see on the following screen, under server details you can find various details about server assigned to your client.
SL 19.png
You can also access server bandwidth graphs through pressing 'Show Bandwidth Graph'.
SL 20.png
Both, private and public network bandwidth graphs can be accessed that way.
SL 21.png

Client Area

In the client area of module your customer can view all details concerning his server as well as bandwidth graphs.

They can even manage rDNS records, of course if you only give them such permission.
Your clients can view server power status (4), switch their servers on/off (5) and order various types of reboot (6-8).

SL 22.png
Let's look at 'Server Details' (1) to you. As you can see, your clients can find here complete server specification.
SL 23.png
Your clients can view bandwidth of public and private networks in the 'Bandwidth Graphs' (2).
SL 24.png
'rDNS Management' (3) page allows your customers to easily update and remove existing rDNS records.
SL 25.png
Our module also allows your clients to add new rDNS records.

Adding a new rDNS record includes choosing rDNS IP address, providing TTL and hostname and pressing 'Add'.

SL 26.png

SoftLayer Servers Addon

In 'SoftLayer Servers' addon you can view the list of all orders of SoftLayer product and the list of available dedicated servers.

Let's proceed to further possibilities of our addon.

SoftLayer Product Orders

'Ordered Services' tab allows you to view the list of all ordered SoftLayer Servers products.

Orders are sorted by their status, each tab contains orders with different statuses.
In addition, you can view basic details of each order, such as client who made it, hosting id or assigned server.

SL 27.png
From here you can also easily assign server to hosting or change assigned server if hosting already have one assigned.

Server assignment is shown at the Workflow section.
Let's see how to easily remove assigned server.
For that purpose press 'Change Assignment' button.

SL 28.png
Afterwards, press 'Remove Assignment' button.
SL 29.png

SoftLayer Devices

In order to view list of your SoftLayer servers proceed to 'SoftLayer Devices' 'All'.
SL 30.png
List of all unassigned SoftLayer servers can be accessed under 'SoftLayer Devices' 'Unassigned'.

From here you can even assign server to hosting through pressing 'Assign To Hosting' button.

SL 31.png
Afterwards, choose hosting you wish to assign server to, fill API access details of SoftLayer user created for your customer and press 'Save'.
SL 32.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.
Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social