open-nomad/website/source/docs/commands/server-members.html.md.erb

53 lines
1.4 KiB
Plaintext
Raw Normal View History

2015-09-15 01:04:56 +00:00
---
layout: "docs"
page_title: "Commands: server-members"
sidebar_current: "docs-commands-server-members"
2015-09-15 01:04:56 +00:00
description: >
Display a list of the known server members and their status.
2015-09-15 01:04:56 +00:00
---
# Command: server-members
2015-09-15 01:04:56 +00:00
The `server-members` command displays a list of the known servers in the cluster
2015-09-15 01:04:56 +00:00
and their current status. Member information is provided by the gossip protocol,
which is only run on server nodes.
~> **Only runs on servers!** This command can only be run from the server nodes.
Running <tt>nomad server-members</tt> from a client will result in an error.
2015-09-15 01:04:56 +00:00
## Usage
```
nomad server-members [options]
2015-09-15 01:04:56 +00:00
```
## General Options
<%= general_options_usage %>
2015-09-15 01:04:56 +00:00
2016-08-09 13:56:26 +00:00
## Server Members Options
2015-09-15 01:04:56 +00:00
* `-detailed`: Dump the basic member information as well as the raw set of tags
for each member. This mode reveals additional information not displayed in the
standard output format.
2015-09-15 03:24:04 +00:00
## Examples
Default view:
2015-09-15 01:04:56 +00:00
```
$ nomad server-members
2015-09-15 01:04:56 +00:00
Name Addr Port Status Proto Build DC Region
node1.global 10.0.0.8 4648 alive 2 0.1.0dev dc1 global
node2.global 10.0.0.9 4648 alive 2 0.1.0dev dc1 global
```
2015-09-15 03:24:04 +00:00
Detailed view:
```
$ nomad server-members -detailed
2015-09-15 03:24:04 +00:00
Name Addr Port Tags
node1 10.0.0.8 4648 bootstrap=1,build=0.1.0dev,vsn=1,vsn_max=1,dc=dc1,port=4647,region=global,role=nomad,vsn_min=1
node2 10.0.0.9 4648 bootstrap=0,build=0.1.0dev,vsn=1,vsn_max=1,dc=dc1,port=4647,region=global,role=nomad,vsn_min=1
```