Adding a ProxmoxVE Server and Products

This Plugin is currently in Beta. Ths KB article is a work in progress.

Proxmox Virtual Environment is an open source server virtualization management solution based on QEMU/KVM and LXC.

Supported Features

Create	Suspend	Unsuspend	Terminate	Change Package	Change Password	Client Area Link
Yes	Yes	Yes	Yes	No	No	Yes

Get Started

Login to your Clientexec admin and navigate to Settings > Products > Servers > Add Server, and fill in the forms:

Field Name	Description
Server Name	Friendly name, How you will see it inside ClientExec.
Plugin	ProxmoxVE.
Hostname	ProxmoxVE Hostname
IP Addresses	Put all IPs that you want to be able to assign in the IPs section of the server here. One per line.
Username	ProxmoxVE Username
Password	ProxmoxVE Password
Gateway IP	ProxmoxVE Gateway IP Address
VM Password Custom Field	Enter the name of the package custom field that will hold the root password. (see below)
VM ID Custom Field	Enter the name of the package custom field that will hold the ProxmoxVE VM Id. (see below)
VM Hostname Custom Field	Enter the name of the package custom field that will hold the VM hostname. (see below)
VM MainIp Custom Field	Enter the name of the package custom field that will hold the Main IPv4 Address. (see below)
VM Operating System Custom Field	Enter the name of the package custom field that will hold the VM Operating System. (see below)

Click save changes, and then navigate back to the server and click Test Connection to ensure it is working.

Configuring Custom fields

Once you have set up a server, you will need to set up the five custom fields. To do so, log into your Clientexec Admin Area and navigate to Settings > Products > Custom Fields > Add Custom Field.

Make sure you uncheck All Product Groups for these fields.

VM Password:

Field Name: The name you set for the VM Password Custom Field while setting up the server.
Field Type: Password
Is Required: No
Include in Signup: No

VM ID:

Field Name: The name you set for the VM ID Custom Field while setting up the server.
Field Type: Text Field
Is Required: No
Include in Signup: No

VM Hostname:

Field Name: The name you set for the VM Hostname Custom Field while setting up the server.
Field Type: Text Field
Is Required: No
Include in Signup: Yes

VM MainIP:

Field Name: The name you set for the VM MainIP Custom Field while setting up the server.
Field Type: Text Field
Is Required: No
Include in Signup: No

VM Operating System:

Field Name: The name you set for the VM Operating System Custom Field while setting up the server.
Field Type: Dropdown
Is Required: Yes
Include in Signup: Yes

Go back and add these field names to your Server settings if you've not already done so.

Activating Snapin

This plugin also includes a snapin to help add the Operating Systems to the VM Operating System Custom Field.

Go to Settings > Plugins > Snapins and in the dropdown select ProxmoxVE Helper and select yes for Enabled and Viewable by All Staff. Then click Update Settings.

Next, go to Accounts > ProxmoxVE Helper and in the dropdown select your ProxmoxVE server. Then you will be able to select the Operating System Values to add to your VM Operating System custom field. (The operating systems must be created as VM Templates)

Creating Products

Navigate to Settings > Products > Products.
Create a new Product Group for your ProxmoxVE server products, and make sure the type is Hosting. Also add the custom fields you created to the product group. (if you already have a product group, edit it to add the custom fields).
Create a new product under your product group. Add descriptions and prices that you want to charge.
Once you save changes, navigate to the Advanced & Plugin Settings tab and select your ProxmoxVE server. Fill in the fields options for your server.
Repeat steps 3 and 4 to add additional products.

Updated on: 31/08/2024