How to setup the WHMCS VPS Reseller Module – Old Platform

This article refers to the old WHMCS module. Only for legacy resellers.

Overview # supports Reseller accounts. The Reseller accounts can create multiple VMs based on the resources assigned to their account. This guide is intended for Resellers who wish to sell VMs via WHMCS. WHMCS can be configured to create the VPS as soon as you accept the Order (Automatically or Manually). We provide a module for WHMCS to enable you to do so. Setting it up is relatively easy and you can create, delete and suspend a VPS using this module.

Download #

You can download the Virtualizor WHMCS Cloud module HERE (October 29, 2017). Unzip it and upload to the whmcs folder virtualizor_cloud (the folder itself), in your :/path/to/whmcs/modules/servers/ Directory.

Please ensure that the upload was completed correctly and that the following folder exists:


API Key # can generate a unique Key and Password to make API calls to the Control Panel. You will need the API Key and Password to add the server to WHMCS. This information can be found on the HOSTAFRICA Cloud Panel API Credentials. Login details for the control Panel will be sent to you per email once the registration process has been completed.


Adding the server to WHMCS #

To add the HOSTAFRICA server to WHMCS login to WHMCS Admin Panel:

Go to WHMCS Admin Panel -> Setup -> Servers -> Add New Server and complete the form as shown below:

WHMCS cloud Add Server1.png

The servers details are as follows:

IP Address:
Username: see last step - API Key
Password: see last step - API Password
Secure: Tick the box

Creating a product #

The next step is to create the products. Go to the WHMCS Admin Panel -> Setup -> Products/Services -> Create a New Product. Complete the details as per the following image and specify the Product Name of your choice.

WHMCS cloud Create Product.png

Module Settings #

Now proceed to the Module Settings.

Click on the Module Settings Tab and choose the Module Name Virtualizor_cloud.

A list of fields will load which will be the settings for the new product.

Setup the following values:

Type: “KVM” (for Windows server plans) or “Virtuozzo OpenVZ” (for Linux server plans)
Disk Space: The amount of disk space that the VPS will be allowed to use. (see our plans)
Guaranteed RAM: The amount of RAM to be allocated to the VPS (see our plans)
Burstable RAM: Only valid for OpenVZ – always 512
SWAP RAM: Only valid for KVM – always 1024
Bandwidth: The allowed bandwidth to the VPS in GBs (see our plans)
CPU Cores: Number of CPU Cores (see our plans)
VNC: Yes
IPs: The number of IPs to be allocated to this VPS – always 1
IPv6 Subnets: Leave empty
IPv6: Leave empty
Region: “KVM (Windows)” for KVM and “OpenVZ7 (Linux)” for Virtuozzo OpenVZ

WHMCS cloud Module Settings.png

Custom Fields #

Now Click on the Custom Fields Tab and complete the following additional fields:

OS #

- Field Type: Drop down - Description: OS - Select Options: Paste the following list in the field
  • Windows VMs: win2012_r2.img, win2016.img
  • Linux VMs: ubuntu-14.04-x86_64, ubuntu-16.04-x86_64, centos-6-x86_64, centos-7-x86_64, debian-7.6-x86_64, debian-8.0-x86_64, fedora-23-x86_64
- Required field, Show on Order Form

vpsid #

- Field Type: TextBox - Description: vpsid - Admin only

iso #

Currently, we don't offer ISOs. Do not set up the option ISO

noemail #

- Field Type: TextBox - Description: Do not send an email to the client - Admin only

Modsettings whmcs.gif

Please note:

The vpsid is the VPS ID as per the Control Panel Database and needs to be stored for any future action like Terminate, Suspend, etc.

The OS field is the List of Operating System Templates on your server. HOSTAFRICA provides templates to its users. It’s a COMMA separated value. This will allow the USER to choose the OS when he is signing up for the VPS.

Configurable Options [OPTIONAL] #

You can add the Configurable Options as per your requirements or exclude one or more of the options below if you do not need it.

Note: The order of preference for selection of Configurable Options is first i.e. If a Product/Service has (lets say) Ram defined as 512 MB and you have also created a Configurable Option with variable Ram options, then the users chosen Ram value from configurable options will be used and not the RAM value in Product/Service.

The following are the Configurable Options available in HOSTAFRICA WHMCS module.

  • Number of IPs
  • Bandwidth

To add, go to WHMCS Admin Panel -> Setup -> Products/Services -> Configurable Options. Then click on Create a new Group


Now, click on the Add New Configurable Option button. A new window will open.

Add a configurable option for the Number of IPs as below:


Add a configurable option for Bandwidth as below:

Other options are possible but should only be used when a Ressler Pool has been bought. Further information can be found on the Virtualizor wiki.

Changing VPS or mask #

When ordering a VPS WHMCS would ask for a nameserver. This is not necessary with our VPS. Therefore this option should be hided in order not to confuse the customer when ordering the VPS.

This file has to be altered: /folderofyourWHMCS/templates/orderforms/cart/configureproduct.tpl

Please follow the instructions on the WHMCS website

Firewall Port #

Please make sure, that the whmcs server has ports 4082,4083,4084 and 4085 TCP and UDP opened (incoming and outgoing).

IP Whitelisting #

In order to enable WHMCS to connect to the CLOUD/VPS Cloud backend, your WHMCS IP has to be whitelisted. Please send an email with your WHMCS IP address to

Powered by BetterDocs