SSH
The SSH node executes commands and shell scripts on remote servers over a secure SSH connection. This is useful for server administration, deployment scripts, health checks, and any automation that requires running commands on remote Linux/Unix systems.
Before You Use This Node
| What you may need | Where to set it up | Why it matters |
|---|---|---|
| SSH server connection | Connections | Save host, port, username, and authentication once, then reuse them. |
| Private key file, if key-based login is used | Files | Store the key file centrally and reference it from the SSH connection. |
| Common paths, commands, or server names | Global Variables | Reuse common server values without retyping them. |
Actions
| Action | Description |
|---|---|
ssh:executeCommand | Execute a single command on the remote server |
ssh:executeShellScript | Execute a multi-line shell script on the remote server |
ssh:executeCommand
Runs a single command on the remote server and captures the standard output and standard error.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
command | string | Yes | The command to execute |
timeout | integer | No | Command timeout in seconds. Defaults to 60 |
workingDirectory | string | No | Directory to execute the command in |
Example: Check disk usage
ssh:executeShellScript
Uploads and executes a multi-line shell script on the remote server. The script is written to a temporary file, made executable, run, and then cleaned up.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
script | string | Yes | The shell script content (multi-line) |
timeout | integer | No | Script timeout in seconds. Defaults to 120 |
shell | string | No | Shell interpreter to use. Defaults to /bin/bash |
workingDirectory | string | No | Directory to execute the script in |
Example: Log rotation script
Connection
Requires an SSH connection configured in the Global Configurator:
| Field | Description |
|---|---|
host | Remote server hostname or IP address |
port | SSH port. Defaults to 22 |
username | SSH username |
password | SSH password (if using password authentication) |
privateKey | SSH private key content (if using key-based authentication) |
passphrase | Private key passphrase (if the key is encrypted) |
strictHostKeyChecking | Verify the server's host key. Defaults to true |
Configure under Connections > SSH in the Global Configurator.
Output
Both actions return the command or script output:
If the command exits with a non-zero exit code, the step fails and the error output is captured in stderr: