docs-archive/1.10.4/_api/airflow/contrib/hooks/winrm_hook/index.html - airflow-site - Git at Google



 <!DOCTYPE html>
 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
 <head>
   <meta charset="utf-8">

   <meta name="viewport" content="width=device-width, initial-scale=1.0">

   <title>airflow.contrib.hooks.winrm_hook &mdash; Airflow Documentation</title>


   <script type="text/javascript" src="../../../../../_static/js/modernizr.min.js"></script>


       <script type="text/javascript" id="documentation_options" data-url_root="../../../../../" src="../../../../../_static/documentation_options.js"></script>
         <script type="text/javascript" src="../../../../../_static/jquery.js"></script>
         <script type="text/javascript" src="../../../../../_static/underscore.js"></script>
         <script type="text/javascript" src="../../../../../_static/doctools.js"></script>
         <script type="text/javascript" src="../../../../../_static/language_data.js"></script>

     <script type="text/javascript" src="../../../../../_static/js/theme.js"></script>


   <link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="../../../../../genindex.html" />
     <link rel="search" title="Search" href="../../../../../search.html" />
     <link rel="next" title="airflow.executors" href="../../../executors/index.html" />
     <link rel="prev" title="airflow.contrib.hooks.wasb_hook" href="../wasb_hook/index.html" />

   <script>
     document.addEventListener('DOMContentLoaded', function() {
       var el = document.getElementById('changelog');
       if (el !== null ) {
         // [AIRFLOW-...]
         el.innerHTML = el.innerHTML.replace(
             /\[(AIRFLOW-[\d]+)\]/g,
             `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>`
         );
         // (#...)
         el.innerHTML = el.innerHTML.replace(
             /\(#([\d]+)\)/g,
             `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>`
         );
       };
     })
   </script>
   <style>
     .example-header {
       position: relative;
       background: #9AAA7A;
       padding: 8px 16px;
       margin-bottom: 0;
     }
     .example-header--with-button {
       padding-right: 166px;
     }
     .example-header:after{
       content: '';
       display: table;
       clear: both;
     }
     .example-title {
       display:block;
       padding: 4px;
       margin-right: 16px;
       color: white;
       overflow-x: auto;
     }
     .example-header-button {
       top: 8px;
       right: 16px;
       position: absolute;
     }
     .example-header + .highlight-python {
       margin-top: 0 !important;
     }
     .viewcode-button {
       display: inline-block;
       padding: 8px 16px;
       border: 0;
       margin: 0;
       outline: 0;
       border-radius: 2px;
       -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3);
       box-shadow: 0 3px 6px 0 rgba(0,0,0,.3);
       color: #404040;
       background-color: #e7e7e7;
       cursor: pointer;
       font-size: 16px;
       font-weight: 500;
       line-height: 1;
       text-decoration: none;
       text-overflow: ellipsis;
       overflow: hidden;
       text-transform: uppercase;
       -webkit-transition: background-color .2s;
       transition: background-color .2s;
       vertical-align: middle;
       white-space: nowrap;
     }
     .viewcode-button:visited {
       color: #404040;
     }
     .viewcode-button:hover, .viewcode-button:focus {
       color: #404040;
       background-color: #d6d6d6;
     }
   </style>

 </head>

 <body class="wy-body-for-nav">


   <div class="wy-grid-for-nav">

     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >


             <a href="../../../../../index.html" class="icon icon-home"> Airflow


           </a>


               <div class="version">
                 1.10.4
               </div>


 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
     <input type="text" name="q" placeholder="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
 </div>


         </div>

         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">


               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../../../../../project.html">Project</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../license.html">License</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../start.html">Quick Start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../tutorial.html">Tutorial</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../howto/index.html">How-to Guides</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../ui.html">UI / Screenshots</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../concepts.html">Concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../profiling.html">Data Profiling</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../cli.html">Command Line Interface</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../scheduler.html">Scheduling &amp; Triggers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../plugins.html">Plugins</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../security.html">Security</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../timezone.html">Time zones</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../api.html">Experimental Rest API</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../integration.html">Integration</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../metrics.html">Metrics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../kubernetes.html">Kubernetes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../lineage.html">Lineage</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../changelog.html">Changelog</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../faq.html">FAQ</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../macros.html">Macros reference</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="../../../../index.html">API Reference</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#operators">Operators</a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="../../../../index.html#hooks">Hooks</a><ul class="current">
 <li class="toctree-l3 current"><a class="reference internal" href="../../../../index.html#hooks-packages">Hooks packages</a><ul class="current">
 <li class="toctree-l4"><a class="reference internal" href="../../../hooks/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks</span></code></a></li>
 <li class="toctree-l4 current"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks</span></code></a></li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#executors">Executors</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#models">Models</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#core-and-community-package">Core and community package</a></li>
 </ul>
 </li>
 </ul>


         </div>
       </div>
     </nav>

     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


       <nav class="wy-nav-top" aria-label="top navigation">

           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="../../../../../index.html">Airflow</a>

       </nav>


       <div class="wy-nav-content">

         <div class="rst-content">


 <div role="navigation" aria-label="breadcrumbs navigation">

   <ul class="wy-breadcrumbs">

       <li><a href="../../../../../index.html">Docs</a> &raquo;</li>

           <li><a href="../../../../index.html">API Reference</a> &raquo;</li>

           <li><a href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks</span></code></a> &raquo;</li>

       <li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.winrm_hook</span></code></li>


       <li class="wy-breadcrumbs-aside">


             <a href="../../../../../_sources/_api/airflow/contrib/hooks/winrm_hook/index.rst.txt" rel="nofollow"> View page source</a>


       </li>

   </ul>


   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">

   <div class="section" id="module-airflow.contrib.hooks.winrm_hook">
 <span id="airflow-contrib-hooks-winrm-hook"></span><h1><a class="reference internal" href="#module-airflow.contrib.hooks.winrm_hook" title="airflow.contrib.hooks.winrm_hook"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.winrm_hook</span></code></a><a class="headerlink" href="#module-airflow.contrib.hooks.winrm_hook" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="module-contents">
 <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2>
 <dl class="class">
 <dt id="airflow.contrib.hooks.winrm_hook.WinRMHook">
 <em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.hooks.winrm_hook.</code><code class="sig-name descname">WinRMHook</code><span class="sig-paren">(</span><em class="sig-param">ssh_conn_id=None</em>, <em class="sig-param">endpoint=None</em>, <em class="sig-param">remote_host=None</em>, <em class="sig-param">remote_port=5985</em>, <em class="sig-param">transport='plaintext'</em>, <em class="sig-param">username=None</em>, <em class="sig-param">password=None</em>, <em class="sig-param">service='HTTP'</em>, <em class="sig-param">keytab=None</em>, <em class="sig-param">ca_trust_path=None</em>, <em class="sig-param">cert_pem=None</em>, <em class="sig-param">cert_key_pem=None</em>, <em class="sig-param">server_cert_validation='validate'</em>, <em class="sig-param">kerberos_delegation=False</em>, <em class="sig-param">read_timeout_sec=30</em>, <em class="sig-param">operation_timeout_sec=20</em>, <em class="sig-param">kerberos_hostname_override=None</em>, <em class="sig-param">message_encryption='auto'</em>, <em class="sig-param">credssp_disable_tlsv1_2=False</em>, <em class="sig-param">send_cbt=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/winrm_hook.html#WinRMHook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.winrm_hook.WinRMHook" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="../../../hooks/base_hook/index.html#airflow.hooks.base_hook.BaseHook" title="airflow.hooks.base_hook.BaseHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.hooks.base_hook.BaseHook</span></code></a></p>
 <p>Hook for winrm remote execution using pywinrm.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Seealso</dt>
 <dd class="field-odd"><p><a class="reference external" href="https://github.com/diyan/pywinrm/blob/master/winrm/protocol.py">https://github.com/diyan/pywinrm/blob/master/winrm/protocol.py</a></p>
 </dd>
 <dt class="field-even">Parameters</dt>
 <dd class="field-even"><ul class="simple">
 <li><p><strong>ssh_conn_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – connection id from airflow Connections from where
 all the required parameters can be fetched like username and password.
 Thought the priority is given to the param passed during init</p></li>
 <li><p><strong>endpoint</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – When not set, endpoint will be constructed like this:
 ‘<a class="reference external" href="http:/">http:/</a>/{remote_host}:{remote_port}/wsman’</p></li>
 <li><p><strong>remote_host</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Remote host to connect to. Ignored if <cite>endpoint</cite> is set.</p></li>
 <li><p><strong>remote_port</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – Remote port to connect to. Ignored if <cite>endpoint</cite> is set.</p></li>
 <li><p><strong>transport</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – transport type, one of ‘plaintext’ (default), ‘kerberos’, ‘ssl’, ‘ntlm’, ‘credssp’</p></li>
 <li><p><strong>username</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – username to connect to the remote_host</p></li>
 <li><p><strong>password</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – password of the username to connect to the remote_host</p></li>
 <li><p><strong>service</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – the service name, default is HTTP</p></li>
 <li><p><strong>keytab</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – the path to a keytab file if you are using one</p></li>
 <li><p><strong>ca_trust_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Certification Authority trust path</p></li>
 <li><p><strong>cert_pem</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – client authentication certificate file path in PEM format</p></li>
 <li><p><strong>cert_key_pem</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – client authentication certificate key file path in PEM format</p></li>
 <li><p><strong>server_cert_validation</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – whether server certificate should be validated on
 Python versions that support it; one of ‘validate’ (default), ‘ignore’</p></li>
 <li><p><strong>kerberos_delegation</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – if True, TGT is sent to target server to
 allow multiple hops</p></li>
 <li><p><strong>read_timeout_sec</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – maximum seconds to wait before an HTTP connect/read times out (default 30).
 This value should be slightly higher than operation_timeout_sec,
 as the server can block <em>at least</em> that long.</p></li>
 <li><p><strong>operation_timeout_sec</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – maximum allowed time in seconds for any single wsman
 HTTP operation (default 20). Note that operation timeouts while receiving output
 (the only wsman operation that should take any significant time,
 and where these timeouts are expected) will be silently retried indefinitely.</p></li>
 <li><p><strong>kerberos_hostname_override</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – the hostname to use for the kerberos exchange
 (defaults to the hostname in the endpoint URL)</p></li>
 <li><p><strong>message_encryption</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Will encrypt the WinRM messages if set
 and the transport auth supports message encryption. (Default ‘auto’)</p></li>
 <li><p><strong>credssp_disable_tlsv1_2</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – Whether to disable TLSv1.2 support and work with older
 protocols like TLSv1.0, default is False</p></li>
 <li><p><strong>send_cbt</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – Will send the channel bindings over a HTTPS channel (Default: True)</p></li>
 </ul>
 </dd>
 </dl>
 <dl class="method">
 <dt id="airflow.contrib.hooks.winrm_hook.WinRMHook.get_conn">
 <code class="sig-name descname">get_conn</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/winrm_hook.html#WinRMHook.get_conn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.winrm_hook.WinRMHook.get_conn" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 </div>
 </div>


            </div>

           </div>
           <footer>

     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

         <a href="../../../executors/index.html" class="btn btn-neutral float-right" title="airflow.executors" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


         <a href="../wasb_hook/index.html" class="btn btn-neutral float-left" title="airflow.contrib.hooks.wasb_hook" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

     </div>


   <hr/>

   <div role="contentinfo">
     <p>

     </p>
   </div>
   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

 </footer>

         </div>
       </div>

     </section>

   </div>


   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
   </script>


 </body>
 </html>




	<!DOCTYPE html>
	<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
	<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
	<head>
	<meta charset="utf-8">

	<meta name="viewport" content="width=device-width, initial-scale=1.0">

	<title>airflow.contrib.hooks.winrm_hook — Airflow Documentation</title>








	<script type="text/javascript" src="../../../../../_static/js/modernizr.min.js"></script>


	<script type="text/javascript" id="documentation_options" data-url_root="../../../../../" src="../../../../../_static/documentation_options.js"></script>
	<script type="text/javascript" src="../../../../../_static/jquery.js"></script>
	<script type="text/javascript" src="../../../../../_static/underscore.js"></script>
	<script type="text/javascript" src="../../../../../_static/doctools.js"></script>
	<script type="text/javascript" src="../../../../../_static/language_data.js"></script>

	<script type="text/javascript" src="../../../../../_static/js/theme.js"></script>




	<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
	<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
	<link rel="index" title="Index" href="../../../../../genindex.html" />
	<link rel="search" title="Search" href="../../../../../search.html" />
	<link rel="next" title="airflow.executors" href="../../../executors/index.html" />
	<link rel="prev" title="airflow.contrib.hooks.wasb_hook" href="../wasb_hook/index.html" />

	<script>
	document.addEventListener('DOMContentLoaded', function() {
	var el = document.getElementById('changelog');
	if (el !== null ) {
	// [AIRFLOW-...]
	el.innerHTML = el.innerHTML.replace(
	/\[(AIRFLOW-[\d]+)\]/g,
	`<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>`
	);
	// (#...)
	el.innerHTML = el.innerHTML.replace(
	/\(#([\d]+)\)/g,
	`<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>`
	);
	};
	})
	</script>
	<style>
	.example-header {
	position: relative;
	background: #9AAA7A;
	padding: 8px 16px;
	margin-bottom: 0;
	}
	.example-header--with-button {
	padding-right: 166px;
	}
	.example-header:after{
	content: '';
	display: table;
	clear: both;
	}
	.example-title {
	display:block;
	padding: 4px;
	margin-right: 16px;
	color: white;
	overflow-x: auto;
	}
	.example-header-button {
	top: 8px;
	right: 16px;
	position: absolute;
	}
	.example-header + .highlight-python {
	margin-top: 0 !important;
	}
	.viewcode-button {
	display: inline-block;
	padding: 8px 16px;
	border: 0;
	margin: 0;
	outline: 0;
	border-radius: 2px;
	-webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3);
	box-shadow: 0 3px 6px 0 rgba(0,0,0,.3);
	color: #404040;
	background-color: #e7e7e7;
	cursor: pointer;
	font-size: 16px;
	font-weight: 500;
	line-height: 1;
	text-decoration: none;
	text-overflow: ellipsis;
	overflow: hidden;
	text-transform: uppercase;
	-webkit-transition: background-color .2s;
	transition: background-color .2s;
	vertical-align: middle;
	white-space: nowrap;
	}
	.viewcode-button:visited {
	color: #404040;
	}
	.viewcode-button:hover, .viewcode-button:focus {
	color: #404040;
	background-color: #d6d6d6;
	}
	</style>

	</head>

	<body class="wy-body-for-nav">


	<div class="wy-grid-for-nav">

	<nav data-toggle="wy-nav-shift" class="wy-nav-side">
	<div class="wy-side-scroll">
	<div class="wy-side-nav-search" >



	<a href="../../../../../index.html" class="icon icon-home"> Airflow



	</a>




	<div class="version">
	1.10.4
	</div>




	<div role="search">
	<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
	<input type="text" name="q" placeholder="Search docs" />
	<input type="hidden" name="check_keywords" value="yes" />
	<input type="hidden" name="area" value="default" />
	</form>
	</div>


	</div>

	<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">






	<ul class="current">
	<li class="toctree-l1"><a class="reference internal" href="../../../../../project.html">Project</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../license.html">License</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../start.html">Quick Start</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../installation.html">Installation</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../tutorial.html">Tutorial</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../howto/index.html">How-to Guides</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../ui.html">UI / Screenshots</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../concepts.html">Concepts</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../profiling.html">Data Profiling</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../cli.html">Command Line Interface</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../scheduler.html">Scheduling & Triggers</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../plugins.html">Plugins</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../security.html">Security</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../timezone.html">Time zones</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../api.html">Experimental Rest API</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../integration.html">Integration</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../metrics.html">Metrics</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../kubernetes.html">Kubernetes</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../lineage.html">Lineage</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../changelog.html">Changelog</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../faq.html">FAQ</a></li>
	<li class="toctree-l1"><a class="reference internal" href="../../../../../macros.html">Macros reference</a></li>
	<li class="toctree-l1 current"><a class="reference internal" href="../../../../index.html">API Reference</a><ul class="current">
	<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#operators">Operators</a></li>
	<li class="toctree-l2 current"><a class="reference internal" href="../../../../index.html#hooks">Hooks</a><ul class="current">
	<li class="toctree-l3 current"><a class="reference internal" href="../../../../index.html#hooks-packages">Hooks packages</a><ul class="current">
	<li class="toctree-l4"><a class="reference internal" href="../../../hooks/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks</span></code></a></li>
	<li class="toctree-l4 current"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks</span></code></a></li>
	</ul>
	</li>
	</ul>
	</li>
	<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#executors">Executors</a></li>
	<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#models">Models</a></li>
	<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#core-and-community-package">Core and community package</a></li>
	</ul>
	</li>
	</ul>



	</div>
	</div>
	</nav>

	<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


	<nav class="wy-nav-top" aria-label="top navigation">

	<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
	<a href="../../../../../index.html">Airflow</a>

	</nav>


	<div class="wy-nav-content">

	<div class="rst-content">

















	<div role="navigation" aria-label="breadcrumbs navigation">

	<ul class="wy-breadcrumbs">

	<li><a href="../../../../../index.html">Docs</a> »</li>

	<li><a href="../../../../index.html">API Reference</a> »</li>

	<li><a href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks</span></code></a> »</li>

	<li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.winrm_hook</span></code></li>


	<li class="wy-breadcrumbs-aside">


	<a href="../../../../../_sources/_api/airflow/contrib/hooks/winrm_hook/index.rst.txt" rel="nofollow"> View page source</a>


	</li>

	</ul>


	<hr/>
	</div>
	<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
	<div itemprop="articleBody">

	<div class="section" id="module-airflow.contrib.hooks.winrm_hook">
	<span id="airflow-contrib-hooks-winrm-hook"></span><h1><a class="reference internal" href="#module-airflow.contrib.hooks.winrm_hook" title="airflow.contrib.hooks.winrm_hook"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.winrm_hook</span></code></a><a class="headerlink" href="#module-airflow.contrib.hooks.winrm_hook" title="Permalink to this headline">¶</a></h1>
	<div class="section" id="module-contents">
	<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2>
	<dl class="class">
	<dt id="airflow.contrib.hooks.winrm_hook.WinRMHook">
	<em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.hooks.winrm_hook.</code><code class="sig-name descname">WinRMHook</code><span class="sig-paren">(</span><em class="sig-param">ssh_conn_id=None</em>, <em class="sig-param">endpoint=None</em>, <em class="sig-param">remote_host=None</em>, <em class="sig-param">remote_port=5985</em>, <em class="sig-param">transport='plaintext'</em>, <em class="sig-param">username=None</em>, <em class="sig-param">password=None</em>, <em class="sig-param">service='HTTP'</em>, <em class="sig-param">keytab=None</em>, <em class="sig-param">ca_trust_path=None</em>, <em class="sig-param">cert_pem=None</em>, <em class="sig-param">cert_key_pem=None</em>, <em class="sig-param">server_cert_validation='validate'</em>, <em class="sig-param">kerberos_delegation=False</em>, <em class="sig-param">read_timeout_sec=30</em>, <em class="sig-param">operation_timeout_sec=20</em>, <em class="sig-param">kerberos_hostname_override=None</em>, <em class="sig-param">message_encryption='auto'</em>, <em class="sig-param">credssp_disable_tlsv1_2=False</em>, <em class="sig-param">send_cbt=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/winrm_hook.html#WinRMHook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.winrm_hook.WinRMHook" title="Permalink to this definition">¶</a></dt>
	<dd><p>Bases: <a class="reference internal" href="../../../hooks/base_hook/index.html#airflow.hooks.base_hook.BaseHook" title="airflow.hooks.base_hook.BaseHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.hooks.base_hook.BaseHook</span></code></a></p>
	<p>Hook for winrm remote execution using pywinrm.</p>
	<dl class="field-list simple">
	<dt class="field-odd">Seealso</dt>
	<dd class="field-odd"><p><a class="reference external" href="https://github.com/diyan/pywinrm/blob/master/winrm/protocol.py">https://github.com/diyan/pywinrm/blob/master/winrm/protocol.py</a></p>
	</dd>
	<dt class="field-even">Parameters</dt>
	<dd class="field-even"><ul class="simple">
	<li><p><strong>ssh_conn_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – connection id from airflow Connections from where
	all the required parameters can be fetched like username and password.
	Thought the priority is given to the param passed during init</p></li>
	<li><p><strong>endpoint</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – When not set, endpoint will be constructed like this:
	‘<a class="reference external" href="http:/">http:/</a>/{remote_host}:{remote_port}/wsman’</p></li>
	<li><p><strong>remote_host</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Remote host to connect to. Ignored if <cite>endpoint</cite> is set.</p></li>
	<li><p><strong>remote_port</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – Remote port to connect to. Ignored if <cite>endpoint</cite> is set.</p></li>
	<li><p><strong>transport</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – transport type, one of ‘plaintext’ (default), ‘kerberos’, ‘ssl’, ‘ntlm’, ‘credssp’</p></li>
	<li><p><strong>username</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – username to connect to the remote_host</p></li>
	<li><p><strong>password</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – password of the username to connect to the remote_host</p></li>
	<li><p><strong>service</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – the service name, default is HTTP</p></li>
	<li><p><strong>keytab</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – the path to a keytab file if you are using one</p></li>
	<li><p><strong>ca_trust_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Certification Authority trust path</p></li>
	<li><p><strong>cert_pem</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – client authentication certificate file path in PEM format</p></li>
	<li><p><strong>cert_key_pem</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – client authentication certificate key file path in PEM format</p></li>
	<li><p><strong>server_cert_validation</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – whether server certificate should be validated on
	Python versions that support it; one of ‘validate’ (default), ‘ignore’</p></li>
	<li><p><strong>kerberos_delegation</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – if True, TGT is sent to target server to
	allow multiple hops</p></li>
	<li><p><strong>read_timeout_sec</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – maximum seconds to wait before an HTTP connect/read times out (default 30).
	This value should be slightly higher than operation_timeout_sec,
	as the server can block <em>at least</em> that long.</p></li>
	<li><p><strong>operation_timeout_sec</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – maximum allowed time in seconds for any single wsman
	HTTP operation (default 20). Note that operation timeouts while receiving output
	(the only wsman operation that should take any significant time,
	and where these timeouts are expected) will be silently retried indefinitely.</p></li>
	<li><p><strong>kerberos_hostname_override</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – the hostname to use for the kerberos exchange
	(defaults to the hostname in the endpoint URL)</p></li>
	<li><p><strong>message_encryption</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Will encrypt the WinRM messages if set
	and the transport auth supports message encryption. (Default ‘auto’)</p></li>
	<li><p><strong>credssp_disable_tlsv1_2</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – Whether to disable TLSv1.2 support and work with older
	protocols like TLSv1.0, default is False</p></li>
	<li><p><strong>send_cbt</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – Will send the channel bindings over a HTTPS channel (Default: True)</p></li>
	</ul>
	</dd>
	</dl>
	<dl class="method">
	<dt id="airflow.contrib.hooks.winrm_hook.WinRMHook.get_conn">
	<code class="sig-name descname">get_conn</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/winrm_hook.html#WinRMHook.get_conn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.winrm_hook.WinRMHook.get_conn" title="Permalink to this definition">¶</a></dt>
	<dd></dd></dl>

	</dd></dl>

	</div>
	</div>


	</div>

	</div>
	<footer>

	<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

	<a href="../../../executors/index.html" class="btn btn-neutral float-right" title="airflow.executors" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


	<a href="../wasb_hook/index.html" class="btn btn-neutral float-left" title="airflow.contrib.hooks.wasb_hook" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

	</div>


	<hr/>

	<div role="contentinfo">
	<p>

	</p>
	</div>
	Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

	</footer>

	</div>
	</div>

	</section>

	</div>



	<script type="text/javascript">
	jQuery(function () {
	SphinxRtdTheme.Navigation.enable(true);
	});
	</script>






	</body>
	</html>