HyperVM

• Documentation Home
• General Information
  • System Requirements
  • Installing WHMCS
  • Upgrading
  • Release Notes
  • Further Security Steps
  • Importing Data
  • Licensing
  • Common Troubleshooting Tips
• Key Aspects
  • Clients
  • Orders
  • Products
  • Domains
  • Invoicing
  • Transactions
  • Support Tickets
  • Messages & Emails
• Setup/Configuration
  • General Settings
  • Automation Settings
  • Payment Gateways
  • Admins/Permissions
  • Products/Services
  • Support Departments
• Developer Resources
  • Client Area Templates
  • Order Form Templates
  • Language Files
  • Action Hooks
  • Widgets
  • Creating Modules
  • API

Supported Features

The following ports should be open for outbound connections from your WHMCS server: 8887 & 8888

Adding a HyperVM Server

The following steps guide you through the process of setting up a server in WHMCS for HyperVM Accounts.

1. Begin by going to Configuration > Servers
2. Click Add New Server
3. Enter the master server name, IP address, select the server type "Hypervm" from the dropdown menu, and enter your HyperVM username & password
4. Click Create Server to complete the process

Your HyperVM server is now configured in WHMCS. You can now move on to create your first HyperVM Package.

Setting up a HyperVM Package

To create a HyperVM Package in WHMCS, perform the following steps:

1. Go to Setup > Products/Services > Products/Services
2. Click Create a New Product and then enter the name for your new package
3. Set the product type to "Other" and untick the Show Domain Options tick box
4. Configure the pricing, welcome email, and other configuration options as normal
5. Next, go to the Module Settings tab of the product config
6. Select Hypervm in the Module Type dropdown menu
7. The page will refresh with the options for a HyperVM package
8. In the Type field, you need to enter the type of server this package is for - it will be either "openvz" or "xen"
9. In the Plan Name field, you need to enter the plan name as it appears listed in the dropdown in HyperVM when you are creating a new server eg. "sample1"
10. In the OS Template field, again, you need to enter it exactly as it appears in the dropdown menu when adding a new server in HyperVM, eg. "centos-4-i386-hostinabox23"
11. In the Server box you need to enter the hostname of the slave server on which it will be set up. If you have only 1 HyperVM server this is 'localhost'.
12. Finally you need to select the number of IPs to allocate to it.
13. The last step is to setup a custom field on the custom fields tab called "Username" which is set to show on the order form and be required so users can enter their desired username when placing their order
14. The last updated on HyperVM module now support the passing of a hostname via a custom field "Hostname"

That's it! Your HyperVM Package is now configured and ready for use.

Configure HyperVM Automation

Inside the HyperVM module then you have a few options that you can add to make the HyperVM automation process better for you and your clients!

OS Chooser

Let the client choose the OS he want's to install when he orders his VPS, this way you get the OS your CLIENT want instantly created instead of the pre-selected one in your configuration!

1. Go to your package
2. Click "Configurable Options"
3. Click "Add New Configurable Option"
4. Under option name you write "Operating System" it's important that the name is spelled correctly without the quotes
5. Under "Add Option" you may enter your OS's like this "RAWNAME|NICE NAME" (EXAMPLE: centos-5-i386-afull|CentOS 5"
6. Make a new Option for each OS you want to add

Congratulations, you have managed to create so that your client's can now choose what OS they want when they order the VPS through your order form!