open-nomad/website/pages/docs/commands/alloc/stop.mdx
Jeff Escalante 6c8f079d24
new website
2020-02-06 18:45:31 -05:00

58 lines
1.6 KiB
Plaintext

---
layout: docs
page_title: 'Commands: alloc stop'
sidebar_title: stop
description: |
Stop and reschedule a running allocation
---
# Command: alloc stop
The `alloc stop` command allows a user to perform an in-place restart of an
entire allocation or individual task.
## Usage
```plaintext
nomad alloc stop [options] <allocation>
```
The `alloc stop` command requires a single argument, specifying the alloc ID or
prefix to stop. If there is an exact match based on the provided alloc ID or
prefix, then the alloc will be stopped and rescheduled. Otherwise, a list of
matching allocs and information will be displayed.
Stop will issue a request to stop and reschedule the allocation. An interactive
monitoring session will display log lines as the allocation completes shutting
down. It is safe to exit the monitor early with ctrl-c.
## General Options
@include 'general_options.mdx'
## Stop Options
- `-detach`: Return immediately instead of entering monitor mode. After the
stop command is submitted, a new evaluation ID is printed to the
screen, which can be used to examine the rescheduling evaluation using the
[eval status] command.
- `-verbose`: Display verbose output.
## Examples
```shell
$ nomad alloc stop c1488bb5
==> Monitoring evaluation "26172081"
Evaluation triggered by job "example"
Allocation "4dcb1c98" created: node "b4dc52b9", group "cache"
Evaluation within deployment: "c0c594d0"
Evaluation status changed: "pending" -> "complete"
==> Evaluation "26172081" finished with status "complete"
$ nomad alloc stop -detach eb17e557
8a91f0f3-9d6b-ac83-479a-5aa186ab7795
```
[eval status]: /docs/commands/eval-status