host-catalogs update

Command: host-catalogs update

The host-catalogs update command lets you update an existing host catalog.

Example

This example updates a static host catalog with the ID hcst_1234567890 to add the name devops and the description For DevOps usage:

$ boundary host-catalogs update static -id hcst_1234567890 -name devops -description "For DevOps usage"

Usage

$ boundary host-catalogs update [type] <subcommand> [options] [args]

Please see the typed subcommand help for detailed usage information.

Subcommands:
    plugin    Update a plugin-type host catalog
    static    Update a static-type host catalog

Usages by type

You can update plugin or static host set types.

The boundary host-catalogs update plugin command lets you update a plugin type host catalog.

Example

This example updates a plugin type host catalog with the ID hc_1234567890 to add the name devops and the description Plugin host-catalog for DevOps.

$ boundary host-catalogs update plugin -id hc_1234567890 -name "devops" -description "Plugin host-catalog for DevOps"

Usage

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

Command options

-description=<string> - The description to set on the plugin host catalog.
-id=<string> - The ID of the plugin type host catalog to update.
-name=<string> - The name to set on the plugin host catalog.
-version=<int> - The version of the plugin host catalog 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://.

Secrets options

-bool-secret - A key=value Boolean value that you can add to the request's secrets map. You can specify this value multiple times. This option supports referencing values from files using file:// and environment variables using env://.
-num-secret - A key=value numeric value that you can add to the request's secrets map. You can specify this value multiple times. This option supports referencing values from files using file:// and environment variables using env://.
-secret - A key=value pair that you can add to the request's secrets 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-secret, -bool-secret, or -num-secret. You can specify this value multiple times. This option supports referencing values from files using file:// and environment variables using env://.
-secrets=<string> - A JSON map value that you can use as the entirety of the request's secrets map. Usually this value is sourced from file using file:// syntax. This option is exclusive with other secret flags.
-string-secret - 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 type options

The following options are specific to the type of plugin.

disable_credential_rotation - When set to true, Boundary does not rotate the credentials with AWS automatically.
region - The region to configure the host catalog for. All host sets in this catalog are configured for this region.
access_key_id - The access key ID for the IAM user to use with this host catalog.
secret_access_key - The secret access key for the IAM user to use with this host catalog.
role_arn - The AWS role ARN used for AssumeRole authentication. If you provide a role_arn value, you must also set disable_credential_rotation to true.
role_external_id - The external ID that you configured for the AssumeRole provider.
role_session_name - The session name that you configured for the AssumeRole provider.
role_tags - The key-value pair tags that you configured for the AssumeRole provider.
-worker-filter - A boolean expression to filter which workers can handle dynamic host catalog commands for this host catalog. This should match a valid filter expression for the self-managed worker deployed in AWS. Refer to worker Filter examples to learn more.
-instance_addresses_only=true - If added with the -attr flag, Boundary limits the syncing of instance addresses and automatically selects the host's primary ENI (Elastic Network Interface). To unset the value later, change true to false.

disable_credential_rotation - When set to true, Boundary does not rotate the credentials automatically. Azure host catalogs do not currently support credential rotation.
tenant_id - The ARM tenant (directory) ID for your Azure Active Directory application.
subscription_id - The ARM subscription ID for the subscription that has read access.
client_id - The client (application) ID of the Azure service principal that Boundary should use to authenticate and discover hosts.
secret_value - The ARM client secret value that Azure generates for authentication.

disable_credential_rotation - When set to true, Boundary does not rotate the credentials automatically.
zone - The GCP zone of the instances that you want to add to the host catalog.
project_id - The project ID of any instances that you want to add to the host catalog.
client_email - The unique email address that is used to identify the service account. It is required when you authenticate using the service account.
private_key_id - The unique identifier of the private key. It is required when you authenticate using the service account.
private_key - The private key used to obtain an OAuth 2.0 access token. The key must be PEM encoded. It is required when you authenticate using the service account.
target_service_account_id - The email address of the service account to impersonate. It is required when you authenticate using service account impersonation.

The boundary host-catalogs update static command lets you update a static type host catalog.

Example

This example updates a static type host catalog with the ID hcst_1234567890 to add the name devops and the description Static host-catalog for DevOps:

$ boundary host-catalogs update static -id hcst_1234567890 -name "devops" -description "Static host-catalog for DevOps"

Usage

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

Command options

-description=<string> - The description to set on the static host catalog.
-id=<string> - The ID of the static type host catalog you want to update.
-name=<string> - The name to set on the static host catalog.
-version=<int> - The version of the static type host catalog you want to update. If you do not specify a version, the command automatically performs a check-and-set.

CLI options

In addition to the command specific options, there are options common to all CLI commands and subcommands: