luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Document /v1/agent/force-leave prune and wan params (#11886) 

Document prune parameter added in #6571 and wan parameter added in
#11722.

Co-authored-by: Freddy <freddygv@users.noreply.github.com>
This commit is contained in:
Blake Covarrubias 2021-12-20 15:56:13 -08:00 committed by GitHub
parent 0eb6334b2d
commit 80ce6b54e2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
website/content/api-docs/agent/index.mdx
View File

@ -679,8 +679,8 @@ $ curl \
## Force Leave and Shutdown
This endpoint instructs the agent to force a node into the `left` state. If a
node fails unexpectedly, then it will be in a `failed` state. Once in the
This endpoint instructs the agent to force a node into the `left` state in the
LAN and WAN gossip pools. If a node fails unexpectedly, then it will be in a `failed` state. Once in the
`failed` state, Consul will attempt to reconnect, and the services and checks
belonging to that node will not be cleaned up. Forcing a node into the `left`
state allows its old entries to be removed.
@ -710,6 +710,14 @@ The table below shows this endpoint's support for
- `node` `(string: <required>)` - Specifies the name of the node to be forced into `left` state. This is specified as part of the URL.
- `prune` `(bool: false)` - Specifies whether to forcibly remove the node from the list of members.
Pruning a node in the `left` or `failed` state removes it from the list altogether.
This is specified as part of the URL as a query parameter. Added in Consul 1.6.2.
- `wan` `(bool: false)` - Specifies the node should only be removed from the WAN
gossip pool. This is specified as part of the URL as a query parameter. Added
in Consul 1.11.0.
### Sample Request
```shell-session

5
website/content/commands/force-leave.mdx
View File

@ -61,4 +61,7 @@ consul force-leave server1.us-east1
#### Command Options
- `-prune` - Removes failed or left agent from the list of
members entirely
members entirely. Added in Consul 1.6.2.
- `-wan` - Exclusively leave the agent from the WAN gossip pool. Added in Consul
1.11.0.