About the ODX Unified Library

What is the ODX Library?

The ODX Unified Library combines two sources into a single catalog of NetBox hardware definitions and operational metadata. It merges device types, module types, and rack types from the community-driven NetBox Device Type Library with additional device types, module types, and ODX sidecar files from the NetBox ODX Research project. The result is a unified collection with enriched operational metadata including thermal profiles, lifecycle status, power consumption, and provenance data.

When both sources contain the same device or module type, the ODX version takes precedence, as it may contain corrections or enrichments. ODX also contributes entirely new device and module types not yet present in the upstream community library.

How to Access

Git Clone

Clone the full repository for local use and integration into your workflows.

git clone https://github.com/mrmrcoleman/odx-library.git

JSON API

Access data programmatically via static JSON endpoints hosted alongside this website.

curl https://odx-library.pages.dev/api/stats.json

This Website

Browse and search the entire catalog right here with filtering, sorting, and detail views.

How to Contribute

This is a read-only distribution built from two source repositories. To contribute, submit PRs to the appropriate source:

  • 1
    netbox-community/devicetype-library

    The community-maintained source for device types, module types, and rack types. Submit new hardware definitions or corrections here.

  • 2
    NetBox ODX Research

    The ODX source for additional device types, module types, and sidecar data (thermal, lifecycle, operational metadata). Contact NetBox Labs for access.

Architecture Overview

Sources

Two repositories are merged: the community DeviceType Library provides the base catalog of device types, module types, and rack types. The ODX Research repo contributes additional device types, module types, and ODX sidecar files with operational metadata (thermal profiles, lifecycle dates, power data, provenance). When both sources have the same entry, ODX takes precedence.

Pipeline

A merge pipeline indexes both sources, resolves conflicts, maps manufacturer naming conventions, and produces a unified file tree. A separate step generates static JSON API files and a search index. The pipeline replays individual commits from both sources, preserving original authors and messages.

Output

The unified library is available as a git repository (clone it), a static JSON API (curl it), and this website (browse it). All three are kept in sync automatically via a CI pipeline that polls both source repos for changes.