Personal tools
Namespaces

Variants
Actions

SolusVM 2 VPS And Cloud For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About SolusVM 2 VPS & Cloud For WHMCS)
 
(210 intermediate revisions by 2 users not shown)
Line 5: Line 5:
 
=About [https://www.modulesgarden.com/products/whmcs/solusvm-2-vps-and-cloud SolusVM 2 VPS & Cloud For WHMCS] =
 
=About [https://www.modulesgarden.com/products/whmcs/solusvm-2-vps-and-cloud SolusVM 2 VPS & Cloud For WHMCS] =
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''SolusVM 2 VPS & Cloud For WHMCS''' popis cały do odświeżenia od zera,
+
|style="padding: 10px 0px 10px 0px;"|'''SolusVM 2 VPS & Cloud For WHMCS''' module offers provisioning of virtual machines as single VPS instances or flexible Cloud resources.<br/>
 +
Allow your clients to create and manage servers within their limits using efficient tools for backups, snapshots, reinstallations, and real-time performance monitoring.<br/>
 +
Use the module to Empower your customers with comprehensive control over their virtual servers.
 
|}
 
|}
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Server
+
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Product
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Create User Account
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Package
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Package - Supports Configurable Options
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Password
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Password Of Account
+
|style="padding: 0px 0px 0px 30px;"|✔ Import Virtual Machine (Cloud)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Boot/Reboot/Shutdown Server
+
|style="padding: 0px 0px 0px 45px;"|✔ Existing Virtual Machines
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle TUN/TAP And PAE
+
|style="padding: 0px 0px 0px 45px;"|✔ From SolusVM 2.0 WHMCS Addon
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Reconfigure Network
+
|style="padding: 0px 0px 0px 30px;"|✔ View Available Resources (Cloud)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Rebuild Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Start/Stop/Pause/Unpause/Resume Servers
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Password: Root, Client, SSH Console, VNC Console
+
|style="padding: 0px 0px 0px 30px;"|✔ Access noVNC Console
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Mount/Unmount ISO
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Rescue Mode
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Boot Order
+
|style="padding: 0px 0px 0px 30px;"|✔ View Servers Status And Details
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Server Status
+
|style="padding: 0px 0px 0px 30px;"|✔ View Scheduled And Completed Tasks
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Graphs: Traffic, Load, Memory
+
|style="padding: 0px 0px 0px 30px;"|✔ View Queue
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change IP Addresses
+
|style="padding: 0px 0px 0px 30px;"|✔ Provide Product General Configuration:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Product Resource:
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Product Type:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Dynamically - Using Configurable Options
+
|style="padding: 0px 0px 0px 60px;"|✔ VPS - Provisioning Of Single Server Per Product
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Statically - Using 'Module Settings' Fields
+
|style="padding: 0px 0px 0px 60px;"|✔ Cloud - Enable Provisioning Of Multiple Servers Per Single Product
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Configure Client Area Features Per Product
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Virtualization Type:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define OS Templates Available For Rebuild
+
|style="padding: 0px 0px 0px 60px;"|✔ KVM
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Allow To Rebuild Server On Purchased OS Only
+
|style="padding: 0px 0px 0px 60px;"|✔ VZ
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Set Rebuild Limit
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Image Format
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Select Kernels For Rescue Mode
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Compute Resource
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Configure Friendly Names For OS Templates And Nodes
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Default User Role
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Create New SolusVM User For Each VPS Ordered By Client
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Storage Type
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Root Password Storing In System Database
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Server Location
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Root Password Change After Server Creation
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Server Limits:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Decoded Server Password
+
|style="padding: 0px 0px 0px 45px;"|✔ Virtual CPUs
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Run API Connection Test
+
|style="padding: 0px 0px 0px 45px;"|✔ vCPU Units (VZ)
 
|}
 
|}
−
*'''Client Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ View Server Details And Status
+
|style="padding: 0px 0px 0px 45px;"|✔ vCPU Limit (VZ)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Boot/Reboot/Shutdown/Rebuild/Delete Server
+
|style="padding: 0px 0px 0px 45px;"|✔ Disk Size [GiB]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Access SSH Console - OpenVZ And Xen Only
+
|style="padding: 0px 0px 0px 45px;"|✔ Memory [MiB]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Access VNC Console - KVM And Xen HVM Only
+
|style="padding: 0px 0px 0px 45px;"|✔ IO Priority (VZ)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Access NoVNC HTML5 Console - KVM And Xen HVM Only
+
|style="padding: 0px 0px 0px 45px;"|✔ SWAP [MiB] (VZ)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Access HTML5 Serial Console - OpenVZ And Xen Only
+
|style="padding: 0px 0px 0px 45px;"|✔ Additional IPv4 Addresses
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Log In To Control Panel
+
|style="padding: 0px 0px 0px 45px;"|✔ Additional IPv6 Addresses
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle TUN/TAP And PAE
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Default Server Configuration:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle PXE (Preboot Execution Environment)
+
|style="padding: 0px 0px 0px 45px;"|✔ Enable IPv4 And IPv6
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Rescue Mode With Chosen Kernel
+
|style="padding: 0px 0px 0px 45px;"|✔ Provide User Data Script
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Reconfigure Network
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Default Operating System / Application
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Passwords: Root, Client, SSH Console And VNC Console
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable Access To Client Area Features:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Hostname
+
|style="padding: 0px 0px 0px 45px;"|✔ Backups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change IP Addresses
+
|style="padding: 0px 0px 0px 45px;"|✔ Graphs
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Mount/Unmount ISO
+
|style="padding: 0px 0px 0px 45px;"|✔ Network
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Boot Order
+
|style="padding: 0px 0px 0px 45px;"|✔ Reinstall
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Graphs: Traffic, Load, Memory
+
|style="padding: 0px 0px 0px 45px;"|✔ Snapshots
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Send Email Templates After Creation Of Server Based On Its Type
+
|style="padding: 0px 0px 0px 45px;"|✔ Tasks
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Server Resources While Ordering And Upgrade/Downgrade Them Freely
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Available Operation Systems
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Choose SolusVM Username When Ordering New Product
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Available Applications
 
|}
 
|}
−
*'''Configurable Options:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Operating System
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Server Information Entries
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Memory
+
|style="padding: 0px 0px 10px 30px;"|✔ Generate Configurable Options
 
|}
 
|}
 +
*'''Addon Features:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Disk Space
+
|style="padding: 10px 0px 0px 30px;"|✔ View Server Configurations Lists And Details:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Secondary Disk Size
+
|style="padding: 0px 0px 0px 45px;"|✔ IP Address
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Bandwidth
+
|style="padding: 0px 0px 0px 45px;"|✔ Active Accounts
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ CPU
+
|style="padding: 0px 0px 0px 45px;"|✔ Status
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Extra IPv4 Address
+
|style="padding: 0px 0px 0px 30px;"|✔ Customize Operation System And Application Logo Images
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Control Panel
+
|style="padding: 0px 0px 0px 30px;"|✔ View Queue Of Scheduled Tasks And Details
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Location
+
|style="padding: 0px 0px 0px 30px;"|✔ Customize Module Language Files With "Translations" Tool
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ ISO Image
+
|style="padding: 0px 0px 10px 30px;"|✔ View And Manage Logs
 
|}
 
|}
 +
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Network Speed
+
|style="padding: 10px 0px 0px 30px;"|✔ Manage Single (VPS) Or Multiple (Cloud) Servers Per Product
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Rebuild Limit
+
|style="padding: 0px 0px 0px 30px;"|✔ View Servers Status And Details
 
|}
 
|}
−
 
−
*'''General Info:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports OpenVZ, Xen And KVM Virtualization
+
|style="padding: 0px 0px 0px 30px;"|✔ View Available Resources (Cloud)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>DNS Manager For WHMCS</u> - Supports PowerDNS [https://www.modulesgarden.com/products/whmcs/dns-manager/features (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Start/Stop/Restart Servers
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Advanced Billing For WHMCS</u> - Actual Server Resource Usage Billing [https://www.modulesgarden.com/products/whmcs/advanced-billing/features (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Access noVNC Console
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>IP Manager For WHMCS</u> - Complete Management of IP Pools [https://www.modulesgarden.com/products/whmcs/ip-manager/features (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Rescue Mode
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Server Allocator For WHMCS</u> - Automatic Assignment Of Most Suitable Servers To Products [https://www.modulesgarden.com/products/whmcs/server-allocator (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Server Password
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 30px;"|✔ Create/Manage/Restore Backups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports SolusVM 1.0 (Compatibility With SolusVM 2 Coming Soon)
+
|style="padding: 0px 0px 0px 30px;"|✔ View Server Graphs:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
+
|style="padding: 0px 0px 0px 45px;"|✔ CPU Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
+
|style="padding: 0px 0px 0px 45px;"|✔ Disk Throughput
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.8 Back To WHMCS V8.8
+
|style="padding: 0px 0px 0px 45px;"|✔ Network Throughput
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
+
|style="padding: 0px 0px 0px 45px;"|✔ Memory Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/solusvm-2-vps-and-cloud#open-source-version Open Source Version]
+
|style="padding: 0px 0px 0px 30px;"|✔ View Network Details
 
|}
 
|}
−
 
−
=Installation and Configuration=
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''In this tutorial we will show you how to successfully install [https://www.modulesgarden.com/products/whmcs/solusvm-2-vps-and-cloud SolusVM 2 VPS & Cloud For WHMCS.]'''<br/>
+
|style="padding: 0px 0px 0px 30px;"|✔ Reinstall Server Using:
−
We will guide you step by step through the whole installation and configuration process.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
+
|style="padding: 0px 0px 0px 45px;"|✔ Operating Systems
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_0.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Applications
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory. <br/>
+
|style="padding: 0px 0px 0px 30px;"|✔ Create/Manage/Revert Snapshots
−
The content of the package to upload should look like this.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_1.png]]
+
|style="padding: 0px 0px 10px 30px;"|✔ View Scheduled And Completed Tasks
 
