status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
consul/website/content/commands/peering/list.mdx

50 lines
1.3 KiB
Plaintext
Raw Normal View History

feat(cli): add initial peering cli commands
2022-08-31 16:58:41 +00:00
---
layout: commands
page_title: 'Commands: Peering List'
docs: CLI page descriptions for automated checker (#16056) * ACL * ACL * Catalog * consul config * consul connect * top-level updates * consul intention * consul kv * consul namespace * consul peering * consul peering delete * consul services * consul snapshot * consul tls * consul acl auth-method * acl binding-rule * acl policy * acl role * acl token * fix * standardization * Update website/content/commands/snapshot/save.mdx Co-authored-by: Bryce Kalow <bkalow@hashicorp.com> * consul debug consul keyring Co-authored-by: Bryce Kalow <bkalow@hashicorp.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2023-01-26 18:42:13 +00:00
description: |
The `consul peering lists` command outputs a list of the local cluster's cluster peering connections, including imported and exported service counts and the connection state.
feat(cli): add initial peering cli commands
2022-08-31 16:58:41 +00:00
---
# Consul Peering List
Command: `consul peering List`
docs: Migrate link formats (#15976) * Adding check-legacy-links-format workflow * Adding test-link-rewrites workflow * Updating docs-content-check-legacy-links-format hash * Migrating links to new format Co-authored-by: Kendall Strautman <kendallstrautman@gmail.com>
2023-01-25 16:52:43 +00:00
Corresponding HTTP API Endpoint: [\[GET\] /v1/peerings](/consul/api-docs/peering#list-all-peerings)
feat(cli): add initial peering cli commands
2022-08-31 16:58:41 +00:00
The `peering list` lists all peering connections.
The results are filtered according to ACL policy configuration.
docs: Migrate link formats (#15976) * Adding check-legacy-links-format workflow * Adding test-link-rewrites workflow * Updating docs-content-check-legacy-links-format hash * Migrating links to new format Co-authored-by: Kendall Strautman <kendallstrautman@gmail.com>
2023-01-25 16:52:43 +00:00
The table below shows this command's [required ACLs](/consul/api-docs/api-structure#authentication).
feat(cli): add initial peering cli commands
2022-08-31 16:58:41 +00:00
| ACL Required |
| ------------ |
| `peering:read` |
## Usage
Usage: `consul peering list [options]`
#### Command Options
- `-format={pretty|json}` - Command output format. The default value is `pretty`.
#### Enterprise Options
DOCS: CE-556 Add partition parameter to API endpoint docs (#21374) * CD-556 rename partition partial that's only used in CLI Update CLI pages for partial rename API: Add partial for partition as body option API: Add partial for partition as query parameter Update API peering and members pages * acl/auth-methods.mdx Update partition partials to be generic * binding-rules.mdx, policies.mdx * roles.mdx, templated-policies.mdx * tokens.mdx, catalog.mdx, config.mdx, intentions.mdx * service.mdx, exported-services.mdx, kv.mdx, namespaces.mdx * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Add partial to acl/auth-methods.mdx Fix headings indent in a few files. * Update website/content/api-docs/acl/auth-methods.mdx Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> --------- Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
2024-07-18 17:02:45 +00:00
@include 'cli-http-api-partition-options.mdx'
feat(cli): add initial peering cli commands
2022-08-31 16:58:41 +00:00
#### API Options
@include 'http_api_options_client.mdx'
## Examples
The following example lists all peering connections associated with the cluster:
```shell-session hideClipboard
$ consul peering list
Name State Imported Svcs Exported Svcs Meta
cluster-02 ACTIVE 0 2 env=production
cluster-03 PENDING 0 0
```