SolusVM Extended Cloud For WHMCS

About SolusVM Extended Cloud For WHMCS

SolusVM Extended Cloud For WHMCS allows your customers to create and manage multiple virtual servers in your WHMCS client area. Clients can freely manage their servers within resource limit defined by you. Module offers range of functionalities owing to which your clients will be able to e.g. create, resize, reboot or upgrade virtual servers according to their needs.

• Provisioning Module Functionality:

✔ Create Client

✔ Suspend/Unsuspend Servers

✔ Terminate Client And All His Servers

✔ Dynamic Server Resources Setup With Configurable Options

• Admin Area Features:

✔ Create/Suspend/Unsuspend/Terminate Product

✔ Get Server Status

✔ Graphs: Traffic, Load, Memory

✔ Configurable Client Area Features

✔ OS Templates Allowed For Rebuild

✔ Friendly Names For OS Templates

✔ Possibility To Turn Off Root Password Storing In The System Database

• Client Area Features:

✔ Create/Delete Server

✔ Boot/Reboot/Shutdown/Rebuild Server

✔ Upgrade Server

✔ Enable TUN/TAP And PAE

✔ Change Password: Root, Client, SSH Console And VNC Console

✔ Change Boot Order

✔ Get Server Status

✔ Graphs: Traffic, Load, Memory

✔ SSH Console (OpenVZ & Xen Virtualizations)

✔ VNC Console (KVM & Xen HVM Virtualizations)

✔ Control Panel Button

✔ OS Templates Allowed For Rebuild

✔ Friendly Names For OS Templates

✔ Send Email Templates After Server Creation Based On Type

• Additional Functionality:

✔ Integrated With DNS Manager For WHMCS - Supports PowerDNS (read more)

✔ Integrated With Advanced Billing For WHMCS - Server Resource Usage Billing (read more)

✔ Extended API Connection Test

✔ Multi-Language Support

✔ Supports WHMCS V5 and Later

• Available Configurable Options:

✔ Memory Limit

✔ Storage Limit

✔ Bandwidth Limit

✔ CPU Cores Limit

✔ IP Addresses Limit

Installation and Configuration

In this tutorial we will show you how to successfully install SolusVM Extended Cloud 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 Cloud For WHMCS.

2. Upload and extract the module into the main WHMCS directory. Files in your WHMCS directory should look like this.

3. When you install SolusVM Extended Cloud 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' .

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

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.

6. Enter your current IP and once again click on 'Add API User' button.

Configuration of Server

7. Now log in to your WHMCS admin area and go to 'Setup' → 'Products/Services' → 'Servers' . Afterwards, press 'Add New Server' .

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 'SolusvmExtendedCloud ' from a dropdown menu and press 'Save Changes' . Here you can also provide other server details like nameservers or maximum number of accounts.

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

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

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 step 13.

12. Enter product group name, choose order form template and press 'Save Changes' .

13. When you have a product group, you can create your product and assign it with SolusVM Extended Cloud. If you already have a product, go to the step 15. To create a product click on 'Create a New Product' .

14. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press 'Continue' .

15. Now, go to the 'Module Settings' section, choose both 'SolusvmExtendedCloud' and your previously created server group from dropdown menus. Afterwards, press 'Save Changes' .

16. Select desired virtualization and press 'Save Changes' . All options for selected virtualization will be loaded.

17. Now, choose desired values from 'Node' , 'Plan' and 'Internal IP' dropdown menus. Fill 'Username Prefix' field and scroll down to the 'Client Area Features' section. Note: At fields starting of 'Vserver' you can define the limits for created VPSes.

18. At the 'Client Area Features' section you can define which features will be available for your clients. Feature is enabled by marking checkbox next to it. Important: It is adviced to disable features which are not supported by chosen virtualization.

18. Our module allows you to set up custom names for OS templates visible at the client area. It can be done at the 'Templates Friendly Name' section through filling fields next to OS templates you wish to rename. At the next section you can define which OS templates will be available for your clients by marking checkboxes next to them. Now, press 'Save Changes' .

File:SC17 2.png

Product With Dynamic Resources

19. In order to set up product with dynamic resources, simply press 'Generate Default' as shown on the following screen. Configurable options allow your client to pick product with resources tailored to theirs needs. Configurable options can be edited and each option can be priced. Follow to this article for more information.

Product With Static Resources

19. You can also provide your clients with static resources. Simply, fill fields marked on the screen below with desired limits and press 'Save Changes' . Note: Make sure that this product do not have assigned configurable options otherwise they will overwrite limits provided at this step.

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

Management

SolusVM Extended Cloud For WHMCS is very simple and convenient in use. Your customers are only a few clicks away from creating their own servers. Module will allow your customers to manage multiple servers and freely change their resources. Everything within your own WHMCS client area. Owing to integration with Advanced Billing For WHMCS you can even offer product, for which client will be billed depending of its usage. An additional possibility is also integration with DNS Manager For WHMCS allowing to manage PowerDNS zones and records.

Interface

Now, let's check the interface of the module in your WHMCS client area where you customers can create and manage virtual servers. Note: Screen below presents the module, right after creation of the product. More features will show up after creating a server.

You can manage each product from your WHMCS admin area. In addition to that, each VPS created by your clients can be easily monitored.

Management of Servers

Let's start from creating new virtual server. To do so, click on 'Create Virtual Server' button.

Set server details and click on 'Add New Virtual Server' button.

As you can see on the screen below, virtual server has been successfully created. Now let's see how can we manage our new server. To proceed, click on 'Manage' button.

Module offers all the management functionalities as SolusVM Extended For VPS with one significant difference, the upgrade. Upgrade allows your customers to request a change of virtual server resources. For more information about management of already created virtual server visit SolusVM Extended VPS For WHMCS Wiki

Set upgrades details and click on 'Upgrade' button.

As you can see on the following screen, virtual server has been upgraded.

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.

If automatically generated configurable options do not seem to fill your client needs, you can edit them using this guide to change them.

If you decide to set pricing per server resource ordered, you can find instruction how to proceed here.

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 Cloud 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 Cloud product.

Afterwards, buttons 'Manage DNS' and 'Manage Reverse DNS' will appear in the client area as shown on the screen below.

Dependant on your previously chosen settings, your customers will be able to add, edit and remove DNS zones and records.

Module will also allow your customers to add, edit and remove Reverse DNS zones and records.

Management of Billing

When you combine SolusVM Extended Cloud 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.

With Advanced Billing module, you can also display your customers the current server resource usage and their cost.

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 'SolusvmExtendedCloud' . 2. Proceed to the 'Setup' → 'Products/Services' → 'Servers' and switch your server type from 'Solusvmpro' to 'SolusvmExtendedCloud' . 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 Cloud product is ready to use!

Debug Mode

SolusVM Extended Cloud 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.

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' . 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 does not, that indicates a problem with WHMCS product/server configuration or problem with your SolusVM server. The following screen presents exemplary module log.

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. 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. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.