netbox-toolkit-plugin 0.1.0__tar.gz → 0.1.1__tar.gz

{netbox_toolkit_plugin-0.1.0/netbox_toolkit_plugin.egg-info → netbox_toolkit_plugin-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-toolkit-plugin
-Version: 0.1.0
+Version: 0.1.1
 Summary: NetBox plugin for running pre-defined commands on network devices
 Author: Andy Norwood
 Classifier: Development Status :: 3 - Alpha
@@ -58,7 +58,7 @@ A NetBox plugin that allows you to run commands on network devices directly from
 
 #### 📋 Command Management  
 - [📋 Command Creation](./docs/user/command-creation.md) - Create platform-specific commands
-- [🔐 Permissions Setup](./docs/user/PERMISSIONS_SETUP_GUIDE.md) - Configure granular access control
+- [🔐 Permissions Setup](./docs/user/permissions-setup-guide.md) - Configure granular access control
 - [📝 Permission Examples](./docs/user/permission-examples.md) - Example permission configuration
 
 #### 🔧 Troubleshooting

{netbox_toolkit_plugin-0.1.0 → netbox_toolkit_plugin-0.1.1}/README.md

@@ -37,7 +37,7 @@ A NetBox plugin that allows you to run commands on network devices directly from
 
 #### 📋 Command Management  
 - [📋 Command Creation](./docs/user/command-creation.md) - Create platform-specific commands
-- [🔐 Permissions Setup](./docs/user/PERMISSIONS_SETUP_GUIDE.md) - Configure granular access control
+- [🔐 Permissions Setup](./docs/user/permissions-setup-guide.md) - Configure granular access control
 - [📝 Permission Examples](./docs/user/permission-examples.md) - Example permission configuration
 
 #### 🔧 Troubleshooting

netbox_toolkit_plugin-0.1.1/netbox_toolkit_plugin/__init__.py

@@ -0,0 +1,32 @@
+from netbox.plugins import PluginConfig
+
+__author__ = "Andy Norwood"
+__version__ = "0.1.1"
+
+
+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_plugin-0.1.0/netbox_toolkit → netbox_toolkit_plugin-0.1.1/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_plugin-0.1.0/netbox_toolkit → netbox_toolkit_plugin-0.1.1/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

{netbox_toolkit_plugin-0.1.0/netbox_toolkit → netbox_toolkit_plugin-0.1.1/netbox_toolkit_plugin}/config.py

@@ -1,81 +1,82 @@
 """Configuration settings for the NetBox Toolkit plugin."""
+
 from typing import Dict, Any
 from django.conf import settings
 
 
-class ToolkitConfig:
+class ToolkitSettings:
     """Configuration class for toolkit settings."""
-    
+
     # Default connection timeouts
     DEFAULT_TIMEOUTS = {
-        'socket': 15,
-        'transport': 15,
-        'ops': 30,
-        'banner': 15,
-        'auth': 15,
+        "socket": 15,
+        "transport": 15,
+        "ops": 30,
+        "banner": 15,
+        "auth": 15,
     }
-    
+
     # Device-specific timeout overrides
     DEVICE_TIMEOUTS = {
-        'catalyst': {
-            'socket': 20,
-            'transport': 20,
-            'ops': 45,
+        "catalyst": {
+            "socket": 20,
+            "transport": 20,
+            "ops": 45,
         },
-        'nexus': {
-            'socket': 25,
-            'transport': 25,
-            'ops': 60,
+        "nexus": {
+            "socket": 25,
+            "transport": 25,
+            "ops": 60,
         },
     }
-    
+
     # SSH transport options
     SSH_TRANSPORT_OPTIONS = {
-        'disabled_algorithms': {
-            'kex': [],  # Don't disable any key exchange methods
+        "disabled_algorithms": {
+            "kex": [],  # Don't disable any key exchange methods
         },
-        'allowed_kex': [
+        "allowed_kex": [
             # Modern algorithms
-            'diffie-hellman-group-exchange-sha256',
-            'diffie-hellman-group16-sha512',
-            'diffie-hellman-group18-sha512',
-            'diffie-hellman-group14-sha256',
+            "diffie-hellman-group-exchange-sha256",
+            "diffie-hellman-group16-sha512",
+            "diffie-hellman-group18-sha512",
+            "diffie-hellman-group14-sha256",
             # Legacy algorithms for older devices
-            'diffie-hellman-group-exchange-sha1',
-            'diffie-hellman-group14-sha1',
-            'diffie-hellman-group1-sha1',
+            "diffie-hellman-group-exchange-sha1",
+            "diffie-hellman-group14-sha1",
+            "diffie-hellman-group1-sha1",
         ],
     }
-    
+
     # Netmiko configuration for fallback connections
     NETMIKO_CONFIG = {
-        'banner_timeout': 20,
-        'auth_timeout': 20,
-        'global_delay_factor': 1,
-        'use_keys': False,           # Disable SSH key authentication
-        'allow_agent': False,        # Disable SSH agent
+        "banner_timeout": 20,
+        "auth_timeout": 20,
+        "global_delay_factor": 1,
+        "use_keys": False,  # Disable SSH key authentication
+        "allow_agent": False,  # Disable SSH agent
         # Session logging (disabled by default)
-        'session_log': None,
+        "session_log": None,
         # Connection options for legacy devices
-        'fast_cli': False,           # Disable for older devices
-        'session_log_record_writes': False,
-        'session_log_file_mode': 'write',
+        "fast_cli": False,  # Disable for older devices
+        "session_log_record_writes": False,
+        "session_log_file_mode": "write",
     }
-    
+
     # Retry configuration
     RETRY_CONFIG = {
-        'max_retries': 2,
-        'retry_delay': 1,  # Reduced from 3s to 1s for faster fallback
-        'backoff_multiplier': 1.5,  # Reduced from 2 to 1.5 for faster progression
+        "max_retries": 2,
+        "retry_delay": 1,  # Reduced from 3s to 1s for faster fallback
+        "backoff_multiplier": 1.5,  # Reduced from 2 to 1.5 for faster progression
     }
-    
+
     # Fast connection test timeouts (for initial Scrapli viability testing)
     FAST_TEST_TIMEOUTS = {
-        'socket': 8,      # Reduced from 15s to 8s for faster detection
-        'transport': 8,   # Reduced from 15s to 8s for faster detection
-        'ops': 15,        # Keep ops timeout reasonable for actual commands
+        "socket": 8,  # Reduced from 15s to 8s for faster detection
+        "transport": 8,  # Reduced from 15s to 8s for faster detection
+        "ops": 15,  # Keep ops timeout reasonable for actual commands
     }
-    
+
     # Error patterns that should trigger immediate fallback to Netmiko
     SCRAPLI_FAST_FAIL_PATTERNS = [
         "No matching key exchange",
@@ -83,77 +84,83 @@ class ToolkitConfig:
         "No matching MAC",
         "connection not opened",
         "Error reading SSH protocol banner",
-        "Connection refused", 
+        "Connection refused",
         "Operation timed out",
         "SSH handshake failed",
         "Protocol version not supported",
         "Unable to connect to port 22",
         "Name or service not known",
-        "Network is unreachable"
+        "Network is unreachable",
     ]
-    
+
     # Platform mappings for better recognition
     PLATFORM_ALIASES = {
-        'ios': 'cisco_ios',
-        'iosxe': 'cisco_ios',
-        'nxos': 'cisco_nxos',
-        'iosxr': 'cisco_iosxr',
-        'junos': 'juniper_junos',
-        'eos': 'arista_eos',
+        "ios": "cisco_ios",
+        "iosxe": "cisco_ios",
+        "nxos": "cisco_nxos",
+        "iosxr": "cisco_iosxr",
+        "junos": "juniper_junos",
+        "eos": "arista_eos",
     }
-    
+
     @classmethod
     def get_fast_test_timeouts(cls) -> Dict[str, int]:
         """Get fast connection test timeouts for initial viability testing."""
         return cls.FAST_TEST_TIMEOUTS.copy()
-    
+
     @classmethod
     def should_fast_fail_to_netmiko(cls, error_message: str) -> bool:
         """Check if error message indicates immediate fallback to Netmiko is needed."""
         error_lower = error_message.lower()
-        return any(pattern.lower() in error_lower for pattern in cls.SCRAPLI_FAST_FAIL_PATTERNS)
-    
+        return any(
+            pattern.lower() in error_lower for pattern in cls.SCRAPLI_FAST_FAIL_PATTERNS
+        )
+
     @classmethod
-    def get_timeouts_for_device(cls, device_type_model: str = None) -> Dict[str, int]:
+    def get_timeouts_for_device(cls, device_type_model: str = "") -> Dict[str, int]:
         """Get timeout configuration for a specific device type."""
         timeouts = cls.DEFAULT_TIMEOUTS.copy()
-        
+
         if device_type_model:
             model_lower = device_type_model.lower()
             for device_keyword, custom_timeouts in cls.DEVICE_TIMEOUTS.items():
                 if device_keyword in model_lower:
                     timeouts.update(custom_timeouts)
                     break
-        
+
         return timeouts
-    
+
     @classmethod
     def normalize_platform(cls, platform: str) -> str:
         """Normalize platform name using aliases."""
         if not platform:
-            return None
-        
+            return ""
+
         platform_lower = platform.lower()
         return cls.PLATFORM_ALIASES.get(platform_lower, platform_lower)
-    
+
     @classmethod
     def get_ssh_options(cls) -> Dict[str, Any]:
         """Get SSH transport options."""
         return cls.SSH_TRANSPORT_OPTIONS.copy()
-    
+
     @classmethod
     def get_retry_config(cls) -> Dict[str, int]:
         """Get retry configuration."""
         return cls.RETRY_CONFIG.copy()
-    
+
     @classmethod
     def get_ssh_transport_options(cls) -> Dict[str, Any]:
         """Get SSH transport options for Scrapli."""
-        user_config = getattr(settings, 'NETBOX_TOOLKIT', {})
-        return {**cls.SSH_TRANSPORT_OPTIONS, **user_config.get('ssh_options', {})}
-    
+        user_config = getattr(settings, "PLUGINS_CONFIG", {}).get(
+            "netbox_toolkit_plugin", {}
+        )
+        return {**cls.SSH_TRANSPORT_OPTIONS, **user_config.get("ssh_options", {})}
+
     @classmethod
     def get_netmiko_config(cls) -> Dict[str, Any]:
         """Get Netmiko configuration for fallback connections."""
-        user_config = getattr(settings, 'NETBOX_TOOLKIT', {})
-        return {**cls.NETMIKO_CONFIG, **user_config.get('netmiko', {})}
+        user_config = getattr(settings, "PLUGINS_CONFIG", {}).get(
+            "netbox_toolkit_plugin", {}
+        )
+        return {**cls.NETMIKO_CONFIG, **user_config.get("netmiko", {})}