nbox

Query and modify NetBox (DCIM/IPAM) from the shell with the `nbox` CLI — look up devices, interfaces, IPs, prefixes, VLANs, sites, racks, circuits, VRFs, tenants, VMs, and clusters; run cross-object search; use IPAM helpers (next free IP/prefix, prefix utilization, cable-path traces); and safely write (reserve IPs/prefixes, set status/description, manage tags) behind a dry-run/confirm gate. Use when the user asks about NetBox, network inventory, IP addressing, or device/interface/cable details, or wants machine-readable network data or safe mutations. Read-only by default; supports `-o json` / `-o csv` and an MCP server.

Run nbox as an MCP server (read-only by default; optional local stdio writes with --local-writes, or shared HTTP/OIDC writes with --allow-writes + nbox:write + [serve.vault]) so an agent host can query NetBox over JSON-RPC — stdio or HTTP+OIDC transport, the read tools (search/get/get_interface/history/…), the nbox://{kind}/{ref} resource template, the investigation prompts catalog, and --print-config for install recipes. Use when the user wants to wire NetBox into an MCP host or stand up the server.

How to safely modify NetBox through nbox's write commands — the universal dry-run / confirm / audit lifecycle shared by all seven safe-write commands (interface description, device status, IP/prefix/ip-range reserve, tag add/remove). Use when the user wants to change NetBox objects, reserve IPs, or manage tags.

Pull the full physical context of a device or interface from NetBox with nbox — a device's interfaces/IPs/cables/VLANs/services, an interface's cable-path A↔Z trace, a MAC reverse-resolved to its carrying interface/device, plus rack and site context. Use when the user asks how a device is connected, what's on an interface, where a MAC lives, or what's in a rack/site.

Answer IP addressing questions from NetBox with nbox's IPAM read commands — look up an IP and its parent prefix/VLAN/scope, check prefix utilization and the prefix tree, preview the next free IP/prefix, and inspect VLANs, IP ranges, aggregates, VRFs, and route targets. Use when the user asks about addressing, allocation, or routing context.

Find NetBox objects across kinds in one query with nbox's ranked, deduped cross-object search — the entry point when the kind or exact reference isn't known yet. Use when the user wants to locate a device/IP/prefix/VLAN/site/etc. by a name fragment, or narrow by site/tenant/role/tag/status/VRF before a detail lookup.

Reserve the next available IP or prefix in NetBox using nbox's three allocate write commands — ip reserve, prefix reserve, and ip-range reserve. Use when the user wants to allocate IP addresses or child prefixes from NetBox.

Update NetBox object fields using nbox's PATCH write commands — interface set description and device set status. Use when the user wants to change an interface description or a device's status in NetBox.

Add or remove tags on any NetBox object using nbox's tag write commands — tag add and tag remove. Use when the user wants to manage tags on devices, IPs, prefixes, VLANs, or any other NetBox object.