|}
 
|}
 +
*'''Configurable Options:'''
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install SolusVM 2 VPS & Cloud For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br/>
+
|style="padding: 10px 0px 0px 30px;"|✔ Virtual CPUs
−
File is located in '' 'modules/servers/solusvm2/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM3.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Limit of CPU [VZ]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br/>
+
|style="padding: 0px 0px 0px 30px;"|✔ CPU Units for the VS
−
Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SVM4.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Disk Size
 
|}
 
|}
−
==Configuration of API Access==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''6. Now, we will show you how to configure a new product.'''<br/>
+
|style="padding: 0px 0px 0px 30px;"|✔ Amount of RAM
−
Firstly, log in to your SolusVM admin area, go to '' 'Configuration' → 'API Access' '' and press  '' 'Add API User'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM5.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Amount of SWAP [VZ]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''7. Fill in your IP address and once again click on '' 'Add API User' '' button.'''
+
|style="padding: 0px 0px 0px 30px;"|✔ IO Priority [VZ]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SVM6.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Additional IPv4 Addresses
 
|}
 
|}
−
==Configuration of Server==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''8. Now, log in to your WHMCS admin area and proceed to '' 'System Settings' → 'Servers'.'''''<br/>
+
|style="padding: 0px 0px 0px 30px;"|✔ Additional IPv6 Addresses
−
Afterwards, press '' 'Add New Server'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM7.png]]
+
|style="padding: 0px 0px 10px 30px;"|✔ OS / Application
 
|}
 
|}
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. Enter your server name and IP address.'''<br/>
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support With Custom Translations Tool
−
Choose '' 'SolusvmExtendedVPS' '' from a dropdown menu and provide:
+
−
*'''Username''' - fill in with API User ID
+
−
*'''Password''' - fill in with API User Key
+
−
Check if your server use SSL connection and optionally provide a custom port (by defualt the '' '5656' '' is used). <br/>
+
−
Press '' 'Save Changes' '' when ready.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM8.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.2 Back To PHP 8.1
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''10. After configuring your server correctly, you are going to see the following screen.'''<br/>
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
−
Test your connection and API key through pressing '' 'Test Connection'.''<br/>
+
−
Now, you need to create a new group for your server. For that purpose press '' 'Create New Group'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM9.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.12 Back To WHMCS V8.9
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''11. Fill in name, choose a previously created server and press '' 'Add'.'' '''<br/>
+
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V14 Or Later
−
Confirm by clicking on '' 'Save Changes'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SVM10.png]]
+
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/solusvm-2-vps-and-cloud#open-source-version Open Source Version]
 
|}
 
|}
  
−
==Configuration of  Product==
+
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''12. In order to create and configure product, go to '' 'System Settings'  → 'Products/Services'.'''''<br/>
+
|style="padding: 10px 0px 15px 15px;"|'''In this tutorial we will show you how to successfully install [https://www.modulesgarden.com/products/whmcs/solusvm-2-vps-and-cloud SolusVM 2 VPS & Cloud For WHMCS.]'''<br/>
−
Afterwards, click on '' 'Create a New Group'. ''
+
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM11.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''13. Fill in a product group name and press '' 'Save Changes'.'''''
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_0.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM12.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory. <br/>
 +
The content of the package to upload should look like this.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''14. When you have a product group, you can create your product and assign it to SolusVM Extended VPS.'''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_1.png]]
−
To create a product click on '' 'Create a New Product'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM13.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install SolusVM 2 VPS & Cloud For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br/>
 +
File is located in '' '/modules/servers/SolusVM2VpsCloud/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''15. Afterwards, choose your product type and product group from dropdown menus, fill in your product name and press '' 'Continue'.'''''
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM14.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br/>
 +
Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''16. Now, go to '' 'Module Settings' '' section, choose both '' 'SolusvmExtendedVPS' '' and a previously created server group from dropdown menus.'''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_3.png]]
−
Afterwards, press '' 'Save Changes'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM15.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step, set up the 'storage' folder as recursively writable.<br/>
 +
This folder is available at 'your_whmcs/modules/servers/SolusVM2VpsCloud/storage'.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''17. Start configuration of a product with '' 'Product Configuration' '' section.<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_3_1.png]]
−
Select desired '' 'Virtualization Type' '' and press '' 'Save Changes' '' in order to load the virtualization.
+
 
|}
 
|}
 +
 +
==Activation of SolusVM 2 VPS & Cloud Addon==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM16.png]]
+
|style="padding: 10px 0px 15px 15px;"|'''7. Firstly, activate the SolusVM 2 VPS & Cloud addon.''' <br />
 +
To do so, log in to your WHMCS and navigate to '' 'System Settings'  →'Addon Modules'.'' Find '' 'SolusVM 2 VPS & Cloud' '' and press '' 'Activate'.''<br/>
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''18. Now, choose '' 'Default Node', 'Plan', 'Default Operating System', 'Number of IPs' '' and '' 'Default Node Group'.''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_4_1.png]]
−
''Note: default data will be used if no configurable options are generated!''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM17.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''8. In the next step, you need to permit access to this module.'''<br />
 +
To do so, click on the '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''19. Define features available in the client area through marking/unmarking them under '' 'Client Area Features' '' section.'''<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_4_2.png]]
−
'''Important:''' Keep in mind that the root password is generated automatically for KVM virtualization upon its creation and reset.<br/>
+
−
There is no possibility to set your own password due to SolusVM API limitations to KVM virtualization.
+
 
|}
 
|}
 +
 +
==Configuration of Server==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM17_1.png]]
+
|style="padding: 10px 0px 15px 15px;"|'''9. Now, log in to your WHMCS admin area and proceed to '' 'System Settings' → 'Servers'.'''''<br/>
 +
Afterward, press '' 'Add New Server'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''20. At the very bottom you may change available nodes names to any friendly name.'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''10. Enter your server name and IP address.'''
 +
* Set the '''Module''' to '' 'SolusVM 2 VPS & Cloud For WHMCS'.''
 +
* Fill in the '''Secret Access Key''' with your SolusVM 2 API token. <br/> '''''Important:''' Make sure the token is created for a user with the 'Admin' role. Some functions of the module might not work properly otherwise.''<br/>
  
 +
Check '''Secure''' option if your server uses an SSL connection.<br/>
 +
You may test the connection by clicking on the dedicated button if successful, press '' 'Save Changes' '' to complete the server configuration.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM17_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''21. The final step is generating default configurable options.'''<br/>
+
|style="padding: 0px 0px 20px 15px;"|'''11. Now, you need to create a new group for your server. For that purpose press '' 'Create New Group'.''
−
To do so, press '' 'Generate Default' '' near '' 'Configurable Options' '' as shown on the screen below.<br/>
+
−
Any time you wish to refresh the list of your OS Templates and ISO Images press '' 'Synchronize' '' button marked on the following screen with a red arrow.<br/>
+
−
''Note 1: You can set up user friendly names for the templates through editing configurable option group assigned to the product.''<br/>
+
−
''Note 2: If you remove OS template or ISO image from the configurable option, it will be restored during synchronization.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM17_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_6.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''You have just finished the installation and configuration of the module!
+
|style="padding: 0px 0px 15px 15px;"|'''12. Fill in name, choose a previously created server and press '' 'Add'.'' '''<br/>
 +
Confirm by clicking on '' 'Save Changes'.''
 
|}
 
|}
−
 
