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

• This module is compatible with Plesk versions 11, 11.5, 12, 12.5, Onyx, and Obsidian.
• You can also use single sign-on with Plesk.

Supported Features #

Adding a Plesk Server #

To set up a Plesk server in WHMCS:

1. Go to Configuration () > System Settings > Servers.
2. Click Add New Server.
3. Select Plesk from the menu.
4. Enter the hostname or IP address.
5. Enter a username and password.
6. Click Test Connection.
7. Enter the desired additional server details.
8. Click Save Changes.
9. If this is the only Plesk server that is currently in WHMCS, click on the name and ensure that it results in an asterisk (*) next to it. This indicates that it is the default to use when any other non-specific configuration doesn’t apply.

Creating a Plesk Product #

You can create a product that provisions accounts on your Plesk server at Configuration () > System Settings > Products/Services.

Domain Templates #

Check to ensure that your domain template functions correctly as soon as you finish setting it up.

Configurable Options #

To create configurable options that attach Plesk’s Panel Addons to your Plesk products:

1. Go to Configuration () > System Settings > Configurable Options.
2. Edit an existing group or create and save a new group.
3. Click Add New Configurable Option.
4. Enter an option name using the Plesk Panel-Addon-Name name format, replacing Panel-Addon-Name with the exact name that displays in Plesk for that Plesk Panel Addon. For example:
   
   For example, in the Plesk Panel Addons list above, one of the configured Panel Addons is Extra Bandwidth, with resources of 5GB or 10GB.
   
   In the Plesk Configurable Options list above, this is Plesk Extra Bandwidth.
   
   In the Plesk Bandwidth Configurable Options list above, 10GB Extra Bandwidth and 5GB Extra Bandwidth ensure that the bandwidth options in Plesk and WHMCS match.
   We recommend that you set the first option to None or a similar value. When you do this, ensure that the Panel Addon uses a value of 0. This gives the user the ability to choose not to have any additional values per option.
5. Select Yes/No or Dropdown for Option Type.
6. Enter the desired options and display order.
7. Click Save Changes.
8. Create each desired additional option.
9. Click Close Window.
10. Select the desired products in the Assigned Products list.
11. Click Save Changes.
12. Go to Configuration () > System Settings > Products/Services.
13. Edit the desired product or service.
14. In the Configurable Options tab, select the desired options.
15. Click Save Changes.

Dedicated IP Address #

To create configurable options that provision a dedicated IP address, use either or both of these exact names when you create configurable options:

• Dedicated IPv4
• Dedicated IPv6

Select Yes/No for Option Type for these options.

Overriding Overage Billing Soft Limits with Configurable Options #

When using configurable options to override the soft limits for overage billing on a Plesk product, you must create a config.ini file in the /modules/servers directory with the following contents:

;WHMCS Plesk Provisioning Module Config File
skip_addon_prefix = true

After you create this file, ensure that you have configured Disk Space and Bandwidth configurable options. This will ensure that the overrides function correctly.

Add-On Features #

In WHMCS 8.2 and later, in addition to WHMCS’s existing product addon functionality (now an Independent Product), you can create an Add-On Feature. These addons let you sell module-specific features that are available through cPanel & WHM and Plesk, like WP Toolkit or, in WHMCS 8.10 and later, Sitejet Builder.

Reseller Packages #

When creating a reseller package, create the service plan on your Plesk server in the Reseller Plans tab at Hosting Services > Service Plans.

When you configure the product in WHMCS, use the following settings:

• In the Details tab, set the Product Type setting to Reseller Account.
• In the Module Settings tab, set the Service Plan Name and Reseller Plan Name settings.

Creating a reseller account will not create a shared hosting space for the reseller’s website. After account creation, the reseller can log in to Plesk and set up their own hosting space.

Metric Billing #

You can bill clients for their use of individual items like databases or bandwidth. You can choose whether to include a certain amount in the base price and only charge for exceeding a certain limit, offer tiered pricing, or charge for every unit of an item.

You can configure metric billing in the Metric Billing tab.

When a client orders this product, WHMCS will track the account’s use of the items that you configured. On the service’s Next Due Date date, the system will record that period’s usage and add the cost to the service’s renewal invoice.

Log in to Plesk #

When you click Log in to Plesk in the Client Area or Admin Area, WHMCS bases its actions on the server hostname if it is available. If it is not, WHMCS uses the IP address.

The use of http and https login links depends on the Secure setting in your server’s configuration.

WHMCS Connect #

This module supports WHMCS Connect. WHMCS Connect allows you and your administrators to quickly and easily access the control panels of all the servers configured in your WHMCS installation that support Single Sign-On, enabling you and your staff to administer and make changes without ever needing to re-authenticate.

Last modified: June 14, 2024