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

47 lines
1.1 KiB
Plaintext
Raw Normal View History

---
layout: "docs"
page_title: "Commands: node-drain"
sidebar_current: "docs-commands-node-drain"
description: >
Toggle drain mode for a given node.
---
2015-09-15 03:24:04 +00:00
# Command: node-drain
The `node-drain` command is used to toggle drain mode on a given node. Drain
2015-09-15 20:52:02 +00:00
mode prevents any new tasks from being allocated to the node, and begins
migrating all existing allocations away.
2015-09-15 03:24:04 +00:00
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>
```
A node ID or prefix must be provided. If there is an exact match, the
drain mode will be adjusted for that node. Otherwise, a list of matching
nodes and information will be displayed.
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.
2015-09-15 03:24:04 +00:00
## Examples
Enable drain mode on node1:
```
$ nomad node-drain -enable node1
2015-09-15 03:24:04 +00:00
```