SSHOperator(*, ssh_hook: Optional[SSHHook] = None, ssh_conn_id: Optional[str] = None, remote_host: Optional[str] = None, command: Optional[str] = None, timeout: Optional[int] = None, conn_timeout: Optional[int] = None, cmd_timeout: Optional[int] = None, environment: Optional[dict] = None, get_pty: bool = False, **kwargs)¶
SSHOperator to execute commands on given remote host using the ssh_hook.
ssh_hook (airflow.providers.ssh.hooks.ssh.SSHHook) – predefined ssh_hook to use for remote execution. Either ssh_hook or ssh_conn_id needs to be provided.
remote_host (str) – remote host to connect (templated) Nullable. If provided, it will replace the remote_host which was defined in ssh_hook or predefined in the connection of ssh_conn_id.
command (str) – command to execute on remote host. (templated)
conn_timeout (int) – timeout (in seconds) for maintaining the connection. The default is 10 seconds. Nullable. If provided, it will replace the conn_timeout which was predefined in the connection of ssh_conn_id.
cmd_timeout (int) – timeout (in seconds) for executing the command. The default is 10 seconds.
timeout (int) – (deprecated) timeout (in seconds) for executing the command. The default is 10 seconds. Use conn_timeout and cmd_timeout parameters instead.
environment (dict) – a dict of shell environment variables. Note that the server will reject them silently if AcceptEnv is not set in SSH config.
get_pty (bool) – request a pseudo-terminal from the server. Set to
Trueto have the remote process killed upon task timeout. The default is
Falsebut note that get_pty is forced to
Truewhen the command starts with
template_fields= ['command', 'remote_host']¶
Get ssh tunnel