HashiConf 2024 Now streaming live from Boston! Attend for free
Consul
Consul Home

You are viewing documentation for version v1.17.x. View latest version.

Consul Exported Services

Command: consul services exported-services

Corresponding HTTP API Endpoint: [GET] /v1/exported-services

The exported-services command displays the services that were exported using an exported-services configuration entry. Sameness groups and wildcards in the configuration entry are expanded in the response.

The table below shows this command's required ACLs.

ACL Required
mesh:read or operator:read

Usage

Usage: consul services exported-services [options]

Command Options

  • -format={pretty|json} - Command output format. The default value is pretty.

  • -filter - Specifies an expression to use for filtering the results. Consumers.Peers and `Consumers.Partitions' selectors are supported.

Enterprise Options

  • -partition=<string> - Specifies the partition to query. If not provided, the partition will be inferred from the request's ACL token, or will default to the default partition. Partitions are a Consul Enterprise feature added in v1.11.0.

API Options

  • -ca-file=<value> - Path to a CA file to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CACERT environment variable.

  • -ca-path=<value> - Path to a directory of CA certificates to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CAPATH environment variable.

  • -client-cert=<value> - Path to a client cert file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_CERT environment variable.

  • -client-key=<value> - Path to a client key file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_KEY environment variable.

  • -http-addr=<addr> - Address of the Consul agent with the port. This can be an IP address or DNS address, but it must include the port. This can also be specified via the CONSUL_HTTP_ADDR environment variable. In Consul 0.8 and later, the default value is http://127.0.0.1:8500, and https can optionally be used instead. The scheme can also be set to HTTPS by setting the environment variable CONSUL_HTTP_SSL=true. This may be a unix domain socket using unix:///path/to/socket if the agent is configured to listen that way.

  • -tls-server-name=<value> - The server name to use as the SNI host when connecting via TLS. This can also be specified via the CONSUL_TLS_SERVER_NAME environment variable.

  • -token=<value> - ACL token to use in the request. This can also be specified via the CONSUL_HTTP_TOKEN environment variable. If unspecified, the query will default to the token of the Consul agent at the HTTP address.

  • -token-file=<value> - File containing the ACL token to use in the request instead of one specified via the -token argument or CONSUL_HTTP_TOKEN environment variable. This can also be specified via the CONSUL_HTTP_TOKEN_FILE environment variable.

Examples

To list all exported services and consumers:

$ consul services exported-services
Service   Consumer Peers
backend   east, west
db        west
frontend  east, east-eu
web       east

The following lists exported services with a filter expression:

$ consul services exported-services -filter='"west" in Consumers.Peers'
Service  Consumer Peers
backend  east, west
db       west