CLI reference / queue / drain

stado queue drain

Invocation

stado queue drain [OPTIONS]

Purpose

Pause, then (with --wait) block until no job is running any more

Required inputs and options

Input or optionContract
--waitWait for running/ to empty instead of returning immediately
--timeout <TIMEOUT>Deadline for --wait, in seconds. Exits non-zero if it elapses with jobs still running [default: 900]

Output and state effect

It performs the operation described above and emits its operator result on standard output or standard error. Any state change is limited to the resources and records named by the purpose and options on this page.

Refusals

  • Exits non-zero if it elapses with jobs still running [default: 900]
  • Before dispatch, Stado refuses a missing required token shown in the invocation, an unknown option, or a value outside a listed value set; argument-usage failures exit with code 2.