catalog command is used to interact with Consul's catalog via the command
line. It exposes top-level commands for reading and filtering data from the
The catalog is also accessible via the HTTP API.
List all datacenters:
$ consul catalog datacenters dc1 dc2 dc3
List all nodes:
$ consul catalog nodes Node ID Address DC worker-01 1b662d97 10.4.5.31 dc1
List all nodes which provide a particular service:
$ consul catalog nodes -service=redis Node ID Address DC worker-01 1b662d97 10.4.5.31 dc1 worker-02 d407a592 10.4.4.158 dc1
List all services:
$ consul catalog services consul postgresql redis
List all services on a node:
$ consul catalog services -node=worker-01 consul postgres
For more examples, ask for subcommand help or view the subcommand documentation by clicking on one of the links in the sidebar.
consul catalog <subcommand>
For the exact documentation for your Consul version, run
consul catalog -h to
view the complete list of subcommands.
Usage: consul catalog <subcommand> [options] [args] # ... Subcommands: datacenters Lists all known datacenters for this agent nodes Lists all nodes in the given datacenter services Lists all registered services in a datacenter
For more information, examples, and usage about a subcommand, click on the name of the subcommand in the sidebar or one of the links below: