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)
(→‎Tips)
 
(19 intermediate revisions by 2 users not shown)
Line 41: Line 41:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Servers Status And Details
+
|style="padding: 0px 0px 0px 30px;"|✔ View Server Status And Details
 
|}
 
|}
 
{|
 
{|
Line 84: Line 84:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 45px;"|✔ Select Server Location
 
|style="padding: 0px 0px 0px 45px;"|✔ Select Server Location
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Select Default Application Group And Default Application
 
|}
 
|}
 
{|
 
{|
Line 114: Line 117:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 45px;"|✔ Additional IPv6 Addresses
 
|style="padding: 0px 0px 0px 45px;"|✔ Additional IPv6 Addresses
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Backup Files
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ VPC Private Network
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Assigned Servers To VPC
 
|}
 
|}
 
{|
 
{|
Line 140: Line 152:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Reinstall
+
|style="padding: 0px 0px 0px 45px;"|✔ Private Networks
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Reinstallation
 
|}
 
|}
 
{|
 
{|
Line 149: Line 164:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Select Available Operation Systems
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Server Information Entries
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Select Available Applications
+
 
|}
 
|}
 
{|
 
{|
Line 159: Line 171:
 
*'''Addon Features:'''
 
*'''Addon Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ View Server Configurations Lists And Details:
+
|style="padding: 10px 0px 0px 30px;"|✔ View Server List With Details:
 
|}
 
|}
 
{|
 
{|
Line 171: Line 183:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Customize Operation System And Application Logo Images
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure App Templates:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Applications
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Operationg Systems
 +
|}
 +
 
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Create Application Groups And Assign App Templates
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Manage Media Library With Logotypes For App Templates
 
|}
 
|}
 
{|
 
{|
Line 187: Line 212:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Servers Status And Details
+
|style="padding: 0px 0px 0px 30px;"|✔ View Server Status And Details
 
|}
 
|}
 
{|
 
{|
Line 226: Line 251:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Reinstall Server Using:
+
|style="padding: 0px 0px 0px 30px;"|✔ Create/Manage Private Networks
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Reinstall Server With Predefined Templates:
 
|}
 
|}
 
{|
 
{|
Line 267: Line 295:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Additional IPv6 Addresses
 
|style="padding: 0px 0px 0px 30px;"|✔ Additional IPv6 Addresses
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Backup Files Limit
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ VPC Private Network Limit
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Assigned Servers to VPC Limit
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 10px 30px;"|✔ OS / Application
 
|style="padding: 0px 0px 10px 30px;"|✔ OS / Application
 
|}
 
|}
 +
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
Line 276: Line 314:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.3 Back To PHP 8.1
 
|}
 
|}
 
{|
 
{|
Line 282: Line 320:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.8
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.13 Back To WHMCS V8.10
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
+
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V14 Or Later
 
|}
 
|}
 
{|
 
{|
Line 405: Line 443:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_11.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_11.png]]
 
|}
 
|}
 +
===App Templates===
 
{|
 
{|
−
|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.'''
+
|style="padding: 10px 0px 30px 15px;"|Before continuing to the product's settings, you must ensure you have at least one application or group of applications ready to use. <br/> Proceed to the addon module → App Templates section and follow below to create a ready application that will be installed by default on the server. <br/>
 +
 
 +
The '''App Templates''' section in the SolusVM 2 module allows you to import and manage operating systems and applications that can be preinstalled on a virtual machine during provisioning.<br/> These templates are fully synchronized with your connected Solus servers.
 +
 
 +
|}
 +
 
 +
====Applications====
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|This section enables you to load available application templates directly from your Solus server and manage them within WHMCS.<br/>
 +
* Navigate to the App Templates section in the addon module.
 +
* Use the tabs at the top to switch between ''Operating Systems'' and ''Applications''.
 +
* Click the '''refresh''' icon to import the latest templates from your Solus instance.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_11_0.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Once templates are imported, you can use action buttons to edit, duplicate, or delete them. Mass actions are also available for bulk management.<br/>
 +
 
 +
'''''Important!''' Before configuring a product in WHMCS, make sure you have at least one application or group of applications defined here. These templates will be used as defaults when creating virtual machines.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_11_1.png]]
 +
