netbox-ping 0.2__py3-none-any.whl

netbox_ping/__init__.py

@@ -0,0 +1,23 @@
+from netbox.plugins import PluginConfig
+
+class Config(PluginConfig):
+    name = 'netbox_ping'
+    verbose_name = 'NetBox Ping'
+    description = 'Ping IPs and subnets'
+    version = '0.2'
+    author = 'Christian Rose'
+    default_settings = {
+        'exclude_virtual_interfaces': True
+    }
+
+    # Register the custom table
+    ipaddress_table = 'netbox_ping.tables.CustomIPAddressTable'
+    
+    # Define which models support custom fields
+    custom_field_models = ['ipaddress']
+
+    # API settings
+    base_url = 'netbox-ping'
+    default_app_config = 'netbox_ping.apps.NetBoxPingConfig'
+
+config = Config

netbox_ping/config.py

@@ -0,0 +1,43 @@
+from extras.choices import CustomFieldTypeChoices
+from extras.models import CustomField, Tag
+from django.db.models import Q
+
+def create_custom_fields_and_tags():
+    """Create custom fields and tags needed by the plugin"""
+    
+    # Create Up_Down custom field
+    custom_field, created = CustomField.objects.get_or_create(
+        name='Up_Down',
+        defaults={
+            'type': CustomFieldTypeChoices.TYPE_BOOLEAN,
+            'label': 'Up/Down Status',
+            'description': 'Indicates if the IP is responding to ping',
+            'required': False,
+            'filter_logic': 'exact'
+        }
+    )
+    
+    # Add the custom field to IPAddress content type if not already added
+    if created:
+        custom_field.content_types.add(
+            ContentType.objects.get(app_label='ipam', model='ipaddress')
+        )
+
+    # Create online/offline tags
+    Tag.objects.get_or_create(
+        name='online',
+        slug='online',
+        defaults={
+            'description': 'IP is responding to ping',
+            'color': '4CAF50'  # Green color
+        }
+    )
+
+    Tag.objects.get_or_create(
+        name='offline',
+        slug='offline',
+        defaults={
+            'description': 'IP is not responding to ping',
+            'color': 'F44336'  # Red color
+        }
+    ) 

netbox_ping/forms.py

@@ -0,0 +1,13 @@
+from django import forms
+from netbox.forms import NetBoxModelForm
+from .models import PluginSettingsModel
+
+
+class InterfaceComparisonForm(forms.Form):
+    add_to_device = forms.BooleanField(required=False)
+    remove_from_device = forms.BooleanField(required=False)
+
+class PluginSettingsForm(NetBoxModelForm):
+    class Meta:
+        model = PluginSettingsModel
+        fields = ('update_tags',)

netbox_ping/hooks.py

@@ -0,0 +1,6 @@
+from extras.plugins import PluginTemplateExtension
+from . import tables
+
+def override_ipaddress_table():
+    """Override the default IP address table to include Up_Down status"""
+    return tables.CustomIPAddressTable 

netbox_ping/migrations/0001_initial.py

@@ -0,0 +1,30 @@
+from django.db import migrations, models
+import django.db.models.deletion
+import netbox.models.features
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        ('extras', '0001_initial'),  # Base NetBox dependency
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='PluginSettingsModel',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)),
+                ('created', models.DateTimeField(auto_now_add=True)),
+                ('last_updated', models.DateTimeField(auto_now=True)),
+                ('custom_field_data', models.JSONField(blank=True, default=dict, null=True)),
+                ('update_tags', models.BooleanField(default=True, help_text='Whether to update tags when scanning IPs', verbose_name='Update Tags')),
+            ],
+            options={
+                'verbose_name': 'Plugin Settings',
+                'verbose_name_plural': 'Plugin Settings',
+                'ordering': ['pk'],
+            },
+            bases=(netbox.models.features.ChangeLoggingMixin, models.Model),
+        ),
+    ] 

netbox_ping/models.py

@@ -0,0 +1,42 @@
+from django.db import models
+from netbox.models import NetBoxModel
+from utilities.choices import ChoiceSet
+
+class PluginSettingsModel(NetBoxModel):
+    """Store plugin settings"""
+    class Meta:
+        verbose_name = 'Plugin Settings'
+        verbose_name_plural = 'Plugin Settings'
+        ordering = ['pk']
+
+    # Required fields from NetBoxModel
+    id = models.BigAutoField(
+        primary_key=True
+    )
+    created = models.DateTimeField(
+        auto_now_add=True
+    )
+    last_updated = models.DateTimeField(
+        auto_now=True
+    )
+    custom_field_data = models.JSONField(
+        blank=True,
+        null=True,
+        default=dict
+    )
+
+    # Our custom fields
+    update_tags = models.BooleanField(
+        default=True,
+        verbose_name='Update Tags',
+        help_text='Whether to update tags when scanning IPs'
+    )
+
+    def __str__(self):
+        return "NetBox Ping Settings"
+
+    @classmethod
+    def get_settings(cls):
+        """Get or create settings"""
+        settings, _ = cls.objects.get_or_create(pk=1)
+        return settings 

