Skip to content

Feature Overview

Feature Overview

Device Import

  • Search and discover devices from LibreNMS using flexible filters
  • Validate device prerequisites before import (Site, Device Type, Device Role)
  • Import devices as physical Devices or Virtual Machines
  • Smart matching for Sites, Device Types, and Platforms (via mappings), including optional parsing of LibreNMS location strings into site, location, rack, and tenant values
  • Unified Platform creation modal — same experience on import page and device sync page
  • Bulk import support
  • Automatic Virtual Chassis creation for stackable devices
  • Background job processing for large device sets
  • Duplicate detection to prevent re-importing existing devices

Out-of-Band (OOB) Management

  • Detects when a LibreNMS device (iDRAC/iLO/BMC/IPMI/CIMC) is the OOB controller of an existing NetBox device
  • Add as OOB — link the controller to the host and set oob_ip on a chosen (or new) interface
  • Promote to host — re-point a device currently linked to its OOB controller onto the incoming host device
  • Merge NetBox devices — reconcile two devices (hostname-matched vs serial-matched) that represent one physical box
  • Per-server linkage stored in the librenms_id custom field as {"<server_key>": {"id": N, "oob": {"id": M, "type": "drac"}}}
  • Post-merge Move to winner actions to migrate interfaces, IP addresses, and primary/OOB IPs at your own pace

Module / Inventory Sync

  • Compare LibreNMS ENTITY-MIB inventory to NetBox module bays and installed modules
  • Install, update, or skip modules directly from the sync table
  • Match statuses: Matched, No Bay, No Type, Name Conflict, Not Installed
  • Inline modal to create missing ModuleBayTemplate, ModuleTypeMapping, or ModuleBayMapping without leaving the page
  • Carrier Auto-Install suggestion for chassis that omit holder modules from SNMP

Mappings

  • Interface Type Mappings — LibreNMS interface type and speed to NetBox interface type
  • Platform Mappings — LibreNMS OS string to NetBox Platform
  • Device Type Mappings — LibreNMS hardware string to NetBox DeviceType
  • Location Mappings — parsed LibreNMS location value to a NetBox Site, Location, Rack, or Tenant
  • Module Type Mappings — LibreNMS entPhysicalModelName to NetBox ModuleType (with manufacturer scoping)
  • Module Bay Mappings — LibreNMS entPhysicalName to NetBox bay name (exact or regex, manufacturer scoping)
  • Bulk YAML import/export for all mapping types

Rules & Patterns

  • Normalization Rules — regex-based string transformation before matching (strips vendor suffixes etc.)
  • Inventory Ignore Rules — include, skip, or make transparent selected ENTITY-MIB inventory items
  • Carrier Auto-Install Rules — suggest carrier module installation for vendors that omit them from SNMP
  • Port Stack LAG Patterns — identify LAG interfaces and service access points by LibreNMS OS
  • Bulk YAML import/export for all rule and pattern types
  • Vendor-contributed example rules in contrib/

Plugin Settings

  • Multi-server LibreNMS configuration support
  • Configurable device naming defaults (sysName vs hostname)
  • Domain stripping options during import for cleaner device names
  • Virtual Chassis member naming pattern customization during import

Device

  • LibreNMS device identification via:
  • Custom field librenms_id (recommended)
  • Primary IP address
  • Primary IP DNS name
  • Hostname
  • Add device to LibreNMS from netbox via SNMP v2c or v3

Virtual Chassis Support

  • Automatic VC member selection for each interface
  • Member-specific interface synchronization
  • Bulk member editing capabilities

Interface Sync

  • Create or Update interface in NetBox from LibreNMS interface data
  • Name
  • Description
  • Status (Enabled/Disabled)
  • Type (with custom mapping support)
  • Speed
  • MAC Address
  • MTU
  • VLAN assignments
  • Sync all or specific fields

Cable Sync

  • Create Cable connection in NetBox from LibreNMS links data
  • Best results when the custom field librenms_id is populated on interfaces

IP Address Sync

  • Create IP address objects in Netbox from LibreNMS device IP data
  • Optionally set the device or VM Primary IP from the LibreNMS management IP (opt-in Set Primary IP toggle on the IP Address Sync tab)
  • Best results when the custom field librenms_id is populated on interfaces

VLAN Sync

  • Create VLAN objects in NetBox from LibreNMS device VLAN data
  • Per-VLAN group assignment with scope-aware auto-selection

Location

  • NetBox Site to LibreNMS location synchronization
  • Sync location latitude and longitude values from NetBox to LibreNMS
  • Map parsed LibreNMS location values to NetBox Sites, Locations, Racks, and Tenants with Location Mappings