|}
 +
 
 +
====Groups====
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|With your templates ready, the next step is to organize them into groups that can be assigned to individual products.<br/>
 +
Navigate to '' 'App Templates' '' → '' 'Groups' '' and click on the '' 'Create' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_11_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Read the information, then provide the group with:
 +
*Name - A label for internal identification.
 +
*Description - Optional information about the group.
 +
*Items to include - Select which templates to bundle into this group.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_11_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|You can use the action button and the mass action function to edit and delete template groups.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_11_4.png]]
 +
|}
 +
 
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|You can use the action button and the mass action function to edit and delete template groups.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''Upgrade Notes'''<br/>
 +
When upgrading to version 1.1.0, the following changes and migrations take place automatically:
 +
* A default group is created in the App Templates that includes all available templates.
 +
* Existing application templates and their group associations are migrated to the new structure.
 +
* For each product, a matching group is created and linked using the same applications and operating systems as before ''(e.g., product ID = 8 retains identical templates post-migration).''
 +
* Product settings are updated to use the same application group and default template as in the previous version.
 +
* A test group is also added to demonstrate the new App Templates functionality.<br/>
 +
 
 +
'''''Note:''' These steps ensure a seamless transition without requiring manual reconfiguration. After the upgrade, you may optionally remove any unwanted applications from the default group.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|Once your Applications and Groups are configured, return to the module settings in WHMCS to complete the product configuration using the selected group and default application.<br/>
 +
For more advanced use cases or to define your templates manually, please refer to the [[#App_Templates_Advanced_Configuration|App Templates Advanced Configuration]] section in this documentation.
 +
|}
 +
 
 +
===Module Settings===
 +
{|
 +
|style="padding: 10px 0px 15px 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.'''
 +
The module should automatically save and reload settings. If not, click on 'Save Changes' manually.
 
|}
 
|}
 
{|
 
{|
Line 425: Line 535:
 
*'''Default User Role''' - new clients will be added to the SolusVM 2 panel, pick the role they will be assigned by default.
 
*'''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.
 
*'''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.
+
*'''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.
 
*'''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.
 
*'''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.
Line 431: Line 541:
 
{|
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_14.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_14.png]]
 +
|}
 +
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''20. Proceed with '' 'App Template Configuration'.''
 +
 +
'''App Templates Configuration''' - To create instances based on operating systems or applications, you must first configure the App Templates in the module's addon. <br/> Once your applications and groups are set up there, you can select the desired application in the product's Module Settings tab to be used during instance creation. <br/> Please refer to the [[#App_Templates|App Templates]] and [[#App_Templates_Advanced_Configuration|App Templates Advanced Configuration]] sections of the documentation for detailed setup instructions.
 +
 +
* '''Default Application Group''' - The group of applications available for reinstalls. See the [[#Groups|Groups]] section for more details.
 +
* '''Default Application''' - The application that will be installed by default during creation. See the [[#Applications|Applications]] section.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_13_0.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''20. Set up the limits on the virtual machine.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''21. Set up the limits on the virtual machine.'''<br/>
 
For both virtualization types, these are:
 
For both virtualization types, these are:
 
*'''Virtual CPUs''' - number of virtual CPUs assigned.
 
*'''Virtual CPUs''' - number of virtual CPUs assigned.
Line 441: Line 563:
 
*'''Additional IPv6 Addresses''' - additional ipV6 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.
 
*'''Backup Files''' - the maximum number of backup files, set it to '' '-1' '' to disable the limit.
−
Additionally, for the VZ virtualization type define:
+
*'''VPC Private Networks''' - defines the limit for VPC private network,  set it to '' '-1' '' to disable the limit.
 +
*'''Assigned Servers to VPC''' - the maximum allowed number of servers assigned to VPC, 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 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.
 
*'''vCPU Limit''' - the number of CPUs the virtual machines will be limited to. Enter '' '0' '' to disable the limit.
Line 451: Line 576:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''21. Define the default configuration.'''
+
|style="padding: 0px 0px 15px 15px;"|'''22. Define the default configuration.'''
 
*'''Enable IPv4''' - decide if IPv4 protocol should be used.
 
*'''Enable IPv4''' - decide if IPv4 protocol should be used.
 
*'''Enable IPv6''' - decide if IPv6 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''
 
*'''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''
 
|}
 
|}
Line 461: Line 585:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''22. Configure service-related options.'''
+
|style="padding: 0px 0px 15px 15px;"|'''23. Configure service-related options.'''
 
*'''Generate Password''' - Decide if you want the service password to be generated automatically.
 
*'''Generate Password''' - Decide if you want the service password to be generated automatically.
 
*'''Password Length''' - Define how long the password will be.
 
*'''Password Length''' - Define how long the password will be.
Line 472: Line 596:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''23. Define features available in the client area by marking them in the '' 'Client Area Features' '' section.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''24. Define features available in the client area by marking them in the '' 'Client Area Features' '' section.'''<br/>
 
