open-nomad/website/pages/docs/commands/alloc/stop.mdx

62 lines
1.8 KiB
Plaintext
Raw Normal View History

2019-04-23 11:22:27 +00:00
---
2020-02-06 23:45:31 +00:00
layout: docs
page_title: 'Commands: alloc stop'
sidebar_title: stop
description: |
2019-04-23 11:22:27 +00:00
Stop and reschedule a running allocation
---
2019-06-05 15:09:22 +00:00
# Command: alloc stop
2019-04-23 11:22:27 +00:00
2019-04-24 19:51:26 +00:00
The `alloc stop` command allows a user to perform an in-place restart of an
entire allocation or individual task.
2019-04-23 11:22:27 +00:00
## Usage
```plaintext
2019-04-23 11:22:27 +00:00
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.
2020-02-06 23:45:31 +00:00
Stop will issue a request to stop and reschedule the allocation. An interactive
2019-04-23 11:22:27 +00:00
monitoring session will display log lines as the allocation completes shutting
down. It is safe to exit the monitor early with ctrl-c.
When ACLs are enabled, this command requires a token with the
`alloc-lifecycle`, `read-job`, and `list-jobs` capabilities for the
allocation's namespace.
2019-04-23 11:22:27 +00:00
## General Options
2020-02-06 23:45:31 +00:00
@include 'general_options.mdx'
2019-04-23 11:22:27 +00:00
## Stop Options
- `-detach`: Return immediately instead of entering monitor mode. After the
2020-02-06 23:45:31 +00:00
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.
2019-04-23 11:22:27 +00:00
- `-verbose`: Display verbose output.
2019-04-23 11:22:27 +00:00
## Examples
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad alloc stop c1488bb5
2019-04-23 11:22:27 +00:00
==> 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
```
2020-02-06 23:45:31 +00:00
[eval status]: /docs/commands/eval-status