Merge pull request #3 from k01ek/develop

add device extension; add name filed for session;

Author: k01ek

README.md

@@ -20,7 +20,9 @@ Restart NetBox and add `netbox-bgp` to your local_requirements.txt
 
 ## Configuration
 
-The plugin is not configurable
+The following options are available:
+* `device_ext_page`: String (default right) Device related BGP sessions table position. The following values are available:  
+left, right, full_width. Set empty value for disable.
 
 ## Screenshots
 
@@ -30,6 +32,9 @@ BGP Session Object
 BGP Session Table
 ![BGP Session Table](docs/img/bgp_sess_list.png)
 
+Device Extension
+![Device Session Table](docs/img/dev_sess_list.png)
+
 ASN Object
 ![ASN](docs/img/asn.png)
 

docs/img/asn.png

@@ -11,8 +11,9 @@ class BGPConfig(PluginConfig):
     author_email = '[email protected]'
     base_url = 'bgp'
     required_settings = []
-    default_settings = {}
-
+    default_settings = {
+        'device_ext_page': 'right'
+    }
 
 
 config = BGPConfig # noqa

docs/img/bgp_sess.png

@@ -14,4 +14,4 @@ class CommunityAdmin(admin.ModelAdmin):
 
 @admin.register(BGPSession)
 class BGPSessionAdmin(admin.ModelAdmin):
-    fields = ('local_address', 'local_as', 'remote_address', 'remote_as' 'description')
+    fields = ('name', 'local_address', 'local_as', 'remote_address', 'remote_as', 'description')

docs/img/bgp_sess_list.png

@@ -1,16 +1,21 @@
 from rest_framework.serializers import ModelSerializer
 
 from netbox.api import ChoiceField
-
+from dcim.api.nested_serializers import NestedSiteSerializer
+from tenancy.api.nested_serializers import NestedTenantSerializer
+from extras.api.serializers import TaggedObjectSerializer
+from extras.api.customfields import CustomFieldModelSerializer
 from netbox_bgp.models import ASN, ASNStatusChoices, BGPSession, SessionStatusChoices
 
 
-class ASNSerializer(ModelSerializer):
+class ASNSerializer(TaggedObjectSerializer, CustomFieldModelSerializer):
     status = ChoiceField(choices=ASNStatusChoices, required=False)
+    site = NestedSiteSerializer(required=False, allow_null=True)
+    tenant = NestedTenantSerializer(required=False, allow_null=True)
 
     class Meta:
         model = ASN
-        fields = ['number', 'id', 'status']
+        fields = ['number', 'id', 'status', 'description', 'site', 'tenant', 'tags']
 
 
 class BGPSessionSerializer(ModelSerializer):

docs/img/dev_sess_list.png

@@ -72,6 +72,7 @@ def search(self, queryset, name, value):
             return queryset
         qs_filter = (
             Q(remote_as__number__icontains=value)
+            | Q(name__icontains=value)
             | Q(local_as__number__icontains=value)
             | Q(description__icontains=value)
         )

netbox_bgp/__init__.py

@@ -156,6 +156,10 @@ class Meta:
 
 
 class BGPSessionForm(BootstrapMixin, forms.ModelForm):
+    name = forms.CharField(
+        max_length=64,
+        required=True
+    )
     tags = DynamicModelMultipleChoiceField(
         queryset=Tag.objects.all(),
         required=False
@@ -177,7 +181,6 @@ class BGPSessionForm(BootstrapMixin, forms.ModelForm):
     )
     local_as = DynamicModelChoiceField(
         queryset=ASN.objects.all(),
-        null_option=None,
         query_params={
             'site_id': '$site'
         },
@@ -209,7 +212,7 @@ class BGPSessionForm(BootstrapMixin, forms.ModelForm):
     class Meta:
         model = BGPSession
         fields = [
-            'site', 'device',
+            'name', 'site', 'device',
             'local_as', 'remote_as', 'local_address', 'remote_address',
             'description', 'status', 'tenant', 'tags',
         ]

netbox_bgp/admin.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.1.3 on 2021-04-14 09:57
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('netbox_bgp', '0005_netbox_bgp'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='bgpsession',
+            name='name',
+            field=models.CharField(blank=True, max_length=100, null=True),
+        ),
+    ]

netbox_bgp/api/serializers.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.1.3 on 2021-04-14 10:26
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('netbox_bgp', '0006_netbox_bgp'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='bgpsession',
+            name='name',
+            field=models.CharField(blank=True, max_length=64, null=True),
+        ),
+    ]

netbox_bgp/filters.py

@@ -170,6 +170,11 @@ def get_absolute_url(self):
 
 @extras_features('export_templates', 'webhooks')
 class BGPSession(ChangeLoggedModel):
