Documentation CLI 0.1.1 · development llms.txt

coldctl agent scheduler cancel

Cancel a queue entry.

ImplementedLocal cancellation request

Syntax

USAGE

coldctl agent scheduler cancel [OPTIONS] <ID>

Arguments & options

Argument	Description
`<ID>`	Queue UUID returned by scheduler enqueue; not the archive job ID.

Option	Description / default
`--data-dir <PATH>`	Override the OS application data directory
`-h, --help`	Print help

Examples

Replace configuration names, paths and JOB_ID with values from your installation. Examples are not executed by this page.

CLI

coldctl agent scheduler cancel QUEUE_ID

Operational notes

Stops future batches and requests active archival to stop at a safe boundary. An in-flight batch may commit. Committed deletions are not undone. Cancellation is terminal for the queue.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Cancel a queue entry and request its active job to stop at a batch boundary

Usage: coldctl agent scheduler cancel [OPTIONS] <ID>

Arguments:
  <ID>  

Options:
      --data-dir <PATH>  Override the OS application data directory
  -h, --help             Print help