Personal tools


Proxmox Cloud For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search


About Proxmox Cloud For WHMCS

Proxmox Cloud For WHMCS offers your clients the flexibility to create, remove and freely resize their own virtual servers within resource limits defined by you.

Your customers will be able to single-handedly create as many servers as they need and manage aspects like backups, network devices or firewall.
The module supports Cloud-Init for the KVM virtualization type and features Proxmox Addon allowing you to easily manage servers, IP addresses and clusters.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate User Account
✔ Change Package
✔ Change User Role
✔ Migrate/Import/Delete Server
✔ Edit Server Node
✔ View Server Status, Details And Statistics
✔ View Graphs - With Ability To Change Time Scale of MRTG Graphs
✔ Display Disk And Bandwidth Usage Of Each Product
✔ Display CPU, SWAP and Memory Usage Of Each Product
✔ Select Server Locations Available For Clients
✔ Configure Client Area Features Per Product
✔ Define Static Or Dynamic Resource Limits
✔ Define Server Minimum And Maximum Resource Values
✔ Import IP Address To Hosting IP Addresses Table
✔ Return IP Address To IP Addresses Subnet
✔ Add Additional IP Address To VM
✔ Enable Backups Routing
✔ Enable Auto VM Backups Before Reinstallation
  • Proxmox Addon Features:
✔ Display Servers List Per VPS And Cloud
✔ Manage Public & Private IP Addresses Per Server, VLAN, Tag And Node
✔ Add Additional DHCP Server
✔ Display Servers Clusters
✔ Display KVM Templates
✔ Convert KVM VPS To KVM Template
✔ Set Minimum VM ID For Product Without ID Ranges Defined
✔ Synchronize Users Permissions
✔ VM Cleaner - Manage VM Not Existing In Your WHMCS
✔ Create And Store Full Backup Of VMs Configuration
✔ Manage SSH Key Pairs For KVM Template
✔ View Tasks History
  • Client Area Features:
✔ Create/Edit/Delete Servers
✔ Boot/Reboot/Stop/Shutdown Server
✔ Reinstall Server Using Templates (KVM) And ISO Images
✔ Choose Location For New Servers
✔ View Available Resources
✔ Access noVNC And SPICE Console
✔ Create/Restore/Delete Backups
✔ Manage Backups Within Defined Limits (Max Number Of Files & Max Size Of Files)
✔ Manage Backup Jobs Within Defined Limits (Max Number Of Files & Max Size Of Files)
✔ Create/Upload/Download Public And Private SSH Keys (LXC)
✔ View Graphs - With Ability To Change Time Scale of MRTG Graphs
✔ View Task History
✔ View Network Devices and Manage Private Interface
✔ Manage Private Networks And Assign Them To Multiple Servers
✔ Create Server Snapshots (KVM)
✔ Create VM Template From Server - KVM Virtualization Only
✔ Manage Firewall
✔ View Server Status, Details And Statistics
✔ Display Disk And Bandwidth Usage
✔ Display CPU, SWAP and Memory Usage
✔ Change Boot Order (KVM)
✔ Change ISO Image (KVM)
✔ Choose Server Resources While Ordering And Upgrade/Downgrade Them Freely
  • Configurable Options:
✔ CPU Sockets Limit
✔ CPU Cores Limit
✔ CPU Limit
✔ CPU Weight Limit
✔ Memory Limit
✔ SWAP Limit
✔ Storage Limit
✔ IPv4 Addresses Limit
✔ IPv6 Addresses Limit
✔ Bandwidth Limit
✔ Backups Size Limit
✔ Backups Files Limit
✔ Private Networks Limit
✔ VCPUs Limit
✔ Network Rate Limit
✔ CPU Sockets Limit
✔ CPU Cores Limit
✔ CPU Limit
✔ CPU Weight Limit
✔ Memory Limit
✔ SWAP Limit
✔ Storage Limit
✔ IPv4 Addresses Limit
✔ IPv6 Addresses Limit
✔ Bandwidth Limit
✔ Backups Size Limit
✔ Backups Files Limit
✔ Private Networks Limit
✔ VCPUs Limit
✔ Network Rate Limit
  • General Info:
✔ Supports Cloud-Init (KVM)
✔ Supports PVE And PAM Authentication
✔ Supports KVM and LXC Virtualization
✔ Integrated With Advanced Billing For WHMCS - Actual Server Resource Usage Billing (read more)
✔ Integrated With Proxmox Cloud Autoscaling For WHMCS - Automated Servers Resizing (read more)
✔ Integrated With IP Manager For WHMCS - Complete Management of IP Subnets (read more)
✔ Multi-Language Support
✔ Supports Proxmox VE Up To 5.X
✔ Supports IPv4 and IPv6
✔ Supports Custom Hooks
✔ Supports PHP 5.6 Up To PHP 7.3
✔ Supports WHMCS Template Six
✔ Supports WHMCS 7.4 And Later

Installation and Configuration

This tutorial will show you how to successfully install and configure Proxmox Cloud For WHMCS.

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


1. Log in to our client area and download the module.
PXC2 1.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 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.3.
It does not apply to open source versions.

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

PHP56 73.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.

PX2 2 1.png
4. Open 'UploadOnProxmoxServer' and upload content of the proper version on all Proxmox servers into the '/usr/share/novnc-pve/' folder.
You should upload these files not only during the first installation of the module, but also each time you update it.

Note: If you wish to allow noVNC consoles, you need to configure a product using the PVE realm and set user permissions to 'PVEVMUser.'

5. When you install Proxmox Cloud For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

This file is located in 'modules/servers/proxmoxCloud/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

PXC2 3.png
6. 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 our client area → 'My Products'.

PXC2 4.png

Activation of Proxmox Addon

7. Firstly, you should activate Proxmox Addon.

To do so, log in into your WHMCS and press 'Setup' → 'Addon Modules'. Find 'Proxmox Addon' and press 'Activate'.

Note: The Proxmox addon version might not match the current version of the provisioning module itself. This is completely normal due to the specific structure of the product.

PXC2 5.png
8. In the next step, you need to permit access to this module.

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

PXC2 6.png

Configuration of Server

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

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

PXC2 7.png
10. Next, enter your server name, IP address, username and password.

Choose 'ProxmoxCloud' from a dropdown menu and press 'Save Changes'.
The last step is choosing authentication from the 'Authentication' dropdown menu.
Note: Authentication depends on the realm used by the user on a Proxmox server.

PXC2 8.png
11. After you have configured your server correctly, you will see the following screen.

You can check connection with the Proxmox server. To do so, simply press 'Test Connection' as shown on the screen below.

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

Configuration of Product

14. In order to create and configure a product, go to 'Setup' → 'Products/Services' → 'Products/Services'.

Click on 'Create a New Group'.

PXC2 12.png
15. Enter the product group name and press 'Save Changes'.
PXC2 13.png
16. When you have a product group, you are able to create your product.

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

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

'Product Type' can be set to 'Dedicated/VPS Server' but nameservers will have to be added later.
If you do not want to be forced to fill in nameservrs data, please select 'Hosting Account' instead.

PXC2 15.png
18. Now, go to the 'Module Settings' section, choose both 'ProxmoxCloud' and your previously created server group from dropdown menus.

Next, click on 'Save Changes'.

PXC2 16.png
19. Choose 'Virtualization Type', 'Default Node', 'Template & ISO Storage' and 'User Permission' from dropdown menus.

Available virtualization types:

  • KVM
  • LXC (supported by Proxmox VE 4.0 and later)
  • OpenVZ (supported by Proxmox VE 3.4 and earlier, prior to Proxmox Cloud For WHMCS 2.3.0)

You can also choose how often the bandwidth usage should be calculated.
Afterwards, press 'Save Changes'.
Note: If you choose 'Auto-Node' as 'Default Node', new virtual servers will be created on the least used node.

PXC2 17.png

KVM Virtualization Type

20. Setting of the KVM virtualization type (skip this step if you have chosen the LXC virtualization type).

From dropdown menus, choose 'KVM OS Type', 'Default Storage', 'Disk Type' and 'CD/DVD-ROM Type'.
Choose ISO images available for your clients by marking them in 'ISO Image'.

Set the network through selecting from the 'Network Mode', 'Network Model', and 'Bridge' dropdown menus.
If you are going to allow your clients to manage their private networks, you have to select 'Private Bridge' and set up VLAN TAG Range.
Type in your VM description in 'Container Description', set the backup location in the 'Storage' dropdown menu and click 'Save Changes'.
You may also decide whether you wish to use DHCP software to automatically assign IP addresses - if yes, simply select the option 'ISC DHCP Server'.
Read more about its installation here.

PXC2 18.png

LXC Virtualization Type

21. Setting of the LXC virtualization type (skip this step if you have chosen the KVM virtualization type).

