Virtuozzo VPS For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About Virtuozzo VPS For WHMCS

Virtuozzo VPS For WHMCS is a marvelous module intended for automatic provision and management of virtual servers in your WHMCS.

You will be able to create and provision ready products to your customers, while they will be allowed to manage their products straightforwardly in your client area.
In addition, the module contains a Server Monitor to let you view and manage all existing virtual machines and nodes within your admin area.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Server
✔ Migrate Server Between Nodes
✔ Change Package - Supports Configurable Options
✔ Change Password
✔ Assign/Delete Virtual Machine By Name
✔ Stop/Restart/Suspend/Migrate Virtual Machine
✔ View Server Details And Status
✔ View And Update Assigned IP Addresses
✔ View Scheduled Tasks
  • Client Area Features:
✔ View Server Details And Status
✔ Start/Stop/Restart/Suspend/Resume Server
✔ Schedule And Manage Backups
✔ Access VNC Console
✔ View Usage Statistics
✔ View And Order New IP Addresses
✔ Manage Firewall Rules
✔ Change Password
✔ Upgrade/Downgrade Product
  • Servers Monitor - Addon Features:
✔ Add/Edit Node
✔ Check Nodes Status
✔ View Nodes Usage And Statistics
✔ View Virtual Machines List
✔ Assign And Manage IP Pools
  • General Info:
✔ Requires Virtual Automation (PVA)
✔ Supports Virtuozzo And Virtuozzo Containers
✔ Supports High Availability Function
✔ Server Resources Chosen During Order
✔ Integrated With IP Manager For WHMCS - Easy IP Pools Management (Beta) (read more)
✔ Integrated With Advanced Billing For WHMCS - Server Resource Usage Billing (read more)
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Specified Servers To Products (read more)
✔ Multi-Language Support
✔ Supports Virtuozzo And Virtuozzo Containers Up To Version 7
✔ Supports PHP 5.4 Up To PHP 7
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V6 and V7

Installation and Configuration

This tutorial will show you how to successfully install and configure Virtuozzo VPS For WHMCS.

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

Installation

1. Log in to your client area and download the module.
VZ1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.
It does not apply to open source versions.

Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'.

VZ2 1 1.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

VV 2.png
4. When you install Virtuozzo VPS For WHMCS for the first time, you have to rename 'license_RENAME.php' file.

File is located in 'modules/servers/virtuozzo/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

VZ3.png
5. 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 in your client area → 'My Products'.

VZ4.png

Activation of Virtuozzo VPS Monitor

5. Firstly, you need to activate Virtuozzo VPS addon.

To do so, log in to your WHMCS and move to 'Setup' → 'Addon Modules'. Find 'Virtuozzo' and press 'Activate'.

VZ5.png
6. In the next step you need to permit access to this module.

To do so, click on 'Configure' button, tick 'Full Administrator' and press 'Save Changes' .

VZ6.png
7. In order to allow module to run smoothly, go to your addon → 'Installation' tab and add two cron jobs marked on the following screen.

Suggested execution time for 'slowCron' - each 5 minutes.
Suggested execution time for 'cron' - each minute.

VZ6 1.png

Configuration of Server

8. Now we will show you how to configure a new product.

Go to 'Setup' → 'Products/Services' → 'Servers' and press 'Add New Server' .

VZ7.png
9. Next, enter your server name, IP address, username and password. Choose 'Virtuozzo' from a dropdown menu and press 'Save Changes'.

Note: Server you are using on WHMCS is in fact a node on your PVA server, not a whole PVA server.

VZ8.png
10. It is time to create a server group, to do so click on 'Create New Group'.
VZ9.png
11. Enter name, click on your previously created server, press 'Add' and afterwards 'Save Changes'.
VZ10.png

Configuration of Product

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

Click on 'Create a New Group' .

VZ11.png
13. Enter product group name and press 'Save Changes'.
PCS12.png
14. When you have a product group, you can create your product.

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

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

Note: 'Product Type' should be set to 'Dedicated/VPS Server'.

VZ14.png
16. Now, go to 'Module Settings' section, choose both 'Virtuozzo' module name and your previously created server group from a dropdown menu.

Next, click on 'Save Changes'.

VZ15.png
17. From dropdown menus choose 'Base Node', 'Type', 'Public Network' and 'Private Network'.

