aliases update

Command: aliases update

The aliases update command lets you update an alias.

Example

This example updates a target-type alias with the ID alt_1234567890 to add the name devops:

$ boundary aliases update target -id alt_1234567890 -name devops

Usage

$ boundary aliases update [type] [sub command] [options] [args]

Please see the typed subcommand help for detailed usage information.

Subcommands:
    target    Update a target type alias

Usages by type

At this time, you can only create aliases for targets.

The aliases update target command lets you update aliases for targets.

Example

This example updates a target-type alias with the ID alt_1234567890 to add the name devops:

$ boundary aliases update target -id alt_1234567890 -name devops

Usage

$ boundary aliases update target [options] [args]

Command options

• -description=<string> - Specifies the optional description you want to use to describe the alias for identification purposes.

• -destination-id=<string> - Specifies the ID of the target that the alias points to.

• -id=<string> - Specifies the ID of the alias to update.

• -name=<string> - Specifies the optional name you want to use to describe the alias for identification purposes.

• -value=<string> - The string that you want to use as the alias to represent the target. If you are creating an alias in a project scope, you must include the org and project suffix in the format alias.projectsuffix.orgsuffix. The value must comply with DNS naming rules.

  If the project and containing org scopes don't both have alias suffixes, the command will fail. Complete the steps in Create the suffixes to create the required suffixes, and then return to this procedure.

• -version=<int> - Specifies the version of the alias to update. If you do not specify a version, the command performs a check-and-set automatically.

Target alias options

• -authorize-session-host-id=<string> - Indicates the host ID to use when you use the alias to authorize a session.