netbox_ping/navigation.py

@@ -0,0 +1,17 @@
+from netbox.plugins import PluginMenuItem, PluginMenuButton
+
+menu_items = (
+    PluginMenuItem(
+        link='plugins:netbox_ping:ping_home',
+        link_text='Network Tools',
+        permissions=('ipam.view_prefix',),
+        buttons=(
+            PluginMenuButton(
+                link='plugins:netbox_ping:ping_home',
+                title='Network Tools',
+                icon_class='mdi mdi-lan',
+                permissions=('ipam.view_prefix',),
+            ),
+        ),
+    ),
+) 

netbox_ping/plugin.py

@@ -0,0 +1,83 @@
+from django.contrib.contenttypes.models import ContentType
+from extras.api.serializers import CustomFieldSerializer, TagSerializer
+from extras.models import CustomField, Tag
+from ipam.models import IPAddress
+from rest_framework.exceptions import ValidationError
+
+def initialize_plugin():
+    """Initialize plugin custom fields and tags using the API"""
+    
+    # Get ContentType ID for IPAddress
+    ipaddress_ct_id = ContentType.objects.get_for_model(IPAddress).id
+    
+    # Create Up_Down custom field
+    up_down_data = {
+        'name': 'Up_Down',
+        'type': 'boolean',
+        'label': 'Up/Down Status',
+        'description': 'Indicates if the IP is responding to ping',
+        'required': False,
+        'filter_logic': 'exact',
+        'ui_visible': 'always',
+        'ui_editable': 'yes',
+        'is_cloneable': True,
+        'weight': 100,
+    }
+    
+    # Create Auto_discovered custom field
+    discovered_data = {
+        'name': 'Auto_discovered',
+        'type': 'date',
+        'label': 'Auto Discovered',
+        'description': 'Date when this IP was automatically discovered',
+        'required': False,
+        'filter_logic': 'exact',
+        'ui_visible': 'always',
+        'ui_editable': 'yes',
+        'is_cloneable': True,
+        'weight': 101,
+    }
+
+    # Create custom fields
+    for cf_data in [up_down_data, discovered_data]:
+        try:
+            custom_field = CustomField.objects.get(name=cf_data['name'])
+        except CustomField.DoesNotExist:
+            try:
+                custom_field = CustomField.objects.create(**cf_data)
+                custom_field.object_types.set([ipaddress_ct_id])
+                print(f"Created custom field: {custom_field.name}")
+            except Exception as e:
+                print(f"Failed to create custom field: {str(e)}")
+
+    # Create tags
+    tags_data = [
+        {
+            'name': 'online',
+            'slug': 'online',
+            'description': 'IP is responding to ping',
+            'color': '4CAF50'
+        },
+        {
+            'name': 'offline',
+            'slug': 'offline',
+            'description': 'IP is not responding to ping',
+            'color': 'F44336'
+        },
+        {
+            'name': 'auto-discovered',
+            'slug': 'auto-discovered',
+            'description': 'IP was automatically discovered by scanning',
+            'color': '2196F3'  # Blue color
+        }
+    ]
+    
+    for tag_data in tags_data:
+        try:
+            tag = Tag.objects.get(slug=tag_data['slug'])
+        except Tag.DoesNotExist:
+            try:
+                tag = Tag.objects.create(**tag_data)
+                print(f"Created tag: {tag.name}")
+            except Exception as e:
+                print(f"Failed to create tag: {str(e)}") 

netbox_ping/signals.py

