ad5ad69d54
* Add 'Commands (CLI)' docs * Update index.mdx Added Environment variables section * Add 'connect' sub-folder structure * Adding listen address and port environment variables * add connect to the docs navigation * docs: Add Florin's update to index * docs: Fix links and typo * Add front-matter to resolve the PR check issue * Update postgres.mdx Boundary helper for POSTGRES * Completed 'boundary accounts' command docs * Draft connection option documentatino for kube, http, and rdp (#3455) * Style updates for consistency * Clean up using partials * Add 'ssh' doc & updated style for consistency * Fix paste error * Fix the format issue on 'connect ssh' doc * Add 'auth-methods' command doc (#3520) * Add the docs for 'logout', 'server', and 'dev' commands (#3524) * Add the docs for 'logout', 'server', and 'dev' commands * Update the front matter * Add auth-tokens and authenticate command docs (#3575) * Add config command docs (#3576) * updates to the ssh helper command docs (#3523) * updates to the ssh helper command docs * docs: Fix code block * docs: Add minor copy edits --------- Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> * docs: Add worker commands * docs: Update workers subcommands (#3598) * docs: Update worker subcommands * docs: Update certificate-authority subcommand * doc: Fix syntax for code refererences * docs: Add `users` commands (#3599) * docs: Add `users` commands * docs: Add more subcommands * docs: Add `target` commands (#3608) * Add command docs for 'credential-libraries' (#3610) * Add 'credential-stores' command docs (#3611) * Add 'credential-stores' command docs * Add the output message * Fix a typo * Fix a typo * Update the dummy token value * docs: Add `storage-bucket` commands - update (#3615) * docs: Add `sessions` commands (#3616) * docs: Add `session-recordings` commands (#3617) * Add 'credentials' command docs (#3619) * Add 'credentials' command docs * Fix typos * docs: Add `scopes` commands (#3620) * docs: Add `scopes` commands * docs: Fix typos * docs: Add `roles` commands (#3621) * docs: Add `roles` commands * docs: Add remaining subcommands * Add 'database' command docs (#3628) * Add 'database' command docs * Update the format inconsistency * docs: Add `managed-groups` commands (#3626) * docs: Add `managed-groups` commands * docs: Clarify description * docs: Add `hosts` commands (#3629) * docs: Add `host-sets` commands (#3630) * docs: Add `host-sets` commands * docs: Copy edits * docs: Add `host-catalogs` commands (#3632) * Add 'boundary groups' command docs (#3636) --------- Co-authored-by: kevin-loehfelm <37027455+kevin-loehfelm@users.noreply.github.com> Co-authored-by: kevin-loehfelm <kevin.loehfelm@hashicorp.com> Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Co-authored-by: Florin Cătălin Țiucra-Popa <106736683+FlorinTP@users.noreply.github.com> Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com>
91 lines
2.0 KiB
Plaintext
91 lines
2.0 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: groups update - Command
|
|
description: |-
|
|
The "groups update" command lets Boundary admin update a group resource.
|
|
---
|
|
|
|
# groups update
|
|
|
|
Command: `boundary groups update`
|
|
|
|
The `groups update` command lets you update an existing group's information.
|
|
|
|
## Examples
|
|
|
|
In this example, an existing group (`g_9SpLKOoTse`) has the following details:
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```plaintext
|
|
Group information:
|
|
Created Time: Thu, 24 Aug 2023 13:58:50 PDT
|
|
Description: Support engineering group
|
|
ID: g_9SpLKOoTse
|
|
Name: support
|
|
Updated Time: Thu, 24 Aug 2023 13:58:50 PDT
|
|
Version: 3
|
|
|
|
...snip...
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
The following command updates the group's `description` and `version`:
|
|
|
|
```shell-session
|
|
$ boundary groups update -id g_9SpLKOoTse \
|
|
-description "Customer support for product XXX" \
|
|
-version 4
|
|
```
|
|
|
|
**Example output:**
|
|
|
|
<CodeBlockConfig hideClipboard highlight="3,7">
|
|
|
|
```plaintext
|
|
Group information:
|
|
Created Time: Thu, 24 Aug 2023 13:58:50 PDT
|
|
Description: Customer support for product XXX
|
|
ID: g_9SpLKOoTse
|
|
Name: support
|
|
Updated Time: Thu, 24 Aug 2023 14:33:18 PDT
|
|
Version: 4
|
|
|
|
Scope:
|
|
ID: o_R0wbo0H6Zl
|
|
Name: quick-start-org
|
|
Parent Scope ID: global
|
|
Type: org
|
|
|
|
Authorized Actions:
|
|
no-op
|
|
read
|
|
update
|
|
delete
|
|
add-members
|
|
set-members
|
|
remove-members
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary groups update [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Command options
|
|
|
|
- `-description` `(string: "")` - The description to set on the group.
|
|
- `-id` `(string: "")` - The ID of the group to update.
|
|
- `-name` `(string: "")` - The name to set on the group.
|
|
- `-version` `(string: "")` - The version of the group to update.
|
|
If you do not specify a version, the command performs a check-and-set automatically.
|
|
|
|
@include 'cmd-option-note.mdx' |