Send a command to a remote server using SSH.
type: "io.kestra.plugin.fs.ssh.Command"
Examples
Run SSH command using password authentication
id: fs_ssh_command
namespace: company.team
tasks:
- id: command
type: io.kestra.plugin.fs.ssh.Command
host: localhost
port: "22"
authMethod: PASSWORD
username: foo
password: "{{ secret('SSH_PASSWORD') }}"
commands:
- ls
Run SSH command using public key authentication (must be an OpenSSH private key)
id: fs_ssh_command
namespace: company.team
tasks:
- id: command
type: io.kestra.plugin.fs.ssh.Command
host: localhost
port: "22"
authMethod: PUBLIC_KEY
username: root
privateKey: "{{ secret('SSH_RSA_PRIVATE_KEY') }}"
commands:
- touch kestra_was_here
Run SSH command using the local OpenSSH configuration
id: ssh
namespace: company.team
tasks:
- id: ssh
type: io.kestra.plugin.fs.ssh.Command
authMethod: OPEN_SSH
useOpenSSHConfig: true
host: localhost
password: "{{ secret('SSH_PASSWORD') }}"
commands:
- echo "Hello World"
Properties
commands *Requiredarray
1
The list of commands to run on the remote server
host *Requiredstring
Hostname of the remote server
authMethod string
PASSWORD
PASSWORD
PUBLIC_KEY
OPEN_SSH
Authentication method
enableSshRsa1 booleanstring
false
Enable the disabled by default RSA/SHA1 algorithm
env object
Environment variables to pass to the SSH process.
openSSHConfigDir string
~/.ssh/config
OpenSSH configuration directory in case the authentication method is OPEN_SSH
.
password string
Password on the remote server, required for password auth method
port string
22
Port of the remote server
privateKey string
Private SSH Key to authenticate, required for pubkey auth method
privateKeyPassphrase string
Passphrase used in order to unseal the private key, optional for pubkey auth method
strictHostKeyChecking string
no
Whether to check if the host public key could be found among known host, one of 'yes', 'no', 'ask'
username string
Username on the remote server, required for password auth method
Outputs
exitCode integer
0
The exit code of the entire flow execution.
outputFiles object
The output files' URIs in Kestra's internal storage.
taskRunner TaskRunnerDetailResult
vars object
The value extracted from the output of the executed commands
.