Note: 'Virtuozzo Container' server type can have only one routed network.

VZ16.png
18. Depending on the server type that you have chosen, you may see different field names in 'Default Values' and 'Configurable Options' subsection.

On the following screen we will show you the configuration of 'Virtual Machine' server type.
If you wish to offer predefined servers to your clients, set up 'Default Values' and skip 'Configurable Options'.
In order to set up 'Default Values', choose 'Base Template' from a dropdown menu.
Next, enter values into textboxes marked on the screen below.

VZ17.png
19. At 'Configurable Options' you can generate/update specific configurable options for product.

Firstly, mark/unmark checkboxes at 'Settings to Generate' to specify which option you want to generate in your configurable options.
Afterwards, select nodes and base templates to generate in configurable options.
At the end, confirm it through 'Generate Configurable Options' / 'Update Configurable Options'.
Note: Values which will not be generated in configurable options, will be taken from 'Default Values'.

VZ18.png
20. Now, it is time to define pages and functionalities visible for client in 'Client Area Configuration' subsection.

You can do it by simply selecting/unselecting checkboxes next to a page/functionality you want to enable/disable.
On screen below you can see enabled all pages and functionalities.

VZ19.png
Congratulations! You have just finished the installation and configuration of the module.

Your clients should see something similar to the screen below.

VZ21.png

Management

Virtuozzo VPS For WHMCS allows your customers to manage their Virtuozzo accounts from the client area in your WHMCS system.

You can monitor and manage each product from your WHMCS admin area.

VZ22.png

Management of Addon

In 'Addons' 'Virtuozzo' you can find all used virtual machines and nodes as well as instructions on how to install the module.

Installation

At this tab you can find instructions on how to install Virtuozzo VPS For WHMCS and configure the product.

You can also find here a link to Virtuozzo VPS For WHMCS Wiki which you are currently reading.

VZ29 4.png

Templates Configuration

This tab does not support Virtuozzo VPS For WHMCS module, it was created for Virtuozzo Virtual Datacenter For WHMCS.

Servers Monitor

To add new node, press '+ Add Node' button.

Afterwards, follow steps 7 to 20 of 'VPS _For_WHMCS#Configuration_of_Server Installation and Configuration' instructions.

VZ23.png
You can also view current node usage through pressing 'Usage' button, as presented on the following screen.
VZ24.png
In 'Usage' tab you can view resource usage in specific time period for node that you chose.
VZ25.png
To access virtual machines list on a particular node, press on 'Virtual Machines' .
VZ26.png
'Virtual Machines' tab contains virtual machines list created on this WHMCS and node that you selected.

You can view here basic information about virtual servers.
To view more information about specific virtual machine, simply press on 'View' button.

VZ27.png
If you change your Virtuozzo server connection details, you can update connection credentials on your WHMCS through pressing 'Edit' next to altered node.
VZ28.png
Afterwards, upgrade your connection details and confirm through pressing 'Save Changes'.
VZ29.png

IP Management

Our Virtuozzo VPS For WHMCS module supports management of IP addresses, but it needs IP Manager For WHMCS to work correctly.

To access it, go to 'Addons' 'Virtuozzo' 'Servers Monitor' and press 'IP Management' button.

VZ29.1.png
As you can see, you can assign different IP pools to each network type.

Let's add a new IP Pool to 'Host Only' network. To do so, press ' Create a new Pool for this network' button.

VZ29.2.png
You will be moved to IP Manager module. You can add IP pool through creating a new subnet.

To do so, click 'Create New Subnet' button and follow the steps described here.
It is also important to configure IP Manager integration module for Virtuozzo VPS .
It will activate itself as soon as you add the first IP pool, so all you have to do is configure it for product using Virtuozzo VPS module. Instruction for it can be found here.
Successfully added IP pool will appear in Virtuozzo VPS addon.

VZ29.3.png

Management of Admin Area

At the admin area you can order basic options(2) as 'Create' , 'Suspend' , 'Unsuspend' , 'Terminate' and 'Change Package' .

