2017-02-10 01:58:20 +00:00
|
|
|
---
|
2020-02-06 23:45:31 +00:00
|
|
|
layout: docs
|
|
|
|
page_title: 'Commands: operator raft remove-peer'
|
|
|
|
sidebar_title: raft remove-peer
|
|
|
|
description: |
|
2017-02-10 01:58:20 +00:00
|
|
|
Remove a Nomad server from the Raft configuration.
|
|
|
|
---
|
|
|
|
|
2018-03-22 20:39:18 +00:00
|
|
|
# Command: operator raft remove-peer
|
2017-02-10 01:58:20 +00:00
|
|
|
|
|
|
|
Remove the Nomad server with given address from the Raft configuration.
|
|
|
|
|
|
|
|
There are rare cases where a peer may be left behind in the Raft quorum even
|
|
|
|
though the server is no longer present and known to the cluster. This command
|
|
|
|
can be used to remove the failed server so that it is no longer affects the Raft
|
2019-10-22 13:44:00 +00:00
|
|
|
quorum. If the server still shows in the output of the [`nomad server members`]
|
|
|
|
command, it is preferable to clean up by running [`nomad server force-leave`]
|
|
|
|
instead of this command.
|
2017-02-10 01:58:20 +00:00
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
See the [Outage Recovery] guide for some examples of how this command is used.
|
|
|
|
For an API to perform these operations programmatically, please see the
|
|
|
|
documentation for the [Operator] endpoint.
|
2017-02-10 01:58:20 +00:00
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
```plaintext
|
2017-02-10 01:58:20 +00:00
|
|
|
nomad operator raft remove-peer [options]
|
|
|
|
```
|
|
|
|
|
|
|
|
## General Options
|
|
|
|
|
2020-02-06 23:45:31 +00:00
|
|
|
@include 'general_options.mdx'
|
2017-02-10 01:58:20 +00:00
|
|
|
|
|
|
|
## Remove Peer Options
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
- `-peer-address`: Remove a Nomad server with given address from the Raft
|
|
|
|
configuration. The format is "IP:port"
|
|
|
|
|
|
|
|
- `-peer-id`: Remove a Nomad server with the given ID from the Raft
|
|
|
|
configuration. The format is "id"
|
2018-01-16 21:35:32 +00:00
|
|
|
|
2020-02-06 23:45:31 +00:00
|
|
|
[`nomad server force-leave`]: /docs/commands/server/force-leave 'Nomad server force-leave command'
|
|
|
|
[`nomad server members`]: /docs/commands/server/members 'Nomad server members command'
|
2020-03-20 22:24:56 +00:00
|
|
|
[operator]:/1/api-docs/operator 'Nomad Operator API'
|
2020-03-20 21:00:59 +00:00
|
|
|
[outage recovery]: https://learn.hashicorp.com/nomad/operating-nomad/outage
|