Personal tools


IBM Cloud Virtual Servers For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search


About IBM Cloud Virtual Servers For WHMCS

IBM Cloud Virtual Servers For WHMCS is a well-thought-out module that will automate the provisioning and control of IBM Cloud Virtual Servers instances straight from your WHMCS.
Your clients will be allowed to carry out the fundamental actions such as start, stop, and reboot the server remotely.
Moreover, you can effortlessly supervise product features as well as the status of each sold machine.
  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Server
✔ Start/Stop/Reboot Server
✔ View Server Status And Details
✔ View Assigned Private And Floating IP Addresses
✔ Configure Product Details:
✔ Choose Virtual Private Cloud
✔ Choose Resource Group
✔ Choose Location
✔ Choose Profile
✔ Choose Subnet
✔ Toggle Floating IP Address
✔ Choose Image
✔ Provide Hostname Prefix
✔ Choose SSH Key
✔ Provide User Data Script
✔ Generate Configurable Options
✔ Run API Connection Test
  • Client Area Features:
✔ Start/Stop/Reboot Server
✔ View Server Status And Details
✔ View Assigned Private And Floating IP Addresses
✔ Provide SSH Key During Order
  • Configurable Options:
✔ Profile
✔ Image
✔ Floating IP
  • Available Images:
✔ Linux OS:
✔ CentOS 7.x
✔ Debian GNU/Linux 9.x Stretch/Stable
✔ Red Hat Enterprise Linux 7.x
✔ Ubuntu Linux 16.04 LTS Xenial Xerus
✔ Ubuntu Linux 18.04 LTS Bionic Beaver
✔ Microsoft Windows:
✔ Windows Server 2012 R2 Standard Edition
✔ Windows Server 2012 Standard Edition
✔ Windows Server 2016 Standard Edition
✔ Any Other OS Platforms When Made Available By IBM Cloud
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 7.1 Up To PHP 7.3
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.8 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 Virtual Servers For WHMCS smoothly.

We will guide you step by step through the whole process.


1. Log in to our client area and download the module.
IBM 1.png
2. Upload and extract the extension into the main WHMCS directory.

Extracted files in your WHMCS directory should look like this:

IBM 2.png
3. When you install IBM Cloud Virtual Servers For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

The file is located in '/yourWHMCS/modules/servers/IbmCloudVirtualServers/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

IBM 3.png
4. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

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

IBM 4.png
5. Now, set up the 'storage' folder as recursively writable.

This folder is available at '/yourWHMCS/modules/servers/IbmCloudVirtualServers/'.

IBM 5.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 where to find them.

6. Firstly, log in to your IBM Cloud account and proceed to

Click on the 'Create an IBM Cloud API key' button as presented below.

IBM 6.png
7. Now, provide a name and description of your 'API Key' and press 'Create' .
IBM 7.png
8. Your 'API Key' has been created successfully. Copy it and keep safe. You may also download a file with the details.

Note that you will not be able to see your 'API Key' again.

IBM 8.png
9. Now, log in to your WHMCS and proceed to 'Setup' 'Products/Services' 'Servers' and press 'Add New Server'.
IBM 9.png
10. Next, enter your server name and select 'IBM Cloud Virtual Servers' from the 'Module' field.

Your 'Hostname' depends on the region of your IBM Cloud. More info can be found here.
Now, provide your IBM Cloud username and 'API Key' as a password.
If for some reasons, the test connection is not successful, then paste your 'API Key' once again in the 'Access Hash' field.

IBM 10.png
11. It is time to create a server group. To do so, click on 'Create New Group' .
IBM 11.png
12. Enter a name, click on your previously created server, press 'Add' and afterward 'Save Changes' .
IBM 12.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'.

IBM 13.png
14. Enter your product group name and press 'Save Changes'.
IBM 14.png
15. Once you have a product group, you can create a new product.

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

