Personal tools
Namespaces

Variants
Actions

Proxmox VE VPS For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Management of Existing Accounts)
Line 115: Line 115:
 
*'''Additionally:'''
 
*'''Additionally:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports PVE And PAM Autentication
+
|style="padding: 10px 0px 0px 30px;"|✔ Supports PVE And PAM Authentication
 
|}
 
|}
 
{|
 
{|
Line 215: Line 215:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
−
Enter your licence key between quotation marks as presented on the following screen.<br />
+
Enter your license key between quotation marks as presented on the following screen.<br />
−
You can find your license key at your client area → '' 'My Products' '' .
+
You can find your license key at your client area → '' 'My Products' ''.
 
|}
 
|}
 
{|
 
{|
Line 225: Line 225:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'''5. Firstly we should activate Proxmox Addon.''' <br />
 
|style="padding: 10px 0px 15px 15px;"|'''5. Firstly we should activate Proxmox Addon.''' <br />
−
To do so, log in into your WHMCS and press '' 'Setup' → 'Addon Modules' ''. Find'' 'Proxmox Addon' ''and press'' 'Activate' ''.
+
To do so, log in into your WHMCS and press '' 'Setup' '' → '' 'Addon Modules' ''. Find '' 'Proxmox Addon' '' and press '' 'Activate' ''.
 
|}
 
|}
 
{|
 
{|
Line 232: Line 232:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''6. In next step you need to permit access to this module.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''6. In next step you need to permit access to this module.'''<br />
−
To do so click on 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.  
+
To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes' ''.  
 
|}
 
|}
 
{|
 
{|
Line 240: Line 240:
 
==Configuration of Server==
 
==Configuration of Server==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''7. Now we will show you how to configure a new product.''' <br />
+
|style="padding: 10px 0px 15px 15px;"|'''7. Now, we will show you how to configure a new product.''' <br />
−
Go to '' 'Setup' → 'Products/Services' → 'Servers' '' and press '' 'Add New Server' ''.
+
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server' ''.
 
|}
 
|}
 
{|
 
{|
Line 247: Line 247:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. Next, enter your server name, IP address, username and password. Choose '' 'Proxmox VPS' '' from a dropdown menu and press '' 'Save Changes' ''.'''<br />
+
|style="padding: 0px 0px 10px 15px;"|'''8. Next, enter your server name, IP address, username and password. Choose '' 'Proxmox VPS' '' from a dropdown menu and press '' 'Save Changes' ''.'''
 
|}
 
|}
 
{|
 
{|
Line 253: Line 253:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. After you configure your server correctly, you will see a following screen. ''' <br />
+
|style="padding: 0px 0px 15px 15px;"|'''9. After you configure your server correctly, you will see a following screen.''' <br />
−
You can check connection with Proxmox server, simply press'' 'Test Connection' '' as shown on screen below.  
+
You can check connection with Proxmox server, simply press '' 'Test Connection' '' as shown on screen below.  
 
|}
 
|}
 
{|
 
{|
Line 266: Line 266:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''11. Enter name, click on your previously created server, press '' 'Add' '' and afterwards'' 'Save Changes' ''. '''
+
|style="padding: 0px 0px 20px 15px;"|'''11. Enter name, click on your previously created server, press '' 'Add' '' and afterwards '' 'Save Changes' ''.'''
 
|}
 
|}
 
{|
 
{|
Line 274: Line 274:
 
==Configuration of Product==
 
==Configuration of Product==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''12. In order to create and configure a product click on '' 'Setup' → 'Products/Services' → 'Products/Services' ''.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''12. In order to create and configure a product click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
 
Click on '' 'Create a New Group' ''.   
 
Click on '' 'Create a New Group' ''.   
 
|}
 
|}
Line 294: Line 294:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''15.  Afterwards choose your product group and type from dropdown menus, enter your product name and press '' 'Continue' ''.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''15.  Afterwards, choose your product group and type from dropdown menus, enter your product name and press '' 'Continue' ''.'''<br />
 
'' 'Product Type' '' should be set to '' 'Dedicated/VPS Server' '' in order to add nameservers later.
 
'' 'Product Type' '' should be set to '' 'Dedicated/VPS Server' '' in order to add nameservers later.
 
|}
 
|}
Line 301: Line 301:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''16. Now go to '' 'Module Settings' '' section, choose both 'Proxmox VPS' and your previously created server group from dropdown menus.<br />
+
|style="padding: 0px 0px 15px 15px;"|'''16. Now go to '' 'Module Settings' '' section, choose both '' 'Proxmox VPS' '' and your previously created server group from dropdown menus.<br />
 
Next, click on '' 'Save Changes' ''.'''
 
Next, click on '' 'Save Changes' ''.'''
 
|}
 
|}
Line 308: Line 308:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''17. From dropdown menus choose '' 'Virtualization Type' '', '' 'Default Node' '' and '' 'Template & ISO Storage' '' .<br />
+
|style="padding: 0px 0px 15px 15px;"|'''17. From dropdown menus choose '' 'Virtualization Type' '', '' 'Default Node' '' and '' 'Template & ISO Storage' ''.'''<br />
−
Afterwards press '' 'Save Changes' ''.
+
Afterwards, press '' 'Save Changes' ''.
 
''Note: If you choose 'Auto-Node' as 'Default Note', new virtual servers will be created on the least used node.''
 
''Note: If you choose 'Auto-Node' as 'Default Note', new virtual servers will be created on the least used node.''
 
|}
 
|}
Line 317: Line 317:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''18. Setting of KVM virtualization type. (skip, if you have chosen OpenVZ virtualization type)'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''18. Setting of KVM virtualization type. (skip, if you have chosen OpenVZ virtualization type)'''<br />
−
From dropdown menus choose '' 'KVM OS Type' '', '' 'Storage' '', '' 'Disk Type' '', '' 'CD/DVD-ROM Type' '', '' 'ISO Image' '', '' 'Network Mode' '', '' 'Network Model' '', '' 'Bridge' '', '' 'Node' '' and '' 'Storage' '' .<br />
+
From dropdown menus choose '' 'KVM OS Type' '', '' 'Storage' '', '' 'Disk Type' '', '' 'CD/DVD-ROM Type' '', '' 'ISO Image' '', '' 'Network Mode' '', '' 'Network Model' '', '' 'Bridge' '', '' 'Node' '' and '' 'Storage' ''.<br />
−
Type your VM description in '' 'Container Description' ''and click '' 'Save Changes' ''.
+
Type your VM description in '' 'Container Description' '' and click '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
Line 326: Line 326:
 
|style="padding: 0px 0px 15px 15px;"|'''19. Setting of OpenVZ virtualization type. (skip, if you have chosen KVM virtualization type)'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''19. Setting of OpenVZ virtualization type. (skip, if you have chosen KVM virtualization type)'''<br />
 
From dropdown menus choose '' 'OpenVZ OS Template' '', '' 'Target Storage' '', '' 'Node' '' and '' 'Storage' ''.<br />
 
From dropdown menus choose '' 'OpenVZ OS Template' '', '' 'Target Storage' '', '' 'Node' '' and '' 'Storage' ''.<br />
−
Type your VM description in'' 'Container Description' ''and press '' 'Save Changes' ''.
+
Type your VM description in '' 'Container Description' '' and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
Line 337: Line 337:
 
|style="padding: 0px 0px 20px 25px;"|[[File:PX19_1.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:PX19_1.png]]
 
|}
 
|}
−
 
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|By doing so, you have just added a custom field 'vmid' and configurable options shown on the screen below.<br />  
 
|style="padding: 0px 0px 15px 15px;"|By doing so, you have just added a custom field 'vmid' and configurable options shown on the screen below.<br />  
Line 351: Line 350:
 
==Configuration of Addon==
 
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''20. Adding new IP address'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''20. Adding new IP address.'''<br />
−
In order to create new product you have to add product'' 'Dedicated IP'' ' to '' 'IP Addresses' '' list in '' 'Proxmox' '' addon module.<br />
+
In order to create new product you have to add product '' 'Dedicated IP'' ' to '' 'IP Addresses' '' list in '' 'Proxmox' '' addon module.<br />
−
To do so, go to'' 'Addons' → 'Proxmox Addon' → 'IP Management' ''and press '' 'Add Pool' ''.<br />
+
To do so, go to '' 'Addons' '' → '' 'Proxmox Addon' '' → '' 'IP Management' '' and press '' 'Add Pool' ''.<br />
 
''Note: You can add both IPv4 and IPv6 addresses.''
 
''Note: You can add both IPv4 and IPv6 addresses.''
 
|}
 
