Nautobot BGP Models Plugin
Project description
Nautobot BGP Models Plugin
A plugin for Nautobot extending the core models with BGP-specific models.
New models enable modeling and management of BGP peerings, whether or not the peer device is present in Nautobot.
The initial development of this plugin was sponsored by Riot Games, Inc.
Data Models
Navigate to Data Models for detailed descriptions on additional data models provided in the plugin.
Use Cases
To make the start with the plugin easier, we provide two example use cases for common OS platforms: Cisco and Juniper.
Cisco Configuration Modeling and Rendering
Navigate to Cisco Example Use Case for detailed instructions how to consume BGP Models plugin on Cisco devices.
Juniper Configuration Modeling and Rendering
Navigate to Juniper Example Use Case for detailed instructions how to consume BGP Models plugin on Juniper devices.
Installation
The plugin is available as a Python package in PyPI and can be installed with pip
:
pip install nautobot-bgp-models
The plugin is compatible with Nautobot 1.3 and higher
To ensure Nautobot BGP Models Plugin is automatically re-installed during future upgrades, create a file named local_requirements.txt
(if not already existing) in the Nautobot root directory (alongside requirements.txt
) and list the nautobot-bgp-models
package:
# echo nautobot-bgp-models >> local_requirements.txt
Once installed, the plugin needs to be enabled in your nautobot_config.py
# In your configuration.py
PLUGINS = ["nautobot_bgp_models"]
PLUGINS_CONFIG = {
"nautobot_bgp_models": {
"default_statuses": {
"AutonomousSystem": ["active", "available", "planned"],
"Peering": ["active", "decommissioned", "deprovisioning", "offline", "planned", "provisioning"],
}
}
}
In the default_statuses
section, you can define a list of default statuses to make available to AutonomousSystem
and/or Peering
. The lists must be composed of valid slugs of existing Status objects.
Screenshots
Contributing
Pull requests are welcomed and automatically built and tested against multiple version of Python and multiple version of Nautobot through TravisCI.
The project is packaged with a light development environment based on docker-compose
to help with the local development of the project and to run the tests within TravisCI.
The project is following Network to Code software development guideline and is leveraging:
- Black, Pylint, Bandit and pydocstyle for Python linting and formatting.
- Django unit test to ensure the plugin is working properly.
Questions
For any questions or comments, please check the FAQ first and feel free to swing by the Network to Code slack channel (channel #networktocode). Sign up here
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for nautobot-bgp-models-0.7.0b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 37f25ed540b820da146af8302719db0627eb29d34d1e7647b3867a46d8802b5d |
|
MD5 | 03f3eabd4dda2503b429ead5942b498e |
|
BLAKE2b-256 | 2bc57fbe6df3bf5280509c5757d373225bc49d476e80582c18b8f7032d19e665 |
Hashes for nautobot_bgp_models-0.7.0b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eaa61a1b9c9ccf1133fc8a82a2eab353081da2e6424b104678bd2cad01bdc553 |
|
MD5 | 69086d6317fb872aa5731dbbe6415df0 |
|
BLAKE2b-256 | eae94e984194fc5240d6d6c956b37c61c34706a5fd19e5b1dc814a58ff72853e |