From dropdown menus, choose 'Default Storage', 'Template' and 'Bridge'.
Enter your virtual server description in 'Container Description' and press 'Save Changes'.

Remember! This virtualization type is supported only by Proxmox VE 4.0. and later.
If you are using the previous version of a Proxmox server, you will not be able to start this virtualization.

PXC2 18 1.png

OpenVZ Virtualization Type

22. Setting of the OpenVZ virtualization type (skip this step if you have chosen the KVM virtualization type).

Please note that only Proxmox versions prior to v.2.3.0 support OpenVZ virtualization.

From dropdown menus, choose 'OpenVZ OS Templates', 'Default Storage', 'Network Mode' and 'Bridge'.
Type in your virtual server description in 'Container Description' and press 'Save Changes'.

Remember! This virtualization type is supported only by Proxmox VE 3.4 and previous.
If you are using the latest version of a Proxmox server, you will not be able to start this virtualization.

PXC2 19.png

Finalizing The Configuration

23. Private Network Management - in order to allow clients to manage their private networks, set up the 'Network Device' section properly.
  • Select 'Private Bridge'
  • Select 'Private Network Model'
  • Enter ranges for VLAN TAG

Note: Configure these three options for the KVM and LXC virtualization.
If you skip this step, clients will not be allowed to add private networks.

PXC2 20 1.png
24. The next step is setting up the configuration of backups.

Define backup settings in the 'Backups' section through selecting values from the 'Storage' and 'Backups Routing' dropdown menus.
Backups routing automatically removes the oldest backup when a new backup is created and the established backup limit is reached.
Additionally, you can limit the time period for storing backups by providing the number of days into the 'Store The Backup For N Days' field.
Furthermore, you can define the limit of firewall rules and the interface to apply the rules to.
Finish the configuration in the 'Module Settings' tab through pressing 'Save Changes'.
Important: Keep in mind that the root password is generated automatically for the KVM virtualization upon its creation and reset.
If you want to be able to set your own password on the KVM virtualization, go check the Configuration of SSH Keys.

PXC2 20.png
25. Set up server limits to control the size of created servers.
PXC2 21 1.png
26. The final step is generating custom fields and deciding whether to set up the product with static or configurable resources.

Press 'Generate default' next to 'Custom Fields'.
Static Resources: Fill in the fields in located in the 'Default Configuration' section with desired values.
Configurable Resources: Click on 'Generate Default' next to 'Configurable Options'.
Press 'Save Changes' at the bottom of the page.
Note: While generating 'Configurable Options', it is advisable to delete the ones you do not use, e.g. the swap option or IPv6 for the KVM virtualization.

PXC2 21.png
27. In the end of the product configuration, you have to add a cron job that is shown below (5 minutes interval suggested).
php -q /your_whmcs/modules/servers/proxmoxCloud/cron/cron.php

Do not forget to replace 'your_whmcs' with your WHMCS root location.

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

Configuration of Addon

28. Add a new IP address.

In order to create a new product, you have to add a dedicated IP pool to 'IP Addresses' list in 'Proxmox' addon module.
To do so, go to 'Addons' 'Proxmox Addon' 'IP Management' and press 'New IP Addresses'.
Note: You can add both IPv4 and IPv6 addresses.

PXC2 30.png
29. Type in the desired IP and mask in 'IP Pool' and choose server from 'Server' dropdown menu.

Select 'Private Address' if the added address is of such a kind, clients will be then allowed to add, remove and configure their private network.
Afterwards, press 'Add'.
Note: Automatic IP assignment works only for OpenVZ/LXC machines.
In case of the KVM virtualization, IP addresses have to be manually added to the pool in Proxmox addon or IP Manager to allow their automatic assignment.
Important: Private IP addresses are not downloaded for the IP Manager module.

PXC2 23.png
30. You are now able to create new virtual machines at the product.

If you used the KVM virtualization type, the client area of a successfully created product should look similar to the one presented on the screen below.

PXC2 24 1.png
31. The client area of a product using the LXC virtualization type looks quite similar.
PXC2 25.png
32. This is how an exemplary product details look like in the admin area.

Allowed actions:

  • Create
  • Suspend/Unsuspend
  • Terminate
  • Change Package
  • Change User Role
PXC2 25 1.png

Configuration of SSH Keys (KVM)

Important! Since the 2.5.0 version of the module, if you are using Proxmox VE 5.2 or later, we highly recommended using the Cloud-Init feature instead of following instructions described in this section.

