2014-02-08 00:41:03 +00:00
---
layout: "docs"
page_title: "Commands: Force Leave"
sidebar_current: "docs-commands-forceleave"
2014-10-19 23:40:10 +00:00
description: |-
The `force-leave` command forces a member of a Consul cluster to enter the left state. Note that 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
---
2014-02-19 01:32:13 +00:00
# Consul Force Leave
2014-02-08 00:41:03 +00:00
2014-02-19 01:32:13 +00:00
Command: `consul force-leave`
2014-02-08 00:41:03 +00:00
2014-02-19 01:32:13 +00:00
The `force-leave` command forces a member of a Consul cluster to enter the
2014-02-08 00:41:03 +00:00
"left" state. Note that 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-19 01:32:13 +00:00
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),
2014-02-19 01:32:13 +00:00
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.
2014-02-19 01:32:13 +00:00
This can be particularly useful for a node that was running as a server,
as it will be removed from the Raft quorum.
2014-02-08 00:41:03 +00:00
## Usage
2014-02-19 01:32:13 +00:00
Usage: `consul force-leave [options] node`
2014-02-08 00:41:03 +00:00
The following command-line options are available for this command.
Every option is optional:
* `-rpc-addr` - Address to the RPC server of the agent you want to contact
2014-12-15 18:16:43 +00:00
to send this command. If this isn't specified, the command checks the
CONSUL_RPC_ADDR env variable. If this isn't set, the default RPC
address will be set to "127.0.0.1:8400".
2014-02-08 00:41:03 +00:00
