Personal tools
Namespaces

Variants
Actions

Proxmox Cloud 2.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 4: Line 4:
 
=About [http://www.modulesgarden.com/products/whmcs/proxmox_cloud/features Proxmox Cloud For WHMCS]=
 
=About [http://www.modulesgarden.com/products/whmcs/proxmox_cloud/features Proxmox Cloud For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Proxmox Cloud For WHMCS''' allows you to provide your clients with availability to create and freely resize their own servers within resource limit defined by you.
+
|style="padding: 10px 0px 10px 0px;"|'''Proxmox Cloud For WHMCS''' allows you to provide your clients with the availability to create and freely resize their own servers within resource limit defined by you.
−
This powerful module lets you also to conveniently manage servers, IP addresses and clusters owing to special addon attached to the module.<br />
+
This powerful module lets you also conveniently manage servers, IP addresses and clusters owing to special addon attached to the module.<br />
−
The great advantage of Proxmox Cloud For WHMCS is the fact that customers can manage multiple virtual servers, backups and much more in your WHMCS client area!
+
The great advantage of Proxmox Cloud For WHMCS is the fact that customers can manage multiple virtual servers, backups and many more in your WHMCS client area!
 
|}
 
|}
 +
<!--comments are awesome -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
Line 17: Line 18:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Terminate Server/User
 
|style="padding: 0px 0px 0px 30px;"|✔ Terminate Server/User
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Migrate Server Between Nodes
 
|}
 
|}
 
{|
 
{|
Line 76: Line 80:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ VNC Console
 
|style="padding: 0px 0px 0px 30px;"|✔ VNC Console
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ SPICE Console
 
|}
 
|}
 
{|
 
{|
Line 91: Line 98:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Task History
 
|style="padding: 0px 0px 0px 30px;"|✔ Task History
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Manage Network Devices
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Create Snapshots
 
|}
 
|}
 
{|
 
{|
Line 219: Line 232:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_1.png]]
 
|}
 
|}
 
{|
 
{|
Line 225: Line 238:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_2.png]]
 
|}
 
|}
 
{|
 
{|
Line 232: Line 245:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_3.png]]
 
|}
 
|}
 
{|
 
{|
Line 240: Line 253:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PXC4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_4.png]]
 
|}
 
|}
  
Line 249: Line 262:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_5.png]]
 
|}
 
|}
 
{|
 
{|
Line 256: Line 269:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PXC6.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_6.png]]
 
|}
 
|}
  
Line 265: Line 278:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_7.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''8. Next, enter your server name, IP address, username and password.<br />
 
|style="padding: 0px 0px 15px 15px;"|'''8. Next, enter your server name, IP address, username and password.<br />
 
Choose '' 'ProxmoxCloud' '' from a dropdown menu and press '' 'Save Changes' ''.'''<br />
 
Choose '' 'ProxmoxCloud' '' from a dropdown menu and press '' 'Save Changes' ''.'''<br />
−
Last step is choosing  authentication from the '' 'Authentication' '' dropdown menu.<br />
+
The last step is choosing  authentication from the '' 'Authentication' '' dropdown menu.<br />
−
''Note: Authentication depends of realm used by user at Proxmox server.''
+
''Note: Authentication depends of the realm used by user at Proxmox server.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_8.png]]
 
|}
 
|}
 
{|
 
{|
Line 281: Line 294:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''10. It is time to create a server group. To do so, click on '' 'Create Server Group' ''.
+
|style="padding: 0px 0px 20px 15px;"|'''10. It is time to create a server group. To do so, click on '' 'Create New Group' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_10.png]]
 
|}
 
|}
 
{|
 
{|
Line 293: Line 306:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PXC11.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_11.png]]
 
|}
 
|}
  
 
==Configuration of Product==
 
==Configuration of Product==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''12. In order to create and configure a product go to the '' 'Setup' → 'Products/Services' → 'Products/Services' ''.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''12. In order to create and configure a product go to '' 'Setup' → 'Products/Services' → 'Products/Services' ''.'''<br />
 
Click on '' 'Create a New Group' ''.   
 
Click on '' 'Create a New Group' ''.   
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_12.png]]
 
|}
 
|}
 
{|
 
{|
Line 308: Line 321:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_13.png]]
 
|}
 
|}
 
{|
 
{|
Line 315: Line 328:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_14.png]]
 
|}
 
|}
 
{|
 
{|
Line 322: Line 335:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_15.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''16. Now, go to the '' 'Module Settings' '' section, choose both '' 'ProxmoxCloud' '' 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 '' 'ProxmoxCloud' '' and your previously created server group from dropdown menus.<br />
 
Next, click on '' 'Save Changes' ''.'''
 
