Revision as of 20:30, 15 September 2021

Supported Features

The following ports should be open for outbound connections from your WHMCS server: 8443

Setting Up a Plesk Server

To set up a Plesk 11 or Plesk 12 server for hosting accounts:

1. Go to Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers.
2. Click Add New Server.
3. Select a module (Plesk).
4. Enter the server's hostname or IP address, username, password, and API token.
5. Set the type to Plesk.
6. Click Test Connection to make sure the details are entered correctly and WHMCS can connect to Plesk.
7. Click Save Changes.
8. On the longer server configuration page that appears, configure the desired settings for your server.

For more information, see Creating Your First Plesk Server.

Setting Up a Plesk Hosting Package

Creating a Hosting Plan

To set up a Plesk hosting package, use the basic instructions in Products and Services, making sure to select Plesk as your module. Then, refer to the steps below.

To configure a service plan:

1. On your Plesk server, create a service plan in Hosting Services > Service Plans.
2. In WHMCS, select the Service Plan Name from the menu that appears.
3. From the Which IP addresses to use? menu, select how you wish Plesk to assign IP addresses when accounts using this product are created.
4. For WordPress® hosting, configure the desired Install WordPress settings.
5. If applicable, enter a Blog Title, WordPress Path, and Admin Password, or click Create Custom Field.
6. Optionally, choose an automatic setup option for new orders.

Reseller Packages

When creating a reseller package, use the settings above with these exceptions:

• On the first page while creating a product, set the Product Type setting to Reseller Account instead of Shared Hosting.
• On your Plesk server, create the service plan in the Reseller Plans tab at Hosting Services > Service Plans.
• In WHMCS, under the Module Settings tab, select both a Service Plan Name and Reseller Plan Name.

Notes

Creating a reseller account will not create a shared hosting space for the reseller's website. Once the account has been created, the reseller can log in to Plesk and set up their own hosting space.

Additional Options

The Plesk module supports multiple ways of adding value to your offerings via configurable options, addons, and dedicated IP addresses.

Configurable Options for Plesk Panel Addons

Plesk Panel Addons

WHMCS Plesk Configurable Options

WHMCS Plesk Bandwidth Configurable Options

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

1. Navigate to Configuration () > System Settings > Configurable Options.
2. Create a configurable option. Use the Plesk Panel-Addon-Name format, replacing Panel-Addon-Name with the exact name that displays in Plesk for that Plesk Panel Addon. For example:
   • In the Plesk Panel Addons image above, one of the configured Panel Addons is Extra Bandwidth, with resources of 5GB or 10GB.
   • In WHMCS in the WHMCS Plesk Configurable Options image above, this is Plesk Extra Bandwidth.
   • In the WHMCS Plesk Bandwidth Configurable Options image above, 10GB Extra Bandwidth and 5GB Extra Bandwidth are set to 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.
3. Select Yes/No or Dropdown as the Option Type for these options.
4. Ensure that the products for these options are selected in Assigned Products.

For more information, see Addons_and_Configurable_Options.

To add configurable options to a product:

1. Navigate to Configuration () > System Settings > Products/Services.
2. Edit the desired product or service.
3. Choose the Configurable Options tab.
4. Select the desired options.

Dedicated IP Address

To create configurable options that provision a dedicated IP address:

1. Navigate to Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services.
2. Choose the Configurable Options tab.
3. Create configurable options named Dedicated IPv4 or Dedicated IPv6, depending on the type of IP addresses that you want to offer.
4. Select Yes/No as the Option Name.
5. Ensure that the products for these options are selected in Assigned Products.

For more information, see Addons_and_Configurable_Options.

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 like the WordPress Toolkit offerings available through both cPanel & WHM and Plesk.

For more information and steps to create an addon, see Product Addons.

Common Problems

The client account is getting setup but the domain is not

This is usually due to the permissions of the domain template exceeding the server resources or containing something unsupported (for example, ColdFusion). Always test whether your domain template works directly in Plesk after setting it up.

I get a blank command error from WHMCS when it tries to setup an account

This can occur if your firewall is blocking connections on port 8443. You need to open it on both the server WHMCS is on and the server WHMCS is connecting to for inbound and outbound connections.

