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)

[!TIP]

This plugin is compatible with netbox-branching out of the box. See Branching for the one configuration pitfall to avoid.

Installation

Brief installation instructions are provided below. For a complete installation guide, please refer to the included documentation.

1. Install the plugin from PyPI:

$ pip install netbox-bgp

1. Add netbox_bgp to PLUGINS in configuration.py:

PLUGINS = [
    # ...
    'netbox_bgp',
]

1. Add netbox-bgp to local_requirements.txt so it survives future upgrades.

1. Run NetBox migrations:

$ ./manage.py migrate

1. 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 | | Permissions | Model permissions and object-level constraints | | 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.