SSH

Configuration

Execute Command

Operation

Execute Command

Host*

example.com or 192.168.1.100

Port

Username*

ubuntu, root, or deploy

Authentication Method

Select...

Password

••••••••

Private Key

plaintext

-----BEGIN OPENSSH PRIVATE KEY-----\n...

Passphrase

••••••••

Command*

plaintext

ls -la /var/www

Working Directory

/var/www/html (optional)

Execute Command (ssh_execute_command)

Execute a shell command on a remote SSH server

Input

Parameter	Type	Required	Description
`host`	string	Yes	SSH server hostname or IP address
`port`	number	Yes	SSH server port (default: 22)
`username`	string	Yes	SSH username
`password`	string	No	Password for authentication (if not using private key)
`privateKey`	string	No	Private key for authentication (OpenSSH format)
`passphrase`	string	No	Passphrase for encrypted private key
`command`	string	Yes	Shell command to execute on the remote server
`workingDirectory`	string	No	Working directory for command execution

Output

Parameter	Type	Description
`stdout`	string	Standard output from command
`stderr`	string	Standard error output
`exitCode`	number	Command exit code
`success`	boolean	Whether command succeeded (exit code 0)

Execute Script

Operation

Execute Script

Host*

example.com or 192.168.1.100

Port

Username*

ubuntu, root, or deploy

Authentication Method

Select...

Password

••••••••

Private Key

plaintext

-----BEGIN OPENSSH PRIVATE KEY-----\n...

Passphrase

••••••••

Script Content*

plaintext

#!/bin/bash\necho "Hello World"

Interpreter

/bin/bash

Working Directory

/var/www/html (optional)

Execute Script (ssh_execute_script)

Upload and execute a multi-line script on a remote SSH server

Input

Parameter	Type	Required	Description
`host`	string	Yes	SSH server hostname or IP address
`port`	number	Yes	SSH server port (default: 22)
`username`	string	Yes	SSH username
`password`	string	No	Password for authentication (if not using private key)
`privateKey`	string	No	Private key for authentication (OpenSSH format)
`passphrase`	string	No	Passphrase for encrypted private key
`script`	string	Yes	Script content to execute (bash, python, etc.)
`interpreter`	string	No	Script interpreter (default: /bin/bash)
`workingDirectory`	string	No	Working directory for script execution

Output

Parameter	Type	Description
`stdout`	string	Standard output from script
`stderr`	string	Standard error output
`exitCode`	number	Script exit code
`success`	boolean	Whether script succeeded (exit code 0)
`scriptPath`	string	Temporary path where script was uploaded

Check Command Exists

Operation

Check Command Exists

Host*

example.com or 192.168.1.100

Port

Username*

ubuntu, root, or deploy

Authentication Method

Select...

Password

••••••••

Private Key

plaintext

-----BEGIN OPENSSH PRIVATE KEY-----\n...

Passphrase

••••••••

Command Name*

docker, git, python3

Check Command Exists (ssh_check_command_exists)

Check if a command/program exists on the remote SSH server

Input

Parameter	Type	Required	Description
`host`	string	Yes	SSH server hostname or IP address
`port`	number	Yes	SSH server port (default: 22)
`username`	string	Yes	SSH username
`password`	string	No	Password for authentication (if not using private key)
`privateKey`	string	No	Private key for authentication (OpenSSH format)
`passphrase`	string	No	Passphrase for encrypted private key
`commandName`	string	Yes	Command name to check (e.g., docker, git, python3)

Output

Parameter	Type	Description
`commandExists`	boolean	Whether the command exists
`commandPath`	string	Full path to the command (if found)
`version`	string	Command version output (if applicable)

Upload File

Operation

Upload File

Host*

example.com or 192.168.1.100

Port

Username*

ubuntu, root, or deploy

Authentication Method

Select...

Password

••••••••

Private Key

plaintext

-----BEGIN OPENSSH PRIVATE KEY-----\n...

Passphrase

••••••••

File Content*

plaintext

Content to upload...

