Wazuh 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.

Wazuh API

Variable	Description	Status
WAZUH_URL	Required for authentication.	required
WAZUH_USER	Required for authentication.	required
WAZUH_PASSWORD	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave wazuh --help
weave doctor   # reports WAZUH_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
agent	·	✓	·	✓	✓	✓	·
group	·	✓	·	·	·	·	·
rule	·	✓	·	·	·	·	·

Commands

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

list (3)

list agents

read

List enrolled agents.

weave wazuh list agents <arg>

list groups

read

List agent groups.

weave wazuh list groups <arg>

list rules

read

List detection rules.

weave wazuh list rules <arg>

do (2)

do restart

write

Restart the Wazuh agent on a host.

weave wazuh do restart <agent-id>

do upgrade

write

Upgrade the Wazuh agent on a host (WPK from the online repository).

weave wazuh do upgrade <agent-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/wazuh/.

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

agents

snapshot diff apply

Wazuh enrolled agents — snapshot + diff only (agent fields are not writable).

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

State file skeleton

module: wazuh
kind: agents
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.

Agents audit

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

weave wazuh snapshot agents
$EDITOR .weave-state/wazuh/agents.yaml
weave wazuh diff agents

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
wazuh_agents	weave wazuh snapshot/diff agents 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 WAZUH_URL) are set and which are blank.

Unexpected behaviour from a state apply

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