SSH

SSH (Secure Shell) é um protocolo amplamente utilizado para conectar-se com segurança a servidores remotos, permitindo que você execute comandos, transfira arquivos e gerencie sistemas através de canais criptografados.

Com suporte SSH no Zippy, seus agentes podem:

Executar comandos remotos: Execute comandos shell em qualquer servidor acessível via SSH
Enviar e executar scripts: Transfira e execute facilmente scripts de múltiplas linhas para automação avançada
Transferir arquivos com segurança: Faça upload e download de arquivos como parte dos seus fluxos de trabalho (em breve ou via comando)
Automatizar gerenciamento de servidores: Execute atualizações, manutenção, monitoramento, implantações e tarefas de configuração programaticamente
Usar autenticação flexível: Conecte-se com autenticação por senha ou chave privada, incluindo suporte para chaves criptografadas

As seguintes ferramentas SSH do Zippy permitem que seus agentes interajam com servidores como parte de automações maiores:

ssh_execute_command: Execute qualquer comando shell único remotamente e capture saída, status e erros.
ssh_execute_script: Envie e execute um script completo de múltiplas linhas no sistema remoto.
(Ferramentas adicionais em breve, como transferência de arquivos.)

Ao integrar SSH aos seus fluxos de trabalho de agentes, você pode automatizar acesso seguro, operações remotas e orquestração de servidores—simplificando DevOps, automação de TI e gerenciamento remoto personalizado, tudo dentro do Zippy.

Parâmetro	Tipo	Obrigatório	Descrição
`host`	string	Sim	Nome do host ou endereço IP do servidor SSH
`port`	number	Sim	Porta do servidor SSH (padrão: 22)
`username`	string	Sim	Nome de usuário SSH
`password`	string	Não	Senha para autenticação (se não estiver usando chave privada)
`privateKey`	string	Não	Chave privada para autenticação (formato OpenSSH)
`passphrase`	string	Não	Frase-senha para chave privada criptografada
`command`	string	Sim	Comando shell a executar no servidor remoto
`workingDirectory`	string	Não	Diretório de trabalho para execução do comando

Saída

Parâmetro	Tipo	Descrição
`stdout`	string	Saída padrão do comando
`stderr`	string	Saída de erro padrão
`exitCode`	number	Código de saída do comando
`success`	boolean	Se o comando foi bem-sucedido (código de saída 0)
`message`	string	Mensagem de status da operação

`ssh_execute_script`

Envia e executa um script de múltiplas linhas em um servidor SSH remoto

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`host`	string	Sim	Nome do host ou endereço IP do servidor SSH
`port`	number	Sim	Porta do servidor SSH (padrão: 22)
`username`	string	Sim	Nome de usuário SSH
`password`	string	Não	Senha para autenticação (se não estiver usando chave privada)
`privateKey`	string	Não	Chave privada para autenticação (formato OpenSSH)
`passphrase`	string	Não	Frase-senha para chave privada criptografada
`script`	string	Sim	Conteúdo do script a executar (bash, python, etc.)
`interpreter`	string	Não	Interpretador de script (padrão: /bin/bash)
`workingDirectory`	string	Não	Diretório de trabalho para execução do script

Saída

Parâmetro	Tipo	Descrição
`stdout`	string	Saída padrão do script
`stderr`	string	Saída de erro padrão
`exitCode`	number	Código de saída do script
`success`	boolean	Se o script foi bem-sucedido (código de saída 0)
`scriptPath`	string	Caminho temporário onde o script foi enviado
`message`	string	Mensagem de status da operação

`ssh_check_command_exists`

Verifica se um comando/programa existe no servidor SSH remoto

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`host`	string	Sim	Nome do host ou endereço IP do servidor SSH
`port`	number	Sim	Porta do servidor SSH (padrão: 22)
`username`	string	Sim	Nome de usuário SSH
`password`	string	Não	Senha para autenticação (se não estiver usando chave privada)
`privateKey`	string	Não	Chave privada para autenticação (formato OpenSSH)
`passphrase`	string	Não	Frase-senha para chave privada criptografada
`commandName`	string	Sim	Command name to check (e.g., docker, git, python3)

Saída

