Difference between revisions of "Plesk"

From WHMCS Documentation

Line 1: Line 1:
 
==Supported Features==
 
==Supported Features==
 
{{Provisioning_Module
 
{{Provisioning_Module
| title = Plesk 8
+
| changepackage = Yes
| level = 3
 
| changepw = Yes
 
| clientarealink = Yes
 
| port = 8443}}
 
{{Provisioning_Module
 
| title = Plesk 9
 
| level = 3
 
 
| changepw = Yes
 
| changepw = Yes
 
| usageupdates = Yes
 
| usageupdates = Yes
| clientarealink = Yes
 
| port = 8443}}
 
{{Provisioning_Module
 
| title = Plesk 10/11
 
| level = 3
 
| changepackage = Yes
 
| changepw = Yes
 
 
| clientarealink = Yes
 
| clientarealink = Yes
 
| port = 8443}}
 
| port = 8443}}
Line 23: Line 9:
 
== Setting Up a Plesk Server ==
 
== Setting Up a Plesk Server ==
  
The following steps guide you through the process of setting up a server in WHMCS for Plesk Hosting Accounts.
+
The following steps guide you through the process of setting up a server in WHMCS for Plesk Hosting Accounts in Plesk 8-12.
  
#Begin by going to '''Setup > Servers'''
+
#Begin by going to '''Setup > Products/Services > Servers'''
 
#Click '''Add New Server '''
 
#Click '''Add New Server '''
 
#Enter the server name, IP address, username and password as appropriate
 
#Enter the server name, IP address, username and password as appropriate
#Set the type to '''Plesk8''', '''Plesk9''' or '''Plesk10'''
+
#Set the type to '''Plesk'''
#If using Plesk 8, and you only have CLIENT access for Plesk, choose '''Pleskreseller'''.
 
 
#Custom Port: If you have a non-standard (8443) port for Plesk, you should enter the port number in the Access Hash section of the Server setup
 
#Custom Port: If you have a non-standard (8443) port for Plesk, you should enter the port number in the Access Hash section of the Server setup
#Click Save '''Changes''' to complete the process and add your new server
+
#Click the '''Test Connection''' button to make sure the detials are entered correctly and WHMCS can connect to Plesk
 +
#Once the test connection reports success, click Save '''Changes''' to complete the process and add your new server
  
 
== Setting Up a Plesk Package ==
 
== Setting Up a Plesk Package ==
 +
[[File:plesk12_1.png|thumb|Plesk Module Settings]][[File:plesk12_3.png|thumb|Creating a Hosting Plan]]
 +
To setup a Plesk package, go to '''Setup > Products/Services > Products/Services'''.  From there, you can create the product and configure the general settings and pricing info as normal, then for a shared hosting plan:
 +
# On the Module Settings tab, select "plesk" in the module dropdown field and then for a shared hosting package:
 +
#Create a Service Plan inside Plesk itself (in '''Hosting Services > Service Plans''') and then just enter the Service Plan Name into WHMCS exactly as it appears in Plesk.
 +
#From the '''Which IP addresses to use?''' dropdown select how you wish PLesk to assign IP addresses when acocunts using this product are created.
 +
#And then finally as with all products you have the option of choosing the automatic setup option you want for new orders, be it immediately as soon as the order is placed, as soon as the initial payment has been received (recommended) or waiting until an admin manually reviews & accepts the pending orders
 +
 +
===For a reseller package===
 +
[[File:plesk12_2.png|thumb|Plesk Module Settings]][[File:plesk12_4.png|thumb|Creating a Reseller Plan]]
 +
#Set the settings for the resellers own hosting account as above with one difference, the '''Product Type''' setting must be Reseller Account.
 +
#Create a service plan inside Plesk itself (in '''Hosting Services > Service Plans > Reseller Plans tab''')
 +
#Under the Module Settings tab enter the Service Plan Name and Reseller Plan Name into WHMCS exactly as they appear in Plesk to define the resellers limits & permissions.
 +
 +
 +
 +
 +
  
To setup a package for your Plesk server, go to '''Setup > Products/Services''', proceed to the new product setup and enter the details such as name, product type, pricing, etc... as normal. For a shared hosting account you should select the ''Hosting Account'' product type, for a reseller hosting account you should select the ''Reseller Account'' product type. On the '''Module Settings''' tab you should do the following:
 
  
#Set the Module to Plesk or Pleskreseller matching what you used for the server
 
#For a shared hosting account, enter both the '''Client Template''' and '''Domain Template''' names (Plesk 8 & 9 Only) or the '''Service Plan Name''' (for Plesk 10) - these must be entered exactly as setup inside Plesk where you configure the limits & permissions
 
#For a reseller account, you must enter both the fields described above but also the '''Reseller Template''' name(Plesk 9 Only) or the '''Reseller Plan Name''' (for Plesk 10) to define the resellers limits & permissions.
 
  
 
==Common Problems==
 
==Common Problems==

Revision as of 14:41, 9 July 2014

