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.
How to Use Interface Mappings¶
Accessing the Page:¶
- From the main menu, navigate to the Plugins section
- Under Netbox Librenms Plugin, Select "Interface Mappings"
Creating a New Mapping:¶
- Click the green
+
orAdd
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
- Select the Netbox interface type from the dropdown
- Click
Create
to save the mapping
Editing Existing Mappings:¶
- 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:¶
- 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
- If a mapping does not exist, it will show the icon
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