Personal tools
Namespaces

Variants
Actions

SolusVM Extended VPS For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About SolusVM Extended VPS For WHMCS)
Line 10: Line 10:
 
|}
 
|}
 
*'''Features Included:'''
 
*'''Features Included:'''
 +
{|<meta name="keywords" content="solusvm extended vps for whmcs, solusvm extended vps configuration, solusvm extended vps management, solusvm extended vps installation, solusvm extended vps common problems, about solusvm extended vps, solusvm extended vps documentation, solusvm extended vps faq, solusvm extended vps help, solusvm extended vps guide, modulesgarden solusvm extended vps, solusvm extended vps wiki, solusvm extended vps tutorial, solusvm extended vps tips, solusvm extended vps module wiki"></meta>
 +
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The SolusVM Extended VPS For WHMCS Module."></meta>
 +
 +
=About [http://www.modulesgarden.com/products/whmcs/solusvm_extended_vps/features SolusVM Extended VPS For WHMCS] =
 +
<span style="color:red"><strong>Wiki might contain module features from version 1.2 which will be released soon!</strong></span>
 
{|
 
{|
 +
|style="padding: 10px 0px 10px 0px;"|'''SolusVM Extended VPS For WHMCS''' allows you to automatically provision virtual servers to your clients.<br />
 +
Owing to well-thought module configuration, you will be able to quickly and capably set up ready products in WHMCS and offer them to your customers.<br />
 +
Module lets your clients to conveniently manage virtual servers from your own WHMCS client area. Everything in an easy and enjoyable way.
 +
|}
 +
*'''Features Included:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Provisioning Module
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Virtual Server Management From The Client Area
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Complete Product Management From The Admin Area
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Simple Installation
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Dynamic Server Resources Setup With Configurable Options
 +
|}
 +
*'''Provisioning Module Functionality:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Create Server
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Terminate Server
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Suspend/Unsuspend Server
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Rebuild Server
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Upgrade/Downgrade Server And Resources
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Boot/Reboot/Shutdown Server
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Enable TUN/TAP And PAE
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Change Password: Root, Client, Console And VNC
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Mount/Unmount ISO
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Change Boot Order
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Get Server Status
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Graphs: Traffic, Load, Memory
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ SSH Console
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ VNC Console
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Send Email Templates After Server Creation Based On Type
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Two Layouts
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Possibility To Turn Off Root Password Storing In The System Database
 +
|}
 +
*'''Additional Functionality:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Combined With DNS Manager For WHMCS - Supports PowerDNS [http://www.modulesgarden.com/products/whmcs/dns_manager/features (read more)]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Combined With Advanced Billing For WHMCS Module - Supports Server Resource Usage Billing [http://www.modulesgarden.com/products/whmcs/advanced_billing/features (read more)]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and Later
 +
|}
 +
 +
=Installation and Configuration=
 +
{|
 +
|style="padding: 10px 0px 0px 0px;"|'''In this tutorial we will show you how to successfully install SolusVM Extended VPS For WHMCS.'''<br />
 +
We will guide you step by step through the whole installation and configuration process.
 +
|}
 +
{|
 +
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download SolusVM Extended VPS For WHMCS.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Files in your WHMCS directory should look like this.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 15px;"|'''3. When you install SolusVM Extended VPS for the first time you have to rename '' 'license_RENAME.php' '' file.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|File is located at '' 'modules/servers/solusvmExtendedCloud/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 15px;"|'''4. In order to configure your license key you have to edit a previously renamed '' 'license.php' '' file.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Enter your licence key between quotation marks as presented on the following screen. You can find your license key at your client area → '' 'My Products' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''5. Now we will show you how to configure a new product.'''<br />
 +
First, log in to your SolusVM admin area, go to '' 'CONFIGURATION' '' → '' 'API Access' '' and add API User.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''6. Enter your current IP and once again click on '' 'Add API User' '' button.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV6.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 15px;"|'''7. Now log in to your WHMCS admin area. Press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' ''.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Afterwards press '' 'Add New Server' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:CP8.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''8. Enter your server name and IP address.'''<br />
 +
Next, enter your API User ID into '' 'Username' '' field and your API User Key into '' 'Password' '' field. Choose '' 'SolusvmExtendedVPS' '' from a dropdown menu and press '' 'Save Changes' ''.<br />
 +
Here you can also provide other server details like nameservers or maximum number of accounts.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV7.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 15px;"|'''9. After you configure your server correctly, you will see a following screen.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Test your connection through pressing on '' 'Test Connection' ''. Now you need to create a new group for your server. For that purpose press '' 'Create New Group' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV8.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''10. Enter name, click on your previously created server, press '' 'Add' '' then press '' 'Save Changes' ''.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV9.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 15px;"|'''11. In order to create and configure product click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|If you don't have a product group, click on '' 'Create a New Group' ''. If you do, simply go to step 13.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:CP12.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''12. Enter product group name, choose order form template and press '' 'Save Changes' ''.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV10.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 15px;"|'''13. When you have a product group, you can create your product and assign it with SolusVM Extended VPS. If you already have a product, go to step 15.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|To create a product click on '' 'Create a New Product' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV10.5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''14. Afterwards choose your product type and product group from a dropdown menus, enter your product name and press '' 'Continue' ''.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV11.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''15. Now go to '' 'Module Settings' '' section, choose both '' 'SolusvmExtendedVPS' '' and your previously created server group from a dropdown menus.'''<br />
 +
After you press '' 'Save Changes' '', all the configuration options will load below.<br />
 +
Generate configurable options and custom fields as shown on the following screen.<br />
 +
'''Keep in mind that without right custom fields, module will not work correctly.'''<br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV12.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''16. Configuration of the product is divided into two sections: '' 'Features Setup' '' and '' 'Products Configuration' ''.<br />
 +
In Features Setup you can select the functionalities you want to offer your customers.<br />
 +
In Product Configuration you need to determine the details of connection between WHMCS product and your SolusVM server.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV12.5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''17. Custom fields generated by our module should contain 4 fields: '' 'vserverid' '', '' 'nodeid' '', '' 'internalip' '' and '' 'clientpassword' ''.'''<br />
 +
With configurable options you can allow your customers to place orders perfectly tailored to their needs. Our module offers the following configurable options:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV13.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|'''You have just finished the installation and configuration of the module. From this moment your customers can start to place orders!
 +
|}
 +
 +
=Management=
 +
{|
 +
|style="padding: 10px 0px 30px 0px;"|'''SolusVM Extended VPS For WHMCS offers very intuitive management of virtual servers.'''
 +
|}
 +
==Interface==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Now let's check the interface of the module in your WHMCS client area. As you can see, everything your customers need is in one place.<br />
 +
Note that the screen below presents the module, right after creation of the product. Charts and graphs will fill with data after use of server resources.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV14.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|The above screen presents a '' 'Classic Design' '' introduced in version 1.2. A following screen shows basic design.<br />
 +
You can switch between designs by ticking '' 'Client Area Classic Design' '' in '' 'Module Settings' ''.<br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV14.5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|You can monitor and manage each product from your WHMCS admin area.<br />
 +
Note that the screen below presents the module, right after creation of the product. Charts and graphs will fill with data after use of server resources.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SV15.png]]
 +
|}
 +
 +
==Management of Server==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Module allows your customers to easily boot (1), reboot (2), shutdown (3) and delete (4) their servers through pressing specified button.<br />
 +
Product allows also to quickly change hostname (5), root password (6), boot order (7) and enable/disable PAE (8).<br />
 +
Dependant on the chosen virtualization type, module allows your customers to also enable/disable TUN/TAP.<br />
 +
Dependant on the chosen virtualization type, module displays Traffic, Load and Memory graphs.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV16.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|One of the most interesting functionality is SSH console where your clients can remotely manage server. To access it, simply press on the '' 'Console' '' button.<br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV17.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Rebuild feature allows to change template from available templates list. To rebuild your server click on '' 'Rebuild' '' button, choose template and click on the blue '' 'Rebuild' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV19.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Customers can quickly access the VPS Control Panel with just one click to '' 'Control Panel' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SV18.png]]
 +
|}
 +
 +
==Management of DNS==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|When you combine SolusVM Extended VPS For WHMCS With [http://www.docs.modulesgarden.com/DNS_Manager_For_WHMCS DNS Manager For WHMCS], your clients will be able to manage PowerDNS from the client area.<br />
 +
DNS Manager For WHMCS will allow your customers to manage DNS zones, records and ReverseDNS.<br />
 +
To connect both modules, go to '' 'Processing' '' section of DNS Manager, configure the module, tick '' 'With Products' '' and choose SolusVM Extended VPS product. 
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV26.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Afterwards, buttons '' 'Manage DNS' '' and '' 'Manage Reverse DNS' '' will appear in the client area as shown on the screen below.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV22.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Dependant on your previously chosen settings, your customers will be able to add, edit and remove DNS zones and records.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV24.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Module will also allow your customers to add, edit and remove Reverse DNS zones and records.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SV25.png]]
 +
|}
 +
 +
==Management of Billing==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|When you combine SolusVM Extended VPS For WHMCS With [http://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS Advanced Billing For WHMCS], you will be able to set up additional billing options.<br />
 +
Module allows you to charge your customers based on the server resources used by them.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SV23.png]]
 +
|}
 +
 +
==Management of Email Templates==
 +
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV27.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV28.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|
 +
|}
 +
 +
==Update of Products==
 +
{|
 +
|style="padding: 10px 0px 25px 15px;"|Our module is entirely compatible with SolusVM Pro module and you can easily upgrade your existing products without losing your settings.<br />
 +
Firstly, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' → '' 'Module Settings' '' of your product and switch '' 'Module Name' '' from '' 'Solusvmpro' '' to '' 'SolusvmExtendedVPS' ''.<br />
 +
Afterwards go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and switch your server type from '' 'Solusvmpro' '' to '' 'SolusvmExtendedVPS' ''.<br />
 +
Once again go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' '' → '' 'Module Settings' '' of your product and make sure that '' 'Server Group' '' is set up correctly.<br />
 +
In the last step generate default configurable options and custom fields through clickng on '' 'Generate default' '' buttons.
 +
Your SolusVM Extended VPS product is ready to use!
 +
|}
 +
 +
==Debug Mode==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|SolusVM Extended VPS is very complex module. Therefore many things might go wrong.<br />
 +
To help you quickly solve various problems usually connected with WHMCS product/server configuration and SolusVM server configuration, we created a '' 'Debug Mode' ''.<br />
 +
To enable it, go to '' 'Module Settings' '' of your product and tick '' 'Debug Mode' '' as shown on the screen below.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV20.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Afterwards go to '' 'Utilities' '' → '' 'Logs' '' → '' 'Module Log' '' and click on '' 'Disable Debug Logging' '' in order to enable it.<br />
 +
From that moment, each action performed by module will be recorded in the log.<br />
 +
In that way, you can easily check whether module correctly fetches the information about virtual servers, nodes, templates, plans etc.<br />
 +
If it doesn't, that indicates a problem with WHMCS product/server configuration or problem with your SolusVM server.<br />
 +
The following screen presents exemplary module log.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV21.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|Remember to turn off Debug Mode after you fix the problem.
 +
|}
 +
 +
=Tips=
 +
{|
 +
|style="padding: 10px 0px 5px 15px;"|1. We made every effort to make our module as easy to install, configure and use, as possible. Therefore we paid special attention to displayed messages.<br />
 +
Read carefully each message, follow the instructions and you shall have no problems with using the module.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|2. Operations performed on the virtual servers are not executed immediately. Give your SolusVM server some time for processing the request and execution of operation.
 +
|}
 +
 +
=Common Problems=
 +
{|
 +
|style="padding: 10px 0px 0px 15px;"|1. The vast majority of problems are connected with misconfigured SolusVM server or misconfigured servers/products in your WHMCS.<br />
 +
First, make sure that your SolusVM server has properly configured virtual servers, nodes, node groups, templates, plans and API access.<br />
 +
'''In most cases, appropriate SolusVM server configuration guarantees correct operation of the module.'''<br />
 +
Afterwards check your WHMCS server connection and products settings. If you are certain that everything is correct, use our [[#Debug Mode|Debug Mode]].
 +
|}
 +
{|
 +
|style="padding: 5px 0px 30px 15px;"|2. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
 +
|}
 +
 
|style="padding: 10px 0px 0px 30px;"|✔ Provisioning Module
 
|style="padding: 10px 0px 0px 30px;"|✔ Provisioning Module
 
|}
 
|}

Revision as of 14:46, 18 July 2013

Contents

About SolusVM Extended VPS For WHMCS

Wiki might contain module features from version 1.2 which will be released soon!

SolusVM Extended VPS For WHMCS allows you to automatically provision virtual servers to your clients.

Owing to well-thought module configuration, you will be able to quickly and capably set up ready products in WHMCS and offer them to your customers.
Module lets your clients to conveniently manage virtual servers from your own WHMCS client area. Everything in an easy and enjoyable way.

  • Features Included:

About SolusVM Extended VPS For WHMCS

Wiki might contain module features from version 1.2 which will be released soon!

SolusVM Extended VPS For WHMCS allows you to automatically provision virtual servers to your clients.

Owing to well-thought module configuration, you will be able to quickly and capably set up ready products in WHMCS and offer them to your customers.
Module lets your clients to conveniently manage virtual servers from your own WHMCS client area. Everything in an easy and enjoyable way.

  • Features Included:
✔ Provisioning Module
✔ Virtual Server Management From The Client Area
✔ Complete Product Management From The Admin Area
✔ Simple Installation
✔ Dynamic Server Resources Setup With Configurable Options
  • Provisioning Module Functionality:
✔ Create Server
✔ Terminate Server
✔ Suspend/Unsuspend Server
✔ Rebuild Server
✔ Upgrade/Downgrade Server And Resources
✔ Boot/Reboot/Shutdown Server
✔ Enable TUN/TAP And PAE
✔ Change Password: Root, Client, Console And VNC
✔ Mount/Unmount ISO
✔ Change Boot Order
✔ Get Server Status
✔ Graphs: Traffic, Load, Memory
✔ SSH Console
✔ VNC Console
✔ Send Email Templates After Server Creation Based On Type
✔ Two Layouts
✔ Possibility To Turn Off Root Password Storing In The System Database
  • Additional Functionality:
✔ Combined With DNS Manager For WHMCS - Supports PowerDNS (read more)
✔ Combined With Advanced Billing For WHMCS Module - Supports Server Resource Usage Billing (read more)
✔ Multi-Language Support
✔ Supports WHMCS V5 and Later

Installation and Configuration

In this tutorial we will show you how to successfully install SolusVM Extended VPS For WHMCS.

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

1. Log in to your client area and download SolusVM Extended VPS For WHMCS.
SV1.png
2. Upload and extract the module into the main WHMCS directory.
Files in your WHMCS directory should look like this.
SV2.png
3. When you install SolusVM Extended VPS for the first time you have to rename 'license_RENAME.php' file.
File is located at 'modules/servers/solusvmExtendedCloud/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .
SV3.png
4. In order to configure your license key you have to edit a previously renamed 'license.php' file.
Enter your licence key between quotation marks as presented on the following screen. You can find your license key at your client area → 'My Products' .
SV4.png
5. Now we will show you how to configure a new product.

First, log in to your SolusVM admin area, go to 'CONFIGURATION' → 'API Access' and add API User.

SV5.png
6. Enter your current IP and once again click on 'Add API User' button.
SV6.png
7. Now log in to your WHMCS admin area. Press 'Setup' → 'Products/Services' → 'Servers' .
Afterwards press 'Add New Server' .
CP8.png
8. Enter your server name and IP address.

Next, enter your API User ID into 'Username' field and your API User Key into 'Password' field. Choose 'SolusvmExtendedVPS' from a dropdown menu and press 'Save Changes' .
Here you can also provide other server details like nameservers or maximum number of accounts.

SV7.png
9. After you configure your server correctly, you will see a following screen.
Test your connection through pressing on 'Test Connection' . Now you need to create a new group for your server. For that purpose press 'Create New Group' .
SV8.png
10. Enter name, click on your previously created server, press 'Add' then press 'Save Changes' .
SV9.png
11. In order to create and configure product click on 'Setup' → 'Products/Services' → 'Products/Services' .
If you don't have a product group, click on 'Create a New Group' . If you do, simply go to step 13.
CP12.png
12. Enter product group name, choose order form template and press 'Save Changes' .
SV10.png
13. When you have a product group, you can create your product and assign it with SolusVM Extended VPS. If you already have a product, go to step 15.
To create a product click on 'Create a New Product' .
SV10.5.png
14. Afterwards choose your product type and product group from a dropdown menus, enter your product name and press 'Continue' .
SV11.png
15. Now go to 'Module Settings' section, choose both 'SolusvmExtendedVPS' and your previously created server group from a dropdown menus.

After you press 'Save Changes' , all the configuration options will load below.
Generate configurable options and custom fields as shown on the following screen.
Keep in mind that without right custom fields, module will not work correctly.

SV12.png
16. Configuration of the product is divided into two sections: 'Features Setup' and 'Products Configuration' .

In Features Setup you can select the functionalities you want to offer your customers.
In Product Configuration you need to determine the details of connection between WHMCS product and your SolusVM server.

File:SV12.5.png
17. Custom fields generated by our module should contain 4 fields: 'vserverid' , 'nodeid' , 'internalip' and 'clientpassword' .

With configurable options you can allow your customers to place orders perfectly tailored to their needs. Our module offers the following configurable options:

SV13.png
You have just finished the installation and configuration of the module. From this moment your customers can start to place orders!

Management

SolusVM Extended VPS For WHMCS offers very intuitive management of virtual servers.

Interface

Now let's check the interface of the module in your WHMCS client area. As you can see, everything your customers need is in one place.

Note that the screen below presents the module, right after creation of the product. Charts and graphs will fill with data after use of server resources.

SV14.png
The above screen presents a 'Classic Design' introduced in version 1.2. A following screen shows basic design.

You can switch between designs by ticking 'Client Area Classic Design' in 'Module Settings' .

File:SV14.5.png
You can monitor and manage each product from your WHMCS admin area.

Note that the screen below presents the module, right after creation of the product. Charts and graphs will fill with data after use of server resources.

SV15.png

Management of Server

Module allows your customers to easily boot (1), reboot (2), shutdown (3) and delete (4) their servers through pressing specified button.

Product allows also to quickly change hostname (5), root password (6), boot order (7) and enable/disable PAE (8).
Dependant on the chosen virtualization type, module allows your customers to also enable/disable TUN/TAP.
Dependant on the chosen virtualization type, module displays Traffic, Load and Memory graphs.

SV16.png
One of the most interesting functionality is SSH console where your clients can remotely manage server. To access it, simply press on the 'Console' button.
SV17.png
Rebuild feature allows to change template from available templates list. To rebuild your server click on 'Rebuild' button, choose template and click on the blue 'Rebuild' button.
File:SV19.png
Customers can quickly access the VPS Control Panel with just one click to 'Control Panel' button.
SV18.png

Management of DNS

When you combine SolusVM Extended VPS For WHMCS With DNS Manager For WHMCS, your clients will be able to manage PowerDNS from the client area.

DNS Manager For WHMCS will allow your customers to manage DNS zones, records and ReverseDNS.
To connect both modules, go to 'Processing' section of DNS Manager, configure the module, tick 'With Products' and choose SolusVM Extended VPS product.

SV26.png
Afterwards, buttons 'Manage DNS' and 'Manage Reverse DNS' will appear in the client area as shown on the screen below.
SV22.png
Dependant on your previously chosen settings, your customers will be able to add, edit and remove DNS zones and records.
SV24.png
Module will also allow your customers to add, edit and remove Reverse DNS zones and records.
File:SV25.png

Management of Billing

When you combine SolusVM Extended VPS For WHMCS With Advanced Billing For WHMCS, you will be able to set up additional billing options.

Module allows you to charge your customers based on the server resources used by them.

SV23.png

Management of Email Templates

SV27.png
SV28.png

Update of Products

Our module is entirely compatible with SolusVM Pro module and you can easily upgrade your existing products without losing your settings.

Firstly, go to 'Setup' → 'Products/Services' → 'Products/Services' → 'Module Settings' of your product and switch 'Module Name' from 'Solusvmpro' to 'SolusvmExtendedVPS' .
Afterwards go to 'Setup' → 'Products/Services' → 'Servers' and switch your server type from 'Solusvmpro' to 'SolusvmExtendedVPS' .
Once again go to 'Setup' → 'Products/Services' → 'Products/Services' → 'Module Settings' of your product and make sure that 'Server Group' is set up correctly.
In the last step generate default configurable options and custom fields through clickng on 'Generate default' buttons. Your SolusVM Extended VPS product is ready to use!

Debug Mode

SolusVM Extended VPS is very complex module. Therefore many things might go wrong.

To help you quickly solve various problems usually connected with WHMCS product/server configuration and SolusVM server configuration, we created a 'Debug Mode' .
To enable it, go to 'Module Settings' of your product and tick 'Debug Mode' as shown on the screen below.

SV20.png
Afterwards go to 'Utilities' → 'Logs' → 'Module Log' and click on 'Disable Debug Logging' in order to enable it.

From that moment, each action performed by module will be recorded in the log.
In that way, you can easily check whether module correctly fetches the information about virtual servers, nodes, templates, plans etc.
If it doesn't, that indicates a problem with WHMCS product/server configuration or problem with your SolusVM server.
The following screen presents exemplary module log.

SV21.png
Remember to turn off Debug Mode after you fix the problem.

Tips

1. We made every effort to make our module as easy to install, configure and use, as possible. Therefore we paid special attention to displayed messages.

Read carefully each message, follow the instructions and you shall have no problems with using the module.

2. Operations performed on the virtual servers are not executed immediately. Give your SolusVM server some time for processing the request and execution of operation.

Common Problems

1. The vast majority of problems are connected with misconfigured SolusVM server or misconfigured servers/products in your WHMCS.

First, make sure that your SolusVM server has properly configured virtual servers, nodes, node groups, templates, plans and API access.
In most cases, appropriate SolusVM server configuration guarantees correct operation of the module.
Afterwards check your WHMCS server connection and products settings. If you are certain that everything is correct, use our Debug Mode.

2. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
✔ Provisioning Module
✔ Virtual Server Management From The Client Area
✔ Complete Product Management From The Admin Area
✔ Simple Installation
✔ Dynamic Server Resources Setup With Configurable Options
  • Provisioning Module Functionality:
✔ Create Server
✔ Terminate Server
✔ Suspend/Unsuspend Server
✔ Rebuild Server
✔ Upgrade/Downgrade Server And Resources
✔ Boot/Reboot/Shutdown Server
✔ Enable TUN/TAP And PAE
✔ Change Password: Root, Client, Console And VNC
✔ Mount/Unmount ISO
✔ Change Boot Order
✔ Get Server Status
✔ Graphs: Traffic, Load, Memory
✔ SSH Console
✔ VNC Console
✔ Send Email Templates After Server Creation Based On Type
✔ Two Layouts
✔ Possibility To Turn Off Root Password Storing In The System Database
  • Additional Functionality:
✔ Combined With DNS Manager For WHMCS - Supports PowerDNS (read more)
✔ Combined With Advanced Billing For WHMCS Module - Supports Server Resource Usage Billing (read more)
✔ Multi-Language Support
✔ Supports WHMCS V5 and Later

Installation and Configuration

In this tutorial we will show you how to successfully install SolusVM Extended VPS For WHMCS.

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

1. Log in to your client area and download SolusVM Extended VPS For WHMCS.
SV1.png
2. Upload and extract the module into the main WHMCS directory.
Files in your WHMCS directory should look like this.
SV2.png
3. When you install SolusVM Extended VPS for the first time you have to rename 'license_RENAME.php' file.
File is located at 'modules/servers/solusvmExtendedCloud/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .
SV3.png
4. In order to configure your license key you have to edit a previously renamed 'license.php' file.
Enter your licence key between quotation marks as presented on the following screen. You can find your license key at your client area → 'My Products' .
SV4.png
5. Now we will show you how to configure a new product.

First, log in to your SolusVM admin area, go to 'CONFIGURATION' → 'API Access' and add API User.

SV5.png
6. Enter your current IP and once again click on 'Add API User' button.
SV6.png
7. Now log in to your WHMCS admin area. Press 'Setup' → 'Products/Services' → 'Servers' .
Afterwards press 'Add New Server' .
CP8.png
8. Enter your server name and IP address.

Next, enter your API User ID into 'Username' field and your API User Key into 'Password' field. Choose 'SolusvmExtendedVPS' from a dropdown menu and press 'Save Changes' .
Here you can also provide other server details like nameservers or maximum number of accounts.

SV7.png
9. After you configure your server correctly, you will see a following screen.
Test your connection through pressing on 'Test Connection' . Now you need to create a new group for your server. For that purpose press 'Create New Group' .
SV8.png
10. Enter name, click on your previously created server, press 'Add' then press 'Save Changes' .
SV9.png
11. In order to create and configure product click on 'Setup' → 'Products/Services' → 'Products/Services' .
If you don't have a product group, click on 'Create a New Group' . If you do, simply go to step 13.
CP12.png
12. Enter product group name, choose order form template and press 'Save Changes' .
SV10.png
13. When you have a product group, you can create your product and assign it with SolusVM Extended VPS. If you already have a product, go to step 15.
To create a product click on 'Create a New Product' .
SV10.5.png
14. Afterwards choose your product type and product group from a dropdown menus, enter your product name and press 'Continue' .
SV11.png
15. Now go to 'Module Settings' section, choose both 'SolusvmExtendedVPS' and your previously created server group from a dropdown menus.

After you press 'Save Changes' , all the configuration options will load below.
Generate configurable options and custom fields as shown on the following screen.
Keep in mind that without right custom fields, module will not work correctly.

SV12.png
16. Configuration of the product is divided into two sections: 'Features Setup' and 'Products Configuration' .

In Features Setup you can select the functionalities you want to offer your customers.
In Product Configuration you need to determine the details of connection between WHMCS product and your SolusVM server.

File:SV12.5.png
17. Custom fields generated by our module should contain 4 fields: 'vserverid' , 'nodeid' , 'internalip' and 'clientpassword' .

With configurable options you can allow your customers to place orders perfectly tailored to their needs. Our module offers the following configurable options:

SV13.png
You have just finished the installation and configuration of the module. From this moment your customers can start to place orders!

Management

SolusVM Extended VPS For WHMCS offers very intuitive management of virtual servers.

Interface

Now let's check the interface of the module in your WHMCS client area. As you can see, everything your customers need is in one place.

Note that the screen below presents the module, right after creation of the product. Charts and graphs will fill with data after use of server resources.

SV14.png
The above screen presents a 'Classic Design' introduced in version 1.2. A following screen shows basic design.

You can switch between designs by ticking 'Client Area Classic Design' in 'Module Settings' .

File:SV14.5.png
You can monitor and manage each product from your WHMCS admin area.

Note that the screen below presents the module, right after creation of the product. Charts and graphs will fill with data after use of server resources.

SV15.png

Management of Server

Module allows your customers to easily boot (1), reboot (2), shutdown (3) and delete (4) their servers through pressing specified button.

Product allows also to quickly change hostname (5), root password (6), boot order (7) and enable/disable PAE (8).
Dependant on the chosen virtualization type, module allows your customers to also enable/disable TUN/TAP.
Dependant on the chosen virtualization type, module displays Traffic, Load and Memory graphs.

SV16.png
One of the most interesting functionality is SSH console where your clients can remotely manage server. To access it, simply press on the 'Console' button.
SV17.png
Rebuild feature allows to change template from available templates list. To rebuild your server click on 'Rebuild' button, choose template and click on the blue 'Rebuild' button.
File:SV19.png
Customers can quickly access the VPS Control Panel with just one click to 'Control Panel' button.
SV18.png

Management of DNS

When you combine SolusVM Extended VPS For WHMCS With DNS Manager For WHMCS, your clients will be able to manage PowerDNS from the client area.

DNS Manager For WHMCS will allow your customers to manage DNS zones, records and ReverseDNS.
To connect both modules, go to 'Processing' section of DNS Manager, configure the module, tick 'With Products' and choose SolusVM Extended VPS product.

SV26.png
Afterwards, buttons 'Manage DNS' and 'Manage Reverse DNS' will appear in the client area as shown on the screen below.
SV22.png
Dependant on your previously chosen settings, your customers will be able to add, edit and remove DNS zones and records.
SV24.png
Module will also allow your customers to add, edit and remove Reverse DNS zones and records.
File:SV25.png

Management of Billing

When you combine SolusVM Extended VPS For WHMCS With Advanced Billing For WHMCS, you will be able to set up additional billing options.

Module allows you to charge your customers based on the server resources used by them.

SV23.png

Management of Email Templates

SV27.png
SV28.png

Update of Products

Our module is entirely compatible with SolusVM Pro module and you can easily upgrade your existing products without losing your settings.

Firstly, go to 'Setup' → 'Products/Services' → 'Products/Services' → 'Module Settings' of your product and switch 'Module Name' from 'Solusvmpro' to 'SolusvmExtendedVPS' .
Afterwards go to 'Setup' → 'Products/Services' → 'Servers' and switch your server type from 'Solusvmpro' to 'SolusvmExtendedVPS' .
Once again go to 'Setup' → 'Products/Services' → 'Products/Services' → 'Module Settings' of your product and make sure that 'Server Group' is set up correctly.
In the last step generate default configurable options and custom fields through clickng on 'Generate default' buttons. Your SolusVM Extended VPS product is ready to use!

Debug Mode

SolusVM Extended VPS is very complex module. Therefore many things might go wrong.

To help you quickly solve various problems usually connected with WHMCS product/server configuration and SolusVM server configuration, we created a 'Debug Mode' .
To enable it, go to 'Module Settings' of your product and tick 'Debug Mode' as shown on the screen below.

SV20.png
Afterwards go to 'Utilities' → 'Logs' → 'Module Log' and click on 'Disable Debug Logging' in order to enable it.

From that moment, each action performed by module will be recorded in the log.
In that way, you can easily check whether module correctly fetches the information about virtual servers, nodes, templates, plans etc.
If it doesn't, that indicates a problem with WHMCS product/server configuration or problem with your SolusVM server.
The following screen presents exemplary module log.

SV21.png
Remember to turn off Debug Mode after you fix the problem.

Tips

1. We made every effort to make our module as easy to install, configure and use, as possible. Therefore we paid special attention to displayed messages.

Read carefully each message, follow the instructions and you shall have no problems with using the module.

2. Operations performed on the virtual servers are not executed immediately. Give your SolusVM server some time for processing the request and execution of operation.

Common Problems

1. The vast majority of problems are connected with misconfigured SolusVM server or misconfigured servers/products in your WHMCS.

First, make sure that your SolusVM server has properly configured virtual servers, nodes, node groups, templates, plans and API access.
In most cases, appropriate SolusVM server configuration guarantees correct operation of the module.
Afterwards check your WHMCS server connection and products settings. If you are certain that everything is correct, use our Debug Mode.

2. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=SolusVM_Extended_VPS_For_WHMCS&oldid=4503"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
SolusVM Extended VPS For WHMCS