You are viewing an outdated version of the documentation.

This documentation is for an older version (1.4.7) of Dagster. You can view the version of this page from our latest release below.

SSH / SFTP (dagster-ssh)

This library provides an integration with SSH and SFTP.

class dagster_ssh.SSHResource(remote_host, remote_port, username=None, password=None, key_file=None, key_string=None, timeout=10, keepalive_interval=30, compress=True, no_host_key_check=True, allow_host_key_change=False, logger=None)[source]

Resource for ssh remote execution using Paramiko.

ref: https://github.com/paramiko/paramiko

dagster_ssh.ssh_resource ResourceDefinition[source]

Config Schema:
remote_host (dagster.StringSource):

remote host to connect to

remote_port (dagster.IntSource, optional):

port of remote host to connect (Default is paramiko SSH_PORT)

Default Value: 22

username (dagster.StringSource, optional):

username to connect to the remote_host

password (dagster.StringSource, optional):

password of the username to connect to the remote_host

key_file (dagster.StringSource, optional):

key file to use to connect to the remote_host.

key_string (dagster.StringSource, optional):

key string to use to connect to remote_host

timeout (dagster.IntSource, optional):

timeout for the attempt to connect to the remote_host.

Default Value: 10

keepalive_interval (dagster.IntSource, optional):

send a keepalive packet to remote host every keepalive_interval seconds

Default Value: 30

compress (dagster.BoolSource, optional):

Default Value: True

no_host_key_check (dagster.BoolSource, optional):

Default Value: True

allow_host_key_change (dagster.BoolSource, optional):

[Deprecated]

Default Value: False