blob: f84c0afad4065d5ebc4b3bdf3077a435074dcd40 [file] [log] [blame]
:mod:`airflow.contrib.operators.winrm_operator`
===============================================
.. py:module:: airflow.contrib.operators.winrm_operator
Module Contents
---------------
.. py:class:: WinRMOperator(winrm_hook=None, ssh_conn_id=None, remote_host=None, command=None, timeout=10, do_xcom_push=False, *args, **kwargs)
Bases: :class:`airflow.models.BaseOperator`
WinRMOperator to execute commands on given remote host using the winrm_hook.
:param winrm_hook: predefined ssh_hook to use for remote execution
:type winrm_hook: airflow.contrib.hooks.winrm_hook.WinRMHook
:param ssh_conn_id: connection id from airflow Connections
:type ssh_conn_id: str
:param remote_host: remote host to connect
:type remote_host: str
:param command: command to execute on remote host. (templated)
:type command: str
:param timeout: timeout for executing the command.
:type timeout: int
:param do_xcom_push: return the stdout which also get set in xcom by airflow platform
:type do_xcom_push: bool
.. attribute:: template_fields
:annotation: = ['command']
.. method:: execute(self, context)