batch:stop

Stop one or more batches.

Usage

horizon batch:stop [options]

Examples

# Stop a single batch
horizon batch:stop --batch="pyi2zub057rp"

# Stop two batches and discard their output
horizon batch:stop --batch="pyi2zub057rp" --batch="k3nd81mfq0zx" --discard

# Stop a batch immediately, without waiting for CONVERGE to finish writing output files
horizon batch:stop --batch="pyi2zub057rp" --force

# Stop all of your pending and running batches
horizon batch:stop --all

Options

This command supports the general CLI options in addition to those listed below.

--batch=BATCH_ID, -b BATCH_ID

ID of the batch to stop. You can get batch IDs by running batch:list or by navigating to the Batch Details page in the web interface (go to Batches and click on the batch name).

Repeatable—To stop multiple batches, pass this option once per batch.

--all, -a

Stop all of your batches with a status of Pending or Running.

--discard

Discard output files for all jobs in the stopped batch(es). This option implies --force, because there is no output left to wait for.

Caution

Discarded output cannot be recovered.

--force

End every running job in the batch(es) immediately instead of stopping gracefully. CONVERGE is not given the opportunity to create a restart file or finish writing output files.

Caution

Output files may be incomplete.