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

Improve FHRP Group Assignments documentation in v3.1 beta #5673

New Issue
Closed
opened 2025-12-29 19:31:11 +01:00 by adam · 1 comment
adam commented 2025-12-29 19:31:11 +01:00
Owner
Copy Link

Originally created by @devon-mar on GitHub (Nov 16, 2021).

Originally assigned to: @jeremystretch on GitHub.

Change Type

Addition

Area

Functionality/features

Proposed Changes

The current documentation on FHRP Group Assignment mentions that FHRP groups are assigned to device and VM interfaces but doesn't mention where/how to do it.

I assumed that it would be on the "Edit Interface" or the "FHRP Group" page, but FHRP group assignment is actually done on the "Interface Details Page". This is inconsistent with other NetBox models. For example, IP assignment to devices/virtual machines is done on the "Edit" page, not the "IP Address Details" page.

I propose that the documentation mentions that assignment is done on the VM/device interface details page.

I can open a PR for this if this is a desired change.

Originally created by @devon-mar on GitHub (Nov 16, 2021). Originally assigned to: @jeremystretch on GitHub. ### Change Type Addition ### Area Functionality/features ### Proposed Changes The current documentation on [FHRP Group Assignment](https://netbox.readthedocs.io/en/feature/core-functionality/ipam/#fhrp-group-assignments) mentions that FHRP groups are assigned to device and VM interfaces but doesn't mention where/how to do it. I assumed that it would be on the "Edit Interface" or the "FHRP Group" page, but FHRP group assignment is actually done on the "Interface Details Page". This is inconsistent with other NetBox models. For example, IP assignment to devices/virtual machines is done on the "Edit" page, not the "IP Address Details" page. I propose that the documentation mentions that assignment is done on the VM/device interface details page. I can open a PR for this if this is a desired change.
adam added the status: acceptedtype: documentationbeta labels 2025-12-29 19:31:11 +01:00
adam closed this issue 2025-12-29 19:31:11 +01:00
adam commented 2025-12-29 19:31:11 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Nov 18, 2021):

This is inconsistent with other NetBox models.

This is very consistent with other models, as the assignment to an FHRP group is not done on the interface model itself, but rather through an intermediate model (FHRPGroupAssignment) which holds additional attributes of the assignment. Contact assignments work similarly, and this is also the reason images are not attached when editing an object, for example.

@jeremystretch commented on GitHub (Nov 18, 2021): > This is inconsistent with other NetBox models. This is very consistent with other models, as the assignment to an FHRP group is not done on the interface model itself, but rather through an intermediate model (FHRPGroupAssignment) which holds additional attributes of the assignment. Contact assignments work similarly, and this is also the reason images are not attached when editing an object, for example.
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 beta status: accepted type: documentation
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#5673
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?