WHMCS Module

Overview

Softaculous Virtualizor supports the remote creation of Virtual Machines / VPS. 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 really easy. You can create, delete, or suspend a VPS with this module.

The endusers can also manage their VPS through the WHMCS(Old UI) interface without actually logging into Virtualizor.

Note: This module (version 2) requires Virtualizor 2.8.0+ on the master.
The existing plans created on "WHMCS Module 1" will be backward compatible. For any VM that is created from WHMCS module, we recommend that to do not make any changes from the Virtualizor Panel. It will affect the integrity. Like adding multiple disks from the Virtualizor panel.

Compatible with WHMCS 8

Download

Download the Virtualizor WHMCS module (2.8.0) from HERE. (Last updated: 9th Sept, 2024)
Unzip it and upload the folder virtualizor (the folder itself), in your /path/to/whmcs/modules/servers/ Directory.
Please make sure that the upload was done properly and following folder exists :
/path/to/whmcs/modules/servers/virtualizor

Ports

Virtualizor uses ports from 4081 - 4085. If there is any firewall restricting this, you will need to allow these ports.

Features

VPS Information View in WHMCS Client Panel

VPS information View in WHMCS Admin Panel

Servers Key

Virtualizor generates a Unique Key and Key Pass when its installed on the server.
You will need the servers Key and Key Pass to add the server to WHMCS.
This information can be found from the Virtualizor Admin Panel -> Configuration -> Server Info

Adding Server to WHMCS

Note : Only Master server needs to be added on WHMCS.

To add the Virtualizor Server to WHMCS login to WHMCS Admin Panel Then go to WHMCS Admin Panel -> Setup -> Servers -> Add New Server
Fill the form as shown in the below images :

Creating a Product

Now, you will need to create a product.

Product

To do so go to WHMCS Admin Panel -> Setup -> Products/Services -> Create a New Product
Fill in the details as per the following image and specify the Products Name of your choice .

Module Settings

The WHMCS module has been updated to a new and simple version. It includes selecting the module name and setting up the fields as shown in the image below:

The Fields are:

• Virtualizor Server : Select the type of virtualizor server where you want to create your VPS.
• Type : Select the type of Virtualization being used.
• Select Plan : Select plan which you have created on virtualizor panel.
• Default Node/Group: Select the Server or node Group or any individual server. (NOTE : [G] denotes the group)

1. Select the Virtualizor server and then type of virtualization.
2. After selecting above two fields you have to click on Save Changes. Once the changes are saved, you will get the list of Plans. Until then Plans will be empty.
3. Select Virtualizor Plan (as created on your Virtualizor Master) and Default Node/Group.
   If you haven't created a Virtualizor Plan you will need to do so as following :

If you want to know more about adding a Plan click on this link Add a Plan

Custom Fields

Now Click on the Custom Fields Tab and fill in the form as per the following image

Just for your information the vpsid is the VPS ID as per the Virtualizor Database and needs to be stored for any future action like Terminate, Suspend, etc. Please fill it as per the above Image.

The OS field is the List of Operating System Templates on your server. Virtualizor provides templates to its users. Its a COMMA seperated value. This will allow the USER to choose the OS when he is signing up for the VPS. Also the list should be the names as listed in the Virtualizor Admin Panel -> Media -> OS Templates. Again, use the Name and not Filename as seen in the Virtualizor Admin.

The ISO field is to display list of ISO images to your clients. This field will allow users to choose the ISO image while signing up for any plan.

NOTE: While creating a VM Operating System MUST be provided for VM provisioning. So if you want to use Configurable Option for OS selection then you can remove the above custom field of "OS". Either of them MUST be present while placing order.

The node_ram_select field is an optional field. This field is useful when you want to choose servers (where your VPSs are going to be created) based on FREE RAM among your servers.

NOTE : Please add 'none' value when you add ISO and OS field. (Please refer the screenshot above)

NOTE : ISO option is not supported for OpenVZ and XEN-PV 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.

Following are the Configurable Options available in Virtualizor WHMCS module.

• Number of IPs
• Number of IPv6 Address
• Number of IPv6 Subnet
• Number of Internal IP Address
• Space
• RAM
• Bandwidth
• CPU Cores
• Network Speed
• CPU Percent
• Operating System
• Control Panel
• Managed by Admin
• Server - Slave Server's ID in Virtualizor. Set the same values as you would with the Slave Server described in Module Settings
• Region - Server Groups ID in Virtualizor. Set the same values as you would with the Server Group described in Module Settings

Additional Params : (Since 3.0.0+)

If these parameters are added as configurable option then VM(s) will be created with Plan Value + Configurable option value.
For e.g. If VPS plan has space defined as 5GB and additional_space configurable option is added as 20GB, and while ordering if this 20GB option is selected, then VM will be created with 25GB.
You can use the following parameters as additional param :

• additional_ram
• additional_space
• additional_bandwidth
• additional_cores
• additional_num_ips
• additional_num_ips_int
• additional_num_ips6
• additional_num_ips6_subnet

Other Advance Configurable Options

• hostname
• swapram
• virtio
• nic_type
• vif_type
• osreinstall_limit
• kvm_cache
• io_mode
• iso - ISO
• sec_iso - Secondary ISO
• mgs - Media Groups (NOTE : Put ID of the Media Group for this configurable option.
  You can get it from Virtualizor Admin panel-> Media -> Media Groups )
