With its help, your customers can manage virtual servers, backups, firewall as well as access VNC/SPICE console and much more - all this directly in your WHMCS client area.
Additionally, the module lets you conveniently manage all existing servers, IP addresses and clusters through the unique Proxmox Addon attached to the module.

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

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

File is located in 'modules/servers/proxmoxVPS/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 your client area → 'My Products'.

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

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

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

Choose authentication type from 'Authentication' and 'Proxmox VPS' from 'Type' dropdown menus. 'Save Changes'.

In order to check connection with a Proxmox server, simply press 'Test Connection' as shown on the screen below.

Click on 'Create a New Group'.

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

'Product Type' should be set to 'Dedicated/VPS Server' in order to add nameservers later.

Next, 'Save Changes'.

Available virtualization types:
KVM
LXC (supported by proxmox 4.0 and later)
OpenVZ (supported by proxmox version 3.4 and earlier)
You can also choose how often bandwidth usage should be counted.
Afterwards, press 'Save Changes'.
Note: If you choose 'Auto-Node' as a 'Default Note', new virtual servers will be created on the least used node.

From dropdown menus choose 'KVM OS Type' and 'Default Storage'.
Type your VM description in 'Container Description' and scroll down.
You can also define VM prefix by filling in 'Default KVM Container Prefix' field.
Set 'USe Client name For VPS' to 'Yes' and either the client's comapny or their first/last name will be used as the hostname value.

Additionally, set up backups in 'Backups' section through selecting values from 'Storage' and 'Backups Routing' dropdown menus.
Backups routing automatically removes the oldest backup as soon as a new backup is created and a backup limit is reached.
Type in the number of days into 'Store The Backup For N Days' to remove backups older than the provided number of days.
In 'Firewall Options' section you can set up available interfaces and firewall rules limit.
Important: Keep in mind that the root password is generated automatically for KVM virtualization upon its creation and reset.
There is no possibility to set your own password due to Proxmox API limitations to KVM virtualization.

From dropdown menus choose 'Default Storage' , 'Template' and 'Bridge'.
Enter your virtual servers description in 'Container Description' and press 'Save Changes'.
Remember! This virtualization type is supported only by Proxmox version 4.0. and later
If you are using older version of Proxmox server, you will not be able to start this virtualization.

From dropdown menus choose 'Default Storage' and 'OpenVZ OS Template'.
Additionally, define backup settings at 'Backups' section through selecting values from 'Storage' and 'Backups Routing' dropdown menus.
Backups routing automatically deletes the oldest backup when a new backup is created and a backup limit is reached.
Fill in the number of days into 'Store The Backup For N Days' to remove backups older than the provided number of days.
Type your VM description into 'Container Description' and press 'Save Changes'.

php -q /your_whmcs/modules/servers/proxmoxVPS/cron/cron.phpyou may 

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

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

Next, choose a server from 'Server' dropdown menu and define which virtualization it should be applied to through selecting it from 'Virtualization' dropdown menu.
Afterwards, press 'Add'.

Note! Automatic IP assignment works only for OpenVZ machines.

KVM virtualization does not support IP Management from module. Instead, IP can be assigned via the console.

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

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

You are also able to add an IP address to a product. To do so, press 'Add New IP' as shown on the following screen.

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 - 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 ranged allows you to sort VMs created depending on server they was created from.

You can quickly define VM ID ranges for those servers, press 'Manage' to do so.
Note: VM ID ranged allows you to sort VMs created depending on server they was created from.

In order to convert VM, go to 'Proxmox Addon' → 'Templates' → 'Create Template'.
Choose server on which VM to convert exists and press 'Next Step'.
Important: VM will be destroyed in the process.

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

Cron job user synchronization - if you change 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 list of recovered VMs, allows downloading results.

As you can see, control panel contains options useful for managing VM.
The module allows your customers to easily 'boot', 'reboot', 'stop' and 'shutdown' their servers through pressing a specific button.
Clients can also access 'VNC', 'noVNC' and 'SPICE' consoles. Among 'Additional Tools' you will find options to 'reinstall' server, create 'backup' and set up 'backup jobs'.
Note! Please note that VNC console is available only on Proxmox version 3.4 server.

Your clients are able to access resource usage 'graphs', view VM 'history', manage 'network' interface device and set up 'firewall' rules.
Additionally, in case of Proxmox VPS (KVM) clients may take 'snapshots' and manage 'disks'.

Customers can also view 'DNS' (OpenVZ only) and 'IP Addresses'.

To access it, simply press the 'VNC Console' button. Console requires Java software. You need to accept security risk to run it.
Remember that VNC Console is available for users of Proxmox server version 3.4. only!

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

Afterwards, press 'Add'.

There you can easily edit/delete and preview details of existing backup jobs.
To add a new backup job press 'New Job' as shown on the following screen.

Next, press 'Add' button.

They can also switch the timeline of graphs by choosing it from a dropdown menu pointed on the following screen. Choose from 'Hour', 'Day', 'Week', 'Moth' and 'Year'.

Note: You are allowed to remove only private network interface devices.

As you can see, you can easily modify and remove a 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.

The first way (red) is by choosing macro from a 'Macro' dropdown field.
The second way (blue) consists 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.

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

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

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

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

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

Go to 'Setup' → 'Products/Services' → 'Configurable Option' and press edit button next to the configurable option used by your product.

Now, we will show you how to edit options. Let's say you want to add an option to order VPS with 4 cores per socket.
To do so, edit 'The number of cores per socket' by pressing edit button as shown on the screen below.

To add a new option, enter it in a textbox under all other options, but if you want to replace it with option you currently have, simply edit its textbox.
Finish through pressing 'Save Changes'.

Module allows you to charge your customers basing on the server resources used by them.

1. Create and configure a Proxmox VPS server and a server group.
2. Create and configure a Proxmox VPS product.
3. Place a new order with a previously created product for your customer. Do not activate product yet.
4. Access the just created product from the admin area via client profile → 'Products/Services' section and fill in 4 custom fields.
They are 'vmid' , 'node' , 'storage' and 'backup storage'.
5. If possible, enter IP addresses into fields 'Dedicated IP' and 'Assigned IPs' .
6. Set product status to 'Active' .
Remember, do not click 'Create' button during the entire process. That would unnecessarily create a new virtual machine.

When they are joined into one cluster, you can access all of them by connecting to any.
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).

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.

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

Reason: You have not uploaded 'mgnovnc.html' on to the Proxmox server.
Solution: Extract the module and upload 'mgnovnc.html' file located in 'UploadOnProxmoxServer' on all Proxmox servers into '/usr/share/novnc-pve/' folder.