host-sets update

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.

$ boundary host-sets update plugin -id hsplg_1234567890 -name "devops" -description "Plugin host-set for DevOps"

Usage

$ boundary host-sets update plugin [options] [args]

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 your preferred endpoint for when Boundary establishes a session with the target. The preferred-endpoint option may not be valid for all plugin types.

  You can specify multiple endpoints using CIDR or DNS formats to create an order of preferences. CIDR strings should follow the cidr:<valid IPv4/6 CIDR> format, for example, cidr:10.0.0.0/16. DNS strings should follow the dns:<globbed name> format, for example dns:*.internal.

  If you do not specify a preference, Boundary chooses an endpoint using the following built-in priority order:

  1. Private IPv4
  2. Public IPv4
  3. DNS
  4. Private IPv6
  5. Public IPv6

• -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.

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:

$ boundary host-sets update static -id hsst_1234567890 -name "devops" -description "Static host-set for DevOps"

Usage

$ boundary host-sets update static [options] [args]

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.