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

netbox_toolkit_plugin/__init__.py

@@ -0,0 +1,32 @@
+from netbox.plugins import PluginConfig
+
+__author__ = "Andy Norwood"
+__version__ = "0.1.2"
+
+
+class ToolkitPluginConfig(PluginConfig):
+    """NetBox plugin configuration for the Toolkit plugin."""
+
+    name = "netbox_toolkit_plugin"
+    verbose_name = "Command Toolkit Plugin"
+    description = "NetBox plugin for running pre-defined commands on network devices"
+    version = __version__
+    author = __author__
+    base_url = "toolkit"
+    min_version = "4.2.0"
+
+    # Database migrations
+    required_settings = []
+
+    # Default plugin settings
+    default_settings = {
+        "rate_limiting_enabled": True,
+        "device_command_limit": 10,
+        "time_window_minutes": 5,
+        "bypass_users": [],
+        "bypass_groups": [],
+        "debug_logging": False,  # Enable debug logging for this plugin
+    }
+
+
+config = ToolkitPluginConfig

{netbox_toolkit → netbox_toolkit_plugin}/api/serializers.py

@@ -3,33 +3,36 @@ from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializ
 from dcim.api.serializers import PlatformSerializer, DeviceSerializer
 from ..models import Command, CommandLog
 
+
 class CommandExecutionSerializer(serializers.Serializer):
     """Serializer for command execution input validation"""
+
     device_id = serializers.IntegerField(
         help_text="ID of the device to execute the command on"
     )
     username = serializers.CharField(
         max_length=100,
         help_text="Username for device authentication",
-        trim_whitespace=True
+        trim_whitespace=True,
     )
     password = serializers.CharField(
         max_length=255,
-        style={'input_type': 'password'},
+        style={"input_type": "password"},
         help_text="Password for device authentication",
-        trim_whitespace=False
+        trim_whitespace=False,
     )
     timeout = serializers.IntegerField(
         required=False,
         default=30,
         min_value=5,
         max_value=300,
-        help_text="Command execution timeout in seconds (5-300)"
+        help_text="Command execution timeout in seconds (5-300)",
     )
-    
+
     def validate_device_id(self, value):
         """Validate that the device exists and has required attributes"""
         from dcim.models import Device
+
         try:
             device = Device.objects.get(id=value)
             if not device.platform:
@@ -43,17 +46,17 @@ class CommandExecutionSerializer(serializers.Serializer):
             return value
         except Device.DoesNotExist:
             raise serializers.ValidationError("Device not found")
-    
+
     def validate(self, data):
         """Cross-field validation and object retrieval"""
         from dcim.models import Device
-        
+
         # Get the actual device object for use in views
-        device = Device.objects.get(id=data['device_id'])
-        data['device'] = device
-        
+        device = Device.objects.get(id=data["device_id"])
+        data["device"] = device
+
         return data
-    
+
     def validate_username(self, value):
         """Validate username format"""
         if not value.strip():
@@ -61,7 +64,7 @@ class CommandExecutionSerializer(serializers.Serializer):
         if len(value.strip()) < 2:
             raise serializers.ValidationError("Username must be at least 2 characters")
         return value.strip()
-    
+
     def validate_password(self, value):
         """Validate password"""
         if not value:
@@ -70,33 +73,45 @@ class CommandExecutionSerializer(serializers.Serializer):
             raise serializers.ValidationError("Password must be at least 3 characters")
         return value
 
+
 class NestedCommandSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(
-        view_name='plugins-api:netbox_toolkit-api:command-detail'
+        view_name="plugins-api:netbox_toolkit_plugin-api:command-detail"
     )
 
     class Meta:
         model = Command
-        fields = ('id', 'url', 'name', 'display')
+        fields = ("id", "url", "name", "display")
+
 
 class CommandSerializer(NetBoxModelSerializer):
     url = serializers.HyperlinkedIdentityField(
-        view_name='plugins-api:netbox_toolkit-api:command-detail'
+        view_name="plugins-api:netbox_toolkit_plugin-api:command-detail"
     )
     platform = PlatformSerializer(nested=True)
 
     class Meta:
         model = Command
         fields = (
-            'id', 'url', 'display', 'name', 'command', 'description', 
-            'platform', 'command_type',
-            'tags', 'custom_fields', 'created', 'last_updated'
+            "id",
+            "url",
+            "display",
+            "name",
+            "command",
+            "description",
+            "platform",
+            "command_type",
+            "tags",
+            "custom_fields",
+            "created",
+            "last_updated",
         )
-        brief_fields = ('id', 'url', 'display', 'name', 'command_type', 'platform')
+        brief_fields = ("id", "url", "display", "name", "command_type", "platform")
+
 
 class CommandLogSerializer(NetBoxModelSerializer):
     url = serializers.HyperlinkedIdentityField(
-        view_name='plugins-api:netbox_toolkit-api:commandlog-detail'
+        view_name="plugins-api:netbox_toolkit_plugin-api:commandlog-detail"
     )
     command = NestedCommandSerializer()
     device = DeviceSerializer(nested=True)
@@ -104,38 +119,58 @@ class CommandLogSerializer(NetBoxModelSerializer):
     class Meta:
         model = CommandLog
         fields = (
-            'id', 'url', 'display', 'command', 'device', 'output', 
-            'username', 'execution_time', 'success', 'error_message', 'execution_duration',
-            'parsed_data', 'parsing_success', 'parsing_template',
-            'created', 'last_updated'
+            "id",
+            "url",
+            "display",
+            "command",
+            "device",
+            "output",
+            "username",
+            "execution_time",
+            "success",
+            "error_message",
+            "execution_duration",
+            "parsed_data",
+            "parsing_success",
+            "parsing_template",
+            "created",
+            "last_updated",
+        )
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "command",
+            "device",
+            "username",
+            "execution_time",
+            "success",
         )
-        brief_fields = ('id', 'url', 'display', 'command', 'device', 'username', 'execution_time', 'success')
+
 
 class BulkCommandExecutionSerializer(serializers.Serializer):
     """Serializer for bulk command execution validation"""
-    command_id = serializers.IntegerField(
-        help_text="ID of the command to execute"
-    )
+
+    command_id = serializers.IntegerField(help_text="ID of the command to execute")
     device_id = serializers.IntegerField(
         help_text="ID of the device to execute the command on"
     )
     username = serializers.CharField(
-        max_length=100,
-        help_text="Username for device authentication"
+        max_length=100, help_text="Username for device authentication"
     )
     password = serializers.CharField(
         max_length=255,
-        style={'input_type': 'password'},
-        help_text="Password for device authentication"
+        style={"input_type": "password"},
+        help_text="Password for device authentication",
     )
     timeout = serializers.IntegerField(
         required=False,
         default=30,
         min_value=5,
         max_value=300,
-        help_text="Command execution timeout in seconds"
+        help_text="Command execution timeout in seconds",
     )
-    
+
     def validate_command_id(self, value):
         """Validate that the command exists"""
         try:
@@ -143,10 +178,11 @@ class BulkCommandExecutionSerializer(serializers.Serializer):
             return value
         except Command.DoesNotExist:
             raise serializers.ValidationError("Command not found")
-    
+
     def validate_device_id(self, value):
         """Validate that the device exists"""
         from dcim.models import Device
+
         try:
             device = Device.objects.get(id=value)
             if not device.platform:

{netbox_toolkit → netbox_toolkit_plugin}/api/urls.py

@@ -1,10 +1,10 @@
 from netbox.api.routers import NetBoxRouter
 from .views import CommandViewSet, CommandLogViewSet
 
-app_name = 'netbox_toolkit'
+app_name = "netbox_toolkit_plugin"
 
 router = NetBoxRouter()
-router.register('commands', CommandViewSet)
-router.register('command-logs', CommandLogViewSet)
+router.register("commands", CommandViewSet)
+router.register("command-logs", CommandLogViewSet)
 
 urlpatterns = router.urls