mirror of
https://github.com/kemko/nomad.git
synced 2026-01-06 02:15:43 +03:00
44 lines
1009 B
Plaintext
44 lines
1009 B
Plaintext
---
|
|
layout: "docs"
|
|
page_title: "Commands: node-drain"
|
|
sidebar_current: "docs-commands-node-drain"
|
|
description: >
|
|
Toggle drain mode for a given node.
|
|
---
|
|
|
|
# Command: node-drain
|
|
|
|
The `node-drain` command is used to toggle drain mode on a given node. Drain
|
|
mode prevents any new tasks from being allocated to the node, and begins
|
|
migrating all existing allocations away.
|
|
|
|
The [node-status](/docs/commands/node-status.html) command compliments this
|
|
nicely by providing the current drain status of a given node.
|
|
|
|
## Usage
|
|
|
|
```
|
|
nomad node-drain [options] <node>
|
|
```
|
|
|
|
This command expects exactly one argument to specify the node ID (prefix)
|
|
to enable or disable drain mode for. It is also required to pass one of
|
|
`-enable` or `-disable`, depending on which operation is desired.
|
|
|
|
## General Options
|
|
|
|
<%= general_options_usage %>
|
|
|
|
## Node Drain Options
|
|
|
|
* `-enable`: Enable node drain mode.
|
|
* `-disable`: Disable node drain mode.
|
|
|
|
## Examples
|
|
|
|
Enable drain mode on node1:
|
|
|
|
```
|
|
$ nomad node-drain -enable node1
|
|
```
|