Revision as of 12:55, 19 April 2024

About IP Manager For WHMCS

IP Manager For WHMCS will empower you to add and manage IP subnets, and also automatically assign IP addresses to your servers, products, addons or configurable options.

You will easily assign addresses from a chosen IP pool to specified clients' products, export IP subnets, or even integrate with 3rd party applications like cPanel.
The module will additionally allow you to synchronize IP addresses used by products in your WHMCS with the module's IP subnets.
At the same time, your customers will be invited to manage their IP addresses straight from the WHMCS client area.

Admin Area Features:

✔ Show And Manage Multi-Level IP Subnets With IP Pools In Tree-View

✔ Assign/Unassign/Delete IP Addresses Directly From Products/Services View

✔ Create Multiple Configurations For Multiple Scenarios Of IP Addresses Assignment

✔ Create Multiple Relations In One Configuration For Products, Addons, Configurable Options & Servers

✔ Define IP Addresses Reservation Rules - Reserve IP Addresses For Network, Gateway, Broadcast And More

✔ Define Default Custom Fields For:

✔ IP Subnets

✔ IP Addresses In Chosen Subnets/Pools

✔ Export/Import IP Subnets/Pools - Supports XML And CSV Formats

✔ Omit Dedicated IP Address Fields For Chosen Configuration

✔ Toggle Custom Field Usage Instead Of 'Assigned IP' Field

✔ Synchronize IP Addresses Used By Products In WHMCS With IP Manager

✔ Receive Automatic Email Reminder Sent When Specified Usage Percentage Of Any IP Subnets Has Been Exceeded

✔ Define Configuration Of Integration Method (cPanel & cPanel Extended)

✔ Set Up IP Addresses Cleaner - Ensures That All Assigned IP Addresses Are In Use

✔ View IP Subnets Usage Statistics And Graphs

✔ View Logs

IP Subnet Features:

✔ Add IP Subnet/Pool Using CIDR Notation

✔ Exclude Selected IP Addresses From IP Subnet During Its Creation

✔ View IP Addresses Of Subnets/Pools

✔ Split/Merge IP Subnet

✔ View And Create Child Subnets

✔ Delete Single IP Address From Subnets/Pools

✔ Assign/Unassign IP Addresses To/For Service

✔ Bulk Actions - Assign/Unassign/Delete IP Addresses

✔ Lock IP Subnet To Client Or Clients Service

✔ Create Custom Fields For Subnets/Pools/IP Addresses

✔ Generate Free IP Addresses

✔ Sequentially

✔ Defined Manually

Client Area Features:

✔ View Assigned IP Addresses And Subnets

✔ Unassign IP Addresses

✔ Order Additional IP Addresses

3rd Party Integration Modules:

✔ cPanel

✔ cPanel Extended

✔ DirectAdmin

✔ DirectAdmin Extended

✔ Plesk

✔ Plesk Extended

✔ Proxmox VE VPS

✔ Proxmox VE Cloud VPS

✔ SolusVM Extended VPS

✔ Virtuozzo Hybrid Server

General Info:

✔ Supports IPv4 and IPv6

✔ Supported All Types Of Configurable Options

✔ IP Subnets Rely On IP Addresses Range And Assigned IP Addresses (Free IP Addresses Are Not Stored In Database)

✔ Create New 3rd Party Integration Modules

✔ Multi-Language Support

✔ Supports PHP 8.1 Back To PHP 7.4

✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"

✔ Supports WHMCS V8.9 Back To WHMCS V8.6

✔ Requires ionCube Loader V12 Or Later

✔ Easy Module Upgrade To Open Source Version

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 our client area and download the module.

2. In the downloaded file you might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.

Previous updates of the module may contain two packages dedicated to various PHP versions.

The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.
Note: Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.

Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

4. When you install IP Manager For WHMCS 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'.

5. In order to configure your license key, you have to edit the 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 our client area → 'My Products'.

6. Remove all files from the 'templates_c' folder located in your WHMCS root directory.

7. Now, you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area and go to 'Setup' → 'Addon Modules'.
Afterwards, find 'IP Manager' and press 'Activate' button.

8. 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'.

9. The last step is setting the 'storage' folder rights as recursively writable.

Folder is located in 'you_whmcs/modules/addons/ipmanager2'.

10. You have just successfully installed IP Manager!

You can access your module in 'Addons' → 'IP Manager'. Additionally you can also add Integration Code to allow your customers to view and manage IP addresses assigned to their products.

Configuration and Management

IP Manager For WHMCS allows you to manage dedicated IP addresses' subnets, automatically assign them to clients/products/servers/addons/configurable options.

The module enables clients to manage and order dedicated IP addresses, IPv4 or IPv6.
In this short guide the possibilities of the module will be briefly described.

Subnets

To manage any subnet via IP Manager you have to add it first.

Remember that it is very important to configure any IP reservation rules before you create any subnets. If you add rules later on, they may not work properly!
Read about rules reservation here.

Create Subnet

To begin, add a new IP addresses subnet, press the 'Create New Subnet' button.

Use 'Classless Inter-Domain Routing (CIDR)' notation to add subnets.

First of all, select IP version: IPv4 or IPv6, type the subnet IP address and a correct bitmask.
Correct ranges:

IPv4 - 1 to 32
IPv6 - 1 to 128

Note: The first IP from the subnet should be compatible with CIDR notation.

You can exclude any number of IP addresses from the subnet.

To do so, enter them into 'Excluded IP Addresses:' textarea, one IP address or IP range per line.

If you want to set nameservers and gateway click on 'Toggle Advanced Settings'.

Enter nameservers and gateway address into textboxes as shown on the screen below (this step is optional).
Afterwards, confirm the creation of the subnet through pressing the 'Add Subnet' button.

Available IP Subnets And Child Subnets

Once you have added some IP subnets you can preview some details on them and manage the IP addresses.

As you can see on the following screen, you can find here a list of subnets in a tree view. Press any of added IP subnets to see its details.

Subnet

To view subnet's details press on its address as shown on the following screen.

In the 'Subnet ' field, you can find information about the address, mask, size, nameservers, gateway and many others.

Actions

The most important functions of your IP Manager For WHMCS include some actions that can be done on subnets.

Delete - use it to remove the subnet together with any IP address in it (if there are such already).
Split - select split to divide the subnet into equal subnets according to the chosen mask. Keep in mind that the subnet may already include some assigned IP addresses.
If you split such a subnet, the assigned IPs might be transferred to another subnet.
Merge - use this option if you want to join previously split subnet. Note that you can merge only parallel subnets.

Additionally, you must remember that merge action removes IP addresses from external servers.
Create Child Subnet - this option allows to create subnet within a 'parent' subnet.
Such s child subnet may again be split/merged, have its own child subnets.

Excluded IP Addresses

List of excluded IP addresses. You can remove some addresses from the list or add new ones.

Important! If you have any IP reservation rules set up, then do not include single IP addresses here. This option should be used as an addition if you do not use rules.

Custom Fields

IP Manager allows you to add custom fields per subnet.

To add a new custom field, press 'Create New Custom Field'. Afterwards, fill out the form with a custom field name and value.
Again, this option should be used if you do not specify default custom fields or if you want to add some additional ones. Be careful not to double custom fields here.

Assigned Client/Service

If you wish to assign an IP subnet to a client or specific service, our module makes it available to you.

You can achieve that through using auto-complete textbox to choose the client and/or service. Again, remember to 'Save Changes'.
Notes:
IP addresses will be added to all products ordered by client.
IP addresses will be added to all addons included in products.

Keep in mind that a subnet that is assigned to a client is reserved for this client only.

While IP addresses are assigned to a client, the following aspects are taken into consideration (in this order):

subnets assigned to a hosting
subnets assigned to a client
subnets assigned to configuration.

IP Addresses List

The easiest possible way of creating IP addresses within the created subnet.

Simply select the number of IP addresses you want to create and press the 'Add IP Address' button. New address in the subnet will be generated.

You may also add an IP address manually. To do so, press the 'Add Custom IP' button.

Type in the IP address you wish to be created.

Once the addresses are generated, you can proceed to their assignment.

Use action or mass actions buttons to do so.

Assign Single IP Address

You are now redirected to a page where you can assign this specific IP address to a service by entering a domain or a username,
using 3rd party integration module or custom assignment.

Choose the method you wish to use and save the changes.

As you can see, the IP address is assigned to the previously selected service (related to chosen domain).
You may always unassign this IP from this service and again assign it to another one, delete the IP address, create a custom field for this single address.

Tree View

To clarify, a comfortable tree view of your created subnets and child-subnets is available. Let's take a look at it to summarize the divisions.

You can see here a list of all subnets and child subnets in your IP Manager. Subnets marked in red already have some child subnets created, press any to show the list of child subnets.
Accordingly available actions change.

Any subnet can have child subnets created (with IP reservation rules taken into consideration) and custom fields assigned.

Child subnets, however, can again have their child subnets created, can be split, merged or deleted.

You may also manually exclude some IP addresses from a child subnet, assign clients and services directly to it and finally manage single IP addresses in such subnet.

Settings

Show Settings

Module Settings

Below, you can find description of each option.

Assignment Process Settings
1. For any configuration you provide into this field, the 'Dedicated IP' field will be omitted.
2. If checked, additional IP addresses will be stored in a custom field or 'Assigned IPs' field.
3. If checked, in case of a server provisioning failure, relation will be saved.
4. Automatically process the IP address when downgrading the configurable option.
5. Module ignores error message from an external server and continues the action.
IP Logs Settings
1. IP addresses without products or users will not be displayed in 'IP Logs' page.
IP Reservation Settings
1. If you check this checkbox, you will allow to add IP reservation rules.
Email Reminder Settings
1. If you check this checkbox, you will receive an email with notification about IP subnets running out of IP addresses.
2. Enables you to define percentage value which, when exceeded by any subnet, results in a notification being sent.

IP Addresses Cleaner

IP Addresses Cleaner allows you to restore/remove IP addresses form WHMCS/IP Manager/both depending on chosen settings.

IP Addresses Cleaner Settings
1. IP address are added to hosting if relation exists.
2. IP address' relation are removed if IP address is not assigned to any hosting.
3. If IP address does not exist in any subnet, it is removed from hosting.
4. Create IP address' relation if it does not exist.
5. If IP address does not exist in any subnet, it is removed from relations.
6. Set IP address as unassigned if its relation does not exist.

Important: After making any changes in those settings, press 'Update Settings'.
Otherwise, settings will not be saved and the Cleaner will run using old ones.

