netbox-ping 0.3__tar.gz

netbox_ping-0.3/MANIFEST.in

@@ -0,0 +1,5 @@
+include LICENSE
+include README.md
+recursive-include netbox_ping/templates *
+recursive-include netbox_ping/static *
+recursive-include netbox_ping/migrations *

netbox_ping-0.3/PKG-INFO

@@ -0,0 +1,180 @@
+Metadata-Version: 2.2
+Name: netbox-ping
+Version: 0.3
+Summary: A NetBox plugin for pinging and discovering IPs
+Home-page: https://github.com/dendanskemine/netbox-ping
+Author: Christian Rose
+License: Apache 2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.12
+Description-Content-Type: text/markdown
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: summary
+
+# NetBox Ping Plugin
+![Python](https://img.shields.io/badge/python-3.12.3-blue.svg)
+![NetBox](https://img.shields.io/badge/netbox-4.2.2-blue.svg)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+
+A NetBox plugin for pinging and discovering IPs in your network.
+
+
+## Features
+- Ping IPs and subnets directly from NetBox
+- Auto-discover new IPs
+- Track IP status with custom fields and tags
+- Bulk scan operations
+- Dark mode compatible UI
+
+## Installation
+```bash
+pip install netbox-ping
+```
+
+## Configuration
+Add to your `configuration.py`:
+```python
+PLUGINS = ['netbox_ping']
+
+PLUGINS_CONFIG = {
+    'netbox_ping': {
+        'coming_soon': True
+    }
+}
+```
+
+## Usage
+1. Install the plugin
+2. Navigate to Plugins > NetBox Ping
+3. Click "Create Required Fields & Tags"
+4. Start scanning your networks!
+
+## Requirements
+
+- NetBox 4.0 or later
+- Python 3.8 or later
+- `ping` command available on the system
+
+## Installation
+
+### Package Installation
+
+1. Install the package from your NetBox installation path:
+   ```bash
+   source /opt/netbox/venv/bin/activate
+   cd /opt/netbox
+   pip install git+https://github.com/DenDanskeMine/netbox-prefix-pinger.git
+   ```
+
+### Enable the Plugin
+
+2. Add the plugin to `PLUGINS` in `/opt/netbox/netbox/netbox/configuration.py`:
+   ```python
+   PLUGINS = [
+       'netbox_ping',
+   ]
+   ```
+
+### Run Migrations
+
+3. Apply database migrations:
+   ```bash
+   cd /opt/netbox
+   python3 manage.py migrate
+   ```
+
+### Collect Static Files
+
+4. Collect static files:
+   ```bash
+   python3 manage.py collectstatic
+   ```
+
+### Restart NetBox
+
+5. Restart the NetBox service:
+   ```bash
+   sudo systemctl restart netbox
+   ```
+
+## Usage
+
+1. Navigate to the "Plugins" menu in NetBox
+2. Select "Network Tools" from the dropdown
+3. You'll see a list of all prefixes in your NetBox instance
+4. Two actions are available for each prefix:
+   - **Check Status**: Checks all existing IPs in the prefix
+   - **Scan Subnet**: Discovers and adds new active IPs
+
+### Status Indicators
+
+- 🟢 Online Tag: IP is responding to ping
+- 🔴 Offline Tag: IP is not responding
+- Custom Field "Up_Down": Boolean indicator of IP status
+
+## Configuration
+
+No additional configuration is required. The plugin will automatically:
+- Create required custom fields
+- Create online/offline tags
+- Set up necessary permissions
+
+## Permissions
+
+Users need the following permissions to use the plugin:
+- `ipam.view_prefix`
+- `ipam.view_ipaddress`
+
+## Development
+
+To set up a development environment:
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/yourusername/netbox-ping.git
+   cd netbox-ping
+   ```
+
+2. Create a virtual environment:
+   ```bash
+   python3 -m venv venv
+   source venv/bin/activate
+   ```
+
+3. Install development dependencies:
+   ```bash
+   pip install -e .
+   ```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Support
+
+If you have any questions or need help, please:
+1. Open an issue on GitHub
+2. Check existing issues for answers
+3. Contact the maintainer
+
+## Acknowledgments
+
+- Built for NetBox (https://github.com/netbox-community/netbox)
+- Inspired by the need for simple IP status tracking, this is my first plugin for NetBox.
+- I'm not a good python developer, so this is probably not the best way to do this.
+- The plugin `netbox-interface-synchronization` gave me a lot of inspiration, code wise, as the offical NetBox development repo had some issues, i couldn't get around.
+- The plugin [netbox-interface-synchronization](https://github.com/NetTech2001/netbox-interface-synchronization/tree/main) is a great plugin, and i recommend using it if you need to synchronize interfaces.
+

netbox_ping-0.3/README.md

@@ -0,0 +1,158 @@
+# NetBox Ping Plugin
+![Python](https://img.shields.io/badge/python-3.12.3-blue.svg)
+![NetBox](https://img.shields.io/badge/netbox-4.2.2-blue.svg)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+
+A NetBox plugin for pinging and discovering IPs in your network.
+
+
+## Features
+- Ping IPs and subnets directly from NetBox
+- Auto-discover new IPs
+- Track IP status with custom fields and tags
+- Bulk scan operations
+- Dark mode compatible UI
+
+## Installation
+```bash
+pip install netbox-ping
+```
+
+## Configuration
+Add to your `configuration.py`:
+```python
+PLUGINS = ['netbox_ping']
+
+PLUGINS_CONFIG = {
+    'netbox_ping': {
+        'coming_soon': True
+    }
+}
+```
+
+## Usage
+1. Install the plugin
+2. Navigate to Plugins > NetBox Ping
+3. Click "Create Required Fields & Tags"
+4. Start scanning your networks!
+
+## Requirements
+
+- NetBox 4.0 or later
+- Python 3.8 or later
+- `ping` command available on the system
+
+## Installation
+
+### Package Installation
+
+1. Install the package from your NetBox installation path:
+   ```bash
+   source /opt/netbox/venv/bin/activate
+   cd /opt/netbox
+   pip install git+https://github.com/DenDanskeMine/netbox-prefix-pinger.git
+   ```
+
+### Enable the Plugin
+
+2. Add the plugin to `PLUGINS` in `/opt/netbox/netbox/netbox/configuration.py`:
+   ```python
+   PLUGINS = [
+       'netbox_ping',
+   ]
+   ```
+
+### Run Migrations
+
+3. Apply database migrations:
+   ```bash
+   cd /opt/netbox
+   python3 manage.py migrate
+   ```
+
+### Collect Static Files
+
+4. Collect static files:
+   ```bash
+   python3 manage.py collectstatic
+   ```
+
+### Restart NetBox
+
+5. Restart the NetBox service:
+   ```bash
+   sudo systemctl restart netbox
+   ```
+
+## Usage
+
+1. Navigate to the "Plugins" menu in NetBox
+2. Select "Network Tools" from the dropdown
+3. You'll see a list of all prefixes in your NetBox instance
+4. Two actions are available for each prefix:
+   - **Check Status**: Checks all existing IPs in the prefix
+   - **Scan Subnet**: Discovers and adds new active IPs
+
+### Status Indicators
+
+- 🟢 Online Tag: IP is responding to ping
+- 🔴 Offline Tag: IP is not responding
+- Custom Field "Up_Down": Boolean indicator of IP status
+
+## Configuration
+
+No additional configuration is required. The plugin will automatically:
+- Create required custom fields
+- Create online/offline tags
+- Set up necessary permissions
+
+## Permissions
+
+Users need the following permissions to use the plugin:
+- `ipam.view_prefix`
+- `ipam.view_ipaddress`
+
+## Development
+
+To set up a development environment:
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/yourusername/netbox-ping.git
+   cd netbox-ping
+   ```
+
+2. Create a virtual environment:
+   ```bash
+   python3 -m venv venv
+   source venv/bin/activate
+   ```
+
+3. Install development dependencies:
+   ```bash
+   pip install -e .
+   ```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Support
+
+If you have any questions or need help, please:
+1. Open an issue on GitHub
+2. Check existing issues for answers
+3. Contact the maintainer
+
+## Acknowledgments
+
+- Built for NetBox (https://github.com/netbox-community/netbox)
+- Inspired by the need for simple IP status tracking, this is my first plugin for NetBox.
+- I'm not a good python developer, so this is probably not the best way to do this.
+- The plugin `netbox-interface-synchronization` gave me a lot of inspiration, code wise, as the offical NetBox development repo had some issues, i couldn't get around.
+- The plugin [netbox-interface-synchronization](https://github.com/NetTech2001/netbox-interface-synchronization/tree/main) is a great plugin, and i recommend using it if you need to synchronize interfaces.
+

netbox_ping-0.3/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.3'
+    author = 'Christian Rose'
+    default_settings = {
+        'coming_soon': 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-0.3/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-0.3/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-0.3/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-0.3/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-0.3/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-0.3/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-0.3/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-0.3/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-0.3/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')