Personal tools
Namespaces

Variants
Actions

OVHcloud VPS And Dedicated Servers For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Common Problems)
(89 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
{{DISPLAYTITLE:OVH VPS & Dedicated Servers For WHMCS}}
 
<meta name="google-site-verification" content="0jeeeHr47-Mrg-FashhD6uEffLru8OjaypiwaAGviDs" />
 
<meta name="google-site-verification" content="0jeeeHr47-Mrg-FashhD6uEffLru8OjaypiwaAGviDs" />
−
<meta name="keywords" content="ovh vps dedicated servers for whmcs, ovh vps dedicated configuration, ovh vps dedicated management, ovh vps dedicated installation, ovh vps dedicated guide, modulesgarden ovh vps dedicated, ovh vps dedicated wiki, ovh vps dedicated tutorial, ovh vps dedicated tips, dns module wiki, ovh vps dedicated common problems, about ovh vps dedicated, ovh vps dedicated documentation, ovh vps dedicated faq, ovh vps dedicated help, whmcs ovh vps dedicated, whmcs ovh vps dedicated, ovh vps dedicated vps, ovh vps dedicated servers, ovh vps dedicated virtual machine, ovh vps dedicated module, ovh vps dedicated module"></meta>
+
<meta name="keywords" content="ovh vps dedicated servers for whmcs, ovh vps dedicated servers  configuration, ovh vps dedicated servers  management, ovh vps dedicated servers installation, ovh vps dedicated servers guide, modulesgarden ovh vps dedicated servers, ovh vps dedicated servers  wiki, ovh vps dedicated servers  tutorial, ovh vps dedicated servers tips, ovh vps dedicated servers module wiki, ovh vps dedicated servers common problems, about ovh vps dedicated servers, ovh vps dedicated servers  documentation, ovh vps dedicated servers  faq, ovh vps dedicated servers  help"></meta>
−
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The OVH VPS & Dedicated Servers For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The OVH VPS & Dedicated Servers For WHMCS Module."></meta>
  
−
 
+
=About [https://www.modulesgarden.com/products/whmcs/ovh-vps-and-dedicated-servers OVH VPS & Dedicated Servers For WHMCS]=
−
=About [https://www.modulesgarden.com/products/whmcs/ovh-vps-and-dedicated-servers OVH VPS & Dedicated Servers For WHMCS]=
+
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''OVH VPS & Dedicated Servers  For WHMCS''' is a tool of invaluable usefulness which will allow you to provide Servers to your audience in a completely automated manner. <br />
+
|style="padding: 10px 0px 10px 0px;"|'''OVH VPS & Dedicated Servers  For WHMCS''' will let you automatically supply VPS and dedicated servers powered by OVH, as well as So you Start and Kimsufi.<br />
−
The module will empower your clients to exert full control over their virtual machines through such actions as power on/off, reboot, server rebuild and many more.<br />
+
The module will allow your clients not only to remotely control the status of a machine, but also access the KVM and IMPI console, and update reverse DNS paths.<br />
−
At the same time you will be enabled to carry out a thorough supervision of all tasks performed on virtual servers directly from the admin area.  
+
In addition, you will easily decide whether an existing server can be reused by another customer, in case the previous one no longer needs it.  
 
|}
 
|}
 
<!-- fixed -->
 
<!-- fixed -->
 
*'''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/Renew Server
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Resize Server By Changing Size Slug For Server Plan
+
|style="padding: 0px 0px 0px 30px;"|✔ Power On/Power Off/Reboot Server
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Power On/Power Off/Shut Down/Reboot Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Reboot Server In Rescue Mode
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Reset Server Password
+
|style="padding: 0px 0px 0px 30px;"|✔ Reinstall Server
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Automatic Backups
+
|style="padding: 0px 0px 0px 30px;"|✔ Access KVM/IPMI Console (OVH)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Enable Private Networking
+
|style="padding: 0px 0px 0px 30px;"|✔ View Server Status And Details
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Enable IPv6
+
|style="padding: 0px 0px 0px 30px;"|✔ Monitor Server Protocols Status (VPS)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Server Hostname
+
|style="padding: 0px 0px 0px 30px;"|✔ View/Create/Restore/Delete Snapshots (VPS)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Server's Status And Details
+
|style="padding: 0px 0px 0px 30px;"|✔ View Assigned IP Addresses And Update Reverse DNS Paths
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Server's Network Information
+
|style="padding: 0px 0px 0px 30px;"|✔ View Assigned Disks With Bandwidth And Space Limit
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View/Create/Restore/Delete Snapshots
+
|style="padding: 0px 0px 0px 30px;"|✔ View Traffic Statistics Graph (Dedicated Servers)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View And Restore Backups
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Product Details For:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Rebuild Server With Chosen OS Distribution
+
|style="padding: 0px 0px 0px 45px;"|✔ VPS
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Tasks History
+
|style="padding: 0px 0px 0px 45px;"|✔ Dedicated Server
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Configure Product Details:
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Features Available In Client Area
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Choose Project
+
|style="padding: 0px 0px 0px 30px;"|✔ Generate Configurable Options
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Choose Region
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Welcome Email, Password Reset And Rescue Reboot Email Templates
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Choose Size Slug Plan
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Email Piping
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Choose OS Image
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Usable OVH Server Location, Country And Type
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Additional Volume Size
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Existing Servers To Be Reused By Another Client
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Snapshots Limit
+
|style="padding: 0px 0px 10px 30px;"|✔ View Servers Logs
 
|}
 
|}
 +
 +
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Firewalls Limit
+
|style="padding: 10px 0px 0px 30px;"|✔ Power On/Power Off/Reboot Server
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Server Tags
+
|style="padding: 0px 0px 0px 30px;"|✔ Reboot Server In Rescue Mode
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Automatic Backups
+
|style="padding: 0px 0px 0px 30px;"|✔ Reinstall Server
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Monitoring
+
|style="padding: 0px 0px 0px 30px;"|✔ Access KVM/IPMI Console (OVH)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Toggle IPv6
+
|style="padding: 0px 0px 0px 30px;"|✔ View Server Status And Details
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Private Networking
+
|style="padding: 0px 0px 0px 30px;"|✔ View/Create/Restore/Delete Snapshots (VPS)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ User Data - Execute Custom Cloud-Config Or Bash Script To Customize Server On First Boot
+
|style="padding: 0px 0px 0px 30px;"|✔ View Assigned Disks With Bandwidth And Space Limit (VPS)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Allow SSH Key Inserting - Enable Logging In To Server Without Password
+
|style="padding: 0px 0px 0px 30px;"|✔ View Assigned IP Addresses And Update Reverse DNS Paths
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Features Available In Client Area:
+
|style="padding: 0px 0px 0px 30px;"|✔ View Traffic Statistics Graph (Dedicated Servers)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Rebuild Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Server Parameters During Order
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Snapshots
+
|style="padding: 0px 0px 10px 30px;"|✔ Receive Email Notifications After Server Creation, Password Reset And Rescue Reboot
 
|}
 
|}
 +
 +
*'''Configurable Options:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Tasks History
+
|style="padding: 10px 0px 0px 30px;"|✔ VPS:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Backups
+
|style="padding: 0px 0px 0px 45px;"|✔ Solution Type
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Kernels
+
|style="padding: 0px 0px 0px 45px;"|✔ Operating System Template
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Firewalls
+
|style="padding: 0px 0px 0px 45px;"|✔ Data Center Location
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Reset Password
+
|style="padding: 0px 0px 0px 45px;"|✔ Snapshot
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Available Images To Rebuild Server:
+
|style="padding: 0px 0px 0px 45px;"|✔ License
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ OS Distributions
+
|style="padding: 0px 0px 0px 45px;"|✔ Solution Type, Operating System And Application (As Single Option)
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ One-Click Install Apps
+
|style="padding: 0px 0px 0px 30px;"|✔ Dedicated Servers:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ Snapshots
+
|style="padding: 0px 0px 0px 45px;"|✔ Operating System Template
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Generate Configurable Options
+
|style="padding: 0px 0px 10px 45px;"|✔ Operating System Language
 
|}
 
|}
 +
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Welcome Email And Password Reset Email Templates
+
|style="padding: 10px 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;"|✔ Configure Email Piping
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports OVH VPS And Dedicated Servers
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Run Server Connection Test
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports "So you Start" And "Kimsufi" Brands
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Toggle Debug For Logging API Requests And Responses
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports Plan Upgrades (VPS)
 
|}
 
|}
−
 
−
*'''Client Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Power On/Power Off/Shut Down/Reboot Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Server's Status And Details
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 7.2 Up To PHP 7.4
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Server's Network Information
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View/Create/Restore/Delete Snapshots
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V7.10 And Later
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View And Restore Backups
+
|style="padding: 0px 0px 30px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/ovh-vps-and-dedicated-servers#open-source-version Open Source Version]
 
|}
 
|}
 +
 +
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Rebuild Server With Chosen:
+
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure OVH VPS & Dedicated Servers  For WHMCS.''' <br />
 +
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ OS Distribution
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ One-Click App
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Administrator's Snapshot
+
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the extension into the main WHMCS directory.<br />
 +
Extracted files in your WHMCS directory should look like this:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Server Kernel
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View/Create/Delete Firewalls And Inbound/Outbound Rules For:
+
|style="padding: 0px 0px 15px 15px;"|'''3. When you install OVH VPS & Dedicated Servers  For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
 +
The file is located in '' 'modules/servers/OvhVpsAndDedicated/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ TCP Protocol
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ UDP Protocol
+
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
 +
Enter your license key between the quotation marks as presented on the following screen.<br />
 +
You can find your license key in our client area → '' 'My Products'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ ICMP Protocol
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Reset Server Password
+
|style="padding: 0px 0px 15px 15px;"|'''5. Now, set up the  '' 'storage' '' folders as recursively writable.'''<br />
 +
These folders are available at:
 +
#'' '/your_whmcs/modules/servers/OvhVpsAndDedicated/' '' and
 +
#'' '/your_whmcs/modules/addons/OvhVpsAndDedicated/' ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Server Hostname
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_4_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Tasks History
+
|style="padding: 0px 0px 30px 15px;"|'''6. The last step is setting up the cron job.'''<br />
 +
 
 +