Note: Please be aware that 'History' refers to the current "IP Logs" section.

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 or remove an IP subnet.
To start IP Addresses Cleaner, press 'Perform Cron Cleanup' .
Actions issued by the cleaner are listed in a popup as shown on the following screen.

IP Reservation

You can automate the process of IP assignment by adding some rules that will be then executed while assigning IP addresses from a subnet to clients or services.

'IP Reservation' rules can be configured under the 'Settings' section.

Use the rules consciously because they will be then taken into consideration while assigning any IP from any subnet in your IP Manager.

As it is stated in the guide visible on the screen, you need to stick to some standards while personalizing your assignment process.
Press 'Add New Rule'.

New Rules

To add a new rule, type in the required value in the 'Rule' field and describe it in the text box nearby.

To illustrate:
Enter n in the 'Rule' textarea. Then the first IP address from a subnet will be always excluded. It will be reserved and it will not be assigned to any client or service.

You can add more that one rule. If you do it thoughtfully, you will have much less work later on while creating new subnets because
customized rules will substitute the need to fill out the 'Excluded IP Addresses' area.

Default Custom Fields - Subnets

In this section ('Settings' → 'Default Custom Fields - Subnets') you are allowed to add and configure some custom fields that will be assigned to subnets by default.

All you need to do is enter the name of your custom field, its value and save changes.

Surely, you can create plenty of such custom fields and edit/remove the already existing.

Default Custom Fields - IPs

Section 'Default Custom Fields - IPs' allows adding default custom fields per IP address within the selected subnet.
Press 'Add New Default Field' to begin.

Select subnet, the single IP addresses in which you wish to have the field assigned. You may point single subnet or select all existing subnets.
Then, type in the custom field name and value.

You can create plenty of such custom fields and then edit/remove the already existing ones.
Keep in mind that if a custom field is assigned to all subnets, then action conducted on a custom field in a single subnet is triggered on all the other subnets!

IP Assignment Mechanism

It is crucial to understand mechanism of automatic IP addresses assignment. In this section we will clarify it for you.

'IP Quantity' field defines the quantity of IP addresses added to the ordered product by triggering a specific relation.
Two and more relations from one configuration can be triggered for the same product (therefore, multiple quantity of IP addresses can be assigned).
Additionally, if you set up two configurations with the same relation, IP addresses from both configurations will be added.
Therefore, if you set up these two configurations in IP Manager:

Configuration 1: Addon A (IP Quantity = 2), Product C (IP Quantity = 1)
Configuration 2: Addon A (IP Quantity = 2), Addon B (IP Quantity = 2), Product D (IP Quantity = 3)

Orders listed below will trigger different relations:

Order 1: Product C with addon A: 5 IP addresses assigned
Order 2: Product C with addon B: 3 IP addresses assigned
Order 3: Product D with addon A: 7 IP addresses assigned
Order 4: Product F with addon A: 4 IP addresses assigned

Automatic IP Assignment

The main reason, why this module has been created, was to automate IP addresses assignment.

Here we will show you how to set up its configuration. In order to start, go to 'Configuration' → 'Create Configuration'.
Type your configuration name, press textboxes corresponding to options you wish to add and select them from dropdown menus:

Products
Addons
Servers
Config Options

Afterwards, press the 'Create New Configuration' button. On the screen below you can see sample configuration with two products selected.

Now you have to assign at least one subnet to configuration. Use the 'Assigned Subnets' button.

Choose a subnet from a dropdown menu and press the 'Assign Subnet' button.

Keep in mind that you can assign multiple subnets to a single configuration.

See the list of subnets assigned to your configuration.

Press Subnet address to see its details
Manage additional Information: nameservers, gateway
Check usage
Remove subnet from the list

On pressing subnet address you will be moved to its details where you can manage it.

Advanced Configuration

Let's say, that you want to set multiple IP assignment to specific product, 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'.
Create a new configuration as while setting up a standard configuration.
Once it is done press 'Configurable Options' as shown on the screen below.

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 Statistics

In each configuration you can find a 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 require free IP subnets (cPanel) or IP addresses (Plesk) on servers to be set up.
Note 2: IP Manager can integrate multiple IP addresses with a single product.

Enabling 3rd Party Integration

Activation of all integration modules looks similar, there is only a difference in cPanel and cPanel Extended integration submodules.

Start by pressing the 'Activate' button next to the module you want to activate.

Press the 'Configure' button and assign configurations to it.

Confirm through clicking 'Save Changes'.

cPanel and cPanel Extended additionally allow you to choose the method of the integration.

Creates a DNS zone for each IP address assigned to a product.
The first IP address assigned to a product is set up as a site dedicated IP address.

As you can see on the following screen, you can easily check the quantity of configurations assigned to each 3rd party integration.

Integration With Proxmox VE VPS/Cloud VPS For WHMCS

Integration with Proxmox VE VPS For WHMCS and Proxmox VE Cloud VPS For WHMCS is the only one to be set up both on the side of IP Manager For WHMCS and the integrated module.

Note: This integration works for LXC and KVM virtualization types.

The process of establishing the integration for Proxmox VE VPS For WHMCS module consists of 4 steps:
1. Create the subnet of IP addresses that will be used for a product.
2. Create the configuration and assign a previously created subnet to it. No additional action is required after this step.
Important: Assigning anything other than the subnet to the configuration in IP Manager For WHMCS may bring unexpected results in your WHMCS environment.
3. When Proxmox starts creating a virtual machine, it retrieves the assigned IP address to the service and assigns it directly to the VM.

In the case of Proxmox VE Cloud VPS For WHMCS module, the IP addresses assigned to the service will be assigned to VMs in the order they were created on the server,
i.e. the first VM to retrieve the IP addresses is the one whose creation process ends first.

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 to VPS, due to the way SolusVM API works.
After creation of VPS, IP Manager is able to add additional IP addresses.
Therefore, if you use this integration, we advise setting up IP Manager synchronization as a cron job.

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.
Note: You need to set up 'Autorelease' type server, otherwise logs will not show up.

Creation of Integration Submodule

You can create your own integration, all you need is knowledge of the PHP programming language.

You can do it through using 'Autorelease' submodule file.
1. To start, make a copy of 'AutoreleaseIntegration.php' located in 'your_whmcs/modules/addons/ipmanager2/app/modules'.

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 settings.

1. Class name should be the same as the file name.
2. Submodule name visible in IP Manager.
3. Submodule description displayed in IP Manager.
4. Place here an integrating module name ( the best way is to copy a folder name of the module ).

4. Now, it is time to implement an integration part, you will need integrated module documentation to do it.

1. Configuration of 3rd party integration submodule.
2. Code assigning IP address to module product goes here.
3. You can add a 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 subnets with IP addresses to CSV and XML files.

To export, go to the 'Export' tab, choose subnet to export and output format.
Now you can 'Generate' the file. File downloading will start shortly.
Note: Your 'storage' folder located in 'your_whmcs/modules/addons/ipmanager2' should have chmod set to 755.

Import

In the 'Import' tab you can find tools to synchronize IP addresses from your WHMCS as well as import them from a file.

Synchronization
Synchronization will confirm relations in your system with relations in IP Manager subnets.

IP address is used by a product, but inside of IP Manager subnet it is marked as unassigned - record inside of a subnet will be updated.
IP address is used by a product, but does not exist in any IP Manager subnet - a new subnet will be created.

There are three available cron commands:
1. This cron command synchronizes all products (it will require confirmation).
2. This cron command synchronizes all products (it will not require any confirmation).
3. This cron command synchronizes only products which IDs have been provided as arguments separated by comma.
Import
To import IP addresses from a file, select it, choose its format and press 'Import'.

IP Logs

The 'Logs' page stores the history of actions ordered on each of IP addresses.

Integration Code

Integration described below is not obligatory.

Module allows your customers to view IP addresses assigned to their product and order additional ones.
To enable it, follow these simple steps:

Integration in WHMCS

Important! In this section, you will find the exemplary integration for the WHMCS 'Six' and 'Twenty-One' themes.

Please remember that the following code line numbers, as well as code fragments, may differ between distinct versions of WHMCS.
You have to make sure by yourself that the integration best suits your WHMCS theme and version.
The picture below is based on the WHMCS 'Six' theme.

After the integration for the WHMCS 'Six' theme, the client area section should look like here:

The integration for the WHMCS 'Twenty-One' theme is presented here:

After the integration for the WHMCS 'Twenty-One' theme, the client area section should look like here:

The above described integration works for all products without exception.
However, in case you wish to restrict the integration to limited number of products, please insert the below codes instead of the one suggested in the addon.


{if $moduleclientarea}
  <div class="moduleoutput">;{$moduleclientarea|replace:'modulebutton':'btn'}
  {if $pid == 26 || $module ==  'yourModuleName_1' || $module == 'yourModuleName_2'}
       {$IPM2_anager_integration}
  {/if}
  </div>
{/if}

Once such code is inserted in the template, IP Manager will be displayed for product with ID that equals 26 or if the product is based on 'yourModuleName_1/ yourModuleName_2' modules.
Extend the IP Manager integration according to your needs. The above code is just an example which can undergo modifications.

Admin Area

In the 'Products/Services' tab located in your client's profile view in the admin area you can manually assign and unassign IP addresses from the chosen products.

To start, select one of the products ordered by your client and press 'Manage IP Addresses' next to the 'Dedicated IP' field.

A new window will pop up, allowing you to manage the assignment of IP addresses.

Select one of your IP pools from the 'Tree View' . In the window to the right you can select IP addresses from the chosen pool and assign them to your client's product.
Please note that only free and not assigned yet IP addresses will be available for selection from the dropdown menu.

If any other IP addresses are already assigned to that product, you can replace them by toggling 'Override Already Assigned IP Addresses' .
Otherwise, the newly selected IP addresses will be added to those already assigned.

Additionally, toggle the 'Use submodule' option if you want the 3rd party integration to be used. Please note however, that this option requires the current list of assigned IP addresses to be overwritten.
This is to ensure that the synchronization works properly. If you decide to leave this option disabled, the new added IP addresses will be assigned only in WHMCS itself.

The third window in the bottom right corner allows you to manage the list of 'Already Assigned IP Addresses' .

You can also preview there if any of the assigned IP addresses is also assigned using the 3rd party submodule integration.
Additionally, you can ' Unassign' any IP address from WHMCS, but it will not unassign this address automatically from the submodule. After its removal it will also return to the IP subnet pool.
If you want to unassign an IP address from both WHMCS and 3rd party integration submodule, press the 'Unassign In Submodule' button which appears only for IP addresses already assigned in the submodules.
Note: If you need a bit more advanced management of a single assignment of IP addresses, go to the 'Subnets' section of the IP Manager addon.

Client Area

