Personal tools
Namespaces

Variants
Actions

Proxmox VPS For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search


Contents

About Proxmox VPS For WHMCS

Proxmox VPS For WHMCS is a powerful module whicssh kh allows you to automatically provision virtual servers to your clients.

Your customers will be able to manage virtual servers, backups, firewall, as well as access noVNC, SPICE, or Xterm.js console, and much more - all this directly in your WHMCS.
Additionally, the module provides support for Cloud-Init for the KVM virtualization type, and lets you conveniently control all existing servers, IP addresses and clusters through the built-in Proxmox Addon.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Server
✔ Create/Terminate User Account
✔ Change Package - Supports Configurable Options
✔ Boot/Reboot/Stop/Shutdown Server
✔ Change User Role
✔ Access noVNC, SPICE And Xterm.js Console
✔ Migrate Server Between Nodes In The Same Cluster
✔ Reinstall Server
✔ Change Server Hostname, ISO Image, Boot Devices And SSH Public Key
✔ View Server Status, Details And Statistics
✔ View Graphs - With Option To Change Time Scale of MRTG Graphs
✔ Display Disk And Bandwidth Usage Of Each Product
✔ Display CPU And Memory Usage Of Each Product
✔ Display IP Sets (KVM)
✔ Auto Node - Automatically Create VM On Node With Most Free Space
✔ Configure Client Area Features Per Product
✔ Import IP Address To Hosting IP Addresses Table
✔ Return IP Address To IP Addresses Subnet
✔ Add Additional IP Address To VM
✔ Add Additional Storage To VM (KVM)
✔ Enable Quemu Guest Agent (KVM)
✔ Enable Backups Routing
✔ Enable Auto VM Backups Before Reinstallation
✔ Enable Load Balancer
✔ Receive Notifications About VM Upgrades And Creation Failures
  • Proxmox Addon Features:
✔ Display Servers: List Per VPS And Cloud
✔ List Per VPS And Cloud
✔ Clusters List
✔ VMs List
✔ KVM Templates
✔ Recovery VM Configurations List With Export To Backup File
✔ Tasks History
✔ Statuses, Resources Usage, IP Assignments And Details
✔ Manage Public And Private IP Addresses Per Server, VLAN, Tag And Node
✔ VM Cleaner - Manage VM Not Existing In Your WHMCS
✔ Convert KVM VPS To KVM Template
✔ Define VM IDs Ranges Per Server
✔ Set Minimum VM ID For Product Without ID Ranges Defined
✔ Configure Resource Weights For Load Balancer Prioritization
✔ Synchronize Users Permissions
  • Client Area Features:
✔ Boot/Reboot/Stop/Shutdown Server
✔ Reinstall Server Using Templates (KVM) And ISO Images
✔ Access noVNC, SPICE And Xterm.js Console
✔ Change Server Hostname, ISO Image, Boot Devices And SSH Public Key
✔ Create/Restore/Delete Backups
✔ Manage Backups Within Defined Limits (Max Number And Size Of Files)
✔ Manage Backup Jobs Within Defined Limits (Max Number And Size Of Files)
✔ View Graphs - With Option To Change Time Scale of MRTG Graphs
✔ View Tasks History
✔ View Network Devices And Manage Private Interface
✔ Create Server Snapshot
✔ Manage Firewall
✔ View And Edit Public SSH Key (KVM)
✔ Download Public And Private SSH Keys (LXC)
✔ View Server Status, Details And Statistics
✔ Display Disk And Bandwidth Usage
✔ Display CPU And Memory Usage
✔ Choose Server Resources While Ordering And Upgrade/Downgrade Them Freely
  • Configurable Options:
KVM:
✔ Number Of CPU Sockets
✔ Number Of Cores Per Socket
✔ CPU Limit
✔ CPU Weight For VM
✔ Amount of RAM
✔ Disk Space
✔ Additional Disk Space
✔ Network Rate
✔ IPv4 Addresses
✔ IPv6 Addresses
✔ Backups Size Limit
✔ Backups Files Limit
✔ Bandwidth Limit
✔ VM Template
✔ Network Rate
✔ VCPUs
✔ ISO Image
✔ OS Type
LXC:
✔ Number Of CPU Cores
✔ CPU Limit
✔ Amount of SWAP
✔ CPU Weight For VM
✔ Amount of RAM
✔ Disk Space
✔ Additional Disk Space
✔ Amount of SWAP
✔ IPv4 Addresses
✔ IPv6 Addresses
✔ Backups Size Limit
✔ Backups Files Limit
✔ Bandwidth Limit
✔ VM Templates
✔ Network Rate
  • 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 IP Manager For WHMCS - Complete Control And Easy Assignment Of IP Subnets (read more)
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Most Suitable Servers To Products (read more)
✔ Multi-Language Support
✔ Supports Proxmox VE V6.0 And Previous
✔ Supports IPv4 And IPv6
✔ Supports PHP 5.6 Up To PHP 7.3
✔ Supports WHMCS Template Six
✔ Supports WHMCS 7.6 And Later
✔ Easy Module Upgrade To Open Source Version

Installation and Configuration

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

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

Note: If you are still using any of the module's previous versions prior to v2.7.0, follow these instructions.

