mirror of
https://github.com/status-im/consul.git
synced 2025-01-30 15:37:14 +00:00
654528ca60
* 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>
52 lines
1.6 KiB
Plaintext
52 lines
1.6 KiB
Plaintext
---
|
|
layout: commands
|
|
page_title: 'Commands: Peering Delete'
|
|
description: |
|
|
The `consul peering delete` command ends a cluster peering connection with another cluster.
|
|
---
|
|
|
|
# Consul Peering Delete
|
|
|
|
Command: `consul peering delete`
|
|
|
|
Corresponding HTTP API Endpoint: [\[DELETE\] /v1/peering/:name](/consul/api-docs/peering#delete-a-peering-connection)
|
|
|
|
The `peering delete` removes a peering connection with another cluster.
|
|
Consul deletes all data imported from the peer in the background.
|
|
The peering connection is removed after all associated data has been deleted.
|
|
Operators can still read the peering connections while the data is being removed.
|
|
The command adds a `DeletedAt` field to the peering connection object with the timestamp of when the peering was marked for deletion.
|
|
You can only use a peering token to establish the connection once. If you need to reestablish a peering connection, you must generate a new token.
|
|
|
|
The table below shows this command's [required ACLs](/consul/api-docs/api-structure#authentication).
|
|
|
|
| ACL Required |
|
|
| ------------ |
|
|
| `peering:write` |
|
|
|
|
## Usage
|
|
|
|
Usage: `consul peering delete [options] -name <peer name>`
|
|
|
|
#### Command Options
|
|
|
|
- `-name=<string>` - (Required) The name of the peer.
|
|
|
|
#### Enterprise Options
|
|
|
|
@include 'cli-http-api-partition-options.mdx'
|
|
|
|
#### API Options
|
|
|
|
@include 'http_api_options_client.mdx'
|
|
|
|
## Examples
|
|
|
|
The following examples deletes a peering connection to a cluster locally referred to as "cluster-02":
|
|
|
|
```shell-session hideClipboard
|
|
$ consul peering delete -name cluster-02
|
|
Successfully submitted peering connection, cluster-02, for deletion
|
|
```
|
|
|