netbox-wdm

A NetBox 4.5+ plugin for WDM (Wavelength Division Multiplexing) device management.

Manages ITU channel plans, channel-to-port assignments, trunk port identification, ROADM live editing, and wavelength service tracking.

Alpha software. The API and data model may change between releases. Use in production at your own risk.

Features

• Overlay pattern -- WdmDeviceTypeProfile overlays DeviceType (blueprint), WdmNode overlays Device (instance).
• Dual port support -- separate MUX and DEMUX front port assignments per channel, with duplex and single-fiber modes.
• ITU grid support -- DWDM 100 GHz (44 ch), DWDM 50 GHz (88 ch), CWDM (18 ch).
• EXP / 1310 ports -- express upgrade and 1310 nm gray optic pass-through as COM rear port positions.
• Auto-population -- channels automatically created from profile templates when a device is added.
• DeviceType integration -- WDM Profile tab on DeviceType detail pages.
• Wavelength editor -- TypeScript frontend with undo/redo, dirty state, optimistic concurrency, conditional MUX/DEMUX columns.
• Wavelength services -- end-to-end service tracking with sequenced channel assignments and PROTECT guards.
• Circuit trace visualization -- interactive horizontal flow diagram on WdmCircuit detail pages.
• Full CRUD stack -- list, detail, edit, delete, bulk import/edit/delete views for all models.
• REST API -- CRUD endpoints plus apply-mapping (atomic ROADM editor) and stitch (wavelength path).
• GraphQL -- strawberry-django types, filters, and schema for all models.
• Sample data -- management command with realistic WDM topologies, patch panels, and end-to-end cabling.

Compatibility

Installation

pip install netbox-wdm

In your NetBox configuration.py:

PLUGINS = ["netbox_wdm"]

Apply migrations:

cd /opt/netbox/netbox
python manage.py migrate

Documentation

Full documentation: jsenecal.github.io/netbox-wdm

Key references:

• docs/developer/architecture -- overlay pattern, port topology, position-stack alignment.
• docs/developer/style-guide -- frontend conventions for the TypeScript components.

Models

Contributing

PRs welcome. Use conventional-commits PR titles (feat:, fix:, chore:, docs:, ...) -- release-drafter assembles release notes from them. Run make setup after cloning to install dev dependencies and the pre-commit hooks (including the AI-attribution-rejecting commit-msg hook).

License

AGPL-3.0-or-later.