open-consul/website/pages/commands/catalog/services.mdx

68 lines
1.4 KiB
Plaintext
Raw Normal View History

2017-07-14 19:45:08 +00:00
---
layout: commands
2020-04-07 18:55:19 +00:00
page_title: 'Commands: Catalog List Services'
sidebar_title: services
2017-07-14 19:45:08 +00:00
---
# Consul Catalog List Services
Command: `consul catalog services`
The `catalog services` command prints all known services. It can also query
for services that match particular metadata or list the services that a
particular node provides.
## Examples
List all services:
2020-05-19 18:32:38 +00:00
```shell-session
2017-07-14 19:45:08 +00:00
$ consul catalog services
consul
postgresql
redis
```
Show all services with their tags:
2020-05-19 18:32:38 +00:00
```shell-session
2017-07-14 19:45:08 +00:00
$ consul catalog services -tags
consul
postgresql leader
redis primary,v1
```
List services for the node "worker-01":
2020-05-19 18:32:38 +00:00
```shell-session
2017-07-14 19:45:08 +00:00
$ consul catalog services -node=worker-01
consul
redis
```
## Usage
Usage: `consul catalog services [options]`
#### API Options
2020-04-07 18:55:19 +00:00
@include 'http_api_options_client.mdx'
2020-04-07 23:56:08 +00:00
2020-04-07 18:55:19 +00:00
@include 'http_api_options_server.mdx'
2017-07-14 19:45:08 +00:00
#### Enterprise Options
2020-04-07 18:55:19 +00:00
@include 'http_api_namespace_options.mdx'
2017-07-14 19:45:08 +00:00
#### Catalog List Nodes Options
- `-node=<id or name>` - Node `id or name` for which to list services.
- `-node-meta=<key=value>` - Metadata to filter nodes with the given
`key=value` pairs. If specified, only services running on nodes matching the
given metadata will be returned. This flag may be specified multiple times to
filter on multiple sources of metadata.
- `-tags` - Display each service's tags as a comma-separated list beside each
service entry.