|}
Line 360: Line 359:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''21. Type desired IP and mask in '' 'IP Pool' '' and choose server from a '' 'Server' ''dropdown menu.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''21. Type desired IP and mask in '' 'IP Pool' '' and choose server from a '' 'Server' '' dropdown menu.'''<br />
−
Afterwards press'' 'Add Pool' ''.
+
Afterwards, press '' 'Add Pool' ''.
 
|}
 
|}
 
{|
 
{|
Line 368: Line 367:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''22. You are now able to create new product using previously added IP address.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''22. You are now able to create new product using previously added IP address.'''<br />
−
If you used KVM virtualization type, the client area of successfully created producs should look similar as on the screen below.<br />
+
If you used KVM virtualization type, the client area of successfully created product should look similar to the one on the screen below.<br />
−
Note that the screen below presents the module, right after creation of the product. Graphs will fill with data after use of certain server resources.
+
''Note: Screen below presents the module, right after creation of the product. Graphs will fill with data after use of certain server resources.''
 
|}
 
|}
 
{|
 
{|
Line 384: Line 383:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 0px;"|''' Proxmox VPS allows your customers to manage their PVE accounts via client area in your WHMCS system.'''<br />
 
|style="padding: 10px 0px 15px 0px;"|''' Proxmox VPS allows your customers to manage their PVE accounts via client area in your WHMCS system.'''<br />
−
You can monitor and manage each product from your WHMCS admin area.
+
You can monitor and manage each product from your WHMCS admin area.<br />
 
You are also able to add IP address to product. To do so, press '' 'Add New IP' '' as shown on the following screen.
 
You are also able to add IP address to product. To do so, press '' 'Add New IP' '' as shown on the following screen.
 
|}
 
|}
Line 398: Line 397:
 
==Management of Addon==
 
==Management of Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In'' 'Addons' → 'Proxmox Addon' → 'Server List' '' you can find servers you have configured.<br />
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Addons' '' → '' 'Proxmox Addon' '' → '' 'Server List' '' you can find servers you have configured.<br />
 
To see what product were created and assigned to your Proxmox server simply click on it's '' 'Server Name' ''.
 
To see what product were created and assigned to your Proxmox server simply click on it's '' 'Server Name' ''.
 
|}
 
|}
Line 417: Line 416:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'' 'Clusters' '' tab contains clusters list. To view information about cluster simply press on it's name.  
+
|style="padding: 0px 0px 20px 15px;"|'' 'Clusters' '' tab contains clusters list. To view information about cluster simply press on its name.  
 
|}
 
|}
 
{|
 
{|
Line 450: Line 449:
 
===Reinstall===
 
===Reinstall===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Reinstall feature allows to change template from available templates list. To reinstall your server, choose a template and click on'' 'Reinstall' ''(5) button.<br />
+
|style="padding: 10px 0px 20px 15px;"|Reinstall feature allows to change template from available templates list. To reinstall your server, choose a template and click on '' 'Reinstall' '' (5) button.
 
|}
 
|}
 
{|
 
{|
Line 458: Line 457:
 
===Backup Jobs & Backup===
 
===Backup Jobs & Backup===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|By pressing '' 'Backup Jobs' ''(8) in your client area, you will be carried to backup jobs management page.<br />
+
|style="padding: 10px 0px 15px 15px;"|By pressing '' 'Backup Jobs' '' (8) in your client area, you will be carried to backup jobs management page.<br />
 
To add new backup job press '' 'New Job' '' as shown on the following screen.
 
To add new backup job press '' 'New Job' '' as shown on the following screen.
 
|}
 
|}
Line 472: Line 471:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can also create a single backup. To do so, press '' 'Backup' '' (7) button and click on '' 'New Backup' '' as shown on the folowing screen.
+
|style="padding: 0px 0px 20px 15px;"|You can also create a single backup. To do so, press '' 'Backup' '' (7) button and click on '' 'New Backup' '' as shown on the following screen.
 
|}
 
|}
 
{|
 
{|
Line 479: Line 478:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Now choose '' 'Compress Dump File' '' and '' 'Backup Mode' '' from dropdown menus.<br />
 
|style="padding: 0px 0px 15px 15px;"|Now choose '' 'Compress Dump File' '' and '' 'Backup Mode' '' from dropdown menus.<br />
−
Afterward press '' 'Add Backup' '' .
+
Afterward press '' 'Add Backup' ''.
 
|}
 
|}
 