File Name*

config.json

Remote Path*

/var/www/html/config.json

Permissions

0644

Upload File (ssh_upload_file)

Upload a file to a remote SSH server

Input

Parameter	Type	Required	Description
`host`	string	Yes	SSH server hostname or IP address
`port`	number	Yes	SSH server port (default: 22)
`username`	string	Yes	SSH username
`password`	string	No	Password for authentication (if not using private key)
`privateKey`	string	No	Private key for authentication (OpenSSH format)
`passphrase`	string	No	Passphrase for encrypted private key
`fileContent`	string	Yes	File content to upload (base64 encoded for binary files)
`fileName`	string	Yes	Name of the file being uploaded
`remotePath`	string	Yes	Destination path on the remote server
`permissions`	string	No	File permissions (e.g., 0644)
`overwrite`	boolean	No	Whether to overwrite existing files (default: true)

Output

Parameter	Type	Description
`uploaded`	boolean	Whether the file was uploaded successfully
`remotePath`	string	Final path on the remote server
`size`	number	File size in bytes

Download File

Operation

Download File

Host*

example.com or 192.168.1.100

Port

Username*

ubuntu, root, or deploy

Authentication Method

Select...

Password

••••••••

Private Key

plaintext

-----BEGIN OPENSSH PRIVATE KEY-----\n...

Passphrase

••••••••

Remote File Path*

/var/log/app.log

Download File (ssh_download_file)

Download a file from a remote SSH server

Input

Parameter	Type	Required	Description
`host`	string	Yes	SSH server hostname or IP address
`port`	number	Yes	SSH server port (default: 22)
`username`	string	Yes	SSH username
`password`	string	No	Password for authentication (if not using private key)
`privateKey`	string	No	Private key for authentication (OpenSSH format)
`passphrase`	string	No	Passphrase for encrypted private key
`remotePath`	string	Yes	Path of the file on the remote server

Output

Parameter	Type	Description
`downloaded`	boolean	Whether the file was downloaded successfully
`fileContent`	string	File content (base64 encoded for binary files)
`fileName`	string	Name of the downloaded file
`remotePath`	string	Source path on the remote server
`size`	number	File size in bytes

List Directory

Operation

List Directory

Host*

example.com or 192.168.1.100

Port

Username*

ubuntu, root, or deploy

Authentication Method

Select...

Password

••••••••

Private Key

plaintext

-----BEGIN OPENSSH PRIVATE KEY-----\n...

Passphrase

••••••••

Directory Path*

/var/www

Show Details

Disabled

List Directory (ssh_list_directory)

List files and directories in a remote directory

Input

Parameter	Type	Required	Description
`host`	string	Yes	SSH server hostname or IP address
`port`	number	Yes	SSH server port (default: 22)
`username`	string	Yes	SSH username
`password`	string	No	Password for authentication (if not using private key)
`privateKey`	string	No	Private key for authentication (OpenSSH format)
`passphrase`	string	No	Passphrase for encrypted private key
`path`	string	Yes	Remote directory path to list
`detailed`	boolean	No	Include file details (size, permissions, modified date)
`recursive`	boolean	No	List subdirectories recursively (default: false)

Output

Parameter	Type	Description
`name`	string	File or directory name
`type`	string	Entry type (file, directory, symlink)
`size`	number	File size in bytes
`permissions`	string	File permissions

Check File/Directory Exists

Operation

Check File/Directory Exists

Host*

example.com or 192.168.1.100

Port

Username*

ubuntu, root, or deploy

Authentication Method

Select...

Password

••••••••

Private Key

plaintext

-----BEGIN OPENSSH PRIVATE KEY-----\n...

Passphrase

••••••••

Path to Check*

/etc/nginx/nginx.conf

Expected Type

Select...

Check File/Directory Exists (ssh_check_file_exists)

Check if a file or directory exists on the remote SSH server

Input

