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

Vlan Members for API #3846

New Issue
Closed
opened 2025-12-29 18:31:35 +01:00 by adam · 3 comments
adam commented 2025-12-29 18:31:35 +01:00
Owner
Copy Link

Originally created by @DCAuto on GitHub (Jul 8, 2020).

Environment

  • Python version: 3.6.8
  • NetBox version: 2.8.7

Proposed Functionality

Make Vlan Members available via the API. I don't believe there is a better way to do it via the API than sifting through every interface. The GUI has that functionality, and was hoping to include it in the API

Use Case

Quickly verify every interface that a vlan is configured, without needing to check every interface.

Currently, I'm trying to verify that if a device has a vlan configured on one of it's interfaces, that a corresponding virtual interface is created.

Database Changes

I believe the Netbox DB currently has this functionality as the GUI is already doing it.

External Dependencies

None.

Originally created by @DCAuto on GitHub (Jul 8, 2020). <!-- NOTE: IF YOUR ISSUE DOES NOT FOLLOW THIS TEMPLATE, IT WILL BE CLOSED. This form is only for proposing specific new features or enhancements. If you have a general idea or question, please post to our mailing list instead of opening an issue: https://groups.google.com/forum/#!forum/netbox-discuss NOTE: Due to an excessive backlog of feature requests, we are not currently accepting any proposals which significantly extend NetBox's feature scope. Please describe the environment in which you are running NetBox. Be sure that you are running an unmodified instance of the latest stable release before submitting a bug report. --> ### Environment * Python version: 3.6.8 * NetBox version: 2.8.7 <!-- Describe in detail the new functionality you are proposing. Include any specific changes to work flows, data models, or the user interface. --> ### Proposed Functionality Make Vlan Members available via the API. I don't believe there is a better way to do it via the API than sifting through every interface. The GUI has that functionality, and was hoping to include it in the API <!-- Convey an example use case for your proposed feature. Write from the perspective of a NetBox user who would benefit from the proposed functionality and describe how. ---> ### Use Case Quickly verify every interface that a vlan is configured, without needing to check every interface. Currently, I'm trying to verify that if a device has a vlan configured on one of it's interfaces, that a corresponding virtual interface is created. <!-- Note any changes to the database schema necessary to support the new feature. For example, does the proposal require adding a new model or field? (Not all new features require database changes.) ---> ### Database Changes I believe the Netbox DB currently has this functionality as the GUI is already doing it. <!-- List any new dependencies on external libraries or services that this new feature would introduce. For example, does the proposal require the installation of a new Python package? (Not all new features introduce new dependencies.) --> ### External Dependencies None.
adam closed this issue 2025-12-29 18:31:35 +01:00
adam commented 2025-12-29 18:31:35 +01:00
Author
Owner
Copy Link

@DCAuto commented on GitHub (Jul 8, 2020):

I'm dumb....sorry for wasting your time :)

@DCAuto commented on GitHub (Jul 8, 2020): I'm dumb....sorry for wasting your time :)
adam commented 2025-12-29 18:31:35 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 8, 2020):

For anyone else who happens upon this issue, I assume this is what you ended up doing:

GET /api/dcim/interfaces/?vlan_id=<PK>

Or:

GET /api/dcim/interfaces/?vlan=<VLAN ID>
@jeremystretch commented on GitHub (Jul 8, 2020): For anyone else who [happens upon](https://xkcd.com/979/) this issue, I assume this is what you ended up doing: ``` GET /api/dcim/interfaces/?vlan_id=<PK> ``` Or: ``` GET /api/dcim/interfaces/?vlan=<VLAN ID> ```
adam commented 2025-12-29 18:31:35 +01:00
Author
Owner
Copy Link

@DCAuto commented on GitHub (Jul 8, 2020):

Yes that fixed it.

@DCAuto commented on GitHub (Jul 8, 2020): Yes that fixed it.
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#3846
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?