Registry / workflow / apache-airflow-providers-ssh

apache-airflow-providers-ssh

library6.0.1pypypi✓ verified 25d ago

This package provides operators, hooks, and sensors for interacting with SSH, SFTP, and SCP within Apache Airflow DAGs. It enables automation of tasks on remote servers via SSH protocol, including command execution and file transfers, supporting various authentication methods. The current version is 4.3.3, and its release cadence is tied to the broader Apache Airflow provider release schedule, with frequent updates.

workflow devops communication

pip install apache-airflow-providers-ssh

github ↗package ↗homepage ↗docs ↗changelog ↗

INSTALL

IMPORT

SIG · APACHE-AIRFLOW-PRO

apache-airflow-providers-ssh

workflowpythonv6.0.1

Install

25.5s avg

Import

5630ms

Disk

267MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v6.0.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 4.726s · 268.1MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 25.5s · import 4.282s · 266MB

267MB installed

● package 267MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

SSHOperator

✓ from airflow.providers.ssh.operators.ssh import SSHOperator

SSHHook

✓ from airflow.providers.ssh.hooks.ssh import SSHHook

SFTPHook

✓ from airflow.providers.ssh.hooks.sftp import SFTPHook

✗ from airflow.providers.sftp.hooks.sftp import SFTPHook

SFTPHook is part of the SSH provider package.

This example demonstrates a basic DAG using the `SSHOperator` to connect to a remote server and execute a shell command. Before running, configure an 'SSH' connection in your Airflow UI (Admin -> Connections) with `Conn Id` as `ssh_default`, providing `Host`, `Login (Username)`, and `Port`. For authentication, you can specify `Password`, `Key File` path, or `Private Key` content in the 'Extra' field as a JSON object (e.g., `{"key_file": "/path/to/your/key.pem"}`).

import os from datetime import datetime from airflow.models.dag import DAG from airflow.providers.ssh.operators.ssh import SSHOperator # For local testing, ensure you have an 'ssh_default' connection configured in Airflow UI # or via an environment variable, e.g., AIRFLOW_CONN_SSH_DEFAULT=ssh://user@hostname:22/?key_file=/path/to/key # For this example, we'll mock the connection_id. # Example of setting connection details via environment variable for local execution # os.environ['AIRFLOW_CONN_SSH_DEFAULT'] = 'ssh://your_user@your_host:22' # If using a private key file: # os.environ['AIRFLOW_CONN_SSH_DEFAULT'] = 'ssh://your_user@your_host:22?key_file=/path/to/your/private_key.pem' with DAG( dag_id='ssh_operator_quickstart', start_date=datetime(2023, 1, 1), schedule_interval=None, catchup=False, tags=['ssh', 'example'], ) as dag: ssh_task = SSHOperator( task_id='run_remote_command', ssh_conn_id='ssh_default', # Ensure this connection exists in Airflow command='echo "Hello from remote host $(hostname)" && ls -l', cmd_timeout=10, # Timeout for the command execution )

Debug

Known issues

breakingProvider version 4.0.0 introduced significant breaking changes by removing many previously deprecated features. Key changes include `SSHHook.timeout` removal (use `conn_timeout`), `SSHHook.create_tunnel()` being deprecated in favor of `get_tunnel()` with altered parameters, `SSHOperator.get_hook()` removed (use `hook` attribute), and `SSHOperator.exec_ssh_client_command()` removed (call `ssh_hook.exec_ssh_client_command()` directly). The minimum supported Airflow version was also bumped to 2.9.0.

fix

Review changelog for 4.0.0 and update code to use recommended methods and parameters (e.g., `conn_timeout` instead of `timeout`, `hook` attribute instead of `get_hook()`). Ensure your Airflow environment is on version 2.9.0 or higher.

affects: >=4.0.0

breakingMinimum Apache Airflow version requirements have consistently increased with provider updates. Version 4.1.0 requires Airflow 2.10.0+, version 4.2.0 and 4.3.0 require Airflow 2.11.0+. Additionally, Python 3.9 support was dropped in provider version 4.1.1.

