Add an “exclude_from_allocation” flag to IPRange #868

New Issue

MrUnknownDE · 2026-04-05T18:21:39+02:00

MrUnknownDE commented

2026-04-05 18:21:39 +02:00

Originally created by @a-belhadj on 11/17/2025

NetBox version

v4.4.5

Feature type

Data model extension

Proposed functionality

Introduce a new boolean field on IPRange objects: exclude_from_allocation = true | false

This flag would instruct NetBox to exclude the corresponding range from the automatic IP allocator (e.g. /prefixes/{id}/available-ips/) without preventing manual creation of IPAddress objects inside that range.

This solves the current limitation where populated = true simultaneously:

prevents allocation (desired)
but also blocks manual creation of IP addresses (undesired)

The two concepts mark_populated and exclude_from_allocator need to be separated to address real-world use cases

Use case

In NetBox 4.3+, the behavior of IP allocation inside a prefix has changed.

This change introduced a new side effect. When an IPRange is marked populated = true, it is impossible to create an IPAddress manually inside that range.

This was not the behavior in 4.2, and it breaks my workflow where an external system allocates IPs (OpenStack), and NetBox must record those IPs afterward (for DNS purposes).

My objects:

PrefixCAN:
  id: 1
  prefix: 192.168.0.0/24

IPRangeOpenstack:
  id: 2
  range: 192.168.0.0 - 192.168.0.100
  description: OpenStack floating IPs

Workflow before NetBox 4.3

VMware IPs were allocated from the prefix using the API POST /api/ipam/prefixes/1/available-ips/
NetBox automatically skipped IPs inside all IPRanges when calculating the next available IP.
This avoided collisions with IPs managed externally by OpenStack and probably already used.
When OpenStack assigned a floating IP (e.g. 192.168.0.50), we could still manually create an IPAddress in NetBox with the following

POST /api/ipam/ip-addresses/
{
"address": "192.168.0.50/24",
"dns_name": api.myopenshift.domain.com",
"description": "API for OCP cluster #1"
}

Problem in NetBox 4.3+

To preserve the old allocation behavior, the current recommendation is to set mark_populated = true

This successfully prevents the allocator from picking an IP inside the OpenStack range when doing a POST /api/ipam/prefixes/1/available-ips/

However, once mark_populated=true is set, NetBox rejects any manual creation of IP addresses in that same range:

Cannot create IP address 192.168.0.50/24 inside range 192.168.0.0-192.168.0.100.

This makes it impossible to record floating IPs that are allocated by OpenStack but must still be present in NetBox to manage DNS records.

Database changes

class IPRange:
  exclude_from_allocation = models.BooleanField(
      default=False,
      help_text="Exclude this range from automatic IP allocation"
  )

External dependencies

No response

*Originally created by @a-belhadj on 11/17/2025* ### NetBox version v4.4.5 ### Feature type Data model extension ### Proposed functionality Introduce a new boolean field on **IPRange** objects: `exclude_from_allocation = true | false` This flag would instruct NetBox to **exclude the corresponding range from the automatic IP allocator** (e.g. `/prefixes/{id}/available-ips/`) **without preventing manual creation of IPAddress objects inside that range**. This solves the current limitation where `populated = true` simultaneously: - prevents allocation (desired) - but also blocks manual creation of IP addresses (undesired) The two concepts `mark_populated` and `exclude_from_allocator` need to be separated to address real-world use cases ### Use case In NetBox 4.3+, the behavior of IP allocation inside a prefix has changed. This change introduced a new side effect. When an IPRange is marked `populated = true`, it is impossible to create an IPAddress manually inside that range. This was not the behavior in 4.2, and it breaks my workflow where an external system allocates IPs (OpenStack), and NetBox must record those IPs afterward (for DNS purposes). --- My objects: ```yaml PrefixCAN: id: 1 prefix: 192.168.0.0/24 IPRangeOpenstack: id: 2 range: 192.168.0.0 - 192.168.0.100 description: OpenStack floating IPs ``` --- #### Workflow before NetBox 4.3 - VMware IPs were allocated from the prefix using the API `POST /api/ipam/prefixes/1/available-ips/` - NetBox automatically **skipped IPs inside all IPRanges** when calculating the next available IP. This avoided collisions with IPs managed externally by OpenStack and probably already used. - When OpenStack assigned a floating IP (e.g. `192.168.0.50`), we could still **manually create** an IPAddress in NetBox with the following ``` POST /api/ipam/ip-addresses/ { "address": "192.168.0.50/24", "dns_name": api.myopenshift.domain.com", "description": "API for OCP cluster #1" } ``` #### Problem in NetBox 4.3+ To preserve the old allocation behavior, the current recommendation is to set `mark_populated = true` This successfully prevents the allocator from picking an IP inside the OpenStack range when doing a `POST /api/ipam/prefixes/1/available-ips/` However, once `mark_populated=true` is set, NetBox **rejects any manual creation of IP addresses** in that same range: ``` Cannot create IP address 192.168.0.50/24 inside range 192.168.0.0-192.168.0.100. ``` This makes it impossible to record floating IPs that are allocated by OpenStack but must still be present in NetBox to manage DNS records. ### Database changes ```python class IPRange: exclude_from_allocation = models.BooleanField( default=False, help_text="Exclude this range from automatic IP allocation" ) ``` ### External dependencies _No response_

MrUnknownDE closed this issue

2026-04-05 18:21:39 +02:00

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

No Label netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#868