Revision as of 01:34, 19 July 2008 (view source) Joe (talk | contribs) (→‎'''Adding a HyperVM Server''') ← Older edit		Latest revision as of 20:04, 5 April 2022 (view source) SarahK (talk | contribs) (→‎Configuring the OS Chooser Option)
(11 intermediate revisions by 5 users not shown)
Line 1:		Line 1:
−	== '''Adding a HyperVM Server''' ==	+	== About this Module ==
−	Before attempting to add a HyperVM server make sure the PHP JSON module is loaded by view the phpinfo at Utilities -> PHP Info.	+	The HyperVM module allows you to add and manage HyperVM servers in WHMCS.
		+	{{Provisioning_Module
		+	| changepackage = Yes
		+	| clientarealink = Yes
		+	| port = 8887 & 8888}}
−	The following steps guide you through the process of setting up a server in WHMCS for HyperVM Accounts.	+	== Adding a HyperVM Server ==
−	* 1. Begin by going to Configuration > Servers	+	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.
−	* 2. Click Add New Server	+	=== 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'''.
−	* 3. Enter the master server name, IP address, select the server type "Hypervm" from the dropdown menu, and enter your HyperVM username & password	+	==== Configuring the OS Chooser Option ====
−	* 4. Click Create Server to complete the process	+	The '''OS Chooser''' option within the HyperVM module can allow the client to choose the installed operating system when he orders his VPS.
−	Your HyperVM server is now configured in WHMCS.  You can now move on to create your first HyperVM Package.	+	To configure this:
−	== '''Setting up a HyperVM Package''' ==	+	# 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'''.
−	To create a HyperVM Package in WHMCS, perform the following steps:	+	=== WHMCS Connect ===
−	* 1. Go to Configuration > Products/Services	+	This module does not support [[WHMCS Connect]].
−	* 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	+	==Troubleshooting==
−	* 4. Configure the pricing, welcome email, and other configuration options as normal	+	''N/A''
−
−	* 5. Next, go to the Server Settings tab of the product config
−
−	* 6. Select Hypervm master in the Server 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 slave server to set it up on. 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
−
−	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!
−
−	'''TIP:''' As mentiond above you put the package under "Other" wich will not put the package under "My Hosting packages" but under the "My Products and Services" inside the client area! VPS is defined as an hosting package, and to get the site put under "My Hosting Package" then you simply go to your package and choose "Shared Hosting Account" instead of "Other" -> Problem Solved
−
−	'''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 ""
−	* 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 trough your order form!
	{{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