From 5a330b9a248d49e8f42e756029e92dae417bcae2 Mon Sep 17 00:00:00 2001 From: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Date: Tue, 7 May 2024 10:18:42 -0400 Subject: [PATCH] docs: Update session-recordings CLI doc --- .../commands/session-recordings/delete.mdx | 38 +++++++++++++++++++ .../commands/session-recordings/index.mdx | 12 ++++-- .../reapply-storage-policy.mdx | 38 +++++++++++++++++++ website/data/docs-nav-data.json | 8 ++++ 4 files changed, 92 insertions(+), 4 deletions(-) create mode 100644 website/content/docs/commands/session-recordings/delete.mdx create mode 100644 website/content/docs/commands/session-recordings/reapply-storage-policy.mdx diff --git a/website/content/docs/commands/session-recordings/delete.mdx b/website/content/docs/commands/session-recordings/delete.mdx new file mode 100644 index 0000000000..bb1c4f8bec --- /dev/null +++ b/website/content/docs/commands/session-recordings/delete.mdx @@ -0,0 +1,38 @@ +--- +layout: docs +page_title: session-recordings delete - Command +description: |- + The "session-recordings delete" command lets you delete a session recording. +--- + +# session-recordings delete + +This feature requires HCP Boundary or Boundary Enterprise + +Command: `session-recordings delete` + +The `session-recordings delete` command lets you delete a session recording. + +## Example + +This example deletes a session recording with the ID `sr_1234567890`: + +```shell-session +$ boundary session-recordings delete -id sr_1234567890 +``` + +## Usage + + + +```shell-session +$ boundary session-recordings delete [options] [args] +``` + + + +### Command options + +- `-id=` - The ID of the session recording you want to delete. + +@include 'cmd-option-note.mdx' \ No newline at end of file diff --git a/website/content/docs/commands/session-recordings/index.mdx b/website/content/docs/commands/session-recordings/index.mdx index 85416f60cf..abf8183b5a 100644 --- a/website/content/docs/commands/session-recordings/index.mdx +++ b/website/content/docs/commands/session-recordings/index.mdx @@ -29,9 +29,11 @@ $ boundary session-recordings download -id chr_1234567890 Usage: boundary session-recordings [options] [args] # ... Subcommands: - download Download a session recording - list List a session recording - read Read a session recording + 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 ``` @@ -39,6 +41,8 @@ Subcommands: 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) \ No newline at end of file +- [read](/boundary/docs/commands/session-recordings/read) +- [reapply-storage-policy](/boundary/docs/commands/session-recordings/reapply-storage-policy) \ No newline at end of file diff --git a/website/content/docs/commands/session-recordings/reapply-storage-policy.mdx b/website/content/docs/commands/session-recordings/reapply-storage-policy.mdx new file mode 100644 index 0000000000..67562c3282 --- /dev/null +++ b/website/content/docs/commands/session-recordings/reapply-storage-policy.mdx @@ -0,0 +1,38 @@ +--- +layout: docs +page_title: session-recordings reapply-storage-policy - Command +description: |- + The "session-recordings reapply-storage-policy" command lets you reapply a storage policy to a session recording. +--- + +# session-recordings reapply-storage-policy + +This feature requires HCP Boundary or Boundary Enterprise + +Command: `session-recordings reapplly-storage-policy` + +The `session-recordings reapply-storage-policy` command lets you reapply a storage policy to a session recording. + +## Example + +This example reapplies a storage policy to a session recording with the ID `sr_1234567890`: + +```shell-session +$ boundary session-recordings reapply-storage-policy -id sr_1234567890 +``` + +## Usage + + + +```shell-session +$ boundary session-recordings delete [options] [args] +``` + + + +### Command options + +- `-id=` - The ID of the session recording you want to reapply the storage policy to. + +@include 'cmd-option-note.mdx' \ No newline at end of file diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index 382d9a9e89..ab92cba4f4 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -1372,6 +1372,10 @@ "title": "Overview", "path": "commands/session-recordings" }, + { + "title": "delete", + "path": "commands/session-recordings/delete" + }, { "title": "download", "path": "commands/session-recordings/download" @@ -1383,6 +1387,10 @@ { "title": "read", "path": "commands/session-recordings/read" + }, + { + "title": "reapply-storage-policy", + "path": "commands/session-recordings/reapply-storage-policy" } ] },