github.com/outbrain/consul@v1.4.5/website/source/docs/commands/members.html.markdown.erb (about)

     1  ---
     2  layout: "docs"
     3  page_title: "Commands: Members"
     4  sidebar_current: "docs-commands-members"
     5  description: |-
     6    The `members` command outputs the current list of members that a Consul agent knows about, along with their state. The state of a node can only be alive, left, or failed.
     7  ---
     8  
     9  # Consul Members
    10  
    11  Command: `consul members`
    12  
    13  The `members` command outputs the current list of members that a Consul
    14  agent knows about, along with their state. The state of a node can only
    15  be "alive", "left", or "failed".
    16  
    17  Nodes in the "failed" state are still listed because Consul attempts to
    18  reconnect with failed nodes for a certain amount of time in the case
    19  that the failure is actually just a network partition.
    20  
    21  ## Usage
    22  
    23  Usage: `consul members [options]`
    24  
    25  #### API Options
    26  
    27  <%= partial "docs/commands/http_api_options_client" %>
    28  
    29  #### Command Options
    30  
    31  * `-detailed` - If provided, output shows more detailed information
    32    about each node.
    33  
    34  * `-segment` - (Enterprise-only) The segment to show members in. If not provided, members
    35    in all segments visible to the agent will be listed.
    36  
    37  * `-status` - If provided, output is filtered to only nodes matching
    38    the regular expression for status
    39  
    40  * `-wan` - For agents in Server mode, this will return the list of nodes
    41    in the WAN gossip pool. These are generally all the server nodes in
    42    each datacenter.
    43