* docs: Update session-recordings CLI doc * fixes id example --------- Co-authored-by: Robin Beck <stellarsquall@protonmail.ch>
48 lines
1.6 KiB
Plaintext
48 lines
1.6 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: session-recordings - Command
|
|
description: |-
|
|
The "session-recordings" command lets you perform operations on Boundary session recording resources.
|
|
---
|
|
|
|
# session-recordings
|
|
|
|
<EnterpriseAlert product="boundary">This feature requires <a href="https://www.hashicorp.com/products/boundary">HCP Boundary or Boundary Enterprise</a></EnterpriseAlert>
|
|
|
|
Command: `boundary session-recordings`
|
|
|
|
The `session-recordings` command lets you perform operations on Boundary session recording resources.
|
|
|
|
## Example
|
|
|
|
The following command downloads a session recording with the id `chr_1234567890`:
|
|
|
|
```shell-session
|
|
$ boundary session-recordings download -id chr_1234567890
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
Usage: boundary session-recordings <subcommand> [options] [args]
|
|
# ...
|
|
Subcommands:
|
|
delete Delete a session recording
|
|
download Download a session recording
|
|
list List a session recording
|
|
read Read a session recording
|
|
reapply-storage-policy Reapply storage policy to a session recording
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
For more information, examples, and usage, click on the name
|
|
of the subcommand in the sidebar or one of the links below:
|
|
|
|
- [delete](/boundary/docs/commands/session-recordings/delete)
|
|
- [download](/boundary/docs/commands/session-recordings/download)
|
|
- [list](/boundary/docs/commands/session-recordings/list)
|
|
- [read](/boundary/docs/commands/session-recordings/read)
|
|
- [reapply-storage-policy](/boundary/docs/commands/session-recordings/reapply-storage-policy) |