Robert Main
18f469105c
* Update website folder to indicate deprecation Adds an alert banner to the top of all MDX files within `/website` to indicate deprecation * Update website README
42 lines
1.3 KiB
Plaintext
42 lines
1.3 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: sessions cancel - Command
|
|
description: >-
|
|
The "sessions cancel" command cancels a session resource.
|
|
---
|
|
|
|
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
|
|
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
|
|
|
|
# sessions cancel
|
|
|
|
Command: `boundary sessions cancel`
|
|
|
|
The `boundary sessions cancel` command lets you cancel a Boundary session by providing the ID.
|
|
If the session is already canceled, the command succeeds with no effect.
|
|
|
|
## Example
|
|
|
|
This example cancels a session with the ID `s_1234567890`:
|
|
|
|
```shell-session
|
|
$ boundary sessions cancel -id s_1234567890
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary sessions cancel [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Command options
|
|
|
|
- `-id=<string>` - The ID of the session you want to cancel.
|
|
|
|
@include 'cmd-option-note.mdx' |