netbox-toolkit-plugin 0.1.0__py3-none-any.whl

netbox_toolkit/migrations/0001_initial.py

@@ -0,0 +1,54 @@
+# Generated by Django 5.1.4 on 2025-05-23 14:41
+
+import django.db.models.deletion
+import taggit.managers
+import utilities.json
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('dcim', '0200_populate_mac_addresses'),
+        ('extras', '0122_charfield_null_choices'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Command',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)),
+                ('created', models.DateTimeField(auto_now_add=True, null=True)),
+                ('last_updated', models.DateTimeField(auto_now=True, null=True)),
+                ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=utilities.json.CustomFieldJSONEncoder)),
+                ('name', models.CharField(max_length=100)),
+                ('command', models.TextField()),
+                ('description', models.TextField(blank=True)),
+                ('device_type', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='toolkit_commands', to='dcim.devicetype')),
+                ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+        migrations.CreateModel(
+            name='CommandLog',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)),
+                ('created', models.DateTimeField(auto_now_add=True, null=True)),
+                ('last_updated', models.DateTimeField(auto_now=True, null=True)),
+                ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=utilities.json.CustomFieldJSONEncoder)),
+                ('output', models.TextField()),
+                ('username', models.CharField(max_length=100)),
+                ('execution_time', models.DateTimeField(auto_now_add=True)),
+                ('command', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='logs', to='netbox_toolkit.command')),
+                ('device', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='command_logs', to='dcim.device')),
+                ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

netbox_toolkit/migrations/0002_alter_command_options_alter_command_unique_together_and_more.py

@@ -0,0 +1,66 @@
+# Generated by Django 5.1.4 on 2025-05-26 12:11
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('dcim', '0200_populate_mac_addresses'),
+        ('netbox_toolkit', '0001_initial'),
+    ]
+
+    operations = [
+        # First remove the old field
+        migrations.RemoveField(
+            model_name='command',
+            name='device_type',
+        ),
+        # Add all new fields
+        migrations.AddField(
+            model_name='command',
+            name='platform',
+            field=models.ForeignKey(default=1, on_delete=django.db.models.deletion.CASCADE, related_name='toolkit_commands', to='dcim.platform'),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name='command',
+            name='command_type',
+            field=models.CharField(default='show', max_length=50),
+        ),
+        migrations.AddField(
+            model_name='command',
+            name='requires_config_mode',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name='command',
+            name='requires_enable',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name='commandlog',
+            name='error_message',
+            field=models.TextField(blank=True),
+        ),
+        migrations.AddField(
+            model_name='commandlog',
+            name='execution_duration',
+            field=models.FloatField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='commandlog',
+            name='success',
+            field=models.BooleanField(default=True),
+        ),
+        # Then alter model options after fields exist
+        migrations.AlterModelOptions(
+            name='command',
+            options={'ordering': ['platform', 'name']},
+        ),
+        migrations.AlterUniqueTogether(
+            name='command',
+            unique_together={('platform', 'name')},
+        ),
+    ]

netbox_toolkit/migrations/0003_permission_system_update.py

@@ -0,0 +1,48 @@
+# Generated by Django 5.1.4 on 2025-05-26 15:28
+
+from django.db import migrations
+
+
+def migrate_command_types(apps, schema_editor):
+    """
+    Migrate existing diagnostic and troubleshooting commands to 'show' type
+    """
+    Command = apps.get_model('netbox_toolkit', 'Command')
+    
+    # Update diagnostic commands to show
+    diagnostic_count = Command.objects.filter(command_type='diagnostic').update(command_type='show')
+    
+    # Update troubleshooting commands to show  
+    troubleshooting_count = Command.objects.filter(command_type='troubleshooting').update(command_type='show')
+    
+    print(f"Migration: Updated {diagnostic_count} diagnostic commands to 'show' type")
+    print(f"Migration: Updated {troubleshooting_count} troubleshooting commands to 'show' type")
+
+
+def reverse_migrate_command_types(apps, schema_editor):
+    """
+    Reverse migration - this is a simplified reverse that sets all to 'show'
+    since we can't reliably determine original diagnostic vs troubleshooting
+    """
+    # Note: This is a lossy reverse operation
+    # In practice, this is acceptable since diagnostic/troubleshooting
+    # were being removed as part of the permission system design
+    pass
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('netbox_toolkit', '0002_alter_command_options_alter_command_unique_together_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='command',
+            options={'ordering': ['platform', 'name'], 'permissions': [('execute_show_command', 'Can execute show commands'), ('execute_config_command', 'Can execute configuration commands')]},
+        ),
+        migrations.RunPython(
+            migrate_command_types,
+            reverse_migrate_command_types,
+        ),
+    ]

