Difference between revisions of "Virtualmin Pro"

Latest revision as of 20:53, 10 May 2022

About this Module

This module allows you to add and manage Virtualmin servers. It is compatible with both the GPL and Pro versions of Virtualmin.

Virtualmin Pro is required to use reseller functionality.

Supported Features

Create	Suspend	Unsuspend	Terminate
Yes	Yes	Yes	Yes

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

Adding a Virtualmin Server

To set up a Virtualmin server in WHMCS:

Go to Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers.
Click Add New Server.
Select Virtualmin from the menu.
Enter the server name and IP address.
Enter the username and password or access hash.
Click Continue.
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 Virtualmin 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 Virtualmin Product

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

If the templates exists inside Virtualmin, just enter the Server Template and Plan names.

Adding a Server Template
If the server template does not exist in Virtualmin, you will need to create it on the Virtualmin Pro server first under System Settings > Server Templates.

Adding an Account Plan
If the plan does not exist in Virtualmin, you will need to create it on the Virtualmin Pro server first under System Settings > Account Plans.

WHMCS Connect

This module does not support WHMCS Connect.

Troubleshooting

Unknown template name

This error means that the server template specified within WHMCS as Module Settings at Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services does not exist within Virtualmin under the System Settings > Server Templates page.

Ensure that the template name entered into WHMCS matches exactly with the server template name as specified in the Virtualmin control panel.

Unknown plan name

This error means that the Plan Name specified within WHMCS as Module Settings at Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services does not exist within Virtualmin under the System Settings > Account Plans page.

Ensure that the plan name entered into WHMCS matches exactly with the account plan name as specified in the Virtualmin control panel.

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 ==
+This module allows you to add and manage Virtualmin servers. It is compatible with both the GPL and Pro versions of Virtualmin.
+<div class="docs-alert-info">Virtualmin Pro is required to use reseller functionality.</div>
 {{Provisioning_Module
 | changepackage = Yes
@@ Line 5: / Line 9: @@
 | clientarealink = Yes}}
-== Adding a Virtualmin Pro Server ==
+== Adding a Virtualmin Server ==
-The following steps guide you through the process of setting up a server in WHMCS for Virtualmin Pro Hosting Accounts.
+To set up a Virtualmin 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 ''Virtualmin'' from the menu.
+# Enter the server name and IP address.
+# Enter the username and password or access hash.
+# Click '''Continue'''.
+# 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 Virtualmin 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.
-# Begin by going to '''Setup > Products/Services > Servers'''
+=== Creating a Virtualmin Product ===
-# Click Add New Server
-# Enter the hostnamename:port, IP address:port, select the server type "Virtualmin" from the dropdown menu and enter a master admin, ''that can accept RPC/API calls'', username and password for Virtualmin
+You can create a product that provisions accounts on your Virtualmin 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'''.
-# Click Create Server to complete the process and add your new Virtualmin Server
-# Add server to Server Group if you have created one.
-== Setting Up a Virtualmin Pro Server/Plan Templates ==
+* If the templates exists inside Virtualmin, just enter the Server Template and Plan names. [[File:virtualmin1.png|thumb|Adding a Server Template]]
+* If the server template does not exist in Virtualmin, you will need to create it on the Virtualmin Pro server first under '''System Settings > Server Templates'''. [[File:virtualmin2.png|thumb|Adding an Account Plan]]
+* If the plan does not exist in Virtualmin, you will need to create it on the Virtualmin Pro server first under '''System Settings > Account Plans'''.
-To setup Virtualmin templates, go to '''Setup > Products & Services'''.  From there, you can create the product and configure the general settings and pricing info as normal.  When it comes to the Module Settings tab, select "Virtualmin" in the module dropdown field, then select Server Group, if created, in the dropdown field and then for the templates:
+=== WHMCS Connect ===
-[[File:virtualmin3.png|thumb|Virtualmin Module Settings]][[File:virtualmin2.png|thumb|Adding an Account Plan]][[File:virtualmin1.png|thumb|Adding a Server Template]]
-#If the templates exists inside Virtualmin, just enter the Server Template and Plan names.
-#If the server template does not exist in Virtualmin, you will need to create it on the Virtualmin Pro server first under System Settings > Server Templates
-# If the plan does not exist in Virtualmin, you will need to create it on the Virtualmin Pro server first under System Settings > Account Plans.
-#And then finally as with all products you have the option of choosing the automatic setup option you want for new orders, be it immediately as soon as the order is placed, as soon as the initial payment has been received (recommended) or waiting until an admin manually reviews & accepts the pending orders
+This module does not support [[WHMCS Connect]].
+== Troubleshooting ==
+===Unknown template name===
-===For a reseller template===
+This error means that the server template specified within WHMCS as '''Module Settings''' 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''' does not exist within Virtualmin under the '''System Settings > Server Templates''' page.
-[[File:virtualmin4.png|thumb|Virtualmin Module Settings]]
-#Set the settings for the resellers own hosting account as above with one difference, the '''Product Type''' setting must be Reseller Account.
-#Under the Module Setting stab, the '''Template Name''' field can be left blank, only a '''Plan Name''' is required. If the plan does not exist in Virtualmin, you will need to create it on the Virtualmin Pro server first under System Settings > Account Plans.
-==Common Problems==
-===Unknown template name===
-This error means that the server template specified within WHMCS on the Setup > Products/Services > Products/Services > Edit > Module Settings page not exist within Virtualmin under the System Settings > Server Templates page.
 Ensure that the template name entered into WHMCS matches exactly with the server template name as specified in the Virtualmin control panel.
 ===Unknown plan name===
-This error means that the Plan Name specified within WHMCS on the Setup > Products/Services > Products/Services > Edit > Module Settings page not exist within Virtualmin under the System Settings > Account Plans page.
+This error means that the Plan Name specified within WHMCS as '''Module Settings''' 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''' does not exist within Virtualmin under the '''System Settings > Account Plans''' page.
 Ensure that the plan name entered into WHMCS matches exactly with the account plan name as specified in the Virtualmin control panel.
 {{modules}}

Documentation