Your clients can view and manage their IP addresses and subnets thanks to installed IP Manager For WHMCS module.

To remove any IP address or subnet from a product, simply press the 'Unassign' button.

Your client can also order a new IP address.

Press 'Order Additional IP Addresses' as shown below.
Your client will be moved to order form containing previously configured addons.

As soon as the addon is active, new IP address is granted.

Add IP via Addon

Setting up an addon allows your client to add an 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.
Confirm through pressing the 'Save Changes' button.

Now, go to 'Addons' → 'IP Manager' and use configuration created before or create a new one.

Remember to add the previously created addon as a configuration relation.
You can do it by pressing the 'Addon' button as shown on the following screen.

Tick checkbox next to addon and enter the quantity of IP addresses to be added.

Afterwards, click the '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 create some functions using PHP programming language.

Here you can see 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 'custom_hooks.php' file.

You can find there all hooks, information about their time of run, returned values and parameters.
For example, if you want to throw message to activity log after IP address assignment find hook 'after_ip_assign_hook($ip, $serviceid, $relation, $configid)' and type:

Logger::factory()->log('Custom hook was triggered');

It should look like on the screen below:

Tips

1. If your client orders a product that is combined with two configurations (e.g. by product type and configurable option), IP Manager will add IP addresses from both configurations.

2. If you have used IPv6 block before the update to IP Manager 2.2.0, all of them will be migrated to corresponding subnets. Note that migration is done automatically for you.

3. IP Manager For WHMCS requires GMP or BCMath installed on your server.

4. If API returns the error 'Unknown network interface' when adding a new IP address for Plesk 12 Integration, then you need to modify the file new_configuration.json located in your_whmcs/modules/addons/ipmanager2/app/modules/api/Plesk/.

Firstly, change the name of the mentioned file from new_configuration.json to configuration.json. Next, open the file and provide the proper name for the interface.
To make sure that you provided the appropriate interface name, log in to your Plesk panel, proceed to the 'Tools & Settings -> IP Addresses' section, and check the interface name.

5. The module supports the "Lagom WHMCS Client Theme", if you want to use this theme in your client area you will have to insert a proper integration code in the dedicated template files.
To easily copy the integration code, proceed to your addon → Integration Code section, and follow the described steps.

Update Instructions

An essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your IP Manager For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

Common Problems

1. In case of connection problems, please check whether your SELinux or firewall does not block ports.

2. If you see something like this when moving to 'Addon' → 'IP Manager', remove a content of the 'template_c' folder.

3. If you export a file and it is empty, check your 'Storage' folder chmod, it should be set to 755. Folder is located in 'your_whmcs/modules/addons/ipmanager2' .

If you still have that problem, set chmod 777.

4. For integration with SolusVM Extended For WHMCS, one additional IP address is always assigned to the Solus virtual machine through the IP Manager For WHMCS module, exceeding the quantity specified in the SolusVM product configuration.

@@ Line 2: / Line 2: @@
 <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The IP Manager For WHMCS Module."></meta>
