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 3: Line 3:
  
 
=About [http://www.modulesgarden.com/products/whmcs/solusvm_extended_vps/features SolusVM Extended VPS For WHMCS] =
 
=About [http://www.modulesgarden.com/products/whmcs/solusvm_extended_vps/features SolusVM Extended VPS For WHMCS] =
−
<h4 style="color: #ff0000; font-weight:bold; text-align:center;">Article update is ongoing on this page, watch out for broken links and unclear descriptions!<br />
 
−
We are sorry for the inconveniences.</h4>
 
 
{|
 
{|
 
|style="padding: 10px 0px 10px 0px;"|'''SolusVM Extended VPS For WHMCS''' allows you to automatically provision virtual servers to your clients.<br />
 
|style="padding: 10px 0px 10px 0px;"|'''SolusVM Extended VPS For WHMCS''' allows you to automatically provision virtual servers to your clients.<br />
Line 64: Line 62:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ SSH Console
+
|style="padding: 0px 0px 0px 30px;"|✔ SSH Console (OpenVZ & Xen)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ VNC Console
+
|style="padding: 0px 0px 0px 30px;"|✔ VNC Console (KVM & Xen HVM)
 
|}
 
|}
 
{|
 
{|
Line 127: Line 125:
 
|style="padding: 0px 0px 30px 25px;"|[[File:SV4.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:SV4.png]]
 
|}
 
|}
−
 
−
 
 
==Configuration of API Access==
 
==Configuration of API Access==
 
{|
 
{|
−
|style="padding: 1px 0px 15px 15px;"|'''5. Now, we will show you how to configure a new product.'''<br />
+
|style="padding: 10px 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.
 
First, log in to your SolusVM admin area, go to '' 'CONFIGURATION' '' → '' 'API Access' '' and add API User.
 
|}
 
|}
Line 143: Line 139:
 
|style="padding: 0px 0px 30px 25px;"|[[File:SV6.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:SV6.png]]
 
|}
 
|}
−
 
−
 
 
==Configuration of Server==
 
==Configuration of Server==
 
{|
 
{|
Line 155: Line 149:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''8. Enter your server name and IP address.'''<br />
 
|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 />
+
Next, enter your API User ID into '' 'Username' '' field and your API User Key into '' 'Password' '' field.<br />
 +
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.  
 
Here you can also provide other server details like nameservers or maximum number of accounts.  
 
|}
 
|}
Line 163: Line 158:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''9. After you configure your server correctly, you will see a following screen.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''9. After you configure your server correctly, you will see a following screen.'''<br />
−
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' ''.
+
Test your connection and API key through pressing on '' 'Test Connection' ''. <br />
 +
Now, you need to create a new group for your server. For that purpose press '' 'Create New Group' ''.
 
|}
 
|}
 
{|
 
{|
Line 169: Line 165:
 
|}
 
|}
 
{|
 
{|
−
|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 15px;"|'''10. Enter name, click on your previously created server, press '' 'Add' '' then click on '' 'Save Changes' ''.'''
 
|}
 
|}
 
{|
 
{|
Line 178: Line 174:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'''11. In order to create and configure product, click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
 
|style="padding: 10px 0px 15px 15px;"|'''11. In order to create and configure product, click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
−
If you do not have a product group, click on '' 'Create a New Group' ''. If you do, simply go to step 13.
+
If you do not have a product group, click on '' 'Create a New Group' ''. If you do, simply go to the step 13.
 
|}
 
|}
 
{|
 
{|
Line 184: Line 180:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''12. Enter product group name, choose order form template and press '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''12. Enter product group name and press '' 'Save Changes' ''.'''
 
|}
 
|}
 
{|
 
{|
Line 190: Line 186:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 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.'''<br />
+
|style="padding: 0px 0px 15px 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 the step 15.'''<br />
 
To create a product click on '' 'Create a New Product' ''.
 
To create a product click on '' 'Create a New Product' ''.
 
|}
 
|}
Line 203: Line 199:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''15. Now go to '' 'Module Settings' '' section, choose both '' 'SolusvmExtendedVPS' '' and your previously created server group from dropdown menus.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''15. Now, go to the '' 'Module Settings' '' section, choose both '' 'SolusvmExtendedVPS' '' and your previously created server group from dropdown menus.'''<br />
−
After you press '' 'Save Changes' '', all the configuration options will load below.<br />
+
Afterwards, press '' 'Save Changes' ''.
−
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.'''
+
 
|}
 
|}
 
{|
 
{|
Line 212: Line 206:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''16. Configuration of the product is divided into two sections: '' 'Features Setup' '' and '' 'Products Configuration' ''.<br />
+
|style="padding: 0px 0px 15px 15px;"|'''16. Start configuration of a product from '' 'Product Configuration' '' section.<br />
−
In Features Setup you can select the functionalities you want to offer your customers.<br />
+
Select desired '' 'Virtualization Type' '' and press '' 'Save Changes' '' in order to load options bounded to chosen virtualization.
−
In Product Configuration you need to determine the details of connection between WHMCS product and your SolusVM server.
+
 
|}
 
|}
 
{|
 
{|
Line 220: Line 213:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''17. Custom fields generated by our module should contain 4 fields: '' 'vserverid' '', '' 'nodeid' '', '' 'internalip' '' and '' 'clientpassword' ''.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|'''17. Now, choose '' 'Default Node' '', '' 'Plan' '', '' 'Default Operating System' '', '' 'Amount of IP' '' and '' 'Default Node Group' ''.
−
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:SV17.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:SV17.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''18. Define features available at the client area through marking/unmarking them at the '' 'Client Area Features' '' section.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV17_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''19. At the '' 'Templates Friendly Name' '' section you can set up custom names for templates.'''<br />
 +
OS templates will be displayed at the client area under those names.<br />
 +
Next section allows you to define which of OS templates will be available for your clients to rebuild their VPSes.<br />
 +
Confirm settings through pressing '' 'Save Changes' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV17_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''20. Final step is generating default configurable options.'''<br />
 +
To do so, press '' 'Generate Default' '' near '' 'Configurable Options' '' as shown on the screen below.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SV17_3.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!  
 
|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=
 
=Management=
 
{|
 
{|
Line 236: Line 251:
 
{|
 
{|
 
|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 />
 
|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.
+
''Note: List of available features depends of selected virtualization.''<br />
 +
''Due to that, you have to manually disable features from the client area which are not supported by chosen virtualization.''
 
|}
 
|}
 
{|
 
{|
Line 243: Line 259:
 
{|
 
{|
 
|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 />
 
|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' ''.
+
You can switch between designs by ticking '' 'Classic Design' '' at the '' 'Module Settings' '' → '' 'Client Area Features' ''.
 
|}
 
|}
 
{|
 
{|
Line 249: Line 265:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can monitor and manage each product from your WHMCS admin area.<br />
+
|style="padding: 0px 0px 20px 15px;"|You can monitor and manage each product from your WHMCS admin area.
−
''Note: Screen below presents the module, right after creation of the product. Charts and graphs will fill with data after use of server resources.''
+
 
|}
 
|}
 
{|
 
{|
Line 258: Line 273:
 
==Management of Server==
 
==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 />
+
|style="padding: 10px 0px 15px 15px;"|Module allows your customers to easily log into control panel (1), access SSH/VNC console (2), boot, reboot (3), shutdown (4), rebuild (5) and delete (6) their VPSes.<br />
−
Product allows also to quickly change hostname (5), root password (6), boot order (7) and enable/disable PAE (8).<br />
+
In an addition to that, your clients can change hostname (7) and root password (8), set up boot order (9), mount ISO (10) and unmount ISO (11).<br />
−
Dependant on the chosen virtualization type, module allows your customers to also enable/disable TUN/TAP.<br />
+
Your clients can also easily enable/disable PAE (13), view current resource usage and graphs of servers resource usage.<br />
−
Dependant on the chosen virtualization type, module displays Traffic, Load and Memory graphs.
+
Dependant on the chosen virtualization type, module allows your customers to enable/disable TUN/TAP (12).
 
|}
 
|}
 
{|
 
{|
Line 267: Line 282:
 
|}
 
|}
 
{|
 
{|
−
|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.
+
|style="padding: 0px 0px 15px 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 />
 +
''Note: This type of console is available only for OpenVZ & Xen virtualizations.''
 
|}
 
|}
 
{|
 
{|
Line 273: Line 289:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Module contains also a VNC Console for KVM and Xen HVM.
+
|style="padding: 0px 0px 15px 15px;"|Module contains also a VNC console.<br />
 +
''Note: VNC console is used by KVM and Xen HVM virtualizations.''
 
|}
 
|}
 
{|
 
{|
Line 279: Line 296:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Rebuild feature allows to change template from available templates list.<br />
+
|style="padding: 0px 0px 15px 15px;"|Rebuild feature allows to change OS template from available OS templates list.<br />
 
To rebuild your server click on '' 'Rebuild' '' button, choose template and click on the blue '' 'Rebuild' '' button.
 
To rebuild your server click on '' 'Rebuild' '' button, choose template and click on the blue '' 'Rebuild' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV24.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SV24.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:SV25.png]]
+
 
|}
 
|}
  
Line 419: Line 430:
 
|style="padding: 0px 0px 30px 25px;"|[[File:SV33.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:SV33.png]]
 
|}
 
|}
−
 
 
==Update of Products==
 
==Update of Products==
 
{|
 
{|
 
|style="padding: 10px 0px 30px 15px;"|Our module is entirely compatible with SolusVM Pro module and you can easily upgrade your existing products without losing your settings.<br />
 
|style="padding: 10px 0px 30px 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 />
+
1. Go to the '' '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 />
+
2. Proceed to the '' '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 />
+
3. Now, click the '' '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 clicking on '' 'Generate default' '' buttons.
+
4. Last step is generating default configurable options and custom fields through clicking on '' 'Generate default' '' buttons.<br />
 
Your SolusVM Extended VPS product is ready to use!
 
Your SolusVM Extended VPS product is ready to use!
 
|}
 
|}
−
 
 
==Debug Mode==
 
==Debug Mode==
 
{|
 
{|
Line 440: Line 449:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Afterwards go to '' 'Utilities' '' → '' 'Logs' '' → '' 'Module Log' '' and click on '' 'Enable Debug Logging' '' in order to enable it. Button should change value for '' 'Disable Debug Logging' ''.<br />
+
|style="padding: 0px 0px 15px 15px;"|Afterwards go to the '' 'Utilities' '' → '' 'Logs' '' → '' 'Module Log' '' and click on '' 'Enable Debug Logging' '' in order to enable it. Button should change value for '' 'Disable Debug Logging' ''.<br />
 
From that moment, each action performed by module will be recorded in the log.<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 />
 
In that way, you can easily check whether module correctly fetches the information about virtual servers, nodes, templates, plans etc.<br />

Revision as of 11:52, 7 May 2014

Contents

About SolusVM Extended VPS For WHMCS

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, SSH Console And VNC Console
✔ Mount/Unmount ISO
✔ Change Boot Order
✔ Get Server Status
✔ Graphs: Traffic, Load, Memory
✔ SSH Console (OpenVZ & Xen)
✔ VNC Console (KVM & Xen HVM)
✔ Control Panel Button
✔ Send Email Templates After Server Creation Based On Type
✔ Two Layouts
✔ Possibility To Turn Off Root Password Storing In The System Database
  • Additional Functionality:
✔ Integrated With DNS Manager For WHMCS - Supports PowerDNS (read more)
✔ Integrated With Advanced Billing For WHMCS - 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 on the following screen.

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 license key between quotation marks as presented on the following screen. You can find your license key at your client area → 'My Products' .

SV4.png

Configuration of API Access

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

Configuration of Server

7. Now log in to your WHMCS admin area. Press 'Setup' → 'Products/Services' → 'Servers' .

Afterwards, press 'Add New Server' .

SV7.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.

SV8.png
9. After you configure your server correctly, you will see a following screen.

Test your connection and API key through pressing on 'Test Connection' .
Now, you need to create a new group for your server. For that purpose press 'Create New Group' .

SV9.png
10. Enter name, click on your previously created server, press 'Add' then click on 'Save Changes' .
SV10.png

Configuration of Product

11. In order to create and configure product, click on 'Setup' → 'Products/Services' → 'Products/Services' .

If you do not have a product group, click on 'Create a New Group' . If you do, simply go to the step 13.

SV11.png
12. Enter product group name and press 'Save Changes' .
SV12.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 the step 15.

To create a product click on 'Create a New Product' .

SV13.png
14. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press 'Continue' .
SV14.png
15. Now, go to the 'Module Settings' section, choose both 'SolusvmExtendedVPS' and your previously created server group from dropdown menus.

Afterwards, press 'Save Changes' .

SV15.png
16. Start configuration of a product from 'Product Configuration' section.

Select desired 'Virtualization Type' and press 'Save Changes' in order to load options bounded to chosen virtualization.

SV16.png
17. Now, choose 'Default Node' , 'Plan' , 'Default Operating System' , 'Amount of IP' and 'Default Node Group' .
SV17.png
18. Define features available at the client area through marking/unmarking them at the 'Client Area Features' section.
SV17 1.png
19. At the 'Templates Friendly Name' section you can set up custom names for templates.

OS templates will be displayed at the client area under those names.
Next section allows you to define which of OS templates will be available for your clients to rebuild their VPSes.
Confirm settings through pressing 'Save Changes' .

SV17 2.png
20. Final step is generating default configurable options.

To do so, press 'Generate Default' near 'Configurable Options' as shown on the screen below.

SV17 3.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: List of available features depends of selected virtualization.
Due to that, you have to manually disable features from the client area which are not supported by chosen virtualization.

SV18.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 'Classic Design' at the 'Module Settings' → 'Client Area Features' .

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

Management of Server

Module allows your customers to easily log into control panel (1), access SSH/VNC console (2), boot, reboot (3), shutdown (4), rebuild (5) and delete (6) their VPSes.

In an addition to that, your clients can change hostname (7) and root password (8), set up boot order (9), mount ISO (10) and unmount ISO (11).
Your clients can also easily enable/disable PAE (13), view current resource usage and graphs of servers resource usage.
Dependant on the chosen virtualization type, module allows your customers to enable/disable TUN/TAP (12).

SV21.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.

Note: This type of console is available only for OpenVZ & Xen virtualizations.

SV22.png
Module contains also a VNC console.

Note: VNC console is used by KVM and Xen HVM virtualizations.

SV23.png
Rebuild feature allows to change OS template from available OS templates list.

To rebuild your server click on 'Rebuild' button, choose template and click on the blue 'Rebuild' button.

SV24.png

Management of Email Templates

You can automatically send your customers the emails with details of newly created virtual servers.

To do so, create new email template with 'Product' type and 'Unique Name' specified in SolusVM Documentation, in our case it is 'KVM Virtual Server' .
Use of other template unique names than specified in above documentation makes impossible to send emails.
Note: The only supported email template unique names are: 'OpenVZ Virtual Server', 'Xen PV Virtual Server', 'Xen HVM' and 'KVM Virtual Server'.

SV30.png
You can paste the email content from SolusVM Documentation or create your own. Owing to our module, you can also use these 4 variables:

{$service_custom_field_rootpassword}, {$service_custom_field_vncip}, {$service_custom_field_vncport} and {$service_custom_field_vncpassword}.

SV31.png

Management of Custom Hooks

Our module allows you to use custom hooks. All you have to do is to create some functions using php programming language.

Here you can see possible hooks:

solusvmExtendedVPS_customclientarea($params)
solusvmExtendedVPS_hostname($params)
solusvmExtendedVPS_username($params)
solusvmExtendedVPS_AdminLink($params)
solusvmExtendedVPS_create_one($params)
solusvmExtendedVPS_create_two($params)
solusvmExtendedVPS_create_three($params)
solusvmExtendedVPS_create_four($params)
solusvmExtendedVPS_create_five($params)
solusvmExtendedVPS_terminate_pre($params)
solusvmExtendedVPS_terminate_post_success($params)
solusvmExtendedVPS_terminate_post_error($params)
solusvmExtendedVPS_suspend_pre($params)
solusvmExtendedVPS_suspend_post_success($params)
solusvmExtendedVPS_suspend_post_error($params)
solusvmExtendedVPS_unsuspend_pre($params)
solusvmExtendedVPS_unsuspend_post_success($params)
solusvmExtendedVPS_unsuspend_post_error($params)
solusvmExtendedVPS_changepackage_pre($params)
solusvmExtendedVPS_changepackage_post_success($params)
solusvmExtendedVPS_changepackage_post_error($params)

But before editing any of these hooks you have to rename file 'custom-rename.php' to 'custom.php' .

SV34.png
Now your hooks are active, but they are empty, so they do nothing. To find details about hooks read file you previously edited.

You can find there hook, information about its time of run, return values and parameters.
For example, if you have no domains but want to have hostname you should set default value for hostname.
To do so, find hook 'solusvmExtendedVPS_hostname($params)' and type 'return 'myhostname.com';' inside of it.
It should look like on the screen below:

SV35.png

Dynamic Server Resources Setup With Configurable Options

If you want to allow your clients to dynamically set server with resources they choose follow these steps.

Firstly, you should have a ready product. For more information on how to create one, head to 'Configuration of Product' instruction.
The final result visible in the order form should be similar to the one presented on the screen below.

SV35 1.png
If automatically generated configurable options do not seem to fill your client needs, you can edit them using this guide to change them.
SV35 2.png
If you decide to set pricing per server resource ordered, you can find instruction how to proceed here.
SV35 3.png
If you prefer to charge your clients for server resources they actually use, you can use our Advanced Billing For WHMCS module.

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.
SV27.png
Dependant on your previously chosen settings, your customers will be able to add, edit and remove DNS zones and records.
SV28.png
Module will also allow your customers to add, edit and remove Reverse DNS zones and records.
SV29.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.

SV32.png
With Advanced Billing module, you can also display your customers the current server resource usage and their cost.
SV33.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.

1. Go to the 'Setup' → 'Products/Services' → 'Products/Services' → 'Module Settings' of your product and switch 'Module Name' from 'Solusvmpro' to 'SolusvmExtendedVPS' .
2. Proceed to the 'Setup' → 'Products/Services' → 'Servers' and switch your server type from 'Solusvmpro' to 'SolusvmExtendedVPS' .
3. Now, click the 'Setup' → 'Products/Services' → 'Products/Services' → 'Module Settings' of your product and make sure that 'Server Group' is set up correctly.
4. Last step is generating default configurable options and custom fields through clicking 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.

SV36.png
Afterwards go to the 'Utilities' → 'Logs' → 'Module Log' and click on 'Enable Debug Logging' in order to enable it. Button should change value for 'Disable Debug Logging' .

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.

SV37.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.
3. In the current version of SolusVM API there is no possibility to automatically upgrade Virtual Machine therefore you have to perform this action manually.

Upgrading package in the SolusVM VPS Extended module means upgrading of Solus Plan.

Common Problems

1. By default our module connects with SolusVM server on port 5353. If you are using different port, you need to specify it in the 'Hostname' field.

Default port for SSL connections is 5656. To connect on that port enter your hostname as follows: 'yourhostname.com:5656' . Keep in mind that you can connect on any port.
Field below 'Tick to use SSL Mode for Connections' switches connection type between http and https. Note that this is something different from choosing the port to connect.

2. 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.

3. Your client get white page with '{"success":"1","status":"1"}' while entering 'Control Panel' .

Cause: SolusVM client area template is based on Bootstrap, which may sometimes cause such errors.
Solution: Switch template used by SolusVM client area.

4. 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=11747"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
SolusVM Extended VPS For WHMCS