# WIPAM IP Management Addon

https://docs.wisecp.com/es/wipam-ip-management-addon

WIPAM keeps your own IP blocks inside WISECP and hands an address from the right pool to a service the moment an order arrives, so nobody allocates addresses by hand and the same address never reaches two customers.

## Screen Access

Go to **Tools** → **Addons** and click the **WIPAM** row. Address: `{admin}/tools/addons/WIPAM`

> **Premium Feature**
> 
> This module is included with the **Business Plan** at no additional cost. On other WISECP license plans you can add it to your existing license.

While the addon is off the list shows an **Enable** button. Enabling it installs the tables it needs and the notification template.

## What the Addon Does

The screen has six tabs. Each one answers a different question.

- **Dashboard**: How much of the pool is left, what needs you today (a block past its fill threshold, a configuration with no pool, addresses waiting to be bound, reservations past their waiting period) and the fullest blocks. Every figure opens the screen that can act on it. This is where you look before a pool runs out.
- **Subnets**: The inventory itself. Add, split and merge blocks; define excluded ranges and reservation rules here.
- **Configurations**: The rules that say how many addresses a product gets. This is what the allocation engine reads.
- **Integrations**: Drivers that also register the address on the service panel: cPanel, DirectAdmin and Plesk.
- **Tools**: Manual assignment, releasing, import and export, cleanup and the addon settings.
- **Logs**: Which address went to whom and when. Look here when a customer asks about their address.

### Automatic allocation

The engine runs on its own when an order is created, when a service becomes active and when an IP add-on is activated. It reads the configuration bound to the product, works out how many addresses are missing and fills the gap from the pool.

An unpaid order gets no address. Addresses of a cancelled service do not return to the pool; they stay **reserved** for the period set by **Released addresses wait**.

### The customer side

Customers see their own addresses on the **My IP Addresses** page of their account. The address also appears on a card on the service dashboard. Whether a customer may release an address is your decision.

## Before You Configure

- A valid WIPAM licence. Without one the screen still opens, but anything that hands out an address stops.
- An IP block you genuinely control. Addresses that come from a provider pool (Vultr, Hetzner, Linode) are outside this addon; there the provider owns them.
- If you want the address registered on a panel, that server needs a WISECP record and working credentials.

## Settings

Change these from the **Settings** card on the **Tools** tab.

- **Released addresses wait**: Default 7 days. A released address stays out of the pool that long, because it may still be in the customer DNS.
- **Log retention**: Default 90 days. Enter 0 and log rows are never removed.
- **Release on cancellation**: Default on. Turn it off and a cancelled service keeps its addresses until you decide.
- **Fill warning**: Default 90%. A block that reaches this level is flagged in the inventory and you get an e-mail. Enter 0 for no warning.
- **Customer may release**: Default on. While off the customer page is read only and you release addresses yourself.
- **Register address on panel**: Default on. While off the address is only recorded, not defined on the server panel.
- **List and batch limits**: How many free addresses the assignment dialog offers, and how many addresses one operation may touch.

## Setup and Operation

### Adding a block

1. Open the **Subnets** tab and click **Add Subnet** at the top right.
2. Write the block in CIDR form, then enter the gateway and the name servers.
3. Click **Save** at the bottom of the dialog; the block appears in the list with its fill level.

The gateway, the network address and the broadcast address leave the pool on their own. Any other range you want to hold back is defined from the **Exclusions** button on the row.

### Binding addresses to a product

1. On the **Configurations** tab click **Add Configuration**, give it a name and save.
2. Open the row, click **Add Product**, pick the product and enter how many IPv4 and IPv6 addresses it gets.
3. Use **Link Block** to choose the subnets the addresses come from.

From then on every order for that product gets its addresses without help. If you forget to link a block the engine has no pool to draw from and the service stays without an address.

### Assigning and releasing by hand

The **IP Addresses** card on the service detail lets you assign one address at a time or take one back. The card also shows how many addresses the service is owed and how many it holds.

### Registering the address on a server panel

1. Open the **Integrations** tab; installed drivers and connected servers are listed.
2. Pick a service or a server and click **Push to Panel**.
3. The outcome goes to the **Logs** tab, with the reason when an attempt fails.

### Monitoring and upkeep

Three daily jobs keep things tidy: one matches addresses already in use against the inventory, one returns expired reserved addresses to the pool, and one reports blocks that are filling up. Watch them from the **Automation** screen.

## Things to Watch

> **A deleted block does not come back**
> 
> Deleting a subnet also removes the address records inside it. If services are using those addresses, move them first.

> **A released address is not handed out at once**
> 
> An address you take back stays reserved until the waiting period ends. When a pool gets tight, adding a block is safer than shortening that period.

> **Clashing with a provider pool**
> 
> When a server module keeps its own IP pool, do not feed the same service from both sides. The module may take back an address it sees as surplus on its next sync.

## Required Privileges

Seeing the screen and running every operation needs the `PRODUCTS_OPERATION` privilege. An administrator without it cannot open the screen.

## Related Screens

- [Service Detail](https://docs.wisecp.com/en/service-detail-overview)
- [Automation](https://docs.wisecp.com/en/automation-overview)
- [Addons](https://docs.wisecp.com/en/addons)
