HashiConf 2025 Don't miss the live stream of HashiConf Day 2 happening now View live stream
Boundary Home

targets update

Command: targets update

The targets update command lets you update a target.

Example

This example updates a TCP target with the ID ttcp_1234567890 to add the name devops and the description For DevOps usage:

$ boundary targets update tcp -id ttcp_1234567890 -name devops -description "For DevOps usage"

Usage

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

Please see the typed subcommand help for detailed usage information.

Subcommands:
    rdp    Update an rdp-type target
    ssh    Update a ssh-type target
    tcp    Update a tcp-type target

Command options

  • -description=<string> - Specifies the optional description of the target that you want to use for identification purposes.
  • -name=<string> - Specifies the optional name you want to use to describe the target for identification purposes.
  • -id=<string> - Specifies the ID of the target to update.
  • -version=<int> - Specifies the version of the target to update. If you do not specify a version, the command automatically performs a check-and-set operation.

CLI options

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

Usages by type

You can update RDP, SSH, or TCP targets.

The targets update rdp command lets you update existing RDP targets.

Example

This example updates an RDP target with the id trdp_1234567890 to add the name devops and the description RDP target for DevOps:

$ boundary targets update rdp -id trdp_1234567890 -name "devops" -description "RDP target for DevOps"

Usage

$ boundary targets update rdp [options] [args]

RDP target options

  • -address=<string> - An optional valid network address for the target to connect to. You cannot use an address alongside host sources.

    If you set a target address for RDP targets that use Kerberos authentication, use the target's hostname and append the domain to it, for example target-hostname.mydomain.com. For RDP targets that use NTLM authentication, set the target address to the target's IP address.

  • -default-client-port=<string> - The port that the Client Agent binds its local proxy listener to when establishing a transparent session for this target. Set this value to match the port that the client application dials by default. For example, SSH clients dial port 22, RDP clients dial port 3389, and HTTPS clients dial port 443. If you do not set this value, the Client Agent falls back to -default-port. If -default-client-port does not match the client application, the transparent session fails.

  • -default-port=<string> - The default port on the target.

  • -egress-worker-filter=<string> - A Boolean expression that filters which egress workers can process sessions for the target.

  • -ingress-worker-filter=<string> - A Boolean expression that filters which ingress workers can process sessions for the target.

  • -session-connection-limit=<string> - The maximum number of connections allowed for a session. A value of -1 means the connections are unlimited.

    The Windows Remote Desktop Connection application consumes multiple connections when initiating a session. If you set the session-connection-limit to 1 for RDP targets it will cause all RDP connections using this client to fail. You can leave the connection limit unset or configure a limit of 2 or higher to account for the multiple connections used by the RDP client.

    Refer to RDP target attributes for more information.

  • -session-max-seconds=<string> - The maximum lifetime of the session, including all connections. You can specify an integer number of seconds or a duration string. If you do not specify a maximum duration, Boundary uses the default value of 8 hours (28800 seconds).

Edit this page on GitHub