You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
boundary/website/content/docs/commands/aliases/index.mdx

54 lines
1.8 KiB

---
layout: docs
page_title: aliases - Command
description: >-
The "aliases" command performs operations on alias resources. An alias is a globally unique, DNS-like string that is associated with a destination resource.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
# aliases
Command: `boundary aliases`
The `aliases` command lets you create and manage alias resources in Boundary.
## Examples
The following example retrieves alias information for a given alias ID, `alt_1234567890`:
```shell-session
$ boundary aliases read -id alt_1234567890
```
## Usage
<CodeBlockConfig hideClipboard>
```shell-session
Usage: boundary aliases [sub command] [options] [args]
# ...
Subcommands:
create Create an alias
delete Delete an alias
list List an alias
read Read an alias
update Update an alias
```
</CodeBlockConfig>
For more information, examples, and usage, click on the name
of the subcommand in the sidebar or one of the links below:
- [create](/boundary/docs/commands/aliases/create)
- [delete](/boundary/docs/commands/aliases/delete)
- [list](/boundary/docs/commands/aliases/list)
- [read](/boundary/docs/commands/aliases/read)
- [update](/boundary/docs/commands/aliases/update)