Difference between revisions of "VPS.Net"

Latest revision as of 20:16, 7 April 2022

About this Module

VPS.net is a VPS cloud hosting service offering limitless resources with instant scalability. The VPS.net module lets you sell VPS to your customers through a completely white label solution.

Supported Features

Create	Suspend	Unsuspend	Terminate
Yes	Yes	Yes	Yes

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

In addition to the above, this module also supports the following non-standard functions: Start, Shutdown and Reboot VPS, Bandwidth & CPU Graphs and Enable and Disable Backups

Adding a VPS.net Server

To set up a VPS.net server in WHMCS:

Go to Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers.
Click Add New Server.
Select VPS.net from the menu.
Enter the hostname or IP address.
Enter the username and password or access hash. You can generate the access key by logging in to the VPS.net portal, going to Profile, and clicking Generate for the API key.
Click Continue.
Enter the desired additional server details.
Click Save Changes.
If this is the only VPS.net 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 a VPS.net Product

You can create a product that provisions accounts on your VPS.net server at Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services. When you do this, select the Server/VPS product type.

You can create products using two methods:

Fixed Products

To create products with fixed options that customers cannot change when ordering, set the number of nodes for the product and the Cloud/Template within the Module Settings tab.

For example, this could set the number of nodes to 2, the Cloud/Template to "London Zone A - CentOS Optimized", and a monthly price on the pricing tab.
You could do this for each configuration of VPS you want to offer and thus have a seperate product for each.

Custom Products

To create products with custom options that customers can change when ordering, use configurable options.

To create this type of product, set the base product price to 0 and create a configurable options group that supports the following option names:

Nodes — A Quantity, Dropdown, or Radio Selection option type that allows the user to specify the number of nodes they want.
Cloud Template — A Dropdown or Radio Selection option type that allows the user to choose the cloud location and OS template. Use the format CloudID+TemplateID, replacing each ID value with the appropriate value from the Cloud Template menu in the Module Settings tab.
Enable Backups — A Yes/No option type that allows the user to choose whether they want backups. You can use the following backup options:
- Enable Backups
- Rsync Backups
- R1Soft Backups

Customisation

You can customize the following template files:

cpugraphs.tpl
networkgraphs.tpl
backuplist.tpl

You can also customize language file lines that appear in the Client Area.

Client Area Management

The Client Area allows VPS.net clients to perform the following actions directly:

Boot, reboot, and shut down the VPS.
View CPU and bandwidth graphs.
Generate backups and restore previous backups.

WHMCS Connect

This module does not support WHMCS Connect.

Troubleshooting

N/A

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin
Lxadmin - Virtualmin Pro - XPanel - HyperVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible

@@ Line 1: / Line 1: @@
+== About this Module ==
+VPS.net is a VPS cloud hosting service offering limitless resources with instant scalability. The VPS.net module lets you sell VPS to your customers through a completely white label solution.
 {{Provisioning_Module
 | changepackage = Yes
 | clientarealink = Yes
-| additional = Start, Shutdown and Reboot VPS, Bandwidth & CPU Graphs and Enable & Disable Backups}}
+| additional = Start, Shutdown and Reboot VPS, Bandwidth & CPU Graphs and Enable and Disable Backups}}
-==Information==
-VPS.NET is a VPS Cloud Hosting Service. In what's being called the next generation of web hosting, the cloud gives you access to limitless resources with instant scalability. Combining WHMCS with the VPS.Net module is a great way to sell VPS (or Cloud servers, depending on how you wish to market it) to your customers through a completely white label solution.
-This is the first official module, not to be confused with previous third party modules for the VPS.Net service.
+== Adding a VPS.net Server ==
-==Setup/Configuration==
+To set up a VPS.net 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 ''VPS.net'' from the menu.
+# Enter the hostname or IP address.
+# Enter the username and password or access hash. You can generate the access key by logging in to [https://www.vps.net the VPS.net portal], going to '''Profile''', and clicking '''Generate''' for the API key.
+# Click '''Continue'''.
+# Enter the desired additional server details.
+# Click '''Save Changes'''.
+# If this is the only VPS.net 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.
-#The first step is to create a server in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
+=== Creating a VPS.net Product ===
-#* Server name: Set to anything you like,
-#* Hostname: VPS.Net
+You can create a product that provisions accounts on your VPS.net 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'''.  When you do this, select the '''Server/VPS''' product type.
-#* Module: Vpsnet
-#* Username: Your VPS.Net account email
-#* Access Hash: API Key for your VPS.Net account
-#* All other fields can be left blank
-#To generate a key:
-#*Log into your account at the VPS.Net portal (www.vps.net)
-#*Click the '''Profile''' link at the top of the page.
-#*On the page that appears, click the '''Generate''' link next to the API key field.
-#Once the server has been setup, you can then proceed to create your first product. The basic steps for this are:
-#*Begin by going 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'''.
-#*Click the '''Create a New Product''' link
-#*Select '''VPS/Dedicated Server''' for the Product Type
-#*Choose the appropriate product group and give the product a name, then click '''Continue >>'''[[File:Vpsnetproductsetuprevised.png]]
-#*On the next screen that appears, all settings can be left at their defaults
-#*Next move to the '''Module Settings''' tab and select the '''Vpsnet''' module from the dropdown menu. Server Group should be left at '''None'''.
-#*You will then see a screen like the one below where you can enter the Number of Nodes, select the Cloud/Template for this item, and enable/disable Backups aswell as choosing the desired auto setup option.
-[[File:Vpsnetmodulesettingsrevised.png]]
+You can create products using two methods:
-===Method 1: Fixed Products===
+==== Fixed Products ====
-With this method, you would set the number of nodes you want this product to come with and the Cloud/Template on the Module Settings page itself so the user doesn't get a choice. For example you could set the number of nodes to 2, the cloud/template to "London Zone A - CentOS Optimized" as above and then a monthly price on the pricing tab.  You could do this for each configuration of VPS you want to offer and thus have a seperate product for each.
+To create products with fixed options that customers cannot change when ordering, set the number of nodes for the product and the Cloud/Template within the '''Module Settings''' tab.
-===Method 2: Let the User Choose===
+* For example, this could set the number of nodes to 2, the Cloud/Template to "London Zone A - CentOS Optimized", and a monthly price on the pricing tab.
+* You could do this for each configuration of VPS you want to offer and thus have a seperate product for each.
-Alternatively, the Number of Nodes and Cloud/Template options you want to offer can also be provided to the user on the signup form as '''Configurable Options''' through a single product. This allows the user to choose exactly what they want and see the price updated based on their selections.  Setup of this method involves setting the base product price to zero, and then creating a [[Addons_and_Configurable_Options#Configurable_Options|Configurable Options Group]] which supports the following option names:
+==== Custom Products ====
-*'''Nodes''' - Can be a Quantity, Dropdown or Radio Selection option type to allow the user to specify the number of nodes they want. Should be a numeric value.
+[[File:vpsnetconfigoptionnodes.png|thumbnail]]
-*'''Cloud Template''' - Can be a Dropdown or Radio Selection option type to allow the user to choose the Cloud Location and OS Template they desire. Should be in the format CloudID+TemplateID - you can find the ID values on the Module Settings tab Cloud Template dropdown for the module.
+[[File:vpsnetconfigoptiontemplatelocation.png|thumbnail]]
-*'''Enable Backups''' - Can be a Yes/No option type to allow the user to choose if they want backups ability. There are also 3 options you can use for the different backup options; "Enable Backups", "Rsync Backups" & "R1Soft Backups".
+[[File:vpsnetconfigoptionsorder.png|thumbnail]]
-The below screenshots show an example of how the configurable options could be setup:
+To create products with custom options that customers can change when ordering, use configurable options.
-[[File:vpsnetconfigoptionnodes.png]]
+To create this type of product, set the base product price to <tt>0</tt> and create a [[Addons_and_Configurable_Options#Configurable_Options|configurable options group]] that supports the following option names:
-[[File:vpsnetconfigoptiontemplatelocation.png]]
+* '''Nodes''' — A ''Quantity'', ''Dropdown'', or ''Radio Selection'' option type that allows the user to specify the number of nodes they want.
+* '''Cloud Template''' — A ''Dropdown'' or ''Radio Selection'' option type that allows the user to choose the cloud location and OS template. Use the format <tt>CloudID+TemplateID</tt>, replacing each ID value with the appropriate value from the '''Cloud Template''' menu in the '''Module Settings''' tab.
+* '''Enable Backups''' — A ''Yes/No'' option type that allows the user to choose whether they want backups. You can use the following backup options:
+** ''Enable Backups''
+** ''Rsync Backups''
+** ''R1Soft Backups''
-[[File:vpsnetconfigoptionsorder.png]]
+=== Customisation ===
-The important feature of config options to remember is the field format "'''SystemValue|DisplayValue'''" for flexibility ie. the part before the pipe symbol is what the system requires and the part after is what you want to display to users and can be more friendly.  This is demonstrated in the example above.
+You can customize the following template files:
-==Upgrades/Downgrades==
+* <tt>cpugraphs.tpl</tt>
+* <tt>networkgraphs.tpl</tt>
+* <tt>backuplist.tpl</tt>
-Automated product & configurable option upgrades/downgrades are fully supported by the VPS.Net module so if enabled in the product configuration, WHMCS will allow the user to order a change of their VPS Product, or number of nodes/cloud template/backups options and automatically provision it with VPS.Net upon payment.
+You can also customize language file lines that appear in the Client Area.
-==Admin Area Management Options==
+== Client Area Management ==
-The admin area allows for creation & termination of VPS.Net services along with automated package changes, power management, and backup generation as shown in the Module Commands below. The VPS Hostname & IP will also be displayed in the respective fields for the product.
+[[File:Vpsnetclientarearevised1.png|thumbnail]]
-[[File:Vpsnetadminsiderevised1.png]]
+The Client Area allows VPS.net clients to perform the following actions directly:
-==Client Area Management Options==
+* Boot, reboot, and shut down the VPS.
+* View CPU and bandwidth graphs.
+* Generate backups and restore previous backups.
-The client area with this module provides clients with an automated management panel for their VPS service all without any admin/staff intervention. This includes the ability to:
+=== WHMCS Connect ===
-*Power On, Off, Reboot & Shutdown their VPS
+This module does not support [[WHMCS Connect]].
-*View CPU & Bandwidth Graphs
-*Generate Backups & Restore Previous Backups
-[[File:Vpsnetclientarearevised1.png]]
+==Troubleshooting==
-==Customisation==
+''N/A''
-The module contains 3 template files - cpugraphs.tpl, networkgraphs.tpl and backuplist.tpl along with numerous language file lines which allow for customisation of the client area pages.
 {{modules}}

Documentation