The functions that can be made available:
 
The functions that can be made available:
 
*'''Start''' - allows clients to power on their virtual machines.
 
*'''Start''' - allows clients to power on their virtual machines.
Line 488: Line 612:
 
*'''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.
 
*'''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.
 
*'''Tasks''' - lets clients view the tasks performed on their virtual machines.
−
Images available for reinstallation:
+
*'''Available Information''' - select which elements will be included in the ''Information'' section, leave blank to include all the available items.
−
*'''Available Operating Systems'''
+
 
−
*'''Available Applications'''
+
 
|}
 
|}
 
{|
 
{|
Line 496: Line 619:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''24. Generate default configurable options.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''25. 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/>
+
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 [VZ] 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/>
 
'''''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'.'''
+
When you are done with the module settings, make sure to ''' 'Save Changes'.'''
 
|}
 
|}
 
{|
 
{|
Line 505: Line 628:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''25. As the last step add a cron job as shown below (5-minute intervals are recommended).'''
+
|style="padding: 0px 0px 30px 15px;"|'''26. 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
 
  php -q /your_whmcs/modules/servers/SolusVM2VpsCloud/cron/cron.php queue
 
This cron makes sure tasks are run automatically when in the queue.<br/>
 
This cron makes sure tasks are run automatically when in the queue.<br/>
Line 519: Line 642:
 
==Addon Configuration==
 
==Addon Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Now we will highlight the features of the addon first.'''<br />
+
|style="padding: 10px 0px 30px 15px;"|'''Let’s begin by exploring the key features available in the addon.'''<br/> To access it, navigate to 'Addons' → 'SolusVM 2 VPS & Cloud' in your WHMCS.
−
Go to '' 'Addons' '' → '' 'SolusVM 2 VPS & Cloud' '' in your WHMCS to access it.
+
 
|}
 
|}
 
===Servers===
 
===Servers===
 
{|
 
{|
−
|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/>
+
|style="padding: 10px 0px 15px 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/>
 
The information displayed in the addon includes:
 
The information displayed in the addon includes:
 
*'''Server name'''
 
*'''Server name'''
Line 532: Line 654:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_20.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_20.png]]
 
|}
 
|}
 +
 +
===App Templates Advanced Configuration===
 +
 
{|
 
{|
−
|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/>
+
|style="padding: 10px 0px 15px 15px;"|Before you proceed, make sure you’ve reviewed the [[#App_Templates|App Templates]] section for basic configuration steps. <br/>
−
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.
+
This section is intended for advanced users and administrators who want to manually manage imported application and operating system templates.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_21.png]]
+
|style="padding: 0px 0px 15px 15px;"|Templates are created and maintained directly in your Solus control panel. The module automatically pulls this data and displays it in the App Templates section of the addon module.<br/>
−
|}
+
  
−
===Media Library===
+
To import or refresh templates in WHMCS:
 +
* Navigate to '''Addon Module → App Templates'''.
 +
* Use the '''refresh icon''' in the '''Applications''' or '''Operating Systems''' tab to load the latest templates from your Solus server.<br/>
 +
Once imported, the templates can be grouped and assigned to specific products within WHMCS, no further manual steps are required.<br/>
 +
 
 +
'''''Important!''' Only templates that already exist in Solus are supported. There is no need to create templates manually in WHMCS.''
 +
|}
 
{|
 
{|
−
|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/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_21_0.png]]
−
Use the Additional Actions to delete all images at once. <br/>
+
−
To upload a new image, use the '' 'Upload Image' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_22.png]]
+
|style="padding: 0px 0px 15px 15px;"|Once imported, templates can be:
 +
*Grouped under App Templates → Groups
 +
*Assigned to specific WHMCS products in the product module settings. <br/>
 +
No additional manual configuration is required for them to be used in provisioning.
 
|}
 
|}
  
−
===Queue===
+
====Editing Imported Templates====
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In this section, you will find a list of all the tasks issued by the module.<br/>
+
|style="padding: 10px 0px 15px 15px;"|To view or update template details:
−
The information on each task includes:
+
* Click the '''Edit''' icon next to a template.
−
*'''Task ID'''
+
* In the '''Application/ Operatng System Details''' section, you can:
−
*'''Related item'''
+
** Update the name, description, and status
−
*'''Task status'''
+
** Upload or change a custom icon for visual presentation
−
*'''Task type'''
+
* Review internal configuration values ''(Setting Details)''
−
*'''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:SVM2_23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_21_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Task details include:
+
|style="padding: 0px 0px 15px 15px;"|These setting detils are automatically assigned by the module. '''Do not modify these values''' unless you are an advanced user who understands Solus internal mechanics.
−
*'''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:SVM2_23_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_21_2.png]]
 
|}
 
|}
 +
 +
===Media Library===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Related log entries can be found in a separate tab.
+
|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/>
 +
Use the Additional Actions to delete all images at once. <br/>
 +
To upload a new image, use the '' 'Upload Image' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_23_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_22.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Tasks can also be deleted with the mass action function.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_23_3.png]]
+
 
|}
 
|}
 +
 +
===[https://www.docs.modulesgarden.com/Task_Queue_Tool Queue]===
 
{|
 
{|
−
|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: 10px 0px 15px 15px;"|The "Queue" tool helps you track and manage the tasks created by the module.<br/>
 +
It allows you to view and interact with task details, including task IDs, statuses, and related items.<br/>
 +
You can filter tasks, execute actions like deleting or running tasks, and even use mass actions for bulk operations.<br/>
 +
For detailed guidance on using this tool, please refer to the dedicated article available [https://www.docs.modulesgarden.com/Queue here].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_24.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_23.png]]
 
|}
 
|}
  
Line 654: Line 768:
  
 
==Admin Area==
 
==Admin Area==
−
===VPS===  
+
===VPS-Type Product Page===  
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Admins can monitor and manage the virtual machines on the client's page.<br/>
 
|style="padding: 10px 0px 15px 15px;"|Admins can monitor and manage the virtual machines on the client's page.<br/>
 
The action buttons include:
 
The action buttons include:
−
*'''Start the machine'''
+
*'''Start''' the machine
−
*'''Stop the machine'''
+
*'''Stop''' the machine'''
−
*'''Shut down the machine'''
+
*'''Shut down''' the machine'''
−
*'''Restart the machine'''
+
*'''Restart''' the machine'''
−
*'''Access the machine's console interface'''
+
 
*'''Log in to SolusVM 2 panel'''
 
*'''Log in to SolusVM 2 panel'''
 
*'''Enable/Disable Rescue Mode'''
 
*'''Enable/Disable Rescue Mode'''
−
*'''Change the password of the machine'''
+
*'''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:
 
Underneath the information regarding the virtual machine is located, it includes:
 
*'''Status of the machine'''
 
*'''Status of the machine'''
Line 678: Line 792:
 
|}
 
|}
  
−
===Cloud===
+
===Cloud-Type Product Page===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Admins can monitor and manage the machines on the client's page.<br/>
+
|style="padding: 10px 0px 15px 15px;"|Admins can monitor and manage the machines on the client's product page.
−
The '''Available Resources''' graph displays how much of the distributed resources are in use.<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:
+
* The '''Virtual Machines list''' features details about the client's servers and offers options to:
−
*'''Start the machine'''
+
**'''Start''' the machine
−
*'''Stop the machine'''
+
**'''Stop''' the machine
−
*'''Shutdown the machine'''
+
**'''Shutdown''' the machine
−
*'''Restart the machine'''
+
**'''Restart''' the machine
−
*'''Toggle Rescue Mode on the machine'''
+
**'''Toggle Rescue Mode''' on the machine
−
*'''Open Console of the machine'''
+
**'''Open Console of the machine
−
and import new virtual machines.<br/>
+
** '''Import''' existing virtual machines.<br/> '''''Note:''' This includes an option to import instances 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/>
+
* Task Monitoring
 +
** The '''Tasks''' table logs all operations executed via the SolusVM 2 panel.
 +
** The '''Queue''' table lists tasks issued directly by the WHMCS module and tracks their execution status.
 +
 
 
'''''Note:''' Keep in mind that the 'Suspend' module command will suspend all machines.''
 
'''''Note:''' Keep in mind that the 'Suspend' module command will suspend all machines.''
 
|}
 
|}
Line 706: Line 823:
 
