starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Overlay network support (notably VXLAN) #1478

New Issue
Closed
opened 2025-12-29 16:32:22 +01:00 by adam · 1 comment
adam commented 2025-12-29 16:32:22 +01:00
Owner
Copy Link

Originally created by @dzorgnotti on GitHub (Dec 28, 2017).

Issue type

[ X] Feature request
[ ] Bug report
[ ] Documentation

Environment

  • Python version: 3.6.1
  • NetBox version: 2.2.8

This has been a dupe several times, but I'll try to make a use case for it as this was missing the last time.

**Request support for overlay networks, especially with VXLAN. **

Use Case:
Overlay networks (e.g. managed by VMware NSX, Cisco ACI, etc.) are now being deployed more often to decouple virtual machine from the physical network resources, to support multi-tenant and/or multi-security zone environments. With the upcoming of GENEVE as a potential successor to VXLAN the thing is on the road to mainstream (my2c).

Without a proper support for the abstraction layer, systems are in limbo when it comes to documentation We can create a VM, we can assign IP addresses but be cannot assign a (overlay) network to these systems.
The same goes for the network infrastructure managing the overlay/underlay, e.g. we would need to define a gateway as a routing in/out tunnel device but can only create the physical (VLAN) side with netbox.
We tried a custom field but we've hit limits as this isn't shown by default and we lack some support in find/sort etc.

Required fields:

  1. Virtual Network Identifier (VNI) (perhaps additional to VLAN for assignment).
  2. VNI group (as an alternative to VLAN group)

VNI is a neutral expression which holds true for VXLAN or GENEVE deployments.
I would suggest to clone the VLAN field in the first instance but allow for an identifier of 24 bits (integer).

Optional (would be not as important today)

  • VTEP as a feature of a network device (hypervisor host, switch, router) with an IP, VLAN, control plane and control plane mode (e.g. EVPN, multicast, etc.) as possible options
  • Control Plane to VNI mapping

Examples:

  • VM is assigned an interface and an IP. IP/IP subnet is linked to a VNI.

  • A device can have VLAN interface but also one or more VNI interfaces.

  • A VNI is local or spans multiple sites

  • Best case: A hypervisor host has a VTEP A on VLAN B with IP C. Assigned to control plane D which is running in mode E. VNIs F-H are assigned to the control plane D. VMs I and J are running in the VNI, etc.

I am not sure I can contribute anything to Python, libraries etc.
#1725 #1058 #1324

Originally created by @dzorgnotti on GitHub (Dec 28, 2017). ### Issue type [ X] Feature request <!-- An enhancement of existing functionality --> [ ] Bug report <!-- Unexpected or erroneous behavior --> [ ] Documentation <!-- A modification to the documentation --> ### Environment * Python version: 3.6.1 * NetBox version: 2.2.8 This has been a dupe several times, but I'll try to make a use case for it as this was missing the last time. **Request support for overlay networks, especially with VXLAN. ** Use Case: Overlay networks (e.g. managed by VMware NSX, Cisco ACI, etc.) are now being deployed more often to decouple virtual machine from the physical network resources, to support multi-tenant and/or multi-security zone environments. With the upcoming of GENEVE as a potential successor to VXLAN the thing is on the road to mainstream (my2c). Without a proper support for the abstraction layer, systems are in limbo when it comes to documentation We can create a VM, we can assign IP addresses but be cannot assign a (overlay) network to these systems. The same goes for the network infrastructure managing the overlay/underlay, e.g. we would need to define a gateway as a routing in/out tunnel device but can only create the physical (VLAN) side with netbox. We tried a custom field but we've hit limits as this isn't shown by default and we lack some support in find/sort etc. Required fields: 1. Virtual Network Identifier (VNI) (perhaps additional to VLAN for assignment). 2. VNI group (as an alternative to VLAN group) VNI is a neutral expression which holds true for VXLAN or GENEVE deployments. I would suggest to clone the VLAN field in the first instance but allow for an identifier of 24 bits (integer). Optional (would be not as important today) - VTEP as a feature of a network device (hypervisor host, switch, router) with an IP, VLAN, control plane and control plane mode (e.g. EVPN, multicast, etc.) as possible options - Control Plane to VNI mapping Examples: - VM is assigned an interface and an IP. IP/IP subnet is linked to a VNI. - A device can have VLAN interface but also one or more VNI interfaces. - A VNI is local or spans multiple sites - Best case: A hypervisor host has a VTEP A on VLAN B with IP C. Assigned to control plane D which is running in mode E. VNIs F-H are assigned to the control plane D. VMs I and J are running in the VNI, etc. I am not sure I can contribute anything to Python, libraries etc. #1725 #1058 #1324
adam closed this issue 2025-12-29 16:32:23 +01:00
adam commented 2025-12-29 16:32:23 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 18, 2018):

While this would be an amazing feature, attempting to model the myriad approaches to overlay networking on the market today is too big a bite for us to take at this stage of NetBox's development. Sadly, I have to reject this request.

@jeremystretch commented on GitHub (Jul 18, 2018): While this would be an amazing feature, attempting to model the myriad approaches to overlay networking on the market today is too big a bite for us to take at this stage of NetBox's development. Sadly, I have to reject this request.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#1478
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?