Parameter	Type	Required	Description
`host`	string	Yes	SSH server hostname or IP address
`port`	number	Yes	SSH server port (default: 22)
`username`	string	Yes	SSH username
`password`	string	No	Password for authentication (if not using private key)
`privateKey`	string	No	Private key for authentication (OpenSSH format)
`passphrase`	string	No	Passphrase for encrypted private key
`path`	string	Yes	Remote file or directory path to check
`type`	string	No	Expected type: file, directory, or any (default: any)

Output

Parameter	Type	Description
`exists`	boolean	Whether the path exists
`type`	string	Type of path (file, directory, symlink, not_found)
`size`	number	File size if it is a file
`permissions`	string	File permissions (e.g., 0755)
`modified`	string	Last modified timestamp

Create Directory

Operation

Create Directory

Host*

example.com or 192.168.1.100

Port

Username*

ubuntu, root, or deploy

Authentication Method

Select...

Password

••••••••

Private Key

plaintext

-----BEGIN OPENSSH PRIVATE KEY-----\n...

Passphrase

••••••••

Directory Path*

/var/www/new-site

Create Parent Directories

Enabled

Create Directory (ssh_create_directory)

Create a directory on the remote SSH server

Input

Parameter	Type	Required	Description
`host`	string	Yes	SSH server hostname or IP address
`port`	number	Yes	SSH server port (default: 22)
`username`	string	Yes	SSH username
`password`	string	No	Password for authentication (if not using private key)
`privateKey`	string	No	Private key for authentication (OpenSSH format)
`passphrase`	string	No	Passphrase for encrypted private key
`path`	string	Yes	Directory path to create
`recursive`	boolean	No	Create parent directories if they do not exist (default: true)
`permissions`	string	No	Directory permissions (default: 0755)

Output

Parameter	Type	Description
`created`	boolean	Whether the directory was created successfully
`remotePath`	string	Created directory path
`alreadyExists`	boolean	Whether the directory already existed

Delete File/Directory

Operation

Delete File/Directory

Host*

example.com or 192.168.1.100

Port

Username*

ubuntu, root, or deploy

Authentication Method

Select...

Password

••••••••

Private Key

plaintext

-----BEGIN OPENSSH PRIVATE KEY-----\n...

Passphrase

••••••••

Path to Delete*

/tmp/old-file.txt

Recursive Delete

Disabled

Force Delete

Disabled

Delete File/Directory (ssh_delete_file)

Delete a file or directory from the remote SSH server

Input

Parameter	Type	Required	Description
`host`	string	Yes	SSH server hostname or IP address
`port`	number	Yes	SSH server port (default: 22)
`username`	string	Yes	SSH username
`password`	string	No	Password for authentication (if not using private key)
`privateKey`	string	No	Private key for authentication (OpenSSH format)
`passphrase`	string	No	Passphrase for encrypted private key
`path`	string	Yes	Path to delete
`recursive`	boolean	No	Recursively delete directories (default: false)
`force`	boolean	No	Force deletion without confirmation (default: false)

Output

Parameter	Type	Description
`deleted`	boolean	Whether the path was deleted successfully
`remotePath`	string	Deleted path

Move/Rename

Operation

Move/Rename

Host*

example.com or 192.168.1.100

Port

Username*

ubuntu, root, or deploy

Authentication Method

Select...

Password

••••••••

Private Key

plaintext

-----BEGIN OPENSSH PRIVATE KEY-----\n...

Passphrase

••••••••

Source Path*

/var/www/old-name

Destination Path*

/var/www/new-name

Overwrite if Exists

Disabled

Move/Rename (ssh_move_rename)

Move or rename a file or directory on the remote SSH server

Input

Parameter	Type	Required	Description
`host`	string	Yes	SSH server hostname or IP address
`port`	number	Yes	SSH server port (default: 22)
`username`	string	Yes	SSH username
`password`	string	No	Password for authentication (if not using private key)
`privateKey`	string	No	Private key for authentication (OpenSSH format)
`passphrase`	string	No	Passphrase for encrypted private key
`sourcePath`	string	Yes	Current path of the file or directory
`destinationPath`	string	Yes	New path for the file or directory
`overwrite`	boolean	No	Overwrite destination if it exists (default: false)

