Documentation For CloudLinux partners
License portal (CLN)
You can find the complete documentation for the CloudLinux Network (CLN) here.
CloudLinux WHMCS plugin
Overview
Installation & configuration
Installation and update
Configuration of product
Configuration of add-on
Management
Link via add-on. Optional license
Link products directly
Link via configurable options
Link add-ons directly (for WHMCS 7.2.x and later)
Order
Admin area
Client area
Licenses list
Addon licenses list (for WHMCS 7.2.x and later)
Common problems
Overview
CloudLinux Licenses for WHMCS allows you to automatically provision CloudLinux, Imunify360, and KernelCare licenses along with selected products. You can provision them for free or as a paid add-on to your product. Owing to CloudLinux Licenses add-on, all module commands on your main product are automatically reproduced on the license product.
Admin area functionality
- Create license
- Terminate license
- Suspend/unsuspend license
- Change license IP address
- View license details
Client area functionality
- View License Details
- Change License IP Address
Add-on functionality
- Manage Relations Between Add-on And License Product
- Manage Relations Between Server And License Product
- Automatically Add License Product To Order When Relation Is Triggered
- View Existing Licenses
- Dependencies Between Module Actions - Every Action: Create, Terminate, Suspend Or Unsuspend Called On The Server Product Will Result With The Same Action Performed On The Licensed Products
- Flexible Filtering Of Existing Licenses
Additionally
- Multi-Language Support – Only Provisioning Module
- Supports CloudLinux, KernelCare, and Imunify360 Licenses
- Supports WHMCS V6 and Later
Installation & configuration
In this section we will show you how to set up our products.
Installation and update
Download CloudLinux Licenses For WHMCS:
Production : http://repo.cloudlinux.com/plugins/whmcs-cl-plugin-latest.zip
Beta : http://repo.cloudlinux.com/plugins/whmcs-cl-plugin-beta.zip
Upload archive to your WHMCS root folder and extract it. Files should automatically jump into their places.
Run the following script:
php <whmcs_root>/clDeploy.php --migrate
Configuration of product
- Log into your WHMCS admin area and go to the Setup → Products/Services → Products/Services. Click Create a New Group .
- Fill Product Group Name (product group will be visible under that name in your WHMCS system) and click Save Changes .
- Click Create a New Product . Choose Other from Product Type drop-down menu and previously created product group from Product Group drop-down menu.
- Fill Product Name and click Continue .
- Set up this product as hidden by ticking Hidden checkbox at Details tab. Do not set up pricing for this product. Pricing will be done in another way.
- Go to the Module Settings tab and select CloudLinux Licenses from Module Name drop-down.
- Fill Username and Password with your CloudLinux API access details and select CloudLinux from License Type drop-down.
- Click Save Changes to confirm.
Configuration of add-on
- Go to Setup → Add-on Modules , find CloudLinux Licenses Add-on and click Activate next to it.
- The next step is permitting access to this module. Click Configure , select admin role and confirm by clicking Save Changes .
Fig 1: CloudLinux License For WHMCS provisioning module configuration.
Fig 2: CloudLinux License For WHMCS add-on module main page.
Management
In this section you can find two ways of linking license product with your server product as well as other possibilities of the module.
- Link Via Add-on. Optional License
- Link Products Directly
- Link Via Configurable Options
- Link Add-ons Directly (for WHMCS 7.2.x and later)
- Order
- Admin Area
- Client Area
- Licenses List
- Add-on Licenses List (for WHMCS 7.2.x and later)
Link via add-on. Optional license
In order to allow your client to decide whether he wants to order server with or without a license, we will use Product Add-on. In this way, when the client orders an add-on, the relation will be triggered and the license product will be ordered along with module.
The following steps must be performed to prepare such connection:
- Go to Setup → Products/Services → Products Add-ons and click Add New Add-on .
- Fill add-on name, set up billing cycle and price.
- Then tick Show on Order checkbox, assign add-on to the product and click Save Changes .
 |
 |
 |
