NetBox Interface Name Rules Plugin

Automatic interface renaming when modules are installed into NetBox device bays.

What it does

When a module (transceiver, line card, converter) is installed into a module bay, NetBox creates interfaces using position-based naming from the module type template. This often produces incorrect names — e.g., Interface 1 instead of et-0/0/4.

This plugin hooks into Django's post_save signal on the Module model to automatically apply renaming rules based on configurable templates.

Features

• Signal-driven — rules fire automatically on module install, no manual step needed
• Template variables — {slot}, {bay_position}, {bay_position_num}, {base}, {channel}, etc.
• Arithmetic expressions — {8 + ({parent_bay_position} - 1) * 2 + {sfp_slot}}
• Breakout support — create multiple channel interfaces from a single port (e.g., QSFP+ 4x10G)
• Scoping — rules can be scoped to specific device types, parent module types, or be universal
• Bulk import/export — YAML-based rule management via the UI or API

Supported scenarios

Installation

pip install netbox-interface-name-rules

Add to configuration.py:

PLUGINS = ["netbox_interface_name_rules"]

Configuration

Rules are managed through the NetBox UI under Plugins → Interface Name Rules, or via the REST API at /api/plugins/interface-name-rules/rules/.

See the full configuration guide for all rule fields, priority scoring, and template variable reference.

Screenshots

Compatibility

• NetBox ≥ 4.3.0 (CI tests 4.3, 4.5, 4.6, plus NetBox main as a non-blocking early warning)
• Python ≥ 3.12

License

Apache 2.0

Documentation

• Full documentation — installation, configuration, examples
• DeepWiki — AI-generated codebase overview

Contributing

See CONTRIBUTING.md for how to submit code or interface name rules.

Community-contributed rules for various vendors are in the contrib/ directory.

Testing

Inside the devcontainer:

netbox-test                 # run this plugin's tests (shared test_netbox DB)
netbox-test-isolated <app> [flags]   # run on a per-session ISOLATED test DB

netbox-test-isolated is concurrency-safe: Django otherwise names the test database test_<DB_NAME> (test_netbox), so two manage.py test runs in the same devcontainer collide on one DB and corrupt each other's migrations (a crashed run can even leave an idle in transaction connection holding locks that wedges every later run). The helper points the test DB at a unique name — derived from the first app argument, or TEST_DB_NAME=... — via the isolated_test_settings shim (--settings=isolated_test_settings with .devcontainer/config on PYTHONPATH). Plain netbox-test keeps using the shared default (test_netbox); netbox-test-isolated instead derives a per-app DB name by default — test_<app> from the first app argument (this plugin when none is given) — unless you set TEST_DB_NAME explicitly. Example — test a sibling plugin without disturbing a parallel run:

netbox-test-isolated netbox_nso_plugin --keepdb