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

# SSH

## Introduction

The SSH (Secure Shell) component in Autom Mate provides essential actions for secure data communication and remote access over networks. It enables users to establish encrypted connections, ensuring data integrity and minimizing security risks associated with remote access.

The purpose of the SSH component is to facilitate secure and automated interactions with remote systems, databases, applications, or services. It allows users to execute commands, transfer data, and manage remote systems securely.

## What is SSH?

SSH (Secure Shell) is a network protocol used for secure communication and remote access. It creates an encrypted connection between the client and server, providing a secure channel for data transmission and remote command execution.

#### Key Features

* <mark style="color:orange;">**Secure Communication**</mark><mark style="color:orange;">:</mark>
  * <mark style="color:orange;">Establishes encrypted connections for secure data transmission.</mark>
* <mark style="color:orange;">**Remote Access**</mark><mark style="color:orange;">:</mark>
  * <mark style="color:orange;">Allows users to remotely access and manage systems or services.</mark>
* <mark style="color:orange;">**Authentication**</mark><mark style="color:orange;">:</mark>
  * <mark style="color:orange;">Provides authentication methods to ensure secure access.</mark>
* <mark style="color:orange;">**Data Integrity**</mark><mark style="color:orange;">:</mark>
  * <mark style="color:orange;">Ensures data integrity during transmission and execution.</mark>

## How To Use Action

### Connect

<figure><img src="/files/m7suzRkORaNmMhMHt4rQ" alt=""><figcaption></figcaption></figure>

**Description :** The **Connect** action enables users to establish SSH connections to remote systems, databases, or services.

**Usage:**

* **User**:
  * <mark style="color:green;">Enter the username for the SSH connection.</mark>
* **Password**:
  * <mark style="color:green;">Enter the password for authentication.</mark>
* **Connection / Custom String**:
  * <mark style="color:green;">Provide the host address or custom connection string.</mark>
* **Test Connection**:
  * <mark style="color:green;">Verify the connection status.</mark>

### Input

<figure><img src="/files/ZMvQxT8gNXbVVR1xf4hW" alt=""><figcaption></figcaption></figure>

**Description:** The **Input** action allows users to remotely input commands or data to a system or device using SSH.

**Usage:**

* **File Path**:
  * <mark style="color:green;">Specify the file path for input data.</mark>
* **Manual Input**:
  * <mark style="color:green;">Manually enter input data or commands.</mark>
* **Assign Value to Variable**:
  * <mark style="color:green;">Assign the input data or command result to a variable.</mark>

### Run Command

<figure><img src="/files/RXgZWlsgS1DMWCCzHG2D" alt=""><figcaption></figcaption></figure>

**Description:** The **Run Command** action executes commands on remote systems or devices using SSH.

**Usage:**

* **File Path**:
  * <mark style="color:green;">Specify the file path for command execution.</mark>
* **Manual Input**:
  * <mark style="color:green;">Manually enter the command to execute.</mark>
* **Assign Value to Variable**:
  * <mark style="color:green;">Assign the command result to a variable.</mark>

### Disconnect

**Description:** The **Disconnect** action terminates the SSH connection to remote hosts.

**Usage:**

* **No Parameters**:
  * <mark style="color:orange;">Simply execute the action to close the SSH connection.</mark>

***

## Additional Tips

### [**Use Cases**](/userguide/use-cases.md)

### [FAQ](/userguide/faq.md)