Inventory

.devcontainer/README.md

@@ -98,6 +98,8 @@ Below are the dev container defaults. The field name to change these defaults is
 - Plugin loader: enabled; reads `.devcontainer/config/plugin-config.py` if present
 - If `plugin-config.py` is missing: plugin is enabled with empty config (features won’t work until configured)
 
+
+
 ## 🔧 Configuration
 
 ### NetBox Version and Environment (use .devcontainer/.env)

.devcontainer/scripts/diagnose.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+# netbox-librenms-plugin devcontainer script
 
 echo "🔍 DevContainer Startup Diagnostics"
 echo "=================================="

.devcontainer/scripts/load-aliases.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+# netbox-librenms-plugin devcontainer script
 # Quick alias loader for current session
 # Usage: source .devcontainer/scripts/load-aliases.sh
 

.devcontainer/scripts/setup.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+# netbox-librenms-plugin devcontainer script
 set -e
 
 echo "🚀 Setting up NetBox LibreNMS Plugin development environment..."

.devcontainer/scripts/start-netbox.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+# netbox-librenms-plugin devcontainer script
 
 # Check if we should run in background or foreground
 BACKGROUND=false
@@ -18,7 +19,6 @@ if [ "$CODESPACES" = "true" ] && [ -n "$CODESPACE_NAME" ]; then
   echo "🔗 GitHub Codespaces detected"
 else
   ACCESS_URL="http://localhost:8000"
-  echo "🐛 Debug: ACCESS_URL is set to: $ACCESS_URL"
 fi
 
 # Load shared process management helpers

.devcontainer/scripts/welcome.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+# netbox-librenms-plugin devcontainer script
 
 # Ensure aliases are available in the postAttach terminal session
 source "$(dirname "$0")/load-aliases.sh" 2>/dev/null
@@ -44,7 +45,7 @@ if [ -n "$CODESPACES" ]; then
   echo "   💡 Click the link in the Ports panel or look for the 'Open in Browser' button"
 else
   echo "🖥️  Local Development Environment:"
-  echo "   NetBox will be available at: http://localhost:8000 (paste into you browser)"
+  echo "   NetBox will be available at: http://localhost:8000 (paste into your browser)"
 fi
 
 echo ""

.github/workflows/lint-format.yaml

@@ -2,13 +2,7 @@ name: Lint and Format
 
 on:
   push:
-    branches:
-      - master
-      - develop
   pull_request:
-    branches:
-      - master
-      - develop
 
 jobs:
   format-and-lint:
@@ -20,31 +14,15 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
         with:
-          python-version: '3.9'
-          cache: 'pip'
+          python-version: '3.12'
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install ruff
 
       - name: Run Ruff linting
-        run: |
-          echo "::group::Ruff Linting"
-          ruff check . --output-format=github
-          echo "::endgroup::"
+        run: ruff check .
 
       - name: Run Ruff formatting check
-        run: |
-          echo "::group::Ruff Formatting"
-          ruff format --check .
-          echo "::endgroup::"
-
-      - name: Report formatting issues
-        if: failure()
-        run: |
-          echo "::error::Formatting or linting issues detected!"
-          echo "To fix locally, run:"
-          echo "  ruff check --fix ."
-          echo "  ruff format ."
-          echo "Then commit and push the changes."
+        run: ruff format --check .

contrib/README.md

@@ -0,0 +1,28 @@
+# 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 (incl. transceivers) |
+| `module_bay_mappings.yaml` | Maps LibreNMS inventory container names to NetBox module bay names |
+
+## 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.

contrib/device_type_mappings.yaml

@@ -0,0 +1,73 @@
+# Device Type Mappings
+#
+# Maps LibreNMS hardware strings to NetBox device types.
+# Import via: LibreNMS Plugin > Device Type Mappings > Import
+#
+# 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)"
+
+# UfiSpace — LibreNMS reports SONiC/ONIE platform names
+- librenms_hardware: "x86-64-ufispace-s9610-36d-r0"
+  netbox_device_type: "S9610-36D"
+  description: "UfiSpace S9610-36D"
+
+- librenms_hardware: "x86-64-ufispace-s9610-46dx-r0"
+  netbox_device_type: "S9610-46DX"
+  description: "UfiSpace S9610-46DX"
+
+- librenms_hardware: "x86-64-ufispace-s9700-53dx-r9"
+  netbox_device_type: "S9700-53DX"
+  description: "UfiSpace S9700-53DX"