Installation

This tutorial will show you how to successfully install and configure Proxmox VPS 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.
PX3 1.png
2. In the downloaded file you might find one or two packages that support different PHP versions.

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.

PHP71 73.png
Previous updates of the module may contain two packages dedicated to various PHP versions.

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.

PHP56 73.png
Important: This situation does not affect the open source version of this module which can be applied to any PHP from version 5.6 and later.
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Once you have chosen the package with the right PHP version, extract it and upload its content into the main WHMCS directory.

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

PX2 2 1.png
4. Open 'UploadOnProxmoxServer' and upload the 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.'
Important: Open Folder UploadOnProxmoxServer/5.2-10 and upload content on all your proxmox servers. Scripts must be updated on proxmox server v2.6.0 to allow Xterm.js console work.

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

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

PX2 3.png
6. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

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

PX2 4.png

Activation of Proxmox Addon

7. Firstly, activate the Proxmox Addon.

To do so, log in to 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 module.

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

PXC3 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 the 'Add New Server' button.

PX2 7.png
10. Next, enter your server name and IP address, you may add any port in the following format: "IpAddress:Port" , that is: 10.10.10.1:8006.

Enter the and password, choose the authentication type from 'Authentication' and 'Proxmox VPS' from the 'Type' dropdown menus. Save changes afterward.

PX3 8.png
11. Time to create a server group. To do so, click on 'Create Server Group'.
PX2 9.png
12. Enter the name, click on your previously created server, press 'Add' and afterward 'Save Changes'.
PX2 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 a product group name and press 'Save Changes'.
PX2 13.png
16. When you have a product group, you can assign your product to it.

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

PX2 14.png
17. Afterward, choose your product group from dropdown menus and point its type, enter your product name and choose Proxmox VPS as a module name.
Press 'Continue'.

'Product Type' can be set to 'Server/VPS' but nameservers will need to be added later (here you can find instructions on how to remove them from your order template).
'Server/VPS' type can also be useful for a more complex display of IP addresses assignment. However, if this is not something you need, you can select 'Shared Account' .

PX2 15.png
18. Now, go to the 'Module Settings' section and choose your previously created server group from the dropdown menu.

The page should reload automatically after the selection. If it doesn't, you may need to click 'Save Changes' .

PX2 16.png
19. Choose 'Virtualization Type' and 'Default Node' from the dropdown menus, and define whether the available resources should be checked before creating a new machine.

Available virtualization types:

  • KVM - short form for Kernel-based virtual machines; used for Qemu (Quick Emulator) which is an open source hypervisor that emulates a physical computer
  • LXC - used for Linux Container as a lightweight alternative to fully virtualized virtual machines

Remember that changing the node will always result in the replacement of the current configuration with the default one. Upon selecting the node, the current configuration should be saved automatically.
If, for any reason, this does not happen, please press 'Save Changes'.

Note: If you choose the 'Auto-Node' as your 'Default Node', new virtual servers will be created on the least used node.
Note 2: An advanced tool is available for you to automatically manage the node selection with the best amount of resources. Read more about Load Balancer.

PX3 17.png

KVM Virtualization Type

20. Setting the KVM virtualization type.

Before you start configuring the KVM virtualization, we highly recommend that you familiarize yourself with the following 'Qemu/KVM Virtual Machines' Proxmox wiki article.

Since the 2.7.0 module version, the basic fields required to create a virtual machine are filled in by default to make the initial setup simpler for you.
Additionally, only the fields that require the administrator's initial attention are expanded by default, while all panel sections with advanced settings are collapsed.

Start your product configuration in the 'Virtual Machine Configuration' panel, where you can set up such features as the used OS template, machine resources and limits or assigned IP addresses.
Note that some fields can be left empty if you want to disable them or set as unlimited - read the tooltips for further guidance.

PX3 18.png
Next, configure 'Network', 'Hard Disk', 'Backup' and so on.

Other panels that are less important or require more knowledge can be expanded according to your needs by clicking on the arrow on the right.

PX3 19.png
Finally, choose which client area features shall be available for your clients.
Do not forget to check out the Finalizing The Configuration chapter.
Other practical information on the product configuration can be also found in the further sections of this documentation.

Save settings when ready.

PX3 20.png
Important: Keep in mind that the root password is by default generated automatically for the KVM virtualization upon its creation and reset.

If you want to set your own password on the KVM virtualization, use the Cloud-Init feature.

LXC Virtualization Type

21. Setting the LXC virtualization type is very similar to KVM.

Before you start configuring the LXC virtualization, we highly recommend that you familiarize yourself with the following 'Linux Container' Proxmox wiki article.

Just as with KVM, the basic fields required to create a virtual machine are filled in by default since the 2.7.0 module version to make the initial setup simpler for you.
Additionally, only the fields that require the administrator's initial attention are expanded by default, while all panel sections with advanced settings are collapsed.

Start your product configuration in the 'Virtual Machine Configuration' panel, where you can set up such features as 'Default Storage', used 'OS Template', container resources and limits or the number of assigned IP addresses.
Note that some fields can be left empty if you want to disable them or set as unlimited - read the tooltips for more information.

