The NetBox Device Type Library: What It Is and How to Use It

What the Device Type Library Is

The NetBox Device Type Library is a community-maintained repository of YAML definitions for physical network and data centre devices. Each definition describes a device's physical properties — manufacturer, model name, form factor, U height, weight, and interface templates — in a format that NetBox can import directly.

The library contains definitions for thousands of devices from hundreds of manufacturers: servers, switches, routers, storage arrays, PDUs, UPS units, patch panels, and more. It is maintained by the NetBox community through GitHub pull requests, with contributions from manufacturers, integrators, and end users.

For anyone implementing NetBox, the device type library is the starting point for populating the device type catalogue. Rather than manually creating device type objects for every model in your inventory, you can import the relevant YAML definitions from the library and have accurate physical specifications immediately.

The Structure of a Device Type Definition

A device type YAML file has a specific structure. The top-level fields are: manufacturer (must match an existing manufacturer object in NetBox), model (the canonical model name), slug (a URL-safe version of the model name), part_number (the vendor's part number), u_height (rack units), is_full_depth (whether the device occupies the full depth of the rack), and weight (in kg or lbs).

Below the top-level fields are interface templates, console port templates, power port templates, and other component templates. These templates define the ports and connections that NetBox will create automatically when a device of this type is added to the inventory.

A well-formed device type definition for a Dell PowerEdge R640 would include two power port templates (for the dual PSUs), two console port templates (one physical, one USB), and the correct number of network interface templates based on the standard NIC configuration.

Finding Devices in the Library

The library is organised by manufacturer. To find a device type, navigate to the manufacturer's directory and look for a YAML file with the model name. The library's GitHub repository has a search function that works across all YAML files.

Before assuming a device type is not in the library, check for common naming variations. The library uses the manufacturer's official model name, which may differ from how the model appears in your asset inventory. "PowerEdge R640" is in the library; "PE R640" is not — but they refer to the same device.

If you cannot find a device type in the library, check whether the manufacturer has submitted definitions through their official GitHub account. Several major vendors — including Cisco, Arista, and Juniper — maintain their own contributions to the library.

Importing Device Types into NetBox

NetBox provides a built-in tool for importing device type definitions from YAML files. The tool is available in the NetBox UI under Devices → Device Types → Import. You can paste YAML content directly or upload a file.

For bulk imports — when you need to import dozens or hundreds of device types — the community maintains a script called netbox-device-type-library-import that automates the process. The script reads YAML files from a local copy of the library and imports them into NetBox via the API. This is the recommended approach for initial NetBox deployments.

When Your Device Is Not in the Library

The library does not contain every device ever manufactured. Older hardware, niche vendors, and recently released models are often missing. When you encounter a device that is not in the library, you have three options.

The first option is to create a minimal device type definition — just the top-level fields without component templates. This is sufficient for basic capacity planning and is faster than creating a full definition. The second option is to create a full device type definition and submit it to the library as a pull request. This benefits the entire community and is the preferred approach for common devices. The third option is to use a "generic" device type for devices where the specific model is not important for your use case.

Matching Your Asset Data Against the Library

Before importing your asset data into NetBox, you need to verify that every device type in your inventory has a corresponding definition in the library (or in your NetBox instance). This matching step is where model name normalisation becomes critical.

The matching process works like this: for each unique manufacturer and model combination in your asset data, search the library for a YAML file that matches. If the model name in your data is "PE R640", normalise it to "PowerEdge R640" first, then search. If a match is found, note the manufacturer slug and model slug for use in your import CSV. If no match is found, add the combination to a gap list for manual resolution.

Struktive automates this matching process. Every record processed by Struktive is matched against the NetBox Device Type Library, and the export includes the correct manufacturer slug and model slug for each matched device. Unmatched devices are flagged in a separate report so you can resolve them before import.