Dan HeathandRobin Beck
5ce6515156
* docs: IA reorganization * docs: Updates * docs: Updates * docs: Fix links * docs: Updates * docs: Fix a typo * docs: Fix client agent topic * docs: Update Client Agent nav * docs: Fix conflict * docs: Fix a typo in Client Agent docs (#5853) * docs: Fix client agent topic * docs: Updates * docs: Updates * docs: Updates * docs: Updates * docs: Fixes get started and operations links * docs: Update nav * docs: Partials * docs: Unix partials * docs: Worker partials * docs: Updates * docs: Update workers and targets * docs: Updates * docs: Updates * docs: Fixes link * docs: Updates after sync review * docs: Updates from review feedback * docs: Move worker filter examples * docs: Fix links * docs: Updates for filters based on working session * docs: Fixes broken links * docs: Add links to other filter topics * docs: Update list intro * docs: Adds link * docs: Fixes redirects * docs: Fixes redirects * docs: Deleted mysql page from TOC * docs: Add versioned redirect * docs: Adds versioned redirects * docs: Adds versioned redirects * docs: Update redirects * docs: Update redirects * docs: Redirect fixes * docs: Update redirect format * docs: Fix a typo * docs: Fixes redirects * docs: Fixes redirect * docs: Adds links out to client agent troubleshooting * uses /etc/boundary.d/ as recommended installation directory (#6003) * docs: Updates legacy io links * docs: Fixes redirects * docs: Fix redirect * docs: Restoring deleted file --------- Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
30 lines
1.3 KiB
Plaintext
30 lines
1.3 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Overview
|
|
description: >-
|
|
Learn how to connect to a target configured with an alias.
|
|
---
|
|
|
|
# Connect to a target using an alias
|
|
|
|
After you [Create a target alias](/boundary/docs/targets/configuration/create-target-alias), you can refer to the alias when you establish sessions.
|
|
|
|
With aliases, you don't have to specify the target ID, target name, or scope when you connect with Boundary. Target aliases are also required to use [transparent sessions](/boundary/docs/concepts/transparent-sessions).
|
|
|
|
You can substitute an alias whenever you could use the `-id` flag or `-target` flag in the CLI.
|
|
|
|
For example, you can use the following command to connect to an SSH target with the ID `ttcp_1234567890`:
|
|
|
|
```shell-session
|
|
$ boundary connect ssh -target -id ttcp_1234567890
|
|
```
|
|
|
|
If you configured an alias named `example.alias.boundary` for the target, you can now use the alias to connect to the target:
|
|
|
|
```shell-session
|
|
$ boundary connect ssh example.alias.boundary
|
|
```
|
|
|
|
Aliases are globally unique, so you don't need to specify the scope to connect to the target.
|
|
|
|
After you verify that you can connect to the target using an alias, you can try to connect to the target using [transparent sessions](/boundary/docs/targets/configuration/configure-transparent-sessions). <sup>HCP/ENT</sup> |