With IP Manager, you can quickly assign IP addresses from a chosen IP pool to specific clients' products, effortlessly export IP subnets, and seamlessly integrate with third-party applications like cPanel.
Additionally, you can synchronize IP addresses used by products in your WHMCS with the module's IP subnets.
IP Manager also empowers your customers to manage their IP addresses directly from the WHMCS client area, providing them with greater control and convenience.
IP Manager streamlines IP address management, saving you time and effort while enhancing the customer experience.

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

Note: If you are still using any versions of IP Manager For WHMCS prior to v3.x, read about it here.

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

The 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 our client area → 'My Products'.

Log in to your WHMCS admin area and go to 'System Settings' → 'Addon Modules'.
Afterward, find 'IP Manager' and press the 'Activate' button.

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

The catalog is located in 'you_whmcs/modules/addons/IpManager3'.

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

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

Remember that it is crucial 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.

Correct bitmask ranges:

• IPv4 - 1 to 32
• IPv6 - 1 to 128

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

To do so, enter them into 'Excluded IP Addresses:' text field, one IP address or IP range per line.
Note: The beginning and end of an IP range should be separated by a hyphen. For example, 192.168.0.3-192.168.0.14.

Enter nameservers and gateway address into textboxes (this step is optional).
Afterward, finalize the creation of the subnet by pressing the 'Confirm' button.

You will find a list of subnets in a tree view.
If you add child subnets, you will be able to see them by clicking on the arrow sign next to the parent subnet.

• Split Subnet - divide the subnet into smaller subnets according to the chosen mask. Keep in mind that the subnet may include already assigned IP addresses.
  If you split such a subnet, the assigned IP addresses might be transferred to another subnet.
• Merge Subnet - use this option to join the 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 for the creation of subnets within a 'parent' subnet.
  Such child subnet may again be split/merged, and have its child subnets.
• Delete - use it to remove the subnet together with any IP address in it.

Important: If you have any IP reservation rules set up, do not include IP addresses here. This option should be used as a substitute for using rules.

Note: IP addresses will be added to all products ordered by the client and to all addons included in the products.

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.

To add a new custom field, press 'Edit'. Afterward, input the custom fields one per line in the following format: customFieldName: customFieldValue.
This option should be used if you do not specify default custom fields or want to add additional ones. Be careful not to double custom fields here.

Use action or mass actions buttons to do so.

Pick a service to assign the IP address to, and decide if you want to enable third-party integration.
Alternatively, switch to 'Custom Assignment' to reserve an IP address without linking it to any service in the database.

Here we will show you how to set up its configuration. In order to start, go to the 'Configurations' tab and click on the 'Create Configuration' button.

• IP Addresses Assignment - products, servers, addons, and configurable options will receive singular IP addresses.
• Subnet Assignment - whole separate subnets will be assigned to products, servers, addons, and configurable options.

Press textboxes corresponding to the options you wish to add, and select them from dropdown menus:

• Products
• Servers
• Addons
• Configurable Options
  

Click on the 'Confirm' button when finished.

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

• Manage additional Information: nameservers, gateway.
• Remove the subnet from the list.

The process is the same for each item. After creating a configuration, proceed to, for example the 'Products' tab and click on 'Edit'.

The new settings will be visible on the list.

See the sections below for more details.

• Omit "Dedicated IP" Field for: - The configurations you include in the field will not have the 'Dedicated IP' field present in the Client Area, instead assigned IP addresses or custom fields will be displayed.
• Switch to 'IP Addresses' Custom Field - Additional IP addresses can be stored in either the 'IP Addresses' custom field or 'Assigned IPs' field.
• Record All IP Addresses in History - When enabled, relations will be saved even in case of a server provisioning failure.
• Exclude Non-existent Entries from Logs - IP addresses without products or users will not be displayed in the 'Logs'.
• Handle IP Address During Downgrades - Automatically process the IP address when downgrading the configurable option.
• IP Address Reservation - If this option is enabled, the IP reservation rules will be used.
• IP Address Processing by Integration Module - The module ignores error messages from an external server and continues the action.
• IP Addresses Management in Client Area - Allows the clients to manage their assigned IP addresses in the Client Area.
• Subnet IP Address Shortage Notification - Enable to receive email notifications when a subnet is about to run out of available IP addresses.
• Exceeded Percentage Notifications - Email notifications will be sent after a subnet exceeds the percentage of available IP addresses defined here.

After making any changes in those settings, press 'Save Settings'.

• Add IP Addresses to Hosting- IP addresses are added to hosting if a relation exists.
• Remove Non-existent IP Addresses (Hosting) from History- IP address relations are removed if an IP address is not assigned to any hosting.
• Remove Non-existent IP Addresses from Hosting - If an IP address does not exist in any subnet, it is removed from hosting.
• Add Module IP Addresses to History- Create IP address' relation if it does not already exist.
• Remove Non-existent IP Addresses from History - If the IP address does not exist in any subnet, it is removed from relations.
• Enable Non-existent in History IP Addresses - Set the IP address as unassigned if its relation does not exist.

After making changes in those settings, press 'Save Settings'.
Otherwise, settings will not be saved and the cleaner will run using the old configuration.

For example, when you manually remove a product with IP addresses assigned or remove an IP subnet.
To start IP Addresses Cleaner, and trigger the selected options, execute the following command:

php -q /yourWHMCS/modules/addons/IpManager3/cron/cron.php clean

To export, go to the 'Export' tab, and choose the subnet to export and output format.
Now you can generate and download the file.
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 subnets.

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

Here is the script that can be used to synchronize the IP addresses:

php -q /yourWHMCS/modules/addons/IpManager3/cron/cron.php Import

Running the script will import all IP addresses into subnets.
If you wish, you can synchronize only specified services by putting their IDs separated by a coma as an argument.

php -q /yourWHMCS/modules/addons/IpManager3/cron/cron.php Import 1,2,3

Moreover, you can keep the synchronization running continuously by setting up a cron.

File Upload
To import IP addresses from a file, click on the 'Upload File' button, include the file and 'Confirm'.
The file has to be of either .csv; .xml or .json format.

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.

Start by pressing the 'Status' toggle button next to the module you want to activate and press the 'Edit' button.

If the configurations you assigned feature the 'Subnet' assignment type, you can choose if all or only the first IP address should be automatically assigned.
If you only included configurations with the 'IP Addresses' assignment type, you can ignore this option, it will not affect anything.

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

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 3 steps:
1. Create the subnet of IP addresses that will be used for the 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 virtual machine.

In the case of Proxmox VE Cloud VPS For WHMCS module, the IP addresses assigned to the service will be assigned to virtual machines 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.

IP Manager For WHMCS cannot inject the first IP address to 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 use this integration, we advise setting up IP Manager synchronization as a cron job.

1. First, create a new folder in 'your_whmcs/modules/addons/IpManager3/app/Modules/ '.

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

<?php

namespace ModulesGarden\IpManager3\App\Modules\IntegrationCustom;


use ModulesGarden\IpManager3\App\Services\ModulesService\IntegrationModule;
use function ModulesGarden\IpManager3\App\Modules\logModuleCall;

class Integration extends IntegrationModule
{
    public function getName(): string
    {
        return 'Custom Integration';
    }
    
    public function getDescription(): string
    {
        return 'Custom integration Module description.';
    }
    
    public function getModuleType(): string
    {
        return 'Custom';
    }
    
    public function showConfiguration(): string
    {
        return '';
    }
    
    public function setIPAddress($ip, $service, $server, $pool, $iteration)
    {
    }
    
    public function unsetIPAddress($ip, $service = null, $server = null) 
    {
    }


}

• The class name should be the same as the file name.
• 'getName' defines the submodule name visible in IP Manager.
• 'getDescription' defines the submodule description displayed in IP Manager.

Click on the 'Create Rule' button to formulate a new rule.

To illustrate:
If you enter n in the 'Rule' field, then the first IP address from a subnet will always be excluded. It will be reserved and it will not be assigned to any client or service.