NetBox Fundamentals
NetBox is an open-source web application for documenting network infrastructure. It combines IP address management and data center inventory into one intended-state model that automation tools can query through APIs.
itNetworking | OpenSkills.info
Course pathWalk it in order
Look it upDip in anytime
Go furtherLeaves this page
Don't Panic
Don't Panic — NetBox Fundamentals
NetBox is the network team's shared notebook with opinions. It stores what the network should look like: sites, racks, devices, cables, prefixes, and addresses, wired together the way a real plant is wired.
Before tools like this, that knowledge lived in spreadsheets that were already wrong when you opened them, plus a tribal story about which VLAN "everyone uses for management". Automation then invented a third inventory file and hoped the three would coincide.
Two disciplines share one graph. IPAM tracks aggregates, prefixes, ranges, and addresses, optionally inside a VRF when tables overlap. DCIM tracks regions, sites, locations, racks, and devices. The join that matters is humble: an IP attaches to an interface, and that interface belongs to a device that sits somewhere physical.
That interface rule is the thing people skip. A flat "device IP" column feels faster until you need to know which port a cable hits or which address moves with a line card.
NetBox is deliberately not a monitoring system, not a DNS server, and not a RADIUS box. It will not graph interface counters or answer recursive queries. Adjacent tools should read it.
The design philosophy sounds stern because it has to. Automated import of live state is discouraged. Continuous LLDP mirrors turn the database into a copy of accidents. Seed carefully if you must, then keep intent under change control and compare drift somewhere else.
Device types capture a manufacturer and model once so new devices inherit interface templates. Editing the type later does not retrofit old devices. That surprise is a feature: inventory should not mutate because someone tidied a template.
When you are ready for depth, the Intro walks the hierarchy and the out-of-scope list. The Cheatsheet keeps the object map beside you while you click. Practice and the Exercise create a site-to-IP chain through the API. Field Notes covers why write-path discipline beats another sync job.
Where this skill leads
Relevant careers
See how this topic contributes to broader role-level skill maps.
Sources
- https://docs.netbox.dev/en/stable/introduction/
Supports
- Origin at DigitalOcean in 2015 and open source release in 2016
- Stewardship by NetBox Labs and volunteer maintainers
- Design philosophy of real-world modeling, intended-state source of truth, and focused scope
- Strong discouragement of automated import of live network state
- Explicit non-goals including monitoring, DNS server, RADIUS, configuration management, and facilities management
- Django, PostgreSQL, Redis, and WSGI deployment stack overview
- Key feature list spanning IPAM, DCIM, circuits, virtualization, plugins, APIs, and permissions
- https://docs.netbox.dev/en/stable/
Supports
- Positioning of NetBox as network source of truth combining IPAM and DCIM
- Network-specific object model versus general-purpose CMDB framing
- https://docs.netbox.dev/en/stable/features/facilities/
Supports
- Region, site group, site, location, rack, and device hierarchy
- Independent geographic and functional grouping of sites
- Optional rack and location assignment for devices
- https://docs.netbox.dev/en/stable/features/devices-cabling/
Supports
- Device types as manufacturer and model templates with component templates
- Instantiation of components only at device creation time
- Modules versus device bays and virtual chassis behavior
- First-class MAC address objects
- Cable termination rules and invalid connection rejection
- https://docs.netbox.dev/en/stable/features/ipam/
Supports
- Aggregate, prefix, IP range, and IP address hierarchy
- Automatic parent assignment from CIDR containment
- VRF isolation and optional uniqueness enforcement
- Container versus non-container prefix utilization calculations
- ASN tracking and application service mapping concepts
- https://docs.netbox.dev/en/stable/models/ipam/prefix/
Supports
- Prefix fields including status, VRF, role, pool flag, scope, and VLAN assignment
- https://docs.netbox.dev/en/stable/installation/
Supports
- Supported Python, PostgreSQL, and Redis versions
- HTTP reverse proxy, WSGI, application, database, and Redis roles
- https://docs.netbox.dev/en/stable/integrations/rest-api/
Supports
- REST API as the primary programmatic integration surface with token authentication
- https://docs.netbox.dev/en/stable/integrations/graphql-api/
Supports
- GraphQL API as a read-oriented nested query interface using the same tokens as REST
- Filtering and pagination patterns for list queries
- https://docs.netbox.dev/en/stable/release-notes/
Supports
- Minor release cadence and historical feature milestones from v3.0 onward
- NetBox 3.0 GraphQL and UI updates in August 2021
- NetBox 3.5 configuration template rendering in April 2023
- NetBox 4.0 UI refresh in the April/May 2024 line
- https://github.com/netbox-community/netbox/releases/tag/v4.0.0
Supports
- NetBox v4.0.0 published 2024-05-06 with plugin migration impact
- https://github.com/netbox-community/netbox/issues/3351
Supports
- Plugins framework design and delivery path toward the 2.8 release line
- https://github.com/netbox-community/netbox/pull/4479
Supports
- v2.8.0 release PR referencing plugins support landing
- https://netboxlabs.com/blog/netbox-labs-to-spin-out-of-ns1-ibm-to-invest/
Supports
- NetBox Labs spin-out from NS1 announced 28 February 2023 with IBM investment
- https://networktocode.com/blog/why-did-network-to-code-fork-netbox/
Supports
- Network to Code rationale for forking NetBox into Nautobot
- https://github.com/netbox-community/netbox/discussions/18609
Supports
- Maintainer clarification that Day-1 baseline and Day-2 drift visibility differ from continuous overwrite of intent
- https://netboxlabs.com/docs/sdks/netbox-ansible-collection/
Supports
- Official Ansible collection requirements and inventory/lookup usage patterns
- https://github.com/netbox-community/awesome-netbox
Supports
- Curated ecosystem links for docker, chart, device type library, clients, and plugins used in awesome links
- https://github.com/netbox-community/netbox-docker
Supports
- Community Docker Compose deployment path referenced for labs
- https://github.com/netbox-community/pynetbox
Supports
- Python API client for NetBox automation scripts
