airflow.providers.ssh.operators.ssh
¶
Module Contents¶
Classes¶
SSHOperator to execute commands on given remote host using the ssh_hook. |
Attributes¶
- class airflow.providers.ssh.operators.ssh.SSHOperator(*, ssh_hook=None, ssh_conn_id=None, remote_host=None, command=None, timeout=None, conn_timeout=None, cmd_timeout=None, environment=None, get_pty=False, banner_timeout=30.0, **kwargs)[source]¶
Bases:
airflow.models.BaseOperator
SSHOperator to execute commands on given remote host using the ssh_hook.
- Parameters
ssh_hook (Optional[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.
ssh_conn_id (Optional[str]) -- ssh connection id from airflow Connections. ssh_conn_id will be ignored if ssh_hook is provided.
remote_host (Optional[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 (Optional[str]) -- command to execute on remote host. (templated)
conn_timeout (Optional[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 (Optional[int]) -- timeout (in seconds) for executing the command. The default is 10 seconds.
timeout (Optional[int]) -- (deprecated) timeout (in seconds) for executing the command. The default is 10 seconds. Use conn_timeout and cmd_timeout parameters instead.
environment (Optional[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
True
to have the remote process killed upon task timeout. The default isFalse
but note that get_pty is forced toTrue
when the command starts withsudo
.banner_timeout (float) -- timeout to wait for banner from the server in seconds