Personal tools
Namespaces

Variants
Actions

IBM Cloud Bare Metal Servers For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About IBM Cloud Bare Metal Servers For WHMCS

IBM Cloud Bare Metal Servers For WHMCS will allow you to move provisioning and management of bare metal servers directly to your WHMCS.

The 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 IBM Cloud bare metal 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
✔ View Full Specification Of Server
✔ View Private And Public Network Bandwidth Graphs
✔ Send Email To Administrator Upon Requesting Server Creation/Termination/Upgrade
✔ Deactivate/Activate Bare Metal Servers User Upon Service Suspension/Unsuspension
  • 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
  • Bare Metal Servers Control Panel Addon Features:
✔ View All Bare Metal Servers Orders Grouped By Status
✔ Assign/Unassign Bare Metal Servers To Ordered Clients' Hostings
✔ View Full List Of Owned Bare Metal Servers
✔ Access List Of Bare Metal Servers Not Yet Assigned To Clients' Hostings
✔ Assign Hostings To Unassigned Bare Metal Servers
✔ Select Product With API Details Configuration
  • General Info:
✔ Supports Bare Metal Servers
✔ Multi-Language Support
✔ Supports PHP 7.1 Up To PHP 7.4
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.10 And Later
✔ Easy Module Upgrade To Open Source Version

Installation and Configuration

This tutorial will show you how to successfully install and configure IBM Cloud Bare Metal Servers 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.
IBMC 1.png
2. In the downloaded file you might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later.

PHP71 74.png
Previous updates of the module may contain two packages dedicated to various PHP versions.

The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3.
Note: Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

PHP56 73.png
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Extract the package and upload its content into the main WHMCS directory.

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

IBMC 2.png
4. When you install IBM Cloud Bare Metal Servers For WHMCS for the first time you have to rename the 'license_RENAME.php' file.

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

IBMC 4.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 our client area → 'My Products' .

IBMC 3.png

Configuration of Server

Before you can go on, you must generate your 'IBM Cloud' access details. You will need them to connect with the server successfully.
Underneath, you will find instructions on where to find them.
6. Firstly, log in to your IBM Cloud account and proceed to https://cloud.ibm.com/iam/apikeys.
Now, change the view into 'Classic infrastructure API keys' . If you do not have the 'API Key' generated here, please generate a new one.
If you already have the 'API Key' , simply go to its details as presented below.
IBMC 4 1.png
7. In the details section, you will find your 'API Key' . Copy your 'API Key' and keep it in a safe file as it will be needed in the next section.
IBMC 4 2.png
8. Now, proceed to https://cloud.ibm.com/iam/users.
Again, make sure that the view is set to 'Classic infrastructure API keys' . Find the user and click 'Manage User' .
IBMC 4 3.png
9. Go to the 'VPN Password' section, copy the username, and keep it in a safe file.
IBMC 4 4.png

Configuration of Product

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

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

IBMC 7.png
13. Fill in product name, select previously created product group and press 'Continue'.
IBMC 8.png
14. Go to 'Module Settings' tab, choose 'IBM Cloud Bare Metal Servers' from the 'Module Name' dropdown menu.

Now, provide the previously copied 'API Username' and 'API Key' .

IBMC 9.png
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.

IBMC 10.png

Configuration of Addon

15. 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 the 'IBM Cloud Bare Metal Servers' panel and press the 'Activate' button.

IBMC 11.png
16. In the next step, you need to permit access to this module.

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

IBMC 12.png
17. It is time to configure addon API connection.

Go to 'Addons' 'IBM Cloud Bare Metal Servers' 'Configure'.
Now, choose the previously created 'IBM Cloud Bare Metal Servers' product and press 'Save' to load API access details from it.

IBMC 13.png
18. You have just successfully installed IBM Cloud Bare Metal Servers For WHMCS!

Management

At this section we will show you possibilities of IBM Cloud Bare Metal Servers For WHMCS.

Our module allows you to offer 'IBM Cloud Bare Metal Servers' products via your WHMCS system.
In addition to that, you can easily manage your servers owing to 'IBM Cloud Bare Metal Servers' 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. A client orders 'IBM Cloud Bare Metal Servers' product from your WHMCS client area.
2. You will receive an email with the server creation request.
3. Log in to your IBM Cloud panel.
4. Create a 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 the IBM Cloud Bare Metal Servers For WHMCS module.