-=About [http://www.modulesgarden.com/products/whmcs/ip_manager/features IP Manager For WHMCS]=
+=About [https://www.modulesgarden.com/products/whmcs/ip-manager IP Manager For WHMCS]=
-<h4 style="color: #ff0000; font-weight:bold; text-align:center;">Article update is ongoing on this page, watch out for broken links and unclear descriptions!<br />
-We are sorry for the inconvenience caused.</h4>
 {|
-|style="padding: 10px 0px 5px 0px;"|'''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.<br />
+|style="padding: 10px 0px 5px 0px;"|'''IP Manager For WHMCS''' will empower you to add and manage IP subnets, and also automatically assign IP addresses to your servers, products, addons or configurable options.<br />
-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.<br />
+You will easily assign addresses from a chosen IP pool to specified clients' products, export IP subnets, or even integrate with 3rd party applications like cPanel.<br />
-You will also be able to synchronize IP addresses used by products in your WHMCS system with IP Manager IP pools.<br />
+The module will additionally allow you to synchronize IP addresses used by products in your WHMCS with the module's IP subnets.<br />
-What is more, IP Manager For WHMCS will allow your customers to easily manage their IP addresses from the WHMCS client area.
+At the same time, your customers will be invited to manage their IP addresses straight from the WHMCS client area.
 |}
 <!--a comment maybe? -->
 *'''Admin Area Features:'''
 {|
-|style="padding: 10px 0px 0px 30px;"|✔ Create Multiple Configurations For The Multiple Scenarios Of The Assigning
+|style="padding: 10px 0px 0px 30px;"|✔ Show And Manage Multi-Level IP Subnets With IP Pools In Tree-View
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Create Multiple Relations In One Configuration For Products, Addons, Configurable Options Or Servers
+|style="padding: 0px 0px 0px 30px;"|✔ Assign/Unassign/Delete IP Addresses Directly From Products/Services View
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Assign Pool For Specified Client
+|style="padding: 0px 0px 0px 30px;"|✔ Create Multiple Configurations For Multiple Scenarios Of IP Addresses Assignment
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Add Pool In CIDR Notation
+|style="padding: 0px 0px 0px 30px;"|✔ Create Multiple Relations In One Configuration For Products, Addons, Configurable Options & Servers
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Add Pool By An IP Addresses Range (IPv4 Only)
+|style="padding: 0px 0px 0px 30px;"|✔ Define IP Addresses Reservation Rules - Reserve IP Addresses For Network, Gateway, Broadcast And More
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Add Pool By An IP Addresses List (IPv4 Only)
+|style="padding: 0px 0px 0px 30px;"|✔ Define Default Custom Fields For:
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Export IP Pools With The Information Assignment To XML And CSV Format
+|style="padding: 0px 0px 0px 45px;"|✔ IP Subnets
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ View Whole IP List From A Specified Pool
+|style="padding: 0px 0px 0px 45px;"|✔ IP Addresses In Chosen Subnets/Pools
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ IPv6 Pools Relying On IP Addresses Range And Assigned IP Addresses (Free IPv6 Addresses Are Not Stored In Database)
+|style="padding: 0px 0px 0px 30px;"|✔ Export/Import IP Subnets/Pools - Supports XML And CSV Formats
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Synchronize IP Addresses Used By Products In WHMCS System With IP Manager
+|style="padding: 0px 0px 0px 30px;"|✔ Omit Dedicated IP Address Fields For Chosen Configuration
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Filter Data In The IP Addresses List
+|style="padding: 0px 0px 0px 30px;"|✔ Toggle Custom Field Usage Instead Of 'Assigned IP' Field
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Exclude Selected IP Addresses From A Pool During Pool Creation
+|style="padding: 0px 0px 0px 30px;"|✔ Synchronize IP Addresses Used By Products In WHMCS With IP Manager
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Delete Single IP Address Or A Bunch Of IP Addresses From An Existing Pool
+|style="padding: 0px 0px 0px 30px;"|✔ Receive Automatic Email Reminder Sent When Specified Usage Percentage Of Any IP Subnets Has Been Exceeded
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Integrate IP Through Assigning With The 3rd Party Applications: cPanel, [http://www.modulesgarden.com/products/whmcs/cpanel_extended/features cPanel Extended], Plesk and Parallels Cloud Server
+|style="padding: 0px 0px 0px 30px;"|✔ Define Configuration Of Integration Method (cPanel & cPanel Extended)
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Create New Integration Modules
+|style="padding: 0px 0px 0px 30px;"|✔ Set Up IP Addresses Cleaner - Ensures That All Assigned IP Addresses Are In Use
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Manual Assigning/Unassigning The IP From Pool For Specified Client Service
+|style="padding: 0px 0px 0px 30px;"|✔ View IP Subnets Usage Statistics And Graphs
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Automatic Choosing The First Free IP Address In The Configuration Related Pools
+|style="padding: 0px 0px 10px 30px;"|✔ View Logs
 |}
+*'''IP Subnet Features:'''
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Automatic Creating Of Pools If Required During The Import Process
+|style="padding: 10px 0px 0px 30px;"|✔ Add IP Subnet/Pool Using CIDR Notation
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ View Information When The Configuration Assigned Pools Has No More Free IP Addresses Inside
+|style="padding: 0px 0px 0px 30px;"|✔ Exclude Selected IP Addresses From IP Subnet During Its Creation
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Omit Dedicated IP Fields For Specific Configuration
+|style="padding: 0px 0px 0px 30px;"|✔ View IP Addresses Of Subnets/Pools
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Usage Of Selected Custom Field
+|style="padding: 0px 0px 0px 30px;"|✔ Split/Merge IP Subnet
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Intelligent IP Assigning For Related Configurable Options With The 'Quantity' Type
+|style="padding: 0px 0px 0px 30px;"|✔ View And Create Child Subnets
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Email Reminder When Percentage Usage Of Any Pool Will Be Exceeded
+|style="padding: 0px 0px 0px 30px;"|✔ Delete Single IP Address From Subnets/Pools
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Configuration Of Integration Method (cPanel & cPanel Extended)
+|style="padding: 0px 0px 0px 30px;"|✔ Assign/Unassign IP Addresses To/For Service
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Clean Graphs That Shows Current Usage Of The IP Pool Grouped By Months
+|style="padding: 0px 0px 0px 30px;"|✔ Bulk Actions - Assign/Unassign/Delete IP Addresses
 |}
 {|
-|style="padding: 0px 0px 10px 30px;"|✔ IP Pool Usage Statistics Presented By Numbers And Progress Bars With Different Colors Dependant On The Usage Of The Pool
+|style="padding: 0px 0px 0px 30px;"|✔ Lock IP Subnet To Client Or Clients Service
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ Create Custom Fields For Subnets/Pools/IP Addresses
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ Generate Free IP Addresses
+|}
+{|
+|style="padding: 0px 0px 0px 45px;"|✔ Sequentially
+|}
+{|
+|style="padding: 0px 0px 10px 45px;"|✔ Defined Manually
 |}
 *'''Client Area Features:'''
 {|
-|style="padding: 10px 0px 0px 30px;"|✔ Manage IP Addresses
+|style="padding: 10px 0px 0px 30px;"|✔ View Assigned IP Addresses And Subnets
 |}
 {|
-|style="padding: 0px 0px 10px 30px;"|✔ Integration With WHMCS Client Area
+|style="padding: 0px 0px 0px 30px;"|✔ Unassign IP Addresses
+|}
+{|
+|style="padding: 0px 0px 10px 30px;"|✔ Order Additional IP Addresses
+|}
+*'''3rd Party Integration Modules:'''
+{|
+|style="padding: 10px 0px 0px 30px;"|✔ cPanel
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ [https://www.modulesgarden.com/products/whmcs/cpanel-extended cPanel Extended]
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ DirectAdmin
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ [https://www.modulesgarden.com/products/whmcs/directadmin-extended DirectAdmin Extended]
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ Plesk
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ [https://www.modulesgarden.com/products/whmcs/plesk-extended Plesk Extended]
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ [https://www.modulesgarden.com/products/whmcs/proxmox-vps Proxmox VE VPS]
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ [https://www.modulesgarden.com/products/whmcs/proxmox-cloud-vps Proxmox VE Cloud VPS]
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ [https://www.modulesgarden.com/products/whmcs/solusvm-extended-vps SolusVM Extended VPS]
+|}
+{|
+|style="padding: 0px 0px 10px 30px;"|✔ [https://www.modulesgarden.com/products/whmcs/virtuozzo-hybrid-server Virtuozzo Hybrid Server]
 |}
 *'''General Info:'''
@@ Line 103: / Line 149: @@
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support (Both Admin Area and Client Area)
+|style="padding: 0px 0px 0px 30px;"|✔ Supported All Types Of Configurable Options
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V5 and Later
+|style="padding: 0px 0px 0px 30px;"|✔ IP Subnets Rely On IP Addresses Range And Assigned IP Addresses (Free IP Addresses Are Not Stored In Database)
 |}
 {|
-|style="padding: 0px 0px 30px 30px;"|✔ Supports PHP 5.0 and Later
+|style="padding: 0px 0px 0px 30px;"|✔ Create New 3rd Party Integration Modules
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.9 Back To WHMCS V8.6
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
+|}
+{|
+|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/ip-manager#open-source-version Open Source Version]
 |}
 =Installation=
 {|
-|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure IP Manager For WHMCS.''' <br />
+|style="padding: 10px 0px 15px 15px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/ip-manager IP Manager For WHMCS.]''' <br />
-We will guide you step by step through the whole installation and configuration process. <br />
+We will guide you step by step through the whole installation and configuration process.
 |}
 {|
-|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download IP Manager For WHMCS.'''
+|style="padding: 0px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 |}
 {|
@@ Line 124: / Line 188: @@
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
+|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
-Files in your WHMCS directory should look like this.
+In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.<br/> <!-- If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. -->
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:PHP72_74.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
+The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.<br/>
+'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].''
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_74.png]]
+|}
+{|
+|style="padding: 0px 0px 10px 15px;"|<!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/ip-manager#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' --> '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|'''Extract the package and upload its content into the main WHMCS directory.
+The content of the package to upload should look like this.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM2.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:gvhgy.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|'''3. When you install IP Manager for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+|style="padding: 0px 0px 15px 15px;"|'''4. When you install IP Manager For WHMCS for the first time, you have to rename '' 'license_RENAME.php' '' file.'''<br />
-File is located in '' 'modules/addons/ipmanager2/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
+File is located in '' 'modules/addons/ipmanager2/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 |}
 {|
@@ Line 138: / Line 220: @@
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
+|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
-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' ''.
+Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area'' → 'My Products'. ''
 |}
 {|
@@ Line 145: / Line 227: @@
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"|'''5. Remove all files from '' 'tempates_c' '' folder located in your WHMCS root directory.'''
+|style="padding: 0px 0px 20px 15px;"|'''6. Remove all files from the '' 'templates_c' '' folder located in your WHMCS root directory.'''
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
+|style="padding: 0px 0px 15px 15px;"|'''7. Now, you have to activate the module in your WHMCS system.'''<br />
-Log in to your WHMCS admin area and go to '' 'Setup' '' → '' 'Addon Modules' ''.<br />
+Log in to your WHMCS admin area and go to '' 'Setup' '' → '' 'Addon Modules'. ''<br />
 Afterwards, find '' 'IP Manager' '' and press '' 'Activate' '' button.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM5.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_5.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit the access to the module.'''<br />
+|style="padding: 0px 0px 15px 15px;"|'''8. In the next step you need to permit the access to the module.'''<br />
-Click on '' 'Configure' '' button, tick desired admin roles and press '' 'Save Changes' ''.
+Click on '' 'Configure' '' button, tick desired admin roles and press '' 'Save Changes'. ''
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM6.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_6.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|'''8. Last step is setting chmod 755 to '' 'storage' '' folder.'''<br />
+|style="padding: 0px 0px 15px 15px;"|'''9. The last step is setting the '' 'storage' '' folder rights as recursively writable.'''<br />
-Folder is located in '' 'you_whmcs/modules/addons/ipmanager2' ''.
+Folder is located in '' 'you_whmcs/modules/addons/ipmanager2'. ''
 |}
 {|
@@ Line 170: / Line 252: @@
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|'''9. You have just successfully installed IP Manager!'''<br />
+|style="padding: 0px 0px 15px 15px;"|'''10. You have just successfully installed IP Manager!'''<br />
-You can access your module at '' 'Addons' '' → '' 'IP Manager' ''.
+You can access your module in '' 'Addons' '' → '' 'IP Manager'. '' Additionally you can also add [[#Integration Code|Integration Code]] to allow your customers to view and manage IP addresses assigned to their products.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM7.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_7.png]]
 |}
 =Configuration and Management=
 {|
-|style="padding: 10px 0px 30px 15px;"|'''IP Manager For WHMCS allows you to manage dedicated IP addresses pool, automatically assign it to clients/products/servers/addons/configurable options.<br />
+|style="padding: 10px 0px 30px 15px;"|'''IP Manager For WHMCS allows you to manage dedicated IP addresses' subnets, automatically assign them to clients/products/servers/addons/configurable options.<br />
-IP Manager supports both IPv4 and IPv6. '''<br />
+The module enables clients to manage and order dedicated IP addresses, IPv4 or IPv6.<br />
-Module enables clients to manage and order dedicated IP addresses.<br />
+In this short guide the possibilities of the module will be briefly described.
-In this short guide we will present you the possibilities of our module.
+|}
+==Subnets==
+{|
+|style="padding: 10px 0px 30px 15px;"|To manage any subnet via IP Manager you have to add it first.<br />
+Remember that it is very important to configure any IP reservation rules before you create any subnets. If you add rules later on, they may not work properly!<br/>
+Read about rules reservation [[#IP Reservation|here]].<br/>
+|}
+===Create Subnet===
+{|
+|style="padding: 10px 0px 20px 15px;"|To begin, add a new IP addresses subnet, press the '' 'Create New Subnet' '' button.
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_8.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|Use '' 'Classless Inter-Domain Routing (CIDR)' '' notation to add subnets.<br/>
+First of all, select IP version: IPv4 or IPv6, type the subnet IP address and a correct bitmask.<br/>
+Correct ranges:<br/>
+*IPv4 - 1 to 32
+*IPv6 - 1 to 128
+''Note: The first IP from the subnet should be compatible with [http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing CIDR notation].''
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_9.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|You can exclude any number of IP addresses from the subnet.<br />
+To do so, enter them into '' 'Excluded IP Addresses:' '' textarea, one IP address or IP range per line.<br />
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_10.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|If you want to set nameservers and gateway click on '' 'Toggle Advanced Settings'. ''<br/>
+Enter nameservers and gateway address into textboxes as shown on the screen below ''(this step is optional)''.<br />
+Afterwards, confirm the creation of the subnet through pressing the '' 'Add Subnet' '' button.
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_11.png]]
 |}
-==IP Pools==
+===Available IP Subnets And Child Subnets===
 {|
-|style="padding: 10px 0px 20px 15px;"|To manage any IP pool via IP Manager you have to add it first.<br />
+|style="padding: 10px 0px 15px 15px;"|Once you have added some IP subnets you can preview some details on them and manage the IP addresses.
-They are three ways to do that. You can use CIDR notation, enter IP range or IP addresses list.<br />
+As you can see on the following screen, you can find here a list of subnets in a tree view. Press any of added IP subnets to see its details.
-''Note 1: IP range and IP list are supported only for IPv4.''<br />
-''Note 2: IPv6 pools are relying on IP addresses range and store in the database only assigned IP addresses.''<br />
-''Therefore free IPv6 addresses will not be visible in the IP pool overview.''
 |}
-===Create IP Pool===
 {|
-|style="padding: 10px 0px 20px 15px;"|In order to add a new IP addresses pool, go to '' 'IP Pool' '' → '' 'Create IP Pool' ''.
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_13.png]]
 |}
+====Subnet====
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM7_1.png]]
+|style="padding: 10px 0px 20px 15px;"|To view subnet's details press on its address as shown on the following screen.
 |}
-====CIDR Notation====
 {|
-|style="padding: 10px 0px 15px 15px;"|Select '' 'Classless Inter-Domain Routing (CIDR)' ''.<br />
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_14.png]]
-Select IP version, type first IP from a pool and a netmask (in prefix notation).<br />
-''Note: First IP from the pool should be compatible with [http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing CIDR notation].''
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM8.png]]
+|style="padding: 0px 0px 15px 15px;"|In the '' 'Subnet'' ' field, you can find information about the address, mask, size, nameservers, gateway and many others.
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|You can exclude any number of IP addresses from the pool.<br />
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_15.png]]
-To do so, enter them into '' 'Excluded IP Addresses:' '' textbox, one IP address or IP range per line.<br />
-Additionally, you can exclude boundary IP addresses through marking '' 'Exclude Boundary IPs' '' checkbox.<br />
-If you want to set nameservers and gateway click on '' 'Toggle Advanced Settings' ''.<br />
-Otherwise, press '' 'Add Pool' '' button and your IP pool will be created.
 |}
+'''Actions'''
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM8_1.png]]
+|style="padding: 0px 0px 10px 15px;"|The most important functions of your IP Manager For WHMCS include some actions that can be done on subnets.<br />
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|Enter nameservers and gateway address into textboxes as shown on the screen below ''(This step is optional)''.<br />
+|style="padding: 0px 0px 20px 15px;"|
-Afterwards, confirm the creation of an IP pool through pressing '' 'Add Pool' '' button.
+*'''Delete''' - use it to remove the subnet together with any IP address in it (if there are such already).
+*'''Split''' - select split to divide the subnet into equal subnets according to the chosen mask. Keep in mind that the subnet may already include some assigned IP addresses.
+*:If you split such a subnet, the assigned IPs might be transferred to another subnet.
+*'''Merge''' - use this option if you want to join previously split subnet. Note that you can merge only parallel subnets.<br/>
+*:Additionally, you must remember that merge action removes IP addresses from external servers.
+*'''Create Child Subnet''' - this option allows to create subnet within a  '' 'parent' '' subnet.
+*:Such s child subnet may again be split/merged, have its own child subnets.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM8_2.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_17.png]]
 |}
-====IP Addresses Range====
+====Excluded IP Addresses====
 {|
-|style="padding: 10px 0px 15px 15px;"|Select '' 'IP Range' ''.<br />
+|style="padding: 10px 0px 15px 15px;"|List of excluded IP addresses. You can remove some addresses from the list or add new ones. <br/>
-Type the first and the last IP address of a pool you wish to add.
+Important! If you have any IP reservation rules set up, then do not include single IP addresses here. This option should be used as an addition if you do not use rules.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM8_3.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_18.png]]
 |}
+====Custom Fields====
 {|
-|style="padding: 0px 0px 15px 15px;"|You can exclude any number of IP addresses from the pool.<br />
+|style="padding: 10px 0px 15px 15px;"|IP Manager allows you to add custom fields per subnet.<br />
-To do so, enter them into '' 'Excluded IP Addresses:' '' textbox, one IP address or IP range per line.<br />
+To add a new custom field, press '' 'Create New Custom Field'. '' Afterwards, fill out the form with a custom field name and value. <br/>
-Additionally, you can exclude boundary IP addresses through marking '' 'Exclude Boundary IPs' '' checkbox.<br />
+Again, this option should be used if you do not specify default custom fields or if you want to add some additional ones. Be careful not to double custom fields here.
-You should also enter netmask in which your IP pool fits in.<br />
-If you want to set nameservers and gateway click on '' 'Toggle Advanced Settings' ''.<br />
-Otherwise, press '' 'Add Pool' '' button and your IP pool will be created.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM8_4.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_19.png]]
 |}
+====Assigned Client/Service====
 {|
-|style="padding: 0px 0px 15px 15px;"|Fill out nameservers and gateway address textboxes as shown on the screen below ''(This step is optional)''.<br />
+|style="padding: 10px 0px 15px 15px;"|If you wish to assign an IP subnet to a client or specific service, our module makes it available to you.<br />
-Afterwards, the confirm creation of a IP pool through pressing '' 'Add Pool' '' button.
+You can achieve that through using auto-complete textbox to choose the client and/or service.
+Again, remember to '' 'Save Changes'. ''<br />
+''Notes:<br/>
+IP addresses will be added to all products ordered by client.<br/>
+IP addresses will be added to all addons included in products.''
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM8_5.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_20.png]]
+|}
+{|
+|style="padding: 0px 0px 30px 15px;"|Keep in mind that a subnet that is assigned to a client is reserved for this client only.<br/>
+While IP addresses are assigned to a client, the following aspects are taken into consideration (in this order):
+*subnets assigned to a hosting
+*subnets assigned to a client
+*subnets assigned to configuration.
 |}
-====List of IP Addresses====
+===IP Addresses List===
 {|
-|style="padding: 10px 0px 15px 15px;"|Go to '' 'IP Pools' '' tab and select '' 'One or more single IP Addresses' ''.<br />
+|style="padding: 10px 0px 15px 15px;"|The easiest possible way of creating IP addresses within the created subnet.<br/>
-Type IP addresses you want to add, separated by comma, after typing last IP address press '' 'Enter' '' button.<br />
+Simply select the number of IP addresses you want to create and press the '' 'Add IP Address' '' button. New address in the subnet will be generated.
-Afterwards, confirm creation of IP pool through pressing '' 'Add Pool' '' button.<br />
-''Note 1: Using this option, you can only add IPv4 addresses.''<br />
-''Note 2: For each IP address added by this method, one IP pool will be created.''
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM8_8.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_21.png]]
+|}
+{|
+|style="padding: 0px 0px 20px 15px;"|You may also add an IP address manually. To do so, press the '' 'Add Custom IP' '' button.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_21_1.png]]
+|}
+{|
+|style="padding: 0px 0px 20px 15px;"|Type in the IP address you wish to be created.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_21_2.png]]
+|}
+{|
+|style="padding: 0px 0px 20px 15px;"|Once the addresses are generated, you can proceed to their assignment.<br/>
+Use action or mass actions buttons to do so.
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_22.png]]
+|}
+====Assign Single IP Address====
+{|
+|style="padding: 0px 0px 15px 15px;"|You are now redirected to a page where you can assign this specific IP address to a service by entering a domain or a username,<br/> using 3rd party integration module or custom assignment.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_23.png]]
+|}
+{|
+|style="padding: 0px 0px 20px 15px;"|Choose the method you wish to use and save the changes.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_24.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|As you can see, the IP address is assigned to the previously selected service (related to chosen domain).<br> You may always unassign this IP from this service and again assign it to another one, delete the IP address, create a custom field for this single address.
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_25.png]]
 |}
-===Show IP Pools===
+===Tree View===
 {|
-|style="padding: 10px 0px 20px 15px;"|To manage a previously created pools, proceed to '' 'IP Pool' '' → '' 'Show IP Pools' ''.<br />
+|style="padding: 0px 0px 20px 15px;"|To clarify, a comfortable tree view of your created subnets and child-subnets is available. Let's take a look at it to summarize the divisions.
-As you can see on the following scree, you can find here details of each IP pool.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM8_6_1.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_26.png]]
 |}
-====Additional Information====
 {|
-|style="padding: 10px 0px 15px 15px;"|You can edit IP pools additional information even after creation of a pool.<br />
+|style="padding: 0px 0px 15px 15px;"| You can see here a list of all subnets and child subnets in your IP Manager. Subnets marked in red already have some child subnets created, press any to show the list of child subnets.<br/> Accordingly available actions change.
-To do so, press on option you want to alter.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM8_6.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_27.png]]
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"|Afterwards, enter new value and press save button as shown on the screen below.
+|style="padding: 0px 0px 20px 15px;"| Any subnet can have child subnets created (with IP reservation rules taken into consideration) and custom fields assigned.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM8_7.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_28.png]]
+|}
+{|
+|style="padding: 0px 0px 30px 15px;"| Child subnets, however, can again have their child subnets created, can be split, merged or deleted.
+You may also manually exclude some IP addresses from a child subnet, assign clients and services directly to it and finally manage single IP addresses in such subnet.
 |}
-====Custom Fields====
+==Settings==
+===Show Settings===
+====Module Settings====
 {|
-|style="padding: 0px 0px 20px 15px;"|IP Manager allows you to specify custom fields per IP pool.<br />
+|style="padding: 10px 0px 20px 15px;"|Below, you can find description of each option.
-To add a new custom field, press '' 'Create a New Custom Field' ''.<br />
+*'''Assignment Process Settings'''
-Afterwards, fill out the form with custom field name and value.
+*#For any configuration you provide into this field, the '' 'Dedicated IP' ''  field will be omitted.
+*#If checked, additional IP addresses will be stored in 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 an external server and continues the action.
+*'''IP Logs Settings'''
+*#IP addresses without products or users will not be displayed in '' 'IP Logs' '' page.
+*'''IP Reservation Settings'''
+*#If you check this checkbox, you will allow to add IP reservation rules.
+*'''Email Reminder Settings'''
+*#If you check this checkbox, you will receive an email with notification about IP subnets running out of IP addresses.
+*#Enables you to define percentage value which, when exceeded by any subnet, results in a notification being sent.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM8_9.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_31.png]]
 |}
-====Assign To A Client====
+====IP Addresses Cleaner====
 {|
-|style="padding: 0px 0px 15px 15px;"|If you want to assign a pool of IP to specific client, our module makes it available to you.<br />
+|style="padding: 10px 0px 20px 15px;"|IP Addresses Cleaner allows you to restore/remove IP addresses form WHMCS/IP Manager/both depending on chosen settings.
-You can achieve that through using auto-complete textbox to find and choose client and pressing '' 'Save Changes' '' button.<br />
+*'''IP Addresses Cleaner Settings'''
-''Note: IP addresses will be added to all products ordered by client.''
+*#IP address are added to hosting if relation exists.
+*#IP address' relation are removed if IP address is not assigned to any hosting.
+*#If IP address does not exist in any subnet, it is removed from hosting.
+*#Create IP address' relation if it does not exist.
+*#If IP address does not exist in any subnet, it is removed from relations.
+*#Set IP address as unassigned if its relation does not exist.
+'''Important:''' After making any changes in those settings, press '' 'Update Settings'. ''<br />
+Otherwise, settings will not be saved and the Cleaner will run using old ones.<br/>
+'''''Note:''' Please be aware that 'History' refers to the current "IP Logs" section.''
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM9.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_32.png]]
 |}
-====IP Pool Details====
 {|
-|style="padding: 0px 0px 20px 15px;"|To view IP pool details press on its address as shown on the following screen.
+|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 or remove an IP subnet.<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 20px 25px;"|[[File:IPM10.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM24_6.png]]
 |}
+===IP Reservation===
 {|
-|style="padding: 0px 0px 15px 15px;"|In IP pool view you can find information about current assignment of IP addresses from pool and manually manage their assignment.<br />
+|style="padding: 10px 0px 20px 15px;"|You can automate the process of IP assignment by adding some rules that will be then executed while assigning IP addresses from a subnet to clients or services.<br/>
-To facilitate the management of addresses we also added records filters.<br />
+'' 'IP Reservation' '' rules can be configured under the '' 'Settings' '' section.
-''Note: The screen below presents IP pool view with manually assigned service 'mytestingdomain.com'.''
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM11.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_34.png]]
 |}
-'''Bulk Actions'''
 {|
-|style="padding: 0px 0px 20px 15px;"|Our module supports actions on multiple IP addresses.<br />
+|style="padding: 0px 0px 15px 15px;"|Use the rules consciously because they will be then taken into consideration while assigning any IP from any subnet in your IP Manager.<br/>
-To issue such action, mark involved IP addresses and choose desired action from '' 'Action For Selected IP Addresses' '' dropdown menu.
+As it is stated in the guide visible on the screen, you need to stick to some standards while personalizing your assignment process.<br/>
+Press '' 'Add New Rule'. ''
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM11_1.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_35.png]]
+|}
+====New Rules====
+{|
+|style="padding: 10px 0px 20px 15px;"|To add a new rule, type in the required value in the '' 'Rule' '' field and describe it in the text box nearby.<br/>
+To illustrate:<br/>
+Enter '''n''' in the '' 'Rule' '' textarea. Then the first IP address from a subnet will be always excluded. It will be reserved and it will not be assigned to any client or service.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_36.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|You can add more that one rule. If you do it thoughtfully, you will have much less work later on while creating new subnets because <br/>customized rules will substitute the need to fill out the '' 'Excluded IP Addresses' '' area.
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_37.png]]
 |}
+===Default Custom Fields - Subnets===
 {|
-|style="padding: 0px 0px 15px 15px;"|*'''Delete From The Pool''' as its name suggest removes IP addresses from a pool.
+|style="padding: 10px 0px 20px 15px;"|In this section ''('Settings' → 'Default Custom Fields - Subnets')'' you are allowed to add and configure some custom fields that will be assigned to subnets by default.
-*'''Unassign''' removes IP addresses from products they were assigned to, IP addresses stays in the pool.
-*'''Unassign Using Submodules''' works in the same way as '''Unassign''' does.<br />
-Additionally, it removes IP addresses from external servers.
-*'''Assign''' is the most interesting option, it allows you to:
-**Choose a product to which IP addresses should be assigned.
-**Define whether or not to use 3rd party integration module.
-**Set them as assigned without assigning them to any product. You can also add a note to involved IP addresses.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM11_2.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_42.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|All you need to do is enter the name of your custom field, its value and save changes.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_43.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|Surely, you can create plenty of such custom fields and edit/remove the already existing.
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_44.png]]
 |}
-====Custom Fields For IP Addresses====
+===Default Custom Fields - IPs===
 {|
-|style="padding: 10px 0px 15px 15px;"|Additionally, you can assign custom field to IP address.<br />
+|style="padding: 10px 0px 20px 15px;"|Section '' 'Default Custom Fields - IPs' '' allows adding default custom fields per IP address within the selected subnet. <br/>Press '' 'Add New Default Field' '' to begin.
-Some 3rd party integration submodules may need additional information provided along with IP address (like MAC address) this it place to add them.<br />
-To add custom field, press '' 'Add a New Custom Field' '' next to IP address you want to assign custom field to.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM11_3.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_44_1.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|Afterwards, fill '' 'Custom Field Name' '' and '' 'Custom Field Value' '' fields and press '' 'Save Changes' ''.
+|style="padding: 0px 0px 15px 15px;"|Select subnet, the single IP addresses in which you wish to have the field assigned. You may point single subnet or select all existing subnets.<br/> Then, type in the custom field name and value.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM11_4.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_44_2.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|You can create plenty of such custom fields and then edit/remove the already existing ones.<br/> ''Keep in mind that if a custom field is assigned to all subnets, then action conducted on a custom field in a single subnet is triggered on all the other subnets!''
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_44_3.png]]
 |}
 ==IP Assignment Mechanism==
 {|
-|style="padding: 10px 0px 30px 15px;"|It is crucial to understand mechanism of automatic IP addresses assignment. In this section we will clarify it to you.<br />
+|style="padding: 10px 0px 30px 15px;"|It is crucial to understand mechanism of automatic IP addresses assignment. In this section we will clarify it for you.<br />
-'' 'IP Quantity' '' field defines quantity of IP addresses added to ordered product by triggering a specific relation.<br />
+'' 'IP Quantity' '' field defines the quantity of IP addresses added to the ordered product by triggering a specific relation.<br />
 Two and more relations from one configuration can be triggered for the same product (therefore, multiple quantity of IP addresses can be assigned).<br />
 Additionally, if you set up two configurations with the same relation, IP addresses from both configurations will be added.<br />
-Therefore, if you set up these two configurations at IP Manager:<br />
+Therefore, if you set up these two configurations in IP Manager:
 *'''Configuration 1''':  Addon A (IP Quantity = 2), Product C (IP Quantity = 1)
 *'''Configuration 2''':  Addon A (IP Quantity = 2), Addon B (IP Quantity = 2), Product D (IP Quantity = 3)
@@ Line 377: / Line 593: @@
 *'''Order 4''': Product F with addon A: 4 IP addresses assigned
 |}
+===Automatic IP Assignment===
-==Automatic IP Assignment==
 {|
-|style="padding: 10px 0px 15px 15px;"|Main reason for creating this module was to automatize the assignment of IP addresses.<br />
+|style="padding: 10px 0px 15px 15px;"|The main reason, why this module has been created, was to automate IP addresses assignment.<br />
-Here we will show you how to set up configuration for it. In order to start, go to '' 'Configuration' '' → '' 'Create Configuration' ''.<br />
+Here we will show you how to set up its configuration. In order to start, go to '' 'Configuration' '' → '' 'Create Configuration'. ''<br />
-Type your configuration name, press textboxes corresponding to options you wish to add and select them from dropdown menus.<br />
+Type your configuration name, press textboxes corresponding to options you wish to add and select them from dropdown menus:
-Afterwards, press '' 'Create New Configuration' '' button. On the screen below you can see sample configuration with two products.
+*Products
+*Addons
+*Servers
+*Config Options<br/>
+Afterwards, press the '' 'Create New Configuration' '' button. On the screen below you can see sample configuration with two products selected.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM12.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_45.png]]
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"|Now you have to assign at least one IP pool to configuration. You can do it through pressing '' 'Assigned Pools' '' button.
+|style="padding: 0px 0px 20px 15px;"|Now you have to assign at least one subnet to configuration. Use the '' 'Assigned Subnets' '' button.<br/>
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM13.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_46.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|Next, choose IP pool from a dropdown menu and press '' 'Add Pool' '' button.<br />
+|style="padding: 0px 0px 15px 15px;"|Choose a subnet from a dropdown menu and press the '' 'Assign Subnet' '' button.<br />
-Keep in mind that you can assign multiple pools to a single configuration.
+Keep in mind that you can assign multiple subnets to a single configuration.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_47.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|See the list of subnets assigned to your configuration.
+*Press Subnet address to see its details
+*Manage additional Information: nameservers, gateway
+*Check usage
+*Remove subnet from the list
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_47_1.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|On pressing subnet address you will be moved to its details where you can manage it.<br/>
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM14.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_47_2.png]]
 |}
-==Advanced Configuration==
+===Advanced Configuration===
 {|
-|style="padding: 10px 0px 15px 15px;"|Lets say, that you want to set multiple IP assignment to specific product or so on, it is available with our module!<br />
+|style="padding: 10px 0px 15px 15px;"|Let's say, that you want to set multiple IP assignment to specific product, it is available with our module!<br />
-Here we will show you how to set up multiple IP addresses assignment to configurable option '' 'Extra IP Addresses' ''.<br />
+Here we will show you how to set up multiple IP addresses assignment to configurable option '' 'Extra IP Addresses'. ''<br />
-Create a new configuration as while setting up standard configuration.<br />
+Create a new configuration as while setting up a standard configuration.<br />
-When you are done press on '' 'Configurable Options' '' as shown on the screen below.
+Once it is  done press '' 'Configurable Options' '' as shown on the screen below.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM15.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_48.png]]
 |}
 {|
 |style="padding: 0px 0px 15px 15px;"|Afterwards, mark checkboxes next to configurable options you want to assign IP addresses to.<br />
-Enter quantity of IP addresses which will be assigned to each configurable option and press '' 'Save Changes' ''.
+Enter quantity of IP addresses which will be assigned to each configurable option and press '' 'Save Changes'. ''
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM16.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_49.png]]
 |}
-==Usage Graph==
+====Usage Statistics====
 {|
-|style="padding: 10px 0px 20px 15px;"|In each configuration you can find graph, which shows the statistics of IP addresses assignment.
+|style="padding: 10px 0px 20px 15px;"|In each configuration you can find a graph, which shows the statistics of IP addresses assignment.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM17.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_50.png]]
 |}
@@ Line 431: / Line 667: @@
 {|
 |style="padding: 10px 0px 30px 15px;"|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.<br />
-''Note 1: Some of these integration submodules requires to set up free IP pools (cPanel) or IP addresses (Plesk) on servers.''<br />
+''Note 1: Some of these integration submodules require free IP subnets (cPanel) or IP addresses (Plesk) on servers to be set up.''<br />
-''Note 2: IP Manager can integrate multiple IP addresses to a single product.''
+''Note 2: IP Manager can integrate multiple IP addresses with a single product.''
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_50_1.png]]
 |}
 ===Enabling 3rd Party Integration===
 {|
-|style="padding: 10px 0px 15px 15px;"| Activation of all integration modules looks similar, there is only a difference for cPanel and cPanel Extended integration submodules.<br />
+|style="padding: 10px 0px 15px 15px;"| Activation of all integration modules looks similar, there is only a difference in cPanel and cPanel Extended integration submodules.<br />
-Start by pressing '' 'Activate' '' button next to a module you want to activate.
+Start by pressing the '' 'Activate' '' button next to the module you want to activate.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM18.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_51.png]]
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"| Press '' 'Configure' '' button and assign configurations to it.<br />
+|style="padding: 0px 0px 15px 15px;"| Press the '' 'Configure' '' button and assign configurations to it.<br />
-Confirm through clicking '' 'Save Changes' ''.
+Confirm through clicking '' 'Save Changes'. ''
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM19.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_52.png]]
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"| cPanel and cPanel Extended additionally allows you to choose a method of the integration.<br />
+|style="padding: 0px 0px 15px 15px;"| cPanel and cPanel Extended additionally allow you to choose the method of the integration.<br />
-. Creates a DNS zone for each IP address assigned to a product.<br />
+* Creates a DNS zone for each IP address assigned to a product.
-. First IP address assigned to a product is set up as a site dedicated IP address.
+* The first IP address assigned to a product is set up as a site dedicated IP address.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM19_1.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_53.png]]
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"| As you can see on the following screen, you can easily check quantity of configurations assigned to each 3rd party integration.
+|style="padding: 0px 0px 20px 15px;"| As you can see on the following screen, you can easily check the quantity of configurations assigned to each 3rd party integration.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM19_2.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_54.png]]
 |}
-===Integration With Proxmox VPS/Cloud For WHMCS===
+===Integration With Proxmox VE VPS/Cloud VPS For WHMCS===
 {|
-|style="padding: 10px 0px 30px 15px;"|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.<br />
+|style="padding: 10px 0px 30px 15px;"|Integration with ''Proxmox VE VPS For WHMCS'' and ''Proxmox VE Cloud VPS For WHMCS'' is the only one to be set up both on the side of ''IP Manager For WHMCS'' and the integrated module.<br/>
-Due to that, setting up integration consist of 3 steps:<br />
+'' '''Note:''' This integration works for '''LXC''' and '''KVM''' virtualization types.
-. Create IP addresses pool which will be used for product.<br />
+<br/><br/>
-. Create configuration & assign previously created pool to it. '''No additional action is required in this step.'''<br />
+The process of establishing the integration for ''Proxmox VE VPS For WHMCS'' module consists of 4 steps:<br />
-. Go to product → '' 'Module Settings' '' tab and assign a previously created configuration in '' 'IP Manager' '' section.<br />
+. Create the subnet of IP addresses that will be used for a product.<br />
-'''Important: Assigning anything beyond the IP pool to the configuration in the IP Manager For WHMCS may cause unexpected effect in your WHMCS environment.'''
+. Create the configuration and assign a previously created subnet to it. '''No additional action is required after this step.'''<br />
+'' '''Important:''' Assigning anything other than the subnet to the configuration in IP Manager For WHMCS may bring unexpected results in your WHMCS environment.''<br />
+. When Proxmox starts creating a virtual machine, it retrieves the assigned IP address to the service and assigns it directly to the VM.<br/>
+<br/>
+In the case of ''Proxmox VE Cloud VPS For WHMCS'' module, the IP addresses assigned to the service will be assigned to VMs in the order they were created on the server, <br/>i.e. the first VM to retrieve the IP addresses is the one whose creation process ends first.
 |}
 ===Integration With SolusVM Extended VPS For WHMCS===
 {|
-|style="padding: 10px 0px 30px 15px;"|Integration with SolusVM Extended VPS For WHMCS is tricky.<br />
+|style="padding: 10px 0px 30px 15px;"|Integration with ''SolusVM Extended VPS For WHMCS'' is tricky.<br />
-IP Manager For WHMCS cannot inject the first IP address for the VPS, due to the way SolusVM API works.<br />
+''IP Manager For WHMCS'' cannot inject the first IP address to VPS, due to the way SolusVM API works.<br />
-After the creation of a VPS, IP Manager is able to add additional IP addresses.<br />
+After creation of VPS, IP Manager is able to add additional IP addresses.<br />
-Therefore, if you are using this integration, we advise seting up IP Manager synchronization as a cron job.
+Therefore, if you use this integration, we advise setting up IP Manager synchronization as a cron job.
 |}
@@ Line 493: / Line 737: @@
 ===Creation of Integration Submodule===
 {|
-|style="padding: 10px 0px 15px 15px;"|You can create your own integration, all you need is knowledge of PHP programming language.<br />
+|style="padding: 10px 0px 15px 15px;"|You can create your own integration, all you need is knowledge of the PHP programming language.<br />
 You can do it through using '' 'Autorelease' '' submodule file.<br />
-. To begin, make copy of '' 'AutorelaseIntegration.php' '' located in '' 'your_whmcs/modules/addons/ipmanager2/app/modules' ''.
+. To start, make a copy of '' 'AutoreleaseIntegration.php' '' located in '' 'your_whmcs/modules/addons/ipmanager2/app/modules'. ''
 |}
 {|
@@ Line 508: / Line 752: @@
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|3. Edit the file, start by entering basic setting.
+|style="padding: 0px 0px 20px 15px;"|3. Edit the file, start by entering basic settings.
 . Class name should be the same as the file name.
 . Submodule name visible in IP Manager.
-. Submodule description you wish to display.
+. Submodule description displayed in IP Manager.
-. Place here a module name that you are integrating ( best way is to copy a folder name of the module ).
+. Place here an integrating module name ( the best way is to copy a folder name of the module ).
 |}
 {|
@@ Line 518: / Line 762: @@
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|4. Now it is time to implement integration part, you will need integrated module documentation for it.
+|style="padding: 0px 0px 20px 15px;"|4. Now, it is time to implement an integration part, you will need integrated module documentation to do it.
 . Configuration of 3rd party integration submodule.
-. Place code here assigning IP address to module product.
+. Code assigning IP address to module product goes here.
-. You can add code to unassign IP address here.
+. You can add a code to unassign IP address here.
 |}
 {|
@@ Line 527: / Line 771: @@
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"|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' ''.
+|style="padding: 0px 0px 20px 15px;"|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'. ''
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM19.6.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_56.png]]
 |}
 ==Export==
 {|
-|style="padding: 10px 0px 15px 15px;"|You can export your IP pools to .csv and .xml files.<br />
+|style="padding: 10px 0px 15px 15px;"|You can export your subnets with IP addresses to CSV and XML files.<br />
-To export, go to the '' 'Export' '' tab, choose IP pool to export and file format.<br />
+To export, go to the '' 'Export' '' tab, choose subnet to export and output format.<br />
-Confirm through pressing '' 'Save Changes' '' button. Downloading of file will start shortly.<br />
+Now you can '' 'Generate' '' the file. File downloading will start shortly.<br />
-''Note: Your 'storage' folder located at 'your_whmcs/modules/addons/ipmanager2' should have chmod set to '''755'''.''
+''Note: Your '' 'storage' '' folder located in 'your_whmcs/modules/addons/ipmanager2' should have chmod set to '''755'''.''
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM25.3.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_62.png]]
 |}
 ==Import==
 {|
-|style="padding: 10px 0px 15px 15px;"|In '' 'Import' '' tab you can find tools to synchronize IP addresses from your WHMCS as well as import them from a file.<br />
+|style="padding: 10px 0px 15px 15px;"|In the '' 'Import' '' tab you can find tools to synchronize IP addresses from your WHMCS as well as import them from a file.<br />
 '''Synchronization'''<br />
-Synchronization will confirm relations in your system with relations in IP Manager pools.<br />
+Synchronization will confirm relations in your system with relations in IP Manager subnets.
-*IP address is used by a product, but inside of IP Manager pool is marked as unassigned - record inside of a pool will be updated.<br />
+*IP address is used by a product, but inside of IP Manager subnet it is marked as unassigned - record inside of a subnet will be updated.
-*IP address is used by a product, but do not exist in any IP Manager pool - a new pool will be created.<br />
+*IP address is used by a product, but does not exist in any IP Manager subnet - a new subnet will be created.
 There are three available cron commands:<br />
 . This cron command synchronizes all products (it will require confirmation).<br />
@@ Line 555: / Line 800: @@
 . This cron command synchronizes only products which IDs have been provided as arguments separated by comma.<br />
 '''Import'''<br />
-To import IP addresses from a file, select it, chose its format and press '' 'Import'.''
+To import IP addresses from a file, select it, choose its format and press '' 'Import'.''
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM24_1.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_63.png]]
 |}
 ==IP Logs==
 {|
-|style="padding: 10px 0px 15px 15px;"|'' 'Logs' '' page stores the history of actions ordered on IP addresses.
+|style="padding: 10px 0px 20px 15px;"|The '' 'Logs' '' page stores the history of actions ordered on each of IP addresses.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM24_5.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_64.png]]
 |}
-==Settings==
+==Integration Code==
 {|
-|style="padding: 10px 0px 15px 15px;"|You can set up custom field '' 'IP Addresses' '' used in place of '' 'Assigned IPs' '', disable usage of '' 'Dedicated IP' '' field or set up email reminder.<br />
+|style="padding: 10px 0px 15px 15px;"|'''Integration described below is not obligatory.'''<br />
-Disabling '' 'Dedicated IP' '' field is crucial for VPS where IP address is bounded to physical machine.<br />
+Module allows your customers to view IP addresses assigned to their product and order additional ones.<br />
-Therefore we allow you to disable usage of '' 'Dedicated IP' '' field for specific configuration.<br />
+To enable it, follow these simple steps:
-To do so, fill field marked on the following screen with configuration name and pressing '' 'Update Settings' '' button.
 |}
+====Integration in WHMCS====
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM24_2.png]]
+|style="padding: 10px 0px 20px 15px;"|'' '''Important!''' In this section, you will find the exemplary integration for the WHMCS 'Six' and 'Twenty-One' themes.''
+Please remember that the following code line numbers, as well as code fragments, may differ between distinct versions of WHMCS. <br/> You have to make sure by yourself that the integration best suits your WHMCS theme and version.<br/> The picture below is based on the WHMCS 'Six' theme.
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"|To enable usage of '' 'IP Addresses' '' custom field instead of '' 'Assigned IPs' '' field, mark checkbox as shown on the screen below and click '' 'Update Settings' '' button.
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_65_1.png]]
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM24_3.png]]
+|style="padding: 0px 0px 20px 15px;"|After the integration for the WHMCS 'Six' theme, the client area section should look like here:
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|Last but not least important feature is setting up email reminder which will be sent to all admins.<br />
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_65_2.png]]
-To enable email reminder, mark checkbox as shown on the following screen.<br />
-Afterwards, using textbox or slider, define value which exceeding will trigger email reminder.<br />
-Confirm changes by pressing '' 'Update Settings' '' button.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:IPM24_4.png]]
+|style="padding: 0px 0px 20px 15px;"|The integration for the WHMCS 'Twenty-One' theme is presented here:
 |}
-==Integration Code==
 {|
-|style="padding: 10px 0px 15px 15px;"|'''Integration described below is not obligatory.'''<br />
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_66_1.png]]
-Module allows your customers to view IP addresses assigned to their product any order new ones.<br />
-To enable it, follow these simple steps:
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM_49.png]]
+|style="padding: 0px 0px 20px 15px;"|After the integration for the WHMCS 'Twenty-One' theme, the client area section should look like here:
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_66_2.png]]
+|}
+<!--
+====Integration in WHMCS V6 and V7====
+{|
+|style="padding: 10px 0px 20px 15px;"|'' '''Note:''' Please be aware that the following integration is an example for the  WHMCS default 'six' template, and the following code line numbers as well as code fragments may differ between distinct versions of WHMCS. <br/> You have to make sure by yourself that the integration best suits your WHMCS template and version.''
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_65.png]]
 |}
 {|
@@ Line 607: / Line 858: @@
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM_50.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_66.png]]
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"|In the client area it should look like on the screen below.
+|style="padding: 0px 0px 20px 15px;"|The client area should look like on the screen below.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM_51.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_67.png]]
 |}
+====Integration in WHMCS V5====
 {|
-|style="padding: 0px 0px 30px 15px;"|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.
+|style="padding: 10px 0px 20px 25px;"|[[File:IPM2_68.png]]
+|}
+{|
+|style="padding: 0px 0px 20px 15px;"|Correctly placed code is presented on the following screen.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_69.png]]
+|}
+{|
+|style="padding: 0px 0px 20px 15px;"|The client area should look like on the screen below.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_70.png]]
+|}
+{|
+|style="padding: 10px 0px 20px 15px;"|To allow your customers to buy a new IP address you need to set up a product addon for product and assign the addon to configuration in IP Manager.
+|}
+-->
+{|
+|style="padding: 0px 0px 20px 15px;"|The above described integration works for all products without exception.<br/> However, in case you wish to restrict the integration to limited number of products, please insert the below codes instead of the one suggested in the addon. <br/><br />
+<code>
+ {if $moduleclientarea}
+   &lt;div class="moduleoutput"&gt;;{$moduleclientarea|replace:'modulebutton':'btn'}
+   {if $pid == 26 || $module ==  'yourModuleName_1' || $module == 'yourModuleName_2'}
+        {$IPM2_anager_integration}
+   {/if}
+   &lt;/div&gt;
+ {/if}
+</code>
+|}
+{|
+|style="padding: 0px 0px 30px 15px;"|Once such code is inserted in the template, IP Manager will be displayed for product with ID that equals 26 or if the product is based on '' 'yourModuleName_1/ yourModuleName_2' '' modules.<br/> Extend the IP Manager integration according to your needs. The above code is just an example which can undergo modifications.
+|}
+==Admin Area==
+{|
+|style="padding: 10px 0px 15px 15px;"|In the '' 'Products/Services' '' tab located in your client's profile view in the admin area you can manually assign and unassign IP addresses from the chosen products.<br />
+To start, select one of the products ordered by your client and press '' 'Manage IP Addresses' '' next to the '' 'Dedicated IP' '' field.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_78.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|A new window will pop up, allowing you to manage the assignment of IP addresses.<br/>
+Select one of your IP pools from the '' 'Tree View' ''. In the window to the right you can select IP addresses from the chosen pool and assign them to your client's product.<br/>Please note that only free and not assigned yet IP addresses will be available for selection from the dropdown menu.<br/>
+If any other IP addresses are already assigned to that product, you can replace them by toggling '' 'Override Already Assigned IP Addresses' ''.<br/>Otherwise, the newly selected IP addresses will be added to those already assigned.<br/>
+Additionally, toggle the '' 'Use submodule' '' option if you want the 3rd party integration to be used. Please note however, that this option requires the current list of assigned IP addresses to be overwritten.<br/>This is to ensure that the synchronization works properly. If you decide to leave this option disabled, the new added IP addresses will be assigned only in WHMCS itself.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_79.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|The third window in the bottom right corner allows you to manage the list of '' 'Already Assigned IP Addresses' ''.<br/>
+You can also preview there if any of the assigned IP addresses is also assigned using the 3rd party submodule integration.<br/>
+Additionally, you can '' ' Unassign' '' any IP address from WHMCS, but it will not unassign this address automatically from the submodule. After its removal it will also return to the IP subnet pool.<br/>
+If you want to unassign an IP address from both WHMCS and 3rd party integration submodule, press the '' 'Unassign In Submodule' '' button which appears only for IP addresses already assigned in the submodules.<br/>
+'' '''Note:''' If you need a bit more advanced management of a single assignment of IP addresses, go to the '' 'Subnets' '' section of the IP Manager addon.<br/>
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_80.png]]
 |}
 ==Client Area==
 {|
-|style="padding: 10px 0px 15px 15px;"|Your client can view and manage his IP addresses owing to IP Manager For WHMCS.<br />
+|style="padding: 10px 0px 15px 15px;"|Your clients can view and manage their IP addresses and subnets thanks to installed IP Manager For WHMCS module.<br />
-To remove an IP address from a product, press '' 'Unassign' ''.
+To remove any IP address or subnet from a product, simply press the '' 'Unassign' '' button.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM_52.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_71.png]]
 |}
 {|
-|style="padding: 10px 0px 15px 15px;"|Your client can also order a new IP address.<br />
+|style="padding: 0px 0px 15px 15px;"|Your client can also order a new IP address.<br />
 Press '' 'Order Additional IP Addresses' '' as shown below.<br />
 Your client will be moved to order form containing previously configured addons.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM_53.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_72.png]]
-|}
-{|
-|style="padding: 10px 0px 15px 15px;"|As soon the addon became active, new IP addresses will be granted.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM_54.png]]
+|style="padding: 0px 0px 30px 15px;"|As soon as the addon is active, new IP address is granted.
 |}
 ==Add IP via Addon==
 {|
-|style="padding: 10px 0px 15px 15px;"|Setting up addon allows your client to add IP address to their product using integration.<br />
+|style="padding: 10px 0px 15px 15px;"|Setting up an addon allows your client to add an IP address to their product using integration.<br />
 Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Product Addons' '' and press '' 'Add New Addon' ''.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM_55.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_74.png]]
 |}
 {|
 |style="padding: 0px 0px 15px 15px;"|Afterwards, enter addon name, addon description and select applicable products.<br />
 Set pricing for addon by choosing '' 'Billing Cycle' '' and typing price.<br />
-Confirm through pressing '' 'Save Changes' '' button.
+Confirm through pressing the '' 'Save Changes' '' button.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM_56.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_75.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|Now, go to '' 'Addons' '' → '' 'IP Manager' '' and use configuration you created before or [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Automatic_IP_Assignment create new one].<br />
+|style="padding: 0px 0px 15px 15px;"|Now, go to '' 'Addons' '' → '' 'IP Manager' '' and use configuration created before or [[#Automatic IP Assignment|create a new one]].<br />
-Remember to add previously created addon as a configuration relation.<br />
+Remember to add the previously created addon as a configuration relation.<br />
-You can do it by pressing '' 'Addon' '' button as shown on the following screen.
+You can do it by pressing the '' 'Addon' '' button as shown on the following screen.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM_57.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_76.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|Tick checkbox next to addon and enter quantity of IP addresses to add.<br />
+|style="padding: 0px 0px 15px 15px;"|Tick checkbox next to addon and enter the quantity of IP addresses to be added.<br />
-Afterwards, click'' 'Save Changes' '' button.
+Afterwards, click the '' 'Save Changes' '' button.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:IPM_58.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_77.png]]
 |}
 {|
@@ Line 679: / Line 989: @@
 ==Management of Custom Hooks==
 {|
-|style="padding: 10px 0px 15px 15px;"|Our module allows you to use custom hooks. All you have to do is to create some functions using PHP programming language.<br />
+|style="padding: 10px 0px 15px 15px;"|Our module allows you to use custom hooks. All you have to do is create some functions using PHP programming language.<br />
-Here you can see the possible hooks:
+Here you can see possible hooks:
   before_ip_assign_hook($ip, $serviceid, $relation, $configid)
   after_ip_assign_hook($ip, $serviceid, $relation, $configid)
@@ Line 689: / Line 999: @@
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|To find details about hooks read file '' 'custom_hooks.php' ''.<br />
+|style="padding: 0px 0px 15px 15px;"|To find details about hooks read '' 'custom_hooks.php' '' file.<br />
-You can find there hook, information about its time of run, return values and parameters.<br />
+You can find there all hooks, information about their time of run, returned values and parameters.<br />
-For example, if you want to throw message to activity log after IP address assignment find hook '' 'after_ip_assign_hook($ip, $serviceid, $relation, $configid)' '' and type:<br />
+For example, if you want to throw message to activity log after IP address assignment find hook '' 'after_ip_assign_hook($ip, $serviceid, $relation, $configid)' '' and type:
   Logger::factory()->log('Custom hook was triggered');
 It should look like on the screen below:
@@ Line 699: / Line 1,009: @@
 |}
-==How To Update==
+=Tips=
+{|
+|style="padding: 10px 0px 5px 15px;"|1. If your client orders a product that is combined with two configurations (e.g. by product type and configurable option), IP Manager will add IP addresses from both configurations.
+|}
+{|
+|style="padding: 0px 0px 5px 15px;"|2. If you have used IPv6 block before the update to IP Manager 2.2.0, all of them will be migrated to corresponding subnets. Note that migration is done automatically for you.
+|}
+{|
+|style="padding: 0px 0px 5px 15px;"|3. IP Manager For WHMCS requires [http://php.net/manual/en/book.gmp.php GMP] or [http://php.net/manual/en/book.bc.php BCMath] installed on your server.
+|}
+{|
+|style="padding: 0px 0px 5px 15px;"|4. If API returns the error '' 'Unknown network interface' '' when adding a new IP address for Plesk 12 Integration, then you need to modify the file '''new_configuration.json''' located in '''your_whmcs/modules/addons/ipmanager2/app/modules/api/Plesk/'''. <br/>
+Firstly, change the name of the mentioned file from '''new_configuration.json''' to '''configuration.json'''. Next, open the file and provide the proper name for the interface. <br/>
+To make sure that you provided the appropriate interface name, log in to your Plesk panel, proceed to the '' 'Tools & Settings -> IP Addresses' '' section, and check the interface name.
+|}
+{|
+|style="padding: 0px 0px 10px 15px;"|5. The module supports the "Lagom WHMCS Client Theme", if you want to use this theme in your client area you will have to insert a proper integration code in the dedicated template files. <br/> To easily copy the integration code, proceed to your addon → Integration Code section, and follow the described steps.
+|}
 {|
-|style="padding: 10px 0px 15px 15px;"|In order to upgrade your module, follow [[Modules_Update|Modules Update]] article.
+|style="padding: 0px 0px 30px 25px;"|[[File:IPM_60_0.png]]
 |}
-=Tips=
+=Update Instructions=
 {|
-|style="padding: 10px 0px 30px 15px;"|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.
+|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
+Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.
+|}
+=Upgrade Guide=
+{|
+|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/>
+Opt for the [https://www.modulesgarden.com/products/whmcs/ip-manager#open-source-version Open Source version] of your IP Manager For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/>
+Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.
 |}
 =Common Problems=
 {|
-|style="padding: 10px 0px 0px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+|style="padding: 10px 0px 10px 15px;"|'''1. In case of connection problems, please check whether your SELinux or firewall does not block ports.'''
 |}
 {|
-|style="padding: 10px 0px 10px 15px;"|2. If you see something like this at '' 'Addon' '' → '' 'IP Manager' '', remove content of '' 'template_c' '' (except '' 'index.php' '' file).
+|style="padding: 0px 0px 10px 15px;"|2. If you see something like this when moving to '' 'Addon' '' → '' 'IP Manager', '' remove a content of the '' 'template_c' '' folder.
 |}
 {|
@@ Line 720: / Line 1,056: @@
 |}
 {|
-|style="padding: 0px 0px 30px 15px;"|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' ''.<br />
+|style="padding: 0px 0px 5px 15px;"|3. If you export a file and it is empty, check your '' 'Storage' '' folder chmod, it should be set to '''755'''. Folder is located in '' 'your_whmcs/modules/addons/ipmanager2' ''.<br />
 If you still have that problem, set chmod '''777'''.
+|}
+{|
+|style="padding: 0px 0px 30px 15px;"|4. For integration with SolusVM Extended For WHMCS, '''one additional IP address''' is always assigned to the Solus virtual machine through the IP Manager For WHMCS module, exceeding the quantity specified in the SolusVM product configuration.
 |}

Personal tools

Namespaces

Variants

Views

Actions

Search

IP Manager For WHMCS