With our module you will be also able to assign an IP pool to 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 the module's IP blocks and 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 in '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.

There are four ways to do that. You can use CIDR notation, enter IP addresses range, provide a full list of IP addresses or create IP blocks for subnets.

Note 1: IP addresses range and IP addresses list support IPv4 only.
Note 2: IPv6 pools rely on IP addresses range. Additionally, only assigned IP addresses are stored in the database.
Therefore free IPv6 addresses will not be visible in the IP pool overview.
Note 3: IP Block Assigned For Subnet feature is currently available for IPv6 only.

Select IP version, type the first IP address from a pool and a netmask (in prefix notation).
Note: The 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' checkbox.
If you want to set nameservers and gateway click on 'Toggle Advanced Settings'.

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' checkbox.
You should also enter netmask 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, confirm creation of an IP pool through pressing 'Add Pool' button.

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

Finally press Add Pool button.
Note 1: This option supports only IPv6 addresses.

As you can see on the following screen, you can find here a list of IP Pools and a list of IP Blocks.

To do so, press the 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 choose the client and pressing 'Save Changes' button.
Note: IP addresses will be added to all products ordered by client.

We also added records' filters to facilitate the management of addresses.

To issue such action, mark involved IP addresses and choose desired action from 'Action For Selected IP Addresses' dropdown menu.
Afterwards, confirm your choice through pressing 'Save Changes'.

• Delete From The Pool - as its name suggests, removes IP addresses from a pool.
• Unassign - removes IP addresses from products they were assigned to, IP addresses still remain 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 which IP addresses should be assigned to.
  • 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 each involved IP address.

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

Pool details

• Maximum available subnets in the block
• Number of subnets that can be generated
• Number of already generated subnets
• Number of generated and ready to be assigned subnets
• Subnets CIDR
• Available address in the subnet
  

Additional Information

• Nameservers
• Gateway

  Manage the block additional information just like it was described in case of IP pools management
  

Usage

• Percentage graph on generated subnets
• Percentage graph on subnets assignment
  

Actions

• Delete button
  

IP Block Details

1. Block and its usage details
2. Pool details
3. Address range
4. Services assigned
5. Username
6. Client Name
7. Custom Fields
   • Press Create a New Custom Field to generate
8. Available actions:
   • Assign To
   • Unassign
   • Delete
     

IP Addresses In Pool

1. IP Address in the pool
2. Full IP address

'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

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.
Afterwards, press 'Create New Configuration' button. On the screen below you can see sample configuration with two products.

Note: It is possible to assign IPs using either pools or blocks! You are not allowed to assign both to one configuration.
Let's start with Assigning pools.

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

To do so, press Assigned Blocks in the 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 a standard configuration.
Once it is done press '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 require free IP pools (cPanel) or IP addresses (Plesk) on servers to be set up.
Note 2: IP Manager can integrate multiple IP addresses with 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. The first IP address assigned to a product is set up as a site dedicated IP address.

Due to that, setting up the integration consists of 3 steps:
1. Create IP addresses pool which will be used for product.
2. Create configuration and assign a previously created pool to it. No additional action is required in this step.

Important: Assigning anything beyond the IP pool to the configuration in IP Manager For WHMCS may cause unexpected effect in your WHMCS environment.

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 are using this integration, we advise setting 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 displayed in IP Manager.
4. Place here an integrating module name ( the best way is to copy a folder name of the module ).

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.

To export, go to 'Export' tab, choose IP pool to export and file format.
Confirm through pressing 'Save Changes' button. Download of the file will start shortly.
Note: Your 'storage' folder located in '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 does 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, choose its format and press 'Import'.

IP Manager For WHMCS allows you to define its behavior, therefore make sure you configure settings that suit you needs.

• Assignment Process Settings
  1. For any configuration you provide into this field, '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 product or user will not be displayed in 'IP Logs' page.
• Email Reminder Settings
  1. If you check this checkbox, you will receive an email with notification about IP pools running out of IP addresses.
  2. Enables you to define percentage value which, when exceeded by any IP pool, results in a notification being sent.

• 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 IP pool, it is removed from hosting.
  4. Create IP address' relation if it does not exist.
  5. If IP address does not exist in any IP pool, 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.

For example, when you manually remove a product with IP addresses assigned or remove an IP pool.
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.

Module allows your customers to view IP addresses assigned to their product and order additional 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 a 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 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 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:

If you still have that problem, set chmod 777.