github.com/Ilhicas/nomad@v1.0.4-0.20210304152020-e86851182bc3/website/content/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  If ACLs are enabled, this command requires a management token.
    25  
    26  ## General Options
    27  
    28  @include 'general_options_no_namespace.mdx'
    29  
    30  ## List Peers Options
    31  
    32  - `-stale`: The stale argument defaults to "false" which means the leader
    33    provides the result. If the cluster is in an outage state without a leader, you
    34    may need to set `-stale` to "true" to get the configuration from a non-leader
    35    server.
    36  
    37  ## Examples
    38  
    39  An example output with three servers is as follows:
    40  
    41  ```shell-session
    42  $ nomad operator raft list-peers
    43  Node                   ID               Address          State     Voter
    44  nomad-server01.global  10.10.11.5:4647  10.10.11.5:4647  follower  true
    45  nomad-server02.global  10.10.11.6:4647  10.10.11.6:4647  leader    true
    46  nomad-server03.global  10.10.11.7:4647  10.10.11.7:4647  follower  true
    47  ```
    48  
    49  - `Node` is the node name of the server, as known to Nomad, or "(unknown)" if
    50    the node is stale and not known.
    51  
    52  - `ID` is the ID of the server. This is the same as the `Address` but may be
    53    upgraded to a GUID in a future version of Nomad.
    54  
    55  - `Address` is the IP:port for the server.
    56  
    57  - `State` is either "follower" or "leader" depending on the server's role in the
    58    Raft configuration.
    59  
    60  - `Voter` is "true" or "false", indicating if the server has a vote in the Raft
    61    configuration. Future versions of Nomad may add support for non-voting servers.
    62  
    63  [operator]: /api-docs/operator
    64  [outage recovery]: https://learn.hashicorp.com/tutorials/nomad/outage-recovery