* 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>
143 lines
5.2 KiB
Plaintext
143 lines
5.2 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: host-sets update - Command
|
|
description: |-
|
|
The "host-sets update" command lets you update an existing host set.
|
|
---
|
|
|
|
# host-sets update
|
|
|
|
Command: `host-sets update`
|
|
|
|
The `host-sets update` command lets you update an existing host set.
|
|
|
|
## Example
|
|
|
|
This example updates a static host set with the ID `hsst_1234567890` to add the name `devops` and the description `For DevOps usage`:
|
|
|
|
```shell-session
|
|
$ boundary host-sets update static -id hsst_1234567890 -name devops -description "For DevOps usage"
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary host-sets update [type] <subcommand> [options] [args]
|
|
|
|
Please see the typed subcommand help for detailed usage information.
|
|
|
|
Subcommands:
|
|
plugin Update a plugin-type host set
|
|
static Update a static-type host set
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Usages by type
|
|
|
|
You can update plugin or static host set types.
|
|
|
|
<Tabs>
|
|
<Tab heading="Plugin">
|
|
|
|
The `boundary host-sets update plugin` command lets you update a plugin type host set.
|
|
|
|
#### Example
|
|
|
|
This example updates a plugin type host set with the ID `hsplg_1234567890` to add the name `devops` and the description `Plugin host-set for DevOps`.
|
|
|
|
```shell-session
|
|
$ boundary host-sets update plugin -id hsplg_1234567890 -name "devops" -description "Plugin host-set for DevOps"
|
|
```
|
|
|
|
#### Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary host-sets update plugin [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
#### Command options
|
|
|
|
- `-description=<string>` - The description to set on the plugin host set.
|
|
- `-id=<string>` - The ID of the plugin type host set to update.
|
|
- `-name=<string>` - The name to set on the plugin host set.
|
|
- `-version=<int>` - The version of the plugin host set to update.
|
|
If you do not specify a version, the command automatically performs a check-and-set.
|
|
|
|
#### Attribute options
|
|
|
|
- `-attr` - A key=value pair to add to the request's attribute map.
|
|
This option can also be a key value only, which sets a JSON null as the value.
|
|
If you provide a value, Boundary automatically infers the type.
|
|
You can override the type using `-string-attr`, `-bool-attr`, or `-num-attr`.
|
|
You can specify this value multiple times.
|
|
This option supports referencing values from files using `file://` and environment variables using `env://`.
|
|
- `-attributes=<string>` - A JSON map value that you can use as the entirety of the request's attributes map.
|
|
Usually this value is sourced from a file using the `file://` syntax.
|
|
This option is exclusive with other `attr` flags.
|
|
- `-bool-attr` - A key=value Boolean value that you can add to the request's attributes map.
|
|
You can specify this value multiple times.
|
|
This option supports referencing values from files using `file://` and environment variables using `env://`.
|
|
- `-num-attr` - A key=value numeric value that you can add to the request's attributes map.
|
|
You can specify this value multiple times.
|
|
This attribute supports referencing values from files using `file://` and environment variables using `env://`.
|
|
- `-string-attr` - A key=value string value that you can add to the request's attributes map.
|
|
You can specify this value multiple times.
|
|
This option supports referencing values from files using `file://` and environment variables using `env://`.
|
|
|
|
#### Plugin host-set options
|
|
|
|
- `-preferred-endpoint=<string>` - If set, specifies which IP address or DNS name out of a host's available options is preferred as an endpoint.
|
|
You can specify your preference using `cidr:<valid IPv4/6 CIDR>` or `dns:<globbed name>`.
|
|
You can specify multiple preferences to create an order of preferences.
|
|
If you do not specify a preference, Boundary chooses a value from all available values using a built-in priority order.
|
|
The endpoint preference option may not be valid for all plugin types.
|
|
- `-sync-interval=<string>` - The interval of time between sync operations on the host set.
|
|
You can enter an integer number of seconds or a string such as `400s`, `5m`, or `6h`.
|
|
The interval is applied to the end of the previous sync operation, not the beginning.
|
|
If you set the interval to a negative value, it disables synchronization for that host set.
|
|
If you set the interval to null, Boundary uses the default value.
|
|
The default value may change between releases.
|
|
|
|
</Tab>
|
|
|
|
<Tab heading="Static">
|
|
|
|
The `boundary host-sets update static` command lets you update a static type host set.
|
|
|
|
#### Example
|
|
|
|
This example updates a static type host set with the ID `hsst_1234567890` to add the name `devops` and the description `Static host-set for DevOps`:
|
|
|
|
```shell-session
|
|
$ boundary host-sets update static -id hsst_1234567890 -name "devops" -description "Static host-set for DevOps"
|
|
```
|
|
|
|
#### Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary host-sets update static [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
#### Command options
|
|
|
|
- `-description=<string>` - The description to set on the static host set.
|
|
- `-id=<string>` - The ID of the static type host set to update.
|
|
- `-name=<string>` - The name to set on the static host set.
|
|
- `-version=<int>` - The version of the static type host set to update.
|
|
If you do not specify a version, the command automatically performs a check-and-set.
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
@include 'cmd-option-note.mdx' |