Table of Contents

NetBox

Changelog

  • 2025-03-16: Init for NetBox Community v4.2.4

Tutorial

Flow of initial setup:

  1. Define organization sites (+ customize table)
  2. Define platforms
    • Avoid specifying manufacturers for generic OS, e.g. Microsoft for Windows 11, which will restrict assigning of platform to only Microsoft-produced devices.
  3. Define manufacturers, then device types, then device roles, then devices (+ customize table)
    • Device types have been defined by the community in the devicetype-library repo. Helpful comment from Reddit1).
    • Components should be defined as well for ease of device creation, see screenshot
  4. Define device interfaces
  5. Define IP prefixes and specific addresses

Configuration

Visibility of navigation bar items determined by assigned permissions to user. Create a new user, and create permissions.

Note that superusers have full visibility, and so items cannot be hidden.


1)
Switches (and devices) don't have front/rear ports they have interfaces that connect to ports. Front ports are what devices "generally" connect up with (looking at the front of your patch panel those are front ports). Rear ports are what other rear ports "generally" connect with. These are on the back side of your patch panel. The whole idea is that you can trace the full link from switch interface, through any ports in your campus / network, to the end interface. u/chris-itg