PX3 21.png
Next, configure 'Mount Point', 'Backup', 'Network' and so on.

Other panels that are less important or require more knowledge can be expanded according to your needs by clicking on the arrow on the right.

PX3 19.png
Finally, choose which client area features shall be available for your clients.
Do not forget to check out the Finalizing The Configuration chapter.
Other practical information on the product configuration can be also found in the further sections of this documentation.

Save settings when ready.

PX3 22.png
Important: The LXC virtualization type is supported only by Proxmox VE 4.0. and later.
If you use any previous version of a Proxmox server, you will not be able to start this virtualization.


Finalizing The Configuration

22. Afterward, you can create configurable options.

This step is optional - if you want to take it, start by selecting which of the configurable options listed in this table you want to generate.

Note: it is advisable not to generate options that you do not plan to use, or in case you want their fixed values to be taken from the module settings, rather than being flexible.
Moreover, the configurable options differs between the KVM and LXC virtualization types, so create them separately if needed.

More information about configurable options and their edition can be found here.

PX3 23.png
23. At the end of the product configuration, you have to add a cron job as shown below (5-minute intervals are recommended).
php -q /your_whmcs/modules/addons/proxmoxAddon/cron/cron.php queue

Do not forget to replace 'your_whmcs' with your WHMCS root location. The cron can be also executed every single minute in order to perform the action more often.
In the Configuration of Addon settings, you will find the personalized URL for the cron on your server as well as more possible crons to set up for execution.

You have just finished the installation and configuration of the product, congratulations! Be sure to follow the below addon configuration as well to learn how to set up additional features.

Configuration of Addon

24. Proceed to 'Addons' 'Proxmox Addon' 'Settings' 'General Settings' and set up cron jobs listed under the 'Cron' section.

Please note there are separate cron jobs dedicated to Proxmox VPS and Proxmox Cloud, crucial for the seamless operation of the modules. Their suggested frequency is 5 minutes.
If you use only one of the Proxmox products, there is no need to set up separate cron jobs.
The other cron jobs are responsible for:

  • Users synchronization (run once only)
  • VM recovery synchronization (every 5 minutes suggested)
  • VM migration synchronization (every 5 minutes suggested)
  • Tasks synchronization (every 5 minutes suggested)
PXC3 35.png
25. Next, find the 'Minimum VMID' field under the 'Cron' settings.
Fill it in with a number that will be used as an ID of the first VM, the second VM will be assigned the next ID number.
PXC2 35 1.png
26. Adding a new IP address and IP pool (applicable only if you do not use IP Manager For WHMCS).

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

PXC3 30.png
27. Start by typing a desired initial IP address and mask into 'IP Pool'.

Then adjust the mask that will be used to determine the number of generated addresses - remember that different values are used for creation of the same number of IPv4 and IPv6 subnets.
Next, choose a server from the 'Server' dropdown menu and define which virtualization it should be applied to through selecting it from the 'Virtualization' dropdown menu.
Afterward, press 'Confirm'.

PX2 23.png
28. You are now able to create a new product using the previously added IP address.

If you are using the KVM virtualization type, the client area with a successfully created product should look similar to the one on the screen below.
The assigned IP addresses should be displayed on the bottom panel according to the way you configured the IP pools. It looks quite similar in the case of the LXC virtualization type product.

PX3 24.png

Cloud-Init (KVM)

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

Note: Cloud-Init functionality is supported for the KVM virtualization only.

Configuration Of Product

To to use Cloud-Init, you need to enable it in the configuration of the Proxmox product.

Before you start, we highly recommend that you learn the details of Cloud-Init configuration on your Proxmox server first. Click here for more information included directly in the Proxmox wiki article.
Once you get familiar with Proxmox Cloud-Init, proceed to the Cloud-Init group of your KVM configuration where you can enable it as well as configure the following options:

  • Service Username - if enabled, the username for the VM will be taken from the details of the WHMCS 'Products/Services' tab. Otherwise, it will remain unchanged and set by default as in the template or taken from the 'Default User' field if provided.
  • Service Password - if enabled, the password for the VM will be taken from the details of the WHMCS 'Products/Services' tab. Otherwise, it will remain unchanged and set by default as in the template.
  • Service Nameservers - if enabled, the nameservers for the VM will be taken from the details of the WHMCS 'Products/Services' tab. Otherwise, they will remain unchanged and set by default as in the template.
  • DNS Domain - provide a DNS domain for the container. During VM creation, the setting from the host will be automatically used if neither a search domain nor a nameserver is set.
  • Default User - provide the username that will be used for the VM instead of using the 'Service Username' field or the default user of the configured image. Otherwise, leave empty.
  • Custom - here you can optionally specify your custom config files that will be used instead of the automatically generated ones.