* Mail cron - will be used to send emails to clients after Server creation, reinstallation and entering the rescue mode.<br/>You will find more information on this topic in the product configuration section. We suggest the cron to run every 5 minutes:
 +
<pre>php -q /your_whmcs/modules/servers/OvhVpsAndDedicated/cron/cron.php mail:run</pre>
 +
 
 +
Remember to replace '' 'your_whmcs' '' with your WHMCS root path.
 
|}
 
|}
 +
 +
==Activation of Addon==
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Server Parameters During Order
+
|style="padding: 10px 0px 15px 15px;"|'''7. Now you have to activate the module in your WHMCS system.'''<br />
 +
Log in to your WHMCS admin area. Click '' 'System Settings' '' and find '' 'Addon Modules'. ''<br/>
 +
Afterwards, find '' 'OVH VPS And Dedicated Servers For WHMCS' '' and press the '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Provide SSH Key During Order
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Receive Email Notification After VM Creation And Password Reset
+
|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 the desired admin roles and press '' 'Save Changes'. ''<br />
 
|}
 
|}
−
 
−
*'''Configurable Options:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Region
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_6.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Image
+
|style="padding: 0px 0px 30px 15px;"|'''9. OVH VPS And Dedicated Servers For WHMCS has been successfully installed!'''<br />
 +
Access the addon under '' 'Addons' '' → '' 'OVH VPS And Dedicated'. ''
 
|}
 
|}
 +
 +
==Configuration of Server==
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Additional Volume Size
+
|style="padding: 10px 0px 15px 15px;"|'''10. Now, we will show you how to configure a new product.'''<br />
 +
Go to '' 'System Settings' '' → '' 'Servers' '' and press '' 'Add New Server' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Monitoring
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_7.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Private Networking
+
|style="padding: 0px 0px 15px 15px;"|'''11. Next, enter your server name and select '' 'OVH' '' from the '' 'Type' '' field.<br/>
 +
Now, provide your:
 +
*'''Application Key'''
 +
*'''Application Secret'''
 +
*'''Consumer Key'''<br/>
 +
Then select '''Location''' and '''Country''' corresponding with the server offered by the administrator and finally, select the '''OVH Server Type''' (VPS/Dedicated).
 +
<br/> ''' ''Note:''' For "So You Start" and "Kimsufi" select 'Dedicated'. ''<br/>
 +
Check the connection when ready and, if it is successful, save the changes. <br/>
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Firewalls Limit
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_8.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Size Slug Plan
+
|style="padding: 0px 0px 15px 15px;"|'''API details''' are generated depending on the location where you own the OVH account. These might be:
 +
*https://api.us.ovhcloud.com/createApp/ ''(US)''
 +
*https://api.ovh.com/createApp/
 +
*https://eu.api.ovh.com/createApp/
 +
*https://ca.api.ovh.com/createApp/
 +
*https://eu.api.soyoustart.com/createApp/
 +
*https://ca.api.soyoustart.com/createApp/
 +
*https://eu.api.kimsufi.com/createApp/
 +
*https://ca.api.kimsufi.com/createApp/
 +
 
 +
To create an application, please move directly [https://api.ovh.com/createToken/ here] and create the necessary keys.<br/>
 +
In case you encounter any issues with generating your API details, please contact your provider. To learn more about API, please refer to the [https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/ documentation].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Snapshots Limit
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_8_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Backups
+
|style="padding: 0px 0px 15px 15px;"|You may also skip the '' 'Consumer Key' '' field in the server configuration ''(Application Key and Secret must be provided)''.<br/>
 +
After saving the changes, the module will redirect you, in such case, to your provider's page where the key can be generated at once. Please log in and select '' 'Unlimited' '' in the key validity field.<br/>
 +
The '' 'Consumer Key ' '' will be automatically generated and entered in the appropriate field in the server's configuration page in the module.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ IPv6
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_8_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ User Data
+
|style="padding: 0px 0px 20px 15px;"|'''12. It is time to create a server group. To do so, click on '' 'Create New Group'.'''''
 
|}
 
|}
−
 
−
*'''General Info:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Integrated With <u>DNS Manager For WHMCS</u> - Manage DNS Records On DigitalOcean Directly [https://www.modulesgarden.com/products/whmcs/dns-manager (read more)]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 20px 15px;"|'''13. Enter a name, click on your previously created server, press '' 'Add' '' and afterward '' 'Save Changes'.'''''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.3
+
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_9_1.png]]
 
|}
 
|}
 +
 +
==Configuration of Product==
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
+
|style="padding: 10px 0px 15px 15px;"|'''15. In order to create and configure a product, go to '' 'System Settings' '' → '' 'Products/Services'.'''''<br />
 +
Click on '' 'Create a New Group'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V7.4 And Later
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/ovh vps dedicated-droplets#open-source-version Open Source Version]
+
|style="padding: 0px 0px 20px 15px;"|'''16. Enter your product group name and press '' 'Save Changes'. '''''
 
|}
 
|}
−
 
−
=Installation and Configuration=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure OVH VPS & Dedicated Servers  For WHMCS.''' <br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_11.png]]
−
We will guide you step by step through the whole installation and configuration process.
+
 
|}
 
|}
−
==Installation==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
+
|style="padding: 0px 0px 15px 15px;"|'''17. Once you have a product group, you can create a new product.'''<br />
 +
To do so, first click on '' 'Create a New Product'.''  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_12.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''18. Afterward, choose your product type, enter your product name and choose the product group from the dropdown menu. Press '' 'Continue'. '' '''<br />
−
In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later.<br/> If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support].
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP71_73.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_13.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>  
+
|style="padding: 0px 0px 15px 15px;"|'''19. Now, go to the '' 'Module Settings' '' section, choose your previously created server group from the dropdown menu.'''<br />
−
The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3.<br/>
+
The module should automatically save and reload the settings. If not, click on the '' 'Save Changes' '' option manually.'''
−
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_73.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_14.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|'' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/ovh vps dedicated-droplets#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
|style="padding: 0px 0px 15px 15px;"|'''20. Now, you can start configuring the settings of the Server you sell.'''<br /> Bear in mind that the settings vary, depending on the server type selected.<br/>
 +
Underneath we will describe the settings configuration for '' 'OVH VPS' '' and '' 'OVH Dedicated Servers' '' in details.<br/> Note that settings for '' 'So You Start' '' and '' 'Kimsufi' '' products are very much alike the '' 'OVH Dedicated Servers' '' once, so you may surely base on them while configuring these products.
 +
 
 +
'''OVH VPS''' configuration settings:
 +
 
 +
* '''Solution Type''' - choose from the available the one that will suit your needs the most
 +
 
 +
* '''Operating System''' -  choose the OS, it can still be reinstalled at any time if such an option is enabled for clients
 +
**GNU/Linux
 +
**Windows (Cloud/Cloud RAM only)
 +
 
 +
* ''' License''' - you can select a license from the available ones
 +
 
 +
* '''Data Center Location''' - choose where the server shall be located on the OVH data center
 +
 
 +
* '''Payment Frequency''' - define the frequency of payments
 +
 
 +
* '''Prevent System Reinstall''' - enable if you want to block the OS reinstallation during the upgrade process
 +
 
 +
* '''Snapshot''' -  decide if clients should be allowed to capture an image of the server at a given time.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. Once you have chosen the package with the right PHP version, extract it and upload its content into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_15.png]]
−
The content of the chosen PHP version files to upload should look like this.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_2.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''OVH Dedicated Server''' configuration settings:
 +
 
 +
* '''Operation System Template''' - choose a template of an operation system to install
 +
 
 +
* '''Operating System Language''' - choose the language of an installed operation system
 +
 
 +
* '''Plan''' - check out the powerful line-up of dedicated servers and select the preferred solution
 +
 
 +
* '''Disks''' - customise your server by selecting one of the available disks
 +
 
 +
* '''Distribution License''' - choose the distribution license
 +
 
 +
* '''Application License''' - choose the application license
 +
 
 +
* '''Contract Duration''' - define the duration of the contract
 +
 
 +
* '''Memory''' - define the memory of your dedicated server
 +
 
 +
* '''vRack''' - choose up to 40 Gbps, on certain models, for increased speed
 +
 
 +
* '''Public Network''' - choose the preferred public network traffic
 +
 
 +
* '''Data Center Location''' - define where a server will be located on the OVH data center
 +
 
 +
* '''Payment Frequency''' - define the frequency of payments
 +
 
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install OVH VPS & Dedicated Servers  For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_16.png]]
−
The file is located in '' 'modules/servers/DigitalOceanServers/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_3.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''21. Afterward, set up incoming mail configuration.'''<br/>
 +
Due to API limitations, all emails with server credentials can only be sent to your OVH / Kimsufi / So You Start email address set in the panel.<br/>This applies to messages with credentials sent after creating the server as well as messages sent after reinstallation.<br/>The solution to this problem is email piping that will be used to receive messages sent to your OVH mailbox and then forwarded through the templates further to your WHMCS clients.<br/>
 +
 
 +
'' '''Note:''' Even though the module filters the received messages in your mailbox, we recommend that you use a '''separate''' mailbox for your main OVH VPS and Dedicated Servers profile account to avoid any issues with non-OVH content.''<br/>
 +
 
 +
After setting up the dedicated mailbox, provide its valid credentials below and test whether the connection has been established correctly.
 +
 
 +
'''''Note:''' There is available an option to 'Disable Certificate Validation'. Please toggle this option ONLY if you are having trouble with the connection. The certificate validation will be omitted when connecting to an email box.'' <br/>
 +
