Difference between revisions of "Cloudmin"

From WHMCS Documentation

m
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 +
== About this Module ==
 +
 +
The Cloudmin module allows you to add and manage Cloudmin servers in WHMCS.
 
{{Provisioning_Module
 
{{Provisioning_Module
 
| clientarealink = Yes
 
| clientarealink = Yes
 
| additional = Reboot, Startup & Shutdown}}
 
| additional = Reboot, Startup & Shutdown}}
 +
== Adding a Cloudmin Server ==
 +
 +
To set up a Cloudmin 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 ''Cloudmin'' from the menu.
 +
# Enter the hostname or IP address.
 +
# Enter the username and password or the access hash.
 +
# Click '''Continue'''.
 +
# Enter the additional desired server details.
 +
# Click '''Save Changes'''.
 +
# If this is the only Cloudmin 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.
  
==Adding a server==
+
=== Creating a Cloudmin Product === 
 +
 +
You can create a product that provisions accounts on your Cloudmin 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'''. 
  
The module should be configured in the normal way with a server in Setup > Servers first containing the IP Address, hostname, username & password used to access CloudMin and then products assigned to the Cloudmin module type as required.
+
When you do this, you can select one of two '''Setup Type''' options in the '''Module Settings''' tab:
  
It supports 2 types of setup: System & Owner. You can think of the differences between these two as System being an individual VPS and Owner being a reseller who is allowed to create multiple VPS instances.  Each are configured differently so we'll explain both seperately below.
+
* If you choose '''System''', you must define a xen type, openvzm vservers, and a plan name and create a '''Hostname''' [[Custom Fields|custom field]] to determine the VPS hostname.
 +
* If you choose '''Owner''' you must define a plan name and create a '''Username''' custom field.
  
==System Setup==
+
=== WHMCS Connect ===
  
If you choose the Setup Type of "System" in the products Module Settings, then you must also define a Type of xen, openvzm vservers, zones or real and enter a Plan Name. The Xen Host is optional.
+
This module does not support [[WHMCS Connect]].
  
You should however also create a custom field named "Hostname" for the user to enter during ordering to determine what the hostname is for their VPS.
+
==Troubleshooting==
  
==Owner Setup==
+
''N/A''
  
Largely the same as above, but for the Setup Type of "Owner", only a Plan Name is required and then a custom field of "Username" should be created rather than hostname to get the name from the user that they want to use for their account.
 
 
{{modules}}
 
{{modules}}

Latest revision as of 00:27, 5 April 2022

About this Module

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

Supported Features

Create Suspend Unsuspend Terminate
Yes Yes Yes Yes
Change Package Change Password Usage Updates Client Area Link
No No No Yes

In addition to the above, this module also supports the following non-standard functions: Reboot, Startup & Shutdown

Adding a Cloudmin Server

To set up a Cloudmin 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 Cloudmin from the menu.
  4. Enter the hostname or IP address.
  5. Enter the username and password or the access hash.
  6. Click Continue.
  7. Enter the additional desired server details.
  8. Click Save Changes.
  9. If this is the only Cloudmin 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 Cloudmin Product

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

When you do this, you can select one of two Setup Type options in the Module Settings tab:

  • If you choose System, you must define a xen type, openvzm vservers, and a plan name and create a Hostname custom field to determine the VPS hostname.
  • If you choose Owner you must define a plan name and create a Username custom field.

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