open-consul/website/source/docs/commands/force-leave.html.markdown.erb

36 lines
1.3 KiB
Plaintext
Raw Normal View History

2014-02-08 00:41:03 +00:00
---
layout: "docs"
page_title: "Commands: Force Leave"
sidebar_current: "docs-commands-forceleave"
description: |-
The `force-leave` command forces a member of a Consul cluster to enter the left state. If the member is still actually alive, it will eventually rejoin the cluster. The true purpose of this method is to force remove failed nodes.
2014-02-08 00:41:03 +00:00
---
# Consul Force Leave
2014-02-08 00:41:03 +00:00
Command: `consul force-leave`
2014-02-08 00:41:03 +00:00
The `force-leave` command forces a member of a Consul cluster to enter the
"left" state. If the member is still actually alive, it will
2014-02-08 00:41:03 +00:00
eventually rejoin the cluster. The true purpose of this method is to force
remove "failed" nodes.
Consul periodically tries to reconnect to "failed" nodes in case it is a
2014-04-09 18:06:27 +00:00
network partition. After some configured amount of time (by default 72 hours),
Consul will reap "failed" nodes and stop trying to reconnect. The `force-leave`
2014-02-08 00:41:03 +00:00
command can be used to transition the "failed" nodes to "left" nodes more
quickly.
This can be particularly useful for a node that was running as a server,
as it will be removed from the Raft quorum. Note that `force-leave` cannot be
used to force removal of nodes that are outside of the datacenter.
2014-02-08 00:41:03 +00:00
## Usage
Usage: `consul force-leave [options] node`
2014-02-08 00:41:03 +00:00
#### API Options
2014-02-08 00:41:03 +00:00
<%= partial "docs/commands/http_api_options_client" %>
2014-02-08 00:41:03 +00:00