SSH keys are required to enable the automatic resizing of a partition upon the disk upgrade as well as the change of passwords for the KVM virtualization type.
Note - 'Resize Partition', and 'Change Root Password' will only work for newly created VMs with ISC DHCP and Internet access configuration.
We recommend using this option only for new products.

PXC2 65.png
33. First, create a new VM Template that you will use for the KVM image.

Then, generate SSH keys and add the public key to the root account on the newly created VM image. Moreover, upload both ( public and private ) keys on your WHMCS server in a secure location.

PXC2 66.png
34. Next, while in your WHMCS, go to the 'Proxmox Addon' 'Settings' 'SSH Keys' and press 'Add' button.
PXC2 67.png
35. Enter the name and location to the key pairs located on your WHMCS server.

Optionally, you can add a passphrase to increase security.

PX2 64.png
36. Next, go back to the product configuration and, in ' KVM Configuration' 'VM SSH Root Key' , select the pair of keys you want to use.
Enter the SSH communication port and select the preferred features.
Make sure they match the 'KVM OS Template' that will be used.
PXC2 69.png
37. Now, the 'Resize Partition' , 'Change Root Password' and 'Delete VM SSH Root Key' options should be available.
  • Resize Partition - if a customer upgrades a VM by changing the disk size to a larger one, the size of the last partition in that disk will be automatically increased by the newly added value.
    The feature deletes a current partition table, then creates a new one, according to a new disk size, and reboots the VM.
    These partition types have to be standard, e.g. 'Linux Extended' (Ext2/Ext3/Ext4...), 'Linux SWAP' , 'Solaris' or 'LVM' .
    Important - in case of any failure, all data available on the resized partition might be lost!
  • Change Root Password - this option is responsible for the automatic reset of the password after the VM creation. It also allows users to generate a new root password while using the VM.
  • Delete VM SSH Root Key - it will automatically remove the default SSH key after the VM creation. Use this component to increase security or leave unchecked for resizing partition feature.
    Important - if a customer decides to remove the public key from the VM on their own or the 'Delete VM SSH Root Key' is enabled, it will make the 'Resize Partition' and 'Change Root Password' options no longer working!

From now on, clients will be able to set their own password for newly created VMs.

PXC2 70.png
The partition will be also automatically resized during the VM upgrade if a disk size is different than the one set as default in the template.
PXC2 71.png

Cloud-Init (KVM)

Use Cloud-Init to configure the system during installation, first-boot and package change.
Cloud-Init was initially developed to provide early initialization of cloud instances.
Click here to learn more about Cloud-Init configuration.

Note: Cloud-Init functionality is supported for the KVM virtualization only.
IP addresses are automatically assigned if DHCP software is used. Read more about Automatic IP Address Assignent.

Configuration Of Product

To to allow you clients to use cloud-init you need to enable it in the Proxmox product configuration.

Before you start we recommend to learn the details about cloud-init configuration on your Proxmox server - click here for more details.
Once you get familiar with Proxmox cloud-init proceed to Cloud-Init group of your KVM configuration where you can enable it and set the following:

  • Allow To Set Username - if enabled the client can set its own username during VM creation. Otherwise it will remain unchanged and be set by default as in the template or set from the 'Default User' field if provided.
  • Allow To Set Password - if enabled the client can set its own password during VM creation Otherwise it will remain unchanged and be set by default as in the template.
  • Allow To Set SSH Public Key - if enabled the client can upload its own public SSH key in OpenSSH format during VM creation. This will then allow client to log in to VM using their private key instead of password.
  • Default User - provide the username that wille be used for VM instead of using the 'Service Username' field or image's configured default user. Othewise leave empty.
  • Allow To Set DNS Domain - if enabled the client can provide its own DNS domain for a container. During VM creation, the provided setting will be automatically used if neither a search domain nor a nameserver is set.
  • Allow To Set Nameservers - if enabled the client can set its own nameservers for the VM. Otherwise they will remain unchanged and be set by default as in the template.
PXC2 51 new.png
This is how the above settings will look like in the client area during VM creation.
PXC2 55.png

Configuration Of Proxmox Server

The process of setting up Cloud-Init on the Proxmox server is described here.

Additionally you can use the following commands that can be useful for debugging.

  • Re-run cloud init scripts
