Prerequisites
| You need | How |
|---|---|
| A running 2501 instance with at least one host + agent | See Quickstart |
2501 CLI installed and signed in (2501 status works) | See CLI |
| Ansible on PATH | brew install ansible / apt install ansible |
| A sandbox host the agent can SSH into | A spare VM, container, or Lima/Incus instance |
--mode host with a pre-provisioned target.
Step 1 — get a scenarios directory
The runner reads scenarios from a directory. The fastest path is to clone the 2501 scenarios examples repo (your account team can share the URL), or write your own.Step 2 — write scenario.json
scenario.json
Step 3 — write the playbooks
The runner needs three Ansible playbooks:prepare.yml introduces the failure, validate.yml checks the fix worked, restore.yml resets the host.
prepare.yml
validate.yml
restore.yml
inventory.ini so Ansible knows how to reach the host:
inventory.ini
Step 4 — run it
From the repo root that contains./scenarios/:
Step 5 — read the report
Two places:- Terminal output — pass/fail per rule, plus the two aggregate scores.
- Command Center → Benchmarks — the same run, charted over time alongside others.
What to read next
Scenario structure
Every field of
scenario.json, with examples.Validation rules
Every validator, every
where: target, the scoring model.Playbooks
What prepare / validate / restore each do, and when they run.
VM Sandbox
Skip the manual host setup — let the runner provision a fresh VM per run.