With accounts created on my Plesk server from WHMCS the www. subdomain doesn't work

This happens due to the default DNS settings on a Plesk server and the requirement to check a box when creating an account to enable it.

To avoid that, simply follow the steps below.

1. Log in to Plesk.
2. Click Server.
3. Click DNS Settings.
4. Click Add New Record.
5. Choose CNAME under the record type.
6. Enter www in Enter Domain Name.
7. Enter <domain> in Enter Canonical Name.
8. Click OK to complete the changes.

Page not Found/Timeout/502 Bad Gateway error creating accounts

By default, Plesk performs a forced restart of Apache when an account is created or suspended. This causes WHMCS to lose connection to the server, and, if WHMCS is on the same server, you will also lose connection to WHMCS.

To resolve this, see Plesk's support article.

503 Service Temporarily Unavailable error creating accounts

By default, Plesk performs a forced restart of Apache when an account is created or suspended. This causes WHMCS to lose connection to the server, and, if WHMCS is on the same server, you will also lose connection to WHMCS.

To resolve this, see Plesk's support article.

Unable to create account in Panel. The field 'username' is required.

This means the username under the client's Products/Services tab is empty.

Enter a username, save changes, and try module creation again. Then, ensure that Require Domains is enabled for the product at Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services.

0 - Unable to find appropriate manager for this version of Panel. Plesk should be at least 8.0 version

This is a generic error message that the Plesk module returns. For example, it could indicate a connection error or invalid credentials.

To identify the underlying error that is occurring, check Configuration () > System Logs or, prior to WHMCS 8.0, Utilities > Logs > Module Log. Enable it, reproduce the error, disable it again, and the 'Response column will show the underlying error.

For more information, see Troubleshooting_Module_Problems.

1006 - Permission denied

This indicates that your Plesk login doesn't have the necessary permissions to use the API. You need the server administrator to grant your Plesk reseller account the Ability to use remote API permission.

1013 - Template does not exist

This error message is coming directly from the Plesk API and indicates that the client and domain template names are incorrect or missing. You can correct these in the product's Module Settings tab.

1013 - Error message: Customer with email 'johndoe@example.com' is not found in panel. Please contact your service provider

There are two potential causes of this error message:

Incorrect product type

The product type is set incorrectly in WHMCS (for example, a reseller plan is configured as a shared hosting product in WHMCS).

To resolve this:

1. Log in to WHMCS Admin Area.
2. Navigate to Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services.
3. Set Product Type to Shared Hosting or Reseller Hosting to match the Plesk plan type.
4. Click Save Changes.

Missing data from a table inside Plesk

If the error persists after following the Incorrect product type steps above, see this article.

1014 - Parser error: Request is invalid

This error message indicates there is a field value missing. This is most commonly caused by having no assigned IP addresses in the client or domain template's IP pool.

1014 - Parser error: Cannot parse the XML from the source specified

The Plesk API only supports the characters a-z and 0-9. If the client's profile contains accents or other characters, it will cause account creation to fail. Edit the client's profile to remove these characters.

1018 - Unable to create hosting. IP address does not exist in client's pool

This error indicates that there is an issue with the IP address pool configuration in Plesk. For example, there may not be any available IP addresses or the first IP address may be set as dedicated instead of shared.

1023 - Unable to accept the template: the following limitations are exceeded

This issue occurs when the resources provided by the serivce plan addon were already used by the subscription.

To resolve this:

1. In the subscription for that domain name, remove the referenced addon in Plesk.
2. In WHMCS, go to the product or service's Products/Services tab.
3. Use the "Upgrade/Downgrade" option to create an upgrade order.

2306 - Domain adding was failed. Error: xxxxx template failed: Unable to apply limits

This error message comes direct from the Plesk API. It indicates that the template you are attempting to use exceeds your limits or has a feature your server doesn't support. Create an account with the template inside Plesk to retrieve further details.

Plesk login requires user authentication

This issue can happen when the user has a dynamic IP addresses or an unstable internet connection. Selecting Allow IP changes during one session in Plesk will resolve this.