4ffb21f9ca
* Update documentation to include RDP in credential injection * Update FAQ on Boundary and Vault integration Fixed typo. * update documentation on credential stores and workflows for RDP * update static credential store documentation to include upd credential creation * update documentation for credential injection setup * Update 'credentials create' command documentation for upd credential type * fixed typo in UPD options * Update create.mdx with instructions for RDP targets * Create rdp-testing-and-compatibility-matrix.mdx * Update rdp-testing-and-compatibility-matrix.mdx * Update rdp-testing-and-compatibility-matrix.mdx * Update to mention ldap secrets engine * Update rdp-testing-and-compatibility-matrix.mdx to get rid of ticket number * updated to include mention of vault kv and chad suggestions Updated with Chad's suggestions and vault kv * Update rdp-testing-and-compatibility-matrix.mdx Found another place where I neglected the vault kv * docs: Style updates * docs: Clean up beta references, adds update commands * docs: Edits, update domain model topics * docs: Add target address caveats * docs: Edit network config section * docs: Use custom port number to connect * docs: Adds anchor link, beta tag * docs: Respond to feedback * docs: Cleanup for consistency, remove known issue * docs: Cleanup and minor fixes * docs: Add link to create issue * docs: Add direct address note to targets CLI topics * Update website/content/docs/concepts/credential-management.mdx Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com> * docs: Remove beta references from target and credentials * docs: Remove Vault cred store ID * docs: Remove SSH cert from brokered creds * docs: Remove session recording options * docs: Adds UPD to credential stores domain model topic * Update website/content/docs/credentials/rdp-testing-and-compatibility-matrix.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * Update website/content/docs/credentials/rdp-testing-and-compatibility-matrix.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * docs: Remove session recording options * docs: Update limitations and configuration * Update website/content/docs/credentials/configure-credential-injection.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * docs: Update default port commands * docs: Add known issue for error * docs: Fix typo * Update website/content/docs/credentials/rdp-testing-and-compatibility-matrix.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * docs: Add certificate acceptance to Windows * docs: Reorder UPD options * docs: Add NTLMV2 to cred management statement * docs: Update Windows Remote Desktop Connection error * docs: Clarify domain behavior * docs: Fix back ticks on command options * docs: Update command format in definition * docs: Clarify port conflict with Remote Desktop app * docs: Update RDP target address caveat * docs: Release notes 0.20.0 * docs: Minor edit * docs: Vercel build * docs: Deletes older important changes --------- Co-authored-by: Dan Rohan <daniel.rohan@elastic.co> Co-authored-by: Dan Rohan <dan.rohan@hashicorp.com> Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com> Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
170 lines
6.6 KiB
Plaintext
170 lines
6.6 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: targets update - Command
|
|
description: >-
|
|
The "targets update" command updates an existing target resource.
|
|
---
|
|
|
|
# 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`:
|
|
|
|
```shell-session
|
|
$ boundary targets update tcp -id ttcp_1234567890 -name devops -description "For DevOps usage"
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ 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 (HCP & Boundary Enterprise only)
|
|
ssh Update a ssh-type target (HCP & Boundary Enterprise only)
|
|
tcp Update a tcp-type target
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Usages by type
|
|
|
|
You can update RDP, SSH, or TCP targets.
|
|
|
|
<Tabs>
|
|
<Tab heading="RDP">
|
|
|
|
The `targets update rdp` command lets you update existing RDP targets.
|
|
|
|
#### Example
|
|
|
|
This example updates an RDP target with the id `rdp_1234567890` to add the name `devops` and the description `RDP target for DevOps`:
|
|
|
|
```shell-session
|
|
$ boundary targets update rdp -id trdp_1234567890 -name "devops" -description "RDP target for DevOps"
|
|
```
|
|
|
|
#### Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary targets update rdp [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
#### 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 default client port on the target.
|
|
- `-default-port=<string>` - The default port on the target.
|
|
Due to a port conflict on modern Windows operating systems (Windows 11+, Windows Server 2025), transparent sessions cannot use the default RDP port `3389`.
|
|
You must configure a custom port to use transparent sessions with RDP targets.
|
|
|
|
Refer to [Using transparent sessions with RDP on Windows](/boundary/docs/credentials/rdp-testing-and-compatibility-matrix#using-transparent-sessions-with-rdp-on-windows) for more information about configuring a custom port for transparent sessions.
|
|
- `-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.
|
|
- `-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 specfiy a maximum duration, Boundary uses the default value of 8 hours (28800 seconds).
|
|
|
|
</Tab>
|
|
<Tab heading="SSH">
|
|
|
|
The `targets update ssh` command lets you update SSH targets.
|
|
|
|
#### Example
|
|
|
|
This example updates an SSH target with the ID `tssh_1234567890` to add the name `devops` and the description `SSH target for DevOps`:
|
|
|
|
```shell-session
|
|
$ boundary targets update ssh -id tssh_1234567890 -name "devops" -description "SSH target for DevOps"
|
|
```
|
|
|
|
#### Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary targets update ssh [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
#### SSH target options
|
|
|
|
- `-address=<string>` - An optional valid network address for the target to connect to.
|
|
You cannot use an address alongside host sources.
|
|
- `-default-client-port=<string>` - The default client port on the target, if set.
|
|
- `-default-port=<string>` - The default port on the target, if set.
|
|
If you do not specify a default port, Boundary uses port 22.
|
|
- `-egress-worker-filter=<string>` - A Boolean expression that filters which egress workers can process sessions for the target.
|
|
- `-enable-session-recording=<string>` - A Boolean expression you can use to enable session recording 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.
|
|
- `-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 specfiy a maximum duration, Boundary uses the default value of 8 hours (28800 seconds).
|
|
- `-storage-bucket-id=<string>` - The public ID of the storage bucket you want to associate with the target.
|
|
|
|
|
|
</Tab>
|
|
<Tab heading="TCP">
|
|
|
|
The `targets update tcp` command lets you update TCP targets.
|
|
|
|
#### Example
|
|
|
|
This example updates a TCP target with the ID `ttcp_1234567890` to add the name `devops` and the description `TCP target for DevOps`:
|
|
|
|
```shell-session
|
|
$ boundary targets update tcp -id ttcp_1234567890 -name "devops" -description "TCP target for DevOps"
|
|
```
|
|
|
|
#### Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary targets update tcp [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
#### TCP target options
|
|
|
|
- `-address=<string>` - An optional valid network address for the target to connect to.
|
|
You cannot use an address alongside host sources.
|
|
- `-default-client-port=<string>` - The default client port on the target, if set.
|
|
- `-default-port=<string>` - The default port on the target, if set.
|
|
If you do not specify a default port, Boundary uses port 22.
|
|
- `-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.
|
|
- `-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 specfiy a maximum duration, Boundary uses the default value of 8 hours (28800 seconds).
|
|
- `-worker-filter=<string>` - This option is deprecated.
|
|
Use the egress or ingress filters instead.
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
@include 'cmd-option-note.mdx' |