Revision as of 17:02, 5 August 2020 (view source) SarahK (talk | contribs) ← Older edit		Latest revision as of 20:04, 5 April 2022 (view source) SarahK (talk | contribs) (→‎Configuring the OS Chooser Option)
(2 intermediate revisions by the same user not shown)
Line 1:		Line 1:
		+	== About this Module ==
		+
		+	The HyperVM module allows you to add and manage HyperVM servers in WHMCS.
	{{Provisioning_Module		{{Provisioning_Module
	| changepackage = Yes		| changepackage = Yes
Line 4:		Line 7:
	| port = 8887  & 8888}}		| port = 8887  & 8888}}
−	== '''Adding a HyperVM Server''' ==	+	== Adding a HyperVM Server ==
−
−	The following steps guide you through the process of setting up a server in WHMCS for HyperVM Accounts.
−
−	#Begin by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
−	#Click '''Add New Server'''.
−	#Enter the master server name, IP address, select the server type "Hypervm" from the dropdown menu, and enter your HyperVM username & password
−	# The default port will be displayed. If your server is configured to communicate on a different port, tick the '''Override with Custom Port''' checkbox and enter it into the Port field. For more information refer to [[Server Port Overrides]].
−	# 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 set up a HyperVM server in WHMCS:
		+
		+	# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
		+	# Click '''Add New Server'''.
		+	# Select ''HyperVM'' from the menu.
		+	# Enter the hostname or IP address.
		+	# Enter a username and password or the access hash.
		+	# Click '''Continue'''.
		+	# Enter the desired additional server details.
		+	# Examine the displayed default port. If your server uses a different port, check '''Override with Custom Port''' and enter the correct port. For more information, see [[Server Port Overrides]].
		+	# Click '''Save Changes'''.
		+	# If this is the only HyperVM server that is currently in WHMCS, click on the name and ensure that it results in an asterisk (*) next to it. This indicates that it is the default to use when any other non-specific configuration doesn't apply.
−	To create a HyperVM Package in WHMCS, perform the following steps:	+	=== Creating an HyperVM Product ===
		+
		+	You can create a product that provisions accounts on your HyperVM server at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
−	#Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.	+	==== Configuring the OS Chooser Option ====
−	#Click Create a New Product and then enter the name for your new package
−	#Set the product type to "Other" and untick the Show Domain Options tick box
−	#Configure the pricing, welcome email, and other configuration options as normal
−	#Next, go to the Module Settings tab of the product config
−	#Select Hypervm in the Module Type dropdown menu
−	#The page will refresh with the options for a HyperVM package
−	#In the Type field, you need to enter the type of server this package is for - it will be either "openvz" or "xen"
−	#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"
−	#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"
−	#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'.
−	#Finally you need to select the number of IPs to allocate to it.
−	#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
−	#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.	+	The '''OS Chooser''' option within the HyperVM module can allow the client to choose the installed operating system when he orders his VPS.
−	==Configure HyperVM Automation==	+	To configure this:
−	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!	+	# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Configurable Options]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Configurable Options'''.
		+	# Add a new configurable option with the name <tt>Operating System</tt>.
		+	# For '''Add Option''', enter each operating system option in this format: <tt>RAWNAME|NICE NAME</tt><br/>For example:<br/><tt>centos-5-i386-afull|CentOS 5</tt>
		+	# Make certain that this configurable option is associated with your product at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
−	'''OS Chooser'''	+	=== WHMCS Connect ===
−	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!	+	This module does not support [[WHMCS Connect]].
−	#Go to your package	+	==Troubleshooting==
−	#Click "Configurable Options"
−	#Click "Add New Configurable Option"
−	#Under option name you write "Operating System" it's important that the name is spelled correctly without the quotes
−	#Under "Add Option" you may enter your OS's like this "RAWNAME|NICE NAME" (EXAMPLE: centos-5-i386-afull|CentOS 5"
−	#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!	+	''N/A''
	{{modules}}		{{modules}}

---

Latest revision as of 20:04, 5 April 2022

About this Module

The HyperVM module allows you to add and manage HyperVM servers in WHMCS.

Supported Features

Create	Suspend	Unsuspend	Terminate
Yes	Yes	Yes	Yes

Change Package	Change Password	Usage Updates	Client Area Link
Yes	No	No	Yes

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

Adding a HyperVM Server

To set up a HyperVM server in WHMCS:

1. Go to Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers.
2. Click Add New Server.
3. Select HyperVM from the menu.
4. Enter the hostname or IP address.
5. Enter a username and password or the access hash.
6. Click Continue.
7. Enter the desired additional server details.
8. Examine the displayed default port. If your server uses a different port, check Override with Custom Port and enter the correct port. For more information, see Server Port Overrides.
9. Click Save Changes.
10. If this is the only HyperVM server that is currently in WHMCS, click on the name and ensure that it results in an asterisk (*) next to it. This indicates that it is the default to use when any other non-specific configuration doesn't apply.

Creating an HyperVM Product

You can create a product that provisions accounts on your HyperVM server at Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services.

Configuring the OS Chooser Option

The OS Chooser option within the HyperVM module can allow the client to choose the installed operating system when he orders his VPS.

To configure this:

1. Go to Configuration () > System Settings > Configurable Options or, prior to WHMCS 8.0, Setup > Products/Services > Configurable Options.
2. Add a new configurable option with the name Operating System.
3. For Add Option, enter each operating system option in this format: RAWNAME|NICE NAME
   For example:
   centos-5-i386-afull|CentOS 5
4. Make certain that this configurable option is associated with your product at Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services.

WHMCS Connect

This module does not support WHMCS Connect.

Troubleshooting

N/A