github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/commands/operator/raft/remove-peer.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: operator raft remove-peer'
     4  description: |
     5    Remove a Nomad server from the Raft configuration.
     6  ---
     7  
     8  # Command: operator raft remove-peer
     9  
    10  Remove the Nomad server with given address from the Raft configuration.
    11  
    12  There are rare cases where a peer may be left behind in the Raft quorum even
    13  though the server is no longer present and known to the cluster. This command
    14  can be used to remove the failed server so that it is no longer affects the Raft
    15  quorum. If the server still shows in the output of the [`nomad server members`]
    16  command, it is preferable to clean up by running [`nomad server force-leave`]
    17  instead of this command.
    18  
    19  See the [Outage Recovery] guide for some examples of how this command is used.
    20  For an API to perform these operations programmatically, please see the
    21  documentation for the [Operator] endpoint.
    22  
    23  ## Usage
    24  
    25  ```plaintext
    26  nomad operator raft remove-peer [options]
    27  ```
    28  
    29  If ACLs are enabled, this command requires a management token.
    30  
    31  ## General Options
    32  
    33  @include 'general_options_no_namespace.mdx'
    34  
    35  ## Remove Peer Options
    36  
    37  - `-peer-address`: Remove a Nomad server with given address from the Raft
    38    configuration. The format is "IP:port"
    39  
    40  - `-peer-id`: Remove a Nomad server with the given ID from the Raft
    41    configuration. The format is "id"
    42  
    43  [`nomad server force-leave`]: /docs/commands/server/force-leave 'Nomad server force-leave command'
    44  [`nomad server members`]: /docs/commands/server/members 'Nomad server members command'
    45  [operator]: /api-docs/operator 'Nomad Operator API'
    46  [outage recovery]: https://learn.hashicorp.com/tutorials/nomad/outage-recovery