Command: operator raft list-peers
raft list-peers command is used to display the current Raft peer
See the Outage Recovery guide for some examples of how this command is used. For an API to perform these operations programmatically, please see the documentation for the Operator endpoint.
nomad operator raft list-peers [options]
If ACLs are enabled, this command requires a management token.
-address=<addr>: The address of the Nomad server. Overrides the
NOMAD_ADDRenvironment variable if set. Defaults to
-region=<region>: The region of the Nomad server to forward commands to. Overrides the
NOMAD_REGIONenvironment variable if set. Defaults to the Agent's local region.
-no-color: Disables colored command output. Alternatively,
NOMAD_CLI_NO_COLORmay be set. This option takes precedence over
-force-color: Forces colored command output. This can be used in cases where the usual terminal detection fails. Alternatively,
NOMAD_CLI_FORCE_COLORmay be set. This option has no effect if
-no-coloris also used.
-ca-cert=<path>: Path to a PEM encoded CA cert file to use to verify the Nomad server SSL certificate. Overrides the
NOMAD_CACERTenvironment variable if set.
-ca-path=<path>: Path to a directory of PEM encoded CA cert files to verify the Nomad server SSL certificate. If both
-ca-certis used. Overrides the
NOMAD_CAPATHenvironment variable if set.
-client-cert=<path>: Path to a PEM encoded client certificate for TLS authentication to the Nomad server. Must also specify
-client-key. Overrides the
NOMAD_CLIENT_CERTenvironment variable if set.
-client-key=<path>: Path to an unencrypted PEM encoded private key matching the client certificate from
-client-cert. Overrides the
NOMAD_CLIENT_KEYenvironment variable if set.
-tls-server-name=<value>: The server name to use as the SNI host when connecting via TLS. Overrides the
NOMAD_TLS_SERVER_NAMEenvironment variable if set.
-tls-skip-verify: Do not verify TLS certificate. This is highly not recommended. Verification will also be skipped if
-token: The SecretID of an ACL token to use to authenticate API requests with. Overrides the
NOMAD_TOKENenvironment variable if set.
List Peers Options
-stale: The stale argument defaults to "false" which means the leader provides the result. If the cluster is in an outage state without a leader, you may need to set
-staleto "true" to get the configuration from a non-leader server.
An example output with three servers is as follows:
$ nomad operator raft list-peers Node ID Address State Voter nomad-server01.global 10.10.11.5:4647 10.10.11.5:4647 follower true nomad-server02.global 10.10.11.6:4647 10.10.11.6:4647 leader true nomad-server03.global 10.10.11.7:4647 10.10.11.7:4647 follower true
Nodeis the node name of the server, as known to Nomad, or "(unknown)" if the node is stale and not known.
IDis the ID of the server. This is the same as the
Addressbut may be upgraded to a GUID in a future version of Nomad.
Addressis the IP:port for the server.
Stateis either "follower" or "leader" depending on the server's role in the Raft configuration.
Voteris "true" or "false", indicating if the server has a vote in the Raft configuration. Future versions of Nomad may add support for non-voting servers.