You can also order 'Server Actions' (3) such as 'Stop' , 'Restart' , 'Suspend' , 'Start' , 'Reinstall' , 'Resume' and 'Migrate' .
You are able to configurable options(1), server details(4), assigned IP addresses(5), scheduled cron tasks(6) and host ID(7).
Note: 'Basic Template' cannot be changed if product was already created. 'Node' can be changed only using 'Migrate' and 'OS Template' through using 'Reinstall'.

VZ30.png

Reinstall

To reinstall your virtual server you have to stop it through pressing 'Stop' button.

Note: You are not able to reinstall 'Virtual Machine' server type.

VZ31.png
Afterwards, press 'Reinstall' button.
VZ32.png

Migrate

To migrate your virtual machine, choose server you want to migrate your virtual machine to.

Afterwards, select node on this server from a 'Node' configurable option and press 'Save Changes' button.
The last step is pressing 'Migrate Button' .
Note: To migrate your virtual server you have to generate 'Node' configurable option.

VZ33.png
Next, press 'Migrate' button.
VZ34.png
Afterwards, popup should appear. Confirm migration through clicking 'Migrate' button.
VZ35.png

Management of Client Area

Client area interface of Virtuozzo VPS should look like the one on the screen below.

As you can see, control panel contains useful options needed to manage a VPS.
Module allows your customers to easily 'Suspend' (1), 'Stop' (2), 'Restart' (3) their servers through pressing a specific button.
It is also available to 'Start' , 'Reinstall' (4) and 'Resume' server by clicking on defined buttons.
'Start' and 'Reinstall' actions are available only when server is down, 'Resume' is available when server is suspended.
Clients can also create backup and set up backup jobs(5), access VNC console(7), view virtual server usage statistics(6) and manage IP addresses(8).
Note: If your client is using 'Virtuozzo Container' they can also manage firewall (9).

VZ36.png

Backups Management

In 'Backups Management' (5) you can order backup jobs or create backups.

To create backup job press 'Create Backup Schedule' as shown on the screen below. Note: If two backup task are ordered in too small time interval, only one backup is created.

VZ37.png
Now define backup description by typing its name into a textbox and choose backup type from a dropdown menu.

You can choose whether to delete previous backup or not, through marking checkbox next to 'Remove Previous'.
Afterwards, select 'Recurrence Pattern' through marking desired option and set time of run.
On the screen below you can view sample setting for 'Repeat Daily' option.
To create this backup job, press 'Create Backup Schedule' button.

VZ38.png
You can also create a single backup. To do so, click on 'Create Backup' button as shown on the following screen.
VZ39.png
Now enter backup description and select backup type from a dropdown menu.

Afterwards, choose whether to delete previous backup or not, through marking checkbox next to 'Remove Previous'.
Confirm creation of this backup through pressing 'Create Backup' button.

VZ40.png
To restore Virtual Machine from the backup, simply press restore icon and 'Restore' button.
VZ41.png
At the top of this page, your client can view current backup usage and backup limit.
VZ42.png

Console

One of the most interesting functionalities is VNC console(7) where your clients can remotely manage server. To access it, simply press on the 'Console' button.

Console requires Java software. You also need to accept security risk to run it.
Additionally, it will be opened in a new window, so make sure your browser does not block it.

VZ43.png

Firewall Management

Under 'Firewall Management' (9) section the client can set up firewall for their virtual server.

They can 'Enable' / 'Disable' firewall(1), add new firewall rules(2), view existing rules list and manage existing rules(3).
Note: 'Firewall Management' is available only for 'Virtuozzo Container' server type.

VZ44.png

Usage Statistics

At 'Usage Statistics' your client can view information about resource used by his virtual server.

He can find resource usage and graphs of CPU, memory, bandwidth and disk.
Additionally, he can choose period of resource usage to display on graphs.

VZ45.png

IP Management

Here your client can find all IP addresses assigned to thier virtual server.

They can also order new IP addresses.

VZ46.png
To order new IP addresses, press 'Order New IP'.

Note 1: To order a new IP you have to generate configurable options for 'Number of Public IP' and 'Number of Private IP'.
Depending on generated configurable options, your client will be able to order public IP, private IP or both.
Note 2: You can hide these configurable options from the order form. You can find instruction here.

VZ47.png
Popup will appear, select IP address type and press 'Order'.
VZ48.png

Management of Configurable Options

When you successfully set up a product, your client can order it by choosing amount of resources from default configurable options.
VZ49.png

