Unable to select VLANs on Device Interfaces where they are scoped by Cluster or Cluster Groups

[stuntguy3000]

NetBox version

v3.5.3-dev

Python version

3.8

Expected Behavior

I expect the available VLANs to include those defined by Cluster or Cluster Group scopes.

Observed Behavior

They are not shown as available options.

---

Steps to Reproduce

Create the following Virtualization objects:

• Create a Cluster Type named Generic Cluster Type
• Create a Cluster Group named Cluster Group 1
• Create a Cluster named Ungrouped Cluster
• Create a Cluster named Grouped Cluster (Group: Cluster Group 1)
  
• Create a Virtual Machine named Ungrouped Cluster VM (Cluster: Ungrouped Cluster)
• Create a Virtual Machine named Grouped Cluster VM (Cluster: Grouped Cluster)
  

Create the following IPAM objects:

• Create a VLAN Group named Cluster Group 1 VG (Scope: Cluster Group, Cluster Group 1)
• Create a VLAN Group named Grouped Cluster VG (Scope: Cluster, Grouped Cluster)
  
• Create a VLAN named Alpha (Group: Cluster Group 1 VG)
• Create a VLAN named Beta (Group: Grouped Cluster VG)
  

Create the following Organization objects:

• Create a Site named Generic Site

Create the following Device objects:

• Create a Manufacturer named Generic Manufacturer
• Create a Device Type named Generic Model (Manufacturer: Generic Manufacturer)
• Create a Device Role named Generic Role
• Create a Device named Grouped Cluster Device (Role: Generic Role, Type: Generic Model, Site: Generic Site, Virtualization Cluster: Grouped Cluster)
• Create a Device named Ungrouped Cluster Device (Role: Generic Role, Type: Generic Model, Site: Generic Site, Virtualization Cluster: Ungrouped Cluster)
  
• Add an Interface (of any type) to Grouped Cluster Device named Generic Interface
• Add an Interface (of any type) to Ungrouped Cluster Device named Generic Interface

Finally... replicate the issue:

• Attempt to add a untagged or tagged VLAN to each device's interface
  
  

This is the issue - no VLANS will be present, including those which should be

---

Notes

This issue has been resolved in a branch in my fork. If this issue has been resolved this will be submitted as a new PR addressing this specific issue.

This issue only applies to Devices, but not Virtual Machines.

I hope this isn't death by information, please let me know if I can do anything more to get this accepted and resolved (including a video walkthrough or database object dump).

References

This section of code already exists and performs the correct filtering.

This section of the code are my changes which adds this correct filtering/resolves this issue.

[stuntguy3000]

Ready for review.

[stuntguy3000]

Sorry for the bump @jeremystretch, I've got a code fix for this ready to go as you requested in the previous issue - will create a PR if/when this is accepted.

[SteveRodrigue]

@stuntguy3000 : Thanks to have reformatted the original issue. Also, thank you very to have proposed a solution.

I just tested https://demo.netbox.dev and I confirm the problem is still present. The current workaround I found is to assign vlan(s) using the API directly.

[stuntguy3000]

I still have a PR for this, #12708

[jsenecal]

@DanSheps as you already interacted with issue #12690, do you feel the steps described here are sufficient to replicate the issue ? Feels like the solution is simple enough.

[jeremystretch]

@stuntguy3000 thank you for providing comprehensive reproduction steps.

While I believe I understand the use case, I'll posit a conflicting use case. Consider a scenario wherein a VLAN is shared among virtual machines within a cluster, but not available to the host device. (This is a quite common solution to providing isolated L2 domains.) In such a scenario, I definitely don't want to consider the VLAN as being available on the host device, which is why the available_on_device VLAN filter does not currently consider cluster assignment.

This should really be a feature request rather than a bug report, proposing that cluster assignment be considered when determining the VLANs available on a device.

[stuntguy3000]

@stuntguy3000 thank you for providing comprehensive reproduction steps.

While I believe I understand the use case, I'll posit a conflicting use case. Consider a scenario wherein a VLAN is shared among virtual machines within a cluster, but not available to the host device. (This is a quite common solution to providing isolated L2 domains.) In such a scenario, I definitely don't want to consider the VLAN as being available on the host device, which is why the available_on_device VLAN filter does not currently consider cluster assignment.

This should really be a feature request rather than a bug report, proposing that cluster assignment be considered when determining the VLANs available on a device.

I definitely follow you, in that scenario then it makes sense to not show the vlan. However, I believe that usage would be less common than people who use fully-connected virtual groups and hosts.

My rationale is that, simply put, not having VLANs visible make it harder to document entire Clusters and Cluster Groups where VLANs are usually stretched across VM Hosts and their associated VMs.

Alternatively, I could see an introduction of VM Groups within Clusters, hypothetically where these isolated VLANs could be scoped too. These groups would roughly represent Folders that contain VMs. I believe that is an elegant solution to your use case.

[Chiniquy]

Just ran into the same issue when trying to model VLAN usage for virtual interfaces on a Palo Alto firewall. What is required as a next step to get something actionable here? A feature request?