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>
134 lines
4.8 KiB
Plaintext
134 lines
4.8 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: targets create - Command
|
|
description: |-
|
|
The "targets create" command lets you create a new target.
|
|
---
|
|
|
|
# targets create
|
|
|
|
Command: `targets create`
|
|
|
|
The `targets create` command lets you create a new target.
|
|
|
|
## Example
|
|
|
|
This example creates a TCP target with the name `prodops` and the description `For ProdOps usage`:
|
|
|
|
```shell-session
|
|
$ boundary targets create tcp -name prodops -description "For ProdOps usage"
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary targets create [type] [sub command] [options] [args]
|
|
|
|
Please see the typed subcommand help for detailed usage information.
|
|
|
|
Subcommands:
|
|
ssh Create a ssh-type target (HCP only)
|
|
tcp Create a tcp-type target
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Usages by type
|
|
|
|
You can create SSH or TCP targets.
|
|
|
|
<Tabs>
|
|
<Tab heading="SSH">
|
|
|
|
The `targets create ssh` command lets you create SSH targets.
|
|
|
|
#### Example
|
|
|
|
This example creates an SSH target with the name `prodops` and the description `SSH target for ProdOps`:
|
|
|
|
```shell-session
|
|
$ boundary targets create ssh -name prodops -description "SSH target for ProdOps"
|
|
```
|
|
|
|
#### Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary targets create ssh [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
#### SSH target options
|
|
|
|
- `-address=<string>` - An optional valid network address for the target to connect to.
|
|
You cannot use an address alongside host sources.
|
|
- `-default-client-port=<string>` - The default client port on the target.
|
|
- `-default-port=<string>` - The default port on the target.
|
|
If you do not specify a default port, Boundary uses port 22.
|
|
- `-egress-worker-filter=<string>` - A Boolean expression that filters which egress workers can process sessions for the target.
|
|
- `-enable-session-recording=<string>` - A Boolean expression you can use to enable session recording for the target.
|
|
- `-ingress-worker-filter=<string>` - A Boolean expression that filters which ingress workers can process sessions for the target.
|
|
- `-session-connection-limit=<string>` - The maximum number of connections allowed for a session.
|
|
A value of `-1` means the connections are unlimited.
|
|
- `-session-max-seconds=<string>` - The maximum lifetime of the session, including all connections.
|
|
You can specify an integer number of seconds or a duration string.
|
|
- `-storage-bucket-id=<string>` - The public ID of the storage bucket to associate with the target.
|
|
- `-with-alias-authorize-session-host-id=<string>` - The host ID that an alias uses to authorize sessions for the target.
|
|
- `-with-alias-scope-id=<string>` - The scope ID that you want to create the target and alias in.
|
|
The default is `global`.
|
|
At this time, aliases are only supported for the global scope.
|
|
- `-with-alias-value=<string>` - The value of the alias that you want to use to represent the target.
|
|
Use this parameter to create the alias and target, and associate them with each other, at the same time.
|
|
|
|
|
|
</Tab>
|
|
<Tab heading="TCP">
|
|
|
|
The `targets create tcp` command lets you create TCP targets.
|
|
|
|
#### Example
|
|
|
|
This example creates a TCP target with the name `prodops` and the description `TCP target for ProdOps`:
|
|
|
|
```shell-session
|
|
$ boundary targets create tcp -name prodops -description "TCP target for ProdOps"
|
|
```
|
|
|
|
#### Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary targets create tcp [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
#### TCP target options
|
|
|
|
- `-address=<string>` - An optional valid network address for the target to connect to.
|
|
You cannot use an address alongside host sources.
|
|
- `-default-client-port=<string>` - The default client port on the target.
|
|
- `-default-port=<string>` - The default port on the target.
|
|
If you do not specify a default port, Boundary uses port 22.
|
|
- `-egress-worker-filter=<string>` - A Boolean expression that filters which egress workers can process sessions for the target.
|
|
- `-ingress-worker-filter=<string>` - A Boolean expression that filters which ingress workers can process sessions for the target.
|
|
- `-session-connection-limit=<string>` - The maximum number of connections allowed for a session.
|
|
A value of `-1` means the connections are unlimited.
|
|
- `-session-max-seconds=<string>` - The maximum lifetime of the session, including all connections.
|
|
You can specify an integer number of seconds or a duration string.
|
|
- `-with-alias-authorize-session-host-id=<string>` - The host ID that an alias uses to authorize sessions for the target.
|
|
- `-with-alias-scope-id=<string>` - The scope ID that you want to create the alias in at target creation time.
|
|
The default is `global`.
|
|
At this time, aliases are only supported for the global scope.
|
|
- `-with-alias-value=<string>` - The value of the alias that you want to use to represent the target.
|
|
Use this parameter to create the alias and target, and associate them with each other, at the same time.
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
@include 'cmd-option-note.mdx' |