Personal tools


OVH Public Cloud For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search


About OVH Public Cloud For WHMCS

OVH Public Cloud For WHMCS is a module which allows you to automatically provision virtual servers to your customers.

The great advantage of this module is the fact that customers can order and manage virtual servers, backups and many more in their own WHMCS client area.
Additionally, it allows you to conveniently overview and manage all the customers' servers.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Server
✔ Change Package - Supports Configurable Options
✔ View Server Status And Details
✔ View Interface Details
✔ View List Of Scheduled Tasks
✔ View Volumes Information
✔ Configure Client Area Features Per Product
✔ Define Backup Quantity Limit
✔ Set Security Groups
✔ Enable Backups Routing
✔ Run Extended Connection Test
  • Client Area Features:
✔ View Server Status And Details
✔ Start/Stop/Pause/Unpause/Resume/Rebuild Server
✔ Reboot Server - Soft/Hard
✔ Access noVNC Console
✔ Create/Restore/Delete Backups - Supported By VPS Not Using Cinder Volumes
✔ Download Public & Private SSH Keys
✔ View List Of Scheduled Tasks
✔ View Volumes Information
  • General Info:
✔ Automated Generation Of SSH Keys - Public SSH Key Is Injected To VM Automatically
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Most Suitable Servers To Products (read more)
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.3
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.8 And Later
✔ Easy Module Upgrade To Open Source Version
  • Available Configurable Options:
✔ Flavor
✔ VM Image
✔ IP Addresses
✔ Backups Files Limit
✔ Region

Installation and Configuration

This tutorial will show you how to successfully install and configure OVH Public Cloud For WHMCS.

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


1. Log in to our client area and download the module.
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.
If you need a package for the previous versions of PHP, please contact our support.

PHP71 73.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
Important: This situation does not affect the open source version of this module which can be applied to any PHP from version 5.6 and later.
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
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.

4. When you install OVH Public Cloud For WHMCS for the first time you have to rename 'license_RENAME.php' file.

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

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'.

6. Next step is setting up a cron job (each 5 minutes suggested).

Use the cron job below but switch 'your_whmcs' with your root WHMCS path.

php -q /your_whmcs/modules/servers/OVHPublicCloud/cron/cron.php

Configuration of Server

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

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

Note: If you have WHMCS V7.8.X or later, we recommend using your 'previous experience' of the server configuration instead of the new wizard tool.

8. Next, enter your server name and connection details.
  • Firstly, specify the details of your server. Choose 'OVH Public Cloud' from the module type dropdown menu and provide the 'Username', 'Password' and 'Tenant ID.'
    Note: To find your 'Tenant ID' , log in to your OVH Public Cloud panel and go to the 'Projects'.
    Now you will need to identify the row which corresponds to your project. The 'Tenant ID' will be located in the 'Project ID' column of the identified project.

  • Project Name - you may declare your project name to which this server is related (leave empty if not related to your OVH Public Cloud)
  • Certificate Path - you can also provide a full certificate path to verify permissions (leave empty if not related to your OVH Public Cloud)
  • Optionally, enter your OVH Public Cloud custom Domain or leave this field as 'Default' .
  • If your OpenStack uses https or any custom ports, you can additionally provide the relevant configuration in Secure and Port fields.
  • At last, provide your OVH Public Cloud 'hostname' (or 'IP address' in certain cases) - since the 1.0.8 module version is most likely to be just Prior to the 1.0.8 module version, the address format was a bit different and it looks like where the address starts with the https:// and ends with the API version that should be used.
  • In the next field, you can optionally enter the 'endpoint identity path' . You will probably wish to leave this field blank, because by default it will possibly not be used at all.
  • Do not also forget to select which API version you want to use ( 'V2.0' or 'V3' ).
    Important - if this dropdown is empty, please validate whether you provided the correct data into the 'IP/Hostname', 'Identity Endpoint Path', 'Secure' or 'Port' overwrite fields.

Finally, press 'Save Changes' .

9. While you configure your server details, you need to check if the connection with the OVH Public Cloud server is set up correctly.

Simply press 'Test Connection' as shown on the screen below.
During the test, the connection with all related endpoints will be checked.

Additionally, you have to set up each endpoint address to the corresponding region you want to use to make sure that all services will be connected successfully.
E.g. if you plan to apply the UK1 region, be sure that you choose endpoints that use the .uk1 subdomain name in address.
Optionally, select 'Don't use' if no endpoint is applicable to your OVH Public Cloud.

Note: Any chosen endpoint address will be automatically saved after its selection so there is no need to save it manually after each change.

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

Configuration of Product

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

Click on 'Create a New Group' .

13. Enter product group name and press 'Save Changes'.
14. When you have a product group, you can create your product.

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

15. Afterward, choose your product group and type from the dropdown menus, enter your product name and press 'Continue'.

'Product Type' should be set to 'Hosting Account'.

16. Now, go to the 'Module Settings' section, choose both 'OVHPublicCloud' and your previously created server group from the dropdown menus.

Next, press 'Save Changes'.

17. First of all, select 'Default Tenant'.

'Check access' should return 'OK' if the permissions are set up correctly.

18. Afterward, configure network settings. Choose 'Fixed Network', 'Floating Network' and 'Default Number Of IP Addresses'.

You can set up a network in two ways. Find more information about the configuration here.
We will set up a network without floating IP address as presented on the following screen.
Additionally, choose the number of IP addresses assigned to a product by typing it into 'Default Number Of IP Addresses'.

19. At this step, you can configure backups.

