f978993724
* docs: Aliases overview, domain model, CLI docs (#4705) * docs: Aliases overview and domain model * docs: Add new topics to TOC * docs: Updates * docs: Update CLI topics, add usage * docs: Edits to value description * docs: Add how-to for creating new target * docs: Add procedure to update existing alias from CLI * docs: Update targets domain model topic * Apply batch suggestions from code review Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com> Co-authored-by: Todd <github@quaddi.com> * docs: Fix spelling * docs: Remove ferry references * docs: Remove note about aliases not working with generic commands * docs: Updates to naming conventions * switches Tabs order and adds tab groups * fixes shell-session line breaks * Apply batch of suggestions from code review Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * docs: Delete redundant sentence * docs: Fix jump links --------- Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com> Co-authored-by: Todd <github@quaddi.com> Co-authored-by: Robin Beck <stellarsquall@protonmail.ch> Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * rerun tests --------- Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com> Co-authored-by: Todd <github@quaddi.com> Co-authored-by: Robin Beck <stellarsquall@protonmail.ch> Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
49 lines
1.1 KiB
Plaintext
49 lines
1.1 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: aliases - Command
|
|
description: |-
|
|
The "aliases" command lets Boundary admin create and manage alias resources.
|
|
---
|
|
|
|
# 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) |