2017-07-25 18:18:21 +00:00
|
|
|
---
|
2020-02-06 23:45:31 +00:00
|
|
|
layout: docs
|
|
|
|
|
page_title: 'Commands: deployment pause'
|
2017-07-25 18:18:21 +00:00
|
|
|
description: >
|
|
|
|
|
The deployment pause command is used to pause a deployment and disallow new
|
|
|
|
|
placements.
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Command: deployment pause
|
|
|
|
|
|
|
|
|
|
The `deployment pause` command is used to pause a deployment. Pausing a
|
|
|
|
|
deployment will pause the placement of new allocations as part of rolling
|
|
|
|
|
deployment.
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
```plaintext
|
2017-07-25 18:18:21 +00:00
|
|
|
nomad deployment pause [options] <deployment id>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The `deployment pause` command requires a single argument, a deployment ID or
|
2019-10-22 13:44:00 +00:00
|
|
|
prefix.
|
2017-07-25 18:18:21 +00:00
|
|
|
|
2020-11-19 21:38:08 +00:00
|
|
|
When ACLs are enabled, this command requires a token with the `submit-job`
|
|
|
|
|
and `read-job` capabilities for the deployment's namespace.
|
|
|
|
|
|
2017-07-25 18:18:21 +00:00
|
|
|
## General Options
|
|
|
|
|
|
2020-02-06 23:45:31 +00:00
|
|
|
@include 'general_options.mdx'
|
2017-07-25 18:18:21 +00:00
|
|
|
|
|
|
|
|
## Pause Options
|
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
- `-verbose`: Show full information.
|
2017-07-25 18:18:21 +00:00
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
|
Manually pause a deployment:
|
|
|
|
|
|
2020-05-18 20:53:06 +00:00
|
|
|
```shell-session
|
|
|
|
|
$ nomad deployment pause 2f14ba55
|
2017-07-25 18:18:21 +00:00
|
|
|
Deployment "2f14ba55-acfb-cb31-821c-facf1b9b0830" paused
|
|
|
|
|
```
|
