<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <!-- This file is autogenerated from drvhyperv.html.in Do not edit this file. Changes will be lost. --> <!-- This page was generated at Mon Nov 13 21:46:24 UTC 2017. --> <head> <meta charset="UTF-8"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <link rel="stylesheet" type="text/css" href="main.css"/> <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"/> <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/> <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/> <link rel="manifest" href="/manifest.json"/> <meta name="theme-color" content="#ffffff"/> <title>libvirt: Microsoft Hyper-V hypervisor driver</title> <meta name="description" content="libvirt, virtualization, virtualization API"/> <script type="text/javascript"> <!-- function init() { window.addEventListener('scroll', function(e){ var distanceY = window.pageYOffset || document.documentElement.scrollTop, shrinkOn = 94 home = document.getElementById("home"); links = document.getElementById("jumplinks"); search = document.getElementById("search"); body = document.getElementById("body"); if (distanceY > shrinkOn) { if (home.className != "navhide") { body.className = "navhide" home.className = "navhide" links.className = "navhide" search.className = "navhide" } } else { if (home.className == "navhide") { body.className = "" home.className = "" links.className = "" search.className = "" } } }); } window.onload = init(); --> </script> </head> <body> <div id="body"> <div id="content"> <h1>Microsoft Hyper-V hypervisor driver</h1> <ul> <li> <a href="#project">Project Links</a> </li> <li> <a href="#uri">Connections to the Microsoft Hyper-V driver</a> <ul> <li> <a href="#uriformat">URI Format</a> <ul> <li> <a href="#extraparams">Extra parameters</a> </li> </ul> </li> <li> <a href="#auth">Authentication</a> </li> </ul> </li> </ul> <p> The libvirt Microsoft Hyper-V driver can manage Hyper-V 2008 R2 and newer. </p> <h2> <a id="project">Project Links</a> <a class="headerlink" href="#project" title="Permalink to this headline">¶</a> </h2> <ul> <li> The <a href="http://www.microsoft.com/hyper-v-server/">Microsoft Hyper-V</a> hypervisor </li> </ul> <h2> <a id="uri">Connections to the Microsoft Hyper-V driver</a> <a class="headerlink" href="#uri" title="Permalink to this headline">¶</a> </h2> <p> Some example remote connection URIs for the driver are: </p> <pre> hyperv://example-hyperv.com (over HTTPS) hyperv://example-hyperv.com/?transport=http (over HTTP) </pre> <p><strong>Note</strong>: In contrast to other drivers, the Hyper-V driver is a client-side-only driver. It connects to the Hyper-V server using WS-Management over HTTP(S). Therefore, the <a href="remote.html">remote transport mechanism</a> provided by the remote driver and libvirtd will not work, and you cannot use URIs like <code>hyperv+ssh://example.com</code>. </p> <h3> <a id="uriformat">URI Format</a> <a class="headerlink" href="#uriformat" title="Permalink to this headline">¶</a> </h3> <p> URIs have this general form (<code>[...]</code> marks an optional part). </p> <pre> hyperv://[username@]hostname[:port]/[?extraparameters] </pre> <p> The default HTTPS ports is 5986. If the port parameter is given, it overrides the default port. </p> <h4> <a id="extraparams">Extra parameters</a> <a class="headerlink" href="#extraparams" title="Permalink to this headline">¶</a> </h4> <p> Extra parameters can be added to a URI as part of the query string (the part following <code>?</code>). A single parameter is formed by a <code>name=value</code> pair. Multiple parameters are separated by <code>&</code>. </p> <pre> ?transport=http </pre> <p> The driver understands the extra parameters shown below. </p> <table class="top_table"> <tr> <th>Name</th> <th>Values</th> <th>Meaning</th> </tr> <tr> <td> <code>transport</code> </td> <td><code>http</code> or <code>https</code> </td> <td> Overrides the default HTTPS transport. The default HTTP port is 5985. </td> </tr> </table> <h3> <a id="auth">Authentication</a> <a class="headerlink" href="#auth" title="Permalink to this headline">¶</a> </h3> <p> In order to perform any useful operation the driver needs to log into the Hyper-V server. Therefore, only <code>virConnectOpenAuth</code> can be used to connect to an Hyper-V server, <code>virConnectOpen</code> and <code>virConnectOpenReadOnly</code> don't work. To log into an Hyper-V server the driver will request credentials using the callback passed to the <code>virConnectOpenAuth</code> function. The driver passes the hostname as challenge parameter to the callback. </p> <p><strong>Note</strong>: Currently only <code>Basic</code> authentication is supported by libvirt. This method is disabled by default on the Hyper-V server and can be enabled via the WinRM commandline tool. </p> <pre> winrm set winrm/config/service/auth @{Basic="true"} </pre> <p> To allow <code>Basic</code> authentication with HTTP transport WinRM needs to allow unencrypted communication. This can be enabled via the WinRM commandline tool. However, this is not the recommended communication mode. </p> <pre> winrm set winrm/config/service @{AllowUnencrypted="true"} </pre> </div> </div> <div id="nav"> <div id="home"> <a href="index.html">Home</a> </div> <div id="jumplinks"> <ul> <li> <a href="downloads.html">Download</a> </li> <li> <a href="contribute.html">Contribute</a> </li> <li> <a href="docs.html">Docs</a> </li> </ul> </div> <div id="search"> <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"> <div> <input name="query" type="text" size="12" value=""/> <input name="submit" type="submit" value="Go"/> </div> </form> </div> </div> <div id="footer"> <div id="contact"> <h3>Contact</h3> <ul> <li> <a href="contact.html#email">email</a> </li> <li> <a href="contact.html#irc">irc</a> </li> </ul> </div> <div id="community"> <h3>Community</h3> <ul> <li> <a href="https://twitter.com/hashtag/libvirt">twitter</a> </li> <li> <a href="https://plus.google.com/communities/109522598353007505282">google+</a> </li> <li> <a href="http://stackoverflow.com/questions/tagged/libvirt">stackoverflow</a> </li> <li> <a href="http://serverfault.com/questions/tagged/libvirt">serverfault</a> </li> </ul> </div> <div id="conduct"> Participants in the libvirt project agree to abide by <a href="governance.html#codeofconduct">the project code of conduct</a></div> <br class="clear"/> </div> </body> </html>