Automated Interface Renaming Based on Virtual Chassis Member Position #189

New Issue

MrUnknownDE · 2026-04-05T16:22:46+02:00

MrUnknownDE commented

2026-04-05 16:22:46 +02:00

Originally created by @greatmerlin on 3/9/2026

NetBox version

v4.5.2-Docker-4.0.0

Feature type

Change to existing functionality

Proposed functionality

I propose enhancing the Virtual Chassis (VC) logic to allow for dynamic, pattern-based interface renaming when a Device is assigned a position (Member ID) within a Virtual Chassis.

Currently, NetBox treats interface names as static strings. When a device is added to a VC and assigned a position (e.g., Position 2), the user must manually rename every interface (e.g., from GigabitEthernet1/0/1 to GigabitEthernet2/0/1). This proposal automates that shift.

Technical Implementation Details:

Template Pattern Support: Enhance InterfaceTemplate to support placeholders. For example, a template could define a name as GigabitEthernet{module}/0/{index}.
VC Joining Logic: When a Device is associated with a Virtual Chassis and assigned a position, NetBox should trigger a logic layer that checks for these patterns.
UI Implementation: Add a toggle/checkbox in the "Add to Virtual Chassis" and "Edit Virtual Chassis Member" views labeled: "Update interface names to match stack position."
Bulk Rename Logic: If the toggle is enabled, NetBox will iterate through existing interfaces and update the {module} or prefix segment of the string to match the assigned position integer.

Use case

In enterprise networking (e.g., Cisco Catalyst, Juniper Virtual Chassis), stackable switches follow a Member/Slot/Port convention. When a switch is re-indexed from member 1 to member 2, its logical identity changes across all physical ports.

Automating this in NetBox eliminates massive manual overhead. For instance, in an 8-switch stack of 48-port switches, a user currently has to manually edit 384+ interfaces. This feature prevents data entry errors and significantly speeds up the "Staging" phase of network deployments.

Database changes

No immediate schema changes are required if the logic is handled at the application level during the "Join VC" process.

However, to make this robust long-term, adding a name_pattern field (String) to the InterfaceTemplate model would allow NetBox to know exactly which part of the interface name is intended to be dynamic versus static.

External dependencies

None. This functionality relies on existing internal NetBox models (VirtualChassis, Device, Interface).

*Originally created by @greatmerlin on 3/9/2026* ### NetBox version v4.5.2-Docker-4.0.0 ### Feature type Change to existing functionality ### Proposed functionality I propose enhancing the Virtual Chassis (VC) logic to allow for dynamic, pattern-based interface renaming when a Device is assigned a position (Member ID) within a Virtual Chassis. Currently, NetBox treats interface names as static strings. When a device is added to a VC and assigned a position (e.g., Position 2), the user must manually rename every interface (e.g., from GigabitEthernet1/0/1 to GigabitEthernet2/0/1). This proposal automates that shift. Technical Implementation Details: - Template Pattern Support: Enhance InterfaceTemplate to support placeholders. For example, a template could define a name as GigabitEthernet{module}/0/{index}. - VC Joining Logic: When a Device is associated with a Virtual Chassis and assigned a position, NetBox should trigger a logic layer that checks for these patterns. - UI Implementation: Add a toggle/checkbox in the "Add to Virtual Chassis" and "Edit Virtual Chassis Member" views labeled: "Update interface names to match stack position." - Bulk Rename Logic: If the toggle is enabled, NetBox will iterate through existing interfaces and update the {module} or prefix segment of the string to match the assigned position integer. ### Use case In enterprise networking (e.g., Cisco Catalyst, Juniper Virtual Chassis), stackable switches follow a Member/Slot/Port convention. When a switch is re-indexed from member 1 to member 2, its logical identity changes across all physical ports. Automating this in NetBox eliminates massive manual overhead. For instance, in an 8-switch stack of 48-port switches, a user currently has to manually edit 384+ interfaces. This feature prevents data entry errors and significantly speeds up the "Staging" phase of network deployments. ### Database changes No immediate schema changes are required if the logic is handled at the application level during the "Join VC" process. However, to make this robust long-term, adding a name_pattern field (String) to the InterfaceTemplate model would allow NetBox to know exactly which part of the interface name is intended to be dynamic versus static. ### External dependencies None. This functionality relies on existing internal NetBox models (VirtualChassis, Device, Interface).

MrUnknownDE closed this issue

2026-04-05 16:22:46 +02:00

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

No Label netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox pending closure pending closure status: revisions needed status: revisions needed status: revisions needed type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#189