open-nomad/website/source/docs/commands/stop.html.md.erb

55 lines
1.4 KiB
Plaintext
Raw Normal View History

---
layout: "docs"
page_title: "Commands: stop"
sidebar_current: "docs-commands-stop"
description: >
The stop command is used to stop a running job.
---
# Command: stop
The `stop` command is used to stop a running job and signals the scheduler
to cancel all of the running allocations.
## Usage
```
nomad stop [options] <job>
```
The stop command requires a single argument, specifying the job ID to
cancel.
Upon successful deregistraion, an interactive monitor session will start to
display log lines as the job unwinds its allocations and completes shutting
down. The monitor will exit once all allocations are stopped and the job has
reached a terminal state. It is safe to exit the monitor early using ctrl+c.
## General Options
<%= general_options_usage %>
## Stop Options
* `-detach`: Return immediately instead of monitoring. A new evaluation ID
will be output, which can be used to call the monitor later using the
[eval-monitor](/docs/commands/eval-monitor.html) command.
## Examples
2015-09-21 19:05:48 +00:00
Stop the job with ID "job1":
```
2015-09-21 19:05:48 +00:00
$ nomad stop job1
==> Monitoring evaluation "43bfe672-e9a2-1cb8-457a-4c2dca5ce1c7"
Evaluation status changed: "pending" -> "complete"
==> Evaluation "43bfe672-e9a2-1cb8-457a-4c2dca5ce1c7" finished with status "complete"
```
2015-09-21 19:05:48 +00:00
Stop the job with ID "job1" and return immediately:
```
2015-09-21 19:05:48 +00:00
$ nomad stop -detach job1
507d26cb-1d67-672c-da9d-f6053837bb70
```