−
=Management=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''SolusVM Extended VPS For WHMCS offers very intuitive management of virtual servers both for your admins and clients.'''<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_7.png]]
−
In addition, it provides you with the ability to offer your clients VPS tailored to their needs.<br/>
+
|}
−
Owing to the integration with Advanced Billing For WHMCS you can even offer a product, which client will be billed for depending on its usage.
+
  
 +
==Configuration of  Product==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|'''13. In order to create and configure product, go to '' 'System Settings'  → 'Products/Services'.'''''<br/>
 +
Afterwards, click on '' 'Create a New Group'. ''
 
|}
 
|}
−
==Interface==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Now let's check the interface of the module in your WHMCS client area. As you can see, everything your customers need is in one place.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_8.png]]
−
''Note: List of available features depends on the selected virtualization.''<br/>
+
−
''Due to that, you have to manually disable features from the client area which are not supported by the selected virtualization.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM18.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''14. Fill in a product group name and press '' 'Save Changes'.'''''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can monitor and manage each product from your WHMCS admin area.
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SVM20.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''15. When you have a product group, you can create your product and assign it to SolusVM 2 VPS & Cloud.'''<br/>
 +
To create a product click on '' 'Create a New Product'.''
 
|}
 
|}
−
 
−
==Management of Server==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Module allows your customers to easily manage your server: boot, reboot, shutdown, access SSH/VNC/HTML5 console, enable/disable PAE and PXE or reconfigure network.<br/> Additionally, you can log into control panel, rebuild servers and view usage graphs.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_10.png]]
−
In addition to that, your clients can change hostname and root password.<br/>
+
−
Depending on the chosen virtualization type and selected in '' 'Module Settings' '' options, module allows your customers to mount/unmount ISO and enable/disable TUN/TAP.<br/>
+
−
'''Important:''' Keep in mind that the root password is generated automatically for KVM virtualization upon its creation and reset.<br/>
+
−
There is no possibility to set your own password due to SolusVM API limitations to KVM virtualization.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM21.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''16. Afterward, choose your product type and product group from dropdown menus, fill in your product name and press '' 'Continue'.'''''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|As you can see on the following screen, a VPS of KVM type is different than OpenVZ type.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_11.png]]
−
The most noticeable difference is noVNC Console near Console button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SVM21_1.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''17. Now, go to '' 'Module Settings' '' section, and choose both '' 'SolusVM 2 VPS & Cloud' '' and a previously created server group from the dropdown menus.'''
 
|}
 
|}
−
===SSH Console===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|It's one of the most interesting functionalities is SSH console, where your clients can remotely manage the server. To access it, simply press '' 'Console' '' button.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_12.png]]
−
''Note: This type of console is available only for OpenVZ & Xen virtualization.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SV22.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''18. Start configuration of a product with the '' 'General' '' section.
 +
* First of all, choose the '''Product Type:''' '' 'VPS' '' or '' 'Cloud'.''
 +
* Next, select the desired '''Virtualization Type:''' '' 'KVM' '' or '' 'VZ'.''
 
|}
 
|}
−
 
−
===VNC Console===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The module also enables remote access to VNC console.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_13.png]]
−
''Note: VNC console is used by KVM and Xen HVM virtualization.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SV23.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''19. Now, choose the general settings.
 +
*'''Default User Role''' - new clients will be added to the SolusVM 2 panel, pick the role they will be assigned by default.
 +
*'''Storage Type''' - select the storage type, options are defined in SolusVM 2 panel.
 +
*'''Image Format''' - select the storage format, options are defined in SolusVM 2 panel.<br/>'''''Note:''' Some 'Storage Type' and 'Image Format' combinations may not support certain functions (e.g., snapshots), more information can be found in the [https://docs.solusvm.com/v2/quick-start-guide/Administration.html#3-adding-a-plan official SolusVM documentation].''
 +
*'''Location''' - select the server location, you can add more locations in the SolusVM 2 panel.
 +
*'''Compute Resource''' - select the resource to be used, those can be prepared in the SolusVM 2 panel beforehand.<br/> You can also set it to '' 'Auto' '' to let SolusVM 2 decide which resource to use each time a virtual machine is created.
 
|}
 
|}
−
===HTML5 noVNC Console===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The module also enables usage of HTML5 noVNC console.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_14.png]]
−
''Note: noVNC console is used by KVM and Xen HVM virtualization.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SV23_1.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''20. Set up the limits on the virtual machine.'''<br/>
 +
For both virtualization types, these are:
 +
*'''Virtual CPUs''' - number of virtual CPUs assigned.
 +
*'''Disk Size''' - disk size reserved.<br/>'''''Note:''' Remember that there has to be at least 3GB of free space for the initial machine creation and at least 10GB for reinstallation.''
 +
*'''Memory''' - memory size of the virtual machine
 +
*'''Additional IPv4 Addresses''' - additional ipV4 addresses to be added during creation.
 +
*'''Additional IPv6 Addresses''' - additional ipV6 addresses to be added during creation.
 +
*'''Backup Files''' - the maximum number of backup files, set it to '' '-1' '' to disable the limit.
 +
Additionally, for the VZ virtualization type define:
 +
*'''vCPU Units''' - this argument is used in the kernel fair scheduler. The larger the number is, the more CPU time the virtual machine gets relative to other virtual machines.
 +
*'''vCPU Limit''' - the number of CPUs the virtual machines will be limited to. Enter '' '0' '' to disable the limit.
 +
*'''IO Priority''' - this number determines the priority of the VM's I/O requests relative to I/O requests of other virtual machines.
 +
*'''SWAP''' - the size of the SWAP file in MiB.
 
|}
 
|}
−
===HTML 5 Serial Console===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|And the last supported console is HTML 5 serial console. <br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_15.png]]
−
 
+
−
Please be informed that the installation of some dependencies is mandatory within your SoulsVM instance, in order to use the console.<br/>
+
−
<b>Here is the [https://documentation.solusvm.com/display/DOCS/HTML+5+Serial+Console official SoulsVM documentation] regarding the installation of dependencies.</b><br/><br/>
+
−
 
+
−
''Note: HTML 5 Serial Console is used by OpenVZ and Xen virtualization.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SV23_2.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''21. Define the default configuration.'''
 +
*'''Enable IPv4''' - decide if IPv4 protocol should be used.
 +
*'''Enable IPv6''' - decide if IPv6 protocol should be used.
 +
*'''Operating System / Application''' - select the image to be used during creation.
 +
*'''User Data''' - include any additional commands to be run during the first server boot.<br/>'''''Note:''' The commands depend on the system you choose, a list of WHMCS variables that can be used with the commands has been provided as well, e.g., $email''
 
|}
 
|}
−
 
−
===Rebuild===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Rebuild feature allows you to change OS template from available OS templates list.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_16.png]]
−
To rebuild your server click on '' 'Rebuild' '' button, choose template and confirm by pressing'' 'Rebuild' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SVM24.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''22. Configure service-related options.'''
 +
*'''Generate Password''' - Decide if you want the service password to be generated automatically.
 +
*'''Password Length''' - Define how long the password will be.
 +
*'''Available Characters''' - Include characters available in the password generation process. By default, the field includes all characters permitted in SolusVM 2.<br/>We recommend only substracting from the default list, as adding new characters may result in validation issues.
 +
'''Default Characters:'''
 +
abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890!@#$%^&*-_
 
|}
 
|}
−
 
−
===Graphs===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Move to '' 'Graphs' '' section. You will find there visualizations of your current '' 'Network Traffic', 'Load Average' '' and '' 'Memory Usage'.''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_16_1.png]]
−
Tracking your VPS usage you avoid sudden and unexpected overload.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SVM21_2.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''23. Define features available in the client area by marking them in the '' 'Client Area Features' '' section.'''<br/>
 +
The functions that can be made available:
 +
*'''Start''' - allows clients to power on their virtual machines.
 +
*'''Stop''' - lets clients shut down their virtual machines.
 +
*'''Restart''' - enables clients to reboot their virtual machines.
 +
*'''Shut Down''' - allows clients to turn off their virtual machines completely.
 +
*'''Console''' - provides clients with access to their virtual machine’s console interface.
 +
*'''Rescue Mode''' - lets clients enable or disable rescue mode on their virtual machines.
 +
*'''Change Password''' - allows clients to update the root passwords of their virtual machines.
 +
*'''Log In To Panel''' - enables clients to access the SolusVM 2 panel.
 +
*'''Backups''' - allows clients to create and manage backups of their virtual machines.
 +
*'''Graphs''' - displays performance and status graphs for virtual machines.
 +
*'''Network''' - lets clients view IP addresses, gateways, nameservers, and set primary networks.
 +
*'''Reinstallation''' - allows clients to reinstall their virtual machines with different systems or applications.
 +
*'''Snapshots''' - enables clients to capture snapshots of their virtual machines.<br/>'''''Note:''' Snapshots can be taken on KVM virtualizations with LVM or ThinLVM storage types. If the image format is qcow2, File Based and NFS storage types can be used as well.
 +
*'''Tasks''' - lets clients view the tasks performed on their virtual machines.
 +
Images available for reinstallation:
 +
*'''Available Operating Systems'''
 +
*'''Available Applications'''
 
|}
 
|}
−
 
−
===Rescue Mode (KVM Only)===
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|One of the options available is Rescue Mode that may be turned on/off by the client. It allows to boot the server directly into the rescue mode.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_17.png]]
−
Press to enable this functionality.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM21_3.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''24. Generate default configurable options.'''<br/>
 +
To do so, press '' 'Generate' '' as shown on the screen below. You can choose which options to generate. Some options only work with virtual server [VS] virtualization type. <br/>
 +
'''''Note:''' This step is optional. It is advisable not to generate options that you do not plan to use, or in case you want their fixed values to be taken from the module settings, rather than being flexible.''<br/>
 +