Parâmetro	Tipo	Descrição
`commandExists`	boolean	Whether the command exists
`commandPath`	string	Full path to the command (if found)
`version`	string	Command version output (if applicable)
`message`	string	Mensagem de status da operação

`ssh_upload_file`

Upload a file to a remote SSH server

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`host`	string	Sim	Nome do host ou endereço IP do servidor SSH
`port`	number	Sim	Porta do servidor SSH (padrão: 22)
`username`	string	Sim	Nome de usuário SSH
`password`	string	Não	Senha para autenticação (se não estiver usando chave privada)
`privateKey`	string	Não	Chave privada para autenticação (formato OpenSSH)
`passphrase`	string	Não	Frase-senha para chave privada criptografada
`fileContent`	string	Sim	File content to upload (base64 encoded for binary files)
`fileName`	string	Sim	Name of the file being uploaded
`remotePath`	string	Sim	Destination path on the remote server
`permissions`	string	Não	File permissions (e.g., 0644)
`overwrite`	boolean	Não	Whether to overwrite existing files (default: true)

Saída

Parâmetro	Tipo	Descrição
`uploaded`	boolean	Whether the file was uploaded successfully
`remotePath`	string	Final path on the remote server
`size`	number	File size in bytes
`message`	string	Mensagem de status da operação

`ssh_download_file`

Download a file from a remote SSH server

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`host`	string	Sim	Nome do host ou endereço IP do servidor SSH
`port`	number	Sim	Porta do servidor SSH (padrão: 22)
`username`	string	Sim	Nome de usuário SSH
`password`	string	Não	Senha para autenticação (se não estiver usando chave privada)
`privateKey`	string	Não	Chave privada para autenticação (formato OpenSSH)
`passphrase`	string	Não	Frase-senha para chave privada criptografada
`remotePath`	string	Sim	Path of the file on the remote server

Saída

Parâmetro	Tipo	Descrição
`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
`message`	string	Mensagem de status da operação

`ssh_list_directory`

List files and directories in a remote directory

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`host`	string	Sim	Nome do host ou endereço IP do servidor SSH
`port`	number	Sim	Porta do servidor SSH (padrão: 22)
`username`	string	Sim	Nome de usuário SSH
`password`	string	Não	Senha para autenticação (se não estiver usando chave privada)
`privateKey`	string	Não	Chave privada para autenticação (formato OpenSSH)
`passphrase`	string	Não	Frase-senha para chave privada criptografada
`path`	string	Sim	Remote directory path to list
`detailed`	boolean	Não	Include file details (size, permissions, modified date)
`recursive`	boolean	Não	List subdirectories recursively (default: false)

Saída

Parâmetro	Tipo	Descrição
`entries`	array	Array of file and directory entries

`ssh_check_file_exists`

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

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`host`	string	Sim	Nome do host ou endereço IP do servidor SSH
`port`	number	Sim	Porta do servidor SSH (padrão: 22)
`username`	string	Sim	Nome de usuário SSH
`password`	string	Não	Senha para autenticação (se não estiver usando chave privada)
`privateKey`	string	Não	Chave privada para autenticação (formato OpenSSH)
`passphrase`	string	Não	Frase-senha para chave privada criptografada
`path`	string	Sim	Remote file or directory path to check
`type`	string	Não	Expected type: file, directory, or any (default: any)

Saída

Parâmetro	Tipo	Descrição
`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	Mensagem de status da operação

`ssh_create_directory`

Create a directory on the remote SSH server

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`host`	string	Sim	Nome do host ou endereço IP do servidor SSH
`port`	number	Sim	Porta do servidor SSH (padrão: 22)
`username`	string	Sim	Nome de usuário SSH
`password`	string	Não	Senha para autenticação (se não estiver usando chave privada)
`privateKey`	string	Não	Chave privada para autenticação (formato OpenSSH)
`passphrase`	string	Não	Frase-senha para chave privada criptografada
`path`	string	Sim	Directory path to create
`recursive`	boolean	Não	Create parent directories if they do not exist (default: true)
`permissions`	string	Não	Directory permissions (default: 0755)

Saída

Parâmetro	Tipo	Descrição
`created`	boolean	Whether the directory was created successfully
`remotePath`	string	Created directory path
`alreadyExists`	boolean	Whether the directory already existed
`message`	string	Mensagem de status da operação