*'''Shut Down'''
 
*'''Shut Down'''
 
*'''Restart'''
 
*'''Restart'''
−
*'''Open Console'''
 
 
*'''Log in To Panel'''
 
*'''Log in To Panel'''
 
*'''Toggle Rescue Mode'''
 
*'''Toggle Rescue Mode'''
Line 724: Line 840:
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_30.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_30.png]]
 +
|}
 +
===Console===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Access to an integrated console available for clients to execute commands directly within their environment.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_30_0.png]]
 
|}
 
|}
  
Line 746: Line 869:
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_32.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:SVM2_32.png]]
 +
|}
 +
 +
===Private Network===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|The '''Private Network''' feature allows your clients to create and manage their own VPC-style private networks within their virtual infrastructure. <br/>These networks enable communication between virtual machines without using public IP addresses.<br/>
 +
Clients can:
 +
* Create and delete private networks.
 +
* Attach multiple virtual machines to a private network.
 +
* View and manage assigned private IP addresses.<br/>
 +
 +
To create a new private network, click the '''Add VPC Network''' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_32_0.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|A popup window will appear with the following fields:
 +
* Name – Enter a unique name for the network.
 +
* IP Range (optional) – Define the start and end of the IP address range (From / To) that will be used within this network.
 +
* Netmask – Specify the subnet mask for the network.
 +
 +
