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

Device Roles in Device Types #9897

New Issue
Closed
opened 2025-12-29 21:24:07 +01:00 by adam · 5 comments
adam commented 2025-12-29 21:24:07 +01:00
Owner
Copy Link

Originally created by @LHBL2003 on GitHub (Jun 25, 2024).

NetBox version

v4.0.3

Feature type

Data model extension

Proposed functionality

Add the Device Roles field as optional in Device Types

image

and enable the enumeration in the Device Roles properties under "Related Objects".
image

The number should then also be listed in the Device Roles area.
image

Use case

In Netbox, we maintain the device roles for the devices and VMs. These are often designations such as firewall, printer, fax, access point, etc. Most roles are hardware-specific. We would also like to reuse the device roles in the Device Types area. At the moment, we have solved this by using a TAG with the same name or by creating a customer field. However, after clicking on the link under "Related Objects" in the Customer Field, the Device Types area is not displayed, which is not so nice.

We would therefore prefer a proper integration of the Device Role field. Or the adjustment that the Device Types are also listed under Related Objects.

Database changes

No response

External dependencies

No response

Originally created by @LHBL2003 on GitHub (Jun 25, 2024). ### NetBox version v4.0.3 ### Feature type Data model extension ### Proposed functionality Add the Device Roles field as optional in Device Types ![image](https://github.com/netbox-community/netbox/assets/46369917/ddf02c23-76ba-4bd6-9f76-dad31178d94f) and enable the enumeration in the Device Roles properties under "Related Objects". ![image](https://github.com/netbox-community/netbox/assets/46369917/5ce53f7d-d8c5-4da4-a388-cd31151bf331) The number should then also be listed in the Device Roles area. ![image](https://github.com/netbox-community/netbox/assets/46369917/7a1bf751-6552-45f5-aea3-6d4cbd9c22b5) ### Use case In Netbox, we maintain the device roles for the devices and VMs. These are often designations such as firewall, printer, fax, access point, etc. Most roles are hardware-specific. We would also like to reuse the device roles in the Device Types area. At the moment, we have solved this by using a TAG with the same name or by creating a customer field. However, after clicking on the link under "Related Objects" in the Customer Field, the Device Types area is not displayed, which is not so nice. We would therefore prefer a proper integration of the Device Role field. Or the adjustment that the Device Types are also listed under Related Objects. ### Database changes _No response_ ### External dependencies _No response_
adam added the type: featurepending closurestatus: under reviewnetbox labels 2025-12-29 21:24:07 +01:00
adam closed this issue 2025-12-29 21:24:07 +01:00
adam commented 2025-12-29 21:24:08 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 25, 2024):

Add the Device Roles field as optional in Device Types

This would not make sense as there is no consistent correlation between a device type and role: A single device type may function in one of several different roles depending on how it is deployed. For example, a single model of switch might be used as either a core, distribution, or access switch; a particular router might be used in the backbone or at the edge.

and enable the enumeration in the Device Roles properties under "Related Objects".

It might be feasible to include statistics about the number of roles in which each device type has been deployed without altering the current model. Is this what you're after?

@jeremystretch commented on GitHub (Jun 25, 2024): > Add the Device Roles field as optional in Device Types This would not make sense as there is no consistent correlation between a device type and role: A single device type may function in one of several different roles depending on how it is deployed. For example, a single model of switch might be used as either a core, distribution, or access switch; a particular router might be used in the backbone or at the edge. > and enable the enumeration in the Device Roles properties under "Related Objects". It might be feasible to include statistics about the number of roles in which each device type has been deployed without altering the current model. Is this what you're after?
adam commented 2025-12-29 21:24:08 +01:00
Author
Owner
Copy Link

@sleepinggenius2 commented on GitHub (Jun 25, 2024):