IBM 15.png
16. Afterward, choose your product type, enter your product name, choose module and the product group from the dropdown menus. Press 'Continue'.
IBM 16.png
17. Now, go to the 'Module Settings' section, choose your previously created server group from the dropdown menu.

The module should automatically save and reload the settings. If not, click on the 'Save Changes' option manually.

IBM 17.png
18. Now, you can start configuring the settings of the server you sell.

Important The 'Virtual Private Cloud' and 'Subnet' fields will be visible in the 'Module Settings' only if you create them firstly in IBM Cloud panel here.

  • Virtual Private Cloud - select your preferred VPC with a set of VPS resources.
  • Resource Group - once the virtual server instance has been created, you are not able to change a resource group.
  • Location - choose a geographical area with a set of VPS resources.
  • Profile - define the profile of your instance by selecting the appropriate option from the dropdown menu.
  • Subnet - you need to create subnets in IBM Cloud panel firstly, then choose a subnet for the network interface.
  • Floating IP - decide if a floating IP should be added to the network interface.
  • Image - choose the image from available ones.
  • Hostname Prefix - provide a hostname prefix.
  • Default SSH Key - if there are any SSH keys defined previously in IBM Cloud panel, you can choose a default one here.
  • User Data - you can specify optional user data that automatically performs common configuration tasks or runs scripts. More info can be found here.
IBM 18.png
19. At the end of the configuration process, you can decide whether you want to generate configurable options for the product.

Configurable options can be used by your clients to select each virtual machine parameters individually during order placement.
Otherwise, if configurable options are not defined, then the fixed parameters specified in the earlier configuration will be used instead.
If you decide to use configurable options, press on the 'Create Configurable Options' button.

IBM 19.png
Now, select which options you want to generate and confirm by clicking 'Create' .
Note that the configuration for disabled options will still be taken from the configuration of the main product.
More information about how to use configurable options can be found here or in the official WHMCS documentation.
IBM 20.png

SSH Keys

In the 'Custom Fields' tab you will find the 'SSH Public Key' field which is displayed to clients on the order form by default.

Your SSH key must be an RSA key with a key size of either 2048 bits or 4096 bits.
If you would like to limit the possibility of entering the key e.g. only to the 'ssh-rsa' format, you can use the regular expression in the validation field, such as:

#ssh-rsa AAAA[0-9A-Za-z+/]+[=]{0,3}( [^@][email protected][^@]+)?# 

Remember that API allows such action only once, during the initial VM creation.
Note: If you disable the 'Show on Order Form' option, a client will not be able to provide SSH Key while placing an order.

IBM 21.png


Admin Area

IBM Cloud Virtual Servers For WHMCS allows you to monitor and manage your customer server instance from the admin area of your WHMCS system.

This includes supervision of such features as:

  1. Configurable options which enable you to view the chosen server details
  2. Module commands to allow easy and quick management of the server
    Note: Currently, the 'Change Package' action works only for Floating IPs.
    Important: In order to successfully complete the change package action, the machine must be previously stopped by your client.
  3. Service actions, including: Start, Stop and Reboot the server
  4. Instance details that provide the current status, resources and options set.
IBM 22.png


Thanks to configurable options, you are able to offer a product which your clients can match to their needs.
Additionally, you are able to set up pricing for each configurable option, which makes your offer even more competitive.

At this moment you also have to provide the SSH key. Note that this key should be in one of the OpenSSH standard formats which are supported by API, e.g. ssh-rsa.

IBM 23.png

Client Area

The client area interface of IBM Cloud Virtual Servers For WHMCS should look like the one on the screen below.
As you can see, the control panel contains useful details of the managed server.

The module allows your customers to easily start, stop and reboot their server instance through pressing the corresponding buttons.

IBM 24.png

Update Instructions

An 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.
WHMCS Modules
WHMCS Translations
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
IBM Cloud Virtual Servers For WHMCS