netbox_toolkit/migrations/0004_remove_django_permissions.py

@@ -0,0 +1,77 @@
+# Generated migration to remove Django custom permissions for object-based permissions migration
+
+from django.db import migrations
+
+
+def remove_django_permissions(apps, schema_editor):
+    """Remove old Django permissions that are no longer needed"""
+    Permission = apps.get_model('auth', 'Permission')
+    ContentType = apps.get_model('contenttypes', 'ContentType')
+    
+    try:
+        # Get the Command content type
+        command_ct = ContentType.objects.get(app_label='netbox_toolkit', model='command')
+        
+        # Remove the custom Django permissions
+        custom_permissions = [
+            'execute_show_command',
+            'execute_config_command'
+        ]
+        
+        deleted_count = 0
+        for codename in custom_permissions:
+            count, _ = Permission.objects.filter(
+                content_type=command_ct,
+                codename=codename
+            ).delete()
+            deleted_count += count
+        
+        print(f"Removed {deleted_count} old Django permissions")
+        
+    except ContentType.DoesNotExist:
+        # Command model doesn't exist yet, skip
+        print("Command model not found, skipping permission removal")
+    except Exception as e:
+        print(f"Warning: Could not remove old permissions: {e}")
+
+def restore_django_permissions(apps, schema_editor):
+    """Restore Django permissions if migration is reversed"""
+    Permission = apps.get_model('auth', 'Permission')
+    ContentType = apps.get_model('contenttypes', 'ContentType')
+    
+    try:
+        # Get the Command content type
+        command_ct = ContentType.objects.get(app_label='netbox_toolkit', model='command')
+        
+        # Recreate the custom Django permissions
+        permissions_to_create = [
+            ('execute_show_command', 'Can execute show commands'),
+            ('execute_config_command', 'Can execute configuration commands'),
+        ]
+        
+        for codename, name in permissions_to_create:
+            Permission.objects.get_or_create(
+                content_type=command_ct,
+                codename=codename,
+                defaults={'name': name}
+            )
+        
+        print("Restored old Django permissions")
+        
+    except ContentType.DoesNotExist:
+        # Command model doesn't exist, skip
+        print("Command model not found, skipping permission restoration")
+
+
+class Migration(migrations.Migration):
+    
+    dependencies = [
+        ('netbox_toolkit', '0003_permission_system_update'),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            remove_django_permissions,
+            restore_django_permissions,
+        ),
+    ]

netbox_toolkit/migrations/0005_alter_command_options_and_more.py

@@ -0,0 +1,25 @@
+# Generated by Django 5.1.4 on 2025-05-27 12:54
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('netbox_toolkit', '0004_remove_django_permissions'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='command',
+            options={'ordering': ['platform', 'name']},
+        ),
+        migrations.RemoveField(
+            model_name='command',
+            name='requires_config_mode',
+        ),
+        migrations.RemoveField(
+            model_name='command',
+            name='requires_enable',
+        ),
+    ]

netbox_toolkit/migrations/0006_commandlog_parsed_data_commandlog_parsing_success_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.1.4 on 2025-05-29 11:47
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('netbox_toolkit', '0005_alter_command_options_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='commandlog',
+            name='parsed_data',
+            field=models.JSONField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='commandlog',
+            name='parsing_success',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name='commandlog',
+            name='parsing_template',
+            field=models.CharField(blank=True, max_length=255),
+        ),
+    ]

netbox_toolkit/migrations/0007_alter_commandlog_parsing_template.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.4 on 2025-05-29 12:00
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('netbox_toolkit', '0006_commandlog_parsed_data_commandlog_parsing_success_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='commandlog',
+            name='parsing_template',
+            field=models.CharField(blank=True, max_length=255, null=True),
+        ),
+    ]

netbox_toolkit/models.py