@@ -0,0 +1,48 @@
+from django.contrib.contenttypes.models import ContentType
+from django.apps import apps
+from django.db.models.signals import post_migrate
+from django.dispatch import receiver
+from extras.choices import CustomFieldTypeChoices
+from extras.models import CustomField, Tag
+
+@receiver(post_migrate)
+def create_custom_fields_and_tags(sender, **kwargs):
+    """
+    Create required custom fields and tags after database migrations complete
+    """
+    if sender.name == 'netbox_ping':
+        # Create Up_Down custom field
+        custom_field, _ = CustomField.objects.get_or_create(
+            name='Up_Down',
+            defaults={
+                'type': CustomFieldTypeChoices.TYPE_BOOLEAN,
+                'label': 'Up/Down Status',
+                'description': 'Indicates if the IP is responding to ping',
+                'required': False,
+                'filter_logic': 'exact'
+            }
+        )
+        
+        # Add the custom field to IPAddress content type
+        ipaddress_ct = ContentType.objects.get_for_model(apps.get_model('ipam', 'ipaddress'))
+        if ipaddress_ct not in custom_field.content_types.all():
+            custom_field.content_types.add(ipaddress_ct)
+
+        # Create online/offline tags
+        Tag.objects.get_or_create(
+            name='online',
+            slug='online',
+            defaults={
+                'description': 'IP is responding to ping',
+                'color': '4CAF50'  # Green color
+            }
+        )
+
+        Tag.objects.get_or_create(
+            name='offline',
+            slug='offline',
+            defaults={
+                'description': 'IP is not responding to ping',
+                'color': 'F44336'  # Red color
+            }
+        ) 

netbox_ping/tables.py

@@ -0,0 +1,22 @@
+import django_tables2 as tables
+from netbox.tables import NetBoxTable, columns
+from ipam.models import IPAddress
+from ipam.tables import IPAddressTable
+
+class CustomIPAddressTable(IPAddressTable):
+    """Custom IP Address table that includes the Up_Down status"""
+    
+    up_down = columns.BooleanColumn(
+        verbose_name='Ping Status',
+        accessor=tables.A('_custom_field_data__Up_Down'),
+        order_by='_custom_field_data__Up_Down',
+    )
+
+    online = columns.TagColumn(
+        verbose_name='Online/Offline'
+    )
+
+    class Meta(IPAddressTable.Meta):
+        model = IPAddress
+        fields = IPAddressTable.Meta.fields + ('up_down', 'online')
+        default_columns = ('address', 'status', 'up_down', 'online', 'tenant', 'assigned_object', 'description') 

netbox_ping/template_content.py

@@ -0,0 +1,15 @@
+from netbox.plugins.template_content import PluginTemplateContent
+
+class PrefixContent(PluginTemplateContent):
+    model = 'ipam.prefix'
+
+    def buttons(self):
+        prefix = self.context['object']
+        return f'''
+            <a href="/plugins/netbox_ping/ping-subnet/{prefix.id}/" class="btn btn-primary">
+                <span class="mdi mdi-lan"></span>
+                Ping Subnet
+            </a>
+        '''
+
+template_content = [PrefixContent]

netbox_ping/template_extensions.py

@@ -0,0 +1,15 @@
+from netbox.plugins import PluginTemplateExtension
+
+class PrefixExtension(PluginTemplateExtension):
+    model = 'ipam.prefix'
+
+    def buttons(self):
+        prefix = self.context['object']
+        return f'''
+            <a href="/plugins/netbox_ping/ping-subnet/{prefix.id}/" class="btn btn-primary">
+                <span class="mdi mdi-lan"></span>
+                Ping Subnet
+            </a>
+        '''
+
+template_extensions = [PrefixExtension] 

netbox_ping/templates/netbox_ping/compare_interfaces_button.html

@@ -0,0 +1,4 @@
+<a href="{% url 'plugins:netbox_ping:interface_comparison' device_id=device.id %}" class="btn btn-purple">
+    <i class="mdi mdi-sync" aria-hidden="true"></i>
+    Sync Interfaces
+</a>

netbox_ping/templates/netbox_ping/interface_comparison.html

@@ -0,0 +1,161 @@
+{% extends 'base/layout.html' %}
+
+{% block title %}{{ device }} - Interface comparison{% endblock %}
+{% block header %}
+    <nav class="breadcrumb-container px-3" aria-label="breadcrumb">
+        <ol class="breadcrumb">
+            <li class="breadcrumb-item"><a href="{% url 'dcim:device_list' %}">Device</a></li>
+            <li class="breadcrumb-item"><a href="{% url 'dcim:device_list' %}?site={{ device.site.slug }}">{{ device.site }}</a></li>
+            <li class="breadcrumb-item"><a href="{% url 'dcim:device' pk=device.id %}">{{ device }}</a></li>
+        </ol>
+    </nav>
+    {{ block.super }}
+{% endblock %}
+
+{% block content %}
+<style>
+    .checkbox-group {
+        position: absolute;
+    }
+</style>
+<script>
+function toggle(event) {
+  event = event || window.event;
+  var src = event.target || event.srcElement || event;
+  checkboxes = document.getElementsByName(src.id);
+  for(var checkbox of checkboxes) checkbox.checked = src.checked;
+}
+
+function uncheck(event) {
+  event = event || window.event;
+  var src = event.target || event.srcElement || event;
+  if (src.checked == false) {
+    document.getElementById(src.name).checked = false;
+  }
+}
+</script>
+
+<p>
+{% if templates_count == interfaces_count %}
+    The Device Type and Device have the same number of Interfaces.
+{% else %}
+    The Device Type and Device have a different number of Interfaces.<br>
+    Device Type: {{ templates_count }}<br>
+    Device: {{ interfaces_count }}
+{% endif %}
+</p>
+
+<form method="post">
+    <!-- Interface templates -->
+    {% csrf_token %}
+    <table class="table" style="width: 50%; float: left;">
+        <tr>
+            <th colspan="2">Device Type</th>
+            <th>Actions</th>
+        </tr>
+        <tr>
+            <th>Name</th>
+            <th>Type</th>
+            <th>
+                <label class="checkbox-group">
+                    <input type="checkbox" id="add_to_device" onclick="toggle(this)">
+                    Add
+                </label>
+            </th>
+        </tr>
+        {% for template, interface in comparison_items %}
+        {% if template %}
+        <tr {% if not interface %}class="success" data-mark-connected="true"{% endif %}>
+            <td>
+                {% if interface and template.name != interface.name %}
+                <span style="background-color: #cde8c2">{{ template.name }}</span>
+                {% else %}
+                {{ template.name }}
+                {% endif %}
+            </td>
+            <td>{{ template.type_display }}</td>
+            <td>
+                {% if not interface %}
+                <label class="checkbox-group">
+                    <input type="checkbox" name="add_to_device" value="{{ template.id }}" onclick="uncheck(this)">
+                    Add
+                </label>
+                {% endif %}
+            </td>
+        </tr>
+        {% else %}
+        <tr>
+            <td>&nbsp;</td>
+            <td>&nbsp;</td>
+            <td>&nbsp;</td>
+        </tr>
+        {% endif %}
+        {% endfor %}
+    </table>
+
+    <table class="table" style="width: 50%; float: right;">
+        <!-- Interfaces -->
+        <tr>
+            <th colspan="2">Device</th>
+            <th colspan="2">Actions</th>
+        </tr>
+        <tr>
+            <th>Name</th>
+            <th>Type</th>
+            <th>
+                <label class="checkbox-group">
+                    <input type="checkbox" id="remove_from_device" onclick="toggle(this)">
+                    Remove
+                </label>
+            </th>
+            <th>
+                <label class="checkbox-group">
+                    <input type="checkbox" id="fix_name" onclick="toggle(this)">
+                    Fix Name
+                </label>
+            </th>
+        </tr>
+        {% for template, interface in comparison_items %}
+        {% if interface %}
+        <tr {% if not template %}class="danger" data-enabled="disabled"{% endif %}>
+            <td>
+                {% if template and template.name != interface.name %}
+                <span style="background-color: #eab2b2">{{ interface.name }}</span>
+                {% else %}
+                {{ interface.name }}
+                {% endif %}
+            </td>
+            <td>{{ interface.type_display }}</td>
+            <td>
+                {% if not template %}
+                <label class="checkbox-group">
+                    <input type="checkbox" name="remove_from_device" value="{{ interface.id }}" onclick="uncheck(this)">
+                    Remove
+                </label>
+                {% endif %}
+            </td>
+            <td>
+                {% if template and template.name != interface.name %}
+                <label class="checkbox-group">
+                    <input type="checkbox" name="fix_name" value="{{ interface.id }}" onclick="uncheck(this)">
+                    Fix Name
+                </label>
+                {% endif %}
+            </td>
+        </tr>
+        {% else %}
+        <tr>
+            <td>&nbsp;</td>
+            <td>&nbsp;</td>
+            <td>&nbsp;</td>
+            <td>&nbsp;</td>
+        </tr>
+        {% endif %}
+        {% endfor %}
+    </table>
+    <div class="text-right">
+        <input type="submit" value="Apply Changes" class="btn btn-green">
+    </div>
+</form>
+
+{% endblock %}

netbox_ping/templates/netbox_ping/number_of_interfaces_panel.html

@@ -0,0 +1,21 @@
+<div class="panel panel-default">
+    <div class="panel-heading">
+        <strong>Interfaces</strong>
+    </div>
+    <div class="panel-body">
+        <table class="table table-hover panel-body attr-table">
+            <tr>
+                <td>Total Interfaces</td>
+                <td>{{ interfaces.count }}</td>
+            </tr>
+            <tr>
+                <td>Real Interfaces</td>
+                <td>{{ real_interfaces.count }}</td>
+            </tr>
+            <tr>
+                <td>Interface Templates</td>
+                <td>{{ interface_templates.count }}</td>
+            </tr>
+        </table>
+    </div>
+</div>