Adding a Virtualizor Server and Products

Virtualizor is a powerful web based VPS Control Panel using which a user can deploy and manage VPS on servers with a single click.

Supported Features

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

Get Started

First, you need to configure the plugin in Clientexec's server section as shown in the picture below. Go to Settings > Products > Servers



Now you need to add your Virtualizor server by clicking Add Server.

Field Name	Description
Server Name	Friendly name. How you will see it inside Clientexec.
Hostname	The name of the server where Virtualizor resides.
Shared IP	Main Server IP
Plugin	Virtualizor
Maximum # of Accounts	Set this to 0
Stats URL	Not Mandatory.
IP Addresses (one per line)	If for some reason you need to manually assign an IP to someone, you would add it here. The IP's are automatically assigned when created through Clientexec.

Plugin Options:

Field Name	Description
API Key	Paste your Access Key here.
API Pass	Paste your Access Key here.
VM Password Custom Field*	Enter the name of the package custom field that will hold the VM Password. (see below)
VM Hostname Custom Field*	Enter the name of the package custom field that will hold the VM Hostname. (see below)
VM Operating System Custom Field*	Enter the name of the package custom field that will hold the VM Operating System. (see below)
VM Location Custom Field*	Enter the name of the package custom field that will hold the VM Location. You only need to use Location or Location Group. (see below)
VM Location Group Custom Field*	Enter the name of the package custom field that will hold the VM Location Group. You only need to use Location or Location Group. (see below)
Use Standard Ports for SSO?	If selected, SSO will use port 443 instead of 4083.

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: Text Field
Is Required: Yes
Include in Signup: Yes

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: Yes
Include in Signup: Yes

VM Operating System Custom Field:

Field Name: The name you set for the VM Operating System Custom Field Custom Field while setting up the server.
Field Type: Drop Down
Options:: Name(id), Name(id) - replace name with the Operating System name and id with the Operating System ID from your Virtualizor, example: AlmaLinux 8(1), AlmaLinux 9(2)
Is Required: Yes
Include in Signup: Yes

Note, for the following you only need to use one or the other, do not set up both (Location = Setting Slave ID, Location Group = Setting Location Group ID)

###### VM Location: (use this for single server in a location)

Field Name: The name you set for the VM Location Custom Field while setting up the server.
Field Type: Drop Down
Options: Name(id), Name(id) - replace name with the location and id with the id location from your Virtualizor, example: Finland(1), Germany(2)
Is Required: Yes
Include in Signup: Yes

OR

###### VM Location Group: (use this for multiple servers in a location)

Field Name: The name you set for the VM Location Group Custom Field while setting up the server.
Field Type: Drop Down
Options: Name(id), Name(id) - replace name with the location group and id with the id location from your Virtualizor, example: California(1), Texas(2)
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.

Add Hosting Packages

Navigate to Settings > Products > Products.
Create a new Product Group for your Virtualizor 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 Virtualizor server. Fill in the fields options for your server.
Repeat steps 3 and 4 to add additional products.

Notice: When selecting more than one server for a given product it is imperative that you ensure each server is configured exactly the same. The configuration options below are used for all servers listed above. For plugin types that obtain values from the server it will only be retrieved from the first server listed and it is assumed the second server is configured the same.

Product Configuration Options:

Field Name	Description
Package Name on Server	Enter the Package Name as you set it up in your Virtualizor.
VM Type	Select the type of VM for this package.
IP Pool ID	Enter the ID of the IP pool for this VPS.
Storage ID	Enter the Storage ID for this plan if you are not using primary storage.

If you wish to have the package created automatically after the Order Processor service has been ran, go back to the General Tab and check the "Automatically Activate package?" box.

Please keep in mind you will need to repeat the add packages process for each package that will be using the Virtualizor server.

Updated on: 21/10/2023