{|
 
{|
Line 492: Line 491:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|In main product page in the client area, under '' 'Details' '' headline your client can find information about current usage of CPU, memory and disk (OpenVZ only).<br />
 
|style="padding: 0px 0px 15px 15px;"|In main product page in the client area, under '' 'Details' '' headline your client can find information about current usage of CPU, memory and disk (OpenVZ only).<br />
−
Customer can also view '' 'DNS' ''(OpenVZ only) and '' 'IP Adresses' ''.
+
Customer can also view '' 'DNS' '' (OpenVZ only) and '' 'IP Addresses' ''.
 
|}
 
|}
 
{|
 
{|
Line 500: Line 499:
 
===Graphs===
 
===Graphs===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Under'' 'Details' '' section client can find graph of CPU usage, memory usage, network traffic and disc I/O.<br />
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Details' '' section client can find graph of CPU usage, memory usage, network traffic and disc I/O.<br />
 
He can also switch timeline of the graphs by choosing it from a dropdown menu pointed at the following screen.
 
He can also switch timeline of the graphs by choosing it from a dropdown menu pointed at the following screen.
 
|}
 
|}
Line 524: Line 523:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Here you can view all products this configurable option group is assigned to.<br />
 
|style="padding: 0px 0px 15px 15px;"|Here you can view all products this configurable option group is assigned to.<br />
−
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.<br />
+
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.<br />
 
To do so, edit '' 'The number of cores per socket' '' by pressing edit button as shown on the screen below.
 
To do so, edit '' 'The number of cores per socket' '' by pressing edit button as shown on the screen below.
 
|}
 
|}
Line 548: Line 547:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|With Advanced Billing module, you can also display your customers the current server resource usage and their cost.
+
|style="padding: 0px 0px 20px 15px;"|With Advanced Billing For WHMCS module, you can also display your customers the current server resource usage and their cost.
 
|}
 
|}
 
