From 64ede34841ae18d5f32be1be4afdd42a113ba1dc Mon Sep 17 00:00:00 2001 From: Marcin Zieba Date: Tue, 17 Feb 2026 14:11:49 +0100 Subject: [PATCH 01/62] feat: serial number matching and device conflict resolution MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add serial-based device matching to import validation: - Match devices by serial number when librenms_id lookup fails - Detect serial/hostname conflicts and offer resolution actions - Track serial_action, serial_confirmed, serial_duplicate, name_sync states in validation results - Flag device_type_mismatch when existing device type differs Add conflict resolution views and UI: - DeviceConflictActionView: resolve conflicts via link, update, update_serial, sync_name, sync_serial, sync_platform, sync_device_type - _build_sync_info: compare serial, platform, device type between NetBox and LibreNMS for details modal - UpdateDeviceNameView: sync device name from LibreNMS sysName - Conflict/details buttons in import table with contextual styling Template and JS improvements: - Rewrite device_validation_details.html for conflict UI - Add name row with sync button to sync base template - Expand import modal to modal-xl for conflict details - DRY hideModal usage in librenms_import.js with Bootstrap fallback Tests: - TestSerialNumberMatching: 20+ test cases covering serial matching, hostname conflicts, serial drift, duplicate detection, device type mismatch, and linked device validation - Fix test_add_device_duplicate_error status code (500→200) --- netbox_librenms_plugin/import_utils.py | 316 +++-- .../js/librenms_import.js | 81 +- .../tables/device_status.py | 40 +- .../htmx/device_validation_details.html | 795 +++++++----- .../librenms_import.html | 2 +- .../librenms_sync_base.html | 28 + .../tests/test_import_utils.py | 1073 +++++++++++++++++ .../tests/test_librenms_api.py | 2 +- netbox_librenms_plugin/urls.py | 14 +- netbox_librenms_plugin/views/__init__.py | 2 + .../views/imports/__init__.py | 2 + .../views/imports/actions.py | 248 ++++ .../views/sync/device_fields.py | 49 + 13 files changed, 2220 insertions(+), 432 deletions(-) diff --git a/netbox_librenms_plugin/import_utils.py b/netbox_librenms_plugin/import_utils.py index cb9c9a99e7..feac6e3e99 100644 --- a/netbox_librenms_plugin/import_utils.py +++ b/netbox_librenms_plugin/import_utils.py @@ -706,6 +706,13 @@ def validate_device_for_import( "import_as_vm": import_as_vm, "existing_device": None, "existing_match_type": None, # Track how existing device was matched + "serial_action": None, # None, "link", "conflict", "update_serial", "hostname_differs" + "serial_confirmed": False, # True when librenms_id match and serial matches + "serial_duplicate": False, # True when incoming serial is already on a different device + "name_matches": False, # True when existing device name matches LibreNMS sysName + "name_sync_available": False, # True when existing device name differs from sysName + "suggested_name": None, # sysName to suggest when name_sync_available is True + "device_type_mismatch": False, # True when existing device's type differs from LibreNMS "issues": [], "warnings": [], "virtual_chassis": empty_virtual_chassis_data(), @@ -765,78 +772,166 @@ def validate_device_for_import( result["existing_device"] = existing_vm result["existing_match_type"] = "librenms_id" result["import_as_vm"] = True # Force VM mode since VM exists - result["warnings"].append(f"VM already imported to NetBox as '{existing_vm.name}'") result["can_import"] = False - return result + + # Check if name matches sysName + # Note: name_sync_available/suggested_name are intentionally not set for VMs + # because UpdateDeviceNameView only supports Device objects; VM name-sync + # would require a separate implementation. + sys_name = libre_device.get("sysName") or "" + if sys_name and existing_vm.name == sys_name: + result["name_matches"] = True # Check for existing Device (by librenms_id custom field) # Always query with int to match custom field type - try: - existing_device = Device.objects.filter(custom_field_data__librenms_id=int(librenms_id)).first() - except (ValueError, TypeError): - # librenms_id is not convertible to int; no match will be found - existing_device = None - - if existing_device: - logger.info(f"Found existing device: {existing_device.name} (matched by librenms_id={librenms_id})") - result["existing_device"] = existing_device - result["existing_match_type"] = "librenms_id" - result["warnings"].append(f"Device already imported to NetBox as '{existing_device.name}'") - result["can_import"] = False - return result + if not result["existing_device"]: + try: + existing_device = Device.objects.filter(custom_field_data__librenms_id=int(librenms_id)).first() + except (ValueError, TypeError): + # librenms_id is not convertible to int; no match will be found + existing_device = None + + if existing_device: + logger.info(f"Found existing device: {existing_device.name} (matched by librenms_id={librenms_id})") + result["existing_device"] = existing_device + result["existing_match_type"] = "librenms_id" + result["can_import"] = False + + # Check if name matches sysName + sys_name = libre_device.get("sysName") or "" + if sys_name and existing_device.name == sys_name: + result["name_matches"] = True + elif sys_name and existing_device.name != sys_name: + result["name_sync_available"] = True + result["suggested_name"] = sys_name + + # Check for serial drift on the linked device + incoming_serial = libre_device.get("serial") or "" + if incoming_serial and incoming_serial != "-": + if existing_device.serial and existing_device.serial == incoming_serial: + result["serial_confirmed"] = True + elif existing_device.serial and existing_device.serial != incoming_serial: + serial_conflict = ( + Device.objects.filter(serial=incoming_serial).exclude(pk=existing_device.pk).first() + ) + if serial_conflict: + result["serial_action"] = "conflict" + result["serial_duplicate"] = True + result["warnings"].append( + f"Serial conflict: incoming serial '{incoming_serial}' is already assigned to " + f"device '{serial_conflict.name}' (ID: {serial_conflict.pk}) in NetBox. " + f"Investigate which device should own this serial before updating." + ) + else: + result["serial_action"] = "update_serial" + result["warnings"].append( + f"Serial number differs (NetBox: '{existing_device.serial}', " + f"LibreNMS: '{incoming_serial}'). Hardware may have been replaced." + ) - # Check by hostname/name - Check both VMs and Devices for conflicts - existing_vm = VirtualMachine.objects.filter(name__iexact=hostname).first() - existing_device = Device.objects.filter(name__iexact=hostname).first() + # Only check hostname/serial/IP if not already matched by librenms_id + if not result["existing_device"]: + # Check by hostname/name - Check both VMs and Devices for conflicts + existing_vm = VirtualMachine.objects.filter(name__iexact=hostname).first() + existing_device = Device.objects.filter(name__iexact=hostname).first() - # If BOTH exist with same hostname, it's ambiguous - don't match either - if existing_vm and existing_device: - logger.warning( - f"Hostname conflict: Both VM '{existing_vm.name}' and Device " - f"'{existing_device.name}' exist with hostname '{hostname}'" - ) - result["warnings"].append( - f"Both a VM and Device exist with hostname '{hostname}' in NetBox. " - f"Cannot determine which to match. Please set the librenms_id custom field on the correct object." - ) - # Don't set existing_device, don't block import - let user proceed as new - # This allows them to import and then resolve the conflict manually - elif existing_vm: - logger.info(f"Found existing VM by hostname: {existing_vm.name}") - result["existing_device"] = existing_vm - result["existing_match_type"] = "hostname" - result["import_as_vm"] = True # Force VM mode since VM exists - result["warnings"].append( - f"VM with same hostname exists in NetBox as '{existing_vm.name}' (not linked to LibreNMS)" - ) - result["can_import"] = False - return result - elif existing_device: - logger.info(f"Found existing device by hostname: {existing_device.name}") - result["existing_device"] = existing_device - result["existing_match_type"] = "hostname" - result["warnings"].append( - f"Device with same hostname exists in NetBox as '{existing_device.name}' (not linked to LibreNMS)" - ) - result["can_import"] = False - return result - - # Check by primary IP (weaker match, IP could be reassigned) - only for devices - primary_ip = libre_device.get("ip") - if primary_ip and not import_as_vm: - from ipam.models import IPAddress - - existing_ip = IPAddress.objects.filter(address__startswith=primary_ip).first() - if existing_ip and existing_ip.assigned_object: - device = existing_ip.assigned_object.device if hasattr(existing_ip.assigned_object, "device") else None - if device: - result["existing_device"] = device - result["existing_match_type"] = "primary_ip" + # If BOTH exist with same hostname, it's ambiguous - don't match either + if existing_vm and existing_device: + logger.warning( + f"Hostname conflict: Both VM '{existing_vm.name}' and Device " + f"'{existing_device.name}' exist with hostname '{hostname}'" + ) + result["warnings"].append( + f"Both a VM and Device exist with hostname '{hostname}' in NetBox. " + f"Cannot determine which to match. Please set the librenms_id custom field on the correct object." + ) + # Don't set existing_device, don't block import - let user proceed as new + # This allows them to import and then resolve the conflict manually + elif existing_vm: + logger.info(f"Found existing VM by hostname: {existing_vm.name}") + result["existing_device"] = existing_vm + result["existing_match_type"] = "hostname" + result["import_as_vm"] = True # Force VM mode since VM exists + result["warnings"].append( + f"VM with same hostname exists in NetBox as '{existing_vm.name}' (not linked to LibreNMS)" + ) + result["can_import"] = False + elif existing_device: + logger.info(f"Found existing device by hostname: {existing_device.name}") + result["existing_device"] = existing_device + result["existing_match_type"] = "hostname" + + # Check for serial conflict on hostname-matched device + incoming_serial = libre_device.get("serial") or "" + if incoming_serial and incoming_serial != "-" and existing_device.serial != incoming_serial: + serial_conflict = ( + Device.objects.filter(serial=incoming_serial).exclude(pk=existing_device.pk).first() + ) + if serial_conflict: + result["serial_action"] = "conflict" + result["serial_duplicate"] = True + result["warnings"].append( + f"Serial conflict: incoming serial '{incoming_serial}' is already assigned to " + f"device '{serial_conflict.name}' (ID: {serial_conflict.pk}) in NetBox. " + f"Investigate which device should own this serial before importing." + ) + else: + result["serial_action"] = "update_serial" + result["warnings"].append( + f"Hostname matches but serial differs (NetBox: '{existing_device.serial}', " + f"LibreNMS: '{incoming_serial}'). Hardware may have been replaced." + ) + else: result["warnings"].append( - f"IP address {primary_ip} already assigned to device '{device.name}' (not linked to LibreNMS)" + f"Device with same hostname exists in NetBox as '{existing_device.name}' (not linked to LibreNMS)" ) - result["can_import"] = False - return result + + result["can_import"] = False + + # Check by serial number (strong physical match - hardware identity) + if not result["existing_device"]: + serial = libre_device.get("serial") or "" + if serial and serial != "-" and not import_as_vm: + existing_by_serial = Device.objects.filter(serial=serial).first() + if existing_by_serial: + logger.info(f"Found existing device by serial: {existing_by_serial.name} (serial={serial})") + result["existing_device"] = existing_by_serial + result["existing_match_type"] = "serial" + result["can_import"] = False + + if existing_by_serial.name and existing_by_serial.name.lower() == hostname.lower(): + result["warnings"].append( + f"Device with same serial and hostname exists as '{existing_by_serial.name}' " + f"(not linked to LibreNMS)" + ) + result["serial_action"] = "link" + else: + result["warnings"].append( + f"Device with same serial ({serial}) exists as '{existing_by_serial.name}' " + f"but hostname differs (LibreNMS: '{hostname}'). Device may have been reinstalled." + ) + result["serial_action"] = "hostname_differs" + + # Check by primary IP (weaker match, IP could be reassigned) - only for devices + if not result["existing_device"]: + primary_ip = libre_device.get("ip") + if primary_ip and not import_as_vm: + from ipam.models import IPAddress + + existing_ip = IPAddress.objects.filter(address__net_host=primary_ip).first() + if existing_ip and existing_ip.assigned_object: + device = ( + existing_ip.assigned_object.device + if hasattr(existing_ip.assigned_object, "device") + else None + ) + if device: + result["existing_device"] = device + result["existing_match_type"] = "primary_ip" + result["warnings"].append( + f"IP address {primary_ip} already assigned to device '{device.name}' (not linked to LibreNMS)" + ) + result["can_import"] = False # Validate based on import type (Device or VM) if import_as_vm: @@ -953,13 +1048,6 @@ def validate_device_for_import( if not hostname: result["issues"].append("Device has no hostname") - # Serial number check - serial = libre_device.get("serial", "") - if serial and serial != "-": - existing_serial = Device.objects.filter(serial=serial).first() - if existing_serial: - result["warnings"].append(f"Serial number {serial} already exists on device: {existing_serial.name}") - # 7. Virtual chassis detection (only for devices, not VMs) if include_vc_detection and not import_as_vm and api is not None: device_id = libre_device.get("device_id") @@ -986,19 +1074,39 @@ def validate_device_for_import( logger.debug(f"No device_id found for {hostname}") # 8. Determine if device/VM is ready to import - result["can_import"] = len(result["issues"]) == 0 - - if import_as_vm: - # For VMs: only cluster is required - result["is_ready"] = result["can_import"] and result["cluster"]["found"] + if result["existing_device"]: + # Already matched - can_import was already set to False + result["is_ready"] = False + # Populate role from existing device so the modal shows it + existing = result["existing_device"] + if hasattr(existing, "role") and existing.role: + result["device_role"]["found"] = True + result["device_role"]["role"] = existing.role + + # Check for device type mismatch between existing device and LibreNMS + if hasattr(existing, "device_type") and existing.device_type: + librenms_dt = result["device_type"].get("device_type") + if librenms_dt and existing.device_type.pk != librenms_dt.pk: + result["device_type_mismatch"] = True + result["warnings"].append( + f"Device type mismatch: NetBox has '{existing.device_type}' " + f"but LibreNMS reports '{librenms_dt}'. " + f"This may indicate the wrong device was matched." + ) else: - # For Devices: site, device_type, and device_role are required - result["is_ready"] = ( - result["can_import"] - and result["site"]["found"] - and result["device_type"]["found"] - and result["device_role"]["found"] - ) + result["can_import"] = len(result["issues"]) == 0 + + if import_as_vm: + # For VMs: only cluster is required + result["is_ready"] = result["can_import"] and result["cluster"]["found"] + else: + # For Devices: site, device_type, and device_role are required + result["is_ready"] = ( + result["can_import"] + and result["site"]["found"] + and result["device_type"]["found"] + and result["device_role"]["found"] + ) logger.debug( f"Validation for {libre_device.get('hostname')} ({'VM' if import_as_vm else 'Device'}): " @@ -2072,6 +2180,44 @@ def create_virtual_chassis_with_members(master_device: Device, members_info: lis raise +def _refresh_existing_device(validation: dict) -> None: + """Refresh existing_device from DB to pick up changes made in NetBox since caching.""" + existing = validation.get("existing_device") + if not existing or not hasattr(existing, "pk"): + return + try: + from dcim.models import Device + from virtualization.models import VirtualMachine + + if validation.get("import_as_vm"): + refreshed = VirtualMachine.objects.filter(pk=existing.pk).first() + else: + refreshed = Device.objects.filter(pk=existing.pk).first() + + if refreshed: + validation["existing_device"] = refreshed + if hasattr(refreshed, "role") and refreshed.role: + validation["device_role"] = {"found": True, "role": refreshed.role} + else: + # Device was deleted since caching — recompute readiness + validation["existing_device"] = None + validation["existing_match_type"] = None + validation["can_import"] = True + if validation.get("import_as_vm"): + validation["is_ready"] = bool( + validation.get("site", {}).get("found") and validation.get("device_role", {}).get("found") + ) + else: + validation["is_ready"] = bool( + validation.get("site", {}).get("found") + and validation.get("device_type", {}).get("found") + and validation.get("device_role", {}).get("found") + ) + except Exception as e: + existing_id = getattr(existing, "pk", "unknown") if existing else "none" + logger.error(f"Failed to refresh existing device (pk={existing_id}): {e}") + + def process_device_filters( api: LibreNMSAPI, filters: dict, @@ -2232,6 +2378,10 @@ def process_device_filters( # Use cached validation device["_validation"] = cached_device["_validation"] + # Refresh existing_device from DB to avoid stale data + # (user may have changed role, name, etc. in NetBox) + _refresh_existing_device(device["_validation"]) + # Apply exclude_existing filter if enabled if exclude_existing: validation = device["_validation"] diff --git a/netbox_librenms_plugin/static/netbox_librenms_plugin/js/librenms_import.js b/netbox_librenms_plugin/static/netbox_librenms_plugin/js/librenms_import.js index 04cae5395b..ab1e8a756d 100644 --- a/netbox_librenms_plugin/static/netbox_librenms_plugin/js/librenms_import.js +++ b/netbox_librenms_plugin/static/netbox_librenms_plugin/js/librenms_import.js @@ -265,6 +265,8 @@ * * @param {HTMLElement} modalElement - The modal element to hide * @param {Object} fallbackBackdropRef - Reference object containing fallback backdrop (deprecated) + * WONTFIX: fallbackBackdropRef is unused — _hideManual uses querySelector which is + * correct for this plugin since only one modal is ever open at a time (Tabler, no Bootstrap). */ function hideModal(modalElement, fallbackBackdropRef) { if (!modalElement) { @@ -272,6 +274,14 @@ } const manager = new ModalManager(modalElement); + + // Try to recover an existing Bootstrap instance before falling back to manual + if (typeof bootstrap !== 'undefined' && bootstrap.Modal) { + manager.instance = bootstrap.Modal.getInstance(modalElement); + } else if (typeof window.bootstrap !== 'undefined' && window.bootstrap.Modal) { + manager.instance = window.bootstrap.Modal.getInstance(modalElement); + } + manager.hide(); } @@ -293,6 +303,7 @@ function pollJobStatus(jobId, jobPk, pollUrl, baseUrl, originalFilters, deviceCount) { const messageEl = document.getElementById('filter-progress-message'); const cancelBtn = document.getElementById('cancel-filter-btn'); + const filterModal = document.getElementById('filter-processing-modal'); // Get CSRF token from cookie or form (needed for cancel and status sync) let csrfToken = getCookie('csrftoken'); @@ -357,11 +368,8 @@ messageEl.textContent = 'Job already completed, loading results...'; } cancelBtn.textContent = 'Completed'; - - const modal = document.getElementById('filter-processing-modal'); - if (modal) { - const manager = new ModalManager(modal); - manager.hide(); + if (filterModal) { + hideModal(filterModal); } setTimeout(() => { @@ -403,11 +411,8 @@ messageEl.textContent = 'Job cancelled successfully.'; } cancelBtn.textContent = 'Cancelled'; - - const modal = document.getElementById('filter-processing-modal'); - if (modal) { - const manager = new ModalManager(modal); - manager.hide(); + if (filterModal) { + hideModal(filterModal); } setTimeout(() => { @@ -424,11 +429,8 @@ messageEl.textContent = 'Job stopped (status sync failed).'; } cancelBtn.textContent = 'Stopped'; - - const modal = document.getElementById('filter-processing-modal'); - if (modal) { - const manager = new ModalManager(modal); - manager.hide(); + if (filterModal) { + hideModal(filterModal); } setTimeout(() => { @@ -441,11 +443,8 @@ messageEl.textContent = 'Job completed, loading results...'; } cancelBtn.textContent = 'Completed'; - - const modal = document.getElementById('filter-processing-modal'); - if (modal) { - const manager = new ModalManager(modal); - manager.hide(); + if (filterModal) { + hideModal(filterModal); } setTimeout(() => { @@ -460,11 +459,8 @@ } cancelBtn.textContent = 'Close'; cancelBtn.disabled = false; - - const modal = document.getElementById('filter-processing-modal'); - if (modal) { - const manager = new ModalManager(modal); - manager.hide(); + if (filterModal) { + hideModal(filterModal); } setTimeout(() => window.location.href = baseUrl, 1000); @@ -545,11 +541,8 @@ if (statusValue === 'completed' || statusValue === 'finished') { pollingStopped = true; // Stop future polls - - const modal = document.getElementById('filter-processing-modal'); - if (modal) { - const manager = new ModalManager(modal); - manager.hide(); + if (filterModal) { + hideModal(filterModal); } // Small delay to let modal close before redirect @@ -559,21 +552,15 @@ return; // Stop polling } else if (statusValue === 'stopped') { pollingStopped = true; - - const modal = document.getElementById('filter-processing-modal'); - if (modal) { - const manager = new ModalManager(modal); - manager.hide(); + if (filterModal) { + hideModal(filterModal); } setTimeout(() => window.location.href = baseUrl, 100); } else if (statusValue === 'failed') { pollingStopped = true; - - const modal = document.getElementById('filter-processing-modal'); - if (modal) { - const manager = new ModalManager(modal); - manager.hide(); + if (filterModal) { + hideModal(filterModal); } const errorMsg = data.data?.error; @@ -583,11 +570,8 @@ setTimeout(() => window.location.href = baseUrl, 100); } else if (statusValue === 'errored') { pollingStopped = true; - - const modal = document.getElementById('filter-processing-modal'); - if (modal) { - const manager = new ModalManager(modal); - manager.hide(); + if (filterModal) { + hideModal(filterModal); } const errorMsg = data.data?.error || 'Job encountered an error. Please try again.'; @@ -986,11 +970,8 @@ if (failedCount && failedCount.dataset.failedCount === '0') { setTimeout(() => { const resultsModal = document.getElementById('import-results-modal'); - if (resultsModal && typeof bootstrap !== 'undefined' && bootstrap.Modal) { - const modalInstance = bootstrap.Modal.getInstance(resultsModal); - if (modalInstance) { - modalInstance.hide(); - } + if (resultsModal) { + hideModal(resultsModal); } window.location.reload(); }, MODAL_AUTO_CLOSE_MS); diff --git a/netbox_librenms_plugin/tables/device_status.py b/netbox_librenms_plugin/tables/device_status.py index a67a20271d..3d589b7fa5 100644 --- a/netbox_librenms_plugin/tables/device_status.py +++ b/netbox_librenms_plugin/tables/device_status.py @@ -439,7 +439,7 @@ def render_actions(self, value, record): buttons = [] if existing: - # Link to existing device/VM in NetBox + # Link to existing device/VM in NetBox + details button for conflict resolution if isinstance(existing, VirtualMachine): url_name = "virtualization:virtualmachine" title = "View VM in NetBox" @@ -452,6 +452,44 @@ def render_actions(self, value, record): f'' ) + + # Add details/conflict button for conflict resolution actions + details_url = self._build_validation_details_url(device_id, validation) + match_type = validation.get("existing_match_type", "") + serial_action = validation.get("serial_action") + has_mismatch = validation.get("device_type_mismatch", False) + has_actions = match_type in ("hostname", "serial") and serial_action is not None + has_name_sync = validation.get("name_sync_available", False) + has_sync_needed = match_type == "librenms_id" and serial_action in ("update_serial", "conflict") + + if has_mismatch: + btn_class = "btn-outline-danger" + btn_icon = "mdi-alert-circle" + btn_label = " Conflict" + elif has_actions: + btn_class = "btn-outline-warning" + btn_icon = "mdi-alert" + btn_label = " Conflict" + elif has_name_sync or has_sync_needed: + btn_class = "btn-outline-warning" + btn_icon = "mdi-information-outline" + btn_label = " Details" + else: + btn_class = "btn-outline-info" + btn_icon = "mdi-information-outline" + btn_label = " Details" + + btn_title = "Resolve conflict" if (has_actions or has_mismatch) else "View details" + buttons.append( + f'' + ) elif is_ready: # Ready to import - show Import and Details buttons details_url = self._build_validation_details_url(device_id, validation) diff --git a/netbox_librenms_plugin/templates/netbox_librenms_plugin/htmx/device_validation_details.html b/netbox_librenms_plugin/templates/netbox_librenms_plugin/htmx/device_validation_details.html index 31ea3df6cb..974e8b79ec 100644 --- a/netbox_librenms_plugin/templates/netbox_librenms_plugin/htmx/device_validation_details.html +++ b/netbox_librenms_plugin/templates/netbox_librenms_plugin/htmx/device_validation_details.html @@ -1,325 +1,529 @@ {# HTMX template for device validation details modal #} -{# Shows detailed reasons why a device cannot be imported #} +{# Redesigned to match the sync page's clean table layout #}
- Import Validation: {{ libre_device.hostname }} + {% if validation.existing_device %} + {% if validation.device_type_mismatch %} + + {% elif validation.existing_match_type == 'librenms_id' %} + + {% else %} + + {% endif %} + {% elif validation.is_ready %} + + {% elif validation.can_import %} + + {% else %} + + {% endif %} + Import Validation: {{ libre_device.sysName|default:libre_device.hostname }}
- {# Device Summary #} -
-
- LibreNMS Device Information + {# Compute existing device URL once for use throughout #} + {% if validation.existing_device %} + {% if validation.import_as_vm or validation.existing_device.cluster %} + {% url 'virtualization:virtualmachine' pk=validation.existing_device.pk as existing_device_url %} + {% else %} + {% url 'dcim:device' pk=validation.existing_device.pk as existing_device_url %} + {% endif %} + {% endif %} + + {# Row: LibreNMS Status (left) + Device Info table (right) #} +
+ + {# Left: LibreNMS Status card #} +
+
+
LibreNMS Status
+
+ + + + + + + + + + + + + + + + + + + + + + + +
Status + {% if libre_device.status == 1 %} + Up + {% elif libre_device.status == 0 %} + Down + {% else %} + Unknown + {% endif %} +
Hostname{{ libre_device.hostname }}
ID{{ libre_device.device_id }}
IP{{ libre_device.ip|default:"—" }}
Location{{ libre_device.location|default:"—" }}
+
+
-
-
-
Hostname:
-
{{ libre_device.hostname }}
-
System Name:
-
{{ libre_device.sysName|default:"N/A" }}
+ {# Right: Device Information table #} +
+
+
Device Information
+
+ + + + + + + + + + {# Name row #} + + + + + -
LibreNMS ID:
-
{{ libre_device.device_id }}
+ {% if not validation.import_as_vm %} + {# Site row #} + + + + + -
IP Address:
-
{{ libre_device.ip|default:"N/A" }}
+ {# Device Type row #} + + + + + + {% endif %} -
Hardware:
-
{{ libre_device.hardware|default:"N/A" }}
+ {# Serial row (only for devices) #} + {% if not validation.import_as_vm %} + + + + + + {% endif %} -
OS:
-
{{ libre_device.os|default:"N/A" }}
+ {# Role row #} + + + + + -
Location:
-
{{ libre_device.location|default:"N/A" }}
+ {# Platform row #} + + + + + -
Status:
-
- {% if libre_device.status == 1 %} - Up - {% elif libre_device.status == 0 %} - Down - {% else %} - Unknown - {% endif %} -
- - - + {% if validation.import_as_vm %} + {# Cluster row (VMs only) #} + + + + + + {% else %} + {# Rack row #} + + + + + + {% endif %} - {# Validation Status #} -
-
- {% if validation.existing_device %} - {% if validation.existing_match_type == 'librenms_id' %} - {# Device was imported via this plugin #} -
-
- Device Already Imported -
-

- This device has already been imported to NetBox as - - {{ validation.existing_device.name }} - -

-

- - Matched by LibreNMS ID ({{ libre_device.device_id }}) - device is linked and synchronized. -

-
- {% elif validation.existing_match_type == 'hostname' %} - {# Device exists with same hostname but wasn't imported from LibreNMS #} -
-
- Device Exists (Hostname Match) -
-

- A device with the same hostname exists in NetBox as - - {{ validation.existing_device.name }} - -

-

- - Matched by hostname only - this device is not linked to LibreNMS. - If this is the same device, consider adding the LibreNMS ID custom field manually. -

-
- {% elif validation.existing_match_type == 'primary_ip' %} - {# Device exists with same IP but wasn't imported from LibreNMS #} -
-
- Device Exists (IP Match) -
-

- A device with the same IP address ({{ libre_device.ip }}) exists in NetBox as - - {{ validation.existing_device.name }} - -

-

- - Matched by IP address only - verify this is the same device. - If correct, consider adding the LibreNMS ID custom field manually. -

-
- {% else %} - {# Fallback for unknown match type #} -
-
- Device Already Exists -
-

- This device already exists in NetBox as - - {{ validation.existing_device.name }} - -

-

- No import is needed. -

-
- {% endif %} - {% elif validation.is_ready %} -
-
- Ready to Import -
-

- All prerequisites are met. This device can be imported into NetBox without any issues. -

-
- {% elif validation.can_import %} -
-
- Can Import with Warnings -
-

- This device can be imported, but there are some warnings to review below. -

-
- {% else %} -
-
- Cannot Import -
-

- This device cannot be imported due to validation issues listed below. -

+ {# Primary IP row #} +
+ + + + + +
FieldNetBox ValueLibreNMS Value
Name + {% if validation.existing_device %} + + {{ validation.existing_device.name }} + + {% if validation.name_sync_available %} +
+ {% csrf_token %} + + + +
+ {% endif %} + {% else %} + New device + {% endif %} + 		{{ libre_device.sysName|default:libre_device.hostname }}
Site + {% if validation.existing_device and validation.existing_device.site %} + {{ validation.existing_device.site }} + {% if validation.site.site and validation.existing_device.site.pk == validation.site.site.pk %} + + {% endif %} + {% elif validation.site.site %} + {{ validation.site.site.name }} + {% else %} + No matching site + {% endif %} + {{ libre_device.location|default:"—" }}
Device Type + {% if validation.device_type_mismatch %} + + {{ validation.existing_device.device_type }} + + +
+ {% csrf_token %} + + + + +
+ {% elif validation.existing_device and validation.existing_device.device_type %} + {{ validation.existing_device.device_type }} + {% if sync_info and not sync_info.device_type_synced and sync_info.librenms_device_type %} +
+ {% csrf_token %} + + + +
+ {% elif validation.device_type.device_type %} + + {% endif %} + {% elif validation.device_type.device_type %} + {{ validation.device_type.device_type }} + {% else %} + No matching type + {% endif %} + 		{{ libre_device.hardware|default:"—" }}
Serial + {% if validation.existing_device %} + {% if validation.existing_device.serial %} + {{ validation.existing_device.serial }} + {% else %} + Not set + {% endif %} + {% if sync_info and not sync_info.serial_synced %} + {% if validation.serial_action == 'conflict' %} + + + + {% else %} +
+ {% csrf_token %} + + + +
+ {% endif %} + {% elif sync_info and sync_info.serial_synced and sync_info.librenms_serial != '-' %} + + {% endif %} + {% else %} + — + {% endif %} + 		+ {{ libre_device.serial|default:"—" }} + {% if validation.serial_duplicate %} + Conflict + {% endif %} +
+ {% if validation.import_as_vm %}Role{% else %}Device Role{% endif %} + + {% if validation.existing_device and validation.existing_device.role %} + {{ validation.existing_device.role }} + + {% elif validation.device_role.role %} + {{ validation.device_role.role.name }} + {% else %} + No role assigned + {% endif %} + —
Platform + {% if validation.existing_device and validation.existing_device.platform %} + {{ validation.existing_device.platform }} + {% if sync_info and not sync_info.platform_synced %} + {% if sync_info.platform_info.platform_exists %} +
+ {% csrf_token %} + + + +
+ {% else %} + + + + {% endif %} + {% elif sync_info and sync_info.platform_synced %} + + {% endif %} + {% elif validation.platform.platform %} + {{ validation.platform.platform.name }} + {% elif sync_info and sync_info.platform_info.platform_exists %} + Not set + {% if validation.existing_device %} +
+ {% csrf_token %} + + + +
+ {% endif %} + {% else %} + Optional + {% endif %} + 		{{ libre_device.os|default:"—" }}
Cluster + {% if validation.cluster.cluster %} + {{ validation.cluster.cluster.name }} + {% else %} + No cluster assigned + {% endif %} + —
Rack + {% if validation.rack.rack %} + + {% if validation.rack.rack.location %} + {{ validation.rack.rack.location.name }} — {{ validation.rack.rack.name }} + {% else %} + {{ validation.rack.rack.name }} + {% endif %} + + {% else %} + Optional + {% endif %} + —
Primary IP + {% if validation.existing_device and validation.existing_device.primary_ip %} + {{ validation.existing_device.primary_ip }} + + {% elif libre_device.ip %} + {{ libre_device.ip }} + + {% else %} + No primary IP + {% endif %} + {{ libre_device.ip|default:"—" }}
- {% endif %} +
- {# Validation Details #} -
-
- NetBox Import Matching -
-
-

- - The following NetBox objects will be used when importing this - {% if validation.import_as_vm %}Virtual Machine{% else %}Device{% endif %}: - -

- - - {% if validation.import_as_vm %} - {# VM-specific fields #} - - - - - - - - - - - - - - + {# Status & Actions #} + {% if validation.existing_device %} + {% if validation.existing_match_type == 'librenms_id' %} +
+ Linked — ID {{ libre_device.device_id }} + {% if validation.name_matches %} + Name match + {% elif validation.name_sync_available %} + Name differs + {% endif %} + {% if validation.serial_confirmed %} + Serial confirmed + {% elif validation.serial_action == 'conflict' %} + Serial conflict + {% elif validation.serial_action == 'update_serial' %} + Serial differs + {% endif %} + {% if validation.device_type_mismatch %} + Type mismatch + {% endif %} +
+ {% elif validation.existing_match_type == 'hostname' %} +
+ Hostname match + {% if validation.serial_confirmed %} + Serial confirmed + {% elif validation.serial_action == 'conflict' %} + Serial conflict + {% elif validation.serial_action == 'update_serial' %} + Serial differs + {% endif %} + {% if validation.device_type_mismatch %} + Type mismatch + {% endif %} + + — Exists as + {{ validation.existing_device.name }}, + not linked to LibreNMS. + +
+ {% if validation.serial_action == 'conflict' %} +
+ + Import blocked: The incoming serial number is already assigned to another device in NetBox. + Resolve the duplicate serial before linking. +
+ {% else %} +
+
+ {% csrf_token %} + + {% if validation.device_type_mismatch %} +
+ + +
+ {% endif %} + {% if validation.serial_action == 'update_serial' %} + + {% else %} - {# Device-specific fields #} -
- - - - - - - - - - - - - + + + {% endif %} + + + {% endif %} - - - - + {% elif validation.existing_match_type == 'serial' %} +
+ Serial match + {% if validation.serial_action == 'hostname_differs' %} + Name differs + {% elif validation.serial_action == 'link' %} + Name match + {% endif %} + {% if validation.device_type_mismatch %} + Type mismatch + {% endif %} + + — Exists as + {{ validation.existing_device.name }}, + not linked to LibreNMS. + +
+
+
+ {% csrf_token %} + + {% if validation.device_type_mismatch %} +
+ + +
{% endif %} + {% if validation.serial_action == 'link' %} + + + {% elif validation.serial_action == 'hostname_differs' %} + + {% endif %} + +
- {# Common fields for both Device and VM #} - - - - + {% elif validation.existing_match_type == 'primary_ip' %} +
+ IP match + + — Device with IP {{ libre_device.ip }} exists as + {{ validation.existing_device.name }}. + Consider adding LibreNMS ID manually. + +
- {% if not validation.import_as_vm %} - - - - - {% endif %} + {% else %} +
+ + Exists — Device already exists as + {{ validation.existing_device.name }}. +
+ {% endif %} - - - - - -
Import Type: - - Virtual Machine -
Cluster: - {% if validation.cluster.cluster %} - - {{ validation.cluster.cluster.name }} - {% else %} - - No cluster assigned (required for VMs) - {% endif %} -
Role: - {% if validation.device_role.role %} - - {{ validation.device_role.role.name }} - {% else %} - - Optional - not assigned - {% endif %} -
Import Type: - - Device -
Site: - {% if validation.site.site %} - - {{ validation.site.site.name }} - {% else %} - - No matching site found - {% endif %} -
Device Type: - {% if validation.device_type.device_type %} - - {{ validation.device_type.device_type }} - {% else %} - - No matching device type found - {% endif %} -
Device Role: - {% if validation.device_role.role %} - - {{ validation.device_role.role.name }} - {% else %} - - No device role assigned - {% endif %} -
Platform: - {% if validation.platform.platform %} - - {{ validation.platform.platform.name }} - {% else %} - - Optional - will be auto-mapped if available - {% endif %} -
Rack: - {% if validation.rack.rack %} - - - {% if validation.rack.rack.location %} - {{ validation.rack.rack.location.name }} - {{ validation.rack.rack.name }} - {% else %} - {{ validation.rack.rack.name }} - {% endif %} - - {% else %} - - Optional - not assigned - {% endif %} -
Primary IP: - {% if libre_device.ip %} - - {{ libre_device.ip }} - {% else %} - - No primary IP - will import without - {% endif %} -
+ {% elif validation.is_ready %} +
+ + Ready to Import — All prerequisites are met.
-
+ {% elif validation.can_import %} +
+ + Can Import — Review warnings below before importing. +
+ {% else %} +
+ + Cannot Import — Validation issues prevent import. +
+ {% endif %} {# Warnings #} {% if validation.warnings %}
-
+
Warnings ({{ validation.warnings|length }})
-
-

These warnings won't prevent import but should be reviewed:

-
    +
    +
      {% for warning in validation.warnings %} -
    • {{ warning }}
      • +
    • {{ warning }}
      • {% endfor %}
    @@ -331,23 +535,24 @@
    {% if validation.existing_device %} {% if validation.import_as_vm or validation.existing_device.cluster %} - {# It's a VM #} - + View VM in NetBox {% else %} - {# It's a Device #} - - View Device in NetBox + + View in NetBox + {% if validation.existing_match_type == 'librenms_id' %} + + Full Sync Page + + {% endif %} {% endif %} {% endif %} - -
    diff --git a/netbox_librenms_plugin/templates/netbox_librenms_plugin/librenms_import.html b/netbox_librenms_plugin/templates/netbox_librenms_plugin/librenms_import.html index b5b59d3a5c..72687544cb 100644 --- a/netbox_librenms_plugin/templates/netbox_librenms_plugin/librenms_import.html +++ b/netbox_librenms_plugin/templates/netbox_librenms_plugin/librenms_import.html @@ -398,7 +398,7 @@
    {# HTMX Modal for import actions #}
Device Information Sync {% include 'netbox_librenms_plugin/_ipaddress_sync.html' %}
+ {% if module_sync %} +
+ {% include 'netbox_librenms_plugin/_module_sync.html' %} +
+ {% endif %} + {% with model_name=object|meta:"model_name" %} {% if model_name == "device" %}
/module-sync/", + DeviceModuleTableView.as_view(), + name="device_module_sync", + ), path( "devices//ipaddress-sync/", DeviceIPAddressTableView.as_view(), diff --git a/netbox_librenms_plugin/views/__init__.py b/netbox_librenms_plugin/views/__init__.py index c52b350912..44d14dfd1f 100644 --- a/netbox_librenms_plugin/views/__init__.py +++ b/netbox_librenms_plugin/views/__init__.py @@ -34,6 +34,7 @@ DeviceInterfaceTableView, DeviceIPAddressTableView, DeviceLibreNMSSyncView, + DeviceModuleTableView, DeviceVLANTableView, SaveVlanGroupOverridesView, SingleInterfaceVerifyView, diff --git a/netbox_librenms_plugin/views/base/librenms_sync_view.py b/netbox_librenms_plugin/views/base/librenms_sync_view.py index affbf32306..4a85cb1642 100644 --- a/netbox_librenms_plugin/views/base/librenms_sync_view.py +++ b/netbox_librenms_plugin/views/base/librenms_sync_view.py @@ -86,6 +86,7 @@ def get_context_data(self, request, obj): cable_context = self.get_cable_context(request, obj) ip_context = self.get_ip_context(request, obj) vlan_context = self.get_vlan_context(request, obj) + module_context = self.get_module_context(request, obj) interface_name_field = get_interface_name_field(request) @@ -103,6 +104,7 @@ def get_context_data(self, request, obj): "cable_sync": cable_context, "ip_sync": ip_context, "vlan_sync": vlan_context, + "module_sync": module_context, "v1v2form": AddToLIbreSNMPV1V2(prefix="v1v2"), "v3form": AddToLIbreSNMPV3(prefix="v3"), "librenms_device_id": self.librenms_id, @@ -270,6 +272,13 @@ def get_vlan_context(self, request, obj): """ return None + def get_module_context(self, request, obj): + """ + Get the context data for module sync. + Subclasses should override this method if applicable. + """ + return None + @staticmethod def _strip_vc_pattern(name): """Strip the VC member naming suffix from a device name. diff --git a/netbox_librenms_plugin/views/base/modules_view.py b/netbox_librenms_plugin/views/base/modules_view.py new file mode 100644 index 0000000000..619bd571ed --- /dev/null +++ b/netbox_librenms_plugin/views/base/modules_view.py @@ -0,0 +1,260 @@ +from django.contrib import messages +from django.core.cache import cache +from django.shortcuts import get_object_or_404, render +from django.utils import timezone +from django.views import View + +from netbox_librenms_plugin.views.mixins import CacheMixin, LibreNMSAPIMixin, LibreNMSPermissionMixin + + +# entPhysicalClass values relevant for module sync +INVENTORY_CLASSES = {"module", "powerSupply", "fan"} + + +class BaseModuleTableView(LibreNMSPermissionMixin, LibreNMSAPIMixin, CacheMixin, View): + """ + Base view for synchronizing module/inventory data from LibreNMS. + Fetches inventory, matches against NetBox module bays and module types, + and renders a comparison table. + """ + + model = None + partial_template_name = "netbox_librenms_plugin/_module_sync_content.html" + + def get_object(self, pk): + """Retrieve the object (Device).""" + return get_object_or_404(self.model, pk=pk) + + def get_table(self, data, obj): + """Returns the table class. Subclasses should override.""" + raise NotImplementedError("Subclasses must implement get_table()") + + def post(self, request, pk): + """Fetch inventory from LibreNMS, cache it, and render the module sync table.""" + obj = self.get_object(pk) + + self.librenms_id = self.librenms_api.get_librenms_id(obj) + if not self.librenms_id: + messages.error(request, "Device not found in LibreNMS.") + return render( + request, + self.partial_template_name, + {"module_sync": {"object": obj, "table": None, "cache_expiry": None}}, + ) + + success, inventory_data = self.librenms_api.get_device_inventory(self.librenms_id) + + if not success: + messages.error(request, f"Failed to fetch inventory from LibreNMS: {inventory_data}") + return render( + request, + self.partial_template_name, + {"module_sync": {"object": obj, "table": None, "cache_expiry": None}}, + ) + + # Cache the raw inventory data + cache.set( + self.get_cache_key(obj, "inventory"), + inventory_data, + timeout=self.librenms_api.cache_timeout, + ) + + context = self._build_context(request, obj, inventory_data) + messages.success(request, "Inventory data refreshed successfully.") + return render(request, self.partial_template_name, {"module_sync": context}) + + def get_context_data(self, request, obj): + """Get context from cache (used by the main sync view on initial page load).""" + cached_data = cache.get(self.get_cache_key(obj, "inventory")) + if not cached_data: + return {"table": None, "object": obj, "cache_expiry": None} + return self._build_context(request, obj, cached_data) + + def _build_context(self, request, obj, inventory_data): + """Build context with matched inventory items and table.""" + # Filter to relevant classes + items = [item for item in inventory_data if item.get("entPhysicalClass") in INVENTORY_CLASSES] + + # Build a lookup of all inventory items by index for parent resolution + index_map = {item["entPhysicalIndex"]: item for item in inventory_data} + + # Get NetBox module bays and modules for this device + module_bays = self._get_module_bays(obj) + module_types = self._get_module_types() + + # Build table rows + table_data = [] + for item in items: + row = self._build_row(item, index_map, module_bays, module_types) + table_data.append(row) + + # Sort: installed first, then matched, then unmatched + status_order = {"Installed": 0, "Serial Mismatch": 1, "Matched": 2, "No Type": 3, "No Bay": 4, "Unmatched": 5} + table_data.sort(key=lambda r: status_order.get(r["status"], 99)) + + table = self.get_table(table_data, obj) + table.configure(request) + + cache_ttl = cache.ttl(self.get_cache_key(obj, "inventory")) + cache_expiry = timezone.now() + timezone.timedelta(seconds=cache_ttl) if cache_ttl is not None else None + + return { + "table": table, + "object": obj, + "cache_expiry": cache_expiry, + } + + def _get_module_bays(self, obj): + """Get module bays for the device, indexed by name.""" + from dcim.models import ModuleBay + + bays = ModuleBay.objects.filter(device=obj).select_related("installed_module__module_type") + return {bay.name: bay for bay in bays} + + def _get_module_types(self): + """Get all module types, indexed by model (part_number).""" + from dcim.models import ModuleType + + types = ModuleType.objects.all().select_related("manufacturer") + result = {} + for mt in types: + result[mt.model] = mt + if mt.part_number and mt.part_number != mt.model: + result[mt.part_number] = mt + return result + + def _find_parent_container_name(self, item, index_map): + """Resolve the parent container name for an inventory item.""" + contained_in = item.get("entPhysicalContainedIn", 0) + if contained_in == 0: + return None + parent = index_map.get(contained_in) + if parent: + return parent.get("entPhysicalName", "") + return None + + def _match_module_bay(self, item, index_map, module_bays): + """ + Try to match an inventory item to a NetBox ModuleBay. + Matches by parent container name or item name. + """ + parent_name = self._find_parent_container_name(item, index_map) + item_name = item.get("entPhysicalName", "") + + # Try exact match on parent container name first + if parent_name and parent_name in module_bays: + return module_bays[parent_name] + + # Try matching by item name (e.g., "Power Supply 1" → "PS1") + for bay_name, bay in module_bays.items(): + if self._names_match(item_name, bay_name, item.get("entPhysicalClass", "")): + return bay + + return None + + def _names_match(self, libre_name, bay_name, phys_class): + """Heuristic matching between LibreNMS inventory name and NetBox bay name.""" + if not libre_name or not bay_name: + return False + + libre_lower = libre_name.lower().strip() + bay_lower = bay_name.lower().strip() + + # Exact match + if libre_lower == bay_lower: + return True + + # Power supply: "Power Supply 1" ↔ "PS1" or "PSU1" + if phys_class == "powerSupply": + import re + + ps_match = re.search(r"(\d+)", libre_name) + bay_match = re.search(r"(\d+)", bay_name) + if ps_match and bay_match and ps_match.group(1) == bay_match.group(1): + if any(prefix in bay_lower for prefix in ("ps", "psu", "power")): + return True + + # Fan: "FanTray 1" ↔ "Fan 1" or "Fan Bay 1" + if phys_class == "fan": + import re + + fan_match = re.search(r"(\d+)", libre_name) + bay_match = re.search(r"(\d+)", bay_name) + if fan_match and bay_match and fan_match.group(1) == bay_match.group(1): + if "fan" in bay_lower: + return True + + # Slot matching: "Supervisor(slot 1)" or "Linecard(slot 3)" ↔ "Slot 1" / "Slot 3" + if phys_class == "module": + import re + + slot_match = re.search(r"slot\s*(\d+)", libre_name, re.IGNORECASE) + bay_match = re.search(r"slot\s*(\d+)", bay_name, re.IGNORECASE) + if slot_match and bay_match and slot_match.group(1) == bay_match.group(1): + return True + + return False + + def _build_row(self, item, index_map, module_bays, module_types): + """Build a single table row from a LibreNMS inventory item.""" + model_name = item.get("entPhysicalModelName", "") or "" + serial = item.get("entPhysicalSerialNum", "") or "" + phys_class = item.get("entPhysicalClass", "") + name = item.get("entPhysicalName", "") or "-" + description = item.get("entPhysicalDescr", "") or "" + + # Match to NetBox module bay + matched_bay = self._match_module_bay(item, index_map, module_bays) + + # Match to NetBox module type + matched_type = module_types.get(model_name) if model_name else None + + # Determine status + status = self._determine_status(matched_bay, matched_type, serial) + + row = { + "name": name, + "model": model_name or "-", + "serial": serial or "-", + "description": description, + "item_class": phys_class, + "module_bay": matched_bay.name if matched_bay else "-", + "module_type": matched_type.model if matched_type else "-", + "status": status, + "row_class": "", + } + + # Add URLs for matched objects + if matched_bay: + row["module_bay_url"] = matched_bay.get_absolute_url() + # Check if a module is already installed in this bay + if hasattr(matched_bay, "installed_module") and matched_bay.installed_module: + installed = matched_bay.installed_module + row["installed_module"] = installed + row["module_url"] = installed.get_absolute_url() + # Check serial match + if serial and installed.serial and installed.serial.strip() == serial.strip(): + status = "Installed" + row["row_class"] = "table-success" + elif serial and installed.serial and installed.serial.strip() != serial.strip(): + status = "Serial Mismatch" + row["row_class"] = "table-danger" + else: + status = "Installed" + row["row_class"] = "table-success" + row["status"] = status + + if matched_type: + row["module_type_url"] = matched_type.get_absolute_url() + + return row + + def _determine_status(self, matched_bay, matched_type, serial): + """Determine the sync status for an inventory item.""" + if matched_bay and matched_type: + return "Matched" + if not matched_bay: + return "No Bay" + if not matched_type: + return "No Type" + return "Unmatched" diff --git a/netbox_librenms_plugin/views/object_sync/__init__.py b/netbox_librenms_plugin/views/object_sync/__init__.py index e9893cf7d8..f025cb2a7b 100644 --- a/netbox_librenms_plugin/views/object_sync/__init__.py +++ b/netbox_librenms_plugin/views/object_sync/__init__.py @@ -5,6 +5,7 @@ DeviceInterfaceTableView, DeviceIPAddressTableView, DeviceLibreNMSSyncView, + DeviceModuleTableView, DeviceVLANTableView, SaveVlanGroupOverridesView, SingleInterfaceVerifyView, diff --git a/netbox_librenms_plugin/views/object_sync/devices.py b/netbox_librenms_plugin/views/object_sync/devices.py index 97584f8319..72f63a094f 100644 --- a/netbox_librenms_plugin/views/object_sync/devices.py +++ b/netbox_librenms_plugin/views/object_sync/devices.py @@ -17,6 +17,7 @@ LibreNMSInterfaceTable, VCInterfaceTable, ) +from netbox_librenms_plugin.tables.modules import LibreNMSModuleTable from netbox_librenms_plugin.utils import ( get_interface_name_field, get_missing_vlan_warning, @@ -29,6 +30,7 @@ from ..base.interfaces_view import BaseInterfaceTableView from ..base.ip_addresses_view import BaseIPAddressTableView from ..base.librenms_sync_view import BaseLibreNMSSyncView +from ..base.modules_view import BaseModuleTableView from ..base.vlan_table_view import BaseVLANTableView from ..mixins import CacheMixin, LibreNMSPermissionMixin @@ -63,6 +65,12 @@ def get_vlan_context(self, request, obj): vlan_table_view.request = request return vlan_table_view.get_vlan_context(request, obj) + def get_module_context(self, request, obj): + """Return module sync context for the device.""" + module_table_view = DeviceModuleTableView() + module_table_view.request = request + return module_table_view.get_context_data(request, obj) + class DeviceInterfaceTableView(BaseInterfaceTableView): """Interface synchronization table for Devices.""" @@ -375,3 +383,15 @@ class DeviceVLANTableView(BaseVLANTableView): """VLAN synchronization table view for Devices.""" model = Device + + +class DeviceModuleTableView(BaseModuleTableView): + """Module/inventory synchronization view for Devices.""" + + model = Device + + def get_table(self, data, obj): + """Return the module sync table.""" + table = LibreNMSModuleTable(data, device=obj) + table.htmx_url = f"{self.request.path}?tab=modules" + return table From e198de1bcb732a63930e3800efc3fcda02fecde8 Mon Sep 17 00:00:00 2001 From: Marcin Zieba Date: Tue, 17 Feb 2026 01:36:34 +0100 Subject: [PATCH 10/62] feat: add Install Module button and fix countdown timer - Add InstallModuleView to create Module in ModuleBay from LibreNMS data - Add Install button (actions column) to module table for matched rows - Fix module countdown timer by adding module-countdown-timer to JS init - Move inline re imports to module level in modules_view.py - Track can_install, module_bay_id, module_type_id in table row data --- .../js/librenms_sync.js | 4 ++ netbox_librenms_plugin/tables/modules.py | 31 +++++++- netbox_librenms_plugin/urls.py | 6 ++ netbox_librenms_plugin/views/__init__.py | 1 + .../views/base/modules_view.py | 72 ++++++++++++++++--- 5 files changed, 105 insertions(+), 9 deletions(-) diff --git a/netbox_librenms_plugin/static/netbox_librenms_plugin/js/librenms_sync.js b/netbox_librenms_plugin/static/netbox_librenms_plugin/js/librenms_sync.js index cd470af1b1..0b42112b24 100644 --- a/netbox_librenms_plugin/static/netbox_librenms_plugin/js/librenms_sync.js +++ b/netbox_librenms_plugin/static/netbox_librenms_plugin/js/librenms_sync.js @@ -153,11 +153,15 @@ function initializeCountdowns() { if (window.vlanCountdownInterval) { clearInterval(window.vlanCountdownInterval); } + if (window.moduleCountdownInterval) { + clearInterval(window.moduleCountdownInterval); + } window.interfaceCountdownInterval = initializeCountdown("countdown-timer"); window.cableCountdownInterval = initializeCountdown("cable-countdown-timer"); window.ipCountdownInterval = initializeCountdown("ip-countdown-timer"); window.vlanCountdownInterval = initializeCountdown("vlan-countdown-timer"); + window.moduleCountdownInterval = initializeCountdown("module-countdown-timer"); } // ============================================ diff --git a/netbox_librenms_plugin/tables/modules.py b/netbox_librenms_plugin/tables/modules.py index f345c6180e..a4c7583a91 100644 --- a/netbox_librenms_plugin/tables/modules.py +++ b/netbox_librenms_plugin/tables/modules.py @@ -1,4 +1,5 @@ import django_tables2 as tables +from django.urls import reverse from django.utils.html import format_html from utilities.paginator import EnhancedPaginator @@ -16,6 +17,9 @@ class LibreNMSModuleTable(tables.Table): module_bay = tables.Column(verbose_name="Module Bay", attrs={"td": {"data-col": "module_bay"}}) module_type = tables.Column(verbose_name="Module Type", attrs={"td": {"data-col": "module_type"}}) status = tables.Column(verbose_name="Status", attrs={"td": {"data-col": "status"}}) + actions = tables.Column( + verbose_name="Actions", orderable=False, empty_values=(), attrs={"td": {"data-col": "actions"}} + ) class Meta: attrs = {"class": "table table-hover object-list", "id": "librenms-module-table"} @@ -24,13 +28,17 @@ class Meta: def __init__(self, *args, device=None, **kwargs): """Initialize table with optional device context.""" self.device = device + self.csrf_token = "" super().__init__(*args, **kwargs) self.tab = "modules" self.htmx_url = None self.prefix = "modules_" def configure(self, request): - """Configure pagination settings.""" + """Configure pagination settings and CSRF token.""" + from django.middleware.csrf import get_token + + self.csrf_token = get_token(request) paginate = {"paginator_class": EnhancedPaginator, "per_page": get_table_paginate_count(request, self.prefix)} tables.RequestConfig(request, paginate).configure(self) @@ -96,3 +104,24 @@ def render_status(self, value, record): } badge_class = badge_classes.get(value, "bg-secondary") return format_html('{}', badge_class, value) + + def render_actions(self, value, record): + """Render install button for matched modules.""" + if not record.get("can_install") or not self.device: + return "" + url = reverse("plugins:netbox_librenms_plugin:install_module", kwargs={"pk": self.device.pk}) + return format_html( + '
' + '' + '' + '' + '' + '
", + url, + self.csrf_token, + record.get("module_bay_id", ""), + record.get("module_type_id", ""), + record.get("serial", ""), + ) diff --git a/netbox_librenms_plugin/urls.py b/netbox_librenms_plugin/urls.py index 7b79f28c6d..e522abb696 100644 --- a/netbox_librenms_plugin/urls.py +++ b/netbox_librenms_plugin/urls.py @@ -21,6 +21,7 @@ DeviceValidationDetailsView, DeviceVCDetailsView, DeviceVLANTableView, + InstallModuleView, InterfaceTypeMappingBulkDeleteView, InterfaceTypeMappingBulkImportView, InterfaceTypeMappingChangeLogView, @@ -77,6 +78,11 @@ DeviceModuleTableView.as_view(), name="device_module_sync", ), + path( + "devices//install-module/", + InstallModuleView.as_view(), + name="install_module", + ), path( "devices//ipaddress-sync/", DeviceIPAddressTableView.as_view(), diff --git a/netbox_librenms_plugin/views/__init__.py b/netbox_librenms_plugin/views/__init__.py index 44d14dfd1f..51dead5597 100644 --- a/netbox_librenms_plugin/views/__init__.py +++ b/netbox_librenms_plugin/views/__init__.py @@ -6,6 +6,7 @@ from .base.interfaces_view import BaseInterfaceTableView from .base.ip_addresses_view import BaseIPAddressTableView, SingleIPAddressVerifyView from .base.librenms_sync_view import BaseLibreNMSSyncView +from .base.modules_view import InstallModuleView from .base.vlan_table_view import BaseVLANTableView from .imports import ( BulkImportConfirmView, diff --git a/netbox_librenms_plugin/views/base/modules_view.py b/netbox_librenms_plugin/views/base/modules_view.py index 619bd571ed..c3467629c2 100644 --- a/netbox_librenms_plugin/views/base/modules_view.py +++ b/netbox_librenms_plugin/views/base/modules_view.py @@ -1,10 +1,19 @@ +import re + from django.contrib import messages from django.core.cache import cache -from django.shortcuts import get_object_or_404, render +from django.db import transaction +from django.shortcuts import get_object_or_404, redirect, render +from django.urls import reverse from django.utils import timezone from django.views import View -from netbox_librenms_plugin.views.mixins import CacheMixin, LibreNMSAPIMixin, LibreNMSPermissionMixin +from netbox_librenms_plugin.views.mixins import ( + CacheMixin, + LibreNMSAPIMixin, + LibreNMSPermissionMixin, + NetBoxObjectPermissionMixin, +) # entPhysicalClass values relevant for module sync @@ -166,8 +175,6 @@ def _names_match(self, libre_name, bay_name, phys_class): # Power supply: "Power Supply 1" ↔ "PS1" or "PSU1" if phys_class == "powerSupply": - import re - ps_match = re.search(r"(\d+)", libre_name) bay_match = re.search(r"(\d+)", bay_name) if ps_match and bay_match and ps_match.group(1) == bay_match.group(1): @@ -176,8 +183,6 @@ def _names_match(self, libre_name, bay_name, phys_class): # Fan: "FanTray 1" ↔ "Fan 1" or "Fan Bay 1" if phys_class == "fan": - import re - fan_match = re.search(r"(\d+)", libre_name) bay_match = re.search(r"(\d+)", bay_name) if fan_match and bay_match and fan_match.group(1) == bay_match.group(1): @@ -186,8 +191,6 @@ def _names_match(self, libre_name, bay_name, phys_class): # Slot matching: "Supervisor(slot 1)" or "Linecard(slot 3)" ↔ "Slot 1" / "Slot 3" if phys_class == "module": - import re - slot_match = re.search(r"slot\s*(\d+)", libre_name, re.IGNORECASE) bay_match = re.search(r"slot\s*(\d+)", bay_name, re.IGNORECASE) if slot_match and bay_match and slot_match.group(1) == bay_match.group(1): @@ -222,6 +225,9 @@ def _build_row(self, item, index_map, module_bays, module_types): "module_type": matched_type.model if matched_type else "-", "status": status, "row_class": "", + "can_install": False, + "module_bay_id": matched_bay.pk if matched_bay else None, + "module_type_id": matched_type.pk if matched_type else None, } # Add URLs for matched objects @@ -243,6 +249,9 @@ def _build_row(self, item, index_map, module_bays, module_types): status = "Installed" row["row_class"] = "table-success" row["status"] = status + elif matched_type: + # Bay exists, type matched, no module installed → can install + row["can_install"] = True if matched_type: row["module_type_url"] = matched_type.get_absolute_url() @@ -258,3 +267,50 @@ def _determine_status(self, matched_bay, matched_type, serial): if not matched_type: return "No Type" return "Unmatched" + + +class InstallModuleView(LibreNMSPermissionMixin, NetBoxObjectPermissionMixin, View): + """Install a NetBox Module into a ModuleBay from LibreNMS inventory data.""" + + def post(self, request, pk): + from dcim.models import Device, Module, ModuleBay, ModuleType + + self.required_object_permissions = {"POST": [("add", Module)]} + if error := self.require_all_permissions_json("POST"): + return error + + device = get_object_or_404(Device, pk=pk) + module_bay_id = request.POST.get("module_bay_id") + module_type_id = request.POST.get("module_type_id") + serial = request.POST.get("serial", "").strip() + + if not module_bay_id or not module_type_id: + messages.error(request, "Missing module bay or module type.") + return redirect(reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk})) + + module_bay = get_object_or_404(ModuleBay, pk=module_bay_id, device=device) + module_type = get_object_or_404(ModuleType, pk=module_type_id) + + # Check if bay already has a module installed + if hasattr(module_bay, "installed_module") and module_bay.installed_module: + messages.warning(request, f"Module bay '{module_bay.name}' already has a module installed.") + return redirect(reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk})) + + try: + with transaction.atomic(): + module = Module( + device=device, + module_bay=module_bay, + module_type=module_type, + serial=serial, + status="active", + ) + module.full_clean() + module.save() + messages.success( + request, f"Installed {module_type.model} in {module_bay.name} (serial: {serial or 'N/A'})." + ) + except Exception as e: + messages.error(request, f"Failed to install module: {e}") + + return redirect(reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk})) From d07ce9c8d1f31c74d223e6157373bbad2c8965bf Mon Sep 17 00:00:00 2001 From: Marcin Zieba Date: Tue, 17 Feb 2026 02:18:32 +0100 Subject: [PATCH 11/62] feat: show sub-components and fix install redirect MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Show sub-modules (transceivers, converters, mezzanines) with tree indentation - Recursively collect descendants with models, skipping empty containers - Keep parent-child grouping when sorting by status - Add port-number matching for sub-components (Converter 3/1 ↔ X2 Port 1) - Fix bay number regex to use trailing number (avoid X2 prefix confusion) - Fix install redirect to stay on Modules tab via ?tab=modules - Add icons for port and other inventory classes --- netbox_librenms_plugin/tables/modules.py | 12 ++- .../views/base/modules_view.py | 90 ++++++++++++++++--- 2 files changed, 87 insertions(+), 15 deletions(-) diff --git a/netbox_librenms_plugin/tables/modules.py b/netbox_librenms_plugin/tables/modules.py index a4c7583a91..abc5aac1e7 100644 --- a/netbox_librenms_plugin/tables/modules.py +++ b/netbox_librenms_plugin/tables/modules.py @@ -43,8 +43,14 @@ def configure(self, request): tables.RequestConfig(request, paginate).configure(self) def render_name(self, value, record): - """Render inventory item name.""" - return value or "-" + """Render inventory item name with tree indentation for sub-components.""" + depth = record.get("depth", 0) + if depth == 0: + return value or "-" + # Build visual tree prefix based on nesting depth + padding_px = depth * 20 + prefix = "└─ " + return format_html('{}{}', padding_px, prefix, value or "-") def render_model(self, value, record): """Render model with link to module type if matched.""" @@ -72,6 +78,8 @@ def render_item_class(self, value, record): "module": "mdi-expansion-card", "powerSupply": "mdi-power-plug", "fan": "mdi-fan", + "port": "mdi-ethernet", + "other": "mdi-card-outline", } icon = icons.get(value, "mdi-card-outline") return format_html(' {}', icon, value) diff --git a/netbox_librenms_plugin/views/base/modules_view.py b/netbox_librenms_plugin/views/base/modules_view.py index c3467629c2..c256f4dddd 100644 --- a/netbox_librenms_plugin/views/base/modules_view.py +++ b/netbox_librenms_plugin/views/base/modules_view.py @@ -81,9 +81,6 @@ def get_context_data(self, request, obj): def _build_context(self, request, obj, inventory_data): """Build context with matched inventory items and table.""" - # Filter to relevant classes - items = [item for item in inventory_data if item.get("entPhysicalClass") in INVENTORY_CLASSES] - # Build a lookup of all inventory items by index for parent resolution index_map = {item["entPhysicalIndex"]: item for item in inventory_data} @@ -91,15 +88,22 @@ def _build_context(self, request, obj, inventory_data): module_bays = self._get_module_bays(obj) module_types = self._get_module_types() - # Build table rows + # Collect top-level items and their sub-components + top_items = [item for item in inventory_data if item.get("entPhysicalClass") in INVENTORY_CLASSES] + table_data = [] - for item in items: - row = self._build_row(item, index_map, module_bays, module_types) + for item in top_items: + row = self._build_row(item, index_map, module_bays, module_types, depth=0) table_data.append(row) - # Sort: installed first, then matched, then unmatched - status_order = {"Installed": 0, "Serial Mismatch": 1, "Matched": 2, "No Type": 3, "No Bay": 4, "Unmatched": 5} - table_data.sort(key=lambda r: status_order.get(r["status"], 99)) + # Find sub-components with a model name (transceivers, converters, etc.) + sub_items = self._get_sub_components(item["entPhysicalIndex"], inventory_data) + for depth, sub_item in sub_items: + sub_row = self._build_row(sub_item, index_map, module_bays, module_types, depth=depth) + table_data.append(sub_row) + + # Sort top-level groups by status, keeping children after their parent + table_data = self._sort_with_hierarchy(table_data) table = self.get_table(table_data, obj) table.configure(request) @@ -113,6 +117,52 @@ def _build_context(self, request, obj, inventory_data): "cache_expiry": cache_expiry, } + def _get_sub_components(self, parent_idx, inventory_data): + """Find descendant items with a model name (real hardware, not empty containers). + + Returns list of (depth, item) tuples. + """ + results = [] + self._collect_descendants(parent_idx, inventory_data, depth=1, results=results) + return results + + def _collect_descendants(self, parent_idx, inventory_data, depth, results): + """Recursively collect descendant items that have a model name.""" + children = [i for i in inventory_data if i.get("entPhysicalContainedIn") == parent_idx] + for child in children: + model = (child.get("entPhysicalModelName") or "").strip() + if model: + results.append((depth, child)) + # Continue looking for deeper components (e.g., SFPs inside converters) + self._collect_descendants(child["entPhysicalIndex"], inventory_data, depth + 1, results) + else: + # Skip containers without models, but check their children + self._collect_descendants(child["entPhysicalIndex"], inventory_data, depth, results) + + def _sort_with_hierarchy(self, table_data): + """Sort table keeping children grouped under their parent.""" + status_order = {"Installed": 0, "Serial Mismatch": 1, "Matched": 2, "No Type": 3, "No Bay": 4, "Unmatched": 5} + + # Group into top-level items with their children + groups = [] + current_group = None + for row in table_data: + if row.get("depth", 0) == 0: + current_group = {"parent": row, "children": []} + groups.append(current_group) + elif current_group is not None: + current_group["children"].append(row) + + # Sort groups by parent status + groups.sort(key=lambda g: status_order.get(g["parent"]["status"], 99)) + + # Flatten back + result = [] + for group in groups: + result.append(group["parent"]) + result.extend(group["children"]) + return result + def _get_module_bays(self, obj): """Get module bays for the device, indexed by name.""" from dcim.models import ModuleBay @@ -196,9 +246,19 @@ def _names_match(self, libre_name, bay_name, phys_class): if slot_match and bay_match and slot_match.group(1) == bay_match.group(1): return True + # Sub-component port matching: "Converter 3/1" ↔ "X2 Port 1", + # "TenGigabitEthernet1/5" ↔ "X2 Port 5", "GigabitEthernet3/9" ↔ "X2 Port 9" + if phys_class in ("other", "port"): + slot_port = re.search(r"(\d+)/(\d+)", libre_name) + # Extract trailing number from bay name (e.g., "X2 Port 1" → 1, "SFP 3" → 3) + bay_num = re.search(r"(\d+)\s*$", bay_name) + if slot_port and bay_num and slot_port.group(2) == bay_num.group(1): + if any(kw in bay_lower for kw in ("port", "sfp", "x2", "xfp", "qsfp")): + return True + return False - def _build_row(self, item, index_map, module_bays, module_types): + def _build_row(self, item, index_map, module_bays, module_types, depth=0): """Build a single table row from a LibreNMS inventory item.""" model_name = item.get("entPhysicalModelName", "") or "" serial = item.get("entPhysicalSerialNum", "") or "" @@ -228,6 +288,7 @@ def _build_row(self, item, index_map, module_bays, module_types): "can_install": False, "module_bay_id": matched_bay.pk if matched_bay else None, "module_type_id": matched_type.pk if matched_type else None, + "depth": depth, } # Add URLs for matched objects @@ -286,7 +347,8 @@ def post(self, request, pk): if not module_bay_id or not module_type_id: messages.error(request, "Missing module bay or module type.") - return redirect(reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk})) + sync_url = reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk}) + return redirect(f"{sync_url}?tab=modules") module_bay = get_object_or_404(ModuleBay, pk=module_bay_id, device=device) module_type = get_object_or_404(ModuleType, pk=module_type_id) @@ -294,7 +356,8 @@ def post(self, request, pk): # Check if bay already has a module installed if hasattr(module_bay, "installed_module") and module_bay.installed_module: messages.warning(request, f"Module bay '{module_bay.name}' already has a module installed.") - return redirect(reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk})) + sync_url = reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk}) + return redirect(f"{sync_url}?tab=modules") try: with transaction.atomic(): @@ -313,4 +376,5 @@ def post(self, request, pk): except Exception as e: messages.error(request, f"Failed to install module: {e}") - return redirect(reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk})) + sync_url = reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk}) + return redirect(f"{sync_url}?tab=modules") From d0905600e58f7c527356094ab1a94513eb800a17 Mon Sep 17 00:00:00 2001 From: Marcin Zieba Date: Tue, 17 Feb 2026 12:53:52 +0100 Subject: [PATCH 12/62] Add DeviceTypeMapping model with full CRUD stack Introduces a user-defined mapping table that maps LibreNMS hardware strings to NetBox DeviceType objects. The mapping table is checked first during device type matching, before falling back to exact part_number/model lookup. Includes: - DeviceTypeMapping model with librenms_hardware (unique) -> netbox_device_type FK - CRUD views, forms, filter, table following InterfaceTypeMapping pattern - API serializer/viewset with REST endpoint - Navigation menu item under Settings - Templates for list and detail views - Migration 0009 - Test for mapping-based match (281 tests pass) --- netbox_librenms_plugin/api/serializers.py | 12 +++- netbox_librenms_plugin/api/urls.py | 1 + netbox_librenms_plugin/api/views.py | 13 +++- netbox_librenms_plugin/filters.py | 12 +++- netbox_librenms_plugin/forms.py | 41 ++++++++++- .../migrations/0009_add_devicetypemapping.py | 45 ++++++++++++ netbox_librenms_plugin/models.py | 33 +++++++++ netbox_librenms_plugin/navigation.py | 17 +++++ netbox_librenms_plugin/tables/mappings.py | 31 ++++++++- .../devicetypemapping.html | 28 ++++++++ .../devicetypemapping_list.html | 12 ++++ netbox_librenms_plugin/tests/test_utils.py | 31 ++++++++- netbox_librenms_plugin/urls.py | 52 +++++++++++++- netbox_librenms_plugin/utils.py | 19 ++++- netbox_librenms_plugin/views/__init__.py | 8 +++ netbox_librenms_plugin/views/mapping_views.py | 69 ++++++++++++++++++- 16 files changed, 409 insertions(+), 15 deletions(-) create mode 100644 netbox_librenms_plugin/migrations/0009_add_devicetypemapping.py create mode 100644 netbox_librenms_plugin/templates/netbox_librenms_plugin/devicetypemapping.html create mode 100644 netbox_librenms_plugin/templates/netbox_librenms_plugin/devicetypemapping_list.html diff --git a/netbox_librenms_plugin/api/serializers.py b/netbox_librenms_plugin/api/serializers.py index 6bcd0aef20..fe3886c172 100644 --- a/netbox_librenms_plugin/api/serializers.py +++ b/netbox_librenms_plugin/api/serializers.py @@ -1,6 +1,6 @@ from netbox.api.serializers import NetBoxModelSerializer -from netbox_librenms_plugin.models import InterfaceTypeMapping +from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping class InterfaceTypeMappingSerializer(NetBoxModelSerializer): @@ -11,3 +11,13 @@ class Meta: model = InterfaceTypeMapping fields = ["id", "librenms_type", "librenms_speed", "netbox_type", "description"] + + +class DeviceTypeMappingSerializer(NetBoxModelSerializer): + """Serialize DeviceTypeMapping model for REST API.""" + + class Meta: + """Meta options for DeviceTypeMappingSerializer.""" + + model = DeviceTypeMapping + fields = ["id", "librenms_hardware", "netbox_device_type", "description"] diff --git a/netbox_librenms_plugin/api/urls.py b/netbox_librenms_plugin/api/urls.py index 230aa078d0..0ddfc7ad90 100644 --- a/netbox_librenms_plugin/api/urls.py +++ b/netbox_librenms_plugin/api/urls.py @@ -7,6 +7,7 @@ router = NetBoxRouter() router.register("interface-type-mappings", views.InterfaceTypeMappingViewSet) +router.register("device-type-mappings", views.DeviceTypeMappingViewSet) urlpatterns = [ path("jobs//sync-status/", views.sync_job_status, name="sync_job_status"), diff --git a/netbox_librenms_plugin/api/views.py b/netbox_librenms_plugin/api/views.py index 7086145be0..5bbba3ffeb 100644 --- a/netbox_librenms_plugin/api/views.py +++ b/netbox_librenms_plugin/api/views.py @@ -11,9 +11,9 @@ from rq.job import Job as RQJob from netbox_librenms_plugin.constants import PERM_CHANGE_PLUGIN, PERM_VIEW_PLUGIN -from netbox_librenms_plugin.models import InterfaceTypeMapping +from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping -from .serializers import InterfaceTypeMappingSerializer +from .serializers import DeviceTypeMappingSerializer, InterfaceTypeMappingSerializer logger = logging.getLogger(__name__) @@ -41,6 +41,15 @@ class InterfaceTypeMappingViewSet(NetBoxModelViewSet): serializer_class = InterfaceTypeMappingSerializer +class DeviceTypeMappingViewSet(NetBoxModelViewSet): + """API viewset for DeviceTypeMapping CRUD operations.""" + + permission_classes = [LibreNMSPluginPermission] + + queryset = DeviceTypeMapping.objects.all() + serializer_class = DeviceTypeMappingSerializer + + @api_view(["POST"]) @permission_classes([LibreNMSPluginPermission]) def sync_job_status(request, job_pk): diff --git a/netbox_librenms_plugin/filters.py b/netbox_librenms_plugin/filters.py index 9ec162a64c..7397eba512 100644 --- a/netbox_librenms_plugin/filters.py +++ b/netbox_librenms_plugin/filters.py @@ -1,6 +1,6 @@ import django_filters -from .models import InterfaceTypeMapping +from .models import DeviceTypeMapping, InterfaceTypeMapping class InterfaceTypeMappingFilterSet(django_filters.FilterSet): @@ -11,3 +11,13 @@ class Meta: model = InterfaceTypeMapping fields = ["librenms_type", "librenms_speed", "netbox_type", "description"] + + +class DeviceTypeMappingFilterSet(django_filters.FilterSet): + """Filter set for DeviceTypeMapping model.""" + + class Meta: + """Meta options for DeviceTypeMappingFilterSet.""" + + model = DeviceTypeMapping + fields = ["librenms_hardware", "description"] diff --git a/netbox_librenms_plugin/forms.py b/netbox_librenms_plugin/forms.py index a5dc9a0e30..0d5a51d52d 100644 --- a/netbox_librenms_plugin/forms.py +++ b/netbox_librenms_plugin/forms.py @@ -15,7 +15,7 @@ from utilities.forms.fields import CSVChoiceField, DynamicModelMultipleChoiceField from virtualization.models import Cluster, VirtualMachine -from .models import InterfaceTypeMapping, LibreNMSSettings +from .models import DeviceTypeMapping, InterfaceTypeMapping, LibreNMSSettings logger = logging.getLogger(__name__) @@ -279,6 +279,45 @@ class InterfaceTypeMappingFilterForm(NetBoxModelFilterSetForm): model = InterfaceTypeMapping +class DeviceTypeMappingForm(NetBoxModelForm): + """Form for creating and editing device type mappings between LibreNMS and NetBox.""" + + netbox_device_type = forms.ModelChoiceField( + queryset=DeviceType.objects.all(), + label="NetBox Device Type", + widget=forms.Select(attrs={"class": "form-select"}), + ) + + class Meta: + """Meta options for DeviceTypeMappingForm.""" + + model = DeviceTypeMapping + fields = ["librenms_hardware", "netbox_device_type", "description"] + + +class DeviceTypeMappingImportForm(NetBoxModelImportForm): + """Form for bulk importing device type mappings.""" + + class Meta: + """Meta options for DeviceTypeMappingImportForm.""" + + model = DeviceTypeMapping + fields = ["librenms_hardware", "netbox_device_type", "description"] + + +class DeviceTypeMappingFilterForm(NetBoxModelFilterSetForm): + """Form for filtering device type mappings.""" + + librenms_hardware = forms.CharField(required=False, label="LibreNMS Hardware") + description = forms.CharField( + required=False, + label="Description", + help_text="Filter by description (partial match)", + ) + + model = DeviceTypeMapping + + class AddToLIbreSNMPV1V2(forms.Form): """ Form for adding devices to LibreNMS using SNMPv1 or SNMPv2c authentication. diff --git a/netbox_librenms_plugin/migrations/0009_add_devicetypemapping.py b/netbox_librenms_plugin/migrations/0009_add_devicetypemapping.py new file mode 100644 index 0000000000..dcd8fc4fd5 --- /dev/null +++ b/netbox_librenms_plugin/migrations/0009_add_devicetypemapping.py @@ -0,0 +1,45 @@ +# Generated by Django 5.2.10 on 2026-02-17 11:48 + +import django.db.models.deletion +import netbox.models.deletion +import taggit.managers +import utilities.json +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ("dcim", "0225_gfk_indexes"), + ("extras", "0134_owner"), + ("netbox_librenms_plugin", "0008_librenmssettings_import_defaults"), + ] + + operations = [ + migrations.CreateModel( + name="DeviceTypeMapping", + 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), + ), + ("librenms_hardware", models.CharField(max_length=255, unique=True)), + ("description", models.TextField(blank=True)), + ( + "netbox_device_type", + models.ForeignKey( + on_delete=django.db.models.deletion.CASCADE, + related_name="librenms_mappings", + to="dcim.devicetype", + ), + ), + ("tags", taggit.managers.TaggableManager(through="extras.TaggedItem", to="extras.Tag")), + ], + options={ + "ordering": ["librenms_hardware"], + }, + bases=(netbox.models.deletion.DeleteMixin, models.Model), + ), + ] diff --git a/netbox_librenms_plugin/models.py b/netbox_librenms_plugin/models.py index cd79f47550..cb0ba6e9ec 100644 --- a/netbox_librenms_plugin/models.py +++ b/netbox_librenms_plugin/models.py @@ -1,4 +1,5 @@ from dcim.choices import InterfaceTypeChoices +from dcim.models import DeviceType from django.db import models from django.urls import reverse from netbox.models import NetBoxModel @@ -74,3 +75,35 @@ class Meta: def __str__(self): return f"{self.librenms_type} + {self.librenms_speed} -> {self.netbox_type}" + + +class DeviceTypeMapping(NetBoxModel): + """Map LibreNMS hardware strings to NetBox DeviceType objects.""" + + librenms_hardware = models.CharField( + max_length=255, + unique=True, + help_text="Hardware string as reported by LibreNMS (e.g., 'Juniper MX480 Internet Backbone Router')", + ) + netbox_device_type = models.ForeignKey( + DeviceType, + on_delete=models.CASCADE, + related_name="librenms_mappings", + help_text="The NetBox DeviceType this hardware string maps to", + ) + description = models.TextField( + blank=True, + help_text="Optional description or notes about this mapping", + ) + + def get_absolute_url(self): + """Return the URL for this mapping's detail page.""" + return reverse("plugins:netbox_librenms_plugin:devicetypemapping_detail", args=[self.pk]) + + class Meta: + """Meta options for DeviceTypeMapping.""" + + ordering = ["librenms_hardware"] + + def __str__(self): + return f"{self.librenms_hardware} -> {self.netbox_device_type}" diff --git a/netbox_librenms_plugin/navigation.py b/netbox_librenms_plugin/navigation.py index a08e62740f..02f1726b52 100644 --- a/netbox_librenms_plugin/navigation.py +++ b/netbox_librenms_plugin/navigation.py @@ -31,6 +31,23 @@ ), ), ), + PluginMenuItem( + link="plugins:netbox_librenms_plugin:devicetypemapping_list", + link_text="Device Type Mappings", + permissions=[PERM_VIEW_PLUGIN], + buttons=( + PluginMenuButton( + link="plugins:netbox_librenms_plugin:devicetypemapping_add", + title="Add", + icon_class="mdi mdi-plus-thick", + ), + PluginMenuButton( + link="plugins:netbox_librenms_plugin:devicetypemapping_bulk_import", + title="Import", + icon_class="mdi mdi-upload", + ), + ), + ), ), ), ( diff --git a/netbox_librenms_plugin/tables/mappings.py b/netbox_librenms_plugin/tables/mappings.py index 73949fd2c8..d02fa12938 100644 --- a/netbox_librenms_plugin/tables/mappings.py +++ b/netbox_librenms_plugin/tables/mappings.py @@ -1,7 +1,7 @@ import django_tables2 as tables from netbox.tables import NetBoxTable, columns -from netbox_librenms_plugin.models import InterfaceTypeMapping +from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping class InterfaceTypeMappingTable(NetBoxTable): @@ -36,3 +36,32 @@ class Meta: "actions", ) attrs = {"class": "table table-hover table-headings table-striped"} + + +class DeviceTypeMappingTable(NetBoxTable): + """Table for displaying DeviceTypeMapping data.""" + + librenms_hardware = tables.Column(verbose_name="LibreNMS Hardware", linkify=True) + netbox_device_type = tables.Column(verbose_name="NetBox Device Type", linkify=True) + description = tables.Column(verbose_name="Description", linkify=False) + actions = columns.ActionsColumn(actions=("edit", "delete")) + + class Meta: + """Meta options for DeviceTypeMappingTable.""" + + model = DeviceTypeMapping + fields = ( + "id", + "librenms_hardware", + "netbox_device_type", + "description", + "actions", + ) + default_columns = ( + "id", + "librenms_hardware", + "netbox_device_type", + "description", + "actions", + ) + attrs = {"class": "table table-hover table-headings table-striped"} diff --git a/netbox_librenms_plugin/templates/netbox_librenms_plugin/devicetypemapping.html b/netbox_librenms_plugin/templates/netbox_librenms_plugin/devicetypemapping.html new file mode 100644 index 0000000000..3894441179 --- /dev/null +++ b/netbox_librenms_plugin/templates/netbox_librenms_plugin/devicetypemapping.html @@ -0,0 +1,28 @@ +{% extends 'generic/object.html' %} +{% load helpers %} +{% load plugins %} + +{% block content %} +
+
+
+ + + + + + + + + + + + + + + +
LibreNMS HardwareNetBox Device TypeDescription
{{ object.librenms_hardware }}{{ object.netbox_device_type }}{{ object.description|default:"—" }}
+
+
+
+{% endblock %} diff --git a/netbox_librenms_plugin/templates/netbox_librenms_plugin/devicetypemapping_list.html b/netbox_librenms_plugin/templates/netbox_librenms_plugin/devicetypemapping_list.html new file mode 100644 index 0000000000..06c95270b3 --- /dev/null +++ b/netbox_librenms_plugin/templates/netbox_librenms_plugin/devicetypemapping_list.html @@ -0,0 +1,12 @@ +{% extends 'generic/object_list.html' %} + +{% block content %} +
+

Device Type Mapping

+

Map LibreNMS hardware strings to NetBox device types. + When importing devices from LibreNMS, these mappings are checked first before + falling back to exact part number / model matching.

+

Example: Map "Juniper MX480 Internet Backbone Router" to device type "MX480"

+
+ {{ block.super }} +{% endblock %} diff --git a/netbox_librenms_plugin/tests/test_utils.py b/netbox_librenms_plugin/tests/test_utils.py index d58fee191f..a1d8e1b4a2 100644 --- a/netbox_librenms_plugin/tests/test_utils.py +++ b/netbox_librenms_plugin/tests/test_utils.py @@ -15,9 +15,12 @@ class TestDeviceTypeMatching: """Test device type matching logic.""" + @patch("netbox_librenms_plugin.models.DeviceTypeMapping") @patch("dcim.models.DeviceType") - def test_match_device_type_exact_match_by_part_number(self, mock_device_type): + def test_match_device_type_exact_match_by_part_number(self, mock_device_type, mock_mapping): """Exact part_number string should match.""" + mock_mapping.DoesNotExist = Exception + mock_mapping.objects.get.side_effect = mock_mapping.DoesNotExist mock_dt = MagicMock(id=1, model="C9300-48P") mock_device_type.objects.get.return_value = mock_dt @@ -29,9 +32,12 @@ def test_match_device_type_exact_match_by_part_number(self, mock_device_type): assert result["device_type"] == mock_dt assert result["match_type"] == "exact" + @patch("netbox_librenms_plugin.models.DeviceTypeMapping") @patch("dcim.models.DeviceType") - def test_match_device_type_exact_match_by_model(self, mock_device_type): + def test_match_device_type_exact_match_by_model(self, mock_device_type, mock_mapping): """Exact model string should match when part_number fails.""" + mock_mapping.DoesNotExist = Exception + mock_mapping.objects.get.side_effect = mock_mapping.DoesNotExist mock_dt = MagicMock(id=1, model="WS-C3750X-48P") # Part number lookup fails, model lookup succeeds mock_device_type.DoesNotExist = Exception @@ -48,9 +54,12 @@ def test_match_device_type_exact_match_by_model(self, mock_device_type): assert result["device_type"] == mock_dt assert result["match_type"] == "exact" + @patch("netbox_librenms_plugin.models.DeviceTypeMapping") @patch("dcim.models.DeviceType") - def test_match_device_type_not_found(self, mock_device_type): + def test_match_device_type_not_found(self, mock_device_type, mock_mapping): """Returns None when no match found.""" + mock_mapping.DoesNotExist = Exception + mock_mapping.objects.get.side_effect = mock_mapping.DoesNotExist mock_device_type.DoesNotExist = Exception mock_device_type.objects.get.side_effect = mock_device_type.DoesNotExist @@ -62,6 +71,22 @@ def test_match_device_type_not_found(self, mock_device_type): assert result["device_type"] is None assert result["match_type"] is None + @patch("netbox_librenms_plugin.models.DeviceTypeMapping") + def test_match_device_type_mapping_match(self, mock_mapping): + """DeviceTypeMapping entry should be used before part_number/model fallback.""" + mock_dt = MagicMock(id=1, model="MX480") + mock_mapping_obj = MagicMock(netbox_device_type=mock_dt) + mock_mapping.DoesNotExist = Exception + mock_mapping.objects.get.return_value = mock_mapping_obj + + from netbox_librenms_plugin.utils import match_librenms_hardware_to_device_type + + result = match_librenms_hardware_to_device_type("Juniper MX480 Internet Backbone Router") + + assert result["matched"] is True + assert result["device_type"] == mock_dt + assert result["match_type"] == "mapping" + def test_match_device_type_empty_hardware(self): """Empty string returns None.""" from netbox_librenms_plugin.utils import match_librenms_hardware_to_device_type diff --git a/netbox_librenms_plugin/urls.py b/netbox_librenms_plugin/urls.py index e522abb696..75f3a5e205 100644 --- a/netbox_librenms_plugin/urls.py +++ b/netbox_librenms_plugin/urls.py @@ -1,6 +1,6 @@ from django.urls import include, path -from .models import InterfaceTypeMapping +from .models import DeviceTypeMapping, InterfaceTypeMapping from .views import ( AddDeviceToLibreNMSView, AssignVCSerialView, @@ -18,6 +18,14 @@ DeviceRackUpdateView, DeviceRoleUpdateView, DeviceStatusListView, + DeviceTypeMappingBulkDeleteView, + DeviceTypeMappingBulkImportView, + DeviceTypeMappingChangeLogView, + DeviceTypeMappingCreateView, + DeviceTypeMappingDeleteView, + DeviceTypeMappingEditView, + DeviceTypeMappingListView, + DeviceTypeMappingView, DeviceValidationDetailsView, DeviceVCDetailsView, DeviceVLANTableView, @@ -347,5 +355,47 @@ InterfaceTypeMappingBulkDeleteView.as_view(), name="interfacetypemapping_bulk_delete", ), + # Device type mapping URLs + path( + "device-type-mappings/", + DeviceTypeMappingListView.as_view(), + name="devicetypemapping_list", + ), + path( + "device-type-mappings//", + DeviceTypeMappingView.as_view(), + name="devicetypemapping_detail", + ), + path( + "device-type-mappings/add/", + DeviceTypeMappingCreateView.as_view(), + name="devicetypemapping_add", + ), + path( + "device-type-mappings/import/", + DeviceTypeMappingBulkImportView.as_view(), + name="devicetypemapping_bulk_import", + ), + path( + "device-type-mappings//delete/", + DeviceTypeMappingDeleteView.as_view(), + name="devicetypemapping_delete", + ), + path( + "device-type-mappings//edit/", + DeviceTypeMappingEditView.as_view(), + name="devicetypemapping_edit", + ), + path( + "device-type-mappings//changelog/", + DeviceTypeMappingChangeLogView.as_view(), + name="devicetypemapping_changelog", + kwargs={"model": DeviceTypeMapping}, + ), + path( + "device-type-mappings/delete/", + DeviceTypeMappingBulkDeleteView.as_view(), + name="devicetypemapping_bulk_delete", + ), path("api/", include("netbox_librenms_plugin.api.urls")), ] diff --git a/netbox_librenms_plugin/utils.py b/netbox_librenms_plugin/utils.py index 4a5bf113a4..7cefd2535b 100644 --- a/netbox_librenms_plugin/utils.py +++ b/netbox_librenms_plugin/utils.py @@ -193,7 +193,8 @@ def match_librenms_hardware_to_device_type(hardware_name: str) -> dict: """ Match LibreNMS hardware string to a NetBox DeviceType. - Only performs exact matching on part_number and model fields (case-insensitive). + Checks DeviceTypeMapping table first, then falls back to exact matching + on part_number and model fields (case-insensitive). Args: hardware_name (str): Hardware string from LibreNMS API (e.g., 'C9200L-48P-4X') @@ -202,13 +203,27 @@ def match_librenms_hardware_to_device_type(hardware_name: str) -> dict: dict: Dictionary containing: - matched (bool): Whether a match was found - device_type (DeviceType|None): The matched DeviceType object - - match_type (str|None): Always 'exact' if found, None otherwise + - match_type (str|None): 'mapping' if via DeviceTypeMapping, 'exact' if via + part_number/model, None otherwise """ from dcim.models import DeviceType + from netbox_librenms_plugin.models import DeviceTypeMapping + if not hardware_name or hardware_name == "-": return {"matched": False, "device_type": None, "match_type": None} + # Check DeviceTypeMapping table first + try: + mapping = DeviceTypeMapping.objects.get(librenms_hardware__iexact=hardware_name) + return { + "matched": True, + "device_type": mapping.netbox_device_type, + "match_type": "mapping", + } + except DeviceTypeMapping.DoesNotExist: + pass + # Try part number exact match try: device_type = DeviceType.objects.get(part_number__iexact=hardware_name) diff --git a/netbox_librenms_plugin/views/__init__.py b/netbox_librenms_plugin/views/__init__.py index 51dead5597..91f3039d50 100644 --- a/netbox_librenms_plugin/views/__init__.py +++ b/netbox_librenms_plugin/views/__init__.py @@ -21,6 +21,14 @@ SaveUserPrefView, ) from .mapping_views import ( + DeviceTypeMappingBulkDeleteView, + DeviceTypeMappingBulkImportView, + DeviceTypeMappingChangeLogView, + DeviceTypeMappingCreateView, + DeviceTypeMappingDeleteView, + DeviceTypeMappingEditView, + DeviceTypeMappingListView, + DeviceTypeMappingView, InterfaceTypeMappingBulkDeleteView, InterfaceTypeMappingBulkImportView, InterfaceTypeMappingChangeLogView, diff --git a/netbox_librenms_plugin/views/mapping_views.py b/netbox_librenms_plugin/views/mapping_views.py index b1fcec9c77..e0ea2da8c3 100644 --- a/netbox_librenms_plugin/views/mapping_views.py +++ b/netbox_librenms_plugin/views/mapping_views.py @@ -1,14 +1,17 @@ from netbox.views import generic from utilities.views import register_model_view -from netbox_librenms_plugin.filters import InterfaceTypeMappingFilterSet +from netbox_librenms_plugin.filters import DeviceTypeMappingFilterSet, InterfaceTypeMappingFilterSet from netbox_librenms_plugin.forms import ( + DeviceTypeMappingFilterForm, + DeviceTypeMappingForm, + DeviceTypeMappingImportForm, InterfaceTypeMappingFilterForm, InterfaceTypeMappingForm, InterfaceTypeMappingImportForm, ) -from netbox_librenms_plugin.models import InterfaceTypeMapping -from netbox_librenms_plugin.tables.mappings import InterfaceTypeMappingTable +from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping +from netbox_librenms_plugin.tables.mappings import DeviceTypeMappingTable, InterfaceTypeMappingTable from netbox_librenms_plugin.views.mixins import LibreNMSPermissionMixin @@ -84,3 +87,63 @@ class InterfaceTypeMappingChangeLogView(LibreNMSPermissionMixin, generic.ObjectC """ queryset = InterfaceTypeMapping.objects.all() + + +# --- DeviceTypeMapping views --- + + +class DeviceTypeMappingListView(LibreNMSPermissionMixin, generic.ObjectListView): + """Provides a view for listing all DeviceTypeMapping objects.""" + + queryset = DeviceTypeMapping.objects.all() + table = DeviceTypeMappingTable + filterset = DeviceTypeMappingFilterSet + filterset_form = DeviceTypeMappingFilterForm + template_name = "netbox_librenms_plugin/devicetypemapping_list.html" + + +class DeviceTypeMappingCreateView(LibreNMSPermissionMixin, generic.ObjectEditView): + """Provides a view for creating a new DeviceTypeMapping object.""" + + queryset = DeviceTypeMapping.objects.all() + form = DeviceTypeMappingForm + + +@register_model_view(DeviceTypeMapping, "bulk_import", path="import", detail=False) +class DeviceTypeMappingBulkImportView(LibreNMSPermissionMixin, generic.BulkImportView): + """Provides a view for bulk importing DeviceTypeMapping objects.""" + + queryset = DeviceTypeMapping.objects.all() + model_form = DeviceTypeMappingImportForm + + +class DeviceTypeMappingView(LibreNMSPermissionMixin, generic.ObjectView): + """Provides a view for displaying details of a specific DeviceTypeMapping object.""" + + queryset = DeviceTypeMapping.objects.all() + + +class DeviceTypeMappingEditView(LibreNMSPermissionMixin, generic.ObjectEditView): + """Provides a view for editing a specific DeviceTypeMapping object.""" + + queryset = DeviceTypeMapping.objects.all() + form = DeviceTypeMappingForm + + +class DeviceTypeMappingDeleteView(LibreNMSPermissionMixin, generic.ObjectDeleteView): + """Provides a view for deleting a specific DeviceTypeMapping object.""" + + queryset = DeviceTypeMapping.objects.all() + + +class DeviceTypeMappingBulkDeleteView(LibreNMSPermissionMixin, generic.BulkDeleteView): + """Provides a view for deleting multiple DeviceTypeMapping objects.""" + + queryset = DeviceTypeMapping.objects.all() + table = DeviceTypeMappingTable + + +class DeviceTypeMappingChangeLogView(LibreNMSPermissionMixin, generic.ObjectChangeLogView): + """Provides a view for displaying the change log of a specific DeviceTypeMapping object.""" + + queryset = DeviceTypeMapping.objects.all() From a181d84b8023134a35fa6033fdaae176271b3f1c Mon Sep 17 00:00:00 2001 From: Marcin Zieba Date: Tue, 17 Feb 2026 13:25:33 +0100 Subject: [PATCH 13/62] Add ModuleTypeMapping model, fix ordering, add contrib examples MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ModuleTypeMapping: - Model mapping LibreNMS inventory model names (entPhysicalModelName) to NetBox ModuleType objects - Full CRUD stack: views, forms, filter, table, templates - API serializer/viewset at /api/plugins/librenms_plugin/module-type-mappings/ - Navigation menu item under Settings with Add/Import buttons - Module tab matching updated to check mapping before part_number/model fallback - Migration 0010 InterfaceTypeMapping ordering fix: - Added Meta.ordering to fix API pagination error (QuerySetNotOrdered) Contrib directory: - contrib/README.md with import instructions - contrib/interface_type_mappings.yaml — common interface type examples - contrib/device_type_mappings.yaml — Juniper/Nokia/Cisco device type examples - contrib/module_type_mappings.yaml — module type mapping examples - All files importable via NetBox built-in YAML bulk import --- contrib/README.md | 27 +++++++ contrib/device_type_mappings.yaml | 60 +++++++++++++++ contrib/interface_type_mappings.yaml | 70 +++++++++++++++++ contrib/module_type_mappings.yaml | 60 +++++++++++++++ netbox_librenms_plugin/api/serializers.py | 12 ++- netbox_librenms_plugin/api/urls.py | 1 + netbox_librenms_plugin/api/views.py | 13 +++- netbox_librenms_plugin/filters.py | 12 ++- netbox_librenms_plugin/forms.py | 35 ++++++++- .../migrations/0010_add_moduletypemapping.py | 49 ++++++++++++ netbox_librenms_plugin/models.py | 35 ++++++++- netbox_librenms_plugin/navigation.py | 17 ++++ netbox_librenms_plugin/tables/mappings.py | 31 +++++++- .../moduletypemapping.html | 28 +++++++ .../moduletypemapping_list.html | 12 +++ netbox_librenms_plugin/urls.py | 52 ++++++++++++- netbox_librenms_plugin/views/__init__.py | 8 ++ .../views/base/modules_view.py | 10 ++- netbox_librenms_plugin/views/mapping_views.py | 77 ++++++++++++++++++- 19 files changed, 597 insertions(+), 12 deletions(-) create mode 100644 contrib/README.md create mode 100644 contrib/device_type_mappings.yaml create mode 100644 contrib/interface_type_mappings.yaml create mode 100644 contrib/module_type_mappings.yaml create mode 100644 netbox_librenms_plugin/migrations/0010_add_moduletypemapping.py create mode 100644 netbox_librenms_plugin/templates/netbox_librenms_plugin/moduletypemapping.html create mode 100644 netbox_librenms_plugin/templates/netbox_librenms_plugin/moduletypemapping_list.html diff --git a/contrib/README.md b/contrib/README.md new file mode 100644 index 0000000000..774a28bbdb --- /dev/null +++ b/contrib/README.md @@ -0,0 +1,27 @@ +# Contrib: Example Mapping Files + +This directory contains example YAML mapping files for bulk import into the +NetBox LibreNMS Plugin. Each file can be imported via the plugin's bulk import +feature in the NetBox UI. + +## How to Import + +1. Navigate to the mapping page (e.g., **LibreNMS → Device Type Mappings**) +2. Click the **Import** button (upload icon) in the top right +3. Select **YAML** format +4. Paste the contents of the relevant YAML file +5. Click **Submit** + +## Available Mappings + +| File | Description | +|------|-------------| +| `interface_type_mappings.yaml` | Maps LibreNMS interface types + speeds to NetBox interface types | +| `device_type_mappings.yaml` | Maps LibreNMS hardware strings to NetBox device types | +| `module_type_mappings.yaml` | Maps LibreNMS inventory model names to NetBox module types | + +## Customisation + +These files are **examples** — adjust values to match the device types, module +types, and interface types defined in your NetBox instance. The `netbox_*` +fields must reference objects that already exist in your NetBox. diff --git a/contrib/device_type_mappings.yaml b/contrib/device_type_mappings.yaml new file mode 100644 index 0000000000..0e7bb96a9b --- /dev/null +++ b/contrib/device_type_mappings.yaml @@ -0,0 +1,60 @@ +# Device Type Mappings — Example +# +# Maps LibreNMS hardware strings to NetBox device types. +# Import via: LibreNMS → Device Type Mappings → Import → YAML +# +# Fields: +# librenms_hardware — Hardware string exactly as shown in LibreNMS +# netbox_device_type — NetBox DeviceType (matched by model name or ID) +# description — Optional note +# +# The librenms_hardware value is matched case-insensitively. +# These mappings are checked BEFORE the built-in part_number/model fallback. + +# Juniper — LibreNMS reports verbose marketing names +- librenms_hardware: "Juniper MX480 Internet Backbone Router" + netbox_device_type: "MX480" + description: "Juniper MX480 chassis" + +- librenms_hardware: "Juniper MX960 Internet Backbone Router" + netbox_device_type: "MX960" + description: "Juniper MX960 chassis" + +- librenms_hardware: "Juniper MX304 Edge Router" + netbox_device_type: "MX304" + description: "Juniper MX304 edge router" + +- librenms_hardware: "JNP10008 [PTX10008]" + netbox_device_type: "PTX10008" + description: "Juniper PTX10008 core router" + +- librenms_hardware: "JNP7100-32C [ACX7100-32C]" + netbox_device_type: "ACX7100-32C" + description: "Juniper ACX7100-32C" + +- librenms_hardware: "JNP7024 [ACX7024]" + netbox_device_type: "ACX7024" + description: "Juniper ACX7024" + +- librenms_hardware: "Juniper JNP10008 Internet Backbone Router" + netbox_device_type: "PTX10008" + description: "Juniper PTX10008 (alternate hardware string)" + +- librenms_hardware: "Juniper VRR Internet Backbone Router" + netbox_device_type: "VRR" + description: "Juniper Virtual Route Reflector" + +# Nokia — model string matches directly in most cases +- librenms_hardware: "7750 SR-7s" + netbox_device_type: "7750 SR-7s" + description: "Nokia 7750 SR-7s service router" + +# Cisco — often matches by part_number but not always +- librenms_hardware: "WS-C4900M" + netbox_device_type: "WS-C4900M" + description: "Cisco Catalyst 4900M" + +# Cisco IOS XR +- librenms_hardware: "8201-SYS" + netbox_device_type: "8201" + description: "Cisco 8201 (hardware string differs from model)" diff --git a/contrib/interface_type_mappings.yaml b/contrib/interface_type_mappings.yaml new file mode 100644 index 0000000000..f548de4c0c --- /dev/null +++ b/contrib/interface_type_mappings.yaml @@ -0,0 +1,70 @@ +# Interface Type Mappings — Example +# +# Maps LibreNMS interface types (and optional speeds) to NetBox interface types. +# Import via: LibreNMS → Interface Mappings → Import → YAML +# +# Fields: +# librenms_type — IANA ifType string from LibreNMS (e.g. ethernetCsmacd) +# librenms_speed — Speed in Kbps (optional, null matches any speed) +# netbox_type — NetBox InterfaceTypeChoices slug +# description — Optional note +# +# Common NetBox interface type slugs: +# 1000base-t, 10gbase-t, 10gbase-x-sfpp, 25gbase-x-sfp28, +# 40gbase-x-qsfpp, 100gbase-x-qsfp28, 400gbase-x-qsfpdd, +# ieee802.11ax, lag, virtual, other + +- librenms_type: ethernetCsmacd + librenms_speed: 1000000 + netbox_type: 1000base-t + description: "1G Ethernet copper" + +- librenms_type: ethernetCsmacd + librenms_speed: 10000000 + netbox_type: 10gbase-x-sfpp + description: "10G Ethernet SFP+" + +- librenms_type: ethernetCsmacd + librenms_speed: 25000000 + netbox_type: 25gbase-x-sfp28 + description: "25G Ethernet SFP28" + +- librenms_type: ethernetCsmacd + librenms_speed: 40000000 + netbox_type: 40gbase-x-qsfpp + description: "40G Ethernet QSFP+" + +- librenms_type: ethernetCsmacd + librenms_speed: 100000000 + netbox_type: 100gbase-x-qsfp28 + description: "100G Ethernet QSFP28" + +- librenms_type: ethernetCsmacd + librenms_speed: 400000000 + netbox_type: 400gbase-x-qsfpdd + description: "400G Ethernet QSFP-DD" + +- librenms_type: ieee8023adLag + librenms_speed: + netbox_type: lag + description: "LACP/LAG aggregation" + +- librenms_type: propVirtual + librenms_speed: + netbox_type: virtual + description: "Virtual/loopback interface" + +- librenms_type: softwareLoopback + librenms_speed: + netbox_type: virtual + description: "Software loopback" + +- librenms_type: tunnel + librenms_speed: + netbox_type: virtual + description: "Tunnel interface" + +- librenms_type: l2vlan + librenms_speed: + netbox_type: virtual + description: "VLAN interface" diff --git a/contrib/module_type_mappings.yaml b/contrib/module_type_mappings.yaml new file mode 100644 index 0000000000..a4dcd69fe6 --- /dev/null +++ b/contrib/module_type_mappings.yaml @@ -0,0 +1,60 @@ +# Module Type Mappings — Example +# +# Maps LibreNMS inventory model names (entPhysicalModelName) to NetBox module types. +# Import via: LibreNMS → Module Type Mappings → Import → YAML +# +# Fields: +# librenms_model — Model name from LibreNMS SNMP inventory +# netbox_module_type — NetBox ModuleType (matched by model name or ID) +# description — Optional note +# +# These mappings are checked FIRST. If no mapping exists, the plugin falls back +# to exact model name and part_number matching against NetBox module types. +# +# Useful for cases where the LibreNMS model string differs from the NetBox +# module type model, or when part numbers are used as model names in inventory. + +# Cisco Catalyst 4900M line cards +- librenms_model: "WS-X4908-10GE" + netbox_module_type: "WS-X4908-10GE" + description: "Cisco 8-port 10G X2 line card" + +- librenms_model: "WS-X4992" + netbox_module_type: "WS-X4992" + description: "Cisco 48-port 10/100/1000 line card" + +# Cisco power supplies +- librenms_model: "PWR-C49M-1000AC" + netbox_module_type: "PWR-C49M-1000AC" + description: "Cisco 1000W AC power supply" + +# Cisco SFP/X2 transceivers +- librenms_model: "X2-10GB-LR" + netbox_module_type: "X2-10GB-LR" + description: "Cisco X2 10G LR transceiver" + +- librenms_model: "X2-10GB-SR" + netbox_module_type: "X2-10GB-SR" + description: "Cisco X2 10G SR transceiver" + +- librenms_model: "GLC-T" + netbox_module_type: "GLC-T" + description: "Cisco 1G copper SFP" + +- librenms_model: "GLC-TE" + netbox_module_type: "GLC-TE" + description: "Cisco 1G copper SFP (extended temp)" + +# Cisco converters +- librenms_model: "CVR-X2-SFP" + netbox_module_type: "CVR-X2-SFP" + description: "Cisco X2-to-SFP converter" + +# Juniper — part numbers often appear as model names in inventory +- librenms_model: "710-017414" + netbox_module_type: "MX480-CHASSIS-BP" + description: "Juniper MX480 backplane (matched by part number)" + +- librenms_model: "CHAS-BP-MX480-S" + netbox_module_type: "MX480-CHASSIS-BP" + description: "Juniper MX480 backplane (matched by name)" diff --git a/netbox_librenms_plugin/api/serializers.py b/netbox_librenms_plugin/api/serializers.py index fe3886c172..95315de5ae 100644 --- a/netbox_librenms_plugin/api/serializers.py +++ b/netbox_librenms_plugin/api/serializers.py @@ -1,6 +1,6 @@ from netbox.api.serializers import NetBoxModelSerializer -from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping +from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping, ModuleTypeMapping class InterfaceTypeMappingSerializer(NetBoxModelSerializer): @@ -21,3 +21,13 @@ class Meta: model = DeviceTypeMapping fields = ["id", "librenms_hardware", "netbox_device_type", "description"] + + +class ModuleTypeMappingSerializer(NetBoxModelSerializer): + """Serialize ModuleTypeMapping model for REST API.""" + + class Meta: + """Meta options for ModuleTypeMappingSerializer.""" + + model = ModuleTypeMapping + fields = ["id", "librenms_model", "netbox_module_type", "description"] diff --git a/netbox_librenms_plugin/api/urls.py b/netbox_librenms_plugin/api/urls.py index 0ddfc7ad90..46373a861f 100644 --- a/netbox_librenms_plugin/api/urls.py +++ b/netbox_librenms_plugin/api/urls.py @@ -8,6 +8,7 @@ router = NetBoxRouter() router.register("interface-type-mappings", views.InterfaceTypeMappingViewSet) router.register("device-type-mappings", views.DeviceTypeMappingViewSet) +router.register("module-type-mappings", views.ModuleTypeMappingViewSet) urlpatterns = [ path("jobs//sync-status/", views.sync_job_status, name="sync_job_status"), diff --git a/netbox_librenms_plugin/api/views.py b/netbox_librenms_plugin/api/views.py index 5bbba3ffeb..a66db66345 100644 --- a/netbox_librenms_plugin/api/views.py +++ b/netbox_librenms_plugin/api/views.py @@ -11,9 +11,9 @@ from rq.job import Job as RQJob from netbox_librenms_plugin.constants import PERM_CHANGE_PLUGIN, PERM_VIEW_PLUGIN -from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping +from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping, ModuleTypeMapping -from .serializers import DeviceTypeMappingSerializer, InterfaceTypeMappingSerializer +from .serializers import DeviceTypeMappingSerializer, InterfaceTypeMappingSerializer, ModuleTypeMappingSerializer logger = logging.getLogger(__name__) @@ -50,6 +50,15 @@ class DeviceTypeMappingViewSet(NetBoxModelViewSet): serializer_class = DeviceTypeMappingSerializer +class ModuleTypeMappingViewSet(NetBoxModelViewSet): + """API viewset for ModuleTypeMapping CRUD operations.""" + + permission_classes = [LibreNMSPluginPermission] + + queryset = ModuleTypeMapping.objects.all() + serializer_class = ModuleTypeMappingSerializer + + @api_view(["POST"]) @permission_classes([LibreNMSPluginPermission]) def sync_job_status(request, job_pk): diff --git a/netbox_librenms_plugin/filters.py b/netbox_librenms_plugin/filters.py index 7397eba512..3bc33a55b3 100644 --- a/netbox_librenms_plugin/filters.py +++ b/netbox_librenms_plugin/filters.py @@ -1,6 +1,6 @@ import django_filters -from .models import DeviceTypeMapping, InterfaceTypeMapping +from .models import DeviceTypeMapping, InterfaceTypeMapping, ModuleTypeMapping class InterfaceTypeMappingFilterSet(django_filters.FilterSet): @@ -21,3 +21,13 @@ class Meta: model = DeviceTypeMapping fields = ["librenms_hardware", "description"] + + +class ModuleTypeMappingFilterSet(django_filters.FilterSet): + """Filter set for ModuleTypeMapping model.""" + + class Meta: + """Meta options for ModuleTypeMappingFilterSet.""" + + model = ModuleTypeMapping + fields = ["librenms_model", "description"] diff --git a/netbox_librenms_plugin/forms.py b/netbox_librenms_plugin/forms.py index 0d5a51d52d..f68c98ad3c 100644 --- a/netbox_librenms_plugin/forms.py +++ b/netbox_librenms_plugin/forms.py @@ -15,7 +15,7 @@ from utilities.forms.fields import CSVChoiceField, DynamicModelMultipleChoiceField from virtualization.models import Cluster, VirtualMachine -from .models import DeviceTypeMapping, InterfaceTypeMapping, LibreNMSSettings +from .models import DeviceTypeMapping, InterfaceTypeMapping, LibreNMSSettings, ModuleTypeMapping logger = logging.getLogger(__name__) @@ -318,6 +318,39 @@ class DeviceTypeMappingFilterForm(NetBoxModelFilterSetForm): model = DeviceTypeMapping +class ModuleTypeMappingForm(NetBoxModelForm): + """Form for creating and editing module type mappings between LibreNMS and NetBox.""" + + class Meta: + """Meta options for ModuleTypeMappingForm.""" + + model = ModuleTypeMapping + fields = ["librenms_model", "netbox_module_type", "description"] + + +class ModuleTypeMappingImportForm(NetBoxModelImportForm): + """Form for bulk importing module type mappings.""" + + class Meta: + """Meta options for ModuleTypeMappingImportForm.""" + + model = ModuleTypeMapping + fields = ["librenms_model", "netbox_module_type", "description"] + + +class ModuleTypeMappingFilterForm(NetBoxModelFilterSetForm): + """Form for filtering module type mappings.""" + + librenms_model = forms.CharField(required=False, label="LibreNMS Model") + description = forms.CharField( + required=False, + label="Description", + help_text="Filter by description (partial match)", + ) + + model = ModuleTypeMapping + + class AddToLIbreSNMPV1V2(forms.Form): """ Form for adding devices to LibreNMS using SNMPv1 or SNMPv2c authentication. diff --git a/netbox_librenms_plugin/migrations/0010_add_moduletypemapping.py b/netbox_librenms_plugin/migrations/0010_add_moduletypemapping.py new file mode 100644 index 0000000000..796bbceafd --- /dev/null +++ b/netbox_librenms_plugin/migrations/0010_add_moduletypemapping.py @@ -0,0 +1,49 @@ +# Generated by Django 5.2.10 on 2026-02-17 12:23 + +import django.db.models.deletion +import netbox.models.deletion +import taggit.managers +import utilities.json +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ("dcim", "0225_gfk_indexes"), + ("extras", "0134_owner"), + ("netbox_librenms_plugin", "0009_add_devicetypemapping"), + ] + + operations = [ + migrations.AlterModelOptions( + name="interfacetypemapping", + options={"ordering": ["librenms_type", "librenms_speed"]}, + ), + migrations.CreateModel( + name="ModuleTypeMapping", + 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), + ), + ("librenms_model", models.CharField(max_length=255, unique=True)), + ("description", models.TextField(blank=True)), + ( + "netbox_module_type", + models.ForeignKey( + on_delete=django.db.models.deletion.CASCADE, + related_name="librenms_mappings", + to="dcim.moduletype", + ), + ), + ("tags", taggit.managers.TaggableManager(through="extras.TaggedItem", to="extras.Tag")), + ], + options={ + "ordering": ["librenms_model"], + }, + bases=(netbox.models.deletion.DeleteMixin, models.Model), + ), + ] diff --git a/netbox_librenms_plugin/models.py b/netbox_librenms_plugin/models.py index cb0ba6e9ec..53815bb0ac 100644 --- a/netbox_librenms_plugin/models.py +++ b/netbox_librenms_plugin/models.py @@ -1,5 +1,5 @@ from dcim.choices import InterfaceTypeChoices -from dcim.models import DeviceType +from dcim.models import DeviceType, ModuleType from django.db import models from django.urls import reverse from netbox.models import NetBoxModel @@ -72,6 +72,7 @@ class Meta: """Meta options for InterfaceTypeMapping.""" unique_together = ["librenms_type", "librenms_speed"] + ordering = ["librenms_type", "librenms_speed"] def __str__(self): return f"{self.librenms_type} + {self.librenms_speed} -> {self.netbox_type}" @@ -107,3 +108,35 @@ class Meta: def __str__(self): return f"{self.librenms_hardware} -> {self.netbox_device_type}" + + +class ModuleTypeMapping(NetBoxModel): + """Map LibreNMS inventory model names to NetBox ModuleType objects.""" + + librenms_model = models.CharField( + max_length=255, + unique=True, + help_text="Model name from LibreNMS inventory (entPhysicalModelName)", + ) + netbox_module_type = models.ForeignKey( + ModuleType, + on_delete=models.CASCADE, + related_name="librenms_mappings", + help_text="The NetBox ModuleType this model name maps to", + ) + description = models.TextField( + blank=True, + help_text="Optional description or notes about this mapping", + ) + + def get_absolute_url(self): + """Return the URL for this mapping's detail page.""" + return reverse("plugins:netbox_librenms_plugin:moduletypemapping_detail", args=[self.pk]) + + class Meta: + """Meta options for ModuleTypeMapping.""" + + ordering = ["librenms_model"] + + def __str__(self): + return f"{self.librenms_model} -> {self.netbox_module_type}" diff --git a/netbox_librenms_plugin/navigation.py b/netbox_librenms_plugin/navigation.py index 02f1726b52..f40d8f8943 100644 --- a/netbox_librenms_plugin/navigation.py +++ b/netbox_librenms_plugin/navigation.py @@ -48,6 +48,23 @@ ), ), ), + PluginMenuItem( + link="plugins:netbox_librenms_plugin:moduletypemapping_list", + link_text="Module Type Mappings", + permissions=[PERM_VIEW_PLUGIN], + buttons=( + PluginMenuButton( + link="plugins:netbox_librenms_plugin:moduletypemapping_add", + title="Add", + icon_class="mdi mdi-plus-thick", + ), + PluginMenuButton( + link="plugins:netbox_librenms_plugin:moduletypemapping_bulk_import", + title="Import", + icon_class="mdi mdi-upload", + ), + ), + ), ), ), ( diff --git a/netbox_librenms_plugin/tables/mappings.py b/netbox_librenms_plugin/tables/mappings.py index d02fa12938..2ab5e81f71 100644 --- a/netbox_librenms_plugin/tables/mappings.py +++ b/netbox_librenms_plugin/tables/mappings.py @@ -1,7 +1,7 @@ import django_tables2 as tables from netbox.tables import NetBoxTable, columns -from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping +from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping, ModuleTypeMapping class InterfaceTypeMappingTable(NetBoxTable): @@ -65,3 +65,32 @@ class Meta: "actions", ) attrs = {"class": "table table-hover table-headings table-striped"} + + +class ModuleTypeMappingTable(NetBoxTable): + """Table for displaying ModuleTypeMapping data.""" + + librenms_model = tables.Column(verbose_name="LibreNMS Model", linkify=True) + netbox_module_type = tables.Column(verbose_name="NetBox Module Type", linkify=True) + description = tables.Column(verbose_name="Description", linkify=False) + actions = columns.ActionsColumn(actions=("edit", "delete")) + + class Meta: + """Meta options for ModuleTypeMappingTable.""" + + model = ModuleTypeMapping + fields = ( + "id", + "librenms_model", + "netbox_module_type", + "description", + "actions", + ) + default_columns = ( + "id", + "librenms_model", + "netbox_module_type", + "description", + "actions", + ) + attrs = {"class": "table table-hover table-headings table-striped"} diff --git a/netbox_librenms_plugin/templates/netbox_librenms_plugin/moduletypemapping.html b/netbox_librenms_plugin/templates/netbox_librenms_plugin/moduletypemapping.html new file mode 100644 index 0000000000..019b0e51ed --- /dev/null +++ b/netbox_librenms_plugin/templates/netbox_librenms_plugin/moduletypemapping.html @@ -0,0 +1,28 @@ +{% extends 'generic/object.html' %} +{% load helpers %} +{% load plugins %} + +{% block content %} +
+
+
+ + + + + + + + + + + + + + + +
LibreNMS ModelNetBox Module TypeDescription
{{ object.librenms_model }}{{ object.netbox_module_type }}{{ object.description|default:"—" }}
+
+
+
+{% endblock %} diff --git a/netbox_librenms_plugin/templates/netbox_librenms_plugin/moduletypemapping_list.html b/netbox_librenms_plugin/templates/netbox_librenms_plugin/moduletypemapping_list.html new file mode 100644 index 0000000000..4cfc22d592 --- /dev/null +++ b/netbox_librenms_plugin/templates/netbox_librenms_plugin/moduletypemapping_list.html @@ -0,0 +1,12 @@ +{% extends 'generic/object_list.html' %} + +{% block content %} +
+

Module Type Mapping

+

Map LibreNMS inventory model names (entPhysicalModelName) to NetBox module types. + When synchronizing modules from LibreNMS, these mappings are checked first before + falling back to exact model / part number matching.

+

Example: Map "710-017414" to module type "WS-X4908-10GE"

+
+ {{ block.super }} +{% endblock %} diff --git a/netbox_librenms_plugin/urls.py b/netbox_librenms_plugin/urls.py index 75f3a5e205..f5e544ca6f 100644 --- a/netbox_librenms_plugin/urls.py +++ b/netbox_librenms_plugin/urls.py @@ -1,6 +1,6 @@ from django.urls import include, path -from .models import DeviceTypeMapping, InterfaceTypeMapping +from .models import DeviceTypeMapping, InterfaceTypeMapping, ModuleTypeMapping from .views import ( AddDeviceToLibreNMSView, AssignVCSerialView, @@ -40,6 +40,14 @@ InterfaceTypeMappingView, LibreNMSImportView, LibreNMSSettingsView, + ModuleTypeMappingBulkDeleteView, + ModuleTypeMappingBulkImportView, + ModuleTypeMappingChangeLogView, + ModuleTypeMappingCreateView, + ModuleTypeMappingDeleteView, + ModuleTypeMappingEditView, + ModuleTypeMappingListView, + ModuleTypeMappingView, SaveUserPrefView, SingleCableVerifyView, SingleInterfaceVerifyView, @@ -397,5 +405,47 @@ DeviceTypeMappingBulkDeleteView.as_view(), name="devicetypemapping_bulk_delete", ), + # Module type mapping URLs + path( + "module-type-mappings/", + ModuleTypeMappingListView.as_view(), + name="moduletypemapping_list", + ), + path( + "module-type-mappings//", + ModuleTypeMappingView.as_view(), + name="moduletypemapping_detail", + ), + path( + "module-type-mappings/add/", + ModuleTypeMappingCreateView.as_view(), + name="moduletypemapping_add", + ), + path( + "module-type-mappings/import/", + ModuleTypeMappingBulkImportView.as_view(), + name="moduletypemapping_bulk_import", + ), + path( + "module-type-mappings//delete/", + ModuleTypeMappingDeleteView.as_view(), + name="moduletypemapping_delete", + ), + path( + "module-type-mappings//edit/", + ModuleTypeMappingEditView.as_view(), + name="moduletypemapping_edit", + ), + path( + "module-type-mappings//changelog/", + ModuleTypeMappingChangeLogView.as_view(), + name="moduletypemapping_changelog", + kwargs={"model": ModuleTypeMapping}, + ), + path( + "module-type-mappings/delete/", + ModuleTypeMappingBulkDeleteView.as_view(), + name="moduletypemapping_bulk_delete", + ), path("api/", include("netbox_librenms_plugin.api.urls")), ] diff --git a/netbox_librenms_plugin/views/__init__.py b/netbox_librenms_plugin/views/__init__.py index 91f3039d50..f95eb7830b 100644 --- a/netbox_librenms_plugin/views/__init__.py +++ b/netbox_librenms_plugin/views/__init__.py @@ -37,6 +37,14 @@ InterfaceTypeMappingEditView, InterfaceTypeMappingListView, InterfaceTypeMappingView, + ModuleTypeMappingBulkDeleteView, + ModuleTypeMappingBulkImportView, + ModuleTypeMappingChangeLogView, + ModuleTypeMappingCreateView, + ModuleTypeMappingDeleteView, + ModuleTypeMappingEditView, + ModuleTypeMappingListView, + ModuleTypeMappingView, ) from .object_sync import ( DeviceCableTableView, diff --git a/netbox_librenms_plugin/views/base/modules_view.py b/netbox_librenms_plugin/views/base/modules_view.py index c256f4dddd..e69593f9db 100644 --- a/netbox_librenms_plugin/views/base/modules_view.py +++ b/netbox_librenms_plugin/views/base/modules_view.py @@ -171,15 +171,23 @@ def _get_module_bays(self, obj): return {bay.name: bay for bay in bays} def _get_module_types(self): - """Get all module types, indexed by model (part_number).""" + """Get all module types, indexed by model (part_number), with ModuleTypeMapping checked first.""" from dcim.models import ModuleType + from netbox_librenms_plugin.models import ModuleTypeMapping + + # Build base lookup from NetBox module types types = ModuleType.objects.all().select_related("manufacturer") result = {} for mt in types: result[mt.model] = mt if mt.part_number and mt.part_number != mt.model: result[mt.part_number] = mt + + # Overlay with explicit ModuleTypeMapping entries (take priority) + for mapping in ModuleTypeMapping.objects.select_related("netbox_module_type__manufacturer"): + result[mapping.librenms_model] = mapping.netbox_module_type + return result def _find_parent_container_name(self, item, index_map): diff --git a/netbox_librenms_plugin/views/mapping_views.py b/netbox_librenms_plugin/views/mapping_views.py index e0ea2da8c3..f32d387344 100644 --- a/netbox_librenms_plugin/views/mapping_views.py +++ b/netbox_librenms_plugin/views/mapping_views.py @@ -1,7 +1,11 @@ from netbox.views import generic from utilities.views import register_model_view -from netbox_librenms_plugin.filters import DeviceTypeMappingFilterSet, InterfaceTypeMappingFilterSet +from netbox_librenms_plugin.filters import ( + DeviceTypeMappingFilterSet, + InterfaceTypeMappingFilterSet, + ModuleTypeMappingFilterSet, +) from netbox_librenms_plugin.forms import ( DeviceTypeMappingFilterForm, DeviceTypeMappingForm, @@ -9,9 +13,16 @@ InterfaceTypeMappingFilterForm, InterfaceTypeMappingForm, InterfaceTypeMappingImportForm, + ModuleTypeMappingFilterForm, + ModuleTypeMappingForm, + ModuleTypeMappingImportForm, +) +from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping, ModuleTypeMapping +from netbox_librenms_plugin.tables.mappings import ( + DeviceTypeMappingTable, + InterfaceTypeMappingTable, + ModuleTypeMappingTable, ) -from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping -from netbox_librenms_plugin.tables.mappings import DeviceTypeMappingTable, InterfaceTypeMappingTable from netbox_librenms_plugin.views.mixins import LibreNMSPermissionMixin @@ -147,3 +158,63 @@ class DeviceTypeMappingChangeLogView(LibreNMSPermissionMixin, generic.ObjectChan """Provides a view for displaying the change log of a specific DeviceTypeMapping object.""" queryset = DeviceTypeMapping.objects.all() + + +# --- ModuleTypeMapping views --- + + +class ModuleTypeMappingListView(LibreNMSPermissionMixin, generic.ObjectListView): + """Provides a view for listing all ModuleTypeMapping objects.""" + + queryset = ModuleTypeMapping.objects.all() + table = ModuleTypeMappingTable + filterset = ModuleTypeMappingFilterSet + filterset_form = ModuleTypeMappingFilterForm + template_name = "netbox_librenms_plugin/moduletypemapping_list.html" + + +class ModuleTypeMappingCreateView(LibreNMSPermissionMixin, generic.ObjectEditView): + """Provides a view for creating a new ModuleTypeMapping object.""" + + queryset = ModuleTypeMapping.objects.all() + form = ModuleTypeMappingForm + + +@register_model_view(ModuleTypeMapping, "bulk_import", path="import", detail=False) +class ModuleTypeMappingBulkImportView(LibreNMSPermissionMixin, generic.BulkImportView): + """Provides a view for bulk importing ModuleTypeMapping objects.""" + + queryset = ModuleTypeMapping.objects.all() + model_form = ModuleTypeMappingImportForm + + +class ModuleTypeMappingView(LibreNMSPermissionMixin, generic.ObjectView): + """Provides a view for displaying details of a specific ModuleTypeMapping object.""" + + queryset = ModuleTypeMapping.objects.all() + + +class ModuleTypeMappingEditView(LibreNMSPermissionMixin, generic.ObjectEditView): + """Provides a view for editing a specific ModuleTypeMapping object.""" + + queryset = ModuleTypeMapping.objects.all() + form = ModuleTypeMappingForm + + +class ModuleTypeMappingDeleteView(LibreNMSPermissionMixin, generic.ObjectDeleteView): + """Provides a view for deleting a specific ModuleTypeMapping object.""" + + queryset = ModuleTypeMapping.objects.all() + + +class ModuleTypeMappingBulkDeleteView(LibreNMSPermissionMixin, generic.BulkDeleteView): + """Provides a view for deleting multiple ModuleTypeMapping objects.""" + + queryset = ModuleTypeMapping.objects.all() + table = ModuleTypeMappingTable + + +class ModuleTypeMappingChangeLogView(LibreNMSPermissionMixin, generic.ObjectChangeLogView): + """Provides a view for displaying the change log of a specific ModuleTypeMapping object.""" + + queryset = ModuleTypeMapping.objects.all() From 7c50f2dbd99ae6f64b3ce3b4b6c0020959fed020 Mon Sep 17 00:00:00 2001 From: Marcin Zieba Date: Tue, 17 Feb 2026 13:32:31 +0100 Subject: [PATCH 14/62] Add ModuleBayMapping model with CRUD stack, replace bay matching heuristics - Add ModuleBayMapping model (librenms_name, librenms_class, netbox_bay_name) - Full CRUD: forms, filters, table, views, URLs, navigation, API - Replace _names_match() heuristics with mapping table lookup - Keep exact parent name match as final fallback - Add contrib/module_bay_mappings.yaml with seed data examples --- contrib/module_bay_mappings.yaml | 95 +++++++++++++++++++ netbox_librenms_plugin/api/serializers.py | 12 ++- netbox_librenms_plugin/api/urls.py | 1 + netbox_librenms_plugin/api/views.py | 18 +++- netbox_librenms_plugin/filters.py | 12 ++- netbox_librenms_plugin/forms.py | 32 ++++++- .../migrations/0011_modulebaymapping.py | 38 ++++++++ netbox_librenms_plugin/models.py | 41 ++++++++ netbox_librenms_plugin/navigation.py | 17 ++++ netbox_librenms_plugin/tables/mappings.py | 34 ++++++- .../modulebaymapping.html | 30 ++++++ .../modulebaymapping_list.html | 12 +++ netbox_librenms_plugin/urls.py | 52 +++++++++- netbox_librenms_plugin/views/__init__.py | 8 ++ .../views/base/modules_view.py | 88 +++++++---------- netbox_librenms_plugin/views/mapping_views.py | 72 +++++++++++++- 16 files changed, 498 insertions(+), 64 deletions(-) create mode 100644 contrib/module_bay_mappings.yaml create mode 100644 netbox_librenms_plugin/migrations/0011_modulebaymapping.py create mode 100644 netbox_librenms_plugin/templates/netbox_librenms_plugin/modulebaymapping.html create mode 100644 netbox_librenms_plugin/templates/netbox_librenms_plugin/modulebaymapping_list.html diff --git a/contrib/module_bay_mappings.yaml b/contrib/module_bay_mappings.yaml new file mode 100644 index 0000000000..da05c3db27 --- /dev/null +++ b/contrib/module_bay_mappings.yaml @@ -0,0 +1,95 @@ +# Module Bay Mappings - Map LibreNMS inventory container names to NetBox module bay names +# +# These mappings replace heuristic matching between LibreNMS inventory and NetBox module bays. +# Import via: LibreNMS Plugin → Module Bay Mappings → Import +# +# Fields: +# librenms_name: LibreNMS entPhysicalName or container name (exact match) +# librenms_class: Optional entPhysicalClass filter (powerSupply, fan, module, etc.) +# Leave empty for class-independent mappings +# netbox_bay_name: Target NetBox module bay name +# description: Optional description + +# --- Power Supplies --- +- librenms_name: "Power Supply 1" + librenms_class: "powerSupply" + netbox_bay_name: "PS1" + description: "Power supply slot 1" +- librenms_name: "Power Supply 2" + librenms_class: "powerSupply" + netbox_bay_name: "PS2" + description: "Power supply slot 2" +- librenms_name: "Power Supply 3" + librenms_class: "powerSupply" + netbox_bay_name: "PS3" + description: "Power supply slot 3" + +# --- Fan Trays --- +- librenms_name: "FanTray 1" + librenms_class: "fan" + netbox_bay_name: "Fan 1" + description: "Fan tray 1" +- librenms_name: "FanTray 2" + librenms_class: "fan" + netbox_bay_name: "Fan 2" + description: "Fan tray 2" +- librenms_name: "FanTray 3" + librenms_class: "fan" + netbox_bay_name: "Fan 3" + description: "Fan tray 3" + +# --- Cisco Line Card Slots --- +- librenms_name: "Linecard(slot 1)" + librenms_class: "module" + netbox_bay_name: "Slot 1" + description: "Linecard slot 1" +- librenms_name: "Linecard(slot 2)" + librenms_class: "module" + netbox_bay_name: "Slot 2" + description: "Linecard slot 2" +- librenms_name: "Linecard(slot 3)" + librenms_class: "module" + netbox_bay_name: "Slot 3" + description: "Linecard slot 3" +- librenms_name: "Linecard(slot 4)" + librenms_class: "module" + netbox_bay_name: "Slot 4" + description: "Linecard slot 4" +- librenms_name: "Linecard(slot 5)" + librenms_class: "module" + netbox_bay_name: "Slot 5" + description: "Linecard slot 5" + +# --- Cisco Supervisor Slots --- +- librenms_name: "Supervisor(slot 1)" + librenms_class: "module" + netbox_bay_name: "Slot 1" + description: "Supervisor slot 1" +- librenms_name: "Supervisor(slot 2)" + librenms_class: "module" + netbox_bay_name: "Slot 2" + description: "Supervisor slot 2" + +# --- Juniper FPC Slots --- +- librenms_name: "FPC 0" + librenms_class: "module" + netbox_bay_name: "FPC 0" + description: "Juniper FPC slot 0" +- librenms_name: "FPC 1" + librenms_class: "module" + netbox_bay_name: "FPC 1" + description: "Juniper FPC slot 1" +- librenms_name: "FPC 2" + librenms_class: "module" + netbox_bay_name: "FPC 2" + description: "Juniper FPC slot 2" + +# --- Juniper Routing Engine --- +- librenms_name: "Routing Engine 0" + librenms_class: "module" + netbox_bay_name: "RE 0" + description: "Juniper routing engine 0" +- librenms_name: "Routing Engine 1" + librenms_class: "module" + netbox_bay_name: "RE 1" + description: "Juniper routing engine 1" diff --git a/netbox_librenms_plugin/api/serializers.py b/netbox_librenms_plugin/api/serializers.py index 95315de5ae..b5d44b7788 100644 --- a/netbox_librenms_plugin/api/serializers.py +++ b/netbox_librenms_plugin/api/serializers.py @@ -1,6 +1,6 @@ from netbox.api.serializers import NetBoxModelSerializer -from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping, ModuleTypeMapping +from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping, ModuleBayMapping, ModuleTypeMapping class InterfaceTypeMappingSerializer(NetBoxModelSerializer): @@ -31,3 +31,13 @@ class Meta: model = ModuleTypeMapping fields = ["id", "librenms_model", "netbox_module_type", "description"] + + +class ModuleBayMappingSerializer(NetBoxModelSerializer): + """Serialize ModuleBayMapping model for REST API.""" + + class Meta: + """Meta options for ModuleBayMappingSerializer.""" + + model = ModuleBayMapping + fields = ["id", "librenms_name", "librenms_class", "netbox_bay_name", "description"] diff --git a/netbox_librenms_plugin/api/urls.py b/netbox_librenms_plugin/api/urls.py index 46373a861f..2c60ad6f1d 100644 --- a/netbox_librenms_plugin/api/urls.py +++ b/netbox_librenms_plugin/api/urls.py @@ -9,6 +9,7 @@ router.register("interface-type-mappings", views.InterfaceTypeMappingViewSet) router.register("device-type-mappings", views.DeviceTypeMappingViewSet) router.register("module-type-mappings", views.ModuleTypeMappingViewSet) +router.register("module-bay-mappings", views.ModuleBayMappingViewSet) urlpatterns = [ path("jobs//sync-status/", views.sync_job_status, name="sync_job_status"), diff --git a/netbox_librenms_plugin/api/views.py b/netbox_librenms_plugin/api/views.py index a66db66345..efe90ad1e5 100644 --- a/netbox_librenms_plugin/api/views.py +++ b/netbox_librenms_plugin/api/views.py @@ -11,9 +11,14 @@ from rq.job import Job as RQJob from netbox_librenms_plugin.constants import PERM_CHANGE_PLUGIN, PERM_VIEW_PLUGIN -from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping, ModuleTypeMapping +from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping, ModuleBayMapping, ModuleTypeMapping -from .serializers import DeviceTypeMappingSerializer, InterfaceTypeMappingSerializer, ModuleTypeMappingSerializer +from .serializers import ( + DeviceTypeMappingSerializer, + InterfaceTypeMappingSerializer, + ModuleBayMappingSerializer, + ModuleTypeMappingSerializer, +) logger = logging.getLogger(__name__) @@ -59,6 +64,15 @@ class ModuleTypeMappingViewSet(NetBoxModelViewSet): serializer_class = ModuleTypeMappingSerializer +class ModuleBayMappingViewSet(NetBoxModelViewSet): + """API viewset for ModuleBayMapping CRUD operations.""" + + permission_classes = [LibreNMSPluginPermission] + + queryset = ModuleBayMapping.objects.all() + serializer_class = ModuleBayMappingSerializer + + @api_view(["POST"]) @permission_classes([LibreNMSPluginPermission]) def sync_job_status(request, job_pk): diff --git a/netbox_librenms_plugin/filters.py b/netbox_librenms_plugin/filters.py index 3bc33a55b3..397140efd8 100644 --- a/netbox_librenms_plugin/filters.py +++ b/netbox_librenms_plugin/filters.py @@ -1,6 +1,6 @@ import django_filters -from .models import DeviceTypeMapping, InterfaceTypeMapping, ModuleTypeMapping +from .models import DeviceTypeMapping, InterfaceTypeMapping, ModuleBayMapping, ModuleTypeMapping class InterfaceTypeMappingFilterSet(django_filters.FilterSet): @@ -31,3 +31,13 @@ class Meta: model = ModuleTypeMapping fields = ["librenms_model", "description"] + + +class ModuleBayMappingFilterSet(django_filters.FilterSet): + """Filter set for ModuleBayMapping model.""" + + class Meta: + """Meta options for ModuleBayMappingFilterSet.""" + + model = ModuleBayMapping + fields = ["librenms_name", "librenms_class", "netbox_bay_name"] diff --git a/netbox_librenms_plugin/forms.py b/netbox_librenms_plugin/forms.py index f68c98ad3c..2bd9f7b302 100644 --- a/netbox_librenms_plugin/forms.py +++ b/netbox_librenms_plugin/forms.py @@ -15,7 +15,7 @@ from utilities.forms.fields import CSVChoiceField, DynamicModelMultipleChoiceField from virtualization.models import Cluster, VirtualMachine -from .models import DeviceTypeMapping, InterfaceTypeMapping, LibreNMSSettings, ModuleTypeMapping +from .models import DeviceTypeMapping, InterfaceTypeMapping, LibreNMSSettings, ModuleBayMapping, ModuleTypeMapping logger = logging.getLogger(__name__) @@ -351,6 +351,36 @@ class ModuleTypeMappingFilterForm(NetBoxModelFilterSetForm): model = ModuleTypeMapping +class ModuleBayMappingForm(NetBoxModelForm): + """Form for creating and editing module bay mappings between LibreNMS and NetBox.""" + + class Meta: + """Meta options for ModuleBayMappingForm.""" + + model = ModuleBayMapping + fields = ["librenms_name", "librenms_class", "netbox_bay_name", "description"] + + +class ModuleBayMappingImportForm(NetBoxModelImportForm): + """Form for bulk importing module bay mappings.""" + + class Meta: + """Meta options for ModuleBayMappingImportForm.""" + + model = ModuleBayMapping + fields = ["librenms_name", "librenms_class", "netbox_bay_name", "description"] + + +class ModuleBayMappingFilterForm(NetBoxModelFilterSetForm): + """Form for filtering module bay mappings.""" + + librenms_name = forms.CharField(required=False, label="LibreNMS Name") + librenms_class = forms.CharField(required=False, label="LibreNMS Class") + netbox_bay_name = forms.CharField(required=False, label="NetBox Bay Name") + + model = ModuleBayMapping + + class AddToLIbreSNMPV1V2(forms.Form): """ Form for adding devices to LibreNMS using SNMPv1 or SNMPv2c authentication. diff --git a/netbox_librenms_plugin/migrations/0011_modulebaymapping.py b/netbox_librenms_plugin/migrations/0011_modulebaymapping.py new file mode 100644 index 0000000000..5b3c2c3be0 --- /dev/null +++ b/netbox_librenms_plugin/migrations/0011_modulebaymapping.py @@ -0,0 +1,38 @@ +# Generated by Django 5.2.10 on 2026-02-17 12:29 + +import netbox.models.deletion +import taggit.managers +import utilities.json +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ("extras", "0134_owner"), + ("netbox_librenms_plugin", "0010_add_moduletypemapping"), + ] + + operations = [ + migrations.CreateModel( + name="ModuleBayMapping", + 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), + ), + ("librenms_name", models.CharField(max_length=255)), + ("librenms_class", models.CharField(blank=True, max_length=50)), + ("netbox_bay_name", models.CharField(max_length=255)), + ("description", models.TextField(blank=True)), + ("tags", taggit.managers.TaggableManager(through="extras.TaggedItem", to="extras.Tag")), + ], + options={ + "ordering": ["librenms_name"], + "unique_together": {("librenms_name", "librenms_class")}, + }, + bases=(netbox.models.deletion.DeleteMixin, models.Model), + ), + ] diff --git a/netbox_librenms_plugin/models.py b/netbox_librenms_plugin/models.py index 53815bb0ac..c464f2c37c 100644 --- a/netbox_librenms_plugin/models.py +++ b/netbox_librenms_plugin/models.py @@ -140,3 +140,44 @@ class Meta: def __str__(self): return f"{self.librenms_model} -> {self.netbox_module_type}" + + +class ModuleBayMapping(NetBoxModel): + """Map LibreNMS inventory names to NetBox module bay names. + + Used when LibreNMS inventory names don't match NetBox bay names exactly. + For example: LibreNMS "Power Supply 1" → NetBox "PS1". + Mappings are global (not scoped to device type or manufacturer). + """ + + librenms_name = models.CharField( + max_length=255, + help_text="Name from LibreNMS inventory (entPhysicalName), e.g. 'Power Supply 1'", + ) + librenms_class = models.CharField( + max_length=50, + blank=True, + help_text="Optional entPhysicalClass filter (e.g. 'powerSupply', 'fan', 'module')", + ) + netbox_bay_name = models.CharField( + max_length=255, + help_text="NetBox module bay name to match, e.g. 'PS1'", + ) + description = models.TextField( + blank=True, + help_text="Optional description or notes about this mapping", + ) + + def get_absolute_url(self): + """Return the URL for this mapping's detail page.""" + return reverse("plugins:netbox_librenms_plugin:modulebaymapping_detail", args=[self.pk]) + + class Meta: + """Meta options for ModuleBayMapping.""" + + unique_together = ["librenms_name", "librenms_class"] + ordering = ["librenms_name"] + + def __str__(self): + cls = f" [{self.librenms_class}]" if self.librenms_class else "" + return f"{self.librenms_name}{cls} -> {self.netbox_bay_name}" diff --git a/netbox_librenms_plugin/navigation.py b/netbox_librenms_plugin/navigation.py index f40d8f8943..aa115552a2 100644 --- a/netbox_librenms_plugin/navigation.py +++ b/netbox_librenms_plugin/navigation.py @@ -65,6 +65,23 @@ ), ), ), + PluginMenuItem( + link="plugins:netbox_librenms_plugin:modulebaymapping_list", + link_text="Module Bay Mappings", + permissions=[PERM_VIEW_PLUGIN], + buttons=( + PluginMenuButton( + link="plugins:netbox_librenms_plugin:modulebaymapping_add", + title="Add", + icon_class="mdi mdi-plus-thick", + ), + PluginMenuButton( + link="plugins:netbox_librenms_plugin:modulebaymapping_bulk_import", + title="Import", + icon_class="mdi mdi-upload", + ), + ), + ), ), ), ( diff --git a/netbox_librenms_plugin/tables/mappings.py b/netbox_librenms_plugin/tables/mappings.py index 2ab5e81f71..91e48e1624 100644 --- a/netbox_librenms_plugin/tables/mappings.py +++ b/netbox_librenms_plugin/tables/mappings.py @@ -1,7 +1,7 @@ import django_tables2 as tables from netbox.tables import NetBoxTable, columns -from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping, ModuleTypeMapping +from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping, ModuleBayMapping, ModuleTypeMapping class InterfaceTypeMappingTable(NetBoxTable): @@ -94,3 +94,35 @@ class Meta: "actions", ) attrs = {"class": "table table-hover table-headings table-striped"} + + +class ModuleBayMappingTable(NetBoxTable): + """Table for displaying ModuleBayMapping data.""" + + librenms_name = tables.Column(verbose_name="LibreNMS Name", linkify=True) + librenms_class = tables.Column(verbose_name="LibreNMS Class") + netbox_bay_name = tables.Column(verbose_name="NetBox Bay Name") + description = tables.Column(verbose_name="Description", linkify=False) + actions = columns.ActionsColumn(actions=("edit", "delete")) + + class Meta: + """Meta options for ModuleBayMappingTable.""" + + model = ModuleBayMapping + fields = ( + "id", + "librenms_name", + "librenms_class", + "netbox_bay_name", + "description", + "actions", + ) + default_columns = ( + "id", + "librenms_name", + "librenms_class", + "netbox_bay_name", + "description", + "actions", + ) + attrs = {"class": "table table-hover table-headings table-striped"} diff --git a/netbox_librenms_plugin/templates/netbox_librenms_plugin/modulebaymapping.html b/netbox_librenms_plugin/templates/netbox_librenms_plugin/modulebaymapping.html new file mode 100644 index 0000000000..5c60b628fb --- /dev/null +++ b/netbox_librenms_plugin/templates/netbox_librenms_plugin/modulebaymapping.html @@ -0,0 +1,30 @@ +{% extends 'generic/object.html' %} +{% load helpers %} +{% load plugins %} + +{% block content %} +
+
+
+ + + + + + + + + + + + + + + + + +
LibreNMS NameLibreNMS ClassNetBox Bay NameDescription
{{ object.librenms_name }}{{ object.librenms_class|default:"—" }}{{ object.netbox_bay_name }}{{ object.description|default:"—" }}
+
+
+
+{% endblock %} diff --git a/netbox_librenms_plugin/templates/netbox_librenms_plugin/modulebaymapping_list.html b/netbox_librenms_plugin/templates/netbox_librenms_plugin/modulebaymapping_list.html new file mode 100644 index 0000000000..fb87f901ec --- /dev/null +++ b/netbox_librenms_plugin/templates/netbox_librenms_plugin/modulebaymapping_list.html @@ -0,0 +1,12 @@ +{% extends 'generic/object_list.html' %} + +{% block content %} +
+

Module Bay Mapping

+

Map LibreNMS inventory container names to NetBox module bay names. + When synchronizing modules from LibreNMS, these mappings determine which + NetBox module bay a LibreNMS component should be installed into.

+

Example: Map "Linecard(slot 1)" to "Slot 1", or "Power Supply 1" to "PS1"

+
+ {{ block.super }} +{% endblock %} diff --git a/netbox_librenms_plugin/urls.py b/netbox_librenms_plugin/urls.py index f5e544ca6f..30a257342f 100644 --- a/netbox_librenms_plugin/urls.py +++ b/netbox_librenms_plugin/urls.py @@ -1,6 +1,6 @@ from django.urls import include, path -from .models import DeviceTypeMapping, InterfaceTypeMapping, ModuleTypeMapping +from .models import DeviceTypeMapping, InterfaceTypeMapping, ModuleBayMapping, ModuleTypeMapping from .views import ( AddDeviceToLibreNMSView, AssignVCSerialView, @@ -40,6 +40,14 @@ InterfaceTypeMappingView, LibreNMSImportView, LibreNMSSettingsView, + ModuleBayMappingBulkDeleteView, + ModuleBayMappingBulkImportView, + ModuleBayMappingChangeLogView, + ModuleBayMappingCreateView, + ModuleBayMappingDeleteView, + ModuleBayMappingEditView, + ModuleBayMappingListView, + ModuleBayMappingView, ModuleTypeMappingBulkDeleteView, ModuleTypeMappingBulkImportView, ModuleTypeMappingChangeLogView, @@ -447,5 +455,47 @@ ModuleTypeMappingBulkDeleteView.as_view(), name="moduletypemapping_bulk_delete", ), + # Module Bay Mapping URLs + path( + "module-bay-mappings/", + ModuleBayMappingListView.as_view(), + name="modulebaymapping_list", + ), + path( + "module-bay-mappings//", + ModuleBayMappingView.as_view(), + name="modulebaymapping", + ), + path( + "module-bay-mappings/add/", + ModuleBayMappingCreateView.as_view(), + name="modulebaymapping_add", + ), + path( + "module-bay-mappings/import/", + ModuleBayMappingBulkImportView.as_view(), + name="modulebaymapping_import", + ), + path( + "module-bay-mappings//delete/", + ModuleBayMappingDeleteView.as_view(), + name="modulebaymapping_delete", + ), + path( + "module-bay-mappings//edit/", + ModuleBayMappingEditView.as_view(), + name="modulebaymapping_edit", + ), + path( + "module-bay-mappings//changelog/", + ModuleBayMappingChangeLogView.as_view(), + name="modulebaymapping_changelog", + kwargs={"model": ModuleBayMapping}, + ), + path( + "module-bay-mappings/delete/", + ModuleBayMappingBulkDeleteView.as_view(), + name="modulebaymapping_bulk_delete", + ), path("api/", include("netbox_librenms_plugin.api.urls")), ] diff --git a/netbox_librenms_plugin/views/__init__.py b/netbox_librenms_plugin/views/__init__.py index f95eb7830b..f9eb1866b8 100644 --- a/netbox_librenms_plugin/views/__init__.py +++ b/netbox_librenms_plugin/views/__init__.py @@ -37,6 +37,14 @@ InterfaceTypeMappingEditView, InterfaceTypeMappingListView, InterfaceTypeMappingView, + ModuleBayMappingBulkDeleteView, + ModuleBayMappingBulkImportView, + ModuleBayMappingChangeLogView, + ModuleBayMappingCreateView, + ModuleBayMappingDeleteView, + ModuleBayMappingEditView, + ModuleBayMappingListView, + ModuleBayMappingView, ModuleTypeMappingBulkDeleteView, ModuleTypeMappingBulkImportView, ModuleTypeMappingChangeLogView, diff --git a/netbox_librenms_plugin/views/base/modules_view.py b/netbox_librenms_plugin/views/base/modules_view.py index e69593f9db..de69b3dbf2 100644 --- a/netbox_librenms_plugin/views/base/modules_view.py +++ b/netbox_librenms_plugin/views/base/modules_view.py @@ -1,5 +1,3 @@ -import re - from django.contrib import messages from django.core.cache import cache from django.db import transaction @@ -203,69 +201,47 @@ def _find_parent_container_name(self, item, index_map): def _match_module_bay(self, item, index_map, module_bays): """ Try to match an inventory item to a NetBox ModuleBay. - Matches by parent container name or item name. + Checks ModuleBayMapping table first, then falls back to exact parent name match. """ + from netbox_librenms_plugin.models import ModuleBayMapping + parent_name = self._find_parent_container_name(item, index_map) item_name = item.get("entPhysicalName", "") + phys_class = item.get("entPhysicalClass", "") - # Try exact match on parent container name first + # Check ModuleBayMapping table for parent container name + if parent_name: + filters = {"librenms_name": parent_name} + if phys_class: + # Try class-specific mapping first, then generic + mapping = ModuleBayMapping.objects.filter(**filters, librenms_class=phys_class).first() + if not mapping: + mapping = ModuleBayMapping.objects.filter(**filters, librenms_class="").first() + else: + mapping = ModuleBayMapping.objects.filter(**filters, librenms_class="").first() + + if mapping and mapping.netbox_bay_name in module_bays: + return module_bays[mapping.netbox_bay_name] + + # Check ModuleBayMapping table for item name + if item_name: + filters = {"librenms_name": item_name} + if phys_class: + mapping = ModuleBayMapping.objects.filter(**filters, librenms_class=phys_class).first() + if not mapping: + mapping = ModuleBayMapping.objects.filter(**filters, librenms_class="").first() + else: + mapping = ModuleBayMapping.objects.filter(**filters, librenms_class="").first() + + if mapping and mapping.netbox_bay_name in module_bays: + return module_bays[mapping.netbox_bay_name] + + # Fallback: exact match on parent container name if parent_name and parent_name in module_bays: return module_bays[parent_name] - # Try matching by item name (e.g., "Power Supply 1" → "PS1") - for bay_name, bay in module_bays.items(): - if self._names_match(item_name, bay_name, item.get("entPhysicalClass", "")): - return bay - return None - def _names_match(self, libre_name, bay_name, phys_class): - """Heuristic matching between LibreNMS inventory name and NetBox bay name.""" - if not libre_name or not bay_name: - return False - - libre_lower = libre_name.lower().strip() - bay_lower = bay_name.lower().strip() - - # Exact match - if libre_lower == bay_lower: - return True - - # Power supply: "Power Supply 1" ↔ "PS1" or "PSU1" - if phys_class == "powerSupply": - ps_match = re.search(r"(\d+)", libre_name) - bay_match = re.search(r"(\d+)", bay_name) - if ps_match and bay_match and ps_match.group(1) == bay_match.group(1): - if any(prefix in bay_lower for prefix in ("ps", "psu", "power")): - return True - - # Fan: "FanTray 1" ↔ "Fan 1" or "Fan Bay 1" - if phys_class == "fan": - fan_match = re.search(r"(\d+)", libre_name) - bay_match = re.search(r"(\d+)", bay_name) - if fan_match and bay_match and fan_match.group(1) == bay_match.group(1): - if "fan" in bay_lower: - return True - - # Slot matching: "Supervisor(slot 1)" or "Linecard(slot 3)" ↔ "Slot 1" / "Slot 3" - if phys_class == "module": - slot_match = re.search(r"slot\s*(\d+)", libre_name, re.IGNORECASE) - bay_match = re.search(r"slot\s*(\d+)", bay_name, re.IGNORECASE) - if slot_match and bay_match and slot_match.group(1) == bay_match.group(1): - return True - - # Sub-component port matching: "Converter 3/1" ↔ "X2 Port 1", - # "TenGigabitEthernet1/5" ↔ "X2 Port 5", "GigabitEthernet3/9" ↔ "X2 Port 9" - if phys_class in ("other", "port"): - slot_port = re.search(r"(\d+)/(\d+)", libre_name) - # Extract trailing number from bay name (e.g., "X2 Port 1" → 1, "SFP 3" → 3) - bay_num = re.search(r"(\d+)\s*$", bay_name) - if slot_port and bay_num and slot_port.group(2) == bay_num.group(1): - if any(kw in bay_lower for kw in ("port", "sfp", "x2", "xfp", "qsfp")): - return True - - return False - def _build_row(self, item, index_map, module_bays, module_types, depth=0): """Build a single table row from a LibreNMS inventory item.""" model_name = item.get("entPhysicalModelName", "") or "" diff --git a/netbox_librenms_plugin/views/mapping_views.py b/netbox_librenms_plugin/views/mapping_views.py index f32d387344..58a83e86ca 100644 --- a/netbox_librenms_plugin/views/mapping_views.py +++ b/netbox_librenms_plugin/views/mapping_views.py @@ -4,6 +4,7 @@ from netbox_librenms_plugin.filters import ( DeviceTypeMappingFilterSet, InterfaceTypeMappingFilterSet, + ModuleBayMappingFilterSet, ModuleTypeMappingFilterSet, ) from netbox_librenms_plugin.forms import ( @@ -13,14 +14,23 @@ InterfaceTypeMappingFilterForm, InterfaceTypeMappingForm, InterfaceTypeMappingImportForm, + ModuleBayMappingFilterForm, + ModuleBayMappingForm, + ModuleBayMappingImportForm, ModuleTypeMappingFilterForm, ModuleTypeMappingForm, ModuleTypeMappingImportForm, ) -from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping, ModuleTypeMapping +from netbox_librenms_plugin.models import ( + DeviceTypeMapping, + InterfaceTypeMapping, + ModuleBayMapping, + ModuleTypeMapping, +) from netbox_librenms_plugin.tables.mappings import ( DeviceTypeMappingTable, InterfaceTypeMappingTable, + ModuleBayMappingTable, ModuleTypeMappingTable, ) from netbox_librenms_plugin.views.mixins import LibreNMSPermissionMixin @@ -218,3 +228,63 @@ class ModuleTypeMappingChangeLogView(LibreNMSPermissionMixin, generic.ObjectChan """Provides a view for displaying the change log of a specific ModuleTypeMapping object.""" queryset = ModuleTypeMapping.objects.all() + + +# --- ModuleBayMapping views --- + + +class ModuleBayMappingListView(LibreNMSPermissionMixin, generic.ObjectListView): + """Provides a view for listing all ModuleBayMapping objects.""" + + queryset = ModuleBayMapping.objects.all() + table = ModuleBayMappingTable + filterset = ModuleBayMappingFilterSet + filterset_form = ModuleBayMappingFilterForm + template_name = "netbox_librenms_plugin/modulebaymapping_list.html" + + +class ModuleBayMappingCreateView(LibreNMSPermissionMixin, generic.ObjectEditView): + """Provides a view for creating a new ModuleBayMapping object.""" + + queryset = ModuleBayMapping.objects.all() + form = ModuleBayMappingForm + + +@register_model_view(ModuleBayMapping, "bulk_import", path="import", detail=False) +class ModuleBayMappingBulkImportView(LibreNMSPermissionMixin, generic.BulkImportView): + """Provides a view for bulk importing ModuleBayMapping objects.""" + + queryset = ModuleBayMapping.objects.all() + model_form = ModuleBayMappingImportForm + + +class ModuleBayMappingView(LibreNMSPermissionMixin, generic.ObjectView): + """Provides a view for displaying details of a specific ModuleBayMapping object.""" + + queryset = ModuleBayMapping.objects.all() + + +class ModuleBayMappingEditView(LibreNMSPermissionMixin, generic.ObjectEditView): + """Provides a view for editing a specific ModuleBayMapping object.""" + + queryset = ModuleBayMapping.objects.all() + form = ModuleBayMappingForm + + +class ModuleBayMappingDeleteView(LibreNMSPermissionMixin, generic.ObjectDeleteView): + """Provides a view for deleting a specific ModuleBayMapping object.""" + + queryset = ModuleBayMapping.objects.all() + + +class ModuleBayMappingBulkDeleteView(LibreNMSPermissionMixin, generic.BulkDeleteView): + """Provides a view for deleting multiple ModuleBayMapping objects.""" + + queryset = ModuleBayMapping.objects.all() + table = ModuleBayMappingTable + + +class ModuleBayMappingChangeLogView(LibreNMSPermissionMixin, generic.ObjectChangeLogView): + """Provides a view for displaying the change log of a specific ModuleBayMapping object.""" + + queryset = ModuleBayMapping.objects.all() From 816b9a0baeccf4172b403dfe6e666d08251c3ca1 Mon Sep 17 00:00:00 2001 From: Marcin Zieba Date: Tue, 17 Feb 2026 13:52:41 +0100 Subject: [PATCH 15/62] Add chassis inventory fallback for device type matching When LibreNMS hardware string doesn't match any NetBox device type, try chassis entity fields (entPhysicalName, entPhysicalModelName) as additional part_number/model lookups. Handles cases like MX480 where hardware='Juniper MX480 Internet Backbone Router' but chassis entPhysicalName='CHAS-BP-MX480-S' matches the device type part_number. - Add _try_chassis_device_type_match() helper in import_utils.py - Call from validate_device_for_import() when primary match fails - Show match source tooltip in import validation template --- netbox_librenms_plugin/import_utils.py | 48 +++++++++++++++++++ .../htmx/device_validation_details.html | 2 +- 2 files changed, 49 insertions(+), 1 deletion(-) diff --git a/netbox_librenms_plugin/import_utils.py b/netbox_librenms_plugin/import_utils.py index feac6e3e99..2e19b5a42b 100644 --- a/netbox_librenms_plugin/import_utils.py +++ b/netbox_librenms_plugin/import_utils.py @@ -631,6 +631,44 @@ def _apply_client_filters(devices: List[dict], filters: dict) -> List[dict]: return filtered +def _try_chassis_device_type_match(api, device_id): + """ + Attempt device type matching using chassis inventory fields. + + When the LibreNMS hardware string doesn't match any NetBox device type, + the chassis entity often contains a more standardized identifier + (e.g., entPhysicalName 'CHAS-BP-MX480-S' or entPhysicalModelName '710-017414') + that matches a DeviceType part_number or model. + + Tries entPhysicalName first (typically the chassis part number), + then entPhysicalModelName as fallback. + + Returns: + dict with matched/device_type/match_type keys, or None on failure. + """ + skip_values = {"", "-", "Unspecified", "BUILTIN", "None"} + + try: + success, inventory = api.get_inventory_filtered(device_id, ent_physical_class="chassis") + if not success or not inventory: + return None + + for item in inventory: + # Try entPhysicalName first (often the chassis part number like CHAS-BP-MX480-S) + for field in ("entPhysicalName", "entPhysicalModelName"): + value = item.get(field) or "" + if value and value not in skip_values: + chassis_match = match_librenms_hardware_to_device_type(value) + if chassis_match["matched"]: + chassis_match["match_type"] = "chassis" + chassis_match["chassis_model"] = value + return chassis_match + except Exception: + logger.debug(f"Chassis inventory fallback failed for device {device_id}", exc_info=True) + + return None + + def validate_device_for_import( libre_device: dict, import_as_vm: bool = False, @@ -971,6 +1009,16 @@ def validate_device_for_import( # 3. Validate DeviceType (required) hardware = libre_device.get("hardware", "") dt_match = match_librenms_hardware_to_device_type(hardware) + + # Chassis inventory fallback: when hardware doesn't match, + # try the chassis entPhysicalModelName as an additional lookup source + if not dt_match["matched"] and api: + device_id = libre_device.get("device_id") + if device_id: + chassis_match = _try_chassis_device_type_match(api, device_id) + if chassis_match and chassis_match["matched"]: + dt_match = chassis_match + result["device_type"] = dt_match if not dt_match["matched"]: diff --git a/netbox_librenms_plugin/templates/netbox_librenms_plugin/htmx/device_validation_details.html b/netbox_librenms_plugin/templates/netbox_librenms_plugin/htmx/device_validation_details.html index 974e8b79ec..454739c493 100644 --- a/netbox_librenms_plugin/templates/netbox_librenms_plugin/htmx/device_validation_details.html +++ b/netbox_librenms_plugin/templates/netbox_librenms_plugin/htmx/device_validation_details.html @@ -177,7 +177,7 @@
Device Information
{% endif %} {% elif validation.device_type.device_type %} - {{ validation.device_type.device_type }} + {{ validation.device_type.device_type }} {% else %} No matching type {% endif %} From 2c7d8996e0a2b63cc352d2a8f655afb92310f0db Mon Sep 17 00:00:00 2001 From: Marcin Zieba Date: Tue, 17 Feb 2026 13:56:54 +0100 Subject: [PATCH 16/62] Add {module_path} compatibility guard for module installation Module types with interface templates using {module_path} (e.g., GLC-T, GLC-TE, X2-10GB-SR) cannot be installed on NetBox < 4.9.0 as the token would create interfaces with literal '{module_path}' names. - Add supports_module_path() and module_type_uses_module_path() utilities - Show 'Requires Upgrade' warning badge in modules table - Block install with error message when module_path unsupported - Install button hidden for affected module types --- netbox_librenms_plugin/tables/modules.py | 3 ++ netbox_librenms_plugin/utils.py | 24 +++++++++++++ .../views/base/modules_view.py | 36 +++++++++++++++++-- 3 files changed, 60 insertions(+), 3 deletions(-) diff --git a/netbox_librenms_plugin/tables/modules.py b/netbox_librenms_plugin/tables/modules.py index abc5aac1e7..1f149b90b2 100644 --- a/netbox_librenms_plugin/tables/modules.py +++ b/netbox_librenms_plugin/tables/modules.py @@ -109,8 +109,11 @@ def render_status(self, value, record): "No Type": "bg-warning", "Unmatched": "bg-secondary", "Serial Mismatch": "bg-danger", + "Requires Upgrade": "bg-warning", } badge_class = badge_classes.get(value, "bg-secondary") + if warning := record.get("module_path_warning"): + return format_html('{}', badge_class, warning, value) return format_html('{}', badge_class, value) def render_actions(self, value, record): diff --git a/netbox_librenms_plugin/utils.py b/netbox_librenms_plugin/utils.py index 7cefd2535b..2f196e6a9d 100644 --- a/netbox_librenms_plugin/utils.py +++ b/netbox_librenms_plugin/utils.py @@ -462,3 +462,27 @@ def check_vlan_group_matches( netbox_gid = netbox_tagged_group_ids.get(vid) return netbox_gid == selected_group_id return True + + +# Minimum NetBox version that supports {module_path} token in module templates +MODULE_PATH_MIN_VERSION = "4.9.0" + + +def supports_module_path(): + """Check if the running NetBox version supports the {module_path} template token.""" + from django.conf import settings + + version_str = getattr(settings, "VERSION", "0.0.0") + # Strip Docker/suffix info (e.g., "4.5.2-Docker-4.0.0" → "4.5.2") + version_str = version_str.split("-")[0] + try: + current = tuple(int(x) for x in version_str.split(".")) + required = tuple(int(x) for x in MODULE_PATH_MIN_VERSION.split(".")) + return current >= required + except (ValueError, TypeError): + return False + + +def module_type_uses_module_path(module_type): + """Check if a ModuleType has any interface templates using {module_path}.""" + return any("{module_path}" in t.name for t in module_type.interfacetemplates.all()) diff --git a/netbox_librenms_plugin/views/base/modules_view.py b/netbox_librenms_plugin/views/base/modules_view.py index de69b3dbf2..3391e01aa7 100644 --- a/netbox_librenms_plugin/views/base/modules_view.py +++ b/netbox_librenms_plugin/views/base/modules_view.py @@ -244,6 +244,8 @@ def _match_module_bay(self, item, index_map, module_bays): def _build_row(self, item, index_map, module_bays, module_types, depth=0): """Build a single table row from a LibreNMS inventory item.""" + from netbox_librenms_plugin.utils import module_type_uses_module_path, supports_module_path + model_name = item.get("entPhysicalModelName", "") or "" serial = item.get("entPhysicalSerialNum", "") or "" phys_class = item.get("entPhysicalClass", "") @@ -256,8 +258,12 @@ def _build_row(self, item, index_map, module_bays, module_types, depth=0): # Match to NetBox module type matched_type = module_types.get(model_name) if model_name else None + # Check {module_path} compatibility + needs_module_path = matched_type and module_type_uses_module_path(matched_type) + module_path_blocked = needs_module_path and not supports_module_path() + # Determine status - status = self._determine_status(matched_bay, matched_type, serial) + status = self._determine_status(matched_bay, matched_type, serial, module_path_blocked) row = { "name": name, @@ -275,6 +281,12 @@ def _build_row(self, item, index_map, module_bays, module_types, depth=0): "depth": depth, } + if module_path_blocked: + from netbox_librenms_plugin.utils import MODULE_PATH_MIN_VERSION + + row["row_class"] = "table-warning" + row["module_path_warning"] = f"Requires NetBox ≥ {MODULE_PATH_MIN_VERSION}" + # Add URLs for matched objects if matched_bay: row["module_bay_url"] = matched_bay.get_absolute_url() @@ -294,7 +306,7 @@ def _build_row(self, item, index_map, module_bays, module_types, depth=0): status = "Installed" row["row_class"] = "table-success" row["status"] = status - elif matched_type: + elif matched_type and not module_path_blocked: # Bay exists, type matched, no module installed → can install row["can_install"] = True @@ -303,8 +315,10 @@ def _build_row(self, item, index_map, module_bays, module_types, depth=0): return row - def _determine_status(self, matched_bay, matched_type, serial): + def _determine_status(self, matched_bay, matched_type, serial, module_path_blocked=False): """Determine the sync status for an inventory item.""" + if module_path_blocked: + return "Requires Upgrade" if matched_bay and matched_type: return "Matched" if not matched_bay: @@ -337,6 +351,22 @@ def post(self, request, pk): module_bay = get_object_or_404(ModuleBay, pk=module_bay_id, device=device) module_type = get_object_or_404(ModuleType, pk=module_type_id) + # Block install if module type uses {module_path} and NetBox doesn't support it + from netbox_librenms_plugin.utils import ( + MODULE_PATH_MIN_VERSION, + module_type_uses_module_path, + supports_module_path, + ) + + if module_type_uses_module_path(module_type) and not supports_module_path(): + messages.error( + request, + f"Cannot install {module_type.model}: its interface templates use " + f"{{module_path}} which requires NetBox ≥ {MODULE_PATH_MIN_VERSION}.", + ) + sync_url = reverse("plugins:netbox_librenms_plugin:device_librenms_sync", kwargs={"pk": pk}) + return redirect(f"{sync_url}?tab=modules") + # Check if bay already has a module installed if hasattr(module_bay, "installed_module") and module_bay.installed_module: messages.warning(request, f"Module bay '{module_bay.name}' already has a module installed.") From 56b1e4fdc1d92865dc172175ab792200c30a2375 Mon Sep 17 00:00:00 2001 From: Marcin Zieba Date: Tue, 17 Feb 2026 14:31:37 +0100 Subject: [PATCH 17/62] Add nested module branch installation and fix URL naming MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Phase 8: Nested module installation with tree-walk. - InstallBranchView: walks inventory tree depth-first, installs parent first then children into newly-created child bays, applies InterfaceNameRule at each level - 'Install Branch' button on parent items with installable children - Fix URL naming: modulebaymapping_import → modulebaymapping_bulk_import, interfacenamerule_import → interfacenamerule_bulk_import (match convention) - Track entPhysicalIndex and has_installable_children in table row data --- contrib/interface_name_rules.yaml | 59 ++++ netbox_librenms_plugin/api/serializers.py | 26 +- netbox_librenms_plugin/api/urls.py | 1 + netbox_librenms_plugin/api/views.py | 18 +- netbox_librenms_plugin/filters.py | 12 +- netbox_librenms_plugin/forms.py | 52 ++- .../migrations/0012_interfacenamerule.py | 58 ++++ netbox_librenms_plugin/models.py | 62 ++++ netbox_librenms_plugin/navigation.py | 17 + netbox_librenms_plugin/tables/mappings.py | 45 ++- netbox_librenms_plugin/tables/modules.py | 63 +++- .../interfacenamerule.html | 40 +++ .../interfacenamerule_list.html | 13 + netbox_librenms_plugin/urls.py | 60 +++- netbox_librenms_plugin/utils.py | 63 ++++ netbox_librenms_plugin/views/__init__.py | 10 +- .../views/base/modules_view.py | 327 +++++++++++++++++- netbox_librenms_plugin/views/mapping_views.py | 66 ++++ 18 files changed, 965 insertions(+), 27 deletions(-) create mode 100644 contrib/interface_name_rules.yaml create mode 100644 netbox_librenms_plugin/migrations/0012_interfacenamerule.py create mode 100644 netbox_librenms_plugin/templates/netbox_librenms_plugin/interfacenamerule.html create mode 100644 netbox_librenms_plugin/templates/netbox_librenms_plugin/interfacenamerule_list.html diff --git a/contrib/interface_name_rules.yaml b/contrib/interface_name_rules.yaml new file mode 100644 index 0000000000..72d9d98c13 --- /dev/null +++ b/contrib/interface_name_rules.yaml @@ -0,0 +1,59 @@ +# Interface Name Rules +# +# Post-install interface rename rules for module types where NetBox's +# position-based naming can't produce the correct interface name. +# +# Covers two scenarios: +# 1. Converter offset — e.g., GLC-T inside CVR-X2-SFP needs port numbering +# that accounts for the converter's position in the parent module bay. +# 2. Breakout channels — e.g., QSFP+ 4x10G produces multiple sub-interfaces +# from a single physical port. +# +# Template variables: +# {slot} — Top-level slot/module bay position +# {bay_position} — Position of the bay this module is installed into +# {parent_bay_position} — Position of the parent module's bay +# {sfp_slot} — Sub-bay index within the parent module +# {base} — Original interface name from NetBox template +# {channel} — Breakout channel number (iterated) +# +# Arithmetic expressions are supported inside braces: +# {8 + ({parent_bay_position} - 1) * 2 + {sfp_slot}} +# +# Bulk import via: LibreNMS Plugin > Settings > Interface Name Rules > Import + +# --- Converter Offset Examples --- + +# GLC-T (1G copper SFP) installed in CVR-X2-SFP converter +# X2 bays are numbered 1-N; each converter holds 2 SFP slots +# Resulting interface: GigabitEthernet/ +- module_type: GLC-T + parent_module_type: CVR-X2-SFP + name_template: "GigabitEthernet{slot}/{8 + ({parent_bay_position} - 1) * 2 + {sfp_slot}}" + channel_count: 0 + channel_start: 0 + description: "GLC-T in CVR-X2-SFP: offset port numbering for X2-to-SFP conversion" + +# GLC-TE (1G copper SFP enhanced) in CVR-X2-SFP +- module_type: GLC-TE + parent_module_type: CVR-X2-SFP + name_template: "GigabitEthernet{slot}/{8 + ({parent_bay_position} - 1) * 2 + {sfp_slot}}" + channel_count: 0 + channel_start: 0 + description: "GLC-TE in CVR-X2-SFP: same offset as GLC-T" + +# --- Breakout Channel Examples --- + +# QSFP+ 4x10G breakout — Juniper-style (channels start at 0) +- module_type: QSFP+-4X10G-LR + name_template: "{base}:{channel}" + channel_count: 4 + channel_start: 0 + description: "QSFP+ 4x10G breakout with Juniper-style channel numbering (0-3)" + +# QSFP+ 4x10G breakout — Cisco-style (channels start at 1) +# - module_type: QSFP+-4X10G-LR +# name_template: "{base}:{channel}" +# channel_count: 4 +# channel_start: 1 +# description: "QSFP+ 4x10G breakout with Cisco-style channel numbering (1-4)" diff --git a/netbox_librenms_plugin/api/serializers.py b/netbox_librenms_plugin/api/serializers.py index b5d44b7788..211f337df8 100644 --- a/netbox_librenms_plugin/api/serializers.py +++ b/netbox_librenms_plugin/api/serializers.py @@ -1,6 +1,12 @@ from netbox.api.serializers import NetBoxModelSerializer -from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping, ModuleBayMapping, ModuleTypeMapping +from netbox_librenms_plugin.models import ( + DeviceTypeMapping, + InterfaceNameRule, + InterfaceTypeMapping, + ModuleBayMapping, + ModuleTypeMapping, +) class InterfaceTypeMappingSerializer(NetBoxModelSerializer): @@ -41,3 +47,21 @@ class Meta: model = ModuleBayMapping fields = ["id", "librenms_name", "librenms_class", "netbox_bay_name", "description"] + + +class InterfaceNameRuleSerializer(NetBoxModelSerializer): + """Serialize InterfaceNameRule model for REST API.""" + + class Meta: + """Meta options for InterfaceNameRuleSerializer.""" + + model = InterfaceNameRule + fields = [ + "id", + "module_type", + "parent_module_type", + "name_template", + "channel_count", + "channel_start", + "description", + ] diff --git a/netbox_librenms_plugin/api/urls.py b/netbox_librenms_plugin/api/urls.py index 2c60ad6f1d..fdfafdc518 100644 --- a/netbox_librenms_plugin/api/urls.py +++ b/netbox_librenms_plugin/api/urls.py @@ -10,6 +10,7 @@ router.register("device-type-mappings", views.DeviceTypeMappingViewSet) router.register("module-type-mappings", views.ModuleTypeMappingViewSet) router.register("module-bay-mappings", views.ModuleBayMappingViewSet) +router.register("interface-name-rules", views.InterfaceNameRuleViewSet) urlpatterns = [ path("jobs//sync-status/", views.sync_job_status, name="sync_job_status"), diff --git a/netbox_librenms_plugin/api/views.py b/netbox_librenms_plugin/api/views.py index efe90ad1e5..80f9bf65f1 100644 --- a/netbox_librenms_plugin/api/views.py +++ b/netbox_librenms_plugin/api/views.py @@ -11,10 +11,17 @@ from rq.job import Job as RQJob from netbox_librenms_plugin.constants import PERM_CHANGE_PLUGIN, PERM_VIEW_PLUGIN -from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping, ModuleBayMapping, ModuleTypeMapping +from netbox_librenms_plugin.models import ( + DeviceTypeMapping, + InterfaceNameRule, + InterfaceTypeMapping, + ModuleBayMapping, + ModuleTypeMapping, +) from .serializers import ( DeviceTypeMappingSerializer, + InterfaceNameRuleSerializer, InterfaceTypeMappingSerializer, ModuleBayMappingSerializer, ModuleTypeMappingSerializer, @@ -73,6 +80,15 @@ class ModuleBayMappingViewSet(NetBoxModelViewSet): serializer_class = ModuleBayMappingSerializer +class InterfaceNameRuleViewSet(NetBoxModelViewSet): + """API viewset for InterfaceNameRule CRUD operations.""" + + permission_classes = [LibreNMSPluginPermission] + + queryset = InterfaceNameRule.objects.all() + serializer_class = InterfaceNameRuleSerializer + + @api_view(["POST"]) @permission_classes([LibreNMSPluginPermission]) def sync_job_status(request, job_pk): diff --git a/netbox_librenms_plugin/filters.py b/netbox_librenms_plugin/filters.py index 397140efd8..62e4d82a8b 100644 --- a/netbox_librenms_plugin/filters.py +++ b/netbox_librenms_plugin/filters.py @@ -1,6 +1,6 @@ import django_filters -from .models import DeviceTypeMapping, InterfaceTypeMapping, ModuleBayMapping, ModuleTypeMapping +from .models import DeviceTypeMapping, InterfaceNameRule, InterfaceTypeMapping, ModuleBayMapping, ModuleTypeMapping class InterfaceTypeMappingFilterSet(django_filters.FilterSet): @@ -41,3 +41,13 @@ class Meta: model = ModuleBayMapping fields = ["librenms_name", "librenms_class", "netbox_bay_name"] + + +class InterfaceNameRuleFilterSet(django_filters.FilterSet): + """Filter set for InterfaceNameRule model.""" + + class Meta: + """Meta options for InterfaceNameRuleFilterSet.""" + + model = InterfaceNameRule + fields = ["module_type", "parent_module_type"] diff --git a/netbox_librenms_plugin/forms.py b/netbox_librenms_plugin/forms.py index 2bd9f7b302..5d686012ea 100644 --- a/netbox_librenms_plugin/forms.py +++ b/netbox_librenms_plugin/forms.py @@ -15,7 +15,14 @@ from utilities.forms.fields import CSVChoiceField, DynamicModelMultipleChoiceField from virtualization.models import Cluster, VirtualMachine -from .models import DeviceTypeMapping, InterfaceTypeMapping, LibreNMSSettings, ModuleBayMapping, ModuleTypeMapping +from .models import ( + DeviceTypeMapping, + InterfaceNameRule, + InterfaceTypeMapping, + LibreNMSSettings, + ModuleBayMapping, + ModuleTypeMapping, +) logger = logging.getLogger(__name__) @@ -381,6 +388,49 @@ class ModuleBayMappingFilterForm(NetBoxModelFilterSetForm): model = ModuleBayMapping +class InterfaceNameRuleForm(NetBoxModelForm): + """Form for creating and editing interface name rules.""" + + class Meta: + """Meta options for InterfaceNameRuleForm.""" + + model = InterfaceNameRule + fields = [ + "module_type", + "parent_module_type", + "name_template", + "channel_count", + "channel_start", + "description", + ] + + +class InterfaceNameRuleImportForm(NetBoxModelImportForm): + """Form for bulk importing interface name rules.""" + + class Meta: + """Meta options for InterfaceNameRuleImportForm.""" + + model = InterfaceNameRule + fields = [ + "module_type", + "parent_module_type", + "name_template", + "channel_count", + "channel_start", + "description", + ] + + +class InterfaceNameRuleFilterForm(NetBoxModelFilterSetForm): + """Form for filtering interface name rules.""" + + module_type_id = forms.IntegerField(required=False, label="Module Type ID") + parent_module_type_id = forms.IntegerField(required=False, label="Parent Module Type ID") + + model = InterfaceNameRule + + class AddToLIbreSNMPV1V2(forms.Form): """ Form for adding devices to LibreNMS using SNMPv1 or SNMPv2c authentication. diff --git a/netbox_librenms_plugin/migrations/0012_interfacenamerule.py b/netbox_librenms_plugin/migrations/0012_interfacenamerule.py new file mode 100644 index 0000000000..876e70726d --- /dev/null +++ b/netbox_librenms_plugin/migrations/0012_interfacenamerule.py @@ -0,0 +1,58 @@ +# Generated by Django 5.2.10 on 2026-02-17 13:01 + +import django.db.models.deletion +import netbox.models.deletion +import taggit.managers +import utilities.json +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ("dcim", "0225_gfk_indexes"), + ("extras", "0134_owner"), + ("netbox_librenms_plugin", "0011_modulebaymapping"), + ] + + operations = [ + migrations.CreateModel( + name="InterfaceNameRule", + 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_template", models.CharField(max_length=255)), + ("channel_count", models.PositiveSmallIntegerField(default=0)), + ("channel_start", models.PositiveSmallIntegerField(default=0)), + ("description", models.TextField(blank=True)), + ( + "module_type", + models.ForeignKey( + on_delete=django.db.models.deletion.CASCADE, + related_name="interface_name_rules", + to="dcim.moduletype", + ), + ), + ( + "parent_module_type", + models.ForeignKey( + blank=True, + null=True, + on_delete=django.db.models.deletion.CASCADE, + related_name="child_interface_name_rules", + to="dcim.moduletype", + ), + ), + ("tags", taggit.managers.TaggableManager(through="extras.TaggedItem", to="extras.Tag")), + ], + options={ + "ordering": ["module_type__model"], + "unique_together": {("module_type", "parent_module_type")}, + }, + bases=(netbox.models.deletion.DeleteMixin, models.Model), + ), + ] diff --git a/netbox_librenms_plugin/models.py b/netbox_librenms_plugin/models.py index c464f2c37c..f6f9d443f0 100644 --- a/netbox_librenms_plugin/models.py +++ b/netbox_librenms_plugin/models.py @@ -181,3 +181,65 @@ class Meta: def __str__(self): cls = f" [{self.librenms_class}]" if self.librenms_class else "" return f"{self.librenms_name}{cls} -> {self.netbox_bay_name}" + + +class InterfaceNameRule(NetBoxModel): + """Post-install interface rename rule for module types. + + Handles cases where NetBox's position-based naming can't produce + the correct interface name, such as converter offset (CVR-X2-SFP) + or breakout transceivers (QSFP+ 4x10G). + + The name_template uses Python str.format() syntax with these variables: + {slot} - Slot number from parent module bay position + {bay_position} - Position of the bay this module is installed into + {parent_bay_position} - Position of the parent module's bay + {sfp_slot} - Sub-bay index (1-based) within the parent module + {base} - Base interface name from NetBox position resolution + {channel} - Channel number (iterated for breakout) + """ + + module_type = models.ForeignKey( + ModuleType, + on_delete=models.CASCADE, + related_name="interface_name_rules", + help_text="The module type whose installation triggers this rename rule", + ) + parent_module_type = models.ForeignKey( + ModuleType, + on_delete=models.CASCADE, + null=True, + blank=True, + related_name="child_interface_name_rules", + help_text="If set, rule only applies when installed inside this parent module type", + ) + name_template = models.CharField( + max_length=255, + help_text="Interface name template expression, e.g. 'GigabitEthernet{slot}/{8 + ({parent_bay_position} - 1) * 2 + {sfp_slot}}'", + ) + channel_count = models.PositiveSmallIntegerField( + default=0, + help_text="Number of breakout channels (0 = no breakout). Creates this many interfaces per template.", + ) + channel_start = models.PositiveSmallIntegerField( + default=0, + help_text="Starting channel number for breakout interfaces (e.g., 0 for Juniper, 1 for Cisco)", + ) + description = models.TextField( + blank=True, + help_text="Optional description or notes about this rule", + ) + + def get_absolute_url(self): + """Return the URL for this rule's detail page.""" + return reverse("plugins:netbox_librenms_plugin:interfacenamerule_detail", args=[self.pk]) + + class Meta: + """Meta options for InterfaceNameRule.""" + + unique_together = ["module_type", "parent_module_type"] + ordering = ["module_type__model"] + + def __str__(self): + parent = f" in {self.parent_module_type.model}" if self.parent_module_type else "" + return f"{self.module_type.model}{parent} → {self.name_template}" diff --git a/netbox_librenms_plugin/navigation.py b/netbox_librenms_plugin/navigation.py index aa115552a2..a97732d72c 100644 --- a/netbox_librenms_plugin/navigation.py +++ b/netbox_librenms_plugin/navigation.py @@ -82,6 +82,23 @@ ), ), ), + PluginMenuItem( + link="plugins:netbox_librenms_plugin:interfacenamerule_list", + link_text="Interface Name Rules", + permissions=[PERM_VIEW_PLUGIN], + buttons=( + PluginMenuButton( + link="plugins:netbox_librenms_plugin:interfacenamerule_add", + title="Add", + icon_class="mdi mdi-plus-thick", + ), + PluginMenuButton( + link="plugins:netbox_librenms_plugin:interfacenamerule_bulk_import", + title="Import", + icon_class="mdi mdi-upload", + ), + ), + ), ), ), ( diff --git a/netbox_librenms_plugin/tables/mappings.py b/netbox_librenms_plugin/tables/mappings.py index 91e48e1624..cc28f3c944 100644 --- a/netbox_librenms_plugin/tables/mappings.py +++ b/netbox_librenms_plugin/tables/mappings.py @@ -1,7 +1,13 @@ import django_tables2 as tables from netbox.tables import NetBoxTable, columns -from netbox_librenms_plugin.models import DeviceTypeMapping, InterfaceTypeMapping, ModuleBayMapping, ModuleTypeMapping +from netbox_librenms_plugin.models import ( + DeviceTypeMapping, + InterfaceNameRule, + InterfaceTypeMapping, + ModuleBayMapping, + ModuleTypeMapping, +) class InterfaceTypeMappingTable(NetBoxTable): @@ -126,3 +132,40 @@ class Meta: "actions", ) attrs = {"class": "table table-hover table-headings table-striped"} + + +class InterfaceNameRuleTable(NetBoxTable): + """Table for displaying InterfaceNameRule data.""" + + module_type = tables.Column(verbose_name="Module Type", linkify=True) + parent_module_type = tables.Column(verbose_name="Parent Module Type", linkify=True) + name_template = tables.Column(verbose_name="Name Template") + channel_count = tables.Column(verbose_name="Channels") + channel_start = tables.Column(verbose_name="Ch. Start") + description = tables.Column(verbose_name="Description", linkify=False) + actions = columns.ActionsColumn(actions=("edit", "delete")) + + class Meta: + """Meta options for InterfaceNameRuleTable.""" + + model = InterfaceNameRule + fields = ( + "id", + "module_type", + "parent_module_type", + "name_template", + "channel_count", + "channel_start", + "description", + "actions", + ) + default_columns = ( + "id", + "module_type", + "parent_module_type", + "name_template", + "channel_count", + "description", + "actions", + ) + attrs = {"class": "table table-hover table-headings table-striped"} diff --git a/netbox_librenms_plugin/tables/modules.py b/netbox_librenms_plugin/tables/modules.py index 1f149b90b2..ee065578e9 100644 --- a/netbox_librenms_plugin/tables/modules.py +++ b/netbox_librenms_plugin/tables/modules.py @@ -117,22 +117,49 @@ def render_status(self, value, record): return format_html('{}', badge_class, value) def render_actions(self, value, record): - """Render install button for matched modules.""" - if not record.get("can_install") or not self.device: + """Render install button for matched modules and install branch for parents.""" + if not self.device: return "" - url = reverse("plugins:netbox_librenms_plugin:install_module", kwargs={"pk": self.device.pk}) - return format_html( - '
' - '' - '' - '' - '' - '
", - url, - self.csrf_token, - record.get("module_bay_id", ""), - record.get("module_type_id", ""), - record.get("serial", ""), - ) + + buttons = [] + + # Single install button + if record.get("can_install"): + url = reverse("plugins:netbox_librenms_plugin:install_module", kwargs={"pk": self.device.pk}) + buttons.append( + format_html( + '
' + '' + '' + '' + '' + '
", + url, + self.csrf_token, + record.get("module_bay_id", ""), + record.get("module_type_id", ""), + record.get("serial", ""), + ) + ) + + # Install branch button for parents with installable children + if record.get("has_installable_children") and record.get("ent_physical_index"): + url = reverse("plugins:netbox_librenms_plugin:install_branch", kwargs={"pk": self.device.pk}) + buttons.append( + format_html( + '
' + '' + '' + '
", + url, + self.csrf_token, + record.get("ent_physical_index", ""), + ) + ) + + return format_html("{}", format_html("".join(str(b) for b in buttons))) if buttons else "" diff --git a/netbox_librenms_plugin/templates/netbox_librenms_plugin/interfacenamerule.html b/netbox_librenms_plugin/templates/netbox_librenms_plugin/interfacenamerule.html new file mode 100644 index 0000000000..7be55cd2ed --- /dev/null +++ b/netbox_librenms_plugin/templates/netbox_librenms_plugin/interfacenamerule.html @@ -0,0 +1,40 @@ +{% extends 'generic/object.html' %} +{% load helpers %} +{% load plugins %} + +{% block content %} +
+
+
+ + + + + + + + + + + + + + + + + + + + + +
Module TypeParent Module TypeName TemplateChannelsChannel StartDescription
{{ object.module_type }} + {% if object.parent_module_type %} + {{ object.parent_module_type }} + {% else %} + Any parent + {% endif %} + {{ object.name_template }}{{ object.channel_count|default:"—" }}{{ object.channel_start }}{{ object.description|default:"—" }}
+
+
+
+{% endblock %} diff --git a/netbox_librenms_plugin/templates/netbox_librenms_plugin/interfacenamerule_list.html b/netbox_librenms_plugin/templates/netbox_librenms_plugin/interfacenamerule_list.html new file mode 100644 index 0000000000..ca11bde0ec --- /dev/null +++ b/netbox_librenms_plugin/templates/netbox_librenms_plugin/interfacenamerule_list.html @@ -0,0 +1,13 @@ +{% extends 'generic/object_list.html' %} + +{% block content %} +
+

Interface Name Rules

+

Define post-install interface rename rules for module types where NetBox's + position-based naming can't produce the correct interface name.

+

Covers converter offset (e.g., CVR-X2-SFP + GLC-T) and breakout transceivers + (e.g., QSFP+ 4x10G with channel numbering).

+

Example: GLC-T in CVR-X2-SFP → GigabitEthernet{slot}/{8 + ({parent_bay_position} - 1) * 2 + {sfp_slot}}

+
+ {{ block.super }} +{% endblock %} diff --git a/netbox_librenms_plugin/urls.py b/netbox_librenms_plugin/urls.py index 30a257342f..b9fa91e107 100644 --- a/netbox_librenms_plugin/urls.py +++ b/netbox_librenms_plugin/urls.py @@ -1,6 +1,6 @@ from django.urls import include, path -from .models import DeviceTypeMapping, InterfaceTypeMapping, ModuleBayMapping, ModuleTypeMapping +from .models import DeviceTypeMapping, InterfaceNameRule, InterfaceTypeMapping, ModuleBayMapping, ModuleTypeMapping from .views import ( AddDeviceToLibreNMSView, AssignVCSerialView, @@ -29,7 +29,16 @@ DeviceValidationDetailsView, DeviceVCDetailsView, DeviceVLANTableView, + InstallBranchView, InstallModuleView, + InterfaceNameRuleBulkDeleteView, + InterfaceNameRuleBulkImportView, + InterfaceNameRuleChangeLogView, + InterfaceNameRuleCreateView, + InterfaceNameRuleDeleteView, + InterfaceNameRuleEditView, + InterfaceNameRuleListView, + InterfaceNameRuleView, InterfaceTypeMappingBulkDeleteView, InterfaceTypeMappingBulkImportView, InterfaceTypeMappingChangeLogView, @@ -107,6 +116,11 @@ InstallModuleView.as_view(), name="install_module", ), + path( + "devices//install-branch/", + InstallBranchView.as_view(), + name="install_branch", + ), path( "devices//ipaddress-sync/", DeviceIPAddressTableView.as_view(), @@ -474,7 +488,7 @@ path( "module-bay-mappings/import/", ModuleBayMappingBulkImportView.as_view(), - name="modulebaymapping_import", + name="modulebaymapping_bulk_import", ), path( "module-bay-mappings//delete/", @@ -497,5 +511,47 @@ ModuleBayMappingBulkDeleteView.as_view(), name="modulebaymapping_bulk_delete", ), + # Interface Name Rule URLs + path( + "interface-name-rules/", + InterfaceNameRuleListView.as_view(), + name="interfacenamerule_list", + ), + path( + "interface-name-rules//", + InterfaceNameRuleView.as_view(), + name="interfacenamerule", + ), + path( + "interface-name-rules/add/", + InterfaceNameRuleCreateView.as_view(), + name="interfacenamerule_add", + ), + path( + "interface-name-rules/import/", + InterfaceNameRuleBulkImportView.as_view(), + name="interfacenamerule_bulk_import", + ), + path( + "interface-name-rules//delete/", + InterfaceNameRuleDeleteView.as_view(), + name="interfacenamerule_delete", + ), + path( + "interface-name-rules//edit/", + InterfaceNameRuleEditView.as_view(), + name="interfacenamerule_edit", + ), + path( + "interface-name-rules//changelog/", + InterfaceNameRuleChangeLogView.as_view(), + name="interfacenamerule_changelog", + kwargs={"model": InterfaceNameRule}, + ), + path( + "interface-name-rules/delete/", + InterfaceNameRuleBulkDeleteView.as_view(), + name="interfacenamerule_bulk_delete", + ), path("api/", include("netbox_librenms_plugin.api.urls")), ] diff --git a/netbox_librenms_plugin/utils.py b/netbox_librenms_plugin/utils.py index 2f196e6a9d..1464e936a7 100644 --- a/netbox_librenms_plugin/utils.py +++ b/netbox_librenms_plugin/utils.py @@ -1,3 +1,4 @@ +import ast import re from typing import Optional @@ -486,3 +487,65 @@ def supports_module_path(): def module_type_uses_module_path(module_type): """Check if a ModuleType has any interface templates using {module_path}.""" return any("{module_path}" in t.name for t in module_type.interfacetemplates.all()) + + +def evaluate_name_template(template: str, variables: dict) -> str: + """Evaluate a name template with arithmetic expressions. + + Supports templates like: + "GigabitEthernet{slot}/{8 + ({parent_bay_position} - 1) * 2 + {sfp_slot}}" + + Variables are substituted first, then any brace-enclosed expression + containing arithmetic operators is safely evaluated via ast.literal_eval + after reducing the expression. + + Args: + template: The name template string with {variable} placeholders. + variables: Dict mapping variable names to their values. + + Returns: + The evaluated interface name string. + + Raises: + ValueError: If an expression cannot be safely evaluated. + """ + # First pass: substitute all simple variables + result = template + for key, value in variables.items(): + result = result.replace(f"{{{key}}}", str(value)) + + # Second pass: evaluate any remaining brace-enclosed arithmetic expressions + def _eval_expr(match): + expr = match.group(1).strip() + # Only allow digits, arithmetic operators, parentheses, and whitespace + if not re.match(r"^[\d\s\+\-\*\/\(\)]+$", expr): + raise ValueError(f"Unsafe expression in name template: {expr}") + try: + # Compile and evaluate safely using AST + node = ast.parse(expr, mode="eval") + # Walk AST to verify only safe node types + for child in ast.walk(node): + if not isinstance( + child, + ( + ast.Expression, + ast.BinOp, + ast.UnaryOp, + ast.Constant, + ast.Add, + ast.Sub, + ast.Mult, + ast.Div, + ast.FloorDiv, + ast.Mod, + ast.USub, + ast.UAdd, + ), + ): + raise ValueError(f"Unsafe AST node in expression: {type(child).__name__}") + return str(eval(compile(node, "