When you are done with the module settings make sure to ''' 'Save Changes'.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|A pop up window appears, select a kernel from the list of available and enable it. SSH details will be viewed immediately.  
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_18.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SVM21_4.png]]
+
|style="padding: 0px 0px 30px 15px;"|'''25. As the last step add a cron job as shown below (5-minute intervals are recommended).'''
 +
php -q /your_whmcs/modules/servers/SolusVM2VpsCloud/cron/cron.php queue
 +
This cron makes sure tasks are run automatically when in the queue.<br/>
 +
Do not forget to replace '' 'your_whmcs' '' with your WHMCS root location. The cron can be also executed every single minute in order to perform the action more often.<br/>
 +
You will find personalized cron job information in the '' 'Queue' '' section of the addon. <br/><br/>
 +
'''You have just finished the installation and configuration of the product, congratulations!'''
 
|}
 
|}
  
−
==Management of Email Templates==
+
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can automatically send your customers emails with details of newly created virtual servers.<br/>
+
|style="padding: 10px 0px 30px 15px;"|'''You have just correctly created and customized a new product.'''<br/> Let us continue to the module management. The client area, the admin area and the addon will be described in detail in this section.
−
To do so, create a new email template with '' 'Product' '' type and '' 'Unique Name' '' specified in [https://documentation.solusvm.com/display/DOCS/Email+Templates SolusVM Documentation], in our case it is '' 'KVM Virtual Server'.''<br/>
+
−
'''Usage of unique names other than specified in the above documentation makes it impossible to send emails.'''<br/>
+
−
''Note: The only supported email template unique names are: 'OpenVZ Virtual Server', 'Xen PV Virtual Server', 'Xen HVM' and 'KVM Virtual Server'.''
+
 
|}
 
|}
 +
==Addon Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM30.png]]
+
|style="padding: 10px 0px 30px 15px;"|'''Now we will highlight the features of the addon first.'''<br />
 +
Go to '' 'Addons' '' → '' 'SolusVM 2 VPS & Cloud' '' in your WHMCS to access it.
 
|}
 
|}
 +
===Servers===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can paste the email content from SolusVM Documentation or create your own. Owing to our module, you can also use variables:
+
|style="padding: 10px 0px 20px 15px;"|'' 'Servers' '' section contains a list of your configured servers, you may quickly edit them directly from this tab, simply press the edit icon.<br/>
−
*{$service_custom_field_rootpassword}
+
The information displayed in the addon includes:
−
*{$service_custom_field_vncip}
+
*'''Server name'''
−
*{$service_custom_field_vncport}
+
*'''Server IP address'''
−
*{$service_custom_field_vncpassword}.
+
*'''Server active accounts number and limit'''
 +
*'''Server status'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SVM31.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_20.png]]
 
|}
 
|}
−
 
−
==Management of Custom Hooks==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Our module allows you to use custom hooks. All you need is knowledge of PHP programming language.<br/>
+
|style="padding: 0px 0px 15px 15px;"|Click on the '' 'OS Images & Applications Icons' '' button to view a list of images available on the server. <br/>
−
Possible hooks are:
+
You can change the image associated with each operating system and application by clicking the '' 'Settings' '' icon and choosing a picture from the media library.
−
*solusvmExtendedVPS_customclientarea($params)
+
−
*solusvmExtendedVPS_hostname($params)
+
−
*solusvmExtendedVPS_username($params)
+
−
*solusvmExtendedVPS_AdminLink($params)
+
−
*solusvmExtendedVPS_create_one($params)
+
−
*solusvmExtendedVPS_create_two($params)
+
−
*solusvmExtendedVPS_create_three($params)
+
−
*solusvmExtendedVPS_create_four($params)
+
−
*solusvmExtendedVPS_create_five($params)
+
−
*solusvmExtendedVPS_terminate_pre($params)
+
−
*solusvmExtendedVPS_terminate_post_success($params)
+
−
*solusvmExtendedVPS_terminate_post_error($params)
+
−
*solusvmExtendedVPS_suspend_pre($params)
+
−
*solusvmExtendedVPS_suspend_post_success($params)
+
−
*solusvmExtendedVPS_suspend_post_error($params)
+
−
*solusvmExtendedVPS_unsuspend_pre($params)
+
−
*solusvmExtendedVPS_unsuspend_post_success($params)
+
−
*solusvmExtendedVPS_unsuspend_post_error($params)
+
−
*solusvmExtendedVPS_changepackage_pre($params)
+
−
*solusvmExtendedVPS_changepackage_post_success($params)
+
−
*solusvmExtendedVPS_changepackage_post_error($params)
+
−
To enable these hooks, you have to rename file '' 'custom-rename.php' '' to '' 'custom.php'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM34.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_21.png]]
 
|}
 
|}
 +
 +
===Media Library===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now your hooks are active, but since they are empty they do nothing. To find hooks' details, read a previously edited file.<br/>
+
|style="padding: 10px 0px 15px 15px;"|The '' 'Media Library' '' section stores images that can be used as thumbnails for your operating system and application images. <br/>
−
In the mentioned file you are going to find the hook, information about its time of run, returned values and parameters.<br/>
+
Use the Additional Actions to delete all images at once. <br/>
−
For example, if you have no domains but want to have hostname, you should set default value for hostname.<br/>
+
To upload a new image, use the '' 'Upload Image' '' button.
−
To do so, find hook '' 'solusvmExtendedVPS_hostname($params)' '' and type '' 'return 'myhostname.com';' '' inside of it.<br/>
+
−
It should look like on the screen below:
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SVM35.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_22.png]]
 
|}
 
|}
  
−
==Dynamic Server Resources Setup With Configurable Options==
+
===Queue===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|If you wish to allow your clients to order servers with resources they choose, use configurable option group.<br/>
+
|style="padding: 10px 0px 15px 15px;"|In this section, you will find a list of all the tasks issued by the module.<br/>
−
To generate a configurable option group for a product, head to the 19th step of '' '[https://www.docs.modulesgarden.com/SolusVM_Extended_VPS_For_WHMCS#Configuration_of_Product Configuration of Product]' '' instruction.<br />
+
The information on each task includes:
−
The final result visible in the order form should be similar to the one presented on the following screen.<br/>
+
*'''Task ID'''
−
''Note: Field '' 'Username' '' appears only during ordering the first SolusVM VPS by client.''<br/>
+
*'''Related item'''
−
''In order to show that field, unmark '' 'One SolusVM User Per VPS For The Same Client' '' and mark '' 'Username When Ordering' '' checkbox.''
+
*'''Task status'''
 +
*'''Task type'''
 +
*'''Attempts taken'''
 +
*'''Date of creation'''
 +
*'''Date of the last status update'''
 +
You may also use the action buttons to:
 +
*'''See task details'''
 +
*'''Manually run the task'''
 +
*'''Delete the task'''
 +
To find specific tasks use the search and sorting functions.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM35_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_23.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If automatically generated configurable options do not fulfill your clients' needs, you can edit them using [https://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options this guide].
+
|style="padding: 0px 0px 15px 15px;"|Task details include:
 +
*'''Task ID'''
 +
*'''Job'''
 +
*'''Queue'''
 +
*'''Retry Count'''
 +
*'''Parent ID'''
 +
*'''Type'''
 +
*'''Related Item'''
 +
*'''Custom Relation'''
 +
*'''Status'''
 +
*'''Retry After Date'''
 +
*'''Created At Date'''
 +
