CLI reference / space / watermark

stado space watermark

Invocation

stado space watermark [OPTIONS] <TARGET>

Purpose

Read or set the memory watermarks TARGET is measured against. With no write flag this prints the declaration in force. With one it rewrites `targets[].memory_reclaim` through the canonical registry's compare-and-swap, validating the whole document first.

Required inputs and options

Input or optionContract
<TARGET>Positional input; required or optional as shown in the invocation.
--policy <POLICY>Arm this host with one policy `stado space policies` declares, whole. Mutually exclusive with the individual field flags below: a write either applies a reviewed declaration or edits fields by hand, and a call that did both would leave a document neither of them describes
--authorize-graphical-sessionAuthorize the `graphical_session` repair the named policy carries. Required by any policy that ends a logged-in session's processes, and refused on its own, because the authorization has no meaning apart from the declaration that names the processes
--memory-mode <MEMORY_MODE>`off`, `report` or `enforce`; only `enforce` repairs anything
--memory-low-free-mb <MEMORY_LOW_FREE_MB>Available memory below this many MiB is pressure
--memory-target-free-mb <MEMORY_TARGET_FREE_MB>A pass stops as soon as this many MiB are available
--memory-high-swap-used-pct <MEMORY_HIGH_SWAP_USED_PCT>Swap utilisation at or above this percentage is pressure on its own
--memory-max-repairs-per-pass <MEMORY_MAX_REPAIRS_PER_PASS>How many repairs one pass may perform
--memory-max-pass-seconds <MEMORY_MAX_PASS_SECONDS>Seconds one pass may spend
--memory-repair <MEMORY_REPAIR>Permit one declared repair by name; repeat to permit several
--memory-repair-unit <MEMORY_REPAIR_UNIT>A unit `restart_unit` may restart; repeat
--memory-repair-process <MEMORY_REPAIR_PROCESS>A process `graphical_session` may end; repeat
--memory-repair-recovery <MEMORY_REPAIR_RECOVERY>The program `reap_recovery` runs
--memory-allow-graphical-session <MEMORY_ALLOW_GRAPHICAL_SESSION>Authorize `graphical_session` to end the processes it names [possible values: true, false]
--memory-refuse-placement <MEMORY_REFUSE_PLACEMENT>Publish this host as not accepting jobs while it is over its watermark [possible values: true, false]
--jsonCommand option; required or optional as shown in the invocation.

Output and state effect

This is an inspection/reporting operation. It emits the result described above and does not change managed state unless an explicit option in this page says otherwise. Pass `--json` when the command exposes that machine-readable option.

Refusals

  • Required by any policy that ends a logged-in session's processes, and refused on its own, because the authorization has no meaning apart from the declaration that names the processes
  • 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.