open-nomad/website/content/docs/commands/job/stop.mdx

85 lines
2.6 KiB
Plaintext
Raw Normal View History

---
2020-02-06 23:45:31 +00:00
layout: docs
page_title: 'Commands: job stop'
description: |
2018-03-22 17:56:06 +00:00
The job stop command is used to stop a running job.
---
2018-03-22 17:56:06 +00:00
# Command: job stop
2018-03-22 18:09:26 +00:00
**Alias: `nomad stop`**
2018-03-22 17:56:06 +00:00
The `job stop` command is used to stop a running job and signals the scheduler
to cancel all of the running allocations.
## Usage
```plaintext
2018-03-22 17:56:06 +00:00
nomad job stop [options] <job>
```
The `job stop` command requires a single argument, specifying the job ID or
prefix to cancel. If there is an exact match based on the provided job ID or
prefix, then the job will be cancelled. Otherwise, a list of matching jobs and
information will be displayed.
2016-11-04 22:25:12 +00:00
Stop will issue a request to deregister the matched job and then invoke an
interactive monitor that exits automatically once the scheduler has processed
the request. It is safe to exit the monitor early using ctrl+c.
When ACLs are enabled, this command requires a token with the `submit-job`,
`read-job`, and `list-jobs` capabilities for the job's namespace.
## General Options
2020-02-06 23:45:31 +00:00
@include 'general_options.mdx'
## Stop Options
- `-detach`: Return immediately instead of entering monitor mode. After the
2016-05-26 01:52:14 +00:00
deregister command is submitted, a new evaluation ID is printed to the screen,
which can be used to examine the evaluation using the [eval status] command.
- `-eval-priority`: Override the priority of the evaluations produced as a result
of this job deregistration. By default, this is set to the priority of the job.
- `-verbose`: Show full information.
2016-01-19 23:01:26 +00:00
- `-yes`: Automatic yes to prompts.
2016-11-04 22:25:12 +00:00
- `-purge`: Purge is used to stop the job and purge it from the system. If not
2020-02-06 23:45:31 +00:00
set, the job will still be queryable and will be purged by the garbage
collector.
2017-04-15 03:54:30 +00:00
- `-global`
2020-09-30 13:48:40 +00:00
Stop a [multi-region] job in all its regions. By default, `job stop` will
stop only a single region at a time. Ignored for single-region jobs.
- `-no-shutdown-delay`
Ignore the the group and task [`shutdown_delay`] configuration so that
there is no delay between service deregistration and task
shutdown. Note that using this flag will result in failed network
connections to the allocations being stopped.
## Examples
2015-09-21 19:05:48 +00:00
Stop the job with ID "job1":
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad job stop job1
2016-01-19 23:01:26 +00:00
==> Monitoring evaluation "43bfe672"
2015-09-21 19:05:48 +00:00
Evaluation status changed: "pending" -> "complete"
2016-01-19 23:01:26 +00:00
==> Evaluation "43bfe672" finished with status "complete"
```
2015-09-21 19:05:48 +00:00
Stop the job with ID "job1" and return immediately:
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad job stop -detach job1
2016-01-19 23:01:26 +00:00
507d26cb
```
2020-02-06 23:45:31 +00:00
[eval status]: /docs/commands/eval-status
[multi-region]: /docs/job-specification/multiregion
[`shutdown_delay`]: /docs/job-specification/group#shutdown_delay