PX3 51 new.png
In addition, you can allow clients to enter their own public keys for the VM during the ordering process, so they can log in to the server using their private key instead of a password.
To enable this function, go to the 'Custom Fields' tab and add a new 'sshkeys|SSH Public Key' field, select the 'Text Area' type and the 'Show on Order Form' checkbox.
Note: This custom field is also auto-generated from the module settings, but with the 'Admin Only' option enabled. Remember to uncheck it in order to make this field visible to clients.
PX2 51 2.png
Now, when the client places a new order, they will be able to enter the public key here in the OpenSSH format.
PX2 51 3.png
The SSH public key can also be inserted once the order has been completed. Simply click on the 'Edit' icon on the product's 'Information' panel.
PX3 52.png
The public key can be entered right there in the OpenSSH format. It can be inserted from the admin area as well.
PX3 53.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 purposes:

  • 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

Management

Proxmox VPS allows your customers to manage their PVE accounts via the client area in your WHMCS system.

At the same time, you can monitor and manage each product from your WHMCS admin area.

Admin Area

In the admin area, you are able to view details and manage your clients' machines, access remote consoles, migrate VMs between nodes, assign IP addresses and view resource usage graphs.

  1. Firstly, there are the standard module commands that you can perform on the VM.
  2. Among them, you will find actions to manage the status of the machine, access to remote consoles as well as migration of the server between nodes.
  3. In this panel you will also find the basic information about the VM.
  4. Moreover, you can change the VM hostname, ISO image, bootable devices as well as insert the SSH public key.
PX3 26.png
It is possible to fetch information of network interfaces and OS using the 'Quemu Guest Agent' tool.

This option must be previously enabled in the product configuration, and successfully installed on the VM. Afterward, it should look similar to the image below.

PX3 27 1.png
In the next panel, you can find IPv4 and IPv6 addresses assigned to the VM.
You can either delete or add an IP address to a product. To perform the latter action, press 'Add New IP' as shown on the following screen.
PX3 27.png
Additionally, until the VM has been provisioned, you can manually assign to it the desired IP addresses from the pool by typing them in the 'Assigned IPs' field (available for the 'Dedicated/VPS Server' product type).
This will override the automatic IP address assignment, and the VM will use only the IP addresses you have entered in the mentioned field.

Note: The IP addresses you provide must already exist in the IP Management pool, and cannot be assigned to any other VM. This feature will not work if you already use the IP Manager For WHMCS module.

PX2 27 2.png
In the next two panels, you can view IPSet information as well as reinstall the VM based either on the OS or ISO template.
PX3 27 3.png
Graphs can be useful to monitor the usage of VM resources. You can change the interval by pressing the 'Edit' button, and simply providing a new one.
PX3 27 4.png
In the last part of product management, you can view the user details on your Proxmox servers along with the assigned VMID, node, VLAN tag, and SSH public key provided before the VM creation.
PX3 27 5.png

Management of Addon

Servers Management

Servers List

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

RAM details:

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

Suspended - the number of suspended accounts per size in MB E.g.: (1/500 MB) in case there is only one suspended account that takes up 500MB assigned to the Proxmox VPS server.

PX3 28.png
Through pressing the 'Edit' icon, you will be moved to the server edit page - see the point 10 of Server Configuration.

Press the 'More Details' icon, and you will obtain extended information on the selected server. Look below for more details.

VMs
The 'VMs' tab includes the list of virtual machines created on this server. Take a quick look at information on the domain, status, bandwidth, and IP addresses.

To view information about the VM, simply press the "More Info" icon located on the right side of the page.

PX3 29.png
Check the node and VMID:
PX2 29 1.png
Clusters
The next tab contains the list of clusters with information on uptime, VMS and resource limits, as well as CPU, SWAP, memory and disk usage data.
PX3 29 2.png
Press the "Edit" icon to manage the node:
PX2 29 3.png
Press 'Node Details' , and you will obtain all the summary and usage graphs:
PX3 30 2.png
VM Cleaner
VM Cleaner allows you to track VMs existing only on your Proxmox server, and not in your WHMCS.
Consequently, you are allowed to sort and delete only those VMs that cannot be managed in your WHMCS system.
PX3 31 1.png
Templates
You can view the list of templates on this page. You can easily convert any KVM machine on your server to a template.

In order to convert a VM, press the 'Create Template' button.

PX3 31 3.png
Next, choose a VM that shall be converted.

Fill out the 'Description' field, and press 'confirm'.
Important: The selected VM will be destroyed in the process.

PX2 31 4.png
You may also delete unused templates here. Delete single templates or use the mass action feature to delete templates in bulk.
PX3 31 2.png
Settings
Here you can define the VM IDs range that will be used for newly created machines on this server. Please note that you need to enable the "Use VM Ranges" setting in the product configuration in order to use this feature.
To proceed, define the ID range and save changes.

Note: VM ID range allows you to sort created machines depending on the server they were created on..

PX3 34.png

VMs List

In 'Addons' 'Proxmox Addon' 'Servers' 'VMs List' you can find details of any Proxmox product.
PX3 35.png
Press the 'More Details' button to preview the node and VMID information.
PX2 35 1.png

Recovery VM Lists

In 'Addons' 'Proxmox Addon' 'Servers' 'Recovery VM List' you can view details of the created machine.

Run the 'VM recovery synchronization' cron job to create and store full backups of VM configuration - you can find it in the point 26 of the configuration instructions.
Use the 'Export to File' button to save information in a TXT copy file.

