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>
37 lines
1.7 KiB
Plaintext
37 lines
1.7 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Alias resource
|
|
description: >-
|
|
Learn about using the alias resource to transparently connect to targets without having to provide the target ID or target name and scope ID.
|
|
---
|
|
|
|
# Aliases
|
|
|
|
An alias is a globally unique, DNS-like string that is associated with a destination resource.
|
|
Examples of valid aliases are `webserver` and `webserver.boundary`.
|
|
You can establish a session to a target by referencing its alias, instead of having to provide a target ID or target name and scope ID.
|
|
For example, if you have an alias `boundary.dev`, you can use it to connect to a target with the following command: `boundary connect ssh boundary.dev`.
|
|
|
|
## Attributes
|
|
|
|
Aliases have the following attributes:
|
|
|
|
- `-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.
|
|
- `-name=<string>` - Specifies the optional name you want to use to describe the alias for identification purposes.
|
|
- `-scope-id=<string>` - Scope in which to create the alias. The default is `global`.
|
|
You can also specify the scope using the BOUNDARY_SCOPE_ID environment variable.
|
|
At this time, aliases are only supported for the global scope.
|
|
- `-value=<string>` - Specifies the string that you want to use as the alias to represent the target.
|
|
The `value` must comply with DNS naming rules.
|
|
|
|
### Target subtypes
|
|
|
|
The target subtype has the following additional attributes:
|
|
|
|
- `-authorize-session-host-id=<string>` - Indicates the host ID to use when you use the alias to authorize a session.
|
|
|
|
## More information
|
|
|
|
- [Aliases](/boundary/docs/concepts/aliases)
|