ad5ad69d54
* Add 'Commands (CLI)' docs * Update index.mdx Added Environment variables section * Add 'connect' sub-folder structure * Adding listen address and port environment variables * add connect to the docs navigation * docs: Add Florin's update to index * docs: Fix links and typo * Add front-matter to resolve the PR check issue * Update postgres.mdx Boundary helper for POSTGRES * Completed 'boundary accounts' command docs * Draft connection option documentatino for kube, http, and rdp (#3455) * Style updates for consistency * Clean up using partials * Add 'ssh' doc & updated style for consistency * Fix paste error * Fix the format issue on 'connect ssh' doc * Add 'auth-methods' command doc (#3520) * Add the docs for 'logout', 'server', and 'dev' commands (#3524) * Add the docs for 'logout', 'server', and 'dev' commands * Update the front matter * Add auth-tokens and authenticate command docs (#3575) * Add config command docs (#3576) * updates to the ssh helper command docs (#3523) * updates to the ssh helper command docs * docs: Fix code block * docs: Add minor copy edits --------- Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> * docs: Add worker commands * docs: Update workers subcommands (#3598) * docs: Update worker subcommands * docs: Update certificate-authority subcommand * doc: Fix syntax for code refererences * docs: Add `users` commands (#3599) * docs: Add `users` commands * docs: Add more subcommands * docs: Add `target` commands (#3608) * Add command docs for 'credential-libraries' (#3610) * Add 'credential-stores' command docs (#3611) * Add 'credential-stores' command docs * Add the output message * Fix a typo * Fix a typo * Update the dummy token value * docs: Add `storage-bucket` commands - update (#3615) * docs: Add `sessions` commands (#3616) * docs: Add `session-recordings` commands (#3617) * Add 'credentials' command docs (#3619) * Add 'credentials' command docs * Fix typos * docs: Add `scopes` commands (#3620) * docs: Add `scopes` commands * docs: Fix typos * docs: Add `roles` commands (#3621) * docs: Add `roles` commands * docs: Add remaining subcommands * Add 'database' command docs (#3628) * Add 'database' command docs * Update the format inconsistency * docs: Add `managed-groups` commands (#3626) * docs: Add `managed-groups` commands * docs: Clarify description * docs: Add `hosts` commands (#3629) * docs: Add `host-sets` commands (#3630) * docs: Add `host-sets` commands * docs: Copy edits * docs: Add `host-catalogs` commands (#3632) * Add 'boundary groups' command docs (#3636) --------- Co-authored-by: kevin-loehfelm <37027455+kevin-loehfelm@users.noreply.github.com> Co-authored-by: kevin-loehfelm <kevin.loehfelm@hashicorp.com> Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Co-authored-by: Florin Cătălin Țiucra-Popa <106736683+FlorinTP@users.noreply.github.com> Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com>
91 lines
2.8 KiB
Plaintext
91 lines
2.8 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: connect ssh - Command
|
|
description: |-
|
|
The "connect ssh" command command performs a target authorization or consumes an existing authorization token, and launches a proxied SSH connection.
|
|
---
|
|
|
|
# connect ssh
|
|
|
|
Command: `boundary connect ssh`
|
|
|
|
The `connect ssh` command authorizes a session against a target and invokes an SSH client for the connection.
|
|
The command fills in the local address and port.
|
|
You can specify your SSH client of choice using the `-style` option.
|
|
|
|
@include 'cmd-connect-env-vars.mdx'
|
|
|
|
The SSH helper command sets the host key `Alias`.
|
|
When an `Alias` is set, SSH does not use `localhost:<port>` for host key validation, but instead uses one of the following:
|
|
|
|
- For connections to a target that has an attached host set, the SSH helper command sets the `HostID` as the alias.
|
|
- For connections directly to a host, the SSH helper command sets the `HostID` as the alias.
|
|
- For connections to a target that has an address field configured, the SSH helper command sets the `TargetID` as the alias.
|
|
|
|
## Examples
|
|
|
|
The following example authorizes a session to a target with the ID `ttcp_eTcZMueUYv` and invokes the default SSH client without any additional options:
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary connect ssh -target-id ttcp_eTcZMueUYv
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
The following example authorizes a session to a target with the ID `ttcp_eTcZMueUYv`, and pipes arguments directly to the invoked SSH binary.
|
|
Any SSH arguments after the double hyphen are sent directly to the binary:
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary connect ssh -target-id ttcp_eTcZMueUYv -- -A
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary connect ssh -target-scope-name Helpdesk -target-name ubuntu-server -- -A
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary connect ssh -target-id=ttcp_Gymo7Vcq7Y \
|
|
-host-id=hst_FrdNPd9Zm9 -- -l ubuntu -i private_key.pem
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary connect ssh [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
This command performs a target authorization or consumes an existing authorization token, and launches a proxied SSH connection.
|
|
|
|
@include 'cmd-connect-command-options.mdx'
|
|
|
|
### SSH options:
|
|
|
|
- `style` `(string: "")` - How the CLI attempts to invoke an SSH
|
|
client.
|
|
This value also sets a suitable default for `-exec`, if you did not specify a value.
|
|
Currently understood values are `ssh` and `putty`.
|
|
The default is `ssh`.
|
|
You can also specify how the CLI attempts to invoke the SSH client using the **BOUNDARY_CONNECT_SSH_STYLE** environment variable.
|
|
|
|
- `username` `(string: "")` - The username you want to pass through to the
|
|
client.
|
|
You can also specify a username using the **BOUNDARY_CONNECT_USERNAME** environment variable.
|