`ssh_delete_file`

Delete a file or directory from the remote SSH server

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`host`	string	Sim	Nome do host ou endereço IP do servidor SSH
`port`	number	Sim	Porta do servidor SSH (padrão: 22)
`username`	string	Sim	Nome de usuário SSH
`password`	string	Não	Senha para autenticação (se não estiver usando chave privada)
`privateKey`	string	Não	Chave privada para autenticação (formato OpenSSH)
`passphrase`	string	Não	Frase-senha para chave privada criptografada
`path`	string	Sim	Path to delete
`recursive`	boolean	Não	Recursively delete directories (default: false)
`force`	boolean	Não	Force deletion without confirmation (default: false)

Saída

Parâmetro	Tipo	Descrição
`deleted`	boolean	Whether the path was deleted successfully
`remotePath`	string	Deleted path
`message`	string	Mensagem de status da operação

`ssh_move_rename`

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

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`host`	string	Sim	Nome do host ou endereço IP do servidor SSH
`port`	number	Sim	Porta do servidor SSH (padrão: 22)
`username`	string	Sim	Nome de usuário SSH
`password`	string	Não	Senha para autenticação (se não estiver usando chave privada)
`privateKey`	string	Não	Chave privada para autenticação (formato OpenSSH)
`passphrase`	string	Não	Frase-senha para chave privada criptografada
`sourcePath`	string	Sim	Current path of the file or directory
`destinationPath`	string	Sim	New path for the file or directory
`overwrite`	boolean	Não	Overwrite destination if it exists (default: false)

Saída

Parâmetro	Tipo	Descrição
`moved`	boolean	Whether the operation was successful
`sourcePath`	string	Original path
`destinationPath`	string	New path
`message`	string	Mensagem de status da operação

`ssh_get_system_info`

Retrieve system information from the remote SSH server

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`host`	string	Sim	Nome do host ou endereço IP do servidor SSH
`port`	number	Sim	Porta do servidor SSH (padrão: 22)
`username`	string	Sim	Nome de usuário SSH
`password`	string	Não	Senha para autenticação (se não estiver usando chave privada)
`privateKey`	string	Não	Chave privada para autenticação (formato OpenSSH)
`passphrase`	string	Não	Frase-senha para chave privada criptografada

Saída

Parâmetro	Tipo	Descrição
`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	Mensagem de status da operação

`ssh_read_file_content`

Read the contents of a remote file

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`host`	string	Sim	Nome do host ou endereço IP do servidor SSH
`port`	number	Sim	Porta do servidor SSH (padrão: 22)
`username`	string	Sim	Nome de usuário SSH
`password`	string	Não	Senha para autenticação (se não estiver usando chave privada)
`privateKey`	string	Não	Chave privada para autenticação (formato OpenSSH)
`passphrase`	string	Não	Frase-senha para chave privada criptografada
`path`	string	Sim	Remote file path to read
`encoding`	string	Não	File encoding (default: utf-8)
`maxSize`	number	Não	Maximum file size to read in MB (default: 10)

Saída

Parâmetro	Tipo	Descrição
`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	Mensagem de status da operação

`ssh_write_file_content`

Write or append content to a remote file

Entrada

Parâmetro	Tipo	Obrigatório	Descrição
`host`	string	Sim	Nome do host ou endereço IP do servidor SSH
`port`	number	Sim	Porta do servidor SSH (padrão: 22)
`username`	string	Sim	Nome de usuário SSH
`password`	string	Não	Senha para autenticação (se não estiver usando chave privada)
`privateKey`	string	Não	Chave privada para autenticação (formato OpenSSH)
`passphrase`	string	Não	Frase-senha para chave privada criptografada
`path`	string	Sim	Remote file path to write to
`content`	string	Sim	Content to write to the file
`mode`	string	Não	Write mode: overwrite, append, or create (default: overwrite)
`permissions`	string	Não	File permissions (e.g., 0644)

Saída

Parâmetro	Tipo	Descrição
`written`	boolean	Whether the file was written successfully
`remotePath`	string	File path
`size`	number	Final file size in bytes
`message`	string	Mensagem de status da operação

Notas

Categoria: tools
Tipo: ssh

SSH

On this page