rm -rf /var/lib/cloud/sem/* /var/lib/cloud/instance /var/lib/cloud/instances/* &&
cloud-init init  &&
cloud-init modules -m final
  • Logs
cat /var/log/cloud-init.log
cat /var/log/cloud-init-output.log


Proxmox Cloud For WHMCS allows your customers to manage their PVE servers in the WHMCS client area.

At the same time, you can monitor and handle each product from your WHMCS admin area.
To view VM details(1), migrate VM(2), update VMs node(3) or delete VM(4), press a specific button.
To view details of a virtual server created by your client, simply press the 'Load Status' button.

PXC2 26.png
On the following screen, you can see loaded details of the VM as well as opened migration popup.

Migration is useful when you want to request migration from the WHMCS admin area, while editing node is practical for updating details after migrating the virtual machine from the Proxmox panel.

PXC2 27.png

Management of Addon

Servers Management

Server List

In 'Addons' 'Proxmox Addon' 'Servers' 'Servers List' you can find configured Proxmox servers.

RAM details:

Assigned - RAM assigned to the server (hosting services only)
Total - full RAM on server
Free - difference between Server Total RAM and RAM Assigned

Suspended - the number of suspended accounts per their size in MB
i.e. (1/500 MB) when there is only one suspended account (size: 500MB of that account) assigned to Proxmox server VPS.
You can quickly define VM ID ranges for those servers, press 'Manage' to do so.
Note: VM ID range allows you to sort the created virtual machines depending on the server they were created from.

PX2 28.png
Define the ID range and save changes.
PX2 29.png
Upon pressing 'Edit' , you will be moved to the server edit page.

VMs List

In 'Addons' 'Proxmox Addon' 'Servers' 'VMs List' you can find details on any Proxmox product.
PX2 28 1.png
Use the 'Toggle Filters' button to find entries that you are interested in.
PX2 28 2.png

Recovery VM Lists

In 'Addons' 'Proxmox Addon' 'Servers' 'recovery VM List' you can find configured Proxmox servers.

Run 'recovery cron job' to create and store full backups of VM configuration.
Use the 'Export to File' button to save information of the cron execution.

PX2 28 3.png

IP Management

In the 'IP Management' tab, you can add, edit and remove IP addresses of Proxmox products.
PXC2 30.png
Fill out the required fields. Here you may also define private IP addresses, simply mark the adequate field.

Clients may manage their private networks and assign IP addresses to VM only if some private IP addresses are added.

PX2 30 1.png


'Clusters' tab contains the list of clusters. To view information about a cluster, simply press its name.
PX2 31.png
Here you can find various information about a cluster, from the available resources to usage graphs.
PX2 32.png

Templates List

On this page, you can view the list of templates and delete the unused ones.
PX2 32 1.png

Create Templates

You can easily convert any virtual machine on your server to a template.

In order to convert the virtual machine, go to 'Proxmox Addon' 'Templates' 'Create Template'.
Choose the server on which the virtual machine that should be converted into a template exists and press 'Next Step'.
Important: The virtual machine will be destroyed in the process.

PX2 33.png
Next, choose the node and the virtual machine to convert.

Fill in 'Template Friendly Name' and press 'Save Changes'.

PX2 34.png

General Settings

'Minimal VMID' allows you to define the minimal ID of a virtual machine created from the server, which does not have the VMID range defined.

Cron job user synchronization - if you change the user role in the product settings, this cron job changes the roles of existing users.
Cron job recovery VM synchronization - run regularly, responsible for updating the list of recovered VMs, allows downloading results.

PXC2 35.png

VM Cleaner

VM Cleaner allows you to track virtual machines existing only on your Proxmox server and that are not visible in your WHMCS.
Consequently, you are allowed here to sort and delete only those virtual machines that are not managed from your WHMCS.
PX2 35 1.png

SSH Keys

SSH Keys section allows you to manage your SSH key pairs that will be used for your KVM virtualization.

These keys will be next used to enable the automatic resizing of a partition upon the disk upgrade as well as the change of a root password on the VM.
For more information, go to the Configuration of SSH Keys section.

PX2 35 2.png

Client Area

Client area interface of Proxmox Cloud For WHMCS allows your clients to create their own virtual servers.

They can also view resources used and manage existing virtual servers.

PXC2 36.png

New Server

In order to add a new server, press 'Add New Server' button.
PXC2 37.png
Afterwards, enter 'Hostname', choose 'OS Type' and select resources for your server by using sliders.

Instead of using the sliders you can also enter resources values into textboxes.
Confirm creation through pressing 'Add New Virtual Server'.
Note! Data to be filled in may differ according to which type OpenVZ or KVM you have chosen.

PXC2 38.png
To manage your virtual server simply press 'Manage' button next to it.

You can find information about managing your virtual servers in next section.

PXC2 39.png
If you do not need a particular virtual server anymore, press 'Delete' button to remove it.
PXC2 40.png

Private Network Management

Move to 'Private Network Management' to add, delete and edit your private networks.

Please keep in mind that this option must be enabled by administrator in your product's 'Module Settings' previously and a private IP address must be added in the Proxmox Addon.
Otherwise you will no be able to add any private network successfully.

PXC2 60.png
In that section you will find all existing private networks with any details such as assigned virtual machines.
To create a new network press 'Add Private Network'.
PXC2 61.png
Type in the name and select virtual machines from available that will have the private IP Addresses assigned.
PXC2 61 1.png
New private network automatically appears on the list. You may edit (1) it or delete (2) whenever needed.
PXC2 61 2.png

Templates Management (KVM Only)

Press 'Templates', you will be redirected to a site where you will find the list of currently created templates along with their details and access to basic actions.
PXC2 62.png
You may edit or delete existing templates. To add a new one, simply press 'Add Template' button.

OS templates do not consume any resources such as CPU sockets, memory etc.
Important! When you convert server into a template, it is consumed in the process! There is no possibility to revert it back.

PXC2 63.png
Select server from dropdown menu and type in its short description. Save changes when ready.
PXC2 64.png

Client Area - VM Management

Client area interface of virtual server should look like the one on the screen below.

As you can see, control panel contains useful options needed for managing VPS.
The module allows your customers to easily boot, stop, reboot and shutdown their VM through pressing a specific button.
Clients can also upgrade server and access VNC, SPICE and noVNC consoles.
Any additional tools are described in details in below sections.

PXC2 41.png

VNC Console

VNC console allows your clients to remotely manage the server. To access it, simply press the 'VNC Console' button.

Console requires Java software and you need to accept security risk to run it.

PX2 39.png

noVNC Console

noVNC console allows your clients to connect with their server in the easiest possible way.
PX2 39 1.png

SPICE Console

Spice console enables you to connect with virtual machine using SPICE.

Note: Your client needs to download and install client side SPICE application in order to connect with VM.

PX2 40.png


Upgrade feature allows you to change server details and resources except 'Template' and 'Password' . To edit your server, click 'Upgrade' button.

Afterwards, alter options you desire and confirm through pressing 'Save Changes' button.

PXC2 42.png

Client Area - Additional Tools


Reinstall feature can be used to reinstall a new OS on the VM by the clients on their own.

You can provide your clients to either select a new OS from a provided KVM templates to automatically system replacement, or let them choose the ISO image for manual system installation.

Note: The ISO images can only be used for the KVM virtualization type, while VM templates can be used either for KVM or LXC.
Additionally the new OS password for the KVM OS reinstallation will be set based on the previous service password while for the LXC user can define it before the new installation.

PXC2 38 1.png
You can configure the available 'KVM OS Templates' for clients in the 'KVM Configuration' .
PXC2 38 2.png
In the same way choose available 'ISO Images' from the can configure the 'CD/DVD-ROM Drive' .
PXC2 38 3.png
Remember to also gain your clients access to selected reinstallation types in the 'User's Options' .
PXC2 38 4.png


To create a single backup, proceed to 'Backups' section and click 'New Backup' as shown on the following screen.
PXC2 47.png
Now choose 'Compress Dump File' and 'Backup Mode' from dropdown menus.

Afterwards, press 'Add' button.

PXC2 48.png
To restore VM from a backup simply press 'Restore' and then click 'OK' button in a popup window to confirm.
PXC2 49.png

Backup Jobs

By pressing 'Backup Jobs' in the client area, you will be carried to a backup jobs management page.

To add a new backup job press 'New Job' as shown on the following screen.

PXC2 50.png
Now, define backup time, mark days to run it and choose 'Compression Dump File' and 'Backup Mode' from dropdown menus.

Next, press 'Add' button. You may also enable email notifications here.

PXC2 51.png

Usage Graphs

Under 'Usage Graphs' page, a client can find graph with CPU usage, memory usage, network traffic and disc I/O.

They can also switch the timeline of the graphs by choosing it from a dropdown menu pointed on the following screen.

PXC2 46.png

Task History

All changes of VM status are listed in 'Task History'.

Additionally, each access to the VM through SPICE console is shown here.

PXC2 52.png


'Network' section allows your clients to view their VM's network interface.

Depending on the settings of the product (private network is used), they can also create/remove them. This feature is optional.

PXC2 53.png

Snapshots (KVM only)

Use snapshot to remember the contents of virtual machine memory current state. You may use them later to restore the VM settings.
PXC2 52 1.png
Press 'Take Snapshot' button and fill out the form to take a snapshot.
Name it (use alphabetical characters only), choose whether to include RAM and add some description.
PXC2 48 11.png


Owing to 'Firewall' page, your clients can set up firewall rules and enable security group for theirs servers from your WHMCS client area.

As you can see, you can easily modify and remove previously added rules and security groups.
To add a new firewall rule (1) or predefined security group (2) use the buttons marked on the following screen.

PXC2 53 1.png
You can add a firewall rule in two ways. Both of them require choosing direction, action, interface, source and destination.

The first way (red) is by choosing macro from a 'Macro' dropdown field.
The second way (blue) consist of choosing protocol and filling source and destination ports out.
Additionally, you can enable rule and add a comment to it.
Press 'Add' to create a rule.

PXC2 53 2.png
Inserting a security group consists of choosing security group and interface on which group has to be used.

Additionally, you can enable security group and add a comment to it.
Click 'Add' to use the security group.

PXC2 53 3.png

Disks (KVM only)

View and manage hard disk within defined limits, add new one or remove additional disks if you wish.
PXC2 52 2.png

Scheduled Task

Proceed to 'Scheduled Tasks' section to view details on any current task.
PXC2 52 3.png

Automatic IP Address Assignment

Automatic IP address assignment can be applied to your Proxmox module, all you need to do is to install 'DHCP' (Dynamic Host Configuration Protocol).
IP addresses will be then automatically requested from a DHCP server. Consequently, the need to manually configure them will be reduced to a minimum.

Important! This option is available only for 'KVM' virtualization type.
Read the below section to learn how to properly install and configure DHCP.

1. First of all, you need to install SSH2 package. You will find precise instructions on how to do that here.
2. Now, you may move to ISC DHCP installation and configuration. Follow the steps below:
  • Install DHCP server package on your Proxmox Node, execute the below command to do so:
sudo apt-get install isc-dhcp-server
  • When ready, configure DHCP server in /etc/dhcp/dhcpd.conf file, run below command to create the file:
sudo nano  /etc/dhcp/dhcpd.conf

Below there is an exemplary content of properly created file: /etc/dhcp/dhcpd.conf.
Take a look at it to see what data should be inside of it:

# Sample /etc/dhcpd.conf
# (add your comments here) 
default-lease-time 600;
max-lease-time 7200;
option subnet-mask;
option broadcast-address;
option routers;
option domain-name-servers,;
option domain-name "mydomain.example";
subnet netmask {
host 1 {hardware ethernet 32:62:39:64:33:33;fixed-address;}
host 2 {hardware ethernet 32:39:61:31:33:66;fixed-address;}

  • Key words: #ProxmoxIPv6 #ProxmoxIPv4 suggesting the usage of a specific type of IP address, must be located in the above mentioned file.
Note: Only key word corresponding to a used IP type is required. If you do not use IPv6 then #ProxmoxIPv6 key word is not obligatory.
  • More info about configuring DHCP server can be found here.
3. Turn on ISC DHCP.

To use automatic IP addresses assignment feature, select 'ISC DHCP Server' option in 'Module Settings' under 'KVM Configuration' section.

PXC2 48 1.png

IP Manager Integration

Owing to integration with IP Manager For WHMCS you are able to easily create IP addresses subnets and assign them to desired products.

Note: This integration works for LXC and KVM virtualization type. OpenVZ is no logner supported.

1. Proceed to IP Manager For WHMCS → Subnets tab in order to prepare IP addresses subnet for Proxmox Cloud For WHMCS.
2. Edit a previously created IP addresses subnet and create custom field 'MAC Address' with desired MAC address at each IP address in the subnet.
More about creating custom fields can be found here.

PX 49.png
3. Afterwards, create a new configuration and assign a previously created subnet to it.

Note: Multiple IP addresses subnets can be assigned to a single configuration.
4. Now, link the configuration with Proxmox Cloud product via product, server or configurable option.
On the following screen we have linked them via a configurable option assigned to the Proxmox Cloud product.

PX 50.png
5. Now, enable integration by proceeding to '3rd Party Integration' tab.

Press 'Activate' next to 'proxmoxCloud' module type as shown on the following screen.

PXC 54.png
6. Next, assign a previously created configuration to the submodule.

Press 'Configure', choose the configuration and press 'Save Changes'.

PXC 55.png

Importing VM

Our module allows you to easily import VM into your cloud product.

To do so, press 'Import VM' as shown on the following screen.

PXC2 45 3.png
Afterwards, select the node on which the server exists and fill in 'VMID' field.

Confirm importing through pressing 'Save Changes' button.

PXC2 45 4.png

Custom Hooks

Our module allows you to use custom hooks, all you need is knowledge of PHP programming language.

Custom hooks are placed in 'your_whmcs/modules/servers/proxmoxCloud/customhooks.php' .
You can find there all custom hooks and basic information about them.
A full list of available custom hooks:


Configurable Options

When you successfully set up a product, your clients can order it by choosing from the default configurable options.

Note! If automatically generated configurable options do not seem to fulfill your clients needs, you can edit them using this guide.

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

Management of Billing

When you combine Proxmox 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 basing on the server resources used by them.

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

Products Autoscaling

If you want to meet the needs of your clients then give them the possibility to scale provisioned servers according to their current load automatically.

To achieve that you need our Proxmox Cloud Autoscaling extension with Advanced Billing For WHMCS product.
Only then, when you have such a combination of products your offer will be full.

With the combination of these three items, you will be able to formulate a set of rules basing on which specified servers will be modified at the right time.

Advanced Billing For WHMCS will bill your clients for the currently used servers and its extension, Proxmox Cloud Autoscaling, will adjust the size of Cloud product to the current needs.



1. Operations performed on the virtual servers are not executed immediately. Give your Proxmox Virtual Environment some time for processing the request and execution of operation.
2. Multiple physical Proxmox servers can be joined into one cluster.

When they are joined into one cluster, you can access all of them by connecting to any of them.
While auto-node creates new VM on the server(node) with the most free resources, server-node creates VM on the server(node) which IP address it has (WHMCS's server configuration).

3. OS Templates are not automatically downloaded while configuring a product.
For each virtualization type, templates are downloaded from the Proxmox server depending on which one of them they are generated for.
4. To name the location accordingly to your needs, within the module change the lang into:
$_LANG['node_X']='Your friendly name for node_X';
5. When PAM authentication is used it is necessary to create a client first in order to change the password correctly. Read more about it here.
6. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.
7. If you currently use the module in the 2.3.2 version or previous, and would like to migrate to Proxmox VE V5.X, you need to update the files on your Proxmox server to the new version from the 'UploadOnProxmoxServer' folder.
8. You can use the 'IPSet IP Filter' option for firewall to prevent IP spoofing. Click here to read more about IP Sets.
9. 'Minimum Network Rate Limit' option allows you to change the previously entered 'Default Network Rate Limit' value to a new one if the current 'Bandwidth Limit' is already exhausted.
Note that the 'Bandwidth Limit' can also be used for WHMCS overage billing calculation as described here.
PXC2 70 1.png

Update Instructions

Essential guidance through the process of updating the module is offered here.

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.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. Error 'Could not create PVE2_API object' during connecting via noVNC console.

Reason: User account does not have permission to access noVNC console.
Solution: Proceed to product's 'Module Settings' tab and check whether selected user permission grant right for noVNC console.
Afterwards, proceed to client's hosting and run 'Change User Role' on it.

3. Error 'This connection is untrusted' during connecting via noVNC console.

Reason: Your certificate is not valid.
Quick Solution: Your client needs to add Proxmox address to certificate exception list.
Best Solution: Configure valid certificate.

4. Blank page during connecting via noVNC console.

Reason: You have not uploaded the additional files on the Proxmox server.
Solution: Open 'UploadOnProxmoxServer' and upload content of proper version on all Proxmox servers into the '/usr/share/novnc-pve/' folder.

5. Error 'Function "ssh2_connect" does not exist. Please Install SSH2 PECL before you start using the script.'

Reason: You have not updated php.ini file
Solution: After SSH2 PECL installation be sure that you have updated php.ini files for CLI and webserver.

6. After you have updated your Proxmox Cloud For WHMCS to Proxmox Cloud For WHMCS V2.0.0, it is always required to save your product configuration in module settings again.
7. If you see an error: 'Invalid VLAN TAG Range' configuration or other when trying to add a new private network, please make sure you have completed all required options in Module Settings.
These are: 'Network Device' → 'Private Bridge', 'VLAN TAG Range From' and 'VLAN TAG Range To'.
8. 'OS Architecture Type ' option for LXC virtualization type is currently not supported as it not implemented in Proxmox itself.
We are sorry for inconvenience.
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
Proxmox Cloud For WHMCS