PX3 36.png
Upon pressing the 'Details' icon, you will obtain the information on configuration, status, and DNS:
PX2 36 1.png
PX2 36 2.png
PX2 36 3.png

Tasks History

The "Tasks History" section includes the list of all module tasks with their most crucial details.
You may delete single tasks or use the mass action button to remove them in bulk.

Run the 'Tasks synchronization' cron job to synchronize the tasks, and view all tasks from the server - you can find it in the point 26 of the configuration instructions.

PX3 37.png

IP Management

In the 'IP Management' tab, you can manage the IP addresses of Proxmox products.
You can create both single IP addresses, and IP pools which then can be assigned to created VMs.
PXC2 30.png
When you create a new IP address or a pool, you may define:
  • private/public address
  • servers or nodes that will use them
  • virtualization types (different VMs will use different IP pools)
PX2 30 1.png

IP Manager Integration

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

By activating the IP Manager submodule, settings concerning IP addresses such as 'Configurable Options' and 'Default Options' will be ignored by Proxmox VPS.
Note: This integration works for LXC and KVM virtualization types.

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

PX 49.png
3. Afterward, create a new configuration, and assign the previously created subnet to it.
Note: Multiple subnets can be assigned to a single configuration.

4. Now, link the configuration with Proxmox VPS product via a product, server or a configurable option.
On the following screen, we have carried out the linking via the configurable option assigned to the Proxmox VPS product, where each of the fields represents the number of assigned IP addresses.
You can, of course, mix them according to your needs, e.g. a single configurable option will assign the provided numbers for both IPv4 and IPv6 addresses.

PX 50.png
5. Next, enable the integration by moving to the '3rd Party Integration' tab.

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

PX 51.png
6. Afterward, assign the previously created configuration to the submodule.

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

PX 52.png
If you encounter an error like the one on the screen below, while integrating the two products, it may mean the function 'mb_strlen' is not enabled by default.
In this case, please read this manual for installation instructions.
PX 52 1.png
It is possible to add VLAN Tag Custom Filed in the very same way as the "MAC Address" field.

Look above for the detailed instruction on how to proceed, follow the steps 1-6 to create a new custom field.
The only element you need to change is the custom field name, which should be 'Tag' in this case.

PX 49 1.png

Settings

Load Balancer

Load Balancer is an advanced tool that allows smooth rotation between nodes so as to find the most preferable one, and create virtual machine on it.

Set the weight of the resource that will prioritize its selection when sorting the nodes according to the free resources.
Note: The lowest possible weight is 1. You cannot set, e.g. 0.5.

PX2 30 4.png
In order to use the Load Balancer, you need to enable it in the product's configuration:

Define the behavior of the tool:

  • On Upgrade - select the action to perform:
    • None - no action will be triggered
    • Block - the upgrade process will be blocked as there are insufficient resources on the node
    • Migrate - the upgrade process will be performed after the previous migration of the VM to a server with sufficient free space
  • Shutdown VM on Upgrade
  • Stop VM If Shutdown Fails
PX3 30 5.png
Node Prioritization Method
Have a look at how the sorting process works, and the rules that it goes by.

Let's take exemplary weights for each resource just like the ones presented on the screen above.

VMs Number Weight: 1,5
CPU Weight: 2
Disk Weight: 4
RAM Weight: 2,5

"Disk Weight" with the highest weight, which means it has the highest priority, and "VMs Number Weight" as the least crucial factor on a given node.

In this case, there are four nodes created, named A, B, C, and D, with current resources as shown below:

Node A (Free Ram: 60%, Free CPU: 20%, Free Disk Space: 50%, Number of VMs: 5) 
Node B (Free Ram: 30%, Free CPU: 70%, Free Disk Space: 40%, Number of VMs: 10)
Node C (Free Ram: 90%, Free CPU: 50%, Free Disk Space: 20%, Number of VMs: 20)
Node D (Free Ram: 80%, Free CPU: 60%, Free Disk Space: 70%, Number of VMs: 15)

The next step is sorting the nodes according to each resource, it is done by assigning them corresponding priorities from 1 to 4.
The higher the priority, the more free resources available.

Priority Free Ram Free CPU Free Disk Space Number of VMs
4 Node C Node B Node D Node A
3 Node D Node D Node A Node B
2 Node A Node C Node B Node D
1 Node B Node A Node C Node C
Now, the final calculation of sorting nodes according to free resources is performed, taking into account the previously defined weights.

The process of sorting nodes is based on the following calculation method:

Final Node Priority = (RAM Priority x RAM Weight) + (CPU Priority x CPU Weight) + (Free Disk Priority x Disk Weight) + (No. VMs  Priority x VMs Weight)

The results for nodes A, B, C and D (with weights and sorting priority) are as follows:

Node A: (2 x 2,5) + ( 1 x 2 ) + ( 3 x 4 ) + ( 4 x 1,5 ) = 25
Node B: (1 x 2,5) + ( 4 x 2 ) + ( 2 x 4 ) + ( 3 x 1,5 ) = 23
Node C: (4 x 2,5) + ( 2 x 2 ) + ( 1 x 4 ) + ( 1 x 1,5 ) = 19,5
Node D: (3 x 2,5) + ( 3 x 2 ) + ( 4 x 4 ) + ( 2 x 1,5 ) = 32,5

