WHMCS Reseller Product Module
From SolusVM
Contents |
Overview
This module is an addon for the popular WHMCS billing solution. The module allows you to create a range of reseller resource products allowing orders to be auto-provisoned instantly on payment.
The module supports SSL mode as default with or without a valid certificate on the SolusVM master.
This is not a VPS provisioning module. The provisioning module is here
Installation
Requirements
- SolusVM Master
- WHMCS Version 4.4.2 or higher
- IonCube Loaders
Download
Version 1.1 (2011/05/20)
- Added support for Media Groups
Download: here
Version 1.0 (2011/05/06)
Download: here
Upload
Once you have downloaded the <module>.zip file to your computer you need to extract the files using your favorite zip extraction program.
Now you should be presented with a folder called modules. You need to upload this folder to the root of your WHMCS installation.
Configuration
Creating API Users in SolusVM
Skip this step if you already use the vps creation module
To create an API user in SolusVM click Configuration >> API Users >> Create API User.
You will be presented with some fields like the image below:
The ID & Key are auto generated and cannot be changed, all you need to add is the IP address of your WHMCS installation and set it to active.
Adding a Master to WHMCS
If you already use the vps creation module you STILL need to setup an identical server but assign it to the new module
Before you can configure your products to use the SolusVM module you need to add a master server to WHMCS.
In WHMCS select Setup >> Servers >> Add new server
Fill in the form as illustrated in the images below.
- Username field should contain the API Id
- Password field should contain the API Key
Don't forget to tick Secure for SSL connections (You should use this when possible)
Now click Save Changes to add the master to WHMCS.
Creating a Product
In WHMCS select Setup >> Products/Services
Now click Create a New Product and fill in the form as illustrated in the image below. We suggest you use the "Other" product type.
Click Continue.
Now fill in all your product details. After that you need to click on Module Setting and select Solusvm from the dropdown menu.
Once the module has loaded you will be presented with the follow options as illustrated in the image below.
Options Explained
- Master Server This is the master server you just created.
- Username Prefix The prefix you want to give to the resellers username when it's created in SolusVM.
- Max VPS The maximum amount of virtual servers the reseller can build.
- Max Users The maximum amount of users the reseller can create.
- Max Diskspace The maximum amount of memory the reseller can use.
- Max Memory The maximum amount of diskspace the reseller can use.
- Max Burst/Swap The maximum amount of Burst Memory for OpenVZ or Swap Space for Xen PV the reseller can use.
- Max Bandwidth The maximum amount of bandwidth the reseller can assign to virtual servers.
- Max IPv4 The maximum amount of IPv4 addresses the reseller can use.
- Max IPv6 The maximum amount of IPv6 addresses the reseller can use.
- OpenVZ Allow the reseller to create OpenVZ virtual servers.
- Xen PV Allow the reseller to create Xen PV virtual servers.
- Xen HVM Allow the reseller to create Xen HVM virtual servers.
- KVM Allow the reseller to create KVM virtual servers.
- Node Groups A comma seperated list of node group id's the reseller can use.
- Client Username Prefix The prefix you want to give to the username of users the reseller creates. This is advised to prevent clashes with the provisioning module.
- Media Groups A comma seperated list of media group id's the reseller can use. version 1.1 or higher
Click "Save Changes" once you have edited the options.
Thats it! All setup!
What the Automation Function Do
- Module Create This will create the reseller within SolusVM and configure the resellers quotas.
- Module Terminate This will only delete the reseller from SolusVM if the reseller has no users or virtual servers assigned to it.
- Module Suspend This will not suspend the reseller or virtual servers assigned to it.
- Module Unsuspend This will not unsuspend the reseller.
- Module Change Package This will upgrade the resellers quotas to the new Product/Service settings.