Editing Configurable Options

In case these options don't suit your needs, you can edit them.

To do so, go to 'Setup' 'Products/Services' 'Configurable Option' .
Afterwards, press edit button next to configurable option used by your product (its name is 'Configurable options for your_product_name' ).

VZ50.png
Here you can view all products this configurable option group is assigned to.

Now, let us show you how to edit options. Lets say you want to add an option to order VPS with 1000 GB disk.
To do so, edit 'hddSize_gb|Disk Size in GB' by pressing edit button as shown on the screen below.

VZ51.png
You will see a popup window, so make sure your browser will not block it.

Edit 'Maximum Allowed' textbox as shown on the following screen.
Afterwards, press 'Save Changes'.

VZ52.png

Hiding Configurable Options

If you decide to hide configurable options from a client order form, follow steps below.

Firstly, go to 'Setup' 'Products/Services' 'Configurable Option'.

VZ53.png
Afterwards, tick 'Hidden' checkboxes next to configurable options you want to hide.

On the screen below you can see hiding of 'Number of Public IP' and 'Number of Private IP'.

VZ54.png

Management of Billing

When you combine Virtuozzo 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.
Note: To set price for specific template you need to have it assigned to product configurable options.

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

Management of Existing Accounts

You can easily use Virtuozzo VPS For WHMCS module with your existing Virtuozzo accounts. To do so, follow the instructions below:

1. Create and configure a Virtuozzo server and a server group.
2. Create and configure a Virtuozzo product. Product configuration should be the same as virtual machine you want to connect to Virtuozzo VPS module.
3. Place new order with previously created product for your customer (it is important to use same hostname as VM you want to use). Do not activate product yet.
4. Go to 'Products/Services' section of freshly created product and press 'Assign VM by Name' , this will only connect VM by UUID, and get IP addresses list.
6. Set product status to 'Active' .

Remember to not click 'Create' button during the entire process. That would unnecessarily create a new virtual machine.

If you decide to remove VM and you do not want to configure it on WHMCS system, create product with its hostname and use 'Delete VM by Name' .
Use 'Delete VM by Name' button with care.
Both 'Assign VM by Name' and 'Delete VM by Name' can be found in admin area of uncreated Virtuozzo VPS product.

VZ56.1.png

How To Update

1. If you switch from Parallels Cloud Server to newer version of Virtuozzo VPS, follow the below steps.

Firstly, download the latest version from your client area.

VZ1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.3.7 up to PHP 5.6.
It does not apply to open source versions.

Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'.

VZ2 1 1.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

VZ2 2.png
4. Then you need to update server settings in 'Products/Services' → 'Servers'. Find more here
5. Finally, update your product details. To do so, move to 'Products/Services' → 'Products/Services'. Find details here.
6. If you are updating from Parallels Cloud Server 1.0.5 or older, you have to make additional changes.

Update configurable options of product using Virtuozzo VPS module.
Update ordered product using Virtuozzo VPS module.

Your module and products have been just successfully updated, good job!

Tips

1. Operations performed on the virtual servers are not executed immediately.

Give your Virtuozzo servers some time for processing the request and execution of operation.

2. To change password, OS on VM has to finish a boot sequence. Password is changed when ready status is detected by cron.
3. You can also check if your server connection is configured correctly.

Go to 'Setup' 'Product/Services' 'Servers' and press 'Test Connection' button next to your server.

VZ56 2.png

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. It can happen that at your 'Module Settings' tab you can get loading gray screen.

Do not worry, it can take a while to download available settings from your PVA server.
But if loading takes too long, check if your server connection credential is set correctly.
Remember, use connection credential to PVA server node, not PVA server itself.

3. When you see message shown on the screen below, it means that you have not installed IP Manager For WHMCS.

This module is needed to manage your IP addresses from Virtuozzo VPS addon, and can be downloaded from here.

VZ57.png
4. It is not advised to use Parallels Cloud Server For WHMCS module with Virtuozzo VPS For WHMCS at the same time.
5. There is no need to update your Parallels Cloud Server For WHMCS to Virtuozzo VPS For WHMCS if you are using WHMCS V5.

In case you use WHMCS V6 and later do the update, Virtuozzo VPS For WHMCS supports WHMCS V7 now!

Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
Virtuozzo VPS For WHMCS