fix

Upgrade your Apache Airflow installation to at least 2.11.0 and ensure your Python environment is 3.10 or newer for provider versions 4.2.0+.

affects: >=4.1.0

gotchaWhen configuring SSH connections, pay close attention to host key verification settings. By default, `no_host_key_check` is `true`, meaning new host keys are automatically added to `known_hosts`. However, `allow_host_key_change` is `false` by default, preventing connections if the host key changes. For robust production environments, consider strict host key checking.

fix

Explicitly configure `no_host_key_check` and `allow_host_key_change` parameters in your Airflow SSH connection (often via 'Extra' JSON) to match your security policy. Consider using `host_key` in the connection extra to pin a specific host key.

affects: all

gotchaIf the SSH connection type does not appear in the Airflow UI's 'Admin -> Connections -> Add new record' dropdown after installation, it might indicate an issue with Airflow environment refresh or installation path.

fix

Ensure the provider package is installed in the same Python environment as your Airflow installation. Restart Airflow scheduler and webserver components. Verify installation using `airflow providers list` or `pip list` in your Airflow environment.

affects: all

breakingThe `schedule_interval` parameter in `DAG` definitions was removed in Apache Airflow 2.2 (replaced by `schedule`). Using `schedule_interval` with Airflow versions 2.2 and newer will cause a `TypeError`. Additionally, importing `DAG` directly from `airflow` is deprecated and will be removed in future versions; it should be imported from `airflow.sdk`.

fix

Update your DAG definitions to use the `schedule` parameter instead of `schedule_interval`. For example, change `schedule_interval=None` to `schedule=None` or `schedule='@daily'` to `schedule='@daily'`. Also, update your import statements from `from airflow import DAG` to `from airflow.sdk import DAG`.

affects: >=4.0.0

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'airflow.providers.ssh'

The 'apache-airflow-providers-ssh' package is not installed.

fix

Install the package using 'pip install apache-airflow-providers-ssh'.

SSH command timed out

The SSH command execution exceeded the default timeout limit.

fix

Increase the 'conn_timeout' parameter in the SSH connection settings.

No module named 'airflow.providers.ssh' on AWS Airflow (Amazon MWAA)

The 'apache-airflow-providers-ssh' package is not included in the Amazon MWAA environment.

fix

Add 'apache-airflow-providers-ssh' to the 'requirements.txt' file and update the MWAA environment.

Unable to create new SSH connection in Apache Airflow (AWS managed MWAA)

The 'SSH' connection type is not available in the Airflow UI due to missing dependencies.

fix

Ensure 'apache-airflow-providers-ssh' is listed in 'requirements.txt' and the MWAA environment is updated.

airflow.exceptions.AirflowException: SSH command timed out

This error indicates that the SSH command executed by the `SSHOperator` or `SSHHook` took longer than the configured `cmd_timeout` (defaulting to 10 seconds) or `conn_timeout` for establishing the connection.

fix

Increase the `cmd_timeout` parameter in your `SSHOperator` or `SSHHook` definition, or set it to `None` for no timeout, based on the expected duration of your remote command. For connection issues, adjust `conn_timeout`. Example: `SSHOperator(task_id='my_ssh_task', ssh_conn_id='ssh_default', command='long_running_script.sh', cmd_timeout=300)` or `SSHHook(ssh_conn_id='ssh_default', cmd_timeout=None)`.

Upgrade

Version history

6.0.1latest on PyPI · released Aug 8, 2026

Audit

Dependencies

apache-airflowrequiredCore Airflow dependency. Provider version 4.3.x requires Apache Airflow >=2.11.0.

apache-airflow-providers-common-compatrequiredCompatibility layer for common Airflow features.

asyncsshrequiredUsed for asynchronous SSH operations.

paramikorequiredSSHv2 protocol library for Python.

sshtunnelrequiredAllows SSH tunneling.

Agent activity

55 hits · last 30 days