airflow.providers.microsoft.winrm.operators.winrm
¶
Module Contents¶
Classes¶
WinRMOperator to execute commands on given remote host using the winrm_hook. |
- class airflow.providers.microsoft.winrm.operators.winrm.WinRMOperator(*, winrm_hook=None, ssh_conn_id=None, remote_host=None, command=None, ps_path=None, output_encoding='utf-8', timeout=10, **kwargs)[source]¶
Bases:
airflow.models.BaseOperator
WinRMOperator to execute commands on given remote host using the winrm_hook.
- Parameters
winrm_hook (airflow.providers.microsoft.winrm.hooks.winrm.WinRMHook | None) – predefined ssh_hook to use for remote execution
ssh_conn_id (str | None) – connection id from airflow Connections
remote_host (str | None) – remote host to connect
command (str | None) – command to execute on remote host. (templated)
ps_path (str | None) – path to powershell, powershell for v5.1- and pwsh for v6+. If specified, it will execute the command as powershell script.
output_encoding (str) – the encoding used to decode stout and stderr
timeout (int) – timeout for executing the command.