I just added this as a multi-object custom field on Device Types within our environment, so that it can be used within a custom validator and for filtering. To @jeremystretch's point, a single model can generally have multiple roles, which is why we implemented it as a multi-object field. It would be nice to integrate that functionality into the core, but so far the custom configuration seems to be working in our environment.

@sleepinggenius2 commented on GitHub (Jun 25, 2024): I just added this as a multi-object custom field on Device Types within our environment, so that it can be used within a custom validator and for filtering. To @jeremystretch's point, a single model can generally have multiple roles, which is why we implemented it as a multi-object field. It would be nice to integrate that functionality into the core, but so far the custom configuration seems to be working in our environment.
adam commented 2025-12-29 21:24:08 +01:00
Author
Owner
Copy Link

@LHBL2003 commented on GitHub (Jun 26, 2024):

This would not make sense as there is no consistent correlation between a device type and role: A single device type may function in one of several different roles depending on how it is deployed. For example, a single model of switch might be used as either a core, distribution, or access switch; a particular router might be used in the backbone or at the edge.

At first I didn't understand why you didn't think it made sense. Until I understood your point of view. :D In a nutshell: The device role on the device type is primarily used to group the device types, as the device roles are 90% identical to those of the device instances. Of course, it would also be nice if the stored device role were proposed as a template when a device instance is created, as it can be changed when it is created if necessary. But I hadn't thought that far ahead, as the device role should primarily be used to group the device types.

image

As with the VMs, you could also create a checkbox for the device roles so that the device role is displayed or not displayed for the device types.
image

So if I want to filter how many models of managed switches we have, I have to create a TAG parallel to the device role or implement the device role as a customer field.

Disadvantage A: No coloring as with device instances and VMs
image

and enable the enumeration in the Device Roles properties under "Related Objects".

Disadvantage B: After clicking on the link "Switch l LAN Managed (SW)", the device type is not listed. This is nice for the devices because you can filter quickly by clicking on the number. Provided that you have not filtered before and would like to do so using this method.
image

@LHBL2003 commented on GitHub (Jun 26, 2024): > This would not make sense as there is no consistent correlation between a device type and role: A single device type may function in one of several different roles depending on how it is deployed. For example, a single model of switch might be used as either a core, distribution, or access switch; a particular router might be used in the backbone or at the edge. At first I didn't understand why you didn't think it made sense. Until I understood your point of view. :D In a nutshell: The device role on the device type is primarily used to group the device types, as the device roles are 90% identical to those of the device instances. Of course, it would also be nice if the stored device role were proposed as a template when a device instance is created, as it can be changed when it is created if necessary. But I hadn't thought that far ahead, as the device role should primarily be used to group the device types. ![image](https://github.com/netbox-community/netbox/assets/46369917/a682861d-a5fa-42d7-b55e-1c693d74a5dc) As with the VMs, you could also create a checkbox for the device roles so that the device role is displayed or not displayed for the device types. ![image](https://github.com/netbox-community/netbox/assets/46369917/128e188c-8623-4523-8514-f2174840047e) So if I want to filter how many models of managed switches we have, I have to create a TAG parallel to the device role or implement the device role as a customer field. Disadvantage A: No coloring as with device instances and VMs ![image](https://github.com/netbox-community/netbox/assets/46369917/795f015b-071c-4217-8a28-34a8a69f0ab2) > and enable the enumeration in the Device Roles properties under "Related Objects". Disadvantage B: After clicking on the link "Switch l LAN Managed (SW)", the device type is not listed. This is nice for the devices because you can filter quickly by clicking on the number. Provided that you have not filtered before and would like to do so using this method. ![image](https://github.com/netbox-community/netbox/assets/46369917/18c11b41-f12a-4d25-b311-ccebd602e334)
adam commented 2025-12-29 21:24:08 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Sep 25, 2024):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Sep 25, 2024): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 21:24:09 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Oct 25, 2024):

This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.

@github-actions[bot] commented on GitHub (Oct 25, 2024): This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.
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 netbox pending closure status: under review type: feature
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#9897
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?