+    name = models.CharField(
+        max_length=64,
+        blank=True,
+        null=True
+    )
     site = models.ForeignKey(
         to='dcim.Site',
         on_delete=models.SET_NULL,
@@ -225,7 +230,7 @@ class Meta:
         verbose_name_plural = 'BGP Sessions'
 
     def __str__(self):
-        return f"{self.device}->{self.remote_as}({self.remote_address})"
+        return f"{self.device}:{self.name}"
 
     def get_status_class(self):
         return SessionStatusChoices.CSS_CLASSES.get(self.status)

netbox_bgp/forms.py

@@ -45,7 +45,7 @@ class Meta(BaseTable.Meta):
 
 class BGPSessionTable(BaseTable):
     pk = ToggleColumn()
-    id = tables.LinkColumn()
+    name = tables.LinkColumn()
     device = tables.LinkColumn()
     remote_address = tables.LinkColumn()
     remote_as = tables.LinkColumn()
@@ -61,5 +61,5 @@ class BGPSessionTable(BaseTable):
     class Meta(BaseTable.Meta):
         model = BGPSession
         fields = (
-            'pk', 'id', 'device', 'remote_as', 'remote_address', 'local_as', 'description', 'site', 'status'
+            'pk', 'name', 'device', 'remote_as', 'remote_address', 'local_as', 'description', 'site', 'status'
         )

netbox_bgp/migrations/0006_netbox_bgp.py

@@ -0,0 +1,37 @@
+from extras.plugins import PluginTemplateExtension
+
+from .models import BGPSession
+from .tables import BGPSessionTable
+
+
+class DeviceBGPSession(PluginTemplateExtension):
+    model = 'dcim.device'
+
+    def left_page(self):
+        if self.context['config'].get('device_ext_page') == 'left':
+            return self.x_page()
+        return ''
+
+    def right_page(self):
+        if self.context['config'].get('device_ext_page') == 'right':
+            return self.x_page()
+        return ''
+
+    def full_width_page(self):
+        if self.context['config'].get('device_ext_page') == 'full_width':
+            return self.x_page()
+        return ''
+
+    def x_page(self):
+        obj = self.context['object']
+        sess = BGPSession.objects.filter(device=obj)
+        sess_table = BGPSessionTable(sess)
+        return self.render(
+            'netbox_bgp/device_extend.html',
+            extra_context={
+                'related_session_table': sess_table
+            }
+        )
+
+
+template_extensions = [DeviceBGPSession]

netbox_bgp/migrations/0007_netbox_bgp.py

@@ -75,8 +75,14 @@ <h1>{% block title %}AS{{ object }}{% endblock %}</h1>
             </div>
             <table class="table table-hover panel-body attr-table">
                 <tr>
-                    <td>Site</td>
-                    <td>{{ object.site }}</td>
+                    <td>Site</td>                    
+                    <td>
+                        {% if object.site %}
+                        <a href="{{ object.site.get_absolute_url }}">{{ object.site }}</a>
+                        {% else %}
+                        <span class="text-muted">None</span>
+                        {% endif %}
+                    </td>
                 </tr>                
                 <tr>
                     <td>Number</td>

netbox_bgp/models.py

@@ -49,7 +49,7 @@
     </a>
     {% endif %}
 </div>
-<h1>{% block title %}BGP Session: {{ object }}{% endblock %}</h1>
+<h1>{% block title %}BGP Session {{ object }}{% endblock %}</h1>
 {% include 'inc/created_updated.html' %}
 <div class="pull-right noprint">
     {% custom_links object %}
@@ -74,6 +74,26 @@ <h1>{% block title %}BGP Session: {{ object }}{% endblock %}</h1>
                 <strong>BGP Session</strong>
             </div>
             <table class="table table-hover panel-body attr-table">
+                <tr>
+                    <td>Name</td>
+                    <td>
+                        {% if object.name %}
+                        {{ object.name }}
+                        {% else %}
+                        <span class="text-muted">None</span>
+                        {% endif %}
+                    </td>
+                </tr>
+                <tr>
+                    <td>Device</td>
+                    <td>
+                        {% if object.device %}
+                        <a href="{{ object.device.get_absolute_url }}">{{ object.device }}</a>
+                        {% else %}
+                        <span class="text-muted">None</span>
+                        {% endif %}
+                    </td>
+                </tr>                          
                 <tr>
                     <td>Local AS</td>
                     <td>

netbox_bgp/tables.py

@@ -0,0 +1,2 @@
+{% load render_table from django_tables2 %}
+{% include 'utilities/obj_table.html' with table=related_session_table table_template='panel_table.html' heading='Related BGP Sessions' panel_class='default noprint' %}

netbox_bgp/template_content.py

@@ -1 +1 @@
-__version__ = "0.0.2"
+__version__ = "0.1.0"

netbox_bgp/templates/netbox_bgp/asn.html

@@ -7,6 +7,7 @@
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
+
 def read(rel_path):
     here = os.path.abspath(os.path.dirname(__file__))
     with codecs.open(os.path.join(here, rel_path), 'r') as fp: