IP Manager For WHMCS
(→IP Pool Details) |
(→Settings) |
||
Line 572: | Line 572: | ||
==Settings== | ==Settings== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"| | + | |style="padding: 10px 0px 15px 15px;"|'''Along with great power comes great responsibilities.'''<br /> |
− | + | IP Manager For WHMCS allows you to define its behaviour, therefore make sure to configure settings. | |
− | + | ||
− | + | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:IPM24_2.png]] |
|} | |} | ||
+ | ===Module Settings=== | ||
{| | {| | ||
− | |style="padding: 0px | + | |style="padding: 10px 0px 15px 15px;"|Below, you can find description of each option.<br /> |
+ | *'''Assigning Process Settings''' | ||
+ | *#For any configuration you provide into this field, '' 'Dedicated IP' '' field will be ommited. | ||
+ | *#If checked, additional IP addresses will be stored into a custom field or '' 'Assigned IPs' '' field. | ||
+ | *#If checked, in case of a server provisioning failure, relation will be saved. | ||
+ | *#Automatically process the IP address, when downgrading the configurable option. | ||
+ | *#Module ignores error message from external server and continue action. | ||
+ | *'''IP Logs Settings''' | ||
+ | *#IP addresses without product or user will not be displayed in '' 'IP Logs' '' page. | ||
+ | *'''Email Reminder Settings''' | ||
+ | *#If you check the checkbox, you will receive an email with notification about IP pools running out of IP addresses. | ||
+ | *#Enables you to define percentage value which exceeding by any IP pool results in a notification being sent. | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:IPM24_3.png]] |
|} | |} | ||
+ | |||
+ | ===IP Addresses Cleaner=== | ||
{| | {| | ||
− | |style="padding: | + | |style="padding: 10px 0px 15px 15px;"|IP Addresses Cleaner allows you to restore/remove IP addresses form WHMCS/IP Manager/both depending on chosen settings.<br /> |
− | + | *'''IP Addresses Cleaner Settings''' | |
− | + | *#IP address will be added to hosting if relation for it exists. | |
− | + | *#IP address' relation will be removed if IP address is not assigned to hosting. | |
+ | *#If IP address does not exist in any IP pool, it will be removed from hosting. | ||
+ | *#Create IP address' relation, if it does not exist. | ||
+ | *#If IP address does not exist in any IP pool, it will be removed from relations. | ||
+ | *#Set IP address as unassigned if its relation does not exist. | ||
+ | Please remember, after making any changes to those settings, press '' 'Update Settings' ''.<br /> | ||
+ | Otherwise, settings will not be saved, and the Cleaner will run using old ones. | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:IPM24_4.png]] |
|} | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 15px 15px;"|IP Addresses Cleaner allows you to automatically find and fix broken IP addresses assignment.<br /> | ||
+ | For example when you manually remove a product with IP addresses assigned, remove an IP pool and so on.<br /> | ||
+ | To start IP Addresses Cleaner, press '' 'Perform Cron Cleanup' ''.<br /> | ||
+ | Actions issued by the cleaner are listed in a popup as shown on the following screen. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 25px;"|[[File:IPM24_5.png]] | ||
+ | |} | ||
+ | |||
==Integration Code== | ==Integration Code== | ||
{| | {| |
Revision as of 18:59, 18 December 2014
Contents
|
About IP Manager For WHMCS
Article update is ongoing on this page, watch out for broken links and unclear descriptions!
We are sorry for the inconvenience caused.
IP Manager For WHMCS allows you to conveniently add and manage IP pools, and automatically assign IP addresses to your servers, products, addons or configurable options. With our module you will be also able to assign an IP pool for a specified client, integrate with 3rd party applications like cPanel, export IP pools or view clear graphs. |
- Admin Area Features:
✔ Create Multiple Configurations For The Multiple Scenarios Of The Assigning |
✔ Create Multiple Relations In One Configuration For Products, Addons, Configurable Options Or Servers |
✔ Assign Pool For Specified Client |
✔ Add Pool In CIDR Notation |
✔ Add Pool By An IP Addresses Range (IPv4 Only) |
✔ Add Pool By An IP Addresses List (IPv4 Only) |
✔ Export IP Pools With The Information Assignment To XML And CSV Format |
✔ View Whole IP List From A Specified Pool |
✔ IPv6 Pools Relying On IP Addresses Range And Assigned IP Addresses (Free IPv6 Addresses Are Not Stored In Database) |
✔ Synchronize IP Addresses Used By Products In WHMCS System With IP Manager |
✔ Filter Data In The IP Addresses List |
✔ Exclude Selected IP Addresses From A Pool During Pool Creation |
✔ Delete Single IP Address Or A Bunch Of IP Addresses From An Existing Pool |
✔ Integrate IP Through Assigning With The 3rd Party Applications: cPanel, cPanel Extended, Plesk and Parallels Cloud Server |
✔ Create New Integration Modules |
✔ Manual Assigning/Unassigning The IP From Pool For Specified Client Service |
✔ Automatic Choosing The First Free IP Address In The Configuration Related Pools |
✔ Automatic Creating Of Pools If Required During The Import Process |
✔ View Information When The Configuration Assigned Pools Has No More Free IP Addresses Inside |
✔ Omit Dedicated IP Fields For Specific Configuration |
✔ Usage Of Selected Custom Field |
✔ Intelligent IP Assigning For Related Configurable Options With The 'Quantity' Type |
✔ Email Reminder When Percentage Usage Of Any Pool Will Be Exceeded |
✔ Configuration Of Integration Method (cPanel & cPanel Extended) |
✔ Clean Graphs That Shows Current Usage Of The IP Pool Grouped By Months |
✔ IP Pool Usage Statistics Presented By Numbers And Progress Bars With Different Colors Dependant On The Usage Of The Pool |
- Client Area Features:
✔ Manage IP Addresses |
✔ Integration With WHMCS Client Area |
- General Info:
✔ Supports IPv4 and IPv6 |
✔ Multi-Language Support (Both Admin Area and Client Area) |
✔ Supports WHMCS V5 and Later |
✔ Supports PHP 5.0 and Later |
Installation
This tutorial will show you how to successfully install and configure IP Manager For WHMCS. We will guide you step by step through the whole installation and configuration process. |
1. Log in to your client area and download IP Manager For WHMCS. |
2. Upload and extract the module into the main WHMCS directory. Files in your WHMCS directory should look like this. |
3. When you install IP Manager for the first time you have to rename 'license_RENAME.php' file. File is located in 'modules/addons/ipmanager2/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' . |
4. In order to configure your license key, you have to edit a previously renamed 'license.php' file. Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → 'My Products' . |
5. Remove all files from 'tempates_c' folder located in your WHMCS root directory. |
6. Now you have to activate the module in your WHMCS system. Log in to your WHMCS admin area and go to 'Setup' → 'Addon Modules' . |
7. In the next step you need to permit the access to the module. Click on 'Configure' button, tick desired admin roles and press 'Save Changes' . |
8. Last step is setting chmod 755 to 'storage' folder. Folder is located in 'you_whmcs/modules/addons/ipmanager2' . |
9. You have just successfully installed IP Manager! You can access your module at 'Addons' → 'IP Manager' . |
Configuration and Management
IP Manager For WHMCS allows you to manage dedicated IP addresses pool, automatically assign it to clients/products/servers/addons/configurable options. IP Manager supports both IPv4 and IPv6. |
IP Pools
To manage any IP pool via IP Manager you have to add it first. They are three ways to do that. You can use CIDR notation, enter IP range or IP addresses list. |
Create IP Pool
In order to add a new IP addresses pool, go to 'IP Pool' → 'Create IP Pool' . |
CIDR Notation
Select 'Classless Inter-Domain Routing (CIDR)' . Select IP version, type first IP from a pool and a netmask (in prefix notation). |
You can exclude any number of IP addresses from the pool. To do so, enter them into 'Excluded IP Addresses:' textbox, one IP address or IP range per line. |
Enter nameservers and gateway address into textboxes as shown on the screen below (This step is optional). Afterwards, confirm the creation of an IP pool through pressing 'Add Pool' button. |
IP Addresses Range
Select 'IP Range' . Type the first and the last IP address of a pool you wish to add. |
You can exclude any number of IP addresses from the pool. To do so, enter them into 'Excluded IP Addresses:' textbox, one IP address or IP range per line. |
Fill out nameservers and gateway address textboxes as shown on the screen below (This step is optional). Afterwards, the confirm creation of a IP pool through pressing 'Add Pool' button. |
List of IP Addresses
Go to 'IP Pools' tab and select 'One or more single IP Addresses' . Type IP addresses you want to add, separated by comma, after typing last IP address press 'Enter' button. |
Show IP Pools
To manage a previously created pools, proceed to 'IP Pool' → 'Show IP Pools' . As you can see on the following scree, you can find here details of each IP pool. |
Additional Information
You can edit IP pools additional information even after creation of a pool. To do so, press on option you want to alter. |
Afterwards, enter new value and press save button as shown on the screen below. |
Custom Fields
IP Manager allows you to specify custom fields per IP pool. To add a new custom field, press 'Create a New Custom Field' . |
Assign To A Client
If you want to assign a pool of IP to specific client, our module makes it available to you. You can achieve that through using auto-complete textbox to find and choose client and pressing 'Save Changes' button. |
IP Pool Details
To view IP pool details press on its address as shown on the following screen. |
In IP pool view you can find information about current assignment of IP addresses from pool and manually manage their assignment. To facilitate the management of addresses we also added records filters. |
Bulk Actions
Our module supports actions on multiple IP addresses. To issue such action, mark involved IP addresses and choose desired action from 'Action For Selected IP Addresses' dropdown menu. |
Additionally, it removes IP addresses from external servers.
|
Custom Fields For IP Addresses
Additionally, you can assign custom field to IP address. Some 3rd party integration submodules may need additional information provided along with IP address (like MAC address) this it place to add them. |
Afterwards, fill 'Custom Field Name' and 'Custom Field Value' fields and press 'Save Changes' . |
IP Assignment Mechanism
It is crucial to understand mechanism of automatic IP addresses assignment. In this section we will clarify it to you. 'IP Quantity' field defines quantity of IP addresses added to ordered product by triggering a specific relation.
Orders listed below will trigger different relations:
|
Automatic IP Assignment
Main reason for creating this module was to automatize the assignment of IP addresses. Here we will show you how to set up configuration for it. In order to start, go to 'Configuration' → 'Create Configuration' . |
Now you have to assign at least one IP pool to configuration. You can do it through pressing 'Assigned Pools' button. |
Next, choose IP pool from a dropdown menu and press 'Add Pool' button. Keep in mind that you can assign multiple pools to a single configuration. |
Advanced Configuration
Lets say, that you want to set multiple IP assignment to specific product or so on, it is available with our module! Here we will show you how to set up multiple IP addresses assignment to configurable option 'Extra IP Addresses' . |
Afterwards, mark checkboxes next to configurable options you want to assign IP addresses to. Enter quantity of IP addresses which will be assigned to each configurable option and press 'Save Changes' . |
Usage Graph
In each configuration you can find graph, which shows the statistics of IP addresses assignment. |
3rd Party Integration
In this tab you can set up 3rd party integration which allows you to manage IP through our module in your WHMCS and synchronize changes on 3rd party servers. Note 1: Some of these integration submodules requires to set up free IP pools (cPanel) or IP addresses (Plesk) on servers. |
Enabling 3rd Party Integration
Activation of all integration modules looks similar, there is only a difference for cPanel and cPanel Extended integration submodules. Start by pressing 'Activate' button next to a module you want to activate. |
Press 'Configure' button and assign configurations to it. Confirm through clicking 'Save Changes' . |
cPanel and cPanel Extended additionally allows you to choose a method of the integration. 1. Creates a DNS zone for each IP address assigned to a product. |
As you can see on the following screen, you can easily check quantity of configurations assigned to each 3rd party integration. |
Integration With Proxmox VPS/Cloud For WHMCS
Integration with Proxmox VPS For WHMCS & Proxmox Cloud For WHMCS are the only integrations which are set up on both IP Manager For WHMCS and integrated module. Due to that, setting up integration consist of 3 steps: |
Integration With SolusVM Extended VPS For WHMCS
Integration with SolusVM Extended VPS For WHMCS is tricky. IP Manager For WHMCS cannot inject the first IP address for the VPS, due to the way SolusVM API works. |
Test Integration Module
This module logs information about IP processing for 'Autorelease' type products. Your order should look similar to the one on the screen below. |
Creation of Integration Submodule
You can create your own integration, all you need is knowledge of PHP programming language. You can do it through using 'Autorelease' submodule file. |
2. Rename copy to your new submodule name. Note: File name has to end with 'Integration', for example 'NewSubmoduleIntegration.php'. |
3. Edit the file, start by entering basic setting.
1. Class name should be the same as the file name. 2. Submodule name visible in IP Manager. 3. Submodule description you wish to display. 4. Place here a module name that you are integrating ( best way is to copy a folder name of the module ). |
4. Now it is time to implement integration part, you will need integrated module documentation for it.
1. Configuration of 3rd party integration submodule. 2. Place code here assigning IP address to module product. 3. You can add code to unassign IP address here. |
4. In order to view a submodule you have just created, log in to your WHMCS and go to 'Addons' → 'IP Manager' → '3rd Party Integration' . |
Export
You can export your IP pools to .csv and .xml files. To export, go to the 'Export' tab, choose IP pool to export and file format. |
Import
In 'Import' tab you can find tools to synchronize IP addresses from your WHMCS as well as import them from a file. Synchronization
There are three available cron commands: |
IP Logs
'Logs' page stores the history of actions ordered on IP addresses. |
Settings
Along with great power comes great responsibilities. IP Manager For WHMCS allows you to define its behaviour, therefore make sure to configure settings. |
Module Settings
Below, you can find description of each option.
|
IP Addresses Cleaner
IP Addresses Cleaner allows you to restore/remove IP addresses form WHMCS/IP Manager/both depending on chosen settings.
Please remember, after making any changes to those settings, press 'Update Settings' . |
IP Addresses Cleaner allows you to automatically find and fix broken IP addresses assignment. For example when you manually remove a product with IP addresses assigned, remove an IP pool and so on. |
Integration Code
Integration described below is not obligatory. Module allows your customers to view IP addresses assigned to their product any order new ones. |
Correctly placed code is presented on the following screen. |
In the client area it should look like on the screen below. |
To allow your customers to buy new IP addresses you need to set up product addon for product and assign the addon to a configuration in IP Manager. |
Client Area
Your client can view and manage his IP addresses owing to IP Manager For WHMCS. To remove an IP address from a product, press 'Unassign' . |
Your client can also order a new IP address. Press 'Order Additional IP Addresses' as shown below. |
As soon the addon became active, new IP addresses will be granted. |
Add IP via Addon
Setting up addon allows your client to add IP address to their product using integration. Go to 'Setup' → 'Products/Services' → 'Product Addons' and press 'Add New Addon' . |
Afterwards, enter addon name, addon description and select applicable products. Set pricing for addon by choosing 'Billing Cycle' and typing price. |
Now, go to 'Addons' → 'IP Manager' and use configuration you created before or create new one. Remember to add previously created addon as a configuration relation. |
Tick checkbox next to addon and enter quantity of IP addresses to add. Afterwards, click 'Save Changes' button. |
If you enabled integration for the client area, your client should be able to order new IP addresses. |
Management of Custom Hooks
Our module allows you to use custom hooks. All you have to do is to create some functions using PHP programming language. Here you can see the possible hooks: before_ip_assign_hook($ip, $serviceid, $relation, $configid) after_ip_assign_hook($ip, $serviceid, $relation, $configid) before_ip_integrating_hook($ip, $service, $server) after_ip_integrating_hook($ip, $service, $server) before_ip_disintegrating_hook($ip, $service, $server) after_ip_disintegrating_hook($ip, $service, $server) |
To find details about hooks read file 'custom_hooks.php' . You can find there hook, information about its time of run, return values and parameters. Logger::factory()->log('Custom hook was triggered'); It should look like on the screen below: |
How To Update
In order to upgrade your module, follow Modules Update article. |
Tips
1. If your client will order a product bonded to two configurations (e.g. by product type and configurable option), IP Manager will add IP addresses from both configurations. |
Common Problems
1. When you have problems with connection, check whether your SELinux or firewall does not block ports. |
2. If you see something like this at 'Addon' → 'IP Manager' , remove content of 'template_c' (except 'index.php' file). |
3. If you export file and it is empty, check your 'Storage' folder chmod, it should be set to 755. Folder is located at 'your_whmcs/modules/addons/ipmanager2' . If you still have that problem, set chmod 777. |