{"id":24095,"library":"nautobot-bgp-models","title":"Nautobot BGP Models App","description":"Nautobot app that provides data models and views for modeling BGP configurations including Autonomous Systems, BGP Routing Instances, Peer Endpoints, Peerings, Address Families, and Communities. Current version 3.1.1 supports Python >=3.10,<3.15 and Nautobot 3.x. Released approximately every 2-3 months.","status":"active","version":"3.1.1","language":"python","source_language":"en","source_url":"https://github.com/nautobot/nautobot-app-bgp-models","tags":["nautobot","bgp","network-automation","nautobot-app"],"install":[{"cmd":"pip install nautobot-bgp-models","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Core Nautobot framework required; app is a Nautobot plugin.","package":"nautobot","optional":false}],"imports":[{"note":"Job class for generating BGP configs.","symbol":"BGPConfigToNetworkJob","correct":"from nautobot_bgp_models.jobs import BGPConfigToNetworkJob"},{"note":"Model representing an ASN.","symbol":"AutonomousSystem","correct":"from nautobot_bgp_models.models import AutonomousSystem"},{"note":"Model representing a BGP peering.","symbol":"Peering","correct":"from nautobot_bgp_models.models import Peering"}],"quickstart":{"code":"from nautobot_bgp_models.models import AutonomousSystem, Peering\nfrom nautobot.core.models.generics import PrimaryModel\n\n# Example: creating an Autonomous System object\nasn = AutonomousSystem.objects.create(\n    asn=64500,\n    description=\"Example AS\",\n    status_id=1  # Active status\n)\nprint(f\"Created ASN: {asn}\")","lang":"python","description":"Basic usage: import models and create an AutonomousSystem."},"warnings":[{"fix":"Ensure Nautobot is upgraded to 3.0 or later before installing nautobot-bgp-models >= 3.0.0.","message":"Nautobot 3.x required for nautobot-bgp-models >= 3.0.0. Versions 2.x require Nautobot 2.x. Check compatibility before upgrading.","severity":"breaking","affected_versions":">=3.0.0"},{"fix":"Use Python 3.10+ for v2.4.0 through v3.1.0. Python 3.14 supported from v3.1.0.","message":"Python 3.9 support dropped in v2.4.0. Python 3.14 support added in v3.1.0.","severity":"deprecated","affected_versions":">=2.4.0"},{"fix":"Upgrade to v2.3.2+ or ensure RoutingInstance is set when local_ip is not on an interface.","message":"PeerEndpoint validation requires a RoutingInstance when local_ip is assigned to an Interface (until v2.3.2 removed this requirement for non-interface IPs).","severity":"gotcha","affected_versions":"<2.3.2"},{"fix":"Add 'nautobot_bgp_models' to PLUGINS list in nautobot_config.py.","message":"The app must be added to PLUGINS in your Nautobot configuration. Missing this will result in models not being available.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run `pip install nautobot-bgp-models` and add 'nautobot_bgp_models' to PLUGINS.","cause":"App not installed or not enabled in Nautobot PLUGINS.","error":"ModuleNotFoundError: No module named 'nautobot_bgp_models'"},{"fix":"Upgrade Nautobot to >=3.0.0 or install nautobot-bgp-models <3.0.0.","cause":"Attempting to use nautobot-bgp-models >=3.0.0 with Nautobot 2.x.","error":"nautobot.core.exceptions.AppImportError: App 'nautobot_bgp_models' requires Nautobot >= 3.0.0"},{"fix":"Set status to an existing Status object (e.g., status=Status.objects.get(name='Active')).","cause":"Creating an AutonomousSystem without a required 'status' field.","error":"django.db.utils.IntegrityError: NOT NULL constraint failed: bgp_models_autonomoussystem.status_id"},{"fix":"Assign a RoutingInstance to the PeerEndpoint or upgrade to v2.3.2+ where this is no longer required.","cause":"PeerEndpoint validation requires routing_instance when local_ip is associated with an interface (pre v2.3.2).","error":"PeerEndpoint with local_ip on interface but no routing_instance"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}