Mark the 'Backups Routing' checkbox if you want to replace the oldest backup with the newest one when the backups file limit is reached.
Afterward, enter a limit of backup files into 'Default Backups Files Limit'.

20. Mark security group from 'Use Security Groups'.

If you wish to use SSH keys, leave 'Inject SSH Key' marked (virtualization must support 'Inject File' feature).
1. It is recommended to leave 'Delete SSH Private Key' marked.
2. If you leave 'Use Volumes' selected, then 'Backups' option will be disabled!

OPC17 1.png
21. Finish through selecting features that will be available in the client area.

Mark the checkbox next to a feature in order to enable it.

22. Select 'Default Flavor' and 'Default VM Image'.

'Default Flavor' defined resources assigned to a VM while 'Default VM Image' allows you to choose the VM image used to create a new VM.

23. Choose 'Default Region' .

'Default Region' will be set if no respective configurable option is defined.
Please make sure that the region used is corresponding to the configured server's endpoints which you set in point 9. of the server configuration guide

Press 'Save Changes' when ready.

OPC19 9.png
24. Do not forget to generate default configurable options. Only then your clients will be allowed to adjust the virtual machine when placing an order.
Congratulations! You have just finished the installation and configuration of the product!


OVH Public Cloud For WHMCS allows your customers to manage their virtual machines via client area in your WHMCS system.

You can monitor and manage each product from your WHMCS admin area.
1. Configurable options - view current VPS resources and change VPS specifications through changing configurable options and pressing 'Change Package'.
2. Module commands - manage VPS status.
3. VPS details - refresh them through pressing the 'Refresh Details' icon.
4. Volumes section - visible only if you are using the 'Use Volumes' feature.
5. Scheduled tasks status can be found in this table.
6. In the marked custom fields you can find IDs of the VM and a private flavor.



Owing to configurable options, you are able to offer a product which your clients can tailor according to their needs.

Additionally, you are able to set up pricing for each configurable option, which make your offer even more competitive.
Important: Virtual Private Server is not created immediately after the 'Create' action, therefore, it is wise to inform your clients about the delay.


Client Area

Client area interface of OVH Public Cloud VPS should look like the one on the screen below.
As you can see, the control panel contains useful options needed for managing VMs.

Module allows your customers to easily start/stop, pause/unpause, soft reboot, hard reboot and reset the network of their virtual servers.
Clients can also rebuild the server, access the noVNC console, create a backup and view scheduled tasks.
Under 'Tasks', your customers can view all requested tasks that were not completed yet.



The rebuild feature allows your clients to change the server image.

Click on the 'Rebuild' button as shown on the following screen to continue.

To reinstall your server, choose an image and press the 'Rebuild' button.

noVNC Console

One of the most interesting functionalities is access to a noVNC console where your clients can remotely manage their servers.

To access it, simply click on 'Console' .

noVNC consoloe is a browser based VNC client. It was implemented using HTML5 Canvas and WebSockets.


Your customers can also create a backup of VPS. To do so, press the 'Backups' button.

Note: Backups are available only if the 'Use Volumes' option in 'Module Settings' is disabled.

Now, type in the backup name and click on 'Backup Now' .
To restore VPS from backup, simply press the 'Restore' button next to it.

SSH Keys

Due to a limitation in WHMCS product creation process, OVH Public Cloud For WHMCS generates a SSH key pair automatically.

The public SSH key is automatically implemented into a VM while the private key can be downloaded from the client area.
In order to download Unix private SSH key press 'Download Private Key'/
You can easily convert your private Unix key(.rsa) to private PuTTY key(.ppk) using 'PuTTYgen'.

Public SSH key on the other hand, can be downloaded as many times as your client will need it.

Press 'Download Public Key' as shown on the following screen to save it on your disk.


Network Configuration Cases

OVH Public Cloud For WHMCS allows you to set up two types of network.

The first one is the network without a floating IP address.
To set up this type of network, choose 'Public' as 'Fixed Network' and 'Disabled' as 'Floating Network' in 'Module Settings'.
On the following screen you can view an exemplary topology of such network.

The second type of network is the network with a floating IP address.

Select 'Shared Network' as 'Fixed Network' and 'Public' as 'Floating Network' in 'Module Settings'.


Configurable Options

In case standard configuration does not suit your needs, you can adjust it through configurable options.

To do so, go to 'Setup' 'Products/Services' 'Configurable Option' and press the edit button next to a configurable option used by your product.
Its name is 'Configurable options for your_product_name'.

Here you can view the products, a given configurable option group is assigned to.

Now we will show you how to edit options. Let's say that you want to add an option to order VPS with 5 IP addresses allowed..
To do so, edit 'ipAddresses|IP Addresses' by pressing the edit button as shown on the screen below.

You should see a popup window, make sure that your browser does not block it.

To add a new option, enter it in the text box under all other options. If you want to replace it with an option you currently have, simply edit its text box.
Next, press 'Save Changes'.



1. Due to the fact that some requests may take time to be completed, we implemented 'Scheduled Tasks'.

Tasks visible at 'Scheduled Tasks' are subsequently performed by regular cron jobs.
The full list of tasks supported by 'Scheduled Tasks' includes: create, terminate, change package, remove IP address and remove backup.

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.
2. In case of persisting connection problems, please make sure you have the following ports open:
35357, 8774, 9292, 5000, 8777, 8776, 9696
3. OVH Public Cloud For WHMCS module does not support dedicated servers.
4. The module's primary functionality refers to the OVH devices which benefit directly from the OpenStack structure, however they cannot be used interchangeably with OpenStack itself.
WHMCS Modules
WHMCS Translations
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
OVH Public Cloud For WHMCS