WHMCS Module
Contents |
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, suspend a VPS with this module.
Download
Download the Virtualizor WHMCS module from HERE.
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 the following folder exists :
/path/to/whmcs/modules/servers/virtualizor
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
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
Now proceed to the Module Settings. Click on the Module Settings Tab and choose the Module Name Virtualizor. A list of fields will load which will be the settings for the new product. A sample configuration is shown in the below image.
The fields are self explanatory, but the following is a detailed explanation :
- Type : The Virtualization type of the server you added.
- Disk Space : The amount of disk space that the VPS will be allowed to use.
- Inodes : This is for OpenVZ VPS only. The number of inodes for the new VPS.
- Guaranteed RAM : The amount of RAM to be allocated to the VPS
- Burstable RAM : The amount of Burstable RAM allowed to the VPS in MBs. This is only for OpenVZ
- SWAP RAM : Swap Ram for the VPS. This is for Xen and KVM VPSs
- Bandwidth : The allowed bandwidth to the VPS in GBs
- CPU Units : Amount of CPU allowed to the VPS (Weightage). It varies as per the Virtualization type. OpenVZ Recommended Value : 1000, Xen Recommended Value : 256
- CPU Cores : Number of CPU Cores
- CPU % : This is also just for OpenVZ. The MAX CPU in % allowed to the VPS.
- I/0 Priority : Just for OpenVZ. Ranges from 0-7
- VNC : Whether to enable VNC or not for the VPS. Applies to Xen and KVM
- IPs : The number of IPs to be allocated to this VPS. Please remember to create the IP Pool on the server.
- Network Speed : This is in Kilo Bytes. Maximum allowed network speed for the VPS.
- Slave Server : Name of the Slave server that the VPS must be created on. You can also specify auto as the name of the Slave server. If you specify auto then the WHMCS module will AUTO select the server based on the Virtualization tecnology. But please take note that when you set auto as the name of the server the Master server will be excluded from the list of available servers.
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.
Configurable Options [OPTIONAL]
You can choose to exclude one or more of the options below if you do not need 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.
Add a configurable option for Virtio as below:
Similarly, add a configurable option for the Virtual Network Interface Type as below:
Similarly, add a configurable option for the Virtual Network Interface Emulation Type as below:
Similarly, add a configurable option for the OS Re-Install Limit as below:
Similarly, add a configurable option for the KVM Cache as below:
Similarly, add a configurable option for the I/O Policy as below:
Firewall Port
Please make sure, that the whmcs server , master server and the slave servers have ports 4082,4083,4084 and 4085 opened.
WHMCS Virtualizor Clients Screenshot
Our WHMCS Module is the best. We offer most of the features from withing WHMCS itself. Below is a screenshot.
Support
If you need any assistance then please contact Softaculous Virtualizor Support. Please send us a screenshot of the Module Settings and the Custom Fields you added to the Product.