'''''Note:''' The 'Mailbox Folder' option allows you to define your mailbox folder for 'Incoming Mail Configuration' which will be used if received emails are set to be automatically filtered and moved to other than the default folder in the inbox. <br/>
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_17.png]]
−
Enter your license key between the quotation marks as presented on the following screen.<br />
+
−
You can find your license key in our client area → '' 'My Products'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_4.png]]
+
|style="padding: 0px 0px 15px 15px;"|The cron set during the last stage of the module's installation should periodically check that mailbox for OVH messages. <br/>If any new emails are received, they will be then converted to your email template and sent to the corresponding client.<br/>The default email templates for product creation, reinstallation and reboot in rescue mode can be specified below. Take a look at the [[#Tips|Tips]] section - tip no 1, and check the templates' types.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. Now, set up the  '' 'storage' '' folder as recursively writable.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_18.png]]
−
This folder is available at '' '/your_whmcs/modules/servers/DigitalOceanServers/'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_4_1.png]]
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''7. The last step is setting up three cron jobs.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''22. Automation Settings section includes detailed actions that will be automatically performed by the module in several situations:'''
 +
*'''Action On Service Suspension''' - decide what to do with the server in situation when the module command: ''Suspend'' has been triggered
 +
**Stop (VPS)
 +
**Do Nothing (VPS)
 +
**Do Nothing ''(Dedicated Server)''
 +
**Reboot To Rescue ''(Dedicated Server)''
 +
**Terminate ''(Dedicated Server)''
 +
**Reinstall ''(Dedicated Server)''
  
−
* Mail cron - will be used to send emails to clients after Server creation, rebuilt or password reset.<br/>You will find more information on this topic in the product configuration section. We suggest the cron to run every 5 minutes: <pre>php -q /your_whmcs/modules/servers/DigitalOceanServers/cron/cron.php MailCron</pre>
+
*'''Auto Pay With Preferred Method''' - toggle to make payments for orders automatically with a preferred payment method in OVH Panel
  
−
* Tasks cron - will be used to remove volumes from the panel after their termination. If not set, the admin will have to delete them manually.<br/>We suggest that the cron should run every hour: <pre>php -q /your_whmcs/modules/servers/DigitalOceanServers/cron/cron.php Tasks</pre>
+
*'''Auto Assign VPS/Dedicated Server To Reusable On Termination''' - when terminated, the server will be in fact cleared and added to the queue to be selected as a reusable by other clients
  
−
* Firewall cron - will be used to synchronize Firewalls assigned to Servers directly in the panel.<br/>You will find more information on this topic in the product configuration section. We suggest  that the cron should run every hour: <pre>php -q /your_whmcs/modules/servers/DigitalOceanServers/cron/cron.php Firewall</pre> Remeber to replace '' 'your_whmcs' '' with your WHMCS root path.
+
*'''Waive Retractation Period''' - toggle to waive retractation period on OVH orders
 
|}
 
|}
−
 
−
==Configuration of Server==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''8. Now, we will show you how to configure a new product.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_19.png]]
−
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_5.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''23. The following section is dedicated to the Client Area Features.'''<br/>
−
|}
+
You will find here numerous options that can be enabled and then will be available to your clients in their client area. Please note that some options are available for VPS only, Dedicated Server only and some for both of them:
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''9. Next, enter your server name and select '' 'OVH VPS & Dedicated Servers ' '' from the 'Type' field.<br/>
+
−
Now, in the '' 'Password' '' field provide your DigitalOcean '' '''API token''' '' and check the connection. If successful, save changes. <br/>
+
  
