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.

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

In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.

The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.
Note: Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

The content of the package to upload should look like this.

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

Enter your license key between quotation marks as presented on the following screen.
You can find your license key in our client area → 'My Products'.

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

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

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

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

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

Click on 'Create a New Group' .

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

• Select your product type - use 'Server/VPS Server'
• Select the product group from a dropdown menu
• Enter your product name
• Choose a module name, 'VirtuozzoVPS', from a dropdown menu

Next, click on 'Save Changes'.

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

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.
At the very bottom, you may select "Install Guest Tools" option. Guest tools will be installed into a virtual machine after its creation or reinstallation.
Eventually, select "Enable Console After Creation" option. The remote console will be automatically enabled after the product creation.
If not selected, the console will be disabled by default, but the client will still be allowed to enable it manually if access was permitted in the "Client Area Functions".
Note 1: This option requires "Install Guest Tools" to be enabled if it is used for Virtual Machine type.

Note2: Virtual machine template must have mounted CD-ROM to use guest tools.
Important: 'Guest Tools' are NOT supported if 'Container' type has been selected.

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'. Follow to the 'Management of Configurable Options' section to learn more.
Note: Values which will not be generated in configurable options, will be taken from 'Default Values'.

You can do it by simply selecting/unselecting checkboxes next to a page/functionality you want to enable/disable.
Here, you may also decide which of the OS templates will be available for clients to select when rebuilding the server.

Important: There are different sets of possible options to choose depending on the selected type:
SSH Keys and Snapshots options are supported by 'Virtual Machine' type only (although visible for both types).
Manage Firewall Rules is supported and visible for the 'Container' type only.
ISO Management access is provided only for the 'Virtual Machine' type.

To make OS images available to customers, you must manually upload them to your local Virtuozzo server and then enter the direct paths to them.

For example, you can create '/root/images/' directory and upload to it downloaded OS images that you want to make available to your customers.
Then enter the direct paths to uploaded files in the 'Available ISO Images For Mount' area, separating them from each other with commas and a new lines.
Optionally at the end of the path, you can also add a friendly operating system name after | character, which will be displayed to the client instead of the file name.

Please note that Virtuozzo should support OS images in the following formats: .iso, .cue, .ccd, and .dmg and these images cannot be compressed and/or encrypted.

If you decide to use the option to send the email after the machine has been created, not just the product, you may add to the template extra merger fields that will indicate a list of assigned IP addresses.
These are the extra merge fields that can be added to your custom or edited email template:

• Dedicated IP {$service_dedicated_ip}
• Assigned IPs {$service_assigned_ips}
  

Select the template from dropdown. Email notification will be sent on the virtual machine creation.
You may read more about creating templates and using merge fields in the official WHMCs documentation here.

Your clients should see something similar to the screen below.

Finally, you will find here described all the possibilities that your clients are offered to manage their virtual machines in the client area. Take a look below to learn all of that.

You can also find here a link to Virtuozzo VPS For WHMCS wiki article which you are currently reading.
Make sure you have set up correctly the cron jobs, as it has been said in point number 8 of this manual.

Afterwards, follow steps 9 to 21 of 'Installation and Configuration' instructions.

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

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

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

Provide your configuration name, assign it to Virtuozzo products, addons or server and press 'Create New Configuration' .

To do so, click 'Create New Subnet' button and follow the steps described here.
Note: It is also recommended to enable IP Manager integration module for Virtuozzo VPS. You can find instruction on how to do that here, but you do not have to assign configuration to it.

Go back to the IP Manager configuration list and press the 'Assigned Subnets' button.

You will now have to assign Virtuozzo configurable options that will be used to determine the number of IP addresses from the pool assigned to the Virtuozzo product.
Note: The configurable options are required for IP addresses assignment by IP Manager.
Even if you do not want to use all configurable options for the product, you have to create and assign at least these two:

ip_number|Number of Public IP
ip_number_secondary|Number of Private IP

Click here for more information. If you already have configurable options set, press the 'Configurable Options' button to add a new relation.

Important: If you decide to assign both public and private configurable options, as shown below, then you will also have to assign that configuration to the second network interface (if used).

Repeat the above steps for the second configuration in the same manner, or use the already created configuration to use shared IP pool.

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

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

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.

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.

You may do that on the product page by pressing 'Add SSH' button marked on the screen below.

Important: Adding and downloading SSH keys is supported only if guest tools are installed on the virtual machine.

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

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 Weekly' option.
To create this backup job, press 'Schedule Backup' button.

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.

Important: Along with the decision to restore a backup of your virtual machine, you accept to delete all the created snapshots of your virtual machine.

To create a snapshot simply press 'Create Snapshot' button.

When the snapshot is ready, you will see it on the list with information on its creation date, size and options to revert the snapshot or delete it.

To access it, simply press on the 'Console' button. A new window will be opened, so make sure your browser does not block it.
You may also disable the console od enable it back again whenever needed. Simply, press the 'Disable/Enable Console' button.

Note: If the noVNC console does not work, make sure that it has been enabled in your Virtuozzo panel. There you can also test if it works properly.

In order to establish connection between Virtuozzo and your WHMCS, run the below command on Virtuozzo server:

prlsrvctl set --vnc-ssl-certificate /PathToCert/certificate.crt  --vnc-ssl-key /PathToKey/private.key

Remember that the used here certificate must be generated for the used by Virtuozzo host.

They can 'Enable' / 'Disable' firewall, add new firewall rules, view existing rules list and manage existing rules.
Important: 'Firewall Management' is available only for 'Virtuozzo Container' server type.
Press 'Create New Rule' to add a new one.

• Define a rule chain: 'Input', 'Output' or 'Forward'
• Define the rule policy
• Select protocol
• Provide source and destination: specify IP address and netmask or leave empty to enable for all
• Define source and destination ports - specify ports or enter a port range

There can be found resource usage and graphs of CPU, memory, bandwidth and disk.

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.

Note: This section is available only for the Virtual Machine type.

Clients can unmount the currently used image from here as well as mount other images which paths you provided in the configuration of product.
When mounting, you can make the image bootable and decide to which CD/DVD-ROM it should be mounted, if more than one is available.

Please note that images can only be mounted if the virtual machine is stopped.

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

Now, let us show you how to edit options. Let’s 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.

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

• nodeID|Node

• baseSampleIdVirtuozzo|Base Sample

• osTemplate|OS Template

• cpuunits|CPU Cores

• cpulimit_mhz|CPU Limit

• memory_gb|Memory Size

• ip_number|Number of Public IPs

• ip_number_secondary|Number of Private IPs

• hddSize_gb|Disk Size

• backup_quota_gb|Backup Quota

• io_limit_mb|Disk I/O Limit, Bps

• iops_limit|Disk I/O Limit, Nps

• snapshots_limit|Snapshots Limit

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

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

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.

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.

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

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

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.

Firstly, download the latest version from your client area.

In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later.
If you need a package for the previous versions of PHP, please contact our support.

The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3.
Note: Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

The content of the chosen PHP version files to upload should look like this.

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

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.

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

SQLSTATE[42S02]: Base table or view not found: 1146 Table 'username.pcsNetworkClassConf' doesn't exist.

when configuring product's module settings, make sure that the Virtuozzo addon has been enabled.

In that case, we recommend that you increase the 'wait_timeout' parameter in your MySQL configuration from the default 300 to at least 3600.