As you can see, Node D has got the highest priority value with the result: 32,5.
It will be selected by Load Balancer to create a new VM on, or to migrate or upgrade an existing VM if its current node does not have sufficient resources.

The above described calculations are performed every time, 'Create' or 'Upgrade' actions are executed based on the current usage of resources on available nodes.

Important: In case a given client already has a VM existing on a node, this very node will NOT be taken into account during the prioritization of resources.
These security measures are taken to ensure that, in case of node failure, the client will still have access to the other VM server, created on another, properly working node.
At the same time, if this client has VMs on every node already, all of them will be taken into account during the prioritization process again.

If you decide to use the Load Balancer tool, define the resource weights to adjust the prioritization of nodes according to your needs.

Tasks

In the "Tasks" section, you will find tasks that have already been completed, are still in progress, or are yet to be executed by the cron.
Moreover, by clicking the 'Information' button, you can display more data on the particular task.
PX3 30 6.png
In the information tab, you can see which specific product/service the chosen task was related to.
Moreover, in logs, you can check the API response errors with each timestamp it was returned.

Note: The logs will be displayed only in case the errors occurred. If the task has finished successfully, there will be nothing to see.

PX3 30 7.png
PX3 30 8.png
If you notice that, for instance, a certain task cannot be completed due to some errors, you can remove it, so the cron no longer attempts to execute it after each iteration.
After you figure out what went wrong, you can try to add it again, and check the results.
PX3 30 9.png

Client Area

The client area interface of Proxmox VPS For WHMCS should look like the one on the screen below.

As you can see, the control panel contains assorted options that will prove highly useful in VM management.
The module allows your customers to easily 'start', 'reboot', 'stop' and 'shutdown' their servers through pressing specific buttons.
Clients can also access the 'noVNC' , 'SPICE' and 'Xterm.js' consoles. Among 'Additional Tools' , you will find options to 'reinstall' a server, create a 'backup' or set up 'backup jobs'.

Your clients are able to access resource usage 'graphs', view the VM 'history', manage the 'network' interface device, and set up the 'firewall' rules. Additionally, clients may take 'snapshots' , and manage 'disks'.
On the main product page in the client area, under the 'Information' headline, your clients can find such details as the current usage of CPU, memory, disk (LXC only) and SWAP (LXC only).
Customers can also view 'DNS' (LXC only) as well ass assigned 'IP addresses'.

Note: The bellow example image was taken from the KVM-based VM, but it will looks very similar in the case of LXC.

PX3 24 1.png
By clicking the 'Edit' button next to the 'Information' headline, your clients can additionally change the VM hostname and ISO image, choose boot devices, as well as insert their SSH public key.
PX3 24 2.png
PX3 24 3.png

Client Area - VM Management

noVNC Console

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

SPICE Console

SPICE console enables you to connect to the virtual machine using SPICE.

Note: Since the 2.7.0 version of the module, your clients no longer need to download and install the client side SPICE application in order to connect with a VM. The console will be now opened in the virt-viewer instead.

PX2 40.png

Xterm.js Console

Xterm.js console enables you to connect to the virtual machine using Xterm.js.

You have to update the scripts on Proxmox v2.6.0. To do so, open the folder: UploadOnProxmoxServer/5.2-10 and upload the content on all your Proxmox servers.

PX2 40 1.png

Client Area - Additional Tools

Reinstall

The "Reinstall" feature can be used to reinstall a new OS on the VM directly by the clients.

You can allow your clients to either select a new OS from the provided KVM templates to automatically replace the system, 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, both KVM and LXC users can define the new OS password before a new installation.

PX3 38.png
PX3 38 1.png
Remember to grant your clients access to the selected reinstallation types in the 'Client Area Features' , as well as choose the available 'OS Images' and 'ISO Images' .
PX3 38 4.png

Backups

To create a single backup, press the 'Backups' button, and click on 'New Backup' as shown on the following screen.
PX3 41.png
Now, choose the compression type ( 'None' , 'LZO' or 'GZIP' ) and the backup mode ( 'Snapshot' , 'Suspend' or 'Stop' ) from dropdown menus.
Afterward, press 'Confirm'.
PX3 42.png
To restore a VM from the backup, press 'Restore' , and then click the 'Confirm' button in a popup window.
PX3 43.png

Backup Jobs

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

You can easily edit or delete, as well as preview the details of existing backup jobs there.
To add a new backup job, press 'New Job' as shown on the following screen.

PX3 44.png
Now, define the backup start time, choose the days when to run it, and select 'Compression Type' and 'Backup Mode' from dropdown menus.
Also, select if you want to receive the notification when the backup is ready.

Finally, press the 'Confirm' button.

PX3 45.png

Graphs

Through pressing the 'Graphs' button, clients will be moved to the page with the generated graphs showing the CPU and memory usage, network traffic, and disk I/O.

They can also switch the timeline of graphs by choosing a new one from a dropdown menu indicated on the following screen. Clients can pick between 'Hour', 'Day', 'Week', 'Moth' and 'Year'.

PX3 46.png

Task History

To access the history of a machine, simply press the 'Task History' button. Afterward, the customer can see all the actions performed on the VM, as well as their status.