Click '''Confirm''' to finalize the configuration. If the form is filled out correctly, the new private network will appear in the list.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_32_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Each private network entry includes an '''Details''' button that opens a detailed view of the network. <br/>This view displays:
 +
* The name of the virtual machine attached to the network.
 +
* The assigned private IP address.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_32_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|To assign a virtual machine to a private network, press the Attach Network button. <br/>A modal will open where you can:
 +
* Select the virtual machine to connect.
 +
* Confirm the action to establish the internal network link. <br/>
 +
Once attached, the virtual machine will be able to communicate with others in the same private network.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:SVM2_32_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|To remove a virtual machine from the private network:
 +
* Click the Detach button next to the IP address you want to remove.
 +
* Confirm the action in the modal that appears.<br/>
 +
This will disconnect the selected virtual machine from the private network.<br/> Please note that this action is processed as a task, which means it will be placed in a queue and may take some time to complete.
 
|}
 
|}
  
 
===Reinstallation===
 
===Reinstallation===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The '' 'Reinstall' '' tab contains a list of operating systems and applications allowed for virtual machine reinstallation.<br/>
+
|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. <br/>
−
Clicking on any of the icons will initiate the reinstallation process, after a confirmation popup.
+
'''''Note:''' This action will erase all existing data and proceed with a fresh installation.''
 
|}
 
|}
 
{|
 
{|
Line 847: Line 1,018:
 
|}
 
|}
 
{|
 
{|
−
|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.
+
|style="padding: 0px 0px 5px 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.
 +
|}
 +
 
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|4. Importing existing instances to WHMCS:<br/>
 +
If you need to link a VPS or Cloud instance that already exists in your SolusVM panel with a WHMCS service, the association must currently be done directly in the database.<br/>
 +
To do this, add a new record in the <code>SolusVM2VpsCloud_Users</code> table:
 +
* <code>whmcs_client_id</code> - WHMCS client ID.
 +
* <code>solus_user_id</code> - SolusVM user ID.
 +
* <code>email</code> - Client’s email address in WHMCS.
 +
* <code>password</code> - The SolusVM user’s password in encoded form.
 +
 
 +
Once the entry is saved, the service will be linked to the specified WHMCS account.
 
|}
 
|}
  
Line 853: Line 1,036:
 
{|
 
{|
 
|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: 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/>
−
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.
+
Ensure the 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.
 +
|}
 +
 
 +
==Migration Guide==
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|While upgrading to '''version 1.1.0''' make sure to follow those guidelines:<br/>
 +
1. Make sure '''all tasks are finished'''.<br/>
 +
2. Optionally, back up your '''customized language files'''.<br/>
 +
3. '''Delete all files''' from the previous version of the module.<br/>
 +
4. Upload the '''new module files'''.<br/>
 +
5. '''Migration tool should run automatically and transfer all your existing data'''; however, if that is not the case, please manually initiate the version upgrade with the '''cron command''': 
 +
 +
php -q /YOUR_WHMCS/modules/servers/SolusVM2VpsCloud/cron/cron.php module:upgrade run 1.1.0 
 +
 
 +
6. Optionally, restore changes made to the language files.
 +
 
 +
The above migration tool will transfer safely your existing applications and operating systems, automatically creating adequate groups. The same case is with configurable option <code>osOrApplication/OS or Application</code> that has now been replaced with '''app/OS or Application''' configurable option.
 
|}
 
|}
  

Latest revision as of 10:51, 11 August 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 Server 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
✔ Select Default Application Group And Default Application
✔ 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
✔ Backup Files
✔ VPC Private Network
✔ Assigned Servers To VPC
✔ 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
✔ Private Networks
✔ Reinstallation
✔ Snapshots
✔ Tasks
✔ Select Server Information Entries
✔ Generate Configurable Options
  • Addon Features:
✔ View Server List With Details:
✔ IP Address
✔ Active Accounts
✔ Status
✔ Configure App Templates:
✔ Applications
✔ Operationg Systems
✔ Create Application Groups And Assign App Templates
✔ Manage Media Library With Logotypes For App Templates
✔ 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 Server 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
✔ Create/Manage Private Networks
✔ Reinstall Server With Predefined Templates:
✔ 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
✔ Backup Files Limit
✔ VPC Private Network Limit
✔ Assigned Servers to VPC Limit
✔ OS / Application
  • General Info:
✔ Multi-Language Support With Custom Translations Tool
✔ Supports PHP 8.3 Back To PHP 8.1
✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
✔ Supports WHMCS V8.13 Back To WHMCS V8.10
✔ 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

[edit] App Templates

Before continuing to the product's settings, you must ensure you have at least one application or group of applications ready to use.
Proceed to the addon module → App Templates section and follow below to create a ready application that will be installed by default on the server.

The App Templates section in the SolusVM 2 module allows you to import and manage operating systems and applications that can be preinstalled on a virtual machine during provisioning.
These templates are fully synchronized with your connected Solus servers.

[edit] Applications

This section enables you to load available application templates directly from your Solus server and manage them within WHMCS.
  • Navigate to the App Templates section in the addon module.
  • Use the tabs at the top to switch between Operating Systems and Applications.
  • Click the refresh icon to import the latest templates from your Solus instance.
SVM2 11 0.png
Once templates are imported, you can use action buttons to edit, duplicate, or delete them. Mass actions are also available for bulk management.

Important! Before configuring a product in WHMCS, make sure you have at least one application or group of applications defined here. These templates will be used as defaults when creating virtual machines.

SVM2 11 1.png

[edit] Groups

With your templates ready, the next step is to organize them into groups that can be assigned to individual products.

Navigate to 'App Templates' → 'Groups' and click on the 'Create' button.

SVM2 11 2.png
Read the information, then provide the group with:
  • Name - A label for internal identification.
  • Description - Optional information about the group.
  • Items to include - Select which templates to bundle into this group.
SVM2 11 3.png
You can use the action button and the mass action function to edit and delete template groups.
SVM2 11 4.png
You can use the action button and the mass action function to edit and delete template groups.
Upgrade Notes

When upgrading to version 1.1.0, the following changes and migrations take place automatically:

  • A default group is created in the App Templates that includes all available templates.
  • Existing application templates and their group associations are migrated to the new structure.
  • For each product, a matching group is created and linked using the same applications and operating systems as before (e.g., product ID = 8 retains identical templates post-migration).
  • Product settings are updated to use the same application group and default template as in the previous version.
  • A test group is also added to demonstrate the new App Templates functionality.

Note: These steps ensure a seamless transition without requiring manual reconfiguration. After the upgrade, you may optionally remove any unwanted applications from the default group.

Once your Applications and Groups are configured, return to the module settings in WHMCS to complete the product configuration using the selected group and default application.

For more advanced use cases or to define your templates manually, please refer to the App Templates Advanced Configuration section in this documentation.

[edit] Module Settings

17. Now, go to 'Module Settings' section, and choose both 'SolusVM 2 VPS & Cloud' and a previously created server group from the dropdown menus.

The module should automatically save and reload settings. If not, click on 'Save Changes' manually.

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. Proceed with 'App Template Configuration'.

App Templates Configuration - To create instances based on operating systems or applications, you must first configure the App Templates in the module's addon.
Once your applications and groups are set up there, you can select the desired application in the product's Module Settings tab to be used during instance creation.
Please refer to the App Templates and App Templates Advanced Configuration sections of the documentation for detailed setup instructions.

  • Default Application Group - The group of applications available for reinstalls. See the Groups section for more details.
  • Default Application - The application that will be installed by default during creation. See the Applications section.
SVM2 13 0.png
21. 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.
  • VPC Private Networks - defines the limit for VPC private network, set it to '-1' to disable the limit.
  • Assigned Servers to VPC - the maximum allowed number of servers assigned to VPC, 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
22. Define the default configuration.
  • Enable IPv4 - decide if IPv4 protocol should be used.
  • Enable IPv6 - decide if IPv6 protocol should be used.
  • 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
23. 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
24. 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.
  • Available Information - select which elements will be included in the Information section, leave blank to include all the available items.
SVM2 17.png
25. 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 [VZ] 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
26. 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

Let’s begin by exploring the key features available in the addon.
To access it, navigate to 'Addons' → 'SolusVM 2 VPS & Cloud' in your WHMCS.

[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

[edit] App Templates Advanced Configuration

Before you proceed, make sure you’ve reviewed the App Templates section for basic configuration steps.

This section is intended for advanced users and administrators who want to manually manage imported application and operating system templates.

Templates are created and maintained directly in your Solus control panel. The module automatically pulls this data and displays it in the App Templates section of the addon module.

To import or refresh templates in WHMCS:

  • Navigate to Addon Module → App Templates.
  • Use the refresh icon in the Applications or Operating Systems tab to load the latest templates from your Solus server.

Once imported, the templates can be grouped and assigned to specific products within WHMCS, no further manual steps are required.

Important! Only templates that already exist in Solus are supported. There is no need to create templates manually in WHMCS.

SVM2 21 0.png
Once imported, templates can be:
  • Grouped under App Templates → Groups
  • Assigned to specific WHMCS products in the product module settings.

No additional manual configuration is required for them to be used in provisioning.

[edit] Editing Imported Templates

To view or update template details:
  • Click the Edit icon next to a template.
  • In the Application/ Operatng System Details section, you can:
    • Update the name, description, and status
    • Upload or change a custom icon for visual presentation
  • Review internal configuration values (Setting Details)
SVM2 21 1.png
These setting detils are automatically assigned by the module. Do not modify these values unless you are an advanced user who understands Solus internal mechanics.
SVM2 21 2.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

The "Queue" tool helps you track and manage the tasks created by the module.

It allows you to view and interact with task details, including task IDs, statuses, and related items.
You can filter tasks, execute actions like deleting or running tasks, and even use mass actions for bulk operations.
For detailed guidance on using this tool, please refer to the dedicated article available here.

SVM2 23.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-Type Product Page

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
  • 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-Type Product Page

Admins can monitor and manage the machines on the client's product page.
  • The Available Resources graph displays how much of the distributed resources are in use.
  • The Virtual Machines 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
    • Import existing virtual machines.
      Note: This includes an option to import instances from the SolusVM 2.0 WHMCS Addon.
  • Task Monitoring
    • The Tasks table logs all operations executed via the SolusVM 2 panel.
    • The Queue table lists tasks issued directly by the WHMCS module and tracks their execution status.

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
  • 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] Console