−
'' '''Note:''' To find your '''API token''', log in to your DigitalOcean panel and go to the [https://cloud.ovh vps dedicated.com/settings/api '''API''' section] where you can generate a new token.<br/> You will need a token with '''read''' and '''write''' permissions. Remember to copy and store the token in the safe place because it will no longer be visible in the panel.<br/> Click [https://www.docs.modulesgarden.com/images/b/bf/DO_API_Token.png here] to see an example where to find it.''
+
*'''Disks''' ''(VPS only)'' - if enabled, clients are allowed to view disks attached to their servers with specified limits
 +
 
 +
*'''Reinstall''' - if enabled, clients are allowed to reinstall the server in the client area
 +
 
 +
*'''KVM/IPMI Console''' - if enabled, clients are allowed to manage their server using KVM console
 +
 
 +
*'''Service Information''' - decide which records will be visible in the client area. Please remember that if you do not choose anything, all records will be displayed in the client area.
 +
 
 +
*'''Rescue Mode''' - if enabled, clients are allowed to reboot the server in rescue mode
 +
 
 +
*'''IP Addresses''' - if enabled, clients are allowed to view IP addresses assigned to the server
 +
 
 +
*'''Update Reverse DNS Paths''' - if enabled, reverse DNS can be updated in the client area, '' 'IP Addresses' '' must be previously enabled to use his option
 +
 
 +
*'''Traffic Statistics Graph''' ''(Dedicated Server only)'' - if enabled, clients are allowed to view traffic graph
 +
<br/>
 +
'''''Important:''' Access to '''KVM/IPMI Console''' and '''Traffic Statistics Graph''' is available for OVH only. "Kimsufi" and "So You Start" brands do not support them.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_20.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''10. It is time to create a server group. To do so, click on '' 'Create Server Group' ''.'''
+
|style="padding: 0px 0px 15px 15px;"|'''24. At the end of the configuration process, you can decide whether you want to generate configurable options for the product.'''<br/>
 +
Configurable options can be used by your clients to select each Server parameters individually during order placement.<br/>Otherwise, if configurable options are not defined, then the fixed parameters specified in the earlier configuration will be used instead.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_21.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''11. Enter a name, click on your previously created server, press '' 'Add' '' and afterward '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 15px 15px;"|If you decide to use configurable options, press on the 'Create' button and select which options you want to generate.<br/> Note that the configuration for disabled options will still be taken from the configuration of the main product.<br/>More information about how to use configurable options can be found [https://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options here] or in the official WHMCS [https://docs.whmcs.com/Addons_and_Configurable_Options documentation].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_9.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_22.png]]
 
|}
 
|}
  
−
==Configuration of Product==
+
===Generating Additional Configurable Option===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''12. In order to create and configure a product, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|This section presents how you can manually add '' 'Solution Type & Operating System & Application' '' as additional configurable option in order to provide the diversity of your products. <br/> ''' Proceed to '' 'System Settings' '' → '' 'Configurable Options' '' '''. <br/> Click on the '' 'Configurable Options' '' that were generated previously.  
−
Click on '' 'Create a New Group' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_CO1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''13. Enter your product group name and press '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 15px 15px;"|Click '' 'Add New Configurable Option' '' as presented below.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_11.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_CO2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''14. Once you have a product group, you can create a new product.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|Now, you need to provide ''' '' 'planCodeVpsOsAddon|Solution Type & Operating System & Application' '' ''' as '' 'Option Name' '' and choose ''' '' 'Dropdown' '' ''' as '' 'Option Type' ''. <br/> The first option has to be ''' '0|None' '''. <br/>
−
To do so, first click on '' 'Create a New Product' ''.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_CO3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''15. Afterward, choose your product type, enter your product name and choose the product group from the dropdown menu. Press '' 'Continue'. '' '''<br />
+
|style="padding: 0px 0px 15px 15px;"|You can add another '' 'Options' '' following this scheme: <br/>
−
<!-- '' 'Product Type' '' should be set to '' 'Hosting Account'. '' -->
+
<pre> product:OS:license|your name that is displayed to customers </pre>
 +
As an example, we will provide ''' '' 'vps-value-1-2-40:Centos 7 - cPanel:option-cpanel-1|VPS Value 1 vCPU 2 GB RAM 40 GB disk - Centos 7 - cPanel (Option cPanel 1 account)' '' '''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_CO4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''16. Now, go to the '' 'Module Settings' '' section, choose both your previously created server group from the dropdown menu.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|If you wish to diversify your products, set different prices to make your products more competitive on the market. <br/> You can create another options using the following values. <br/>
−
The module should automatically save and reload the settings. If not, click on the '' 'Save Changes' '' option manually.'''
+
|}
 +
{| class="wikitable" style="margin-left: 25px; margin-bottom: 20px; margin-top: 0px;"
 +
! Product
 +
! OS
 +
! License
 +
|-
 +
| vps-comfort-4-16-160
 +
| Archlinux
 +
| option-cpanel-100
 +
|-
 +
| vps-comfort-4-16-320
 +
| Centos 7
 +
| option-cpanel-200
 +
|-
 +
| vps-comfort-4-16-80
 +
| Centos 7 - cPanel
 +
| option-cpanel-30
 +
|-
 +
| vps-comfort-4-4-80
 +
| Centos 8
 +
| option-cpanel-5
 +
|-
 +
| vps-comfort-4-8-160
 +
| Centos 8 - Plesk
 +
| option-cpanel-1
 +
|-
 +
| vps-comfort-4-8-320
 +
| CoreOS Stable
 +
| option-plesk-webadmin
 +
|-
 +
| vps-comfort-4-8-80
 +
| Debian 10
 +
| option-plesk-webhost
 +
|-
 +
| vps-elite-8-16-160
 +
| Debian 10 - Plesk
 +
| option-plesk-webpro
 +
|-
 +
| vps-elite-8-16-320
 +
| Debian 8 - Docker
 +
| option-windows
 +
|-
 +
| vps-elite-8-16-640
 +
| Debian 8 - OpenVPN
 +
|
 +
|-
 +
| vps-elite-8-32-160
 +
| Debian 8 - Plesk
 +
|
 +
|-
 +
| vps-elite-8-32-320
 +
| Debian 8 - Vestacp
 +
|
 +
|-
 +
| vps-elite-8-32-640
 +
| Debian 8 - Virtualmin
 +
|
 +
|-
 +
| vps-elite-8-8-160
 +
| Debian 8 - WordPress
 +
|
 +
|-
 +
| vps-elite-8-8-320
 +
| Debian 9
 +
|
 +
|-
 +
| vps-elite-8-8-640
 +
| Fedora 31
 +
|
 +
|-
 +
| vps-essential-2-4-160
 +
| Ubuntu 16.04
 +
|
 +
|-
 +
| vps-essential-2-4-40
 +
| Ubuntu 18.04
 +
|
 +
|-
 +
| vps-essential-2-4-80
 +
| Ubuntu 19.10
 +
|
 +
|-
 +
| vps-essential-2-8-160
 +
| Ubuntu 20.04
 +
|
 +
|-
 +
| vps-essential-2-8-80
 +
| Windows Server 2016 Standard (Desktop)
 +
|
 +
|-
 +
| vps-value-1-2-40
 +
| Windows Server 2019 Standard (Desktop)
 +
|
 +
|-
 +
| vps-value-1-2-80
 +
|
 +
|
 +
|-
 +
| vps-value-1-4-40
 +
|
 +
|
 +
|-
 +
| vps-value-1-4-80
 +
|
 +
|
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_14.png]]
+
|style="padding: 0px 0px 15px 15px;"| '''Note:''' ''Please remember that the above options can be changed as plans are updated.''  <br/> You can easily check the currently available options by generating the default configurable options in the '' 'Module Settings' '' section.
 
|}
 
|}
 +
 +
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''17. Now, you can start configuring the settings of the Server you sell.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''You have just correctly created and customized a new product.'''<br />
−
Just like when creating a new virtual machine in your DigitalOcean panel, here also you can configure such options as:
+
Go to '' 'Addons' '' → '' 'OVH VPS And Dedicated' '' in your WHMCS.
−
* '''Project''' - Select a project on which the droplet will be created.
+
−
 
+
−
* '''Region''' - Select the data center region. More distant server locations may increase the server's latency without providing any practical benefits to clients.
+
−
 
+
−
* '''Size Slug Plan''' - Choose the size slug plan based on which resources will be allocated to the Server. You can read more about size slug indications  [https://developers.ovh vps dedicated.com/documentation/changelog/api-v2/new-size-slugs-for-droplet-plan-changes/ here]. <br/>''Note: If you want to change their names to more user-friendly, you can do it in a [https://www.docs.modulesgarden.com/General#How_To_Change_WHMCS_Module_Language language file].''
+
−
 
+
−
* '''Image''' - Select the image of the system that will be installed on Server.
+
−
 
+
−
* '''Additional Volume Size''' -  Allows you to create and attach additional SSD storage volume to Server in the provided size (in GB).<br/>If left empty or set to 0, then the volume will not be created and attached. [https://www.ovh vps dedicated.com/community/tutorials/an-introduction-to-ovh vps dedicated-block-storage Here] you can find more information about DigitalOcean Block Storage.
+
−
 
+
−
* '''User Data''' - Choose the execution script which will be used to configure Server on the first boot. Go [[#User_Data_Scripts|here]] to find more information about how to use these scripts.<br/> '' '''Note:''' User Data scripts are '''optional''' for product configuration if you do not want to use them, simply set this field to the 'Do not use' option.''
+
−
 
+
−
* '''Snapshots Limit''' - [https://www.ovh vps dedicated.com/docs/images/snapshots/ Snapshots] provide a full copy of a Server, saving everything from a Server's disk to a disk image. Here you can define the maximum number of snapshots that can be stored at one time.
+
−
 
+
−
* '''Firewalls Limit''' - [https://www.ovh vps dedicated.com/docs/networking/firewalls/ Firewalls] block your servers and machines from external attacks. Here you can define the maximum number of firewalls that a client may add per virtual machine. Enter '0' to disable firewalls, leave empty to set no limits.<br/>'''''Note 1:''' You may create more firewalls in the panel which will be assigned with a cron run, the limit in such case can be exceeded.''<br/>'''''Note 2:''' A cron command is required to synchronize firewalls assigned and managed in the OVH VPS & Dedicated Servers  Panel.''
+
−
 
+
−
* '''Tags''' - Here you can apply custom labels for the Server. If you want to add multiple tags, separate them with a comma. Read more about tags [https://www.ovh vps dedicated.com/community/tutorials/how-to-tag-ovh vps dedicated-droplets here].
+
−
 
+
−
* '''Backups''' - Enables automatic system-level backups. It can be used for backup images, to revert the server or create new Servers. Click [https://www.ovh vps dedicated.com/community/tutorials/an-introduction-to-ovh vps dedicated-backups here] for more information.
+
−
 
+
−
* '''Monitoring''' - Enables additional Server metrics collection, monitoring, and alerting. [https://www.ovh vps dedicated.com/community/tutorials/an-introduction-to-ovh vps dedicated-monitoring Here] you can find out more.
+
−
 
+
−
* '''IPv6''' - Enables public [https://www.ovh vps dedicated.com/community/tutorials/how-to-enable-ipv6-for-ovh vps dedicated-droplets IPv6] networking for Server.
+
−
 
+
−
* '''Private Networking''' -  Adds [https://www.ovh vps dedicated.com/community/tutorials/ovh vps dedicated-private-networking-faq Server-to-Server] networking, within the same region.
+
−
 
+
−
* '''Debug''' - Enables logging of API requests and responses to WHMCS [https://docs.whmcs.com/Troubleshooting_Module_Problems module log] which may be useful if you experience any problems with the module.
+
−
 
+
−
'' '''Important:''' Before providing any extra features to your WHMCS clients, remember to familiarize yourself with the [https://www.ovh vps dedicated.com/pricing/ additional costs] that may be applied to your DigitalOcean account.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_15.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_23.png]]
 
|}
 
|}
 +
===Servers===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''18. Afterward, set up incoming mail configuration.'''<br/>
+
|style="padding: 10px 0px 20px 15px;"|'' 'Servers' '' section contains a list of your configured servers, you may quickly edit them directly from this site, simply press the edit icon.  
−
Due to API limitations, all emails with Server credentials can only be sent to your DigitalOcean [https://cloud.ovh vps dedicated.com/settings/profile profile] email address set in the panel [https://www.docs.modulesgarden.com/images/7/7c/DOD_Email_Profile.png here].<br/>This applies to messages with credentials sent after Server creation as well as messages sent after password reset.<br/>The solution to this problem is email piping that will be used to receive messages sent to your DigitalOcean mailbox and then forwarded through the templates further to your WHMCS clients.<br/>
+
−
 
+
−
'' '''Note:''' Even though the module filters the received messages in your mailbox, we recommend that you use a '''separate''' mailbox for your main DigitalOcean profile account to avoid any issues with non-DigitalOcean content.''<br/>
+
−
 
+
−
After setting up the dedicated mailbox, provide its valid credentials below and test whether the connection has been established correctly.<br/>
+
−
 
+
−
'''''Note:''' There is available an option to 'Disable Certificate Validation'. Please toggle this option ONLY if you are having troubles with the connection. The certificate validation will be omitted when connecting to an email box.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_24.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Once the connection is successful, remember to '''save''' your module settings.<br/>From now on, the cron set during the last stage of the module's installation should periodically check that mailbox for DigitalOcean messages. <br/>If any new emails are received, they will be then converted to your email template and sent to the corresponding client.<br/>The default email templates for product creation and password reset can be specified below. Take a look at the [[#Tips|Tips]] section - tip no 4, and check the tempalte content.
+
|style="padding: 0px 0px 20px 15px;"|In the next step, press the marked icon to see a list of deployed machines.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_25.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''19. The following section is dedicated to the Client Area Features.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|There you will see all existing machines on this very server. Whether they are used by any client already or not.<br/>
−
You will find here six options that can be enabled and then will be available to your clients in their client area. These options are:
+
Next to the machine name, there are details such as:
−
*'''Rebuild Server''' - if enabled, clients are allowed to rebuild their virtual machine in an adequate section.
+
*its state
−
 
+
*displayed name
−
*'''Snapshots''' - if enabled, clients are granted access to snapshots section
+
*assigned client (if there is any already)
−
 
+
*service assigned
−
*'''Task History''' - if enabled, clients are allowed to view the history of the tasks
+
*reusable toggle - for machines that can be used again by other clients without the necessity to terminate it first. If disabled, the machine can be simply terminated when not used.<br/> If enabled, when the product is created for the next time by the client, this machine will be automatically reinstalled and assigned to this client.
−
 
+
−
*'''Backups''' - if enabled, clients are allowed to view the history of the tasks
+
−
 
+
−
*'''Kernel''' - if enabled, clients are allowed to change their current kernel to any other available<br/>'''''Note:''' Kernels' management is dependant on the selected OS and must be active in the panel. Before enabling, make sure the option functions correctly in the panel.''<br/> For more info on Kernels move [https://www.ovh vps dedicated.com/docs/droplets/how-to/kernel/  here].
+
−
 
+
−
*'''Firewall''' - if enabled, clients are allowed to create firewalls and manage inbound and outbound rules
+
−
 
+
−
*'''Reset Password''' - if enabled, clients are allowed to reset the password
+
−
 
+
−
*'''Change Hostname''' - if enabled, clients may give their hostname a unique name
+
  
−
*'''Available Images To Rebuild''' - Select OS images, One-click apps, and Snapshots from available to allow the client to use when rebuilding a droplet.<br/> Please note, that if you leave this field empty then all available OS images and One-click apps provided by DigitalOcean will be displayed in the client area to rebuild except the snapshots.<br/> Keep in mind that the available here list of OS Images includes all the snapshots, including the clients' private ones. Be careful when selecting them.  
+
In order to manually assign the machine to a client, simply press the marked on the screen button.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_17_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_26.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''20. At the end of the configuration process, you can decide whether you want to generate configurable options for the product.'''<br/>
+
|style="padding: 0px 0px 20px 15px;"|Start typing to see a list of clients, then select existing service to assign.
−
Configurable options can be used by your clients to select each Server parameters individually during order placement.<br/>Otherwise, if configurable options are not defined, then the fixed parameters specified in the earlier configuration will be used instead.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_26_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|If you decide to use configurable options, press on the 'Create' button and select which options you want to generate.<br/> Note that the configuration for disabled options will still be taken from the configuration of the main product.<br/>More information about how to use configurable options can be found [https://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options here] or in the official WHMCS [https://docs.whmcs.com/Addons_and_Configurable_Options documentation].
+
|style="padding: 0px 0px 20px 15px;"|There is also a possibility to assign reusable products to the machine. These products will be permitted to use this machine.  
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_18_1.png]]
+
−
|}
+
−
 
+
−
===SSH Keys===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|'''In the '' 'Custom Fields' '' tab you will find a '' 'SSH Public Key' '' field which is displayed to clients on the [[#Ordering|order form]] by default.'''<br/>
+
−
This field is optional. It allows your clients to insert their public key in order to be able to log in to Server without using a password.<br/>The provided key should be in one of the ''OpenSSH'' formats which are supported by DigitalOcean API. This includes the following types:
+
−
*ssh-rsa
+
−
*ssh-dss
+
−
*ecdsa-sha2-nistp256
+
−
*ecdsa-sha2-nistp384
+
−
*ecdsa-sha2-nistp521
+
−
*ssh-ed25519
+
−
If you would like to limit the possibility of entering the key e.g. only to the '' 'ssh-rsa' '' format, you can use the regular expression in the validation field, such as:
+
−
+
−
#ssh-rsa AAAA[0-9A-Za-z+/]+[=]{0,3}( [^@]+@[^@]+)?#
+
−
 
+
−
More information about how DigitalOcean handles SSH keys and how to create them can be found [https://www.ovh vps dedicated.com/docs/droplets/how-to/add-ssh-keys/ here]. <br/>
+
−
If you do not want this field to be available to customers during the ordering process, simply uncheck '' 'Shown on Order Form' '' option.<br/> Remember that API allows such action only '''once''', during the initial VM creation. <br/>
+
−
 
+
−
'' '''Important:''' During tests we discovered that some OS images such as 'CoreOS', 'CentOS' or 'FreeBSD', may '''require''' the SSH key to create a Server.<br/>In such cases, we recommend that you additionally check the 'Required Field' option for such products. ''<br/>
+
−
 
+
−
''Please also note that when the SSH key is provided, DigitalOcean may '''not''' send the welcome email after Server creation.''
+
 
|}
 
|}
 
{|
 
{|
Line 520: Line 659:
 
|}
 
|}
  
−
===User Data Scripts===
+
===Logs===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|User data is arbitrary data that can be executed during Server creation, typically during the first boot of a cloud server.<br/>This allows you to perform tasks or run scripts as the root user which can be extremely useful when provisioning a server.<br/>
+
|style="padding: 10px 0px 20px 15px;"|Go back to '' 'Logs' '' section, there you will see a list of all module actions, including errors, notifications etc.
−
 
+
−
You can provide your own scripts using 'cloud-config' or 'Bash'. By default, we provide two exemplary scripts for changing the OS password or inserting SSH key, which you can use as a reference.<br/>
+
−
The script you want to include has to be located in the '' '/your_whmcs/modules/servers/DigitalOceanServers/storage/userDataFiles/' '' directory and may '''not exceed 64 KiB''' in size.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_29.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Once you create your own script, it can be chosen for product execution.<br/>
+
−
You can provide multiple scripts for configurable options, but only one can be chosen for Server creation.<br/>
+
−
If you would like to execute several different scripts at once, you should try combining them within a single file.<br/>
+
−
 
+
−
Remember that the scripts you provide should be compatible with the given distribution.<br/>
+
−
You can learn more [https://www.ovh vps dedicated.com/community/tutorials/how-to-use-cloud-config-for-your-initial-server-setup here] and [https://www.ovh vps dedicated.com/docs/droplets/resources/metadata/ here] about how to use cloud-config for the initial server setup.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_30.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_29.png]]
 
|}
 
|}
  
Line 545: Line 670:
 
==Admin Area==
 
==Admin Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|''' OVH VPS & Dedicated Servers For WHMCS allows you to monitor and manage your customer Servers from the admin area of your WHMCS system.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|''' ''OVH VPS & Dedicated Servers For WHMCS'' allows you to monitor and manage your customer servers from the admin area of your WHMCS system.'''<br />
 
This includes supervision of such features like:
 
This includes supervision of such features like:
−
# Configurable options which enable you to view the chosen Servers resources.<br/>'' '''Important:''' Due to API limitations, the only configuration possible to modify for the already created VM through the 'Change Package' functionality is the ''' 'Size Slug Plan' ''' option for Server resizing.<br/> And even this action may not always be allowed! You can also change the snapshots limit, which value is only kept locally on the WHMCS server.''
+
# Module commands and service actions that enable you to manage server status and features
−
# Module commands, service action and additional options enable you to manage Server status and features.
+
# Service information which provides you with the current status, resources and options set for the server
−
# Server information provides you with the current status, resources and options set for the Server.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_30.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|<ol start="4">
+
|style="padding: 0px 0px 15px 15px;"|'''OVH VPS type'''
−
<li>Network information presents assigned IPv4 and IPv6 addresses to the Server along with their gateway, interface type and used netmask or CIDR.</li>
+
<ol start="3">
−
<li>You can easily view and make new snapshots of the Server.</li>
+
<li>Service Monitoring section with current statuses</li>
−
<li>The automatic Server backups can be restored here as well.</li>
+
<li>Created snapshot with a direct option to edit, restore and delete it</li>
−
<li>You can also rebuild the Server OS to a different distribution.</li>
+
<li>List of IP addresses with option to update the reverse DNS path</li>
−
<li>And finally, display all actions taken on Servers in the tasks history table.</li>
+
<li>List of disks with any important details</li>
 
</ol>
 
</ol>
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_20.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_31.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''OVH Dedicated Servers type:'''
 +
<ol start="3">
 +
<li>List of IP Addresses with option to update the reverse DNS path</li>
 +
<li>Traffic statistics graph</li>
 +
</ol>
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_32.png]]
 
|}
 
|}
  
Line 571: Line 705:
 
|style="padding: 10px 0px 15px 15px;"|Owing to configurable options, you are able to offer a product which your clients can tailor according to their needs.<br />Additionally, you are able to set up pricing for each configurable option, which makes your offer even more competitive.<br/>
 
|style="padding: 10px 0px 15px 15px;"|Owing to configurable options, you are able to offer a product which your clients can tailor according to their needs.<br />Additionally, you are able to set up pricing for each configurable option, which makes your offer even more competitive.<br/>
  
−
Based on the custom [[#SSH Keys|SSH key]] field configuration, you might also insert your public SSH key, which will allow you to log in to a Server without the need to use the password.<br/>Note that this key should be in one of the ''OpenSSH'' standard formats which are supported by API, e.g. ''ssh-rsa''.<br/>
+
After the order placement and successful VM creation, the server credentials will be sent to the client's email address according to the set cron execution intervals.
−
 
+
−
After the order placement and successful VM creation, the Server credentials will be sent to the client's email address according to the set cron execution intervals.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_21.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_33.png]]
 
|}
 
|}
−
 
+
===Importing Existing VPS===
−
==Client Area==
+
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Client area interface of OVH VPS & Dedicated Servers  should look like the one on the screen below.<br/>As you can see, the control panel contains useful options required for managing a Server.<br />
+
|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 the OVH panel. <br/> Take the following steps to make sure that the process will be carried out properly. <br/>  
−
The module allows your customers to easily power on/off, shutdown, reboot and reset password of their servers through pressing the corresponding buttons.<br />
+
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/>
−
Clients can also rebuild the server, create and restore snapshots, create firewalls and manage their rules, access automatic backups and view tasks history with their current status.<br/>
+
2. Proceed to the newly created product's card in your admin area. Find the following empty field:
−
Additionally, clients can change the name of the hostname, view the current Server parameters, resources and all set options, as well as the assigned IP addresses.  
+
*'''Server Name'''
 +
The above-mentioned information has to be consistent with the data from your OVH panel. Now, complete this field 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' ''.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_import.png]]
 
|}
 
|}
−
 
−
===Rebuild Server===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|This feature allows your clients to rebuild their virtual machine and change a server's OS image.<br />
+
|style="padding: 0px 0px 15px 15px;"|3. If the completed data is correct, after refreshing the page, you will see the attached VPS from OVH. <br/> '''Important!'''  Remember to manually add other missing parameters of the VPS such as domains, IP Addresses, configurable options, etc.  so they match the parameters of the attached VPS from the OVH panel.  
−
Press the shown below button in order to reinstall your server to the chosen image and confirm your choice.<br/>
+
−
Please remember that this will also wipe the previously saved data on the VM disk.  
+
 
|}
 
|}
 +
 +
