You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/content/docs/configuration/target-aliases/create-target-alias.mdx
+26-25Lines changed: 26 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,7 +95,8 @@ Complete the following steps to create a new target and new alias at the same ti
95
95
Alternatively, you can configure host catalogs and host sets.
96
96
-**Default Port**: (Optional) Enter an optional default port for the target to use for connections.
97
97
-**Default Client Port**: (Optional) Enter an optional local proxy port on which to listen when a session is started on a client.
98
-
-**Maximum Duration**: (Optional) Enter an optional maximum duration for sessions on this target, in seconds.
98
+
-**Maximum Duration**: (Required) Enter a maximum duration for sessions on this target, in seconds.
99
+
If you do not enter a value, Boundary uses the default of 8 hours (28,800 seconds).
99
100
-**Maximum Connection**: (Optional) Enter the maximum number of connections allowed per session on this target.
100
101
For unlimited connections, enter `-1`.
101
102
-**Workers**: (Optional) Select whether you want the worker to function as an ingress and/or egress worker.
@@ -216,7 +217,7 @@ Target aliases point directly to the target they are associated with. You can as
216
217
217
218
You assign [direct target addresses](/boundary/docs/concepts/domain-model/targets#address) directly to the target. They refer to a specific network resource, like an IP address. Boundary only connects to the direct target address when it establishes a connection to the associated target.
218
219
219
-
When you create a target alias, you can also assign it to a specific host. Assigning an alias to a specific host is useful if you want to avoid creating multiple targets for specific hosts using direct target addresses.
220
+
When you create a target alias, you can also assign it to a specific host. Assigning an alias to a specific host is useful if you want to avoid creating multiple targets for specific hosts using direct target addresses.
220
221
221
222
For example, you could create two aliases for the same target that has been assigned a host set. One alias could refer to the target itself, and would allow Boundary to randomly select a host to connect to for a session. Another alias could point to the same target, but you could assign a host ID that Boundary should use for a session.
222
223
@@ -298,9 +299,9 @@ Create the `linux-dev-servers` target.
298
299
```
299
300
300
301
Example output:
301
-
302
+
302
303
<CodeBlockConfighideClipboard>
303
-
304
+
304
305
```shell-session
305
306
$ boundary targets create ssh \
306
307
-description 'linux-dev.app-servers.eng target' \
@@ -309,7 +310,7 @@ Create the `linux-dev-servers` target.
309
310
-default-port 22 \
310
311
-with-alias-scope-id global \
311
312
-with-alias-value linux-dev.app-servers.eng
312
-
313
+
313
314
Target information:
314
315
Created Time: Thu, 14 Nov 2024 13:39:36 MST
315
316
Description: linux-dev.app-servers.eng target
@@ -320,13 +321,13 @@ Create the `linux-dev-servers` target.
320
321
Type: ssh
321
322
Updated Time: Thu, 14 Nov 2024 13:39:36 MST
322
323
Version: 1
323
-
324
+
324
325
Scope:
325
326
ID: p_3ECODJDbXV
326
327
Name: app-servers
327
328
Parent Scope ID: o_2drCWvp3Oc
328
329
Type: project
329
-
330
+
330
331
Authorized Actions:
331
332
remove-host-sources
332
333
remove-credential-sources
@@ -339,16 +340,16 @@ Create the `linux-dev-servers` target.
339
340
add-host-sources
340
341
set-host-sources
341
342
add-credential-sources
342
-
343
+
343
344
Aliases:
344
345
ID: alt_CkC6wGKLWW
345
346
Value: linux-dev.app-servers.eng
346
-
347
+
347
348
Attributes:
348
349
Default Port: 22
349
350
Enable Session Recording: false
350
351
```
351
-
352
+
352
353
</CodeBlockConfig>
353
354
354
355
Then add the `linux-dev-servers` host set (ID `hsst_56oiL0WaKu`) to the new `linux-dev-servers` target (ID `tssh_lhH5pa425G`).
@@ -396,9 +397,9 @@ Create the `dev-040.linux-dev.app-servers.eng` alias for the host `dev-040`:
396
397
```
397
398
398
399
Example output:
399
-
400
+
400
401
<CodeBlockConfighideClipboard>
401
-
402
+
402
403
```shell-session
403
404
$ boundary aliases create target \
404
405
-description 'Target alias for dev-040.linux-dev.app-servers.eng' \
@@ -407,7 +408,7 @@ Create the `dev-040.linux-dev.app-servers.eng` alias for the host `dev-040`:
407
408
-scope-id global \
408
409
-value dev-040.linux-dev.app-servers.eng \
409
410
-authorize-session-host-id hst_7wGXkF8e0Q
410
-
411
+
411
412
Alias information:
412
413
Created Time: Thu, 14 Nov 2024 13:55:41 MST
413
414
Description: Target alias for dev-040.linux-dev.app-servers.eng
@@ -418,25 +419,25 @@ Create the `dev-040.linux-dev.app-servers.eng` alias for the host `dev-040`:
418
419
Updated Time: Thu, 14 Nov 2024 13:55:41 MST
419
420
Value: dev-040.linux-dev.app-servers.eng
420
421
Version: 1
421
-
422
+
422
423
Scope:
423
424
ID: global
424
425
Name: global
425
426
Type: global
426
-
427
+
427
428
Authorized Actions:
428
429
no-op
429
430
read
430
431
update
431
432
delete
432
-
433
+
433
434
Attributes:
434
435
authorize_session_arguments:
435
436
{
436
437
"host_id": "hst_7wGXkF8e0Q"
437
438
}
438
439
```
439
-
440
+
440
441
</CodeBlockConfig>
441
442
442
443
</Tab>
@@ -476,9 +477,9 @@ Then create the `dev-041.linux-dev.app-servers.eng` alias for the host `dev-041`
476
477
```
477
478
478
479
Example output:
479
-
480
+
480
481
<CodeBlockConfighideClipboard>
481
-
482
+
482
483
```shell-session
483
484
$ boundary aliases create target \
484
485
-description 'Target alias for dev-041.linux-dev.app-servers.eng' \
@@ -487,7 +488,7 @@ Then create the `dev-041.linux-dev.app-servers.eng` alias for the host `dev-041`
487
488
-scope-id global \
488
489
-value dev-041.linux-dev.app-servers.eng \
489
490
-authorize-session-host-id hst_zlRwMMPKwp
490
-
491
+
491
492
Alias information:
492
493
Created Time: Thu, 14 Nov 2024 14:00:13 MST
493
494
Description: Target alias for dev-040.linux-dev.app-servers.eng
@@ -498,25 +499,25 @@ Then create the `dev-041.linux-dev.app-servers.eng` alias for the host `dev-041`
0 commit comments