Netbox module · weave

Setup

Configure credentials via environment variables. We recommend sourcing them through 1Password or your secrets manager rather than committing them to the shell rc.

Official API reference

weave commands for this module are checked against the vendor's published API.

NetBox REST API

Variable	Description	Status
NETBOX_URL	Required for authentication.	required
NETBOX_TOKEN	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave netbox --help
weave doctor   # reports NETBOX_URL status

Capabilities

What this module can do, by entity and verb. ✓ means a working CLI surface; · means not (yet) wired.

Entity	find	list	show	do	snapshot	diff	apply
device	✓	·	·	·	·	·	·
ip	·	✓	·	·	·	·	·
rack	·	✓	·	·	·	·	·
site	·	✓	·	·	✓	✓	✓

Commands

Every registered CLI command, grouped by verb. Each example uses placeholder arguments — substitute real values for your environment.

find (1)

find device

read

Find a device by name or serial.

weave netbox find device <identifier>

list (3)

list ips

read

List IP addresses.

weave netbox list ips <arg>

list racks

read

List racks.

weave netbox list racks <arg>

list sites

read

List sites.

weave netbox list sites <arg>

snapshot / diff / apply are generated automatically from the State Kinds declared on this module — see the State kinds section below for per-kind details. Workflow: snapshot → edit YAML → diff → apply --yes (or confirm interactively; apply --dry-run previews the same diff).

State kinds

Resources this module can snapshot and diff; apply where the kind supports live writes (see Round-trip per kind). Always run diff before apply; use --yes in automation after review. Files live under .weave-state/netbox/.

sites

snapshot diff apply

NetBox sites — name, slug, status, description round-trip via PATCH.

Scope: —
Round-trip: Full round-trip — snapshot, diff, apply.

State file skeleton

module: netbox
kind: sites
items:
  - # <fields specific to this kind — see snapshot output>

Workflows

End-to-end recipes from operators who already run this module in production. Copy, adapt, and put under change-control.

Site metadata audit

Snapshot sites, edit name/slug/status, diff and apply.

weave netbox snapshot sites
$EDITOR .weave-state/netbox/<host>/sites.yaml
weave netbox diff sites
weave netbox apply sites

Look up one device

weave netbox find device <name-or-serial>

List sites

weave netbox list sites

Terraform parity

For each Terraform resource in the canonical provider, here's the equivalent live-API verb in weave. Use this as a migration cheat-sheet, not a 1:1 contract — weave deliberately stays in the live-state lane, not the desired-state lane.

Terraform resource	weave equivalent
netbox_site	weave netbox snapshot/diff/apply sites Site fields round-trip via PATCH /dcim/sites/:id/.
netbox_device	weave netbox find device Lookup by name or serial query params.

Troubleshooting & source

Missing credentials

Run weave doctor — it reports which env vars (including NETBOX_URL) are set and which are blank.

Unexpected behaviour from a state apply

Re-run weave netbox diff <kind> to confirm the controller's current state, then re-snapshot before the next apply. The driver always re-snapshots before diffing.

Open the source

The module lives at https://github.com/andy-broyles/weavewhatever/tree/main/src/weave/modules/netbox. File a bug or feature request at https://github.com/andy-broyles/weavewhatever/issues.