Output

Parameter	Type	Description
`moved`	boolean	Whether the operation was successful
`sourcePath`	string	Original path
`destinationPath`	string	New path

Get System Info

Operation

Get System Info

Host*

example.com or 192.168.1.100

Port

Username*

ubuntu, root, or deploy

Authentication Method

Select...

Password

••••••••

Private Key

plaintext

-----BEGIN OPENSSH PRIVATE KEY-----\n...

Passphrase

••••••••

Get System Info (ssh_get_system_info)

Retrieve system information from the remote SSH server

Input

Parameter	Type	Required	Description
`host`	string	Yes	SSH server hostname or IP address
`port`	number	Yes	SSH server port (default: 22)
`username`	string	Yes	SSH username
`password`	string	No	Password for authentication (if not using private key)
`privateKey`	string	No	Private key for authentication (OpenSSH format)
`passphrase`	string	No	Passphrase for encrypted private key

Output

Parameter	Type	Description
`hostname`	string	Server hostname
`os`	string	Operating system (e.g., Linux, Darwin)
`architecture`	string	CPU architecture (e.g., x64, arm64)
`uptime`	number	System uptime in seconds
`memory`	json	Memory information (total, free, used)
`diskSpace`	json	Disk space information (total, free, used)

Read File Content

Operation

Read File Content

Host*

example.com or 192.168.1.100

Port

Username*

ubuntu, root, or deploy

Authentication Method

Select...

Password

••••••••

Private Key

plaintext

-----BEGIN OPENSSH PRIVATE KEY-----\n...

Passphrase

••••••••

File Path*

/var/log/app.log

Encoding

utf-8

Max Size (MB)

Read File Content (ssh_read_file_content)

Read the contents of a remote file

Input

Parameter	Type	Required	Description
`host`	string	Yes	SSH server hostname or IP address
`port`	number	Yes	SSH server port (default: 22)
`username`	string	Yes	SSH username
`password`	string	No	Password for authentication (if not using private key)
`privateKey`	string	No	Private key for authentication (OpenSSH format)
`passphrase`	string	No	Passphrase for encrypted private key
`path`	string	Yes	Remote file path to read
`encoding`	string	No	File encoding (default: utf-8)
`maxSize`	number	No	Maximum file size to read in MB (default: 10)

Output

Parameter	Type	Description
`content`	string	File content as string
`size`	number	File size in bytes
`lines`	number	Number of lines in file
`remotePath`	string	Remote file path

Write File Content

Operation

Write File Content

Host*

example.com or 192.168.1.100

Port

Username*

ubuntu, root, or deploy

Authentication Method

Select...

Password

••••••••

Private Key

plaintext

-----BEGIN OPENSSH PRIVATE KEY-----\n...

Passphrase

••••••••

File Path*

/etc/config.json

File Content*

plaintext

Content to write...

Write Mode

Select...

Permissions

0644

Write File Content (ssh_write_file_content)

Write or append content to a remote file

Input

Parameter	Type	Required	Description
`host`	string	Yes	SSH server hostname or IP address
`port`	number	Yes	SSH server port (default: 22)
`username`	string	Yes	SSH username
`password`	string	No	Password for authentication (if not using private key)
`privateKey`	string	No	Private key for authentication (OpenSSH format)
`passphrase`	string	No	Passphrase for encrypted private key
`path`	string	Yes	Remote file path to write to
`content`	string	Yes	Content to write to the file
`mode`	string	No	Write mode: overwrite, append, or create (default: overwrite)
`permissions`	string	No	File permissions (e.g., 0644)

Output

Parameter	Type	Description
`written`	boolean	Whether the file was written successfully
`remotePath`	string	File path
`size`	number	Final file size in bytes

Usage Instructions

Execute commands, transfer files, and manage remote servers via SSH. Supports password and private key authentication for secure server access.

Notes

Category: tools
Type: ssh

SSH

On this page