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.

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

Extracted files in your WHMCS directory should look like this:

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

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

These folders are available at:

1. '/your_whmcs/modules/servers/OvhVpsAndDedicated/' and
2. '/your_whmcs/modules/addons/OvhVpsAndDedicated/'

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

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

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

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

Go to 'Setup' → 'Products/Services' → 'Servers' and press 'Add New Server' .

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 server type.
Note: For "So You Start" and "Kimsufi" select 'Dedicated'.
Check the connection when ready and, if it is successful, save the changes.

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

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.

Click on 'Create a New Group'.

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

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

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.

• 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

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 troubles with the connection. The certificate validation will be omitted when connecting to an email box.

• 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

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

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

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.

 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)' .

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

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.

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

3. Service Monitoring section with current statuses
4. Created snapshot with a direct option to edit, restore and delete it
5. List of IP addresses with option to update the reverse DNS path
6. List of disks with any important details

3. List of IP Addresses with option to update the reverse DNS path
4. Traffic statistics graph

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.

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

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:

Simply press its icon to open the console window.

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

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.

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

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

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.
   

• Type
• Size
• Bandwidth limit
• Free space threshold
• Status

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

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 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 → Setup → Email Templates.
More detailed information on templates can be found in the official documentation.

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.

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.