5. Assign the client to the particular machine.
6. Save the client username and API key.
7. Go back to your WHMCS admin area and proceed to the 'IBM Cloud Bare Metal Servers' panel → 'Ordered Devices' 'All'.

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

IBMC 14.png
8. Provide here the primary IP address of server and previously created user API access details.

Confirm assignment through pressing the 'Save' button.
Note 1: The primary IP address of server can be found in 'IBM Cloud Bare Metal Servers' panel → 'Servers' 'Unassigned'.
Note 2: User API access details can be found in IBM Cloud panel → 'Account' 'Users'. '

IBMC 15.png
If you assigned a server to the proper user correctly, you should see a similar picture as presented below.
IBMC 16.png

Admin Area

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

'Suspend' / 'Unsuspend' actions change the status of the user account in IBM Cloud panel.
'Create' / 'Terminate' / 'Change Package' actions send an email to the admin with specific requests.

IBMC 17.png
Our module allows you to check server power status (1), run commands like: default/soft/hard reboot (2) and even power it on/off (3).
IBMC 18.png
With our module, you are able to view server details.

Simply, press 'Show Server Details' .

IBMC 19.png
As you can see on the following screen, under the server details you can find various details about server assigned to your client.
IBMC 20.png
You can also access server bandwidth graphs through pressing 'Show Bandwidth Graph'.
IBMC 21.png
Both, private and public network bandwidth graphs can be accessed that way.
IBMC 22.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 permissions.
Your clients can view server power status (4), switch their servers on/off (5) and order various types of reboot (6-8).

IBMC 23.png
Let's look at 'Server Details' (1) to you. As you can see, your clients can find here complete server specification.
IBMC 24.png
Your clients can view bandwidth of public and private networks in the 'Bandwidth Graphs' (2).
IBMC 25.png
'rDNS Management' (3) page allows your customers to easily update and remove existing rDNS records.
IBMC 26.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'.

IBMC 27.png

IBM Cloud Bare Metal Servers Addon

In the 'IBM Cloud Bare Metal Servers' addon you can view the list of all orders of 'IBM Cloud Bare Metal Servers' products and the list of available dedicated servers.

Let's proceed to further possibilities of our addon.

IBM Cloud Bare Metal Servers Product Orders

The 'Ordered Services' tab allows you to view the list of all ordered 'IBM Cloud Bare Metal 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 clients who made it, hosting IDs or assigned servers.

IBMC 28.png
From here you can also easily assign a server to the hosting or change the assigned server if the hosting already has one assigned.

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

IBMC 29.png
Afterwards, press the 'Remove Assignment' button.
IBMC 30.png

Servers

In order to view list of your 'IBM Cloud Bare Metal Servers' , proceed to 'Servers' 'All'.
IBMC 31.png
List of all unassigned IBM Cloud bare metal servers can be accessed under 'Servers' 'Unassigned'.

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

IBMC 32.png
Afterwards, choose the hosting you wish to assign a server to, fill in the API access details of IBM Cloud user created for your customer and press 'Save'.
IBMC 33.png

Tips

1. We advice to create one IBM Cloud user per each order.

Currently, suspending IBM Cloud hosting suspends IBM Cloud 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 failure.

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 in your IBM Cloud 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.

SoftLayer Migration

To perform the process of the module migration from 'SoftLayer Servers For WHMCS' to ' IBM Cloud Bare Metal Servers For WHMCS' correctly,
you need to follow these steps:
  • Deactivate the SoftLayer addon in 'Setup' 'Addon Modules' .
  • Delete all old files of 'SoftLayer Servers For WHMCS' from:
 your_whmcs/modules/addons/SoftLayerPanel 
 your_whmcs/modules/servers/SoftLayer 
  • Upload new files of 'IBM Cloud Bare Metal Servers For WHMCS' to the main WHMCS directory.

Important! Please remember to reissue the licence in the client area after uploading new files to the main WHMCS directory.
If you do not do this, you will get a notification about the wrong licence, and the migration process will not succeed.

  • Change the 'Module Name' to 'IBM Cloud Bare Metal Servers' in the 'Module Settings' tab of your product configuration.

Update Instructions

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

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Navigation
WHMCS Modules
WHMCS Translations
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
FAQ
Community
IBM Cloud Bare Metal Servers For WHMCS