Next, click on '' 'Save Changes' ''.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_16.png]]
 
|}
 
|}
 
{|
 
{|
Line 337: Line 350:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_17.png]]
 
|}
 
|}
 
{|
 
{|
 
|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 a dropdown menu choose '' 'KVM OS Type' '', '' 'Default Storage' '', '' 'Disk Type' '', '' 'CD/DVD-ROM Type' '' and '' 'ISO Image' ''.<br />
+
From dropdown menus choose '' 'KVM OS Type' '', '' 'Default Storage' '', '' 'Disk Type' '' and '' 'CD/DVD-ROM Type' ''.<br />
 +
Additionally, choose ISO images available for your clients by marking them at '' 'ISO Image' ''.<br />
 
Set network through selecting from '' 'Network Mode' '', '' 'Network Model' '' and '' 'Bridge' '' dropdown menus.<br />
 
Set network through selecting from '' 'Network Mode' '', '' 'Network Model' '' and '' 'Bridge' '' dropdown menus.<br />
 
Type your VM description in '' 'Container Description' '', set backup location at a '' 'Storage' '' dropdown menu and click '' 'Save Changes' ''.
 
Type your VM description in '' 'Container Description' '', set backup location at a '' 'Storage' '' dropdown menu and click '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_18.png]]
 
|}
 
|}
 
{|
 
{|
Line 354: Line 368:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_19.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''20. Next step is setting up configuration of IP addresses and backups.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''20. The next step is setting up configuration of backups.'''<br />
−
If you are using [http://www.modulesgarden.com/products/whmcs/ip_manager/features IP Manager For WHMCS] you can assign configuration with IPv4 and IPv6 pools at '' 'IP Manager' '' section.<br />'''
+
Define backup settings at '' 'Backups' '' section through selecting values from '' 'Storage' '' and '' 'Backups Routing' '' dropdown menus.<br />
−
For more information, visit [http://www.docs.modulesgarden.com/Proxmox_Cloud_For_WHMCS#IP_Manager_Integration IP Manager Integration] section.<br />
+
Backups routing automatically removes the oldest backup when a new backup is created and a backup limit is reached.<br />
−
Otherwise add IP pool via Proxmox For WHMCS addon (more about it in the next section).<br />
+
Additionally, you can limit the time period for storing backups by providing the number of days into '' 'Delete Backup's Older Than N Days' '' field.<br />
−
Additionally, define backup settings at '' 'Backups' '' section through selecting values from '' 'Storage' '' and '' 'Backups Routing' '' dropdown menus.<br />
+
Finish configuration at the '' 'Module Settings' '' tab through pressing '' 'Save Changes' ''.
−
Backups routing automatically remove oldest backup when new backup is created and backup limit is reached.<br />
+
−
Finish configuration at the '' 'Module Settings' '' tab through pressing on '' 'Save Changes' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC19_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_20.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''21. Final step is generating custom fields and deciding whether to set up product with static or configurable resources.<br />
+
|style="padding: 0px 0px 15px 15px;"|'''21. The final step is generating custom fields and deciding whether to set up product with static or configurable resources.<br />
 
Press '' 'Generate default' '' next to '' 'Custom Fields' ''.<br />
 
Press '' 'Generate default' '' next to '' 'Custom Fields' ''.<br />
−
'''Static Resources:''' Fill fields at '' 'Default Configuration' '' section with desired values.<br />
+
'''Static Resources:''' Fill in the fields in '' 'Default Configuration' '' section with desired values.<br />
 
'''Configurable Resources:''' Click on '' 'Generate Default' '' next to '' 'Configurable Options' ''.<br />
 
'''Configurable Resources:''' Click on '' 'Generate Default' '' next to '' 'Configurable Options' ''.<br />
 
Press '' 'Save Changes' '' at the bottom of the page.
 
Press '' 'Save Changes' '' at the bottom of the page.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC20.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_21.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''22. At the end of product configuration you have to add cron job shown below (each 5 minutes suggested).<br />
 
|style="padding: 0px 0px 15px 15px;"|'''22. At the end of product configuration you have to add cron job shown below (each 5 minutes suggested).<br />
−
  php -q /your_whmcs/modules/servers/proxmoxCloud/cron/cron.php<br />
+
  php -q /your_whmcs/modules/servers/proxmoxCloud/cron/cron.php
 
Do not forget to replace '' 'your_whmcs' '' with your WHMCS root location.
 
Do not forget to replace '' 'your_whmcs' '' with your WHMCS root location.
 
|}
 
|}
Line 389: Line 401:
 
==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 a new IP address.'''<br />
−
In order to create new product you have to add dedicated IP pool to '' 'IP Addresses' '' list in '' 'Proxmox' '' addon module.<br />
+
In order to create a new product you have to add dedicated IP pool to '' 'IP Addresses' '' list in '' 'Proxmox' '' addon module.<br />
 
To do so, go to '' 'Addons' '' → '' 'Proxmox Addon' '' → '' 'IP Management' '' and press '' 'New IP Addresses' ''.<br />
 
To do so, go to '' 'Addons' '' → '' 'Proxmox Addon' '' → '' 'IP Management' '' and press '' 'New IP Addresses' ''.<br />
 
''Note: You can add both IPv4 and IPv6 addresses.''
 
''Note: You can add both IPv4 and IPv6 addresses.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC21.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_22.png]]
 
|}
 
|}
 
{|
 
{|
Line 402: Line 414:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_23.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''22. You are now able to create new virtual machines at product.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''22. You are now able to create new virtual machines at product.'''<br />
−
If you used KVM virtualization type, the client area of successfully created product should look similar as on the screen below.
+
If you used KVM virtualization type, the client area of successfully created product should look similar to the one on the screen below.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_24.png]]
 
