Skip to main content
Version: v5.6.1

opschain admin server quiesce

Included from Basic tier

Holds the dispatch plane — the v2 RunnerService.QuiesceFleet RPC. While quiesced, the server makes no new offers to runners: queued work stays queued, runners stay parked, and existing leases are untouched, so in-flight steps run to their natural end. It is the routine instrument for maintenance windows and controlled drains of the whole fleet — reversible with admin server resume, and far gentler than the estate-wide admin platform quiesce (which also closes the write barrier) or the emergency admin platform halt (which freezes in-flight work too).

While the quiesce holds, admin queue shows the ready count growing with no new leases — expected, not a fault.

Flags​

FlagMeaning
--server <url>Server base URL (default: the active context / OPSCHAIN_SERVER).
--auth-token <token>Admin bearer token override (default: your opschain login session, then $OPSCHAIN_ADMIN_TOKEN, then the token stored by opschain admin login).

Output is the server's response document — JSON, or YAML under -o yaml.

Exit codes​

CodeMeaning
0Dispatch held.
1Request failed or the token was rejected.
2Usage error — no server/credential resolvable.

Named errors​

  • a server is required — pass --server <url>, set OPSCHAIN_SERVER, or 'opschain context use <name>' — exit 2.
  • this command needs a login or an admin token — run 'opschain login', pass --auth-token, set OPSCHAIN_ADMIN_TOKEN, or store one with 'opschain admin login' — exit 2.
  • the server rejected the credential — run 'opschain login' again, or check the admin token — HTTP 401 (exit 1).

Examples​

opschain admin server quiesce

See also​

  • opschain docs cli/admin-server-resume — lift the hold.
  • opschain docs cli/admin-queue — watch the parked work.
  • opschain docs fleet-queue — quiesce in the dispatch verdict ladder.
  • opschain docs cli/admin-platform-halt — the emergency tier when a polite hold is not enough.