| Fig 3: Configuration of product add-on, which will trigger license product adding. |
- Go to Add-ons → CloudLinux Licenses Add-on → Add-on Relations and click Add Relation .
- Select previously created product add-on and license product as shown below and click Add Relation .
Fig 4: Creating relations between product add-on and provisioning module.
Link products directly
If you want to offer server along with the license, perform the following steps.
Note. Please do not set up pricing for license provisioning product. In exchange, you can increase a price for server provisioning product.
- Prepare license provisioning product as described in the Configuration of Product section of this documentation.
- Go to Add-ons → CloudLinux Licenses Add-on → Products Relations and click Add Relation .
- Select server provisioning product from the Main Product drop-down list and license provisioning product from Linked Product With License and click Add Relation .
Fig 5: Creating relations directly between server and license provisioning modules .
Link via configurable options
In order to allow your client to decide whether he wants to order server with or without license we can use Configurable Options ( https://docs.whmcs.com/Addons_and_Configurable_Options)).
Below we will show you what steps to proceed to prepare such connection:
- Configure CloudLinuxLicenses product as described here
- Go to Setup → Products/Services → Configurable Options and click Create a New Group .
- Fill group name and add New Configurable Option , set up billing cycle, price and option type. Then save changes.
- Go to Add-ons → CloudLinux Licenses Add-on → Configurable Options Relations and click Add Relation.
- Choose appropriate configurable option and license product which it is assigned to and click Add Relation.
Note. The plugin doesn’t support “quantity” type of Configurable Options.
Fig 6: Creating relations directly between server and license provisioning modules.
Link add-ons directly
[for WHMCS 7.2.x and later]
WHMCS 7.2 introduces the ability to associate Product Add-ons with Provisioning Modules .
In order to allow your client to decide whether he wants to order server with or without license we will use product add-on. Below we will show you what steps to proceed to prepare such connection.
- Go to Setup → Products/Services → Products Add-ons and click Add New Addon .
- Fill add-on name, set up billing cycle and price. Then tick Show on Order checkbox, assign an add-on to the product.
- Go to Module Settings tab and select CloudLinuxLicenses from Module Name drop-down.
- Fill Username and Password with your CloudLinux API access (API secret key) details and select CloudLinux from LicenseType drop-down.
- Click Save Changes to confirm.
Fig 7: Configuration of product add-on with Provisioning Modules.
Order
The only difference between two ways of setting up relation is the ability to order server without CloudLinux license.
Fig 8: Ordering server with license add-on.
Fig 9: Ordering server linked directly with license product.
Admin area
From the admin area it is possible to command such action as create, terminate, suspend/unsuspend and change IP address. Nonetheless, these actions can be ordered only on the server provisioning module and will be automatically reproduced for the license provisioning product.
Only change IP address feature has to be ordered manually.
You can also view the details of created license.
Fig 10: CloudLinux Licenses For WHMCS Admin Area.
Client area
The clients are also able to view their servers license details. And as well as you, they are able to change IP address of their licenses.
Fig 11: CloudLinux Licenses For WHMCS Client Area.
To change IP address click Change as shown on the screen above. Then specify IP address and click Save.
Fig 12: Changing License IP Address.
Licenses list
You can view the list of all licenses owned by your client at our addon → Licenses List.
You can filter the list of licenses by client name, server provisioning products, license provisioning products and license IP address.
Fig 13: Licenses list.
Add-on licenses list
[for WHMCS 7.2.x and later]
You can view a list of all product add-on with Provisioning Modules licenses owned by your client at our add-on → Licenses List .
Fig 14: Add-on Licenses List.
Common problems
After activating the server provisioning product, license provisioning product bounded to it is still pending.
Reason : License IP address may be already taken.
Solution : Change server IP address.
Note
Currently, only key-based licenses are available for Imunify360. Support of IP-based licenses will be added soon.
