SSH

Usage Instructions

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

Tools

`ssh_execute_command`

Input

Parameter	Type	Required	Description
`host`	string	Yes	No description
`port`	number	Yes	No description
`username`	string	Yes	No description
`password`	string	No	No description
`privateKey`	string	No	No description
`passphrase`	string	No	No description
`command`	string	Yes	No description
`workingDirectory`	string	No	No description

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)
`message`	string	Operation status message

`ssh_execute_script`

Input

Parameter	Type	Required	Description
`host`	string	Yes	No description
`port`	number	Yes	No description
`username`	string	Yes	No description
`password`	string	No	No description
`privateKey`	string	No	No description
`passphrase`	string	No	No description
`script`	string	Yes	No description
`interpreter`	string	No	No description
`workingDirectory`	string	No	No description

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
`message`	string	Operation status message

`ssh_check_command_exists`

Input

Parameter	Type	Required	Description
`host`	string	Yes	No description
`port`	number	Yes	No description
`username`	string	Yes	No description
`password`	string	No	No description
`privateKey`	string	No	No description
`passphrase`	string	No	No description
`commandName`	string	Yes	No description

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)
`message`	string	Operation status message

`ssh_upload_file`

Input

Parameter	Type	Required	Description
`host`	string	Yes	No description
`port`	number	Yes	No description
`username`	string	Yes	No description
`password`	string	No	No description
`privateKey`	string	No	No description
`passphrase`	string	No	No description
`fileContent`	string	Yes	No description
`fileName`	string	Yes	No description
`remotePath`	string	Yes	No description
`permissions`	string	No	No description
`overwrite`	boolean	No	No description

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
`message`	string	Operation status message

`ssh_download_file`

Input

Parameter	Type	Required	Description
`host`	string	Yes	No description
`port`	number	Yes	No description
`username`	string	Yes	No description
`password`	string	No	No description
`privateKey`	string	No	No description
`passphrase`	string	No	No description
`remotePath`	string	Yes	No description

Output

Parameter	Type	Description
`downloaded`	boolean	Whether the file was downloaded successfully
`file`	file	Downloaded file stored in execution files
`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
`message`	string	Operation status message

`ssh_list_directory`

Input

Parameter	Type	Required	Description
`host`	string	Yes	No description
`port`	number	Yes	No description
`username`	string	Yes	No description
`password`	string	No	No description
`privateKey`	string	No	No description
`passphrase`	string	No	No description
`path`	string	Yes	No description
`detailed`	boolean	No	No description
`recursive`	boolean	No	No description

Output

Parameter	Type	Description
`entries`	array	Array of file and directory entries
↳ `name`	string	File or directory name
↳ `type`	string	Entry type (file, directory, symlink)
↳ `size`	number	File size in bytes
↳ `permissions`	string	File permissions
↳ `modified`	string	Last modified timestamp
`totalFiles`	number	Total number of files
`totalDirectories`	number	Total number of directories
`message`	string	Operation status message

`ssh_check_file_exists`

Input

Parameter	Type	Required	Description
`host`	string	Yes	No description
`port`	number	Yes	No description
`username`	string	Yes	No description
`password`	string	No	No description
`privateKey`	string	No	No description
`passphrase`	string	No	No description
`path`	string	Yes	No description
`type`	string	No	No description

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
`message`	string	Operation status message

`ssh_create_directory`

Input

Parameter	Type	Required	Description
`host`	string	Yes	No description
`port`	number	Yes	No description
`username`	string	Yes	No description
`password`	string	No	No description
`privateKey`	string	No	No description
`passphrase`	string	No	No description
`path`	string	Yes	No description
`recursive`	boolean	No	No description
`permissions`	string	No	No description

Output

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

`ssh_delete_file`

Input

Parameter	Type	Required	Description
`host`	string	Yes	No description
`port`	number	Yes	No description
`username`	string	Yes	No description
`password`	string	No	No description
`privateKey`	string	No	No description
`passphrase`	string	No	No description
`path`	string	Yes	No description
`recursive`	boolean	No	No description
`force`	boolean	No	No description

Output

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

`ssh_move_rename`

Input

Parameter	Type	Required	Description
`host`	string	Yes	No description
`port`	number	Yes	No description
`username`	string	Yes	No description
`password`	string	No	No description
`privateKey`	string	No	No description
`passphrase`	string	No	No description
`sourcePath`	string	Yes	No description
`destinationPath`	string	Yes	No description
`overwrite`	boolean	No	No description

Output

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

`ssh_get_system_info`

Input

Parameter	Type	Required	Description
`host`	string	Yes	No description
`port`	number	Yes	No description
`username`	string	Yes	No description
`password`	string	No	No description
`privateKey`	string	No	No description
`passphrase`	string	No	No description

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)
`message`	string	Operation status message

`ssh_read_file_content`

Input

Parameter	Type	Required	Description
`host`	string	Yes	No description
`port`	number	Yes	No description
`username`	string	Yes	No description
`password`	string	No	No description
`privateKey`	string	No	No description
`passphrase`	string	No	No description
`path`	string	Yes	No description
`encoding`	string	No	No description
`maxSize`	number	No	No description

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
`message`	string	Operation status message

`ssh_write_file_content`

Input

Parameter	Type	Required	Description
`host`	string	Yes	No description
`port`	number	Yes	No description
`username`	string	Yes	No description
`password`	string	No	No description
`privateKey`	string	No	No description
`passphrase`	string	No	No description
`path`	string	Yes	No description
`content`	string	Yes	No description
`mode`	string	No	No description
`permissions`	string	No	No description

Output

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

On this page