open-nomad/website/source/docs/commands/operator/raft-remove-peer.html.md.erb
2018-01-16 13:35:32 -08:00

44 lines
1.4 KiB
Plaintext

---
layout: "docs"
page_title: "Commands: operator raft remove-peer"
sidebar_current: "docs-commands-operator-raft-remove-peer"
description: >
Remove a Nomad server from the Raft configuration.
---
# Command: `operator raft remove-peer`
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
quorum. If the server still shows in the output of the [`nomad
server-members`](/docs/commands/server-members.html) command, it is preferable
to clean up by simply running [`nomad
server-force-leave`](/docs/commands/server-force-leave.html) instead of this
command.
See the [Outage Recovery](/guides/outage.html) guide for some examples of how
this command is used. For an API to perform these operations programatically,
please see the documentation for the [Operator](/api/operator.html)
endpoint.
## Usage
```
nomad operator raft remove-peer [options]
```
## General Options
<%= partial "docs/commands/_general_options" %>
## Remove Peer Options
* `-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"