If an error has occurred during the execution of a task, the client can view the API response error by clicking on the 'Information' icon.

PX3 47.png
PX3 47 1.png

Network

Your clients are allowed to add and remove only private network interface devices. Upon clicking the 'Information' button, the new popup will open with more network details.

Keep in mind that ' Network device' options have to be set to 'Private'.
Also, after the network creation, the button to add another one or delete a newly created private network may not be longer available, depending on your Proxmox configuration.

PX3 48.png
PX3 48 1.png

Snapshots

Use a snapshot to remember the current contents of the virtual machine memory. You may use them later to restore the VM's settings.
PX3 48 4.png
Press the 'Take Snapshot' button and fill out the form to take a snapshot.
Name it (use the alphabetical characters and no spaces), choose whether to include RAM, and add a description.
PX3 48 5.png

Firewall

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

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

PX3 48 0.png
You can add a firewall rule in two ways. Both of them require choosing a direction, action, interface, source, and a destination.

The first way (orange) is to choose macro from the 'Macro' dropdown field.
The second way (blue) requires you to choose a protocol and fill in both the source and destination ports.
Additionally, you can enable a rule, and add a comment to it.
Press 'Add' to create a rule.

PX3 48 2.png
Choose a security group and an interface which the group will be used on.
Additionally, you can enable a security group, and add a comment to it.

Click 'Add' to use the security group.

PX3 48 3.png

Firewall Options

Here you can view the current firewall settings. To decide on its options, press the 'Edit' button, and adjust them to your needs.
PX3 48 7.png
PX3 48 7 1.png

Disks (KVM only)

View available disks and add new ones.
PX3 48 6.png
Define the additional disk size, choose its bus (the available options may be 'IDE', 'SATA', 'VIRTIO' or 'SCSI' ), as well as define a disk format - you can choose from 'Raw disk image (raw)', 'QEMU image format (qcow2)', or 'VM image format (VMDK)' .
PX3 48 8.png

Configurable Options

When you successfully set up a product, your client can order it by choosing from the default configurable options.
PX2 53.png
In case those options do not suit your needs, you can edit them.

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

PX2 54.png
Here you can view all the products this configurable option group is assigned to.

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

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

To add a new option, enter it in the textbox located below all other options. If you want to replace the option you currently have, simply edit the textbox.
Finish by pressing 'Save Changes'.

PX2 56.png
More information about WHMCS configurable options and their editing can be found here.

List of Configurable Options

The table below lists all configurable options used by the module for the chosen virtualization type.
Note that the name on the left is a variable (which you should not edit), separated by the | from the editable custom name.

KVM
LXC
The number of CPU sockets|CPU Sockets
cores|CPU Cores
The number of cores per socket|CPU Cores
cpulimit|Limit Of CPU
cpulimit|Limit Of CPU
CPU weight for a VM|CPU Weight For The VM
CPU weight for a VM|CPU Weight For The VM
Amount of RAM|Amount Of RAM
Amount of RAM|Amount Of RAM
Disk Space|Disk Space
Disk Space|Disk Space
Amount of SWAP|Amount Of SWAP
additionalDisksSpace|Additional Disks Space
IP Addresses|IPv4 Addresses
IP Addresses|IPv4 Addresses
IPv6 Addresses|IPv6 Addresses
IPv6 Addresses|IPv6 Addresses
Backups Limit|Backups Size
Backups Limit|Backups Size
Backups Files Limit|Backup Files
Backups Files Limit|Backup Files
Bandwidth|Bandwidth
Bandwidth|Bandwidth
VM Template|VM Template
VM Template|VM Template
Network Rate|Network Rate
Network Rate|Network Rate

vcpus|VCPUs
ISO Image|ISO Image

osType|OS Type

Management of Billing

When you combine Proxmox VPS For WHMCS with Advanced Billing For WHMCS, you will be able to set up additional billing options.

The module allows you to charge your customers based on the server resources they have used.
Note: Advanced Billing supports OpenVZ (prior to Proxmox v2.3.0), KVM and the LXC virtualization type.

PX3 57.png
With Advanced Billing For WHMCS module, you can also display the current resource usage of your customer's server, as well as its total cost.
PX3 58.png

Management of Existing Accounts

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

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 the previously created product for your customer. Do not activate the product yet.
4. Access the just created product from the admin area via the Client Profile → 'Products/Services' section and fill out 4 custom fields.
They are 'vmid' and 'node' .
5. If possible, enter IP addresses into fields 'Dedicated IP' and 'Assigned IPs' .
6. Set the product status to 'Active' .
Remember not to click the 'Create' button during the entire process. That would unnecessarily create a new virtual machine.

Servers Location Management

Important: Server Allocator For WHMCS is required to allow location management.

In order to allow defining locations for Proxmox VPS, follow the below steps:
1. In your product's 'Module Settings' , set up 'Default Node' to 'Server-Node'.
2. Create a WHMCS server for each Proxmox node.
3. Manually create a configurable option, name it e.g.: 'Location'. Add options for each server within that configurable option.
4. Install our Server Allocator For WHMCS module and configure it properly.

