> For the complete documentation index, see [llms.txt](https://docs.islandrouter.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.islandrouter.com/island-router-cli-2.3.2/commands/ssh.md).

# ssh

Opens a Secure Shell connection to a remote host.

## Syntax

```
ssh [<user>@]<host> [<command>]
```

## Syntax Description

<table><thead><tr><th width="203">Keyword</th><th>Description</th></tr></thead><tbody><tr><td>user</td><td>(Optional) The user name to use on the remote host.</td></tr><tr><td>host</td><td>The name or IP address of the remote host.</td></tr><tr><td>command</td><td>(Optional) A command to run on the remote host.</td></tr></tbody></table>

## Defaults

The default user name is "admin".

## Usage Guidelines

This commands establishes a Secure Shell (SSH) session to a remote host. Both public key and password authentication are supported. Public key authentication is attempted using the local ssh client key. If public key authentication fails, password authentication is used.

The ssh client maintains a list of public keys for the hosts that have been previous contacted. If the key received from the remote host does not match the stored key, the connection is aborted. Stored host keys can be edited with the [configure known-hosts](https://docs.islandrouter.com/island-router-cli-2.3.2/commands/configure-known-hosts.md) command or deleted with the [clear ssh known-hosts](https://docs.islandrouter.com/island-router-cli-2.3.2/commands/clear-ssh-known-hosts.md) command.

If command is given, the specified string is passed to the remote system for execution instead of invoking a login shell.

## Examples

```
ssh jane@server.example.com
```

## Related Commands

{% content-ref url="/pages/fMECIDqCfpq8ddiHEAVc" %}
[clear ssh client-keys](https://docs.islandrouter.com/island-router-cli-2.3.2/commands/clear-ssh-client-keys.md)
{% endcontent-ref %}

{% content-ref url="/pages/3iByrhLFgNniteiLpR0x" %}
[configure known-hosts](https://docs.islandrouter.com/island-router-cli-2.3.2/commands/configure-known-hosts.md)
{% endcontent-ref %}

{% content-ref url="/pages/ZB3D3FpaqxVZ41b2qa48" %}
[show config known-hosts](https://docs.islandrouter.com/island-router-cli-2.3.2/commands/show-config-known-hosts.md)
{% endcontent-ref %}

{% content-ref url="/pages/z00bUJDdrrrRHRNwwhy9" %}
[clear ssh known-hosts](https://docs.islandrouter.com/island-router-cli-2.3.2/commands/clear-ssh-known-hosts.md)
{% endcontent-ref %}

{% content-ref url="/pages/kIOwTaIXBHfo5Vzi53Wd" %}
[clear ssh host-keys](https://docs.islandrouter.com/island-router-cli-2.3.2/commands/clear-ssh-host-keys.md)
{% endcontent-ref %}

{% content-ref url="/pages/3k1byephVRA7qCis1tXd" %}
[telnet](https://docs.islandrouter.com/island-router-cli-2.3.2/commands/telnet.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.islandrouter.com/island-router-cli-2.3.2/commands/ssh.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