{|
 
{|
Line 556: Line 555:
 
==Management of Existing Accounts==
 
==Management of Existing Accounts==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''You can easily use Proxmox VPS module with your existing Proxmox accounts. To do so, follow the instructions below:'''<br />
+
|style="padding: 10px 0px 30px 15px;"|'''You can easily use Proxmox VPS module with your existing Proxmox accounts. To do so, follow the instructions below:'''<br />
 
1. Create and configure a Proxmox VPS server and a server group.<br />
 
1. Create and configure a Proxmox VPS server and a server group.<br />
 
2. Create and configure a Proxmox VPS product.<br />
 
2. Create and configure a Proxmox VPS product.<br />
Line 564: Line 563:
 
5. If possible, enter IP addresses into fields '' 'Dedicated IP' '' and '' 'Assigned IPs' ''.<br />
 
5. If possible, enter IP addresses into fields '' 'Dedicated IP' '' and '' 'Assigned IPs' ''.<br />
 
6. Set product status to '' 'Active' ''.<br /><br />
 
6. Set product status to '' 'Active' ''.<br /><br />
−
'''Remember to not click '' 'Create' '' button during the entire process. That would unnecessarily create a new virtual machine.'''<br />
+
'''Remember to not click '' 'Create' '' button during the entire process. That would unnecessarily create a new virtual machine.'''
 
|}
 
|}
  

Revision as of 13:11, 31 January 2014

Contents

About Proxmox VPS For WHMCS

Proxmox VPS For WHMCS is a powerful module which allows you to automatically provision virtual servers to your customers.

Additionaly it allows you to conveniently manage your servers, IP addresses and clusters.
The great advantage of this module is the fact that customers can manage virtual servers, backups and much more in your own WHMCS client area!

  • Admin Area Features:
✔ Create Server
✔ Suspend/Unsuspend Server
✔ Terminate Server
✔ Change Package (Supports Configurable Options)
✔ Boot Server
✔ Reboot Server
✔ Stop Server
✔ Reinstall Server
✔ View Server Status, Details And Statistics
✔ View Graphs (With Ability To Change The Time Scale of MRTG Graphs)
✔ Display Disk And Bandwidth Usage Of Each Product
✔ VNC Console Access
✔ Auto Node - Possibility To Automatically Create VM On The Node With The Most Free Space
✔ Possibility To Import IP To Hosting IP Addresses Table
✔ Possibility To Return IP To IP Addresses Pool
✔ Possibility To Add Additional IP To VM
  • Proxmox Addon Features:
✔ Servers List
✔ IP Management (Per Server)
✔ Clusters (Per Server)
  • Client Area Features:
✔ Boot Server
✔ Reboot Server
✔ Stop Server
✔ Shutdown Server
✔ Reinstall Server
✔ VNC Console
✔ Create Backups
✔ Restore Backups
✔ Backup Jobs
✔ Backup Limits (Max Number Of Files & Max Size Of Files)
✔ Backup Limit Jobs (Max Number Of Tasks Performing Backups)
✔ View Server Status, Details And Statistics
✔ View Graphs (With Ability To Change The Time Scale of MRTG Graphs)
✔ Display Disk And Bandwidth Usage
✔ Easy Product Upgrade/Downgrade
  • Additionally:
✔ Supports PVE And PAM Authentication
✔ Dynamically Chosen Server Resources While Ordering And Possibility To Upgrade Those Resources
✔ Integrated With Advanced Billing For WHMCS - Server Resource Usage Billing (read more)
✔ Multi-Language Support
✔ Supports Proxmox VE 3 and Later
✔ Supports IPv4 and IPv6
✔ Supports WHMCS V5 and Later
  • Available Configurable Options:
✔ KVM:
✔ Number of CPU Sockets
✔ Number of Cores Per Socket
✔ CPU Weight For a VM
✔ Amount of RAM
✔ Disk Space
✔ Bandwidth Limit
✔ Network Rate
✔ IP Addresses
✔ OpenVZ:
✔ Number of CPU Sockets
✔ Amount of SWAP
✔ CPU Weight For a VM
✔ Amount of RAM
✔ Disk Space
✔ Bandwidth Limit
✔ IP Addresses

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.

Installation

1. Log in to your client area and download Proxmox VPS For WHMCS.
File:PX1.png
2. Upload and extract the module into the main WHMCS directory.
File:PX2.png
3. When you install Proxmox VPS for the first time you have to rename 'license_RENAME.php' file.

File is located at 'modules/servers/proxmoxVPS/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

File:PX3.png
4. 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 at your client area → 'My Products' .

File:PX4.png

Activation of Proxmox Addon

5. Firstly we should activate Proxmox Addon.

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

File:PX5.png
6. In next step you need to permit access to this module.

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

File:PX6.png

Configuration of Server

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

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

File:PX7.png
8. Next, enter your server name, IP address, username and password. Choose 'Proxmox VPS' from a dropdown menu and press 'Save Changes' .
File:PX8.png
9. After you configure your server correctly, you will see a following screen.

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

File:PX9.png
10. It is time to create a server group, to do so click on 'Create Server Group' .
File:PX10.png
11. Enter name, click on your previously created server, press 'Add' and afterwards 'Save Changes' .
File:PX11.png

Configuration of Product

12. In order to create and configure a product click on 'Setup' → 'Products/Services' → 'Products/Services' .

Click on 'Create a New Group' .

File:PX12.png
13. Enter product group name and press 'Save Changes' .
File:PX13.png
14. When you have a product group, you can create your product.

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

File:PX14.png
15. Afterwards, choose your product group and type from dropdown menus, enter your product name and press 'Continue' .

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

File:PX15.png
16. Now go to 'Module Settings' section, choose both 'Proxmox VPS' and your previously created server group from dropdown menus.

Next, click on 'Save Changes' .

File:PX16.png
17. From dropdown menus choose 'Virtualization Type' , 'Default Node' and 'Template & ISO Storage' .

Afterwards, press 'Save Changes' . Note: If you choose 'Auto-Node' as 'Default Note', new virtual servers will be created on the least used node.

File:PX17.png
18. Setting of KVM virtualization type. (skip, if you have chosen OpenVZ virtualization type)

From dropdown menus choose 'KVM OS Type' , 'Storage' , 'Disk Type' , 'CD/DVD-ROM Type' , 'ISO Image' , 'Network Mode' , 'Network Model' , 'Bridge' , 'Node' and 'Storage' .
Type your VM description in 'Container Description' and click 'Save Changes' .

File:PX18.png
19. Setting of OpenVZ virtualization type. (skip, if you have chosen KVM virtualization type)

From dropdown menus choose 'OpenVZ OS Template' , 'Target Storage' , 'Node' and 'Storage' .
Type your VM description in 'Container Description' and press 'Save Changes' .

File:PX19.png
20. At the end of product configuration press 'Generate default' nearby 'Configurable Options' and 'Custom Fields' .
File:PX19 1.png
By doing so, you have just added a custom field 'vmid' and configurable options shown on the screen below.

Left column is for configurable options for KVM virtualization type, right column is for OpenVZ.

File:PX19 2.png
Congratulations! You have just finished the installation and configuration of the module.

Configuration of Addon

20. Adding new IP address.

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

File:PX20.png
21. Type desired IP and mask in 'IP Pool' and choose server from a 'Server' dropdown menu.

Afterwards, press 'Add Pool' .

File:PX21.png
22. You are now able to create new product using previously added IP address.

If you used KVM virtualization type, the client area of successfully created product should look similar to the one on the screen below.
Note: Screen below presents the module, right after creation of the product. Graphs will fill with data after use of certain server resources.

File:PX22.png
23.The client area of product using OpenVZ virtualization type looks quite similar.
File:PX23.png

Management

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

You can monitor and manage each product from your WHMCS admin area.
You are also able to add IP address to product. To do so, press 'Add New IP' as shown on the following screen.

File:PX23 5.png
Afterwards, enter IP address in a textbox and confirm through 'Save Changes' .
File:PX23 6.png

Management of Addon

In 'Addons' → 'Proxmox Addon' → 'Server List' you can find servers you have configured.

To see what product were created and assigned to your Proxmox server simply click on it's 'Server Name' .

File:PX24.png
As you can see on the screen below, you can find a lot of useful information here like e.g. IP, VM ID or VM Type.
File:PX25.png
In 'IP Management' tab you can add, edit and remove IP addresses of Proxmox products.
File:PX26.png
'Clusters' tab contains clusters list. To view information about cluster simply press on its name.
File:PX26 2.png
Here you can find various information about cluster, from available resource to graph of their use.

In order to go back to cluster list, press on 'Back to clusters list' button.

File:PX26 3.png

Interface

Client area interface of Proxmox VPS should look like the one on the screen below. As you can see, control panel contain useful options needed for managing VPS.

Module allows your customers to easily boot(1), reboot(2), stop(3) and shutdown(4) their servers through pressing specified button.
Clients can also reinstall(5) server, access VNC console(6), create backup (7) and set up backup jobs(8).

File:PX27.png

VNC Console

One of the most interesting functionality is VNC console(6) where your clients can remotely manage server. To access it, simply press on the 'Console' button.

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

File:PX28.png

Reinstall

Reinstall feature allows to change template from available templates list. To reinstall your server, choose a template and click on 'Reinstall' (5) button.
File:PX29.png

Backup Jobs & Backup

By pressing 'Backup Jobs' (8) in your client area, you will be carried to backup jobs management page.

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

File:PX30.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.

File:PX31.png
You can also create a single backup. To do so, press 'Backup' (7) button and click on 'New Backup' as shown on the following screen.
File:PX31 2.png
Now choose 'Compress Dump File' and 'Backup Mode' from dropdown menus.

Afterward press 'Add Backup' .

File:PX31 3.png
To restore VM from backup simply press 'Restore' and then click 'OK' button in a popup window to confirm.
File:PX31 4.png
In main product page in the client area, under 'Details' headline your client can find information about current usage of CPU, memory and disk (OpenVZ only).

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

File:PX32.png

Graphs

Under 'Details' section client can find graph of CPU usage, memory usage, network traffic and disc I/O.

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

File:PX33.png

Management of Configurable Options

When you successfully set up a product, your client can order it by choosing from default configurable options.
File:PX33 1.png
In case those options aren't fitting your needs, you can edit them.

To do so, go to 'Setup' → 'Products/Services' → 'Configurable Option' and press edit button next to configurable option used by your product.
Its name is 'Configurable options for your_product_name' .

File:PX33 2.png
Here you can view all 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 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.

File:PX33 3.png
You will see a popup window, so make sure your browser will not block it.

To add 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.
Next, press 'Save Changes' .

File:PX33 4.png

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.

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

File:PX34.png
With Advanced Billing For WHMCS module, you can also display your customers the current server resource usage and their cost.
File:PX35.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 new order with previously created product for your customer. Do not activate product yet.
4. Go to 'Products/Services' section of freshly created product and fill 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 to not click 'Create' button during the entire process. That would unnecessarily create a new virtual machine.

Tips

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.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Proxmox_VE_VPS_For_WHMCS&oldid=9924"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community
Proxmox VE VPS For WHMCS