Drive it from the dashboard
Once an agent is connected, nothing about it needs a terminal. Its organization’s Agents list shows each one with its status, its board, its machine’s networks and its recent sweeps.
Status
Section titled “Status”| Status | Meaning |
|---|---|
| Online | Heartbeat seen in the last 90 seconds. |
| Offline | Silent for 90 seconds. A sweep it left running is closed as Abandoned. |
| Error | The agent reported a failure. |
| Paused | Shown beside the status: online or not, it starts no sweep. |
Sweep now, stop
Section titled “Sweep now, stop”Scan starts a sweep at once; Stop ends the one running. Progress, hosts and the outcome appear live on the agent and on its board for everyone who has it open.
A stopped sweep is Cancelled, not failed: what it found is filed, and it is not shown as 100%. If the agent is not connected, the dashboard says so instead of queueing the request.
Who may: admins of the organization, and anyone holding the operate permission on the agent’s board.
Settings
Section titled “Settings”| Setting | Same as in config.yaml |
|---|---|
| Name | agent.name |
| Board | ingestor.project_id |
| Range and mask | scan.cidr, scan.mask |
| Repeat every | scan.interval |
| Time limit per sweep | scan.timeout |
| Parallel workers | workers.count |
| Local file name, map name | topology.output, topology.name |
The range field offers the networks the machine actually has an address on, as the agent reported them, so nobody has to read ip addr over SSH.
A saved setting reaches a connected agent at once and applies from its next sweep, never halfway through one. It is also written back into the agent’s config.yaml and returned on every registration, so it survives a restart. A setting the dashboard has never touched stays whatever the file says.
Who may: admins of the organization.
Pause and resume
Section titled “Pause and resume”Pause stops an agent from starting sweeps — by button or by timer — without uninstalling it. It stays connected and online, so it reads as present rather than dead. A pause survives a restart, even one without network access: it is written into the agent’s file. A sweep already running finishes and is filed.
Who may: admins of the organization.
Remove
Section titled “Remove”Delete removes the agent. The dashboard first counts what goes with it:
- Its scan runs and raw results are deleted.
- Boards are kept, with everything drawn on them.
- API keys bound to it are revoked, so the machine cannot register again with them.
The machine itself is untouched: uninstall the agent there too, or it will try to register and be refused. See update and uninstall.
Who may: admins of the organization.
Activity
Section titled “Activity”The organization keeps a record of who told an agent to sweep and who changed what it sweeps. Every member can read the agents’ activity; the organization’s whole audit trail is for admins. See audit trail.
Across organizations
Section titled “Across organizations”Belonging to several organizations — one per client, for a managed service provider — the workspace view lists every agent across all of them with its organization and status, and running sweeps, in one place.