← Back to branch summary

~ubuntu-branches/ubuntu/maverick/libvirt/maverick

« back to all changes in this revision

Viewing changes to docs/drvvbox.html

Tags: upstream-0.6.4
Import upstream version 0.6.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/drvvbox.html
 
1
<?xml version="1.0" encoding="ISO-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
3
<html xmlns="http://www.w3.org/1999/xhtml">
 
4
<!--
 
5
        This file is autogenerated from drvvbox.html.in
 
6
        Do not edit this file. Changes will be lost.
 
7
      -->
 
8
  <head>
 
9
    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
 
10
    <link rel="stylesheet" type="text/css" href="main.css" />
 
11
    <link rel="SHORTCUT ICON" href="32favicon.png" />
 
12
    <title>libvirt: VirtualBox hypervisor driver</title>
 
13
    <meta name="description" content="libvirt, virtualization, virtualization API" />
 
14
  </head>
 
15
  <body>
 
16
    <div id="header">
 
17
      <div id="headerLogo"></div>
 
18
      <div id="headerSearch">
 
19
        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
 
20
            <input id="query" name="query" type="text" size="12" value="" />
 
21
            <input id="submit" name="submit" type="submit" value="Search" />
 
22
          </div></form>
 
23
      </div>
 
24
    </div>
 
25
    <div id="body">
 
26
      <div id="menu">
 
27
        <ul class="l0"><li>
 
28
            <div>
 
29
              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
 
30
            </div>
 
31
          </li><li>
 
32
            <div>
 
33
              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
 
34
            </div>
 
35
          </li><li>
 
36
            <div>
 
37
              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
 
38
            </div>
 
39
          </li><li>
 
40
            <div>
 
41
              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
 
42
              <ul class="l1"><li>
 
43
                  <div>
 
44
                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
 
45
                  </div>
 
46
                </li><li>
 
47
                  <div>
 
48
                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
 
49
                  </div>
 
50
                </li><li>
 
51
                  <div>
 
52
                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
 
53
                  </div>
 
54
                </li><li>
 
55
                  <div>
 
56
                    <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
 
57
                    <ul class="l2"><li>
 
58
                        <div>
 
59
                          <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
 
60
                        </div>
 
61
                      </li><li>
 
62
                        <div>
 
63
                          <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
 
64
                        </div>
 
65
                      </li><li>
 
66
                        <div>
 
67
                          <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
 
68
                        </div>
 
69
                      </li><li>
 
70
                        <div>
 
71
                          <a title="Psuedo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
 
72
                        </div>
 
73
                      </li><li>
 
74
                        <div>
 
75
                          <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
 
76
                        </div>
 
77
                      </li><li>
 
78
                        <div>
 
79
                          <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
 
80
                        </div>
 
81
                      </li><li>
 
82
                        <div>
 
83
                          <a title="Driver for the User Mode Linux technology" class="inactive" href="drvuml.html">UML</a>
 
84
                        </div>
 
85
                      </li><li>
 
86
                        <div>
 
87
                          <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
 
88
                        </div>
 
89
                      </li><li>
 
90
                        <div>
 
91
                          <span class="active">VirtualBox</span>
 
92
                        </div>
 
93
                      </li></ul>
 
94
                  </div>
 
95
                </li><li>
 
96
                  <div>
 
97
                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
 
98
                  </div>
 
99
                </li><li>
 
100
                  <div>
 
101
                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
 
102
                  </div>
 
103
                </li></ul>
 
104
            </div>
 
105
          </li><li>
 
106
            <div>
 
107
              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
 
108
            </div>
 
109
          </li><li>
 
110
            <div>
 
111
              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
 
112
            </div>
 
113
          </li><li>
 
114
            <div>
 
115
              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
 
116
            </div>
 
117
          </li><li>
 
118
            <div>
 
119
              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
 
120
            </div>
 
121
          </li><li>
 
122
            <div>
 
123
              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
 
124
            </div>
 
125
          </li><li>
 
126
            <div>
 
127
              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
 
128
            </div>
 
129
          </li></ul>
 
130
      </div>
 
131
      <div id="content">
 
132
        <h1>VirtualBox hypervisor driver</h1>
 
133
        <p>
 
134
        The libvirt VirtualBox driver can manage any VirtualBox version
 
135
        from version 2.2 onwards.
 
136
    </p>
 
137
        <h2>Connections to VirtualBox driver</h2>
 
138
        <p>
 
139
    The libvirt VirtualBox driver provides per-user drivers (the "session" instance).
 
140
    The uri of the driver protocol is "vbox". Some example connection URIs for the driver are:
 
141
    </p>
 
142
        <pre>
 
143
    vbox:///session                      (local access to per-user instance)
 
144
    vbox+unix:///session                 (local access to per-user instance)
 
145
    vbox+tcp://user@example.com/session  (remote access, SASl/Kerberos)
 