• stid - Storage to use
• ippoolid - IP Pool ID, for selecting IPs from particular IP Pool. (NOTE: You can specify multiple IP Pool Ids with comma separated)
• dnsplid - Setting DNS Plans
• Total I/Os per sec
• Read Mega Bytes/s
• Write Mega Bytes/s
• topology_sockets
• topology_cores
• topology_threads
• rdp
• bpid - This is for assigning backup plans to the VPS. You can get the backup plan ID from Admin Panel -> List Backup Plans.
• upload_speed - This option will help in upgrading/downgrading upload speed.
• recipe - This is for recipe which you want to get executed when VM is provisioned. You can get the recipe ID from Admin panel -> Recipes -> List Recipes. You can set the recipe as 1|Recipe Name
• ha - This option will help to create vps with HA enabled, assuming HA nodes are already configured.
  Value of this option should be 1 to enable HA for the vps.
  
• disable_password - This option will disable the root login for the newly created VMs. User will not be able to login using root password. (Since 3.1.2.4)
  
• ssh_options - If you want the users to login using private keys then you can use this option. Its values MUST be "generate_keys" to enable key base login for the newly created VMs. (Since 3.1.2.4)
• disable_guest_agent - Since 3.1.9.1, guest agent is enabled by default. If you want to disable it then you can use this option and set its value to 1 to disable it.
  
  

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.

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

Space : Add a configurable option for Space (It will be in GIGABYTES e.g 10 = 10GB) as below:

RAM :  Add a configurable option for RAM (It will be in MEGABYTES e.g. 512 = 512MB) as below:

Bandwidth : Add a configurable option for Bandwidth (It will be in GIGABYTES e.g. 10 = 10GB) as below:

CPU Cores : Add a configurable option for CPU Cores as below:

Network Speed : Add a configurable option for Network Speed (It will be in KILOBYTES e.g. 128 = 128KB/s) as below:

CPU Percent : Add a configurable option for CPU Percent as below:

Operating System : Add a configurable option for Operating System as below:

Storage Type : Add a configurable option for stid as below:

Virtio: Add a configurable option for Virtio as below:

Virtual Network Interface Type :  Similarly, add a configurable option for the Virtual Network Interface Type as below

default will be taken as Realtek 8139
e1000 is for Intel e1000 and if you set none then Virtio will be set.

Virtual Network Interface Emulation Type : Similarly, add a configurable option for the Virtual Network Interface Emulation Type as below:

OS Re-Install Limit : Similarly, add a configurable option for the OS Re-Install Limit as below:

KVM Cache : Similarly, add a configurable option for the KVM Cache as below:

I/O Policy : Similarly, add a configurable option for the I/O Policy as below:

DNS Plans : Similarly, add a configuration option for the DNS Plan as below:

VNC Console Keymap : Similarly, add a configurable option for the VNC Console Keymap as below:

Managed by Admin : admin_managed needs to be set as option name with 1 or 0 as the values shown below :

BuycPanel Licensing : Control Panel Configurable option for BuycPanel licensing :

You can assign cPanel installation for your Virtualizor VPS. The above option allows you to display a dropdown of control panel list which can be selected by the user and the license will be automatically activated by BuycPanel.

NOTE : You must enter the BuycPanel Login and API Key in virtualizor_conf.php file.

Control Panel : Control Panel as an individual Configurable Option :

The above will just have the control panel installed in the newly created VPS. It will not license the Control Panel. Please do not confuse with the BuycPanel option described above.

NOTE : The configurable option values should be exactly as mentioned in each configurable option above, if you want to add a description to the Configurable option then you need to add a "|" (pipe) after the value followed by the description. For example for a configurable option of disk space if you want to add a description like GB or TB it should look like "10 | 10 GB".

Custom Code Integration

If you want to add your custom code as a hook to execute after order processing, you can do it by putting your code custom.php. You have to put your code in virtualizor module directory (i.e. /path/to/whmcs/modules/servers/virtualizor/custom.php)
While handling the error please use the variable $custom_error

Callback

The callback feature (Admin Panel -> Configuration -> Master Settings -> Callback Settings) allows Virtualizor to notify WHMCS when a specific action is performed.

NOTE : This functionality requires Virtualizor version 2.8.5

The following callback actions are supported for VPS(s):

• Suspend - It will set VM as suspended in WHMCS.
• Unsuspend - It will set VM as unsuspende in WHMCS.
• Terminate - It will set VM as Terminated in WHMCS.
• Change Hostname - It will change the Hostname in WHMCS for VM.
• Change IP(s) - It will change the IPs (Assigned IPs as well) in WHMCS for VM.
• Enable login for WHMCS User - It will enable the user to login with same credential WHMCS credential in Virtualizor cloud panel login.
• Enable WHMCS Invoicing - This will create the Cloud user invoice in WHMCS.

1) For callbacks to work edit the callback.php script within the /path/to/WHMCS/modules/servers/virtualizor/ folder on your WHMCS installation.
2) Edit the script and set the 3 required security variables:

// Any Admin User in WHMCS
   $admin_user = "admin";

   // The Hash Key in WHMCS (As shown in Virtualizor Admin Panel -> Configuration -> Master Settings -> Callback Settings)
   $hash_key = array();

   // The Virtualizor Master IP
   $connection_ip = array();

3) For more security rename the script to a filename of your choice.

Now you can add multiple servers, for example:

$hash_key = array( 'KEY1', 'KEY2', ..... , 'KEYn');
$connection_ip = array('IP1', 'IP2' , ..... ,'IPn');

NOTE: If you are enabling an option Enable login for WHMCS User, you will need to configure the file named as perform_actions.php same as callback.php
Please do not change the filename to any other file name. It must be perform_actions.php only.