NetBox Facts¶

NetBox Facts is a NetBox 4.5+ plugin that gathers operational facts from network devices managed in NetBox via NAPALM and stores them as queryable records.

What it does¶

The plugin connects to devices using the credentials and driver configured on a Collection Plan, runs one of ten collector types (ARP, NDP, inventory, interfaces, LLDP, ethernet switching, L2 circuits, EVPN, BGP, OSPF), and persists what it finds. Results are either:

• written directly to NetBox (apply mode); or
• captured in a FactsReport for review (detect-only mode), where each detected fact is a FactsReportEntry that can be applied or skipped individually or in bulk.

Recurring collection is handled by NetBox's JobRunner framework so plans re-run on a configurable interval.

When to use it¶

• You want to keep IP, MAC, neighbor, and chassis inventory data in NetBox in sync with what devices actually report.
• You want auditable, reviewable changes rather than silent mutations.
• You operate Junos and want richer ARP/NDP, chassis inventory, EVPN, L2 circuits, and OSPF collection out of the box.

Where to start¶

• New users: read Installation, then Configuration, then Quick Start.
• Operators: read Collection Plans and Detect-Only Workflow.
• Integrators: read the REST API reference.
• Plugin developers: read Architecture and Vendor Dispatch.

Project status¶

Alpha. Compatible with NetBox 4.5.x. Source on GitHub, released to PyPI as netbox-facts.