• Home
• airflow.providers.ssh
• airflow.providers.ssh.hooks
• airflow.providers.ssh.hooks.ssh

airflow.providers.ssh.hooks.ssh

Hook for SSH connections.

Attributes

CMD_TIMEOUT

Classes

SSHHook

Execute remote commands with Paramiko.

Module Contents

airflow.providers.ssh.hooks.ssh.CMD_TIMEOUT = 10

class airflow.providers.ssh.hooks.ssh.SSHHook(ssh_conn_id=None, remote_host='', username=None, password=None, key_file=None, port=None, conn_timeout=None, cmd_timeout=NOTSET, keepalive_interval=30, banner_timeout=30.0, disabled_algorithms=None, ciphers=None, auth_timeout=None, host_proxy_cmd=None)

Bases: airflow.hooks.base.BaseHook

Execute remote commands with Paramiko.

See also

https://github.com/paramiko/paramiko

This hook also lets you create ssh tunnel and serve as basis for SFTP file transfer.

Parameters:

• ssh_conn_id (str | None) – ssh connection id from airflow Connections from where all the required parameters can be fetched like username, password or key_file, though priority is given to the params passed during init.

• remote_host (str) – remote host to connect

• username (str | None) – username to connect to the remote_host

• password (str | None) – password of the username to connect to the remote_host

• key_file (str | None) – path to key file to use to connect to the remote_host

• port (int | None) – port of remote host to connect (Default is paramiko SSH_PORT)

• conn_timeout (int | None) – timeout (in seconds) for the attempt to connect to the remote_host. The default is 10 seconds. If provided, it will replace the conn_timeout which was predefined in the connection of ssh_conn_id.

• cmd_timeout (float | airflow.utils.types.ArgNotSet | None) – timeout (in seconds) for executing the command. The default is 10 seconds. Nullable, None means no timeout. If provided, it will replace the cmd_timeout which was predefined in the connection of ssh_conn_id.

• keepalive_interval (int) – send a keepalive packet to remote host every keepalive_interval seconds

• banner_timeout (float) – timeout to wait for banner from the server in seconds

• disabled_algorithms (dict | None) – dictionary mapping algorithm type to an iterable of algorithm identifiers, which will be disabled for the lifetime of the transport

• ciphers (list[str] | None) – list of ciphers to use in order of preference

• auth_timeout (int | None) – timeout (in seconds) for the attempt to authenticate with the remote_host

conn_name_attr = 'ssh_conn_id'

default_conn_name = 'ssh_default'

conn_type = 'ssh'

hook_name = 'SSH'

classmethod get_ui_field_behaviour()

Return custom UI field behaviour for SSH connection.

ssh_conn_id = None

remote_host = ''

username = None

password = None

key_file = None

pkey = None

port = None

conn_timeout = None

cmd_timeout

keepalive_interval = 30

banner_timeout = 30.0

disabled_algorithms = None

ciphers = None

host_proxy_cmd = None

auth_timeout = None

compress = True

no_host_key_check = True

allow_host_key_change = False

host_key = None

look_for_keys = True

client: paramiko.SSHClient | None = None

property host_proxy: paramiko.ProxyCommand | None

get_conn()

Establish an SSH connection to the remote host.

get_tunnel(remote_port, remote_host='localhost', local_port=None)

Create a tunnel between two hosts.

This is conceptually similar to ssh -L <LOCAL_PORT>:host:<REMOTE_PORT>.

Parameters:

• remote_port (int) – The remote port to create a tunnel to

• remote_host (str) – The remote host to create a tunnel to (default localhost)

• local_port (int | None) – The local port to attach the tunnel to

Returns:

sshtunnel.SSHTunnelForwarder object

Return type:

sshtunnel.SSHTunnelForwarder

exec_ssh_client_command(ssh_client, command, get_pty, environment, timeout=NOTSET)

test_connection()

Test the ssh connection by execute remote bash commands.

Previous Next

Was this entry helpful?