Send a command to a remote server using SSH.

yaml
type: "io.kestra.plugin.fs.ssh.command"

Run SSH command using password authentication

yaml
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: pass
    commands: ['ls']

Run SSH command using public key authentication (must be an OpenSSH private key)

yaml
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

yaml
id: ssh
namespace: company.team
tasks:
  - id: ssh
    type: io.kestra.plugin.fs.ssh.Command
    authMethod: OPEN_SSH
    useOpenSSHConfig: true
    host: localhost
    password: pass.
    commands:
      - echo "Hello World"

SubType string

Min items 1

The list of commands to run on the remote server

Default false

Enable the disabled by default RSA/SHA1 algorithm

Default true

Use WARNING state if any stdErr is sent

Default PASSWORD

Possible Values

PASSWORDPUBLIC_KEYOPEN_SSH

Authentication method

SubType string

Environment variables to pass to the SSH process.

Hostname of the remote server

Default ~/.ssh/config

OpenSSH configuration directory in case the authentication method is OPEN_SSH.

Password on the remote server, required for password auth method

Default 22

Port of the remote server

Private SSH Key to authenticate, required for pubkey auth method

Passphrase used in order to unseal the private key, optional for pubkey auth method

Default no

Whether to check if the host public key could be found among known host, one of 'yes', 'no', 'ask'

Username on the remote server, required for password auth method

Default 0

The exit code of the entire Flow Execution

The value extracted from the output of the executed commands