Netbox Routing Plugin

A plugin for tracking all kinds of routing information

Every routing protocol of a device in one Routing tab: static routes, OSPF, IS-IS, BGP and EIGRP.

About this project

This plugin was created by Daniel Sheppard (dansheps), who is credited as the original author and a historical contributor. The package is now maintained by Arturo (baldoarturo). This repository is a fork that is developed with the help of AI, using Claude Code to speed up development: Claude writes the code, tests and documentation, and the maintainer sets the direction and reviews and approves the changes.

Documentation

The documentation for operators and users (every protocol and feature, with the RFC it comes from) is in docs/. Start with Using the plugin; the RFC index goes from an RFC to the features that use it, and Development explains how to work on the docs.

Features

Ready

• Routing objects
  • Prefix lists
  • AS paths
  • Communities and community lists
• Route policies (match and set, jump to another policy, final deny, search tool; used by OSPF, IS-IS and EIGRP)
• Static routes (special next hops, interface, route leaking)
• OSPF, versions 2 (IPv4) and 3 (IPv6) (instances, areas, interfaces, authentication with key rollover, redistribution, virtual links, ranges, neighbors, traffic engineering, segment routing, fast reroute)
• IS-IS (instances, levels, interfaces, authentication, redistribution, route leaking, segment routing, Flex-Algo, SRv6)
• BGP (instances, address families, peer groups, peers, listen ranges, redistribution, originated networks and aggregates, route policy; RFC 4271 and its extensions)
• BFD profiles (timers, Simple Password and Keyed MD5 authentication, single-hop and multihop mode, echo interval; RFC 5880, 5881, 5882, 5883; used by BGP, OSPF and IS-IS)
• EIGRP (named mode only; routers, address families with autonomous system and K values, networks, interfaces with timers, authentication, stub, passive default and bandwidth, summaries, redistribution; RFC 7868)

Work in progress

Not production ready; the model and the migrations can still change. Each one has a tracking issue.

• Segment routing (tracking #201)

Requirements

• NetBox 4.7+
• Python 3.12+

Installation

Follows the standard NetBox plugin installation procedure.

The package is published on PyPI as netbox-routing-plugin. You can also install the development version straight from GitHub.

Bare metal

The steps below assume NetBox lives in /opt/netbox; adjust paths to match your environment.

1. Install the package into the NetBox virtual environment:

   source /opt/netbox/venv/bin/activate
   pip install netbox-routing-plugin
   

   To install the development version from GitHub instead, use pip install git+https://github.com/baldoarturo/netbox-routing-plugin.git.

2. Add it to local_requirements.txt so it is reinstalled whenever NetBox is upgraded:

   echo "git+https://github.com/baldoarturo/netbox-routing-plugin.git" >> /opt/netbox/local_requirements.txt
   

3. Enable the plugin in configuration.py:

   PLUGINS = [
       'netbox_routing_plugin',
   ]
   

4. Apply the database migrations and collect static files:

   python3 /opt/netbox/netbox/manage.py migrate
   python3 /opt/netbox/netbox/manage.py collectstatic --no-input
   

5. Restart NetBox (e.g. sudo systemctl restart netbox netbox-rq).

Docker

Plugins in Docker are installed by building a custom image, not with pip inside a running container. Follow the netbox-docker plugin instructions and use the same git URL as the package, and netbox_routing_plugin as the plugin name in PLUGINS. Migrations and collectstatic run automatically when the container starts.

Configuration

None

Usage

See Using the plugin: the menu, how the objects relate to each other, bulk import and validation.

Additional Notes

TBD

Contribute

Contributions are always welcome! Please open an issue first before contributing as the scope is going to be kept intentionally narrow

Install the pre-commit hooks once in your clone (pip install pre-commit, then pre-commit install): they run Ruff and Black on every commit with the same configuration as the CI, which runs pre-commit run --all-files on every pull request. See dev/README.md to run NetBox and the tests.