open-consul/website/content/commands/members.mdx

58 lines
1.8 KiB
Plaintext
Raw Normal View History

2014-02-08 00:41:03 +00:00
---
layout: commands
2020-04-07 18:55:19 +00:00
page_title: 'Commands: Members'
description: >-
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.
2014-02-08 00:41:03 +00:00
---
# Consul Members
2014-02-08 00:41:03 +00:00
Command: `consul members`
2014-02-08 00:41:03 +00:00
2022-01-11 13:26:58 +00:00
Corresponding HTTP API Endpoint: [\[GET\] /v1/agent/members](/api-docs/agent#list-members)
The `members` command outputs the current list of members that a Consul
2014-02-08 00:41:03 +00:00
agent knows about, along with their state. The state of a node can only
be "alive", "left", or "failed".
2014-02-08 00:41:03 +00:00
Nodes in the "failed" state are still listed because Consul attempts to
2014-02-08 00:41:03 +00:00
reconnect with failed nodes for a certain amount of time in the case
that the failure is actually just a network partition.
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
are not supported from commands, but may be from the corresponding HTTP endpoint.
| ACL Required |
| ------------ |
| `node:read` |
2014-02-08 00:41:03 +00:00
## Usage
Usage: `consul members [options]`
2014-02-08 00:41:03 +00:00
#### Command Options
2014-02-08 00:41:03 +00:00
2020-04-07 18:55:19 +00:00
- `-detailed` - If provided, output shows more detailed information
about each node.
2014-02-08 00:41:03 +00:00
- `-segment` <EnterpriseAlert inline /> - The segment to show members in. If not provided, members
2017-08-31 18:19:08 +00:00
in all segments visible to the agent will be listed.
2020-04-07 18:55:19 +00:00
- `-status` - If provided, output is filtered to only nodes matching
2014-02-08 00:41:03 +00:00
the regular expression for status
2020-04-07 18:55:19 +00:00
- `-wan` - For agents in Server mode, this will return the list of nodes
in the WAN gossip pool. These are generally all the server nodes in
each datacenter.
#### Enterprise Options
@include 'http_api_partition_options.mdx'
#### API Options
@include 'http_api_options_client.mdx'