It must assign a server to a product depending on the selected option in 'Location' configurable option.

Keep in mind that all locations need to have exactly the same configuration.

Now, a client may order a VPS, and select 'Location'. Server Allocator For WHMCS will change the server assigned to the product.

The "Create" action is triggered on the assigned server due to the 'Server-Node' option enabled.

Tips

1. Operations performed on the virtual servers are not executed immediately. Give your Proxmox Virtual Environment some time to process the request and execute the 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 just one.

  • Auto-node - creates a new VM on the server (node) with the most free resources, so the administrator cannot control it.
  • Server-node - Creates a VM on the server (node) whose IP address or node host (e.g. node1.yourproxmox.com) was provided during the WHMCS's server configuration,
    allowing the administrator to control the node choice.
3. If you set the product type to 'Hosting Account' when adding a new product, you will not need to fill out nameservers as they will be automatically set up.
But if you still want to use the 'Server/VPS' product type, this article might help you in learning how to remove nameservers from your order template.
4. 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 they are generated on.
5. OS Templates are loaded from the storage. Make sure the module can access its content by selecting appropriate permissions for the chosen storage.
6. Due to API limitations, KVM virtualization supports only graphs concerning 'Bandwidth'. Other virtualizations support all graphs.
7. When the PAM authentication is used, it is necessary to create a client first in order to change the password correctly. Read more about it here.
8. As this module supports the templates system, any changes made in the module's template files will be saved after the upgrade process.
9. If you are using the module in the 2.3.2 version or any previous one, 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.
10. OS Templates serve only as operating systems for the VM, while VM Templates contain complete configuration of the VM, the amount of resources included.
11. You can use the {$service_assigned_ips} tag in your welcome email template to display automatically assigned IP addresses for the created VM (either the KVM or LXC virtualization type).
12. 'One User Per VPS' option allows you to either create a new username for each new client's VM, or create only one that will be then used for every new VM owned by your client.
13. You can use the 'IPSet IP Filter' option for firewall to prevent IP spoofing. Click here to read more about IP Sets.

Inside the admin area, in the product details view, you can preview the current IP Sets on VM:

PX3 68.png
14. You can enable 'Admin Notifications' on product configuration to be informed via email about certain actions. These are:
  • Service Creation Failed - if there were any errors that prevented the VM from being successfully created, then the selected email template will be sent to the administrator
  • Upgrade - select the email notification template you want to receive if the client requests the product upgrade.
    This will also block the automatic sending of an upgrade request to the Proxmox API, so the administrator can review it first.
    Note that, if chosen, the product will still be upgraded in the WHMCS itself, but the upgrade request will not be passed to the API.
    To finalize the upgrade, use the "Change Package" module command in your admin area.
  • To-Do List - if checked, in addition to sending any of the above notifications, it will also add them as tasks on the WHMCS To-Do List.
PX3 69.png
15. The 'Minimum Network Rate Limit' option allows you to change the previously entered 'Network Rate Limit' value to a new one if the current 'Bandwidth Limit' is already reached.
Note that the 'Bandwidth Limit' can also be used for the WHMCS overage billing calculation as described here.
PX3 70.png
16. 'Default Username Prefix' - when filling in this field you may use the {$serviceid} parameter to avoid problems with creating usernames that already exist.

Update Instructions

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

Please note that each time you update the module, you have to also update the files on the Proxmox server described in the step 4 of the installation guide.

Important: After upgrading the module to the newest version please first enter to the Proxmox addon in your WHMCS before setting up the product or opening it from admin or client area!
Otherwise, when you try to open the product's module settings, you may get SQLSTATE" "Base table or view not found" errors.

Please also note that since 2.7.0 module version the commands for the crons execution have slighty changed - although the old ones should still work, we recommend that you update their entries.


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 the noVNC console.

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

To change the user role for all clients, please use the 'Cron job users synchronization (run only once)' cron command.
You will find it in the 'Proxmox Addon' → 'General Settings'.

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

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

4. The 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 the proper version on all Proxmox servers into the '/usr/share/novnc-pve/' folder.

5. Error 'Change password failed: user 'xxx' does not exist'

Reason: You have not created a client yet.
Solution: When the 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. Error 'Function "ssh2_connect" does not exist. Please Install SSH2 PECL before you start using the script.'

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

7. Once you have updated your Proxmox VPS For WHMCS to Proxmox VPS For WHMCS V2.0.0, it is always required to save your product configuration
in the module settings again.
8. The current disk usage for the KVM virtualization type is not properly displayed.
This is due to API limitations that lead to returning the incorrect value, which is always set to '0' .
9. If you want to use Cloud-Init on Debian, we recommend using the Cloud-Init's version 18.2 or later to avoid assorted problems occurring in previous versions.
10. Error: "Only root can set 'serial0' config".

Solution: Turn off the Xterms.js console in the product configuration.

11. Error "Parameter verification failed. ([maxfiles] - Only root may set this option.)"

Reason: The user is other than "root" or the server authentication is set to Proxmox VE.
Solution: In the server configuration, set the root details, and select PAM as the authentication type.

Navigation
WHMCS Modules
WHMCS Translations
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
Proxmox VPS For WHMCS