Skip to main content

BGP related stuff

Project description

NetBox BGP Plugin

This Netbox plugin introduces support for BGP related objects documentation.

Models include:

  • BGP Communities
  • BGP Sessions
  • BGP Peer Groups
  • Routing Policy
  • Prefix Lists
  • AS Path Lists

Compatibility

See the compatibility matrix for supported NetBox versions.

Installation

The plugin is available as a Python package in pypi and can be installed with pip

pip install netbox-bgp

Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:

PLUGINS = ['netbox_bgp']

Restart NetBox and add netbox-bgp to your local_requirements.txt

See NetBox Documentation for details

Configuration

The following options are available:

  • device_ext_page: String (default right) Device related BGP sessions display mode. The following values are available:
    • left: Display BGP sessions in the left column of the device detail page
    • right: Display BGP sessions in the right column of the device detail page
    • full_width: Display BGP sessions in full width at the bottom of the device detail page
    • tab: Display BGP sessions in a dedicated tab on the device detail page
    • Set empty value to disable device BGP sessions display
  • top_level_menu: Bool (default False) Enable top level section navigation menu for the plugin.
  • remote_address_strict: Bool (default False) When enabled, the "Add Session" form requires selecting an existing IPAddress object for Remote Address instead of accepting a free-text CIDR (which would otherwise auto-create a new IPAddress). Recommended for multi-VRF environments to avoid orphaned addresses and ambiguous matches.

Screenshots

BGP Session BGP Session

BGP Sessions BGP Session Table

Community Community

Peer Group Peer Group

Routing Policy Routing Policy

Prefix List Prefix List

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netbox_bgp-0.19.0.tar.gz (47.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netbox_bgp-0.19.0-py3-none-any.whl (80.3 kB view details)

Uploaded Python 3

File details

Details for the file netbox_bgp-0.19.0.tar.gz.

File metadata

  • Download URL: netbox_bgp-0.19.0.tar.gz
  • Upload date:
  • Size: 47.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for netbox_bgp-0.19.0.tar.gz
Algorithm Hash digest
SHA256 e18f645a11c04b0e1875ac8fb65e36a300a8e3db0df3237dd043e20b8876bc9b
MD5 16c4ae8e2f318fb5d97c0dc234514f81
BLAKE2b-256 717522dc5c7a7b4ba0ab1c1712c41db9297f2fdb9e52cd7e967d90064baaa205

See more details on using hashes here.

File details

Details for the file netbox_bgp-0.19.0-py3-none-any.whl.

File metadata

  • Download URL: netbox_bgp-0.19.0-py3-none-any.whl
  • Upload date:
  • Size: 80.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for netbox_bgp-0.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 91343c9ddcd33d99e1e89b80f4364e2ecd7495bf2dc623fe28a772f455a8a43b
MD5 af923db59f4e393f0c4e8e6f900af031
BLAKE2b-256 1c9dd678968fa9ee90e1d0c2199460870258e3a5c8405b508af6fc189c88ce55

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page