diff options
| author | Misty Stanley-Jones <misty@apache.org> | 2017-04-03 16:54:34 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-04-03 16:54:34 -0700 |
| commit | 473c5701cb66403b0535a5c01845cb0f27fbeb47 (patch) | |
| tree | 9a40326ad4b426655abca7377dc30da003847d4d /docs/reference/commandline/node_rm.md | |
| parent | ce07fb6b0f1b8765b92022e45f96bd4349812e06 (diff) | |
| parent | 71e6babfa2598669218177b5b429e873b7f35e8f (diff) | |
| download | docker-1.13.x.tar.gz | |
Merge pull request #32332 from mstanleyjones/1.13.x1.13.x
Cherry-pick command-line ref improvements
Diffstat (limited to 'docs/reference/commandline/node_rm.md')
| -rw-r--r-- | docs/reference/commandline/node_rm.md | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/docs/reference/commandline/node_rm.md b/docs/reference/commandline/node_rm.md index b245d636cc..c2fdd4d156 100644 --- a/docs/reference/commandline/node_rm.md +++ b/docs/reference/commandline/node_rm.md @@ -28,33 +28,40 @@ Options: --help Print usage ``` +## Description + When run from a manager node, removes the specified nodes from a swarm. -Example output: +## Examples + +### Remove a stopped node from the swarm -```nohighlight +```bash $ docker node rm swarm-node-02 Node swarm-node-02 removed from swarm ``` +### Attempt to remove a running node from a swarm 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: -```nohighlight +```non $ 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 ``` +### Forcibly remove an inaccessible node from a swarm + 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 `--force` option. This may cause transient errors or interruptions, depending on the type of task being run on the node. -```nohighlight +```bash $ docker node rm --force swarm-node-03 Node swarm-node-03 removed from swarm @@ -63,7 +70,7 @@ Node swarm-node-03 removed from swarm A manager node must be demoted to a worker node (using `docker node demote`) before you can remove it from the swarm. -## Related information +## Related commands * [node demote](node_demote.md) * [node inspect](node_inspect.md) |