summaryrefslogtreecommitdiff
path: root/devdocs/docker/engine%2Freference%2Fcommandline%2Fnode_rm%2Findex.html
blob: d747fce24a4983dfd5a900dfe69164eb74439b03 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<h1>docker node rm</h1>  <p><br></p> <p>Remove one or more nodes from the swarm</p> <p><span class="badge badge-info" data-toggle="tooltip" data-placement="right" title="This command works with the Swarm orchestrator.">Swarm</span> This command works with the Swarm orchestrator.</p> <h2 id="usage">Usage</h2> <div class="highlight"><pre class="highlight" data-language="">$ docker node rm [OPTIONS] NODE [NODE...]
</pre></div> <p>Refer to the <a href="#options">options section</a> for an overview of available <a href="#options"><code class="language-plaintext highlighter-rouge">OPTIONS</code></a> for this command.</p> <h2 id="description">Description</h2> <p name="extended-description">Removes the specified nodes from a swarm.</p> <blockquote> <p><strong>Note</strong></p> <p>This is a cluster management command, and must be executed on a swarm manager node. To learn about managers and workers, refer to the <a href="../../../swarm/index">Swarm mode section</a> in the documentation.</p> </blockquote> <p>For example uses of this command, refer to the <a href="#examples">examples section</a> below.</p> <h2 id="options">Options</h2> <table> <thead> <tr> <td>Name, shorthand</td> <td>Default</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td>
<code class="language-plaintext highlighter-rouge">--force</code> , <code class="language-plaintext highlighter-rouge">-f</code>
</td> <td></td> <td>Force remove a node from the swarm</td> </tr>  </tbody> </table>  <h2 id="examples">Examples</h2> <h3 id="remove-a-stopped-node-from-the-swarm">Remove a stopped node from the swarm</h3> <div class="highlight"><pre class="highlight" data-language="">$ docker node rm swarm-node-02

Node swarm-node-02 removed from swarm
</pre></div> <h3 id="attempt-to-remove-a-running-node-from-a-swarm">Attempt to remove a running node from a swarm</h3> <p>Removes the specified nodes from the swarm, but only if the nodes are in the down state. If you attempt to remove an active node you will receive an error:</p> <pre data-language="">$ docker node rm swarm-node-03

Error response from daemon: rpc error: code = 9 desc = node swarm-node-03 is not
down and can't be removed
</pre> <h3 id="forcibly-remove-an-inaccessible-node-from-a-swarm">Forcibly remove an inaccessible node from a swarm</h3> <p>If you lose access to a worker node or need to shut it down because it has been compromised or is not behaving as expected, you can use the <code class="language-plaintext highlighter-rouge">--force</code> option. This may cause transient errors or interruptions, depending on the type of task being run on the node.</p> <div class="highlight"><pre class="highlight" data-language="">$ docker node rm --force swarm-node-03

Node swarm-node-03 removed from swarm
</pre></div> <p>A manager node must be demoted to a worker node (using <code class="language-plaintext highlighter-rouge">docker node demote</code>) before you can remove it from the swarm.</p> <h2 id="parent-command">Parent command</h2> <table> <thead> <tr> <th style="text-align: left">Command</th> <th style="text-align: left">Description</th> </tr> </thead> <tbody> <tr> <td style="text-align: left"><a href="../node/index">docker node</a></td> <td style="text-align: left">Manage Swarm nodes</td> </tr> </tbody> </table> <h2 id="related-commands">Related commands</h2> <table> <thead> <tr> <td>Command</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td><a href="../node_demote/index">docker node demote</a></td> <td>Demote one or more nodes from manager in the swarm</td> </tr> <tr> <td><a href="../node_inspect/index">docker node inspect</a></td> <td>Display detailed information on one or more nodes</td> </tr> <tr> <td><a href="../node_ls/index">docker node ls</a></td> <td>List nodes in the swarm</td> </tr> <tr> <td><a href="../node_promote/index">docker node promote</a></td> <td>Promote one or more nodes to manager in the swarm</td> </tr> <tr> <td><a href="../node_ps/index">docker node ps</a></td> <td>List tasks running on one or more nodes, defaults to current node</td> </tr> <tr> <td><a href="index">docker node rm</a></td> <td>Remove one or more nodes from the swarm</td> </tr> <tr> <td><a href="../node_update/index">docker node update</a></td> <td>Update a node</td> </tr> </tbody> </table> <div class="_attribution">
  <p class="_attribution-p">
    &copy; 2019 Docker, Inc.<br>Licensed under the Apache License, Version 2.0.<br>Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries.<br>Docker, Inc. and other parties may also have trademark rights in other terms used herein.<br>
    <a href="https://docs.docker.com/engine/reference/commandline/node_rm/" class="_attribution-link">https://docs.docker.com/engine/reference/commandline/node_rm/</a>
  </p>
</div>