github.com/iqoqo/nomad@v0.11.3-0.20200911112621-d7021c74d101/website/pages/docs/commands/operator/raft-list-peers.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: operator raft list-peers'
     4  sidebar_title: raft list-peers
     5  description: |
     6    Display the current Raft peer configuration.
     7  ---
     8  
     9  # Command: operator raft list-peers
    10  
    11  The Raft list-peers command is used to display the current Raft peer
    12  configuration.
    13  
    14  See the [Outage Recovery] guide for some examples of how this command is used.
    15  For an API to perform these operations programmatically, please see the
    16  documentation for the [Operator] endpoint.
    17  
    18  ## Usage
    19  
    20  ```plaintext
    21  nomad operator raft list-peers [options]
    22  ```
    23  
    24  ## General Options
    25  
    26  @include 'general_options.mdx'
    27  
    28  ## List Peers Options
    29  
    30  - `-stale`: The stale argument defaults to "false" which means the leader
    31    provides the result. If the cluster is in an outage state without a leader, you
    32    may need to set `-stale` to "true" to get the configuration from a non-leader
    33    server.
    34  
    35  ## Examples
    36  
    37  An example output with three servers is as follows:
    38  
    39  ```shell-sessionnomad operator raft list-peers
    40  Node                   ID               Address          State     Voter
    41  nomad-server01.global  10.10.11.5:4647  10.10.11.5:4647  follower  true
    42  nomad-server02.global  10.10.11.6:4647  10.10.11.6:4647  leader    true
    43  nomad-server03.global  10.10.11.7:4647  10.10.11.7:4647  follower  true
    44  ```
    45  
    46  - `Node` is the node name of the server, as known to Nomad, or "(unknown)" if
    47    the node is stale and not known.
    48  
    49  - `ID` is the ID of the server. This is the same as the `Address` but may be
    50    upgraded to a GUID in a future version of Nomad.
    51  
    52  - `Address` is the IP:port for the server.
    53  
    54  - `State` is either "follower" or "leader" depending on the server's role in the
    55    Raft configuration.
    56  
    57  - `Voter` is "true" or "false", indicating if the server has a vote in the Raft
    58    configuration. Future versions of Nomad may add support for non-voting servers.
    59  
    60  [operator]: /api-docs/operator
    61  [outage recovery]: https://learn.hashicorp.com/nomad/operating-nomad/outage