Supported Features

Supported Features

Create Suspend Unsuspend Terminate
Yes Yes Yes Yes
Change Package Change Password Usage Updates Client Area Link
Yes Yes Yes Yes

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

Setting Up a Plesk Server

The following steps guide you through the process of setting up a server in WHMCS for Plesk Hosting Accounts in Plesk 8-12.

  1. Begin by going to Setup > Products/Services > Servers
  2. Click Add New Server
  3. Enter the server name, IP address, username and password as appropriate
  4. Set the type to Plesk
  5. Custom Port: If you have a non-standard (8443) port for Plesk, you should enter the port number in the Access Hash section of the Server setup
  6. Click the Test Connection button to make sure the detials are entered correctly and WHMCS can connect to Plesk
  7. Once the test connection reports success, click Save Changes to complete the process and add your new server

Setting Up a Plesk Package

Plesk Module Settings
Creating a Hosting Plan

To setup a Plesk package, go to Setup > Products/Services > Products/Services. From there, you can create the product and configure the general settings and pricing info as normal, then for a shared hosting plan:

  1. On the Module Settings tab, select "plesk" in the module dropdown field and then for a shared hosting package:
  2. Create a Service Plan inside Plesk itself (in Hosting Services > Service Plans) and then just enter the Service Plan Name into WHMCS exactly as it appears in Plesk.
  3. From the Which IP addresses to use? dropdown select how you wish PLesk to assign IP addresses when acocunts using this product are created.
  4. And then finally as with all products you have the option of choosing the automatic setup option you want for new orders, be it immediately as soon as the order is placed, as soon as the initial payment has been received (recommended) or waiting until an admin manually reviews & accepts the pending orders

For a reseller package

Plesk Module Settings
Creating a Reseller Plan
  1. Set the settings for the resellers own hosting account as above with one difference, the Product Type setting must be Reseller Account.
  2. Create a service plan inside Plesk itself (in Hosting Services > Service Plans > Reseller Plans tab)
  3. Under the Module Settings tab enter the Service Plan Name and Reseller Plan Name into WHMCS exactly as they appear in Plesk to define the resellers limits & permissions.





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 such as ColdFusion support when the server doesn't support it. You should always test your domain template works directly in Plesk after setting it up if it is a new setup.

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 tick a box when creating an account to enable it. To avoid that, simply follow the steps below.

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

Module Command Error 1005 - Protocol version '1.6.0.0' not supported. Current protocol version is xx

This error means the incorrect Plesk module has been selected. Version 4.3.1 and above includes separate modules for each version of Plesk, so for example if Plesk 8 is running on the server ensure the Plesk 8 module has been selected under Setup > Servers > Edit and Setup > Products/Services > Edit > Module Settings tab.

Module Command Error: 1006 - Permission denied.

This indicates your plesk login doesn't have the necessary permissions to use the API. You need the admin of the server to grant your plesk reseller account permission to use the API - specifically this permission "Ability to use remote XML interface" and that should resolve it

Module Command Error: 1013 - Template does not exist

This error message is coming direct from the Plesk API. When configuring the product, you have to enter the client and domain template names. These are currently incorrect or missing so you will need to correct them in Setup > Products/Services on the Modules Settings tab when editing your product

Module Command Error: 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 IPs in the client or domain templates IP pool.

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

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

Page not Found error creating accounts with Plesk 10

By default Plesk 10 performs a forced restart of apache when an account is created or suspended which causes WHMCS to lose connection to the server, and if your WHMCS is on the same server, you will also lose connection to WHMCS at the same time.

In order to resolve this please refer to the following knowledgebase article for instructions on configuring Plesk 10 to perform a graceful restart instead: http://kb.parallels.com/en/112020

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

This error message comes direct from the Plesk API. It means that the template you are attempting to use exceeds your limits or has a feature your server doesn't support. You should try creating an account with the template inside Plesk itself as then you get more details about the problem.

You entered credentials of the Panel user account that is associated with a billing account...

The full error message reads:

You entered credentials of the Panel user account that is associated with a billing account. For security sake, the system cannot allow you in under the Panel user. Please use your billing account username and password to log in. You can look up your billing account login information in the message emailed to you when your subscription was created.

We have communicated with Plesk in regards to this issue and they have provided us with these points that should be reviewed to resolve this error:

  1. Plesk does not recommend to have Plesk integrated with both CBM and WHMCS
  2. If you have Plesk 11.5 and later - you can easily disable CBM. Log in to Plesk as administrator, go to Tools & Settings > Interface Management > Interface Controls Visibility, check option “Disconnect Customer And Business Manager” and save.
  3. If you have Plesk 11.0 and earlier – you can remove CBM following the instruction here (http://kb.parallels.com/en/9327)

In conclusion, the resolution to this issue is to disable/remove CBM from Plesk in order to resolve the issue in WHMCS at this time.

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin
Lxadmin - Virtualmin Pro - XPanel - HyperVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible