IPFlow for WHMCS

IP Inventory & Manual Assignments

This user guide covers daily IP management operations, manual assignment workflows, unassigning/releasing IP addresses, custom colored label tagging, and hardware binding in IPFlow.


Navigating the IP Inventory Table

The IP Addresses view (Addons > IPFlow > IP Addresses) provides a live, searchable overview of your entire IP inventory.

+-------------------------------------------------------------------------------------------------------+
| Search: [ 185.190.20... ] Status: [ All v ] Pool: [ All Pools v ] Labels: [ All v ] [ Filter ] [ Reset]|
| ----------------------------------------------------------------------------------------------------- |
| [ ] IP Address   | Status    | Pool Name      | Service / Client        | Labels     | Actions        |
| [ ] 185.190.20.2 | Free      | US-East Pool A | --                      | [ cPanel ] | [Assign] [Edit]|
| [ ] 185.190.20.3 | Assigned  | US-East Pool A | #104 - client@test.com  | [ VIP ]    | [Release][Edit]|
| [ ] 185.190.20.4 | Reserved  | US-East Pool A | Gateway IP              | --         | [Unreserve]    |
+-------------------------------------------------------------------------------------------------------+

Filtering & Search Options:

  • Search Bar: Search instantly by IP address, domain name, client name, or email.
  • Status Filter: View only Free, Assigned, Reserved, or Blacklisted addresses.
  • Subnet Pool: Narrow down to a specific pool or VLAN.
  • Custom Labels: Filter by tags (e.g. show all IPs marked Production or VIP).
  • Datacenter: Filter by specific physical datacenter facilities.

How to Use the 2-Step Assignment Wizard

When you need to manually bind an IP address to a customer’s hosting account or VPS, use the interactive assignment wizard:

+-------------------------------------------------------------------------------+
|                       Interactive IP Assignment Wizard                        |
+-------------------------------------------------------------------------------+
| Step 1: Select Client                                                         |
| [ Search client by name, company, email... (e.g. "John Smith")              ] |
| ----------------------------------------------------------------------------- |
| Step 2: Select Active Service                                                 |
| [ (Service #104) mysite.com - Cloud VPS KVM (Active)                        v]|
| ----------------------------------------------------------------------------- |
| [ Cancel ]                                         [ Confirm Assignment (OK) ]|
+-------------------------------------------------------------------------------+

Step-by-Step Instructions:

  1. In the IP Addresses table, locate any Free IP address and click the Assign action button.
  2. Step 1 (Find the Client):
  3. Type 2 or more letters of the client’s first name, last name, company, or email into the search box.
  4. Select the matching client from the instant dropdown.
  5. Step 2 (Select Customer Service):
  6. The dropdown will automatically load all active or pending services owned by that client.
  7. Choose the target hosting account, VPS, or dedicated server.
  8. Click Confirm Assignment.

IPFlow will instantly:
– Mark the IP address as Assigned.
– Update the customer’s dedicated IP field (tblhosting.dedicatedip) in WHMCS.
– Write a detailed entry to the IPFlow Audit Log recording your Administrator ID and timestamp.


Releasing / Unassigning an IP Address

When a customer cancels a service or you need to return an IP to the free pool manually:

  1. Locate the assigned IP in the IP Addresses table.
  2. Click the Release IP action icon.
  3. In the confirmation prompt, enter an optional note explaining the reason for release.
  4. Click Confirm Release.

The IP address will immediately return to Free status and become available for new customer orders.


Custom Colored Tags & Labels

Tags allow you to visually organize and categorize your IP addresses with colorful badges:

+-------------------------------------------------------------------------------+
| Manage Labels:  [ + Add New Label ]                                          |
|                                                                               |
| [ Production (#2563eb) ]   [ VIP Customer (#059669) ]   [ DDOS-Protected (#d97706) ]
+-------------------------------------------------------------------------------+

Creating & Managing Labels:

  1. Click the Manage Labels button above the IP table.
  2. Enter a label name (e.g. cPanel, Proxmox, Dirty, Monitoring).
  3. Pick a custom badge color using the color picker.
  4. Click Save Label.

Applying Labels in Bulk:

  1. Check the checkboxes next to the desired IP addresses in your table.
  2. In the floating bottom toolbar, click Apply Label and select the tag.
  3. IPFlow will apply the label across all selected addresses in one single bulk action.

Editing IP Metadata & Hardware Details

Click the Edit icon next to any IP address to configure hardware binding and geolocation metadata:

  • MAC Address: Enter an EUI-48 physical MAC address (e.g. 52:54:00:12:34:56).
  • Datacenter: Specify a facility or rack location (e.g., Equinix-LD4 or Hetzner-FSN1).
  • Assigned Server: Bind the IP to a specific physical server from your WHMCS server list.
  • Hardware Node: Specify a hypervisor hostname (e.g., kvm01.frankfurt).
  • Country Code: Assign a 2-letter country code (e.g., US, DE, FR, GB). IPFlow will automatically display the corresponding country flag emoji and vector badge next to the IP!