Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 2.21 KB

interface_mappings.md

File metadata and controls

66 lines (42 loc) · 2.21 KB
Raw

interface_mappings

Quick Intro

Interface type mappings control how LibreNMS interface types are translated to NetBox interface types during synchronization.

The mappings can be customized in the plugin settings menu.

A mapping of LibreNMS Type an LibreNMS Speed combine to make a unique group that map to a Netbox interface type. This means multiple mapping for the same LibreNMS Type can be created.

Note: The LibreNMS Speed is entered as Kbps

Example:

* ethernetCsmacd + 10000000 = 10GBASE-T (10GE)
* ethernetCsmacd + 1000000 = 1000BASE-T (1GE)
* ethernetCsmacd + 100000 = 100BASE-TX (10/100ME)

How to Use Interface Mappings

Accessing the Page:

Interface Mappings Page{ width="250" }

  • From the main menu, navigate to the Plugins section
  • Under Netbox Librenms Plugin, Select "Interface Mappings"

Creating a New Mapping:

{ width="50" }

  • Click the green + or Add button either from the menu or on the Interface Mappings page
  • Enter LibreNMS interface type. You can copy this from plugin's device interface sync page
  • Enter Librenms interface speed as Kbps
  • Select the Netbox interface type from the dropdown
  • Click Create to save the mapping

Editing Existing Mappings:

{ width="50" }

  • On the Mappings page, Locate the desired mapping in the list
  • Click the edit (pencil icon) button
  • Modify the field mappings as needed
  • Save the changes

Deleting Mappings:

{ width="150" }

  • Find the mapping you wish to remove
  • Select the Delete button from the drop down
  • Confirm the deletion when prompted

Applying Mappings:

  • Mappings are automatically applied when interface data is synced between LibreNMS and Netbox
  • If a mapping exist for an interface, it will show on the interface sync page with the icon :material-link-variant:
  • If a mapping does not exist, it will show the icon :material-link-variant-off:

Best Practices

  • Check mappings are correct before performing a sync to avoid data errors
  • Regularly review and update your mappings to ensure they remain accurate