mirror of https://github.com/status-im/consul.git
51 lines
1.4 KiB
Plaintext
51 lines
1.4 KiB
Plaintext
|
---
|
||
|
|
layout: commands
|
||
|
|
page_title: 'Commands: Peering Exported Services'
|
||
|
|
description: |
|
||
|
|
The `consul peering exported-services` command outputs a list of services exported to a cluster peer.
|
||
|
|
---
|
||
|
|
|
||
|
|
# Consul Peering Exported Services
|
||
|
|
|
||
|
|
Command: `consul peering exported-services`
|
||
|
|
|
||
|
|
Corresponding HTTP API Endpoint: [\[GET\] /v1/peering/:name](/consul/api-docs/peering#read-a-peering-connection)
|
||
|
|
|
||
|
|
The `peering exported-services` command displays all of the services that were exported to the cluster peer using an [`exported-services` configuration entry](/consul/docs/connect/config-entries/exported-services).
|
||
|
|
|
||
|
|
The table below shows this command's [required ACLs](/consul/api-docs/api-structure#authentication).
|
||
|
|
|
||
|
|
| ACL Required |
|
||
|
|
| ------------ |
|
||
|
|
| `peering:read` |
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Usage: `consul peering exported-services [options] -name <peer name>`
|
||
|
|
|
||
|
|
#### Command Options
|
||
|
|
|
||
|
|
- `-name=<string>` - (Required) The name of the peer associated with a connection.
|
||
|
|
|
||
|
|
- `-format={pretty|json}` - Command output format. The default value is `pretty`.
|
||
|
|
|
||
|
|
#### Enterprise Options
|
||
|
|
|
||
|
|
@include 'http_api_partition_options.mdx'
|
||
|
|
|
||
|
|
#### API Options
|
||
|
|
|
||
|
|
@include 'http_api_options_client.mdx'
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
The following example outputs the exported services to a peering connection locally referred to as "cluster-02":
|
||
|
|
|
||
|
|
```shell-session hideClipboard
|
||
|
|
$ consul peering exported-services -name cluster-02
|
||
|
|
backend
|
||
|
|
frontend
|
||
|
|
web
|
||
|
|
```
|
||
|
|
|