Support for nested vlan groups #3721

Closed
opened 2025-12-29 18:30:46 +01:00 by adam · 1 comment
Owner

Originally created by @ryanmerolle on GitHub (May 22, 2020).

Environment

  • Python version: 3.6.9
  • NetBox version: 2.8.4

Proposed Functionality

Currently, as per the documentation:

VLAN groups can be used to organize VLANs within NetBox. Groups can also be used to enforce uniqueness: Each VLAN within a group must have a unique ID and name. VLANs which are not assigned to a group may have overlapping names and IDs (including VLANs which belong to a common site). For example, you can create two VLANs with ID 123, but they cannot both be assigned to the same group.

It would be useful to allow for VLAN Groups to nest similar to rack groups. Any VLAN ids present in the parent would be inherited/removed from available in the child groups. When querying the API for associated VLANs in a VLAN Group, the API would return the VLAN ids including the ids from its parent.

Use Case

This would be useful for

  • VXLAN stretched across a L3 Spine & Leaf or even among datacenters (in no way would this scope include support of VXLAN / VNI mappings)
  • Simplifying VLAN tracking of common VLANs that are present at across a number of groups (native VLAN 1 / 999)

Database Changes

  • A model similar to rack_groups, with a new 'parent' field would need to be introduced to allow nested VLAN groups.
  • Inheritance of VLAN ids from parent and "long" nests could create challenges and may dictate a need to cap the number of nested groups allowed.
  • Alternatively, a single nest could be achieved using a parent child relationship similar to how device bay relationships are handled.

External Dependencies

N/A

Originally created by @ryanmerolle on GitHub (May 22, 2020). ### Environment * Python version: 3.6.9 * NetBox version: 2.8.4 ### Proposed Functionality Currently, as per the documentation: > VLAN groups can be used to organize VLANs within NetBox. Groups can also be used to enforce uniqueness: Each VLAN within a group must have a unique ID and name. VLANs which are not assigned to a group may have overlapping names and IDs (including VLANs which belong to a common site). For example, you can create two VLANs with ID 123, but they cannot both be assigned to the same group. It would be useful to allow for VLAN Groups to nest similar to rack groups. Any VLAN ids present in the parent would be inherited/removed from available in the child groups. When querying the API for associated VLANs in a VLAN Group, the API would return the VLAN ids including the ids from its parent. ### Use Case This would be useful for - VXLAN stretched across a L3 Spine & Leaf or even among datacenters (in no way would this scope include support of VXLAN / VNI mappings) - Simplifying VLAN tracking of common VLANs that are present at across a number of groups (native VLAN 1 / 999) ### Database Changes - A model similar to rack_groups, with a new 'parent' field would need to be introduced to allow nested VLAN groups. - Inheritance of VLAN ids from parent and "long" nests could create challenges and may dictate a need to cap the number of nested groups allowed. - Alternatively, a single nest could be achieved using a parent child relationship similar to how device bay relationships are handled. ### External Dependencies N/A
adam closed this issue 2025-12-29 18:30:46 +01:00
Author
Owner

@ryanmerolle commented on GitHub (May 23, 2020):

Closing for now. I realized it’s just not a high ROI item right now.

@ryanmerolle commented on GitHub (May 23, 2020): Closing for now. I realized it’s just not a high ROI item right now.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#3721