==Client Area==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_23.png]]
+
|style="padding: 10px 0px 15px 15px;"|Client area interface of '' 'OVH VPS & Dedicated Servers' '' should look like the one on the screen below.<br/>As you can see, the control panel contains useful options required for managing a server.<br />
 +
The module allows your customers to easily power on/off, reboot and reboot in rescue mode, reinstall and access console through pressing the corresponding buttons.<br />
 +
Clients can also view disks, create and restore snapshots, see IP addresses and view current traffic graphs.<br/>
 +
Additionally, clients may view the current server parameters, resources as well as the assigned IP addresses. <br/>
 +
 
 +
'''OVH VPS''' client area view:
 
|}
 
|}
−
 
−
===Snapshots===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Use snapshots to save the current contents of the virtual machine memory.<br/>You may use them later to restore the VM's settings.  
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_34.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_24.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''OVH Dedicated Server''' client area view:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Press the '' 'Create New Snapshot' '' button and enter the unique snapshot name.<br/>Please note that the spaces in the snapshot name will be ignored by the API and saved as a single string name anyway .  
+
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_35.png]]
 
|}
 
|}
 +
===Service Actions===
 +
====Access Console====
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_25.png]]
+
|style="padding: 10px 0px 15px 15px;"|In case of OVH VPS, clients might be granted access to KVM console.<br/>
 +
Simply press its icon to open the console window.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|Creating a snapshot may take a while, so it will not appear on the list right away.<br/>Its progress status can be tracked in ''[[#Tasks History|Tasks History]]'' or by refreshing the snapshot list manually.
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_36_1.png]]
 
|}
 
|}
−
 
−
===Backups===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|If the automatic backups have been enabled for the Servers products, then your client will be able to restore them from this section.<br/>DigitalOcean uses a snapshot-based backup system. This provides system-level backups of a server without powering it down. <br/>
+
|style="padding: 0px 0px 15px 15px;"|For OVH Dedicate Servers, there is supported IPMI console.<br/>
−
'' '''Note:''' This process happens '''automatically''' within a pre-determined scheduling window, and is completed in the background while the Server is running.<br/>Client cannot force the creation of an additional copy on demand or delete it - this however can be achieved by using [[#Snapshots|snapshots]] feature.''
+
Press the IPMI Access icon and then select type and TTL of the IPMI access to continue to the console.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_26.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_36_2.png]]
 
|}
 
|}
  
−
===Kernels===
+
====Rescue Reboot====
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In '' 'Kernels' '' section you may see kernels available and change your current one.<br/> Use the marked on the screen button to upgrade your Kernel.
+
|style="padding: 10px 0px 15px 15px;"|This action reboots the server in the rescue mode. <br/>
 +
The moment you press the confirm button, new login details are sent in an email template selected in the product configuration ''(see point [[#Configuration_of_Product|21]])'', with accordance to the cron settings. <br/>
 +
'''''Note:''' The action might last up to a few minutes, please be patient.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_26_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_36_3.png]]
 
|}
 
|}
  
−
===Firewalls===
+
====Reinstall====
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Firewalls' '' section allows to view and create firewalls that will protect your Server from external attacks.<br/>
+
|style="padding: 10px 0px 15px 15px;"|The action when triggered, causes the new login details to be sent in an email template selected in the product configuration ''(see point [[#Configuration_of_Product|21]])'' and with accordance to the cron settings. <br/>
−
Press '' 'Create Firewall' '' button to create one.
+
'''''Note:''' Please be patient as reinstallation process is quite time consuming.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_26_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_36_4.png]]
 
|}
 
|}
 +
 +
===Service Management===
 +
====Snapshot (VPS)====
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Type in the just created firewall a name.
+
|style="padding: 10px 0px 15px 15px;"|Use snapshots to save the current contents of the virtual machine memory.<br/>You may use them later to restore the VM's settings.
 +
 
 +
'''''Note:''' Creating a snapshot may take a while, so it will not appear on the list right away. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_26_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_37_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|A new firewall will appear on the list, note that it will have an ID assigned and a default inbound rule automatically created. <br/>
+
|style="padding: 0px 0px 15px 15px;"|Allowed actions on the created snapshot:
−
Press '' 'Edit' '' icon to move to the firewall rules management page.
+
# Edit the snapshot (description)
 +
# Restore the snapshot to reverse the saved contents of the VM settings
 +
# Delete the snapshot
 +
# Create another snapshot. <br/> '''''Note:''' Keep in mind that you must have previously deleted the existing snapshot, as only one snapshot may exist at the time. ''<br/>
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_26_4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_37.png]]
 
|}
 
|}
−
====Firewall Rules====
+
 
 +
====Disks (VPS)====
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Every newly created firewall has a default, exemplary rule created. To create your own rules, just click the marked button.
+
|style="padding: 10px 0px 15px 15px;"|When you enter this section, you will see a list of assigned disks with any details on them, such as:
 +
*Type
 +
*Size
 +
*Bandwidth limit
 +
*Free space threshold
 +
*Status
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_26_5.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_36.png]]
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Finally, setup the rule by selecting:
 
−
*'''Rule Type''' - configure the firewall rules for incoming or outbound traffic
 
−
**Inbound - the specified ports will accept inbound connections only, any other traffic will be blocked
 
−
**Outbound -  the outbound traffic will be allowed for the specified ports, any other traffic will be blocked
 
  
−
*'''Protocol''' - Select the type of allowed traffic:
+
====IP Addresses====
−
**TCP
+
{|
−
**UDP
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'IP Addresses' '' you may see any assigned IP addresses, their version, type, location, MAC address and reverse DNS if specified.<br/>  
−
**ICMP
+
Update the reverse DNS path of an IP address by pressing the marked button.
−
 
+
−
*'''Ports''' - Provide ports to allow the traffic on, accepted forms:  
+
−
**single port (eg. 80)
+
−
**range (eg. 8000-9000)
+
−
**‘all’ – to open all ports
+
−
**leave empty - for ICMP protocol type
+
−
 
+
−
*'''IP Address''' - add IP addresses, use coma to separate. Both IPv4 and IPv6 are supported.<br/>To add a rule for all addresses at once use:
+
−
** '' '0.0.0.0/0' '' for IPv4
+
−
** '' '::/0' '' for IPv6
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_26_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_39.png]]
 
|}
 
|}
−
 
−
===Tasks History===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Tasks history allows you to view all tasks performed on your VM with the current progress status. <br/>Please note that this actions are also collected from the DigitalOcean API.
+
|style="padding: 0px 0px 20px 15px;"|Provide a new reverse DNS for the selected IP address. Press '' 'Confirm' '' when ready.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_27.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_40.png]]
 
|}
 
|}
  
−
=Tips=
+
====Traffic Statistics Graph (Dedicated Servers)====
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"|1. You can use the [https://www.modulesgarden.com/products/whmcs/dns-manager DNS Manager For WHMCS] module to manage your Server DNS records.<br/>
+
|style="padding: 10px 0px 15px 15px;"|Open this section to see the graph with traffic statistics. You will find there outlined data on errors, packets and traffic downloads as well as uploads.<br/>
−
It already has a built-in support for DigitalOcean DNS server.
+
You may easily adjust the graph's view by changing the time scope of the displayed stats.<br/>
 +
 
 +
'''''Note 1:''' Some of the mentioned option may not be visible on the graph until soma data are generated. This is applicable to the graph itself as well.''<br/>
 +
'''''Note 2:''' "So You Start" and "Kimsufi" brands may not support graphs.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 5px 15px;"|2. Some of the features like ''IPv6, private networking'' or ''monitoring'' can only be activated '''once''' and cannot be disabled later on.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:OVH_41.png]]
−
Use these features wisely as they can increase your Servers maintenance costs.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|3. There is an additional custom field named '' 'Firewalls'.'' It should be generated automatically when you upgrade the product.<br/> In case something goes wrong, please add the custom field manually. Take a look at the screen below to check its specification.
+
|style="padding: 0px 0px 20px 15px;"|Select the time scope:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 25px;"|[[File:OVH_31.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_41_1.png]]
 
|}
 
|}
 +
 +
=Tips=
 +
 
{|
 
{|
−
|style="padding: 0px 0px 5px 15px;"|4. '' 'DigitalOcean Server Create Server' '' email template includes information on:  
+
|style="padding: 10px 0px 15px 15px;"|1. List of '' 'OVH VPs & Dedicated Servers' '' email templates included in the module:  
−
* Server Name - {$droplet_name}
+
* OVH VPS Has Been Created
−
* User Name - {$droplet_user}
+
* OVH VPS Rescue Reboot
−
* Password -  {$droplet_password}
+
* OVH VPS Reinstalled
−
* Dedicated IP - {$service_dedicated_ip}
+
* OVH Dedicated Reinstalled
 +
* OVH Dedicated Server Rescue Reboot<br/>
 +
 
 +
In order to view the templates' content and edit it, please move to ''WHMCS → System Settings → Email Templates.'' <br/>
 +
More detailed information on templates can be found in the official [https://docs.whmcs.com/Email_Templates documentation]. <br/>
  
−
Please note that the last merge field has been added into the template in version 1.3.0. In case you started using the module earlier, you may add it manually.<br/>
+
2. If you want to block specific OS images which are available for the server reinstallation process, you need to add these OS images to the following file: <br/>
−
Underneath, you can see how the custom template looks like. You may surely edit it at '' 'WHMCS' → 'Setup' → 'Email Templates'.'' <br/> You will find there the second custom eamil template: '' 'Digital Ocean Password Reset Email' '' as well.
+
''yourWHMCS/modules/servers/OvhVpsAndDedicated/app/Config/blockedImages.json''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_32.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OVH_41_3.png]]
 
|}
 
|}
  
Line 732: Line 874:
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|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. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 5px 15px;"|2. Certain OS distributions may cause the '' 'Action did not complete' '' error in task when trying to reset Server's password, even if the success notification is initially returned.<br/>
+
−
This may be caused by the requirement to use the [[#SSH Keys|SSH key]] by given distribution instead of a password.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|3. Inserting the SSH key may prevent the welcome email being sent by DigitalOcean after Server creation.<br/>
+
|style="padding: 0px 0px 10px 15px;"|2. You may encounter problems while configuring the product for the '''dedicated''' server type for '' 'So you Start' '' or '' 'Kimsufi' '' brands. <br/> As a consequence, options such as plan to configure in the module settings can be unachievable. <br/> ''Please note that this is most probably caused by API problems on the side of these brands.''<br/> However, it is still possible to assign the ordered server directly from the panel of these brands to the client's product at WHMCS by providing its '' 'Server Name' '' in the ordered service in the admin area.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|4. Some features like ''monitoring'' might not be supported by all configurations.<br/>
+
|style="padding: 0px 0px 30px 15px;"|3. If you encounter error in logs: ''Error during create for service #name_of_your_service. Message: Your preferred payment method is not valid''<br/>
−
Please try choosing for example a different region or distribution.
+
'''Solution:''' Please log into your OVH panel and set up a default payment method there.  
 
|}
 
|}

Revision as of 12:24, 28 October 2021

Contents

About OVH VPS & Dedicated Servers For WHMCS

OVH VPS & Dedicated Servers For WHMCS will let you automatically supply VPS and dedicated servers powered by OVH, as well as So you Start and Kimsufi.

The module will allow your clients not only to remotely control the status of a machine, but also access the KVM and IMPI console, and update reverse DNS paths.
In addition, you will easily decide whether an existing server can be reused by another customer, in case the previous one no longer needs it.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate/Renew Server
✔ Power On/Power Off/Reboot Server
✔ Reboot Server In Rescue Mode
✔ Reinstall Server
✔ Access KVM/IPMI Console (OVH)
✔ View Server Status And Details
✔ Monitor Server Protocols Status (VPS)
✔ View/Create/Restore/Delete Snapshots (VPS)
✔ View Assigned IP Addresses And Update Reverse DNS Paths
✔ View Assigned Disks With Bandwidth And Space Limit
✔ View Traffic Statistics Graph (Dedicated Servers)
✔ Configure Product Details For:
✔ VPS
✔ Dedicated Server
✔ Choose Features Available In Client Area
✔ Generate Configurable Options
✔ Choose Welcome Email, Password Reset And Rescue Reboot Email Templates
✔ Configure Email Piping
✔ Choose Usable OVH Server Location, Country And Type
✔ Choose Existing Servers To Be Reused By Another Client
✔ View Servers Logs
  • Client Area Features:
✔ Power On/Power Off/Reboot Server
✔ Reboot Server In Rescue Mode
✔ Reinstall Server
✔ Access KVM/IPMI Console (OVH)
✔ View Server Status And Details
✔ View/Create/Restore/Delete Snapshots (VPS)
✔ View Assigned Disks With Bandwidth And Space Limit (VPS)
✔ View Assigned IP Addresses And Update Reverse DNS Paths
✔ View Traffic Statistics Graph (Dedicated Servers)
✔ Choose Server Parameters During Order
✔ Receive Email Notifications After Server Creation, Password Reset And Rescue Reboot
  • Configurable Options:
✔ VPS:
✔ Solution Type
✔ Operating System Template
✔ Data Center Location
✔ Snapshot
✔ License
✔ Solution Type, Operating System And Application (As Single Option)
✔ Dedicated Servers:
✔ Operating System Template
✔ Operating System Language
  • General Info:
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Most Suitable Servers To Products (read more)
✔ Supports OVH VPS And Dedicated Servers
✔ Supports "So you Start" And "Kimsufi" Brands
✔ Supports Plan Upgrades (VPS)
✔ Multi-Language Support
✔ Supports PHP 7.2 Up To PHP 7.4
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V7.10 And Later
✔ Easy Module Upgrade To Open Source Version

Installation and Configuration

This tutorial will show you how to successfully install and configure OVH VPS & Dedicated Servers For WHMCS.

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

Installation

1. Log in to our client area and download the module.
OVH 1.png
2. Upload and extract the extension into the main WHMCS directory.

Extracted files in your WHMCS directory should look like this:

OVH 2.png
3. When you install OVH VPS & Dedicated Servers For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

The file is located in 'modules/servers/OvhVpsAndDedicated/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

OVH 3.png
4. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

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

OVH 4.png
5. Now, set up the 'storage' folders as recursively writable.

These folders are available at:

  1. '/your_whmcs/modules/servers/OvhVpsAndDedicated/' and
  2. '/your_whmcs/modules/addons/OvhVpsAndDedicated/'
OVH 4 1.png
6. The last step is setting up the cron job.
  • Mail cron - will be used to send emails to clients after Server creation, reinstallation and entering the rescue mode.
    You will find more information on this topic in the product configuration section. We suggest the cron to run every 5 minutes: 
php -q /your_whmcs/modules/servers/OvhVpsAndDedicated/cron/cron.php mail:run

Remember to replace 'your_whmcs' with your WHMCS root path.

Activation of Addon

7. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Click 'System Settings' and find 'Addon Modules'.
Afterwards, find 'OVH VPS And Dedicated Servers For WHMCS' and press the 'Activate' button.

OVH 5.png
8. In the next step you need to permit access to this module.

To do so, click on the 'Configure' button, tick the desired admin roles and press 'Save Changes'.

OVH 6.png
9. OVH VPS And Dedicated Servers For WHMCS has been successfully installed!

Access the addon under 'Addons' → 'OVH VPS And Dedicated'.

Configuration of Server

10. Now, we will show you how to configure a new product.

Go to 'System Settings' → 'Servers' and press 'Add New Server' .

OVH 7.png
11. Next, enter your server name and select 'OVH' from the 'Type' field.

Now, provide your:

  • Application Key
  • Application Secret
  • Consumer Key

Then select Location and Country corresponding with the server offered by the administrator and finally, select the OVH Server Type (VPS/Dedicated).
Note: For "So You Start" and "Kimsufi" select 'Dedicated'.
Check the connection when ready and, if it is successful, save the changes.

OVH 8.png
API details are generated depending on the location where you own the OVH account. These might be:

To create an application, please move directly here and create the necessary keys.
In case you encounter any issues with generating your API details, please contact your provider. To learn more about API, please refer to the documentation.

OVH 8 1.png
You may also skip the 'Consumer Key' field in the server configuration (Application Key and Secret must be provided).

After saving the changes, the module will redirect you, in such case, to your provider's page where the key can be generated at once. Please log in and select 'Unlimited' in the key validity field.
The 'Consumer Key ' will be automatically generated and entered in the appropriate field in the server's configuration page in the module.

OVH 8 3.png
12. It is time to create a server group. To do so, click on 'Create New Group'.
OVH 9.png
13. Enter a name, click on your previously created server, press 'Add' and afterward 'Save Changes'.
OVH 9 1.png

Configuration of Product

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

Click on 'Create a New Group'.

OVH 10.png
16. Enter your product group name and press 'Save Changes'.
OVH 11.png
17. Once you have a product group, you can create a new product.

To do so, first click on 'Create a New Product'.

OVH 12.png
18. Afterward, choose your product type, enter your product name and choose the product group from the dropdown menu. Press 'Continue'.
OVH 13.png
19. Now, go to the 'Module Settings' section, choose your previously created server group from the dropdown menu.

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

OVH 14.png
20. Now, you can start configuring the settings of the Server you sell.
Bear in mind that the settings vary, depending on the server type selected.

Underneath we will describe the settings configuration for 'OVH VPS' and 'OVH Dedicated Servers' in details.
Note that settings for 'So You Start' and 'Kimsufi' products are very much alike the 'OVH Dedicated Servers' once, so you may surely base on them while configuring these products.

OVH VPS configuration settings:

  • Solution Type - choose from the available the one that will suit your needs the most
  • Operating System - choose the OS, it can still be reinstalled at any time if such an option is enabled for clients
    • GNU/Linux
    • Windows (Cloud/Cloud RAM only)
  • License - you can select a license from the available ones
  • Data Center Location - choose where the server shall be located on the OVH data center
  • Payment Frequency - define the frequency of payments
  • Prevent System Reinstall - enable if you want to block the OS reinstallation during the upgrade process
  • Snapshot - decide if clients should be allowed to capture an image of the server at a given time.
OVH 15.png
OVH Dedicated Server configuration settings:
  • Operation System Template - choose a template of an operation system to install
  • Operating System Language - choose the language of an installed operation system
  • Plan - check out the powerful line-up of dedicated servers and select the preferred solution
  • Disks - customise your server by selecting one of the available disks
  • Distribution License - choose the distribution license
  • Application License - choose the application license
  • Contract Duration - define the duration of the contract
  • Memory - define the memory of your dedicated server
  • vRack - choose up to 40 Gbps, on certain models, for increased speed
  • Public Network - choose the preferred public network traffic
  • Data Center Location - define where a server will be located on the OVH data center
  • Payment Frequency - define the frequency of payments
OVH 16.png
21. Afterward, set up incoming mail configuration.

Due to API limitations, all emails with server credentials can only be sent to your OVH / Kimsufi / So You Start email address set in the panel.
This applies to messages with credentials sent after creating the server as well as messages sent after reinstallation.
The solution to this problem is email piping that will be used to receive messages sent to your OVH mailbox and then forwarded through the templates further to your WHMCS clients.

Note: Even though the module filters the received messages in your mailbox, we recommend that you use a separate mailbox for your main OVH VPS and Dedicated Servers profile account to avoid any issues with non-OVH content.

After setting up the dedicated mailbox, provide its valid credentials below and test whether the connection has been established correctly.

Note: There is available an option to 'Disable Certificate Validation'. Please toggle this option ONLY if you are having trouble with the connection. The certificate validation will be omitted when connecting to an email box.
Note: The 'Mailbox Folder' option allows you to define your mailbox folder for 'Incoming Mail Configuration' which will be used if received emails are set to be automatically filtered and moved to other than the default folder in the inbox.

OVH 17.png
The cron set during the last stage of the module's installation should periodically check that mailbox for OVH messages.
If any new emails are received, they will be then converted to your email template and sent to the corresponding client.
The default email templates for product creation, reinstallation and reboot in rescue mode can be specified below. Take a look at the Tips section - tip no 1, and check the templates' types.
OVH 18.png
22. Automation Settings section includes detailed actions that will be automatically performed by the module in several situations:
  • Action On Service Suspension - decide what to do with the server in situation when the module command: Suspend has been triggered
    • Stop (VPS)
    • Do Nothing (VPS)
    • Do Nothing (Dedicated Server)
    • Reboot To Rescue (Dedicated Server)
    • Terminate (Dedicated Server)
    • Reinstall (Dedicated Server)
  • Auto Pay With Preferred Method - toggle to make payments for orders automatically with a preferred payment method in OVH Panel
  • Auto Assign VPS/Dedicated Server To Reusable On Termination - when terminated, the server will be in fact cleared and added to the queue to be selected as a reusable by other clients
  • Waive Retractation Period - toggle to waive retractation period on OVH orders
OVH 19.png
23. The following section is dedicated to the Client Area Features.

You will find here numerous options that can be enabled and then will be available to your clients in their client area. Please note that some options are available for VPS only, Dedicated Server only and some for both of them:

  • Disks (VPS only) - if enabled, clients are allowed to view disks attached to their servers with specified limits
  • Reinstall - if enabled, clients are allowed to reinstall the server in the client area
  • KVM/IPMI Console - if enabled, clients are allowed to manage their server using KVM console
  • Service Information - decide which records will be visible in the client area. Please remember that if you do not choose anything, all records will be displayed in the client area.
  • Rescue Mode - if enabled, clients are allowed to reboot the server in rescue mode
  • IP Addresses - if enabled, clients are allowed to view IP addresses assigned to the server
  • Update Reverse DNS Paths - if enabled, reverse DNS can be updated in the client area, 'IP Addresses' must be previously enabled to use his option
  • Traffic Statistics Graph (Dedicated Server only) - if enabled, clients are allowed to view traffic graph


Important: Access to KVM/IPMI Console and Traffic Statistics Graph is available for OVH only. "Kimsufi" and "So You Start" brands do not support them.

OVH 20.png
24. At the end of the configuration process, you can decide whether you want to generate configurable options for the product.

Configurable options can be used by your clients to select each Server parameters individually during order placement.
Otherwise, if configurable options are not defined, then the fixed parameters specified in the earlier configuration will be used instead.

OVH 21.png
If you decide to use configurable options, press on the 'Create' button and select which options you want to generate.
Note that the configuration for disabled options will still be taken from the configuration of the main product.
More information about how to use configurable options can be found here or in the official WHMCS documentation.
OVH 22.png

Generating Additional Configurable Option

This section presents how you can manually add 'Solution Type & Operating System & Application' as additional configurable option in order to provide the diversity of your products.
Proceed to 'System Settings' → 'Configurable Options' .
Click on the 'Configurable Options' that were generated previously.
OVH CO1.png
Click 'Add New Configurable Option' as presented below.
OVH CO2.png
Now, you need to provide 'planCodeVpsOsAddon|Solution Type & Operating System & Application' as 'Option Name' and choose 'Dropdown' as 'Option Type' .
The first option has to be '0|None' .
OVH CO3.png
You can add another 'Options' following this scheme: 
 product:OS:license|your name that is displayed to customers

As an example, we will provide 'vps-value-1-2-40:Centos 7 - cPanel:option-cpanel-1|VPS Value 1 vCPU 2 GB RAM 40 GB disk - Centos 7 - cPanel (Option cPanel 1 account)' .

OVH CO4.png
If you wish to diversify your products, set different prices to make your products more competitive on the market.
You can create another options using the following values.
Product OS License
vps-comfort-4-16-160 Archlinux option-cpanel-100
vps-comfort-4-16-320 Centos 7 option-cpanel-200
vps-comfort-4-16-80 Centos 7 - cPanel option-cpanel-30
vps-comfort-4-4-80 Centos 8 option-cpanel-5
vps-comfort-4-8-160 Centos 8 - Plesk option-cpanel-1
vps-comfort-4-8-320 CoreOS Stable option-plesk-webadmin
vps-comfort-4-8-80 Debian 10 option-plesk-webhost
vps-elite-8-16-160 Debian 10 - Plesk option-plesk-webpro
vps-elite-8-16-320 Debian 8 - Docker option-windows
vps-elite-8-16-640 Debian 8 - OpenVPN
vps-elite-8-32-160 Debian 8 - Plesk
vps-elite-8-32-320 Debian 8 - Vestacp
vps-elite-8-32-640 Debian 8 - Virtualmin
vps-elite-8-8-160 Debian 8 - WordPress
vps-elite-8-8-320 Debian 9
vps-elite-8-8-640 Fedora 31
vps-essential-2-4-160 Ubuntu 16.04
vps-essential-2-4-40 Ubuntu 18.04
vps-essential-2-4-80 Ubuntu 19.10
vps-essential-2-8-160 Ubuntu 20.04
vps-essential-2-8-80 Windows Server 2016 Standard (Desktop)
vps-value-1-2-40 Windows Server 2019 Standard (Desktop)
vps-value-1-2-80
vps-value-1-4-40
vps-value-1-4-80
Note: Please remember that the above options can be changed as plans are updated.
You can easily check the currently available options by generating the default configurable options in the 'Module Settings' section.

Configuration of Addon

You have just correctly created and customized a new product.

Go to 'Addons' → 'OVH VPS And Dedicated' in your WHMCS.

OVH 23.png

Servers

'Servers' section contains a list of your configured servers, you may quickly edit them directly from this site, simply press the edit icon.
OVH 24.png
In the next step, press the marked icon to see a list of deployed machines.
OVH 25.png
There you will see all existing machines on this very server. Whether they are used by any client already or not.

Next to the machine name, there are details such as:

  • its state
  • displayed name
  • assigned client (if there is any already)
  • service assigned
  • reusable toggle - for machines that can be used again by other clients without the necessity to terminate it first. If disabled, the machine can be simply terminated when not used.
    If enabled, when the product is created for the next time by the client, this machine will be automatically reinstalled and assigned to this client.

In order to manually assign the machine to a client, simply press the marked on the screen button.

OVH 26.png
Start typing to see a list of clients, then select existing service to assign.
OVH 26 1.png
There is also a possibility to assign reusable products to the machine. These products will be permitted to use this machine.
OVH 28.png

Logs

Go back to 'Logs' section, there you will see a list of all module actions, including errors, notifications etc.
OVH 29.png

Management

Admin Area

OVH VPS & Dedicated Servers For WHMCS allows you to monitor and manage your customer servers from the admin area of your WHMCS system.

This includes supervision of such features like:

  1. Module commands and service actions that enable you to manage server status and features
  2. Service information which provides you with the current status, resources and options set for the server
OVH 30.png
OVH VPS type
  1. Service Monitoring section with current statuses
  2. Created snapshot with a direct option to edit, restore and delete it
  3. List of IP addresses with option to update the reverse DNS path
  4. List of disks with any important details
OVH 31.png
OVH Dedicated Servers type:
  1. List of IP Addresses with option to update the reverse DNS path
  2. Traffic statistics graph
OVH 32.png

Ordering

Owing to configurable options, you are able to offer a product which your clients can tailor according to their needs.
Additionally, you are able to set up pricing for each configurable option, which makes your offer even more competitive.

After the order placement and successful VM creation, the server credentials will be sent to the client's email address according to the set cron execution intervals.

OVH 33.png

Importing Existing VPS

In this section, you can find short instruction on how to connect one of your clients to your already existing VPS in the OVH panel.
Take the following steps to make sure that the process will be carried out properly.

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' .
What is important, do not perform the 'Create' action. The status has to remain as 'Pending' .
More info about placing orders can be found here
2. Proceed to the newly created product's card in your admin area. Find the following empty field:

  • Server Name

The above-mentioned information has to be consistent with the data from your OVH panel. Now, complete this field as presented below.
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.
If you completed the required data, now change the status from 'Pending' to 'Active' and 'Save Changes' .

OVH import.png
3. If the completed data is correct, after refreshing the page, you will see the attached VPS from OVH.
Important! Remember to manually add other missing parameters of the VPS such as domains, IP Addresses, configurable options, etc. so they match the parameters of the attached VPS from the OVH panel.

Client Area

Client area interface of 'OVH VPS & Dedicated Servers' should look like the one on the screen below.
As you can see, the control panel contains useful options required for managing a server.

The module allows your customers to easily power on/off, reboot and reboot in rescue mode, reinstall and access console through pressing the corresponding buttons.
Clients can also view disks, create and restore snapshots, see IP addresses and view current traffic graphs.
Additionally, clients may view the current server parameters, resources as well as the assigned IP addresses.

OVH VPS client area view:

OVH 34.png
OVH Dedicated Server client area view:
OVH 35.png

Service Actions

Access Console

In case of OVH VPS, clients might be granted access to KVM console.

Simply press its icon to open the console window.

OVH 36 1.png
For OVH Dedicate Servers, there is supported IPMI console.

Press the IPMI Access icon and then select type and TTL of the IPMI access to continue to the console.

OVH 36 2.png

Rescue Reboot

This action reboots the server in the rescue mode.

The moment you press the confirm button, new login details are sent in an email template selected in the product configuration (see point 21), with accordance to the cron settings.
Note: The action might last up to a few minutes, please be patient.

OVH 36 3.png

Reinstall

The action when triggered, causes the new login details to be sent in an email template selected in the product configuration (see point 21) and with accordance to the cron settings.

Note: Please be patient as reinstallation process is quite time consuming.

OVH 36 4.png

Service Management

Snapshot (VPS)

Use snapshots to save the current contents of the virtual machine memory.
You may use them later to restore the VM's settings.

Note: Creating a snapshot may take a while, so it will not appear on the list right away.

OVH 37 1.png
Allowed actions on the created snapshot:
  1. Edit the snapshot (description)
  2. Restore the snapshot to reverse the saved contents of the VM settings
  3. Delete the snapshot
  4. Create another snapshot.
    Note: Keep in mind that you must have previously deleted the existing snapshot, as only one snapshot may exist at the time.
OVH 37.png

Disks (VPS)

When you enter this section, you will see a list of assigned disks with any details on them, such as:
  • Type
  • Size
  • Bandwidth limit
  • Free space threshold
  • Status
OVH 36.png

IP Addresses

Under 'IP Addresses' you may see any assigned IP addresses, their version, type, location, MAC address and reverse DNS if specified.

Update the reverse DNS path of an IP address by pressing the marked button.

OVH 39.png
Provide a new reverse DNS for the selected IP address. Press 'Confirm' when ready.
OVH 40.png

Traffic Statistics Graph (Dedicated Servers)

Open this section to see the graph with traffic statistics. You will find there outlined data on errors, packets and traffic downloads as well as uploads.

You may easily adjust the graph's view by changing the time scope of the displayed stats.

Note 1: Some of the mentioned option may not be visible on the graph until soma data are generated. This is applicable to the graph itself as well.
Note 2: "So You Start" and "Kimsufi" brands may not support graphs.

OVH 41.png
Select the time scope:
OVH 41 1.png

Tips

1. List of 'OVH VPs & Dedicated Servers' email templates included in the module:
  • OVH VPS Has Been Created
  • OVH VPS Rescue Reboot
  • OVH VPS Reinstalled
  • OVH Dedicated Reinstalled
  • OVH Dedicated Server Rescue Reboot

In order to view the templates' content and edit it, please move to WHMCS → System Settings → Email Templates.
More detailed information on templates can be found in the official documentation.

2. If you want to block specific OS images which are available for the server reinstallation process, you need to add these OS images to the following file:
yourWHMCS/modules/servers/OvhVpsAndDedicated/app/Config/blockedImages.json

OVH 41 3.png

Update Instructions

Essential guidance through the process of updating the module is offered here.

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. You may encounter problems while configuring the product for the dedicated server type for 'So you Start' or 'Kimsufi' brands.
As a consequence, options such as plan to configure in the module settings can be unachievable.
Please note that this is most probably caused by API problems on the side of these brands.
However, it is still possible to assign the ordered server directly from the panel of these brands to the client's product at WHMCS by providing its 'Server Name' in the ordered service in the admin area.
3. If you encounter error in logs: Error during create for service #name_of_your_service. Message: Your preferred payment method is not valid

Solution: Please log into your OVH panel and set up a default payment method there.

Retrieved from "https://www.docs.modulesgarden.com/index.php?title=OVHcloud_VPS_And_Dedicated_Servers_For_WHMCS&oldid=57063"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community