NetBox BGP Plugin
This NetBox plugin introduces support for BGP related objects documentation.
Models include:
- BGP Communities
- BGP Community Lists (and Community List Rules)
- BGP Sessions
- BGP Peer Groups
- Routing Policies (and Routing Policy Rules)
- Prefix Lists (and Prefix List Rules)
- AS Path Lists (and AS Path List Rules)
See the compatibility matrix for supported NetBox versions, and the changelog for release notes and upgrade instructions.
Installation
Brief installation instructions are provided below. For a complete installation guide, please refer to the included documentation.
- Install the plugin from PyPI:
$ pip install netbox-bgp
- Add
netbox_bgptoPLUGINSinconfiguration.py:
PLUGINS = [
# ...
'netbox_bgp',
]
-
Add
netbox-bgptolocal_requirements.txtso it survives future upgrades. -
Run NetBox migrations:
$ ./manage.py migrate
- Restart NetBox.
Documentation
| Page | Contents |
|---|---|
| Introduction | Features, full installation guide, screenshots |
| Configuration | Plugin settings under PLUGINS_CONFIG |
| Integrations | The BGP Sessions tabs added to core NetBox objects |
| Branching | Using the plugin with netbox-branching |
| Data Model | Field reference for each model |
| REST API | Endpoints, including the backwards-compatible aliases |
| GraphQL API | Query fields and an example query |
Contributing
See CONTRIBUTING.md for the development environment, test workflow, and release conventions.
2 maintainers
Release files for netbox-bgp 0.20.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| netbox_bgp-0.20.1.tar.gz | 54.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| netbox_bgp-0.20.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 143.3 kB
Release files / netbox_bgp-0.20.1.tar.gz
| Download URL | netbox_bgp-0.20.1.tar.gz |
|---|---|
| Size | 54.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d055541694afe40da6ca2ce9451b1d1f3577abe5550db1ce3c0c58d5664761e3
|
|
BLAKE2b-256 checksum How to use checksums |
e5edcb86dfa04a38c2062a1921d8d553d939965f90506ccc93e842d453a4a33f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / netbox_bgp-0.20.1-py3-none-any.whl
| Download URL | netbox_bgp-0.20.1-py3-none-any.whl |
|---|---|
| Size | 88.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
61e803b80e2da005e09134ff2f39ec445022e8467cd42225c148adbd8479f4f5
|
|
BLAKE2b-256 checksum How to use checksums |
c66224c29a227641a1b12da45c4b87ac09dec1e98dcb896cd0497e1ba4f2dbb6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
