已开源 / 可安装Open-source / Installable

NetBox Endpoint LocatorNetBox Endpoint Locator

NetBox Endpoint Locator 主打 NetBox 联动 LibreNMS 的终端定位:通过 IP / MAC / VLAN / 端口证据映射回 NetBox 设备,减少手工查表和跨系统切换。NetBox Endpoint Locator links NetBox with LibreNMS to locate endpoints by IP / MAC / VLAN / port evidence, reducing manual table lookup across systems.

适合谁使用

  • 需要从 IP 或 MAC 定位终端接入交换机端口的 NetBox 用户
  • 希望复用 LibreNMS 证据减少跨系统手工查询的网络团队

解决什么问题

终端接入位置常常需要跨 NetBox、LibreNMS、ARP、MAC 表和接口信息手工关联。

核心能力

IPv4 / MAC 查询

插件目标环境为 NetBox 4.4.x,Python 版本要求 3.10 及以上。

LibreNMS 证据关联

通过 LibreNMS 查询 IP、MAC、VLAN、端口和设备证据,过滤聚合、路由和 trunk 类端口。

NetBox 设备映射

当前文档版本为 1.0.2,支持按 IPv4 或 MAC 查询终端接入位置。

终端端口过滤

NetBox Endpoint Locator 主打 NetBox 联动 LibreNMS 的终端定位:通过 IP / MAC / VLAN / 端口证据映射回 NetBox 设备,减少手工查表和跨系统切换。

典型工作流

  • 在 NetBox 中输入 IPv4 或 MAC
  • 调用 LibreNMS 查询 IP、MAC、VLAN、端口和设备证据
  • 过滤聚合、路由和 trunk 类端口
  • 将最终设备映射回 NetBox 并展示接入结果

适用场景

  • 终端定位
  • 接入端口追踪
  • 网络资产核查

输入

  • IPv4 或 MAC 地址
  • LibreNMS API 数据
  • NetBox 设备资产

输出

  • 候选和最终接入设备
  • 交换机接口与 VLAN 证据
  • 映射后的 NetBox 设备链接

部署和数据边界

  • 插件安装在用户自己的 NetBox 环境
  • 查询依赖用户配置的 LibreNMS URL 和令牌
  • 不会替代 NetBox 或 LibreNMS 的资产与监控职责
01

克隆仓库

git clone https://github.com/Jaycelu/netbox_-endpoint_locator.git
cd netbox_-endpoint_locator
02

安装插件

pip install -e .
03

启用插件

PLUGINS = ["netbox_endpoint_locator"]

PLUGINS_CONFIG = {
    "netbox_endpoint_locator": {
        "librenms_url": "https://librenms.example.com",
        "librenms_token": "YOUR_TOKEN"
    }
}
04

重启 NetBox

sudo systemctl restart netbox netbox-rq

系统要求

  • NetBox 4.4.x
  • Python 3.10 或更高版本
  • 可访问的 LibreNMS API 与访问令牌

当前版本和更新时间

1.0.2

发布日期:2026-03-23

内容更新时间:2026-07-13

已知限制

  • 目标环境为 NetBox 4.4.x
  • 查询结果依赖 LibreNMS 中 ARP、FDB、VLAN 和接口数据的完整性

常见问题

可以通过什么信息查询终端?

当前支持使用 IPv4 或 MAC 地址查询。

为什么同时需要 NetBox 和 LibreNMS?

LibreNMS 提供动态 IP、MAC、VLAN 与端口证据,NetBox 提供规范化设备资产和可回链对象。

插件会修改网络设备配置吗?

不会。它读取 LibreNMS 和 NetBox 数据用于定位,不执行设备配置变更。

相关技术文章

如何通过 IP 地址定位交换机端口 · 规划中NetBox 与 LibreNMS 如何联合实现终端定位 · 规划中

查看内容规划

产品入口

Who it is for

  • NetBox users locating an endpoint switch port from an IP or MAC
  • Network teams reusing LibreNMS evidence to reduce manual cross-system queries

What problem it solves

Endpoint access locations often require manual correlation across NetBox, LibreNMS, ARP, MAC tables, and interface data.

Core capabilities

IPv4 / MAC lookup

The plugin targets NetBox 4.4.x and requires Python 3.10 or later.

LibreNMS evidence correlation

LibreNMS evidence covers IP, MAC, VLAN, port, and device data while filtering aggregation, routed, and trunk-like ports.

NetBox device mapping

The documented release is 1.0.2 and supports endpoint lookup by IPv4 or MAC.

Access-port filtering

NetBox Endpoint Locator links NetBox with LibreNMS to locate endpoints by IP / MAC / VLAN / port evidence, reducing manual table lookup across systems.

Typical workflows

  • Enter an IPv4 or MAC in NetBox
  • Query LibreNMS for IP, MAC, VLAN, port, and device evidence
  • Filter aggregation, routed, and trunk-like ports
  • Map the final device back to NetBox and display the result

Use cases

  • Endpoint location
  • Access-path tracing
  • Network asset verification

Inputs

  • IPv4 or MAC address
  • LibreNMS API data
  • NetBox device inventory

Outputs

  • Candidate and final access device
  • Switch interface and VLAN evidence
  • Mapped NetBox device link

Deployment and data boundary

  • The plugin runs in the user's own NetBox environment
  • Queries use the configured LibreNMS URL and token
  • It does not replace NetBox inventory or LibreNMS monitoring
01

Clone repository

git clone https://github.com/Jaycelu/netbox_-endpoint_locator.git
cd netbox_-endpoint_locator
02

Install the plugin

pip install -e .
03

Enable in NetBox

PLUGINS = ["netbox_endpoint_locator"]

PLUGINS_CONFIG = {
    "netbox_endpoint_locator": {
        "librenms_url": "https://librenms.example.com",
        "librenms_token": "YOUR_TOKEN"
    }
}
04

Restart NetBox

sudo systemctl restart netbox netbox-rq

System requirements

  • NetBox 4.4.x
  • Python 3.10 or later
  • Reachable LibreNMS API and access token

Current version and update

1.0.2

Published:2026-03-23

Content updated:2026-07-13

Known limitations

  • The target environment is NetBox 4.4.x
  • Results depend on the completeness of ARP, FDB, VLAN, and interface data in LibreNMS

Frequently asked questions

Which identifiers can be queried?

The current plugin supports IPv4 and MAC address lookups.

Why are both NetBox and LibreNMS needed?

LibreNMS supplies dynamic IP, MAC, VLAN, and port evidence while NetBox provides normalized device inventory and links.

Does the plugin change device configurations?

No. It reads LibreNMS and NetBox data for location and does not push configuration changes.

Related technical guides

如何通过 IP 地址定位交换机端口 · PlannedNetBox 与 LibreNMS 如何联合实现终端定位 · Planned

View the editorial roadmap

Product access

产品截图Product screenshots

NetBox Endpoint Locator Endpoint Locator 查询结果
Endpoint Locator 查询结果Endpoint Locator lookup result