2014-02-08 00:41:03 +00:00
---
2020-09-01 15:14:13 +00:00
layout: commands
2020-04-07 18:55:19 +00:00
page_title: 'Commands: Leave'
2020-04-13 18:40:26 +00:00
sidebar_title: leave
2020-04-07 18:55:19 +00:00
description: >-
The `leave` command triggers a graceful leave and shutdown of the agent. It is
used to ensure other nodes see the agent as left instead of failed. Nodes that
leave will not attempt to re-join the cluster on restarting with a snapshot.
2014-02-08 00:41:03 +00:00
---
2014-02-19 01:32:13 +00:00
# Consul Leave
2014-02-08 00:41:03 +00:00
2014-02-19 01:32:13 +00:00
Command: `consul leave`
2014-02-08 00:41:03 +00:00
2014-10-19 23:40:10 +00:00
The `leave` command triggers a graceful leave and shutdown of the agent.
It is used to ensure other nodes see the agent as "left" instead of
2014-02-08 00:41:03 +00:00
"failed". Nodes that leave will not attempt to re-join the cluster
on restarting with a snapshot.
2014-02-19 01:32:13 +00:00
For nodes in server mode, the node is removed from the Raft peer set
2014-04-16 04:01:12 +00:00
in a graceful manner. This is critical, as in certain situations a
non-graceful leave can affect cluster availability.
2014-02-19 01:32:13 +00:00
2020-04-07 18:55:19 +00:00
Running `consul leave` on a server explicitly will reduce the quorum size. Even if the cluster used `bootstrap_expect` to set a quorum size initially, issuing `consul leave` on a server will reconfigure the cluster to have fewer servers.
2019-01-25 20:20:48 +00:00
This means you could end up with just one server that is still able to commit writes because quorum is only 1, but those writes might be lost if that server fails before more are added.
2014-02-08 00:41:03 +00:00
## Usage
2017-02-09 21:41:17 +00:00
Usage: `consul leave [options]`
2014-02-08 00:41:03 +00:00
2017-02-09 21:41:17 +00:00
#### API Options
2014-02-08 00:41:03 +00:00
2020-04-07 18:55:19 +00:00
@include 'http_api_options_client.mdx'
