a92c0c7ed2
* adds target aliases and transparent sessions usage docs * fixes relative link * Apply suggestions from code review Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> * Update website/content/docs/configuration/target-aliases/create-target-alias.mdx Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> * fixes paragraph formatting * add authenticaton requirement * adds example link * Apply suggestions from code review Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> * clarifies host selection for session * use DNS-like aliases in example * fixes indentation * Update website/content/docs/concepts/aliases.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * adds callout box for 0.16 clusters --------- Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.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.
|
|
---
|
|
|
|
After you [Create a target alias](/boundary/docs/configuration/target-aliases/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/configuration/target-aliases/transparent-sessions).
|
|
|
|
# Connect to a target using an alias
|
|
|
|
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/configuration/target-aliases/transparent-sessions). <sup>HCP/ENT</sup> |