@@ -0,0 +1,89 @@
+from django.db import models
+from django.core.exceptions import ValidationError
+from netbox.models import NetBoxModel
+from dcim.models import Device
+
+class Command(NetBoxModel):
+    name = models.CharField(max_length=100)
+    command = models.TextField()
+    description = models.TextField(blank=True)
+    
+    # Platform-based association (required)
+    platform = models.ForeignKey(
+        to='dcim.Platform',
+        on_delete=models.CASCADE,
+        related_name='toolkit_commands',
+        help_text="Platform this command is designed for (e.g., cisco_ios, cisco_nxos, generic)"
+    )
+    
+    # Command categorization
+    command_type = models.CharField(
+        max_length=50,
+        choices=[
+            ('show', 'Show Command'),
+            ('config', 'Configuration Command'),
+        ],
+        default='show',
+        help_text="Type of command for categorization and permission control"
+    )
+
+    class Meta:
+        ordering = ['platform', 'name']
+        unique_together = [['platform', 'name']]
+
+    def __str__(self):
+        return f"{self.name} ({self.platform})"
+    
+    def get_absolute_url(self):
+        """Return the URL for this object"""
+        from django.urls import reverse
+        return reverse('plugins:netbox_toolkit:command_detail', kwargs={'pk': self.pk})
+
+class CommandLog(NetBoxModel):
+    command = models.ForeignKey(
+        to=Command,
+        on_delete=models.CASCADE,
+        related_name='logs'
+    )
+    device = models.ForeignKey(
+        to='dcim.Device',
+        on_delete=models.CASCADE,
+        related_name='command_logs'
+    )
+    output = models.TextField()
+    username = models.CharField(max_length=100)
+    execution_time = models.DateTimeField(auto_now_add=True)
+    
+    # Execution details added in migration
+    success = models.BooleanField(default=True)
+    error_message = models.TextField(blank=True)
+    execution_duration = models.FloatField(
+        blank=True,
+        null=True,
+        help_text="Command execution time in seconds"
+    )
+    
+    # Parsing details for TextFSM
+    parsed_data = models.JSONField(
+        blank=True,
+        null=True,
+        help_text="Parsed structured data from command output"
+    )
+    parsing_success = models.BooleanField(
+        default=False,
+        help_text="Whether the output was successfully parsed"
+    )
+    parsing_template = models.CharField(
+        max_length=255,
+        blank=True,
+        null=True,
+        help_text="Name of the TextFSM template used for parsing"
+    )
+
+    def __str__(self):
+        return f"{self.command} on {self.device}"
+    
+    def get_absolute_url(self):
+        """Return the URL for this object"""
+        from django.urls import reverse
+        return reverse('plugins:netbox_toolkit:commandlog_view', kwargs={'pk': self.pk})

netbox_toolkit/navigation.py

@@ -0,0 +1,30 @@
+from netbox.choices import ButtonColorChoices
+from netbox.plugins import PluginMenu, PluginMenuButton, PluginMenuItem
+
+menu = PluginMenu(
+    label="Command Toolkit",
+    icon_class="mdi mdi-console",
+    groups=(
+        (
+            "Commands",
+            (
+                PluginMenuItem(
+                    link="plugins:netbox_toolkit:command_list",
+                    link_text="Commands",
+                    buttons=(
+                        PluginMenuButton(
+                            "plugins:netbox_toolkit:command_add",
+                            "Add",
+                            "mdi mdi-plus-thick",
+                            ButtonColorChoices.GRAY
+                        ),
+                    )
+                ),
+                PluginMenuItem(
+                    link="plugins:netbox_toolkit:commandlog_list",
+                    link_text="Command Logs",
+                ),
+            ),
+        ),
+    ),
+)

netbox_toolkit/search.py

@@ -0,0 +1,21 @@
+from netbox.search import SearchIndex
+from .models import Command, CommandLog
+
+class CommandIndex(SearchIndex):
+    model = Command
+    fields = (
+        ('name', 100),
+        ('command', 200),
+        ('description', 500),
+    )
+    display_attrs = ('platform', 'command_type', 'description')
+
+class CommandLogIndex(SearchIndex):
+    model = CommandLog
+    fields = (
+        ('command__name', 100),
+        ('device__name', 150),
+        ('username', 200),
+        ('output', 1000),
+    )
+    display_attrs = ('command', 'device', 'success', 'execution_time')

netbox_toolkit/services/__init__.py

@@ -0,0 +1,7 @@
+"""Services package for business logic."""
+
+from .command_service import CommandExecutionService
+from .device_service import DeviceService
+from .rate_limiting_service import RateLimitingService
+
+__all__ = ['CommandExecutionService', 'DeviceService', 'RateLimitingService']