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.
You will also be able to synchronize IP addresses used by products in your WHMCS system with IP Manager IP pools.
What is more, IP Manager For WHMCS will allow your customers to easily manage their IP addresses from the WHMCS client area.

We will guide you step by step through the whole installation and configuration process.

Files in your WHMCS directory should look like this.

File is located in 'modules/addons/ipmanager2/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

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

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

Click on 'Configure' button, tick desired admin roles and press 'Save Changes' .

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

You can access your module at 'Addons' → 'IP Manager' .

IP Manager supports both IPv4 and IPv6.
Module enables clients to manage and order dedicated IP addresses.
In this short guide we will present you the possibilities of our module.

They are three ways to do that. You can use CIDR notation, enter IP range or IP addresses list.
Note 1: IP range and IP list are supported only for IPv4.
Note 2: IPv6 pools are relying on IP addresses range and store in the database only assigned IP addresses.
Therefore free IPv6 addresses will not be visible in the IP pool overview.

Select IP version, type first IP from a pool and a netmask (in prefix notation).
Note: First IP from the pool should be compatible with CIDR notation.

To do so, enter them into 'Excluded IP Addresses:' textbox, one IP address or IP range per line.
Additionally, you can exclude boundary IP addresses through marking 'Exclude Boundary IPs' checkbox.
If you want to set nameservers and gateway click on 'Toggle Advanced Settings' .
Otherwise, press 'Add Pool' button and your IP pool will be created.

Afterwards, confirm the creation of an IP pool through pressing 'Add Pool' button.

Type the first and the last IP address of a pool you wish to add.

To do so, enter them into 'Excluded IP Addresses:' textbox, one IP address or IP range per line.
Additionally, you can exclude boundary IP addresses through marking 'Exclude Boundary IPs' checkbox.
You should also enter netmask in which your IP pool fits in.
If you want to set nameservers and gateway click on 'Toggle Advanced Settings' .
Otherwise, press 'Add Pool' button and your IP pool will be created.

Afterwards, the confirm creation of a IP pool through pressing 'Add Pool' button.

Type IP addresses you want to add, separated by comma, after typing last IP address press 'Enter' button.
Afterwards, confirm creation of IP pool through pressing 'Add Pool' button.
Note 1: Using this option, you can only add IPv4 addresses.
Note 2: For each IP address added by this method, one IP pool will be created.

As you can see on the following scree, you can find here details of each IP pool.

To do so, press on option you want to alter.

To add a new custom field, press 'Create a New Custom Field' .
Afterwards, fill out the form with custom field name and value.

You can achieve that through using auto-complete textbox to find and choose client and pressing 'Save Changes' button.
Note: IP addresses will be added to all products ordered by client.

To facilitate the management of addresses we also added records filters.
Note: The screen below presents IP pool view with manually assigned service 'mytestingdomain.com'.

To issue such action, mark involved IP addresses and choose desired action from 'Action For Selected IP Addresses' dropdown menu.

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

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.

Some 3rd party integration submodules may need additional information provided along with IP address (like MAC address) this it place to add them.
To add custom field, press 'Add a New Custom Field' next to IP address you want to assign custom field to.

'IP Quantity' field defines quantity of IP addresses added to 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 at 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

Here we will show you how to set up configuration for it. 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.
Afterwards, press 'Create New Configuration' button. On the screen below you can see sample configuration with two products.

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

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 standard configuration.
When you are done press on 'Configurable Options' as shown on the screen below.

Enter quantity of IP addresses which will be assigned to each configurable option and press 'Save Changes' .

Note 1: Some of these integration submodules requires to set up free IP pools (cPanel) or IP addresses (Plesk) on servers.
Note 2: IP Manager can integrate multiple IP addresses to a single product.

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

Confirm through clicking 'Save Changes' .

1. Creates a DNS zone for each IP address assigned to a product.
2. First IP address assigned to a product is set up as a site dedicated IP address.

Due to that, setting up integration consist of 3 steps:
1. Create IP addresses pool which will be used for product.
2. Create configuration & assign previously created pool to it. No additional action is required in this step.
3. Go to product → 'Module Settings' tab and assign a previously created configuration in 'IP Manager' section.
Important: Assigning anything beyond the IP pool to the configuration in the IP Manager For WHMCS may cause unexpected effect in your WHMCS environment.

IP Manager For WHMCS cannot inject the first IP address for the VPS, due to the way SolusVM API works.
After the creation of a VPS, IP Manager is able to add additional IP addresses.
Therefore, if you are using this integration, we advise seting up IP Manager synchronization as a cron job.

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.

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

Note: File name has to end with 'Integration', for example 'NewSubmoduleIntegration.php'.

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

1. Configuration of 3rd party integration submodule.
2. Place code here assigning IP address to module product.
3. You can add code to unassign IP address here.

To export, go to the 'Export' tab, choose IP pool to export and file format.
Confirm through pressing 'Save Changes' button. Downloading of file will start shortly.
Note: Your 'storage' folder located at 'your_whmcs/modules/addons/ipmanager2' should have chmod set to 755.

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

• 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.
  
• IP address is used by a product, but do not exist in any IP Manager pool - a new pool 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, chose its format and press 'Import'.

Disabling 'Dedicated IP' field is crucial for VPS where IP address is bounded to physical machine.
Therefore we allow you to disable usage of 'Dedicated IP' field for specific configuration.
To do so, fill field marked on the following screen with configuration name and pressing 'Update Settings' button.

To enable email reminder, mark checkbox as shown on the following screen.
Afterwards, using textbox or slider, define value which exceeding will trigger email reminder.
Confirm changes by pressing 'Update Settings' button.

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

To remove an IP address from a product, press 'Unassign' .

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

Go to 'Setup' → 'Products/Services' → 'Product Addons' and press 'Add New Addon' .

Set pricing for addon by choosing 'Billing Cycle' and typing price.
Confirm through pressing 'Save Changes' button.

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

Afterwards, click 'Save Changes' button.

Here you can see the possible hooks:

before_ip_assign_hook($ip, $serviceid, $relation, $configid)
after_ip_assign_hook($ip, $serviceid, $relation, $configid)
before_ip_integrating_hook($ip, $service, $server)
after_ip_integrating_hook($ip, $service, $server)
before_ip_disintegrating_hook($ip, $service, $server)
after_ip_disintegrating_hook($ip, $service, $server)

You can find there hook, information about its time of run, return 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:

If you still have that problem, set chmod 777.