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

# SSH

There are three methods that can be used to authenticate a SHH connection:

* Basic Auth
* PEM file
* Vault

### [Listing of all SSH Actions](https://github.com/unskript/docs/blob/main/connnecting/connectors/ssh/action_ssh/README.md)

### Parameters

To connect via SSH you'll need to provide the following parameters (depending on your Authentication type, the requirements change):

| Name                    | Description                                                | Authentication Type |
| ----------------------- | ---------------------------------------------------------- | ------------------- |
| Name                    | This credential will be listed using the name you provide  | All                 |
| Port                    | SSH port to connect to                                     | All                 |
| Username                | User to connect as. Defaults to logged in user             | All                 |
| Password                | Password to use for password authentication                | Basic Auth          |
| Proxy User              | username for Proxy                                         | Basic Auth          |
| Proxy password          | password for Proxy                                         | Basic Auth          |
| Private Key File        | Contents of the Private Key File to use for authentication | PEM                 |
| Proxy Private Ket FileP | PEM file for proxy authentication                          | PEM                 |
| Vault URL               |                                                            | Vault               |
| SSH Secret Path         |                                                            | Vault               |
| Vault Role              |                                                            | Vault               |


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.unskript.com/unskript-documentation/connnecting/connectors/ssh.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.