With our module your customers will be able to single-handedly create as many servers as they need and manage aspects like backups, network devices or firewall.
This gorgeous product lets you also conveniently manage servers, IP addresses and clusters owing to 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 user permissions set to 'PVEVMUser '.

File is located in 'modules/servers/proxmoxCloud/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' .

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 user on Proxmox server.

You can check connection with Proxmox server. To do so, 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, click on 'Save Changes' .

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

From dropdown menus choose 'KVM OS Type' , 'Default Storage' , 'Disk Type' and 'CD/DVD-ROM Type' .
Additionally, choose ISO images available for your clients by marking them in 'ISO Image' .
Set network through selecting from 'Network Mode' , 'Network Model' and 'Bridge' dropdown menus.
Type your VM description in 'Container Description' , set backup location in 'Storage' dropdown menu and click 'Save Changes' .

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

Define backup settings in 'Backups' section through selecting values from 'Storage' and 'Backups Routing' dropdown menus.
Backups routing automatically removes the oldest backup when a new backup is created and a backup limit is reached.
Additionally, you can limit the time period for storing backups by providing the number of days into 'Store The Backup For N Days' field.
Furthermore, you can define firewall rules limit and interface to apply rules to.
Finish configuration at 'Module Settings' tab through pressing 'Save Changes' .
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.

Press 'Generate default' next to 'Custom Fields' .
Static Resources: Fill in the fields in 'Default Configuration' section with desired values.
Configurable Resources: Click on 'Generate Default' next to 'Configurable Options' .
Press 'Save Changes' in the bottom of the page.

php -q /your_whmcs/modules/servers/proxmoxCloud/cron/cron.php

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

In order to create a new product you have to add 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.

Afterwards, press 'Add Pool' .
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 used KVM virtualization type, the client area of 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.
To view VM details(1), migrate VM(2) or update VMs node(3), press a specific button.
To view details of virtual server created by your client simply press 'Load Status' button.

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

To see the list of products created and assigned to your Proxmox server simply click on its 'Server Name' .

It enables you to define VM ID ranges configured per product.
any product without ID range defined will be created with ID greater than minimum ID, which can be configured on the same page.

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

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

Choose 'Template' from a dropdown menu 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' .

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

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 servers through pressing a specific button.
Clients can also edit server, access VNC, SPICE and noVNC consoles and view the graphs of resource usage.
Additionally, they are able to create backup, set up backup jobs, access task history and manage network devices.
They can also find here server details and IP addresses assigned to the server.

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

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

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

Afterwards, press 'Add Backup' .

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

Next, press 'Add' button.

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

Depending on the settings of the product, they can also create/remove them.

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

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

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

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

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

Confirm importing through pressing 'Save Changes' button.
Note: If you fill in 'Password' field with an incorrect value, import will be completed successfully but some features may not work for that VM.

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

proxmoxCloud_beforeCreateVM 
proxmoxCloud_afterCreateVM
proxmoxCloud_beforeTerminateVM
proxmoxCloud_afterTerminateVM
proxmoxCloud_beforeCreate
proxmoxCloud_afterCreate
proxmoxCloud_beforeTerminate
proxmoxCloud_afterTerminate
proxmoxCloud_afterSuspend
proxmoxCloud_afterUnsuspend
proxmoxCloud_afterIPAdditionByAdmin
proxmoxCloud_afterIPDeletionByAdmin
proxmoxCloud_afterIPAdditionByUpgrade

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

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

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