File: drvhyperv.html

package info (click to toggle)
libvirt 5.6.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 240,844 kB
  • sloc: ansic: 584,521; xml: 176,725; sh: 9,912; python: 4,731; perl: 4,343; makefile: 3,321; ml: 465
file content (237 lines) | stat: -rw-r--r-- 8,463 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
<?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 Tue Jul 30 02:04:27 UTC 2019.
      -->
  <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" src="js/main.js">
      <!--// forces non-empty element-->
    </script>
  </head>
  <body onload="pageload()">
    <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>&amp;</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 id="simplesearch" action="https://www.google.com/search" enctype="application/x-www-form-urlencoded" method="get">
          <div>
            <input id="searchsite" name="sitesearch" type="hidden" value="libvirt.org"/>
            <input id="searchq" name="q" type="text" size="12" value=""/>
            <input name="submit" type="submit" value="Go"/>
          </div>
        </form>
        <div id="advancedsearch">
          <span>
            <input type="radio" name="what" id="whatwebsite" checked="checked" value="website"/>
            <label for="whatwebsite">Website</label>
          </span>
          <span>
            <input type="radio" name="what" id="whatwiki" value="wiki"/>
            <label for="whatwiki">Wiki</label>
          </span>
          <span>
            <input type="radio" name="what" id="whatdevs" value="devs"/>
            <label for="whatdevs">Developers list</label>
          </span>
          <span>
            <input type="radio" name="what" id="whatusers" value="users"/>
            <label for="whatusers">Users list</label>
          </span>
        </div>
      </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="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>