mirror of https://github.com/status-im/consul.git
29 lines
932 B
Plaintext
29 lines
932 B
Plaintext
---
|
|
layout: "docs"
|
|
page_title: "Commands: Leave"
|
|
sidebar_current: "docs-commands-leave"
|
|
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.
|
|
---
|
|
|
|
# Consul Leave
|
|
|
|
Command: `consul leave`
|
|
|
|
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.
|
|
|
|
For nodes in server mode, the node is removed from the Raft peer set
|
|
in a graceful manner. This is critical, as in certain situations a
|
|
non-graceful leave can affect cluster availability.
|
|
|
|
## Usage
|
|
|
|
Usage: `consul leave [options]`
|
|
|
|
#### API Options
|
|
|
|
<%= partial "docs/commands/http_api_options_client" %>
|