|}
 
|}
 
{|
 
{|
Line 415: Line 427:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PXC24.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_25.png]]
 
|}
 
|}
  
Line 421: Line 433:
  
 
{|
 
{|
−
|style="padding: 10px 0px 15px 0px;"|''' Proxmox Cloud For WHMCS allows your customers to manage their PVE accounts via client area in your WHMCS system.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|''' Proxmox Cloud For WHMCS 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.<br />
 
You can monitor and manage each product from your WHMCS admin area.<br />
−
To view details about virtual server created by your client simply press '' 'Load Status' '' button.
+
To view VM details(1), migrate VM(2) or update VMs node(3), press a specific button.<br />
 +
To view details of virtual server created by your client simply press '' 'Load Status' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC25.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_26.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can view here basic information about virtual server, resource usage and graph of resource usage.<br />
+
|style="padding: 0px 0px 15px 15px;"|On the following screen you can see loaded details of the VM as well as opened migration popup.<br />
−
To hide server details, press '' 'Hide' '' 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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PXC25_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_27.png]]
 
|}
 
|}
 
==Management of Addon==
 
==Management of Addon==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|At the '' '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 are created and assigned to your Proxmox server simply click on its '' 'Server Name' ''.
+
To see what product was created and assigned to your Proxmox server simply click on its '' 'Server Name' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC26.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_28.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|As you can see on the screen below, you can find a lot of useful information here like e.g. IP address, VM ID or VM Type.
+
|style="padding: 0px 0px 20px 15px;"|As you can see on the screen below, you can find a lot of useful information here like e.g. IP Address, VM ID or VM Type.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC27.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_29.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|At the '' 'IP Management' '' tab you can add, edit and remove IP addresses of Proxmox products.  
+
|style="padding: 0px 0px 20px 15px;"|At the '' 'IP Management' '' tab you can add, edit and remove IP addresses from Proxmox products.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC28.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_30.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'' 'Clusters' '' tab contains clusters list. To view information about cluster simply press on its name.  
+
|style="padding: 0px 0px 20px 15px;"|'' 'Clusters' '' tab contains clusters list. To view information about a cluster simply press its name.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC29.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_31.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Here you can find various information about cluster, from available resource to graph of their usage.
+
|style="padding: 0px 0px 20px 15px;"|Here you can find various information about a cluster, from available resource to their usage graphs.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PXC30.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_32.png]]
 
|}
 
|}
 
===Templates Management===
 
===Templates Management===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can easily convert any VM at your server to template.<br />
+
|style="padding: 10px 0px 15px 15px;"|You can easily convert any VM on your server to a template.<br />
−
In order to convert VM, go to the '' 'Proxmox Addon' '' → '' 'Templates' '' → '' 'Create Template' ''.<br />
+
In order to convert VM, go to '' 'Proxmox Addon' '' → '' 'Templates' '' → '' 'Create Template' ''.<br />
 