Access to an integrated console available for clients to execute commands directly within their environment.
SVM2 30 0.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] Private Network

The Private Network feature allows your clients to create and manage their own VPC-style private networks within their virtual infrastructure.
These networks enable communication between virtual machines without using public IP addresses.

Clients can:

  • Create and delete private networks.
  • Attach multiple virtual machines to a private network.
  • View and manage assigned private IP addresses.

To create a new private network, click the Add VPC Network button.

SVM2 32 0.png
A popup window will appear with the following fields:
  • Name – Enter a unique name for the network.
  • IP Range (optional) – Define the start and end of the IP address range (From / To) that will be used within this network.
  • Netmask – Specify the subnet mask for the network.

Click Confirm to finalize the configuration. If the form is filled out correctly, the new private network will appear in the list.

SVM2 32 1.png
Each private network entry includes an Details button that opens a detailed view of the network.
This view displays:
  • The name of the virtual machine attached to the network.
  • The assigned private IP address.
SVM2 32 2.png
To assign a virtual machine to a private network, press the Attach Network button.
A modal will open where you can:
  • Select the virtual machine to connect.
  • Confirm the action to establish the internal network link.

Once attached, the virtual machine will be able to communicate with others in the same private network.

SVM2 32 3.png
To remove a virtual machine from the private network:
  • Click the Detach button next to the IP address you want to remove.
  • Confirm the action in the modal that appears.

This will disconnect the selected virtual machine from the private network.
Please note that this action is processed as a task, which means it will be placed in a queue and may take some time to complete.

[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.

Note: This action will erase all existing data and proceed with a fresh installation.

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.
4. Importing existing instances to WHMCS:

If you need to link a VPS or Cloud instance that already exists in your SolusVM panel with a WHMCS service, the association must currently be done directly in the database.
To do this, add a new record in the SolusVM2VpsCloud_Users table:

  • whmcs_client_id - WHMCS client ID.
  • solus_user_id - SolusVM user ID.
  • email - Client’s email address in WHMCS.
  • password - The SolusVM user’s password in encoded form.

Once the entry is saved, the service will be linked to the specified WHMCS account.

[edit] Update Instructions

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

Ensure the 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] Migration Guide

While upgrading to version 1.1.0 make sure to follow those guidelines:

1. Make sure all tasks are finished.
2. Optionally, back up your customized language files.
3. Delete all files from the previous version of the module.
4. Upload the new module files.
5. Migration tool should run automatically and transfer all your existing data; however, if that is not the case, please manually initiate the version upgrade with the cron command: 

php -q /YOUR_WHMCS/modules/servers/SolusVM2VpsCloud/cron/cron.php module:upgrade run 1.1.0

6. Optionally, restore changes made to the language files.

The above migration tool will transfer safely your existing applications and operating systems, automatically creating adequate groups. The same case is with configurable option osOrApplication/OS or Application that has now been replaced with app/OS or Application configurable option.

[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=77156"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community
SolusVM 2 VPS And Cloud For WHMCS