146
    vbox+ssh://user@example.com/session  (remote access, SSH tunnelled)
 
147
    </pre>
 
148
        <h2>
 
149
          <a name="xmlconfig" id="xmlconfig">Example domain XML config</a>
 
150
        </h2>
 
151
        <pre>
 
152
    &lt;domain type='vbox'&gt;
 
153
    &lt;name&gt;vbox&lt;/name&gt;
 
154
    &lt;uuid&gt;4dab22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
 
155
 
 
156
    &lt;os&gt;
 
157
        &lt;type&gt;hvm&lt;/type&gt;
 
158
        &lt;boot dev='cdrom'/&gt;
 
159
        &lt;boot dev='hd'/&gt;
 
160
        &lt;boot dev='fd'/&gt;
 
161
        &lt;boot dev='network'/&gt;
 
162
    &lt;/os&gt;
 
163
 
 
164
    &lt;memory&gt;654321&lt;/memory&gt;
 
165
    &lt;vcpu&gt;1&lt;/vcpu&gt;
 
166
 
 
167
    &lt;features&gt;
 
168
        &lt;pae/&gt;
 
169
        &lt;acpi/&gt;
 
170
        &lt;apic/&gt;
 
171
    &lt;/features&gt;
 
172
 
 
173
    &lt;devices&gt;
 
174
        &lt;disk type='file' device='cdrom'&gt;
 
175
            &lt;source file='/home/user/Downloads/slax-6.0.9.iso'/&gt;
 
176
            &lt;target dev='hdc'/&gt;
 
177
            &lt;readonly/&gt;
 
178
        &lt;/disk&gt;
 
179
 
 
180
        &lt;disk type='file' device='disk'&gt;
 
181
            &lt;source file='/home/user/tmp/vbox.vdi'/&gt;
 
182
            &lt;target dev='hdd'/&gt;
 
183
        &lt;/disk&gt;
 
184
 
 
185
        &lt;disk type='file' device='floppy'&gt;
 
186
            &lt;source file='/home/user/tmp/WIN98C.IMG'/&gt;
 
187
            &lt;target dev='fda'/&gt;
 
188
        &lt;/disk&gt;
 
189
 
 
190
        &lt;!--BRIDGE--&gt;
 
191
        &lt;interface type='bridge'&gt;
 
192
            &lt;source bridge='eth0'/&gt;
 
193
            &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
 
194
            &lt;model type='am79c973'/&gt;
 
195
        &lt;/interface&gt;
 
196
 
 
197
        &lt;!--NAT--&gt;
 
198
        &lt;interface type='user'&gt;
 
199
            &lt;mac address='56:16:3e:5d:c7:9e'/&gt;
 
200
            &lt;model type='82540eM'/&gt;
 
201
        &lt;/interface&gt;
 
202
 
 
203
        &lt;sound model='sb16'/&gt;
 
204
 
 
205
        &lt;parallel type='dev'&gt;
 
206
            &lt;source path='/dev/pts/1'/&gt;
 
207
            &lt;target port='0'/&gt;
 
208
        &lt;/parallel&gt;
 
209
 
 
210
        &lt;parallel type='dev'&gt;
 
211
            &lt;source path='/dev/pts/2'/&gt;
 
212
            &lt;target port='1'/&gt;
 
213
        &lt;/parallel&gt;
 
214
 
 
215
        &lt;serial type="dev"&gt;
 
216
            &lt;source path="/dev/ttyS0"/&gt;
 
217
            &lt;target port="0"/&gt;
 
218
        &lt;/serial&gt;
 
219
 
 
220
        &lt;serial type="pipe"&gt;
 
221
            &lt;source path="/tmp/serial.txt"/&gt;
 
222
            &lt;target port="1"/&gt;
 
223
        &lt;/serial&gt;
 
224
 
 
225
        &lt;hostdev mode='subsystem' type='usb'&gt;
 
226
            &lt;source&gt;
 
227
                &lt;vendor id='0x1234'/&gt;
 
228
                &lt;product id='0xbeef'/&gt;
 
229
            &lt;/source&gt;
 
230
        &lt;/hostdev&gt;
 
231
 
 
232
        &lt;hostdev mode='subsystem' type='usb'&gt;
 
233
            &lt;source&gt;
 
234
                &lt;vendor id='0x4321'/&gt;
 
235
                &lt;product id='0xfeeb'/&gt;
 
236
            &lt;/source&gt;
 
237
        &lt;/hostdev&gt;
 
238
 
 
239
    &lt;/devices&gt;
 
240
 
 
241
    &lt;/domain&gt;
 
242
    </pre>
 
243
      </div>
 
244
    </div>
 
245
    <div id="footer">
 
246
      <p id="sponsor">
 
247
            Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
 
248
    </div>
 
249
  </body>
 
250
</html>