Commands · reference
config-weave check
check reports the configuration status of every step in a play and never changes the machine. It runs the same validation, gatherer phase and DAG walk as apply, but stops after each step's first check call and never invokes apply. Run it before an apply to see what would change, and after one to confirm the machine converged. See Check, then apply.
Synopsis
config-weave check [OPTIONS] <PLAYBOOK_DIR> <PLAY>
Arguments
| Argument | Meaning |
|---|---|
| PLAYBOOK_DIR | The playbook directory, containing playbook.wcl. |
| PLAY | The name of the play to check. |
Options
All global options apply.
| Option | Value | Meaning |
|---|---|---|
| --events-ndjson | Stream one JSON event per line to stderr: run and gather lifecycle plus per-step phase progress. Stdout still carries the final report. | |
| --continue-on-error | Keep checking the remaining steps after a step's check returns Error. | |
| --jobs | N | Worker pool size. |
Examples
Report the state of the baseline play.
config-weave check ./my-playbook baseline
Produce a JSON report and count the steps that still need work.
config-weave check ./my-playbook baseline --json \
| jq '[.steps[] | select(.status == "not_configured")] | length'
Exit status
0 when every step reported without error, whether or not any is NotConfigured. A NotConfigured step is a finding, not a failure. 1 when any step's check returned Error. 2 when validation failed or the play does not exist. check never returns 3: a RebootRequired result is reported as the step's status, but only apply turns it into an exit code.