Hexnode module

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.

Hexnode API

Variable	Description	Status
HEXNODE_PORTAL	Required for authentication.	required
HEXNODE_API_KEY	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave hexnode --help
weave doctor   # reports HEXNODE_PORTAL 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	✓	✓	·	✓	✓	✓	·
policy	·	✓	·	·	·	·	·

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 its numeric Hexnode device ID.

weave hexnode find device <device-id>

list (2)

list devices

read

List enrolled devices.

weave hexnode list devices <arg>

list policies

read

List policies.

weave hexnode list policies <arg>

do (3)

do lock

write

Lock a device.

weave hexnode do lock <device-id>

do scan

write

Trigger a device scan (forced check-in).

weave hexnode do scan <device-id>

do wipe

write

Wipe a device (irreversible; deprecated upstream but still served).

weave hexnode do wipe <device-id>

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/hexnode/.

This module is on the thinner integration path — use snapshot / diff for audit; confirm apply per kind below before relying on writes.

devices

snapshot diff apply

Hexnode devices — snapshot + diff only (inventory is read-only).

Scope: —
Round-trip: Snapshot + diff (apply not wired).

State file skeleton

module: hexnode
kind: devices
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.

Devices audit

Snapshot and diff devices (read-only; apply is intentionally not implemented).

weave hexnode snapshot devices
$EDITOR .weave-state/hexnode/devices.yaml
weave hexnode diff devices

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
hexnode_devices	weave hexnode snapshot/diff devices Snapshot/diff only; the vendor API does not support generic writes for this kind.

Troubleshooting & source

Missing credentials

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

Unexpected behaviour from a state apply

Re-run weave hexnode 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/hexnode. File a bug or feature request at https://github.com/andy-broyles/weavewhatever/issues.