Choose server on which VM to convert exist and press '' 'Next Step' ''.<br />
 
Choose server on which VM to convert exist and press '' 'Next Step' ''.<br />
−
'''Important: VM will be consumed in process.'''
+
'''Important: VM will be destroyed in the process.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC30_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_33.png]]
 
|}
 
|}
 
{|
 
{|
Line 482: Line 495:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX30_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_34.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To access list of all available templates go to the '' 'Proxmox Addon' '' → '' 'Templates' '' → '' 'Show Templates' ''.
+
|style="padding: 0px 0px 20px 15px;"|To access the list of all available templates go to '' 'Proxmox Addon' '' → '' 'Templates' '' → '' 'Show Templates' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX30_3.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_35.png]]
 
|}
 
|}
  
Line 494: Line 507:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Client area interface of Proxmox Cloud For WHMCS allows your clients to create their own virtual servers.<br />
 
|style="padding: 10px 0px 15px 15px;"|Client area interface of Proxmox Cloud For WHMCS allows your clients to create their own virtual servers.<br />
−
They can also view their resource usage and manage existing virtual servers.
+
They can also view resources used and manage existing virtual servers.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC31.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_36.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In order to add new server, press '' 'Add New Server' '' button.
+
|style="padding: 0px 0px 20px 15px;"|In order to add a new server, press '' 'Add New Server' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC32.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_37.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Afterwards, enter '' 'Hostname' '', '' 'Nameserver 1' '', '' 'Nameserver 2' '' and '' 'Root Password' ''.<br />
 
|style="padding: 0px 0px 15px 15px;"|Afterwards, enter '' 'Hostname' '', '' 'Nameserver 1' '', '' 'Nameserver 2' '' and '' 'Root Password' ''.<br />
−
Choose '' 'Template' '' from a dropdown menu and select resources for your server using the sliders.<br />
+
Choose '' 'Template' '' from a dropdown menu and select resources for your server by using sliders.<br />
−
You can also enter resources values into textboxes instead of using sliders.<br />
+
Instead of using the sliders you can also enter resources values into textboxes.<br />
 
Confirm creation through pressing '' 'Add New Virtual Server' ''.
 
Confirm creation through pressing '' 'Add New Virtual Server' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC33.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_38.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|To manage your virtual server simply press '' 'Manage' '' button next to it.<br />
 
|style="padding: 0px 0px 15px 15px;"|To manage your virtual server simply press '' 'Manage' '' button next to it.<br />
−
You can find information about managing your virtual servers in [http://www.docs.modulesgarden.com/Proxmox_Cloud_For_WHMCS#Virtual_Server_Management next section].
+
You can find information about managing your virtual servers in [http://www.docs.modulesgarden.com/Proxmox_Cloud_For_WHMCS#Client_Area-VM_Management next section].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC34.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_39.png]]
 
|}
 
|}
 
{|
 
{|
Line 525: Line 538:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PXC35.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_40.png]]
 
|}
 
|}
  
−
==Virtual Server Management==
+
==Client Area - VM Management==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Client area interface of created virtual server should look like the one on the screen below.<br />
+
|style="padding: 10px 0px 15px 15px;"|Client area interface of virtual server should look like the one on the screen below.<br />
 
As you can see, control panel contains useful options needed for managing VPS.<br />
 
As you can see, control panel contains useful options needed for managing VPS.<br />
−
Module allows your customers to easily boot(1), stop(2), reboot(3) and shutdown(4) their servers through pressing specified button.<br />
+
The module allows your customers to easily boot(1), stop(2), reboot(3) and shutdown(4) their servers through pressing a specific button.<br />
−
Clients can also edit(5) server, access console(6), view graphs of resource usage(7), create backup(8), set up backup jobs(9) and access task history(10).<br />
+
Clients can also edit(5) server, access VNC(6) and SPICE(7) consoles and view the graphs of resource usage(8).<br />
−
They can also find here server details and resource usage(11), and IP addresses assigned to virtual server(12).
+
Additionally, they are able to create backup(9), set up backup jobs(10), access task history(11) and manage network devices(12).<br />
 +
They can also find here server details(13) and IP addresses assigned to the server(14).
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PXC36.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_41.png]]
 
|}
 
|}
 
===Edit VM===
 
===Edit VM===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Edit feature allows you to change server details and resources except '' 'Template' '' and '' 'Password' ''. To edit your server, click on '' 'Edit VM' '' button.
+
|style="padding: 10px 0px 20px 15px;"|Edit feature allows you to change server details and resources except '' 'Template' '' and '' 'Password' ''. To edit your server, click on '' 'Edit VM' ''(5) button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC37.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_42.png]]
 
|}
 
|}
 
{|
 
{|
Line 550: Line 564:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PXC38.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_43.png]]
 
|}
 
|}
  
−
===Console===
+
===VNC Console===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|One of the most interesting functionality is VNC console where your clients can remotely manage server. To access it, simply press on the '' 'Console' ''(6) button.<br />
+
|style="padding: 10px 0px 15px 15px;"|VNC console allows your clients to remotely manage the server. To access it, simply press the '' 'VNC Console' ''(6) button.<br />
 
Console requires Java software and you need to accept security risk to run it.
 
Console requires Java software and you need to accept security risk to run it.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PXC39.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_44.png]]
 
|}
 
|}
  
 +
===SPICE Console===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Spice console(7) enables you to connect with virtual machine using SPICE.<br />
 +
''Note: Your client needs to [http://www.spice-space.org/download.html download] and install client side SPICE application in order to connect with VM.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_45.png]]
 +
|}
 
===Usage Graphs===
 
===Usage Graphs===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Under '' 'Usage Graphs' ''(7) page, client can find graph of CPU usage, memory usage, network traffic and disc I/O.<br />
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Usage Graphs' ''(8) page, a client can find graph with 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 the timeline of the graphs by choosing it from a dropdown menu pointed on the following screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PXC40.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_46.png]]
 
|}
 
|}
 
===Backup===
 
===Backup===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|To create a single backup, press '' 'Backup' ''(8) button and click on '' 'New Backup' '' as shown on the following screen.
+
|style="padding: 10px 0px 20px 15px;"|To create a single backup, press '' 'Backup' ''(9) button and click on '' 'New Backup' '' as shown on the following screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC41.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_47.png]]
 
|}
 
|}
 
{|
 
{|
Line 582: Line 604:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC42.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_48.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To restore VM from backup simply press '' 'Restore' '' and then click '' 'OK' '' button in a popup window to confirm.
+
|style="padding: 0px 0px 20px 15px;"|To restore VM from a backup simply press '' 'Restore' '' and then click '' 'OK' '' button in a popup window to confirm.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PXC43.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_49.png]]
 
|}
 
|}
  
 
===Backup Jobs===
 
===Backup Jobs===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|By pressing '' 'Backup Jobs' ''(9) in your client area, you will be carried to backup jobs management page.<br />
+
|style="padding: 10px 0px 15px 15px;"|By pressing '' 'Backup Jobs' ''(10) in the client area, you will be carried to a backup jobs management page.<br />
−
To add new backup job press '' 'New Job' '' as shown on the following screen.
+
To add a new backup job press '' 'New Job' '' as shown on the following screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PXC44.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_50.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now define backup time, mark days to run it and choose '' 'Compression Dump File' '' and '' 'Backup Mode' '' from dropdown menus.<br />
+
|style="padding: 0px 0px 15px 15px;"|Now, define backup time, mark days to run it and choose '' 'Compression Dump File' '' and '' 'Backup Mode' '' from dropdown menus.<br />
 
Next, press '' 'Add' '' button.
 
Next, press '' 'Add' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PXC45.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_51.png]]
 
|}
 
|}
 
===Task History===
 
===Task History===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|All changes of VM status are listed at the '' 'Task History' ''(10).
+
|style="padding: 10px 0px 15px 15px;"|All changes of VM status are listed in '' 'Task History' ''(11).<br />
 +
Additionally, each access to the VM through SPICE console is shown here.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PXC45_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_52.png]]
 +
|}
 +
===Network===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|'' 'Network' ''(12) tab allows your clients to view their VM's network interface.<br />
 +
Depending on the settings of the product, they can also create/remove them.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_53.png]]
 
|}
 
|}
  
Line 617: Line 648:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Owing to integration with [http://www.modulesgarden.com/products/whmcs/ip_manager/features IP Manager For WHMCS] you are able to easily create pools of IP addresses and assign them to desired products.<br />
 
|style="padding: 10px 0px 15px 15px;"|Owing to integration with [http://www.modulesgarden.com/products/whmcs/ip_manager/features IP Manager For WHMCS] you are able to easily create pools of IP addresses and assign them to desired products.<br />
−
1. Proceed to IP Manager For WHMCS → [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#IP_Pools IP Pools] in order to prepare IP addresses pool for Proxmox Cloud For WHMCS.<br />
+
1. Proceed to IP Manager For WHMCS → [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#IP_Pools IP Pools] tab in order to prepare IP addresses pool for Proxmox Cloud For WHMCS.<br />
−
2. Edit a previously created IP addresses pool and create custom field '' 'MAC Address' '' with desired MAC address to each IP address in the pool.<br />
+
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.<br />
−
More about creating custom fields can be found [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Custom_Fields_For_IP_Addresses here].<br />
+
More about creating custom fields can be found [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Custom_Fields_For_IP_Addresses here].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PX33_1_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_49.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|3. Afterwards, create a [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Automatic_IP_Assignment new configuration] and assign previously created pool to it.<br />
+
|style="padding: 0px 0px 15px 15px;"|3. Afterwards, create a [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Automatic_IP_Assignment new configuration] and assign a previously created pool to it.<br />
−
''Note 1: Do not assign Proxmox Cloud For WHMCS product to configuration. Simply, create new configuration with assigned IP addresses pool.''<br />
+
''Note: Multiple IP addresses pools can be assigned to a single configuration.''<br />
−
''Note 2: Multiple IP addresses pools can be assigned to one configuration.''<br />
+
4. Now, link the configuration with Proxmox Cloud product via product, server or configurable option.<br />
−
4. In order to finish, go to the Proxmox Cloud For WHMCS product → '' 'Module Settings' ''.<br />
+
On the following screen we have linked them via a configurable option assigned to the Proxmox Cloud product.
−
Find '' 'IP Manager' '' section and choose previously created pool from '' 'Configuration IPv4' '' or '' 'Configuration IPv6' '' dropdown menu.<br />
+
−
Finish through pressing '' 'Save Changes' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PX45_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PX_50.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|5. Now, enable integration by proceeding to '' '3rd Party Integration' '' tab.<br />
 +
Press '' 'Activate' '' next to '' 'proxmoxVPS' '' module type as shown on the following screen.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PXC_54.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|5. Next, assign a previously created configuration to the submodule.<br />
 +
Press '' 'Configure' '', choose the configuration and press '' 'Save Changes' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PXC_55.png]]
 
|}
 
|}
−
 
 
==Importing VM==
 
==Importing VM==
 
{|
 
{|
Line 645: Line 687:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Afterwards, select node on which server exist and fill both '' 'VMID' '' and '' 'Password' '' fields.<br />
+
|style="padding: 0px 0px 15px 15px;"|Afterwards, select the node on which the server exists and fill in both '' 'VMID' '' and '' 'Password' '' fields.<br />
 
Confirm importing through pressing '' 'Save Changes' '' button.<br />
 
Confirm importing through pressing '' 'Save Changes' '' button.<br />
−
''Note: If you fill 'Password' field with incorrect value, import will be completed successfully but some features may not work for that VM.''
+
''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.''
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:PX45_4.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:PX45_4.png]]
 
|}
 
|}
 +
 
==Custom Hooks==
 
==Custom Hooks==
 
{|
 
{|
Line 675: Line 718:
 
==Configurable Options==
 
==Configurable Options==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|When you successfully set up a product, your clients can order it by choosing from default configurable options.
+
|style="padding: 10px 0px 20px 15px;"|When you successfully set up a product, your clients can order it by choosing from the default configurable options.
 
|}
 
|}
 
{|
 
{|
Line 681: Line 724:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If automatically generated configurable options do not seem to fill your clients needs, you can edit them using [http://www.docs.modulesgarden.com/General#Editing_Configurable_Options this guide].
+
|style="padding: 0px 0px 20px 15px;"|If automatically generated configurable options do not seems to fulfill your clients needs, you can edit them using [http://www.docs.modulesgarden.com/General#Editing_Configurable_Options this guide].
 
|}
 
|}
 
{|
 
{|
Line 687: Line 730:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If you decide to set up pricing per server resource ordered, you can find instruction how to proceed [http://www.docs.modulesgarden.com/General#Setting_Up_Pricing_For_Configurable_Options here].
+
|style="padding: 0px 0px 20px 15px;"|If you decide to set up pricing per server resource ordered, you can find instruction to proceed [http://www.docs.modulesgarden.com/General#Setting_Up_Pricing_For_Configurable_Options here].
 
|}
 
|}
 
{|
 
{|
Line 696: Line 739:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|When you combine Proxmox Cloud For WHMCS with [http://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS Advanced Billing For WHMCS], you will be able to set up additional billing options.<br />
 
|style="padding: 10px 0px 15px 15px;"|When you combine Proxmox Cloud For WHMCS with [http://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS Advanced Billing For WHMCS], you will be able to set up additional billing options.<br />
−
Module allows you to charge your customers based on the server resources used by them.
+
Module allows you to charge your customers basing on the server resources used by them.
 
|}
 
|}
 
{|
 
{|
Line 702: Line 745:
 
|}
 
|}
 
{|
 
{|
−
|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 current server resource usage and their cost.
 
|}
 
|}
 
{|
 
{|

Revision as of 14:36, 15 October 2014

Contents

About Proxmox Cloud For WHMCS

Proxmox Cloud For WHMCS allows you to provide your clients with the availability to create and freely resize their own servers within resource limit defined by you.

This powerful module lets you also conveniently manage servers, IP addresses and clusters owing to special addon attached to the module.
The great advantage of Proxmox Cloud For WHMCS is the fact that customers can manage multiple virtual servers, backups and many more in your WHMCS client area!

  • Admin Area Features:
✔ Create Server/User
✔ Suspend/Unsuspend Server/User
✔ Terminate Server/User
✔ Migrate Server Between Nodes
✔ Import 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
✔ Possibility To Import IP To Hosting IP Addresses Table
✔ Possibility To Return IP To IP Addresses Pool Possibility To Add Additional IP To VM
✔ Possibility To Add Additional IP To VM
✔ Configuration Of Features Available At The Client Area
  • Proxmox Addon Features:
✔ Servers List (VPS And Cloud)
✔ IP Management (Per Server)
✔ Clusters (Per Server)
✔ KVM Templates
  • Client Area Features:
✔ Create VM
✔ Boot Server
✔ Reboot Server
✔ Stop Server
✔ Shutdown Server
✔ Edit Server
✔ VNC Console
✔ SPICE Console
✔ Create Backups
✔ Restore Backups
✔ Backup Routing
✔ Backup Jobs
✔ Task History
✔ Manage Network Devices
✔ Create Snapshots
✔ Backup Files & Job Limits (Max Number Of Files & Max Size Of Files)
✔ View Server Status, Details And Statistics
✔ View Graphs (With Ability To Change The Time Scale of MRTG Graphs)
✔ Display Disk And Bandwidth Usage
✔ Easy VM Upgrade/Downgrade
✔ Change Boot Order (KVM)
✔ Change ISO Image (KVM)
  • General Info:
✔ 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)
✔ Integrated With IP Manager For WHMCS - Complete Management of IP Pools (read more)
✔ Multi-Language Support
✔ Supports Proxmox VE 3 and Later
✔ Supports IPv4 and IPv6
✔ Custom Hooks
✔ Supports WHMCS V5 and Later
  • Available Configurable Options:
✔ KVM:
✔ CPU Sockets Limit
✔ CPU Cores Limit
✔ CPU Weight Limit
✔ Memory Limit
✔ Storage Limit
✔ Bandwidth Limit
✔ IPv4 Addresses Limit
✔ IPv6 Addresses Limit
✔ Backups Size Limit
✔ Backups Files Limit
✔ OpenVZ:
✔ CPU Cores Limit
✔ CPU Weight Limit
✔ SWAP Limit
✔ Memory Limit
✔ Storage Limit
✔ Bandwidth Limit
✔ IPv4 Addresses Limit
✔ IPv6 Addresses Limit
✔ Backups Size Limit
✔ Backups Files Limit

Installation and Configuration

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

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

Installation

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

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

File:PXC 3.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:PXC 4.png

Activation of Proxmox Addon

5. Firstly, you should activate Proxmox Addon.

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

File:PXC 5.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:PXC 6.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:PXC 7.png
8. Next, enter your server name, IP address, username and password.

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

File:PXC 8.png
9. After you configure your server correctly, you will see a following screen.

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

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

Configuration of Product

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

Click on 'Create a New Group' .

File:PXC 12.png
13. Enter product group name and press 'Save Changes' .
File:PXC 13.png
14. When you have a product group, you are able to create your product.

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

File:PXC 14.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:PXC 15.png
16. Now, go to 'Module Settings' section, choose both 'ProxmoxCloud' and your previously created server group from dropdown menus.

Next, click on 'Save Changes' .

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

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:PXC 17.png
18. Setting of KVM virtualization type. (skip, if you have chosen OpenVZ virtualization type)

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 at '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 at a 'Storage' dropdown menu and click 'Save Changes' .

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

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

File:PXC 19.png
20. The next step is setting up configuration of backups.

Define backup settings at '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 'Delete Backup's Older Than N Days' field.
Finish configuration at the 'Module Settings' tab through pressing 'Save Changes' .

File:PXC 20.png
21. The final step is generating custom fields and deciding whether to set up product with static or configurable resources.

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' at the bottom of the page.

File:PXC 21.png
22. At the end of product configuration you have to add cron job shown below (each 5 minutes suggested).
 
php -q /your_whmcs/modules/servers/proxmoxCloud/cron/cron.php

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

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

Configuration of Addon

20. Adding a new IP address.

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.

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

Afterwards, press 'Add Pool' .

File:PXC 23.png
22. You are now able to create new virtual machines at product.

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

File:PXC 24.png
23. The client area of product using OpenVZ virtualization type looks quite similar.
File:PXC 25.png

Management

Proxmox Cloud For WHMCS 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.
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.

File:PXC 26.png
On the following screen you can see loaded details of the VM as well as opened migration popup.

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

File:PXC 27.png

Management of Addon

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

To see what product was created and assigned to your Proxmox server simply click on its 'Server Name' .

File:PXC 28.png
As you can see on the screen below, you can find a lot of useful information here like e.g. IP Address, VM ID or VM Type.
File:PXC 29.png
At the 'IP Management' tab you can add, edit and remove IP addresses from Proxmox products.
File:PXC 30.png
'Clusters' tab contains clusters list. To view information about a cluster simply press its name.
File:PXC 31.png
Here you can find various information about a cluster, from available resource to their usage graphs.
File:PXC 32.png

Templates Management

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

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

File:PXC 33.png
Next, choose node and VM to convert.

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

File:PXC 34.png
To access the list of all available templates go to 'Proxmox Addon' → 'Templates' → 'Show Templates' .
File:PXC 35.png

Client Area

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

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

File:PXC 36.png
In order to add a new server, press 'Add New Server' button.
File:PXC 37.png
Afterwards, enter 'Hostname' , 'Nameserver 1' , 'Nameserver 2' and 'Root Password' .

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

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

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

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

Client Area - VM Management

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

As you can see, control panel contains useful options needed for managing VPS.
The module allows your customers to easily boot(1), stop(2), reboot(3) and shutdown(4) their servers through pressing a specific button.
Clients can also edit(5) server, access VNC(6) and SPICE(7) consoles and view the graphs of resource usage(8).
Additionally, they are able to create backup(9), set up backup jobs(10), access task history(11) and manage network devices(12).
They can also find here server details(13) and IP addresses assigned to the server(14).

File:PXC 41.png

Edit VM

Edit feature allows you to change server details and resources except 'Template' and 'Password' . To edit your server, click on 'Edit VM' (5) button.
File:PXC 42.png
Afterwards, alter options you desire and confirm through pressing 'Save Changes' button.
File:PXC 43.png

VNC Console

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

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

File:PXC 44.png

SPICE Console

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

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

File:PXC 45.png

Usage Graphs

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

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

File:PXC 46.png

Backup

To create a single backup, press 'Backup' (9) button and click on 'New Backup' as shown on the following screen.
File:PXC 47.png
Now choose 'Compress Dump File' and 'Backup Mode' from dropdown menus.

Afterwards, press 'Add Backup' .

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

Backup Jobs

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

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

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

Next, press 'Add' button.

File:PXC 51.png

Task History

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

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

File:PXC 52.png

Network

'Network' (12) tab allows your clients to view their VM's network interface.

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

File:PXC 53.png

IP Manager Integration

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

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.

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

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.

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

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

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

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

PXC 55.png

Importing VM

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

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

File:PX45 3.png
Afterwards, select the node on which the server exists and fill in both 'VMID' and 'Password' fields.

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.

File:PX45 4.png

Custom Hooks

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

Custom hooks are placed at the '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

Configurable Options

When you successfully set up a product, your clients can order it by choosing from the default configurable options.
File:PXC46.png
If automatically generated configurable options do not seems to fulfill your clients needs, you can edit them using this guide.
File:PXC47.png
If you decide to set up pricing per server resource ordered, you can find instruction to proceed here.
File:PXC48.png

Management of Billing

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

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

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

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_Cloud_2.X_For_WHMCS&oldid=14746"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community
Proxmox Cloud 2.X For WHMCS