*'''Updated At Date'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM35_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_23_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If you decide to set up pricing depending on the ordered resource, you can find instruction on how to proceed [https://www.docs.modulesgarden.com/General#Setting_Up_Pricing_For_Configurable_Options here].
+
|style="padding: 0px 0px 20px 15px;"|Related log entries can be found in a separate tab.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM35_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_23_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|If you prefer to charge your clients for server resources they actually use, you can use our [https://www.modulesgarden.com/products/whmcs/advanced-billing/features Advanced Billing For WHMCS] module.  
+
|style="padding: 0px 0px 20px 15px;"|Tasks can also be deleted with the mass action function.
 
|}
 
|}
−
 
−
==Management of DNS==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|When you combine SolusVM Extended VPS For WHMCS with  [https://www.docs.modulesgarden.com/index.php?title=DNS_Manager_For_WHMCS&oldid=19472 DNS Manager For WHMCS], your clients will be able to manage PowerDNS zones and records from the client area.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_23_3.png]]
−
DNS Manager For WHMCS will allow your customers to manage DNS zones, records and ReverseDNS.<br/>'' '''Important:''' SolusVM Extended VPS For WHMCS is compatible with DNS Manager For WHMCS V2.x.x.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To connect both modules, go to '' 'Settings' → 'Packages' '' section of DNS Manager and add a new package.
+
|style="padding: 0px 0px 20px 15px;"|Additional actions include the '' 'Auto Prune' '' system, which will automatically delete tasks after a predefined number of days and an option to disable cron job information.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV2_26.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_24.png]]
 
|}
 
|}
 +
 +
===[https://www.docs.modulesgarden.com/Translations_Tool Translations]===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Name the package and provide any details you find useful. Then proceed to '' 'Item' '' section.
+
|style="padding: 10px 0px 15px 15px;"|Customizing language files is now extremely easy with the '' "Translations" '' tool that is now available directly in the addon.<br.> Its user-friendly design makes managing various language file tweaks a smooth and efficient process. <br/>
 +
Prepare translations for the original English files with this handy built-in tool. For specific instructions on how to use this tool please refer to its dedicated article, you will find it [https://www.docs.modulesgarden.com/Translations_Tool here].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV2_27_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_25.png]]
 
|}
 
|}
 +
 +
<!---
 +
===Logs===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Select SolusVM Extended VPS from the list of products and click on '' 'Add' ''.
+
|style="padding: 10px 0px 15px 15px;"|The '' 'Logs' '' page is where you will find detailed information about the actions the module is performing.<br/>
 +
Use the action buttons to see details or delete each log entry. Multiple logs can be deleted at once by utilizing the mass selection function.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV2_27.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_26.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Your package should now appear on the list. To change its status click on the button as shown below.
+
|style="padding: 0px 0px 20px 15px;"|Furthermore, the logs feature additional actions. Changing the logs' settings, exporting the logs to a '' '.csv' '' file, and a way to delete specific log types.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV2_28.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_26_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Once done, you will see a proper note.
+
|style="padding: 0px 0px 20px 15px;"|In the settings you can specify which log types should be recorded, and whether they should be deleted automatically after a specific time.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV2_29.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_26_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, buttons 'Manage DNS' and 'Manage Reverse DNS' will appear in the client area as shown on the screen below.
+
|style="padding: 0px 0px 20px 15px;"|While exporting you will pick a time frame and the log types to export.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_30.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_26_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can find 'Manage DNS' option also in the left menu.
+
|style="padding: 0px 0px 20px 15px;"|Here you can decide which log types to delete, you can also specify how old the logs have to be to qualify for deletion. Leave the first field empty to delete all logs.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_30_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_26_4.png]]
 
|}
 
|}
 +
--->
 +
 +
==Admin Area==
 +
===VPS===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Depending on previously chosen settings, your customers will be able to add and remove DNS zones.
+
|style="padding: 10px 0px 15px 15px;"|Admins can monitor and manage the virtual machines on the client's page.<br/>
 +
The action buttons include:
 +
*'''Start the machine'''
 +
*'''Stop the machine'''
 +
*'''Shut down the machine'''
 +
*'''Restart the machine'''
 +
*'''Access the machine's console interface'''
 +
*'''Log in to SolusVM 2 panel'''
 +
*'''Enable/Disable Rescue Mode'''
 +
*'''Change the password of the machine'''
 +
*'''Import From SolusVM 2.0 WHMCS Addon''' <br/>'''''Note:''' Only available before a virtual machine is created in the new service, allows you to import an existing machine.''
 +
Underneath the information regarding the virtual machine is located, it includes:
 +
*'''Status of the machine'''
 +
*'''Hostname'''
 +
*'''vCPUs in use'''
 +
*'''Disk space allocated to the machine'''
 +
*'''Operating system/application currently used'''
 +
All tasks from the SolusVM 2 panel are logged in the '' 'Tasks' '' table. The '' 'Queue' '' table lists the tasks issued by the module.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_31.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_27.png]]
 
|}
 
|}
  
−
==Management of Billing==
+
===Cloud===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|When you combine SolusVM Extended VPS For WHMCS with [https://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS Advanced Billing For WHMCS], you will be able to set up additional billing options.
+
|style="padding: 10px 0px 15px 15px;"|Admins can monitor and manage the machines on the client's page.<br/>
 +
The '''Available Resources''' graph displays how much of the distributed resources are in use.<br/>
 +
The '''Virtual Machine list''' features details about the client's servers and offers options to:
 +
*'''Start the machine'''
 +
*'''Stop the machine'''
 +
*'''Shutdown the machine'''
 +
*'''Restart the machine'''
 +
*'''Toggle Rescue Mode on the machine'''
 +
*'''Open Console of the machine'''
 +
and import new virtual machines.<br/>'''''Note:''' Including an option to import from the SolusVM 2.0 WHMCS Addon''<br/>
 +
All tasks from the SolusVM 2 panel are logged in the '' 'Tasks' '' table.<br/>
 +
The '' 'Queue' '' table lists the tasks issued by the module.<br/>
 +
'''''Note:''' Keep in mind that the 'Suspend' module command will suspend all machines.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV32.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_28.png]]
 
|}
 
|}
 +
 +
==Client Area - VPS==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|The module allows you to charge your customers basing on the server resources they use.
+
|style="padding: 10px 0px 15px 15px;"|For the VPS products, clients have access to basic actions and information regarding their virtual machine. <br/>
 +
The basic actions include:
 +
*'''Start'''
 +
*'''Stop'''
 +
*'''Shut Down'''
 +
*'''Restart'''
 +
*'''Open Console'''
 +
*'''Log in To Panel'''
 +
*'''Toggle Rescue Mode'''
 +
*'''Change Password'''
 +
If enabled, additional tools will also be available to the user. <br/>
 +
The current information about the virtual machine is displayed in the '' 'Information' '' table.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SV33.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_29.png]]
 
|}
 
|}
 +
===Backups===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|With Advanced Billing module, you can also display the current server resource usage and their cost, as well as other allowed in Advanced Billing options that are on offer.
+
|style="padding: 10px 0px 15px 15px;"|Users can create and manage backups in the '' 'Backups' '' tab. <br/>
 +
To create a new backup use the '' 'Create Backup' '' button. <br/>
 +
Once a backup is created, it can be deleted or used to restore the virtual machine state by clicking the action buttons next to each backup on the list.<br/>
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SVM34_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_30.png]]
 
|}
 
|}
  
−
==Debug Mode==
+
===Graphs===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|SolusVM Extended VPS is a very complex module. Therefore many things might go wrong.<br/>
+
|style="padding: 10px 0px 15px 15px;"|Clients will find visualizations of their current '' 'CPU Usage', 'Disk Throughput' '', '' 'Network Throughput' '' and '' 'Memory Usage'.''<br/>
−
To help you quickly solve various problems usually connected with WHMCS product/server configuration and SolusVM server configuration, we created '' 'Debug Mode'.''<br/>
+
By tracking VPS usage sudden and unexpected overloads can be avoided.
−
To enable it, go to '' 'Module Settings' '' of your product and tick '' 'Debug Mode' '' as shown on the screen below.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM36.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_31.png]]
 
|}
 
|}
 +
 +
===Network===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Afterwards, go to '' 'Utilities' → 'Logs' → 'Module Log' '' and click on '' 'Enable Debug Logging' '' in order to enable it.<br />
+
|style="padding: 10px 0px 15px 15px;"|The network tab contains information regarding the virtual machine's network settings.
−
Now, each action performed by the module will be recorded in the module log.<br/>
+
*'''IP Address'''
−
In that way, you can easily check whether the module correctly fetches the information about virtual servers, nodes, templates, plans etc.<br />
+
*'''Gateway'''
−
If not, it will indicate a problem with WHMCS product/server configuration or your SolusVM server.<br/>
+
*'''Primary Name Server'''
−
The following screen presents an exemplary module log.
+
*'''Secondary Name Server'''
 +
and whether a given network is set as a primary for the virtual machine.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM37.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_32.png]]
 
|}
 
|}
 +
 +
===Reinstallation===
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|Remember to turn off Debug Mode after you fix the problem.
+
|style="padding: 10px 0px 15px 15px;"|The '' 'Reinstall' '' tab contains a list of operating systems and applications allowed for virtual machine reinstallation.<br/>
 +
Clicking on any of the icons will initiate the reinstallation process, after a confirmation popup.
 
|}
 
|}
−
 
−
==Importing Existing VPS==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In this section, you can find short instruction on how to connect one of your clients to your already existing VPS in Solus panel. <br/> Take the following steps to make sure that the process will be carried out properly. <br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_33.png]]
−
1. Firstly, manually create an order for your customer in WHMCS. Choose a client and in the summary, view click on the '' ' Add New Order' '' button. Next, select a '' 'Product/Service' '' and press '' 'Submit Order' ''. <br/> '''What is important, do not perform the '' 'Create' '' action.''' The status has to remain as '' 'Pending' ''. <br/> More info about placing orders can be found [https://docs.whmcs.com/Order_Management#Placing_an_Order here]<br/>
+
|}
−
2. Proceed to the newly created product's card in your admin area. Find the following custom fields:
+
−
*'''vserverid'''
+
−
*'''nodeid'''
+
  
−
The above-mentioned information has to be consistent with the data from your Solus panel. Now, complete these fields as presented below. <br/> '''Important!''' Remember to make sure that the format of the provided data is compatible with the format supported by the module. You can preview it for another product of the module you have already created and enter it in a similar way. <br/> If you completed the required data, now change the status from '' 'Pending' '' to '' 'Active' '' and '' 'Save Changes' ''.  
+
===Snapshots===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|The '' 'Snapshot' '' tab allows the users to create new snapshots and manage their snapshot library.<br/>
 +
Use the '' 'Create Snapshot' '' button to take a new snapshot. <br/>
 +
The action buttons below can be used to restore a snapshot or delete it.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM38.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_34.png]]
 
|}
 
|}
 +
 +
===Tasks===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|3. If the completed data is correct, after refreshing the page, you will see the attached VPS from Solus. <br/> '''Important!''' Remember to manually add other missing parameters of the VPS such as domains, credentials, IP Addresses, configurable options, SSH Key, billing cycle, etc. so they match the parameters of the attached VPS from Solus.  
+
|style="padding: 10px 0px 15px 15px;"|The list of tasks related to the client's virtual machine can be found in the '' 'Tasks' '' tab.<br/>
 +
The list features details such as:
 +
*'''Task start time'''
 +
*'''Task finish time'''
 +
*'''Action'''
 +
*'''Status'''
 +
*'''Duration'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_35.png]]
 
|}
 
|}
  
−
=Tips=
+
==Client Area - Cloud Type==
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"|1. We made every effort to make our module as easy to install, configure and use, as possible. Therefore, we paid special attention to displayed messages.<br />
+
|style="padding: 10px 0px 15px 15px;"|The client area of cloud products features '' 'Available Resources' '' information table and the '' 'Virtual Servers' '' list. <br/>
−
Read each message carefully, follow the instructions and you shall have no problems using the module.
+
The table features a graphical representation of the resource usage of
 +
*'''vCPUs cores'''
 +
*'''Disk limits'''
 +
*'''Memory limits'''
 +
*'''Additional IPv4 addresses'''
 +
*'''Additional IPv6 addresses'''
 +
Hovering over the question mark icon will display the exact numbers for each metric.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 5px 15px;"|2. Operations performed on the virtual servers are not executed immediately. Give your SolusVM server some time to process the request and execute the operation.
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_36.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 5px 15px;"|3. In the current version of SolusVM API there is no possibility to automatically upgrade Virtual Machine, therefore you have to perform this action manually.<br />
+
|style="padding: 0px 0px 15px 15px;"|Action buttons allow managing, deleting, and performing actions on existing servers.
−
Upgrading package in the SolusVM VPS Extended module means upgrading Solus Plan.
+
*'''Manage Virtual Server''' - opens the details page where changes can be introduced.
 +
*'''Delete''' - starts the task of deleting the server.
 +
*'''Additional Actions''' - allows actions such as: '' 'Start ','' '' 'Stop','' '' 'Shut Down','' '' 'Restart','' '' 'Toggle Rescue Mode','' and '' 'Open Console'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 5px 15px;"|4. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_36_1.png]]
 
|}
 
|}
 +
===New Virtual Machine===
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|5. If you want a random hostname to be generated, enable the ''' 'Random Hostname' ''' option in the '' 'Admin Area Features' '' of the module settings.  
+
|style="padding: 10px 0px 20px 15px;"|
 +
To add a new virtual machine, click on the '' 'Create Virtual Machine' '' button first.
 
|}
 
|}
−
 
−
=Update Instructions=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_37.png]]
−
Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.
+
 
|}
 
|}
−
==Update of Products==
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Our module is entirely compatible with [https://github.com/solusio/SolusVM-WHMCS-Module SolusVM WHMCS Module] ''(previously known as "SolusVM Pro")'' and you can easily upgrade your existing products without losing your settings.<br/>
+
|style="padding: 0px 0px 15px 15px;"|Then provide the configuration for the new virtual machine.
−
1. Go to '' 'System Settings' → 'Products/Services' → 'Module Settings' '' of your product and switch '' 'Module Name' '' from '' 'Solusvmpro' '' to '' 'SolusvmExtendedVPS'.''<br/>
+
*'''Hostname'''
−
2. Proceed to '' 'System Settings' → 'Servers' '' and switch your server type from '' 'Solusvmpro' '' to '' 'SolusvmExtendedVPS'.''<br/>
+
*'''Password'''
−
3. Now, click '' 'System Settings' '' → '' 'Products/Services' '' → '' 'Module Settings' '' of your product and make sure that '' 'Server Group' '' is set up correctly.<br/>
+
*'''SSH Key'''
−
4. The last step is generating default configurable options and custom fields through clicking on '' 'Generate default' '' button.<br/>
+
*'''vCPUs'''
−
Your SolusVM Extended VPS product is ready to use!
+
*'''Disk Size'''
 +
*'''RAM'''
 +
*'''Primary IPv4'''
 +
*'''Primary IPv6'''
 +
*'''Additional IPv4'''
 +
*'''Additional IPv6'''
 +
*'''Image'''
 +
The graph on the top of the screen can help you see how many resources remain while you allocate them to the new machine.<br/>
 +
Click on '' 'Submit' '' when ready.
 
|}
 
|}
−
=Upgrade Guide=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_38.png]]
−
 
+
−
Opt for the [https://www.modulesgarden.com/products/whmcs/solusvm-extended-vps#open-source-version Open Source version] of your SolusVM Extended VPS For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/>
+
−
 
+
−
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.
+
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|You can also manage a machine directly and use additional tools, after selecting it on the side menu.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_39.png]]
 +
|}
 +
{|
  
−
=Common Problems=
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 5px 15px;"|1. Since the SolusVM 2 panel only allows a small number of special signs to be used in passwords, it might be helpful to disable special characters in auto-generated passwords.<br/>To do so, navigate to '' 'General Settings' '' → '' 'Security' '' → '' 'Auto Generated Password Format' '' and select '' 'Generate passwords containing a combination of letters and numbers only'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 5px 15px;"|2. The vast majority of problems are connected with misconfigured SolusVM server or misconfigured servers/products in your WHMCS.<br />
+
|style="padding: 0px 0px 5px 15px;"|2. You can add an SSH Key for a virtual machine using a <code>sshKey|SSH Public Key</code> custom field for the VPS functionality. <br/>For the Cloud functionality, the option to add an SSH Key is available when creating a new virtual machine.
−
Firstly, make sure that your SolusVM server has properly configured virtual servers, nodes, node groups, templates, plans and API access.<br />
+
−
'''In most cases, appropriate SolusVM server configuration guarantees correct operation of the module.'''<br />
+
−
Afterwards, check your WHMCS server connection and products settings. If you are certain that everything is correct, use our [[#Debug Mode|Debug Mode]].
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 5px 15px;"|3. Your client gets white page with '' '{"success":"1","status":"1"}' '' while entering '' 'Control Panel' ''.<br />
+
|style="padding: 0px 0px 30px 15px;"|3. SolusVM 2 VPS & Cloud module can manage virtual machines imported from SolusVM 2.0 WHMCS addon.<br/> To import your machines use the '' 'Import From SolusVM 2.0 WHMCS Addon' '' button found in the admin area.<br/> For VPS products this option is available after service has been activated, but the machine has not been created yet.
−
''Cause'': SolusVM client area template is based on Bootstrap, which may sometimes cause such errors.<br />
+
−
''Solution'': Switch template used by SolusVM client area.
+
 
|}
 
|}
 +
 +
=Update Instructions=
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|4. You have received the following error:
+
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
−
Error 'Fatal error: Call to undefined function mime_content_type() in
+
Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.
−
/your_whmcs/clients/modules/servers/solusvmExtendedVPS/solusvmExtendedVPS.php on line 0 '.
+
−
''Reason:'' Function 'mime_content_type()' is disabled at your server. Our module uses it in order to detect MIME Content-type for a file.<br />
+
−
''Solution:'' Enable function mime_content_type() in your PHP or ask your server provider to do so.
+
 
|}
 
|}
 +
 +
=Upgrade Guide=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/>
 +
 +
Opt for the [https://www.modulesgarden.com/products/whmcs/solusvm-extended-vps#open-source-version Open Source version] of your SolusVM 2 VPS & Cloud For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/>
 +
 +
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.
 +
|}
 +
 +
=Common Problems=
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|5. By default our module connects with SolusVM server on port 5353. If you are using different port, you need to specify it in '' 'Hostname' '' field.<br />
+
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
−
Default port for SSL connections is 5656. To connect on that port enter your hostname as follows: '' 'yourhostname.com:5656' ''. Keep in mind that you can connect on any port.<br />
+
−
Field below '' 'Tick to use SSL Mode for Connections' '' switches connection type between http and https. Note that this is something different from choosing the port to connect.
+
 
|}
 
|}

Latest revision as of 14:55, 16 April 2025

Contents

[edit] About SolusVM 2 VPS & Cloud For WHMCS

SolusVM 2 VPS & Cloud For WHMCS module offers provisioning of virtual machines as single VPS instances or flexible Cloud resources.

Allow your clients to create and manage servers within their limits using efficient tools for backups, snapshots, reinstallations, and real-time performance monitoring.
Use the module to Empower your customers with comprehensive control over their virtual servers.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Product
✔ Change Package
✔ Change Password
✔ Import Virtual Machine (Cloud)
✔ Existing Virtual Machines
✔ From SolusVM 2.0 WHMCS Addon
✔ View Available Resources (Cloud)
✔ Start/Stop/Pause/Unpause/Resume Servers
✔ Access noVNC Console
✔ Enable/Disable Rescue Mode
✔ View Servers Status And Details
✔ View Scheduled And Completed Tasks
✔ View Queue
✔ Provide Product General Configuration:
✔ Select Product Type:
✔ VPS - Provisioning Of Single Server Per Product
✔ Cloud - Enable Provisioning Of Multiple Servers Per Single Product
✔ Select Virtualization Type:
✔ KVM
✔ VZ
✔ Define Image Format
✔ Select Compute Resource
✔ Select Default User Role
✔ Select Storage Type
✔ Select Server Location
✔ Define Server Limits:
✔ Virtual CPUs
✔ vCPU Units (VZ)
✔ vCPU Limit (VZ)
✔ Disk Size [GiB]
✔ Memory [MiB]
✔ IO Priority (VZ)
✔ SWAP [MiB] (VZ)
✔ Additional IPv4 Addresses
✔ Additional IPv6 Addresses
✔ Define Default Server Configuration:
✔ Enable IPv4 And IPv6
✔ Provide User Data Script
✔ Select Default Operating System / Application
✔ Enable Access To Client Area Features:
✔ Backups
✔ Graphs
✔ Network
✔ Reinstall
✔ Snapshots
✔ Tasks
✔ Select Available Operation Systems
✔ Select Available Applications
✔ Select Server Information Entries
✔ Generate Configurable Options
  • Addon Features:
✔ View Server Configurations Lists And Details:
✔ IP Address
✔ Active Accounts
✔ Status
✔ Customize Operation System And Application Logo Images
✔ View Queue Of Scheduled Tasks And Details
✔ Customize Module Language Files With "Translations" Tool
✔ View And Manage Logs
  • Client Area Features:
✔ Manage Single (VPS) Or Multiple (Cloud) Servers Per Product
✔ View Servers Status And Details
✔ View Available Resources (Cloud)
✔ Start/Stop/Restart Servers
✔ Access noVNC Console
✔ Enable/Disable Rescue Mode
✔ Change Server Password
✔ Create/Manage/Restore Backups
✔ View Server Graphs:
✔ CPU Usage
✔ Disk Throughput
✔ Network Throughput
✔ Memory Usage
✔ View Network Details
✔ Reinstall Server Using:
✔ Operating Systems
✔ Applications
✔ Create/Manage/Revert Snapshots
✔ View Scheduled And Completed Tasks
  • Configurable Options:
✔ Virtual CPUs
✔ Limit of CPU [VZ]
✔ CPU Units for the VS
✔ Disk Size
✔ Amount of RAM
✔ Amount of SWAP [VZ]
✔ IO Priority [VZ]
✔ Additional IPv4 Addresses
✔ Additional IPv6 Addresses
✔ OS / Application
  • General Info:
✔ Multi-Language Support With Custom Translations Tool
✔ Supports PHP 8.2 Back To PHP 8.1
✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
✔ Supports WHMCS V8.12 Back To WHMCS V8.9
✔ Requires ionCube Loader V14 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] Installation and Configuration

In this tutorial we will show you how to successfully install SolusVM 2 VPS & Cloud For WHMCS.

We will guide you step by step through the whole installation and configuration process.

1. Log in to our client area and download the module.
SVM2 0.png
3. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

SVM2 1.png
4. When you install SolusVM 2 VPS & Cloud For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in '/modules/servers/SolusVM2VpsCloud/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

SVM2 2.png
5. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

SVM2 3.png
6. In the next step, set up the 'storage' folder as recursively writable.

This folder is available at 'your_whmcs/modules/servers/SolusVM2VpsCloud/storage'.

SVM2 3 1.png

[edit] Activation of SolusVM 2 VPS & Cloud Addon

7. Firstly, activate the SolusVM 2 VPS & Cloud addon.

To do so, log in to your WHMCS and navigate to 'System Settings' →'Addon Modules'. Find 'SolusVM 2 VPS & Cloud' and press 'Activate'.

SVM2 4 1.png
8. In the next step, you need to permit access to this module.

To do so, click on the 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.

SVM2 4 2.png

[edit] Configuration of Server

9. Now, log in to your WHMCS admin area and proceed to 'System Settings' → 'Servers'.

Afterward, press 'Add New Server'.

SVM2 4.png
10. Enter your server name and IP address.
  • Set the Module to 'SolusVM 2 VPS & Cloud For WHMCS'.
  • Fill in the Secret Access Key with your SolusVM 2 API token.
    Important: Make sure the token is created for a user with the 'Admin' role. Some functions of the module might not work properly otherwise.

Check Secure option if your server uses an SSL connection.
You may test the connection by clicking on the dedicated button if successful, press 'Save Changes' to complete the server configuration.

SVM2 5.png
11. Now, you need to create a new group for your server. For that purpose press 'Create New Group'.
SVM2 6.png
12. Fill in name, choose a previously created server and press 'Add'.

Confirm by clicking on 'Save Changes'.

SVM2 7.png

[edit] Configuration of Product

13. In order to create and configure product, go to 'System Settings' → 'Products/Services'.

Afterwards, click on 'Create a New Group'.

SVM2 8.png
14. Fill in a product group name and press 'Save Changes'.
SVM2 9.png
15. When you have a product group, you can create your product and assign it to SolusVM 2 VPS & Cloud.

To create a product click on 'Create a New Product'.

SVM2 10.png
16. Afterward, choose your product type and product group from dropdown menus, fill in your product name and press 'Continue'.
SVM2 11.png
17. Now, go to 'Module Settings' section, and choose both 'SolusVM 2 VPS & Cloud' and a previously created server group from the dropdown menus.
SVM2 12.png
18. Start configuration of a product with the 'General' section.
  • First of all, choose the Product Type: 'VPS' or 'Cloud'.
  • Next, select the desired Virtualization Type: 'KVM' or 'VZ'.
SVM2 13.png
19. Now, choose the general settings.
  • Default User Role - new clients will be added to the SolusVM 2 panel, pick the role they will be assigned by default.
  • Storage Type - select the storage type, options are defined in SolusVM 2 panel.
  • Image Format - select the storage format, options are defined in SolusVM 2 panel.
    Note: Some 'Storage Type' and 'Image Format' combinations may not support certain functions (e.g., snapshots), more information can be found in the official SolusVM documentation.
  • Location - select the server location, you can add more locations in the SolusVM 2 panel.
  • Compute Resource - select the resource to be used, those can be prepared in the SolusVM 2 panel beforehand.
    You can also set it to 'Auto' to let SolusVM 2 decide which resource to use each time a virtual machine is created.
SVM2 14.png
20. Set up the limits on the virtual machine.

For both virtualization types, these are:

  • Virtual CPUs - number of virtual CPUs assigned.
  • Disk Size - disk size reserved.
    Note: Remember that there has to be at least 3GB of free space for the initial machine creation and at least 10GB for reinstallation.
  • Memory - memory size of the virtual machine
  • Additional IPv4 Addresses - additional ipV4 addresses to be added during creation.
  • Additional IPv6 Addresses - additional ipV6 addresses to be added during creation.
  • Backup Files - the maximum number of backup files, set it to '-1' to disable the limit.

Additionally, for the VZ virtualization type define:

  • vCPU Units - this argument is used in the kernel fair scheduler. The larger the number is, the more CPU time the virtual machine gets relative to other virtual machines.
  • vCPU Limit - the number of CPUs the virtual machines will be limited to. Enter '0' to disable the limit.
  • IO Priority - this number determines the priority of the VM's I/O requests relative to I/O requests of other virtual machines.
  • SWAP - the size of the SWAP file in MiB.
SVM2 15.png
21. Define the default configuration.
  • Enable IPv4 - decide if IPv4 protocol should be used.
  • Enable IPv6 - decide if IPv6 protocol should be used.
  • Operating System / Application - select the image to be used during creation.
  • User Data - include any additional commands to be run during the first server boot.
    Note: The commands depend on the system you choose, a list of WHMCS variables that can be used with the commands has been provided as well, e.g., $email
SVM2 16.png
22. Configure service-related options.
  • Generate Password - Decide if you want the service password to be generated automatically.
  • Password Length - Define how long the password will be.
  • Available Characters - Include characters available in the password generation process. By default, the field includes all characters permitted in SolusVM 2.
    We recommend only substracting from the default list, as adding new characters may result in validation issues.

Default Characters: 

abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890!@#$%^&*-_
SVM2 16 1.png
23. Define features available in the client area by marking them in the 'Client Area Features' section.

The functions that can be made available:

  • Start - allows clients to power on their virtual machines.
  • Stop - lets clients shut down their virtual machines.
  • Restart - enables clients to reboot their virtual machines.
  • Shut Down - allows clients to turn off their virtual machines completely.
  • Console - provides clients with access to their virtual machine’s console interface.
  • Rescue Mode - lets clients enable or disable rescue mode on their virtual machines.
  • Change Password - allows clients to update the root passwords of their virtual machines.
  • Log In To Panel - enables clients to access the SolusVM 2 panel.
  • Backups - allows clients to create and manage backups of their virtual machines.
  • Graphs - displays performance and status graphs for virtual machines.
  • Network - lets clients view IP addresses, gateways, nameservers, and set primary networks.
  • Reinstallation - allows clients to reinstall their virtual machines with different systems or applications.
  • Snapshots - enables clients to capture snapshots of their virtual machines.
    Note: Snapshots can be taken on KVM virtualizations with LVM or ThinLVM storage types. If the image format is qcow2, File Based and NFS storage types can be used as well.
  • Tasks - lets clients view the tasks performed on their virtual machines.

Images available for reinstallation:

  • Available Operating Systems
  • Available Applications
SVM2 17.png
24. Generate default configurable options.

To do so, press 'Generate' as shown on the screen below. You can choose which options to generate. Some options only work with virtual server [VS] virtualization type.
Note: This step is optional. It is advisable not to generate options that you do not plan to use, or in case you want their fixed values to be taken from the module settings, rather than being flexible.
When you are done with the module settings make sure to 'Save Changes'.

SVM2 18.png
25. As the last step add a cron job as shown below (5-minute intervals are recommended). 
php -q /your_whmcs/modules/servers/SolusVM2VpsCloud/cron/cron.php queue

This cron makes sure tasks are run automatically when in the queue.
Do not forget to replace 'your_whmcs' with your WHMCS root location. The cron can be also executed every single minute in order to perform the action more often.
You will find personalized cron job information in the 'Queue' section of the addon.

You have just finished the installation and configuration of the product, congratulations!

[edit] Management

You have just correctly created and customized a new product.
Let us continue to the module management. The client area, the admin area and the addon will be described in detail in this section.

[edit] Addon Configuration

Now we will highlight the features of the addon first.

Go to 'Addons' → 'SolusVM 2 VPS & Cloud' in your WHMCS to access it.

[edit] Servers

'Servers' section contains a list of your configured servers, you may quickly edit them directly from this tab, simply press the edit icon.

The information displayed in the addon includes:

  • Server name
  • Server IP address
  • Server active accounts number and limit
  • Server status
SVM2 20.png
Click on the 'OS Images & Applications Icons' button to view a list of images available on the server.

You can change the image associated with each operating system and application by clicking the 'Settings' icon and choosing a picture from the media library.

SVM2 21.png

[edit] Media Library

The 'Media Library' section stores images that can be used as thumbnails for your operating system and application images.

Use the Additional Actions to delete all images at once.
To upload a new image, use the 'Upload Image' button.

SVM2 22.png

[edit] Queue

In this section, you will find a list of all the tasks issued by the module.

The information on each task includes:

  • Task ID
  • Related item
  • Task status
  • Task type
  • Attempts taken
  • Date of creation
  • Date of the last status update

You may also use the action buttons to:

  • See task details
  • Manually run the task
  • Delete the task

To find specific tasks use the search and sorting functions.

SVM2 23.png
Task details include:
  • Task ID
  • Job
  • Queue
  • Retry Count
  • Parent ID
  • Type
  • Related Item
  • Custom Relation
  • Status
  • Retry After Date
  • Created At Date
  • Updated At Date
SVM2 23 1.png
Related log entries can be found in a separate tab.
SVM2 23 2.png
Tasks can also be deleted with the mass action function.
SVM2 23 3.png
Additional actions include the 'Auto Prune' system, which will automatically delete tasks after a predefined number of days and an option to disable cron job information.
SVM2 24.png

[edit] Translations

Customizing language files is now extremely easy with the "Translations" tool that is now available directly in the addon.
Its user-friendly design makes managing various language file tweaks a smooth and efficient process.

Prepare translations for the original English files with this handy built-in tool. For specific instructions on how to use this tool please refer to its dedicated article, you will find it here.

SVM2 25.png


[edit] Admin Area

[edit] VPS

Admins can monitor and manage the virtual machines on the client's page.

The action buttons include:

  • Start the machine
  • Stop the machine
  • Shut down the machine
  • Restart the machine
  • Access the machine's console interface
  • Log in to SolusVM 2 panel
  • Enable/Disable Rescue Mode
  • Change the password of the machine
  • Import From SolusVM 2.0 WHMCS Addon
    Note: Only available before a virtual machine is created in the new service, allows you to import an existing machine.

Underneath the information regarding the virtual machine is located, it includes:

  • Status of the machine
  • Hostname
  • vCPUs in use
  • Disk space allocated to the machine
  • Operating system/application currently used

All tasks from the SolusVM 2 panel are logged in the 'Tasks' table. The 'Queue' table lists the tasks issued by the module.

SVM2 27.png

[edit] Cloud

Admins can monitor and manage the machines on the client's page.

The Available Resources graph displays how much of the distributed resources are in use.
The Virtual Machine list features details about the client's servers and offers options to:

  • Start the machine
  • Stop the machine
  • Shutdown the machine
  • Restart the machine
  • Toggle Rescue Mode on the machine
  • Open Console of the machine

and import new virtual machines.
Note: Including an option to import from the SolusVM 2.0 WHMCS Addon
All tasks from the SolusVM 2 panel are logged in the 'Tasks' table.
The 'Queue' table lists the tasks issued by the module.
Note: Keep in mind that the 'Suspend' module command will suspend all machines.

SVM2 28.png

[edit] Client Area - VPS

For the VPS products, clients have access to basic actions and information regarding their virtual machine.

The basic actions include:

  • Start
  • Stop
  • Shut Down
  • Restart
  • Open Console
  • Log in To Panel
  • Toggle Rescue Mode
  • Change Password

If enabled, additional tools will also be available to the user.
The current information about the virtual machine is displayed in the 'Information' table.

SVM2 29.png

[edit] Backups

Users can create and manage backups in the 'Backups' tab.

To create a new backup use the 'Create Backup' button.
Once a backup is created, it can be deleted or used to restore the virtual machine state by clicking the action buttons next to each backup on the list.

SVM2 30.png

[edit] Graphs

Clients will find visualizations of their current 'CPU Usage', 'Disk Throughput' , 'Network Throughput' and 'Memory Usage'.

By tracking VPS usage sudden and unexpected overloads can be avoided.

SVM2 31.png

[edit] Network

The network tab contains information regarding the virtual machine's network settings.
  • IP Address
  • Gateway
  • Primary Name Server
  • Secondary Name Server

and whether a given network is set as a primary for the virtual machine.

SVM2 32.png

[edit] Reinstallation

The 'Reinstall' tab contains a list of operating systems and applications allowed for virtual machine reinstallation.

Clicking on any of the icons will initiate the reinstallation process, after a confirmation popup.

SVM2 33.png

[edit] Snapshots

The 'Snapshot' tab allows the users to create new snapshots and manage their snapshot library.

Use the 'Create Snapshot' button to take a new snapshot.
The action buttons below can be used to restore a snapshot or delete it.

SVM2 34.png

[edit] Tasks

The list of tasks related to the client's virtual machine can be found in the 'Tasks' tab.

The list features details such as:

  • Task start time
  • Task finish time
  • Action
  • Status
  • Duration
SVM2 35.png

[edit] Client Area - Cloud Type

The client area of cloud products features 'Available Resources' information table and the 'Virtual Servers' list.

The table features a graphical representation of the resource usage of

  • vCPUs cores
  • Disk limits
  • Memory limits
  • Additional IPv4 addresses
  • Additional IPv6 addresses

Hovering over the question mark icon will display the exact numbers for each metric.

SVM2 36.png
Action buttons allow managing, deleting, and performing actions on existing servers.
  • Manage Virtual Server - opens the details page where changes can be introduced.
  • Delete - starts the task of deleting the server.
  • Additional Actions - allows actions such as: 'Start ', 'Stop', 'Shut Down', 'Restart', 'Toggle Rescue Mode', and 'Open Console'.
SVM2 36 1.png

[edit] New Virtual Machine

To add a new virtual machine, click on the 'Create Virtual Machine' button first.

SVM2 37.png
Then provide the configuration for the new virtual machine.
  • Hostname
  • Password
  • SSH Key
  • vCPUs
  • Disk Size
  • RAM
  • Primary IPv4
  • Primary IPv6
  • Additional IPv4
  • Additional IPv6
  • Image

The graph on the top of the screen can help you see how many resources remain while you allocate them to the new machine.
Click on 'Submit' when ready.

SVM2 38.png
You can also manage a machine directly and use additional tools, after selecting it on the side menu.
SVM2 39.png

[edit] Tips

1. Since the SolusVM 2 panel only allows a small number of special signs to be used in passwords, it might be helpful to disable special characters in auto-generated passwords.
To do so, navigate to 'General Settings' → 'Security' → 'Auto Generated Password Format' and select 'Generate passwords containing a combination of letters and numbers only'.
2. You can add an SSH Key for a virtual machine using a sshKey|SSH Public Key custom field for the VPS functionality.
For the Cloud functionality, the option to add an SSH Key is available when creating a new virtual machine.
3. SolusVM 2 VPS & Cloud module can manage virtual machines imported from SolusVM 2.0 WHMCS addon.
To import your machines use the 'Import From SolusVM 2.0 WHMCS Addon' button found in the admin area.
For VPS products this option is available after service has been activated, but the machine has not been created yet.

[edit] Update Instructions

An essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

[edit] Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your SolusVM 2 VPS & Cloud For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=SolusVM_2_VPS_And_Cloud_For_WHMCS&oldid=75791"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community
SolusVM 2 VPS And Cloud For WHMCS