formatdomain.html.in 97.0 KB
Newer Older
1 2 3 4
<html>
  <body>
    <h1>Domain XML format</h1>

D
Daniel P. Berrange 已提交
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
    <ul id="toc"></ul>

    <p>
      This section describes the XML format used to represent domains, there are
      variations on the format based on the kind of domains run and the options
      used to launch them. For hypervisor specific details consult the
      <a href="drivers.html">driver docs</a>
    </p>


    <h2><a name="elements">Element and attribute overview</a></h2>

    <p>
      The root element required for all virtual machines is
      named <code>domain</code>. It has two attributes, the
      <code>type</code> specifies the hypervisor used for running
      the domain. The allowed values are driver specific, but
      include "xen", "kvm", "qemu", "lxc" and "kqemu". The
      second attribute is <code>id</code> which is a unique
      integer identifier for the running guest machine. Inactive
      machines have no id value.
    </p>


    <h3><a name="elementsMetadata">General metadata</a></h3>

31 32 33 34
<pre>
&lt;domain type='xen' id='3'&gt;
  &lt;name&gt;fv0&lt;/name&gt;
  &lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
35
  &lt;description&gt;Some human readable description&lt;/description&gt;
36
  ...</pre>
D
Daniel P. Berrange 已提交
37 38 39 40

    <dl>
      <dt><code>name</code></dt>
      <dd>The content of the <code>name</code> element provides
M
Matthew Booth 已提交
41 42 43 44 45
        a short name for the virtual machine. This name should
        consist only of alpha-numeric characters and is required
        to be unique within the scope of a single host. It is
        often used to form the filename for storing the persistent
        configuration file. <span class="since">Since 0.0.1</span></dd>
D
Daniel P. Berrange 已提交
46 47
      <dt><code>uuid</code></dt>
      <dd>The content of the <code>uuid</code> element provides
M
Matthew Booth 已提交
48 49 50
        a globally unique identifier for the virtual machine.
        The format must be RFC 4122 compliant, eg <code>3e3fce45-4f53-4fa7-bb32-11f34168b82b</code>.
        If omitted when defining/creating a new machine, a random
51 52 53 54
        UUID is generated. It is also possible to provide the UUID
        via a <a href="#elementsSysinfo"><code>sysinfo</code></a>
        specification. <span class="since">Since 0.0.1, sysinfo
        since 0.8.7</span></dd>
55 56 57 58 59 60

      <dt><code>description</code></dt>
      <dd>The content of the <code>description</code> element provides a
      human readable description of the virtual machine. This data is not
      used by libvirt in any way, it can contain any information the user
      wants. <span class="since">Since 0.7.2</span></dd>
D
Daniel P. Berrange 已提交
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
    </dl>

    <h3><a name="elementsOS">Operating system booting</a></h3>

    <p>
      There are a number of different ways to boot virtual machines
      each with their own pros and cons.
    </p>

    <h4><a name="elementsOSBIOS">BIOS bootloader</a></h4>

    <p>
      Booting via the BIOS is available for hypervisors supporting
      full virtualization. In this case the BIOS has a boot order
      priority (floppy, harddisk, cdrom, network) determining where
      to obtain/find the boot image.
    </p>

79 80 81 82 83 84
<pre>
  ...
  &lt;os&gt;
    &lt;type&gt;hvm&lt;/type&gt;
    &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
    &lt;boot dev='hd'/&gt;
85 86
    &lt;boot dev='cdrom'/&gt;
    &lt;bootmenu enable='yes'/&gt;
87
    &lt;smbios mode='sysinfo'/&gt;
88 89
  &lt;/os&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
90 91 92 93

    <dl>
      <dt><code>type</code></dt>
      <dd>The content of the <code>type</code> element specifies the
M
Matthew Booth 已提交
94 95 96 97 98 99 100 101
        type of operating system to be booted in the virtual machine.
        <code>hvm</code> indicates that the OS is one designed to run
        on bare metal, so requires full virtualization. <code>linux</code>
        (badly named!) refers to an OS that supports the Xen 3 hypervisor
        guest ABI. There are also two optional attributes, <code>arch</code>
        specifying the CPU architecture to virtualization, and <code>machine</code>
        referring to the machine type. The <a href="formatcaps.html">Capabilities XML</a>
        provides details on allowed values for these. <span class="since">Since 0.0.1</span></dd>
D
Daniel P. Berrange 已提交
102 103
      <dt><code>loader</code></dt>
      <dd>The optional <code>loader</code> tag refers to a firmware blob
M
Matthew Booth 已提交
104 105
        used to assist the domain creation process. At this time, it is
        only needed by Xen fully virtualized domains. <span class="since">Since 0.1.0</span></dd>
D
Daniel P. Berrange 已提交
106 107
      <dt><code>boot</code></dt>
      <dd>The <code>dev</code> attribute takes one of the values "fd", "hd",
M
Matthew Booth 已提交
108 109
        "cdrom" or "network" and is used to specify the next boot device
        to consider. The <code>boot</code> element can be repeated multiple
110 111
        times to setup a priority list of boot devices to try in turn. The
        <code>boot</code> element cannot be used if per-device boot elements
112 113 114
        are used (see <a href="#elementsDisks">disks</a>,
        <a href="#elementsNICS">network interfaces</a>, and
        <a href="#elementsUSB">USB and PCI devices</a> sections below).
115
        <span class="since">Since 0.1.3, per-device boot since 0.8.8</span>
D
Daniel P. Berrange 已提交
116
      </dd>
117 118 119 120 121 122
      <dt><code>bootmenu</code></dt>
      <dd> Whether or not to enable an interactive boot menu prompt on guest
      startup. The <code>enable</code> attribute can be either "yes" or "no".
      If not specified, the hypervisor default is used. <span class="since">
      Since 0.8.3</span>
      </dd>
123 124 125 126 127
      <dt><code>smbios</code></dt>
      <dd>How to populate SMBIOS information visible in the guest.
      The <code>mode</code> attribute must be specified, and is either
      "emulate" (let the hypervisor generate all values), "host" (copy
      all of Block 0 and Block 1, except for the UUID, from the host's
E
Eric Blake 已提交
128 129 130 131
      SMBIOS values;
      the <a href="html/libvirt-libvirt.html#virConnectGetSysinfo">
      <code>virConnectGetSysinfo</code></a> call can be
      used to see what values are copied), or "sysinfo" (use the values in
132 133 134 135
      the <a href="#elementsSysinfo">sysinfo</a> element).  If not
      specified, the hypervisor default is used. <span class="since">
      Since 0.8.7</span>
      </dd>
D
Daniel P. Berrange 已提交
136 137 138 139 140 141 142
    </dl>

    <h4><a name="elementsOSBootloader">Host bootloader</a></h4>

    <p>
      Hypervisors employing paravirtualization do not usually emulate
      a BIOS, and instead the host is responsible to kicking off the
A
Atsushi SAKAI 已提交
143
      operating system boot. This may use a pseudo-bootloader in the
D
Daniel P. Berrange 已提交
144 145 146 147
      host to provide an interface to choose a kernel for the guest.
      An example is <code>pygrub</code> with Xen.
    </p>

148 149 150 151 152
<pre>
  ...
  &lt;bootloader&gt;/usr/bin/pygrub&lt;/bootloader&gt;
  &lt;bootloader_args&gt;--append single&lt;/bootloader_args&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
153 154 155 156

    <dl>
      <dt><code>bootloader</code></dt>
      <dd>The content of the <code>bootloader</code> element provides
M
Matthew Booth 已提交
157 158 159 160
        a fully qualified path to the bootloader executable in the
        host OS. This bootloader will be run to choose which kernel
        to boot. The required output of the bootloader is dependent
        on the hypervisor in use. <span class="since">Since 0.1.0</span></dd>
D
Daniel P. Berrange 已提交
161 162
      <dt><code>bootloader_args</code></dt>
      <dd>The optional <code>bootloader_args</code> element allows
M
Matthew Booth 已提交
163 164 165
        command line arguments to be passed to the bootloader.
        <span class="since">Since 0.2.3</span>
        </dd>
D
Daniel P. Berrange 已提交
166 167 168 169 170 171 172 173 174 175 176 177

    </dl>

    <h4><a name="elementsOSKernel">Direct kernel boot</a></h4>

    <p>
      When installing a new guest OS it is often useful to boot directly
      from a kernel and initrd stored in the host OS, allowing command
      line arguments to be passed directly to the installer. This capability
      is usually available for both para and full virtualized guests.
    </p>

178 179 180 181 182 183 184 185 186 187
<pre>
  ...
  &lt;os&gt;
    &lt;type&gt;hvm&lt;/type&gt;
    &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
    &lt;kernel&gt;/root/f8-i386-vmlinuz&lt;/kernel&gt;
    &lt;initrd&gt;/root/f8-i386-initrd&lt;/initrd&gt;
    &lt;cmdline&gt;console=ttyS0 ks=http://example.com/f8-i386/os/&lt;/cmdline&gt;
  &lt;/os&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
188 189 190 191

    <dl>
      <dt><code>type</code></dt>
      <dd>This element has the same semantics as described earlier in the
M
Matthew Booth 已提交
192
        <a href="#elementsOSBIOS">BIOS boot section</a></dd>
D
Daniel Veillard 已提交
193
      <dt><code>loader</code></dt>
D
Daniel P. Berrange 已提交
194
      <dd>This element has the same semantics as described earlier in the
M
Matthew Booth 已提交
195
        <a href="#elementsOSBIOS">BIOS boot section</a></dd>
D
Daniel P. Berrange 已提交
196 197
      <dt><code>kernel</code></dt>
      <dd>The contents of this element specify the fully-qualified path
M
Matthew Booth 已提交
198
        to the kernel image in the host OS.</dd>
D
Daniel P. Berrange 已提交
199 200
      <dt><code>initrd</code></dt>
      <dd>The contents of this element specify the fully-qualified path
M
Matthew Booth 已提交
201
        to the (optional) ramdisk image in the host OS.</dd>
D
Daniel P. Berrange 已提交
202 203
      <dt><code>cmdline</code></dt>
      <dd>The contents of this element specify arguments to be passed to
M
Matthew Booth 已提交
204 205 206
        the kernel (or installer) at boottime. This is often used to
        specify an alternate primary console (eg serial port), or the
        installation media source / kickstart file</dd>
D
Daniel P. Berrange 已提交
207 208
    </dl>

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 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
    <h3><a name="elementsSysinfo">SMBIOS System Information</a></h3>

    <p>
      Some hypervisors allow control over what system information is
      presented to the guest (for example, SMBIOS fields can be
      populated by a hypervisor and inspected via
      the <code>dmidecode</code> command in the guest).  The
      optional <code>sysinfo</code> element covers all such categories
      of information. <span class="since">Since 0.8.7</span>
    </p>

<pre>
  ...
  &lt;os&gt;
    &lt;smbios mode='sysinfo'/&gt;
    ...
  &lt;/os&gt;
  &lt;sysinfo type='smbios'&gt;
    &lt;bios&gt;
      &lt;entry name='vendor'&gt;LENOVO&lt;/entry&gt;
    &lt;/bios&gt;
    &lt;system&gt;
      &lt;entry name='manufacturer'&gt;Fedora&lt;/entry&gt;
      &lt;entry name='vendor'&gt;Virt-Manager&lt;/entry&gt;
    &lt;/system&gt;
  &lt;/sysinfo&gt;
  ...</pre>

    <p>
      The <code>sysinfo</code> element has a mandatory
      attribute <code>type</code> that determine the layout of
      sub-elements, with supported values of:
    </p>

    <dl>
      <dt><code>smbios</code></dt>
      <dd>Sub-elements call out specific SMBIOS values, which will
      affect the guest if used in conjunction with
      the <code>smbios</code> sub-element of
      the <a href="#elementsOS"><code>os</code></a> element.  Each
      sub-element of <code>sysinfo</code> names a SMBIOS block, and
      within those elements can be a list of <code>entry</code>
      elements that describe a field within the block.  The following
      blocks and entries are recognized:
        <dl>
          <dt><code>bios</code></dt>
          <dd>
            This is block 0 of SMBIOS, with entry names drawn from
            "vendor", "version", "date", and "release".
          </dd>
          <dt><code>system</code></dt>
          <dd>
            This is block 1 of SMBIOS, with entry names drawn from
            "manufacturer", "product", "version", "serial", "uuid",
            "sku", and "family".  If a "uuid" entry is provided
            alongside a
            top-level <a href="#elementsMetadata"><code>uuid</code>
            element</a>, the two values must match.
          </dd>
        </dl>
      </dd>
    </dl>

D
Daniel P. Berrange 已提交
272 273
    <h3><a name="elementsResources">Basic resources</a></h3>

274 275 276 277 278 279 280
<pre>
  ...
  &lt;memory&gt;524288&lt;/memory&gt;
  &lt;currentMemory&gt;524288&lt;/currentMemory&gt;
  &lt;memoryBacking&gt;
    &lt;hugepages/&gt;
  &lt;/memoryBacking&gt;
281 282 283
  &lt;blkiotune&gt;
    &lt;weight&gt;800&lt;/weight&gt;
  &lt;/blkiotune&gt;
284 285 286 287 288 289
  &lt;memtune&gt;
    &lt;hard_limit&gt;1048576&lt;/hard_limit&gt;
    &lt;soft_limit&gt;131072&lt;/soft_limit&gt;
    &lt;swap_hard_limit&gt;2097152&lt;/swap_hard_limit&gt;
    &lt;min_guarantee&gt;65536&lt;/min_guarantee&gt;
  &lt;/memtune&gt;
290
  &lt;vcpu cpuset="1-4,^3,6" current="1"&gt;2&lt;/vcpu&gt;
291
  &lt;cputune&gt;
292 293 294 295
    &lt;vcpupin vcpu="0" cpuset="1-4,^2"/&gt;
    &lt;vcpupin vcpu="1" cpuset="0,1"/&gt;
    &lt;vcpupin vcpu="2" cpuset="2,3"/&gt;
    &lt;vcpupin vcpu="3" cpuset="0,4"/&gt;
296
    &lt;shares&gt;2048&lt;/shares&gt;
297
  &lt;/cputune&gt;
298 299 300
  &lt;numatune&gt;
  &lt;memory mode="strict" nodeset="1-4,^3"/&gt;
  &lt;/numatune&gt;
301
  ...</pre>
D
Daniel P. Berrange 已提交
302 303 304 305

    <dl>
      <dt><code>memory</code></dt>
      <dd>The maximum allocation of memory for the guest at boot time.
M
Matthew Booth 已提交
306
        The units for this value are kilobytes (i.e. blocks of 1024 bytes)</dd>
D
Daniel P. Berrange 已提交
307
      <dt><code>currentMemory</code></dt>
308
      <dd>The actual allocation of memory for the guest. This value can
M
Matthew Booth 已提交
309 310
        be less than the maximum allocation, to allow for ballooning
        up the guests memory on the fly. If this is omitted, it defaults
311
        to the same value as the <code>memory</code> element</dd>
312 313
      <dt><code>memoryBacking</code></dt>
      <dd>The optional <code>memoryBacking</code> element, may have an
M
Matthew Booth 已提交
314 315 316
        <code>hugepages</code> element set within it. This tells the
        hypervisor that the guest should have its memory allocated using
        hugepages instead of the normal native page size.</dd>
317 318 319 320 321 322 323
      <dt><code>blkiotune</code></dt>
      <dd> The optional <code>blkiotune</code> element provides the ability
        to tune Blkio cgroup tunable parameters for the domain. If this is
        omitted, it defaults to the OS provided defaults.</dd>
      <dt><code>weight</code></dt>
      <dd> The optional <code>weight</code> element is the I/O weight of the
        guest. The value should be in range [100, 1000].</dd>
324 325
      <dt><code>memtune</code></dt>
      <dd> The optional <code>memtune</code> element provides details
326
        regarding the memory tunable parameters for the domain. If this is
E
Eric Blake 已提交
327
        omitted, it defaults to the OS provided defaults. For QEMU/KVM, the
328 329 330 331
        parameters are applied to the QEMU process as a whole. Thus, when
        counting them, one needs to add up guest RAM, guest video RAM, and
        some memory overhead of QEMU itself. The last piece is hard to
        determine so one needs guess and try.</dd>
332 333
      <dt><code>hard_limit</code></dt>
      <dd> The optional <code>hard_limit</code> element is the maximum memory
E
Eric Blake 已提交
334 335
        the guest can use. The units for this value are kilobytes (i.e. blocks
        of 1024 bytes)</dd>
336 337
      <dt><code>soft_limit</code></dt>
      <dd> The optional <code>soft_limit</code> element is the memory limit to
E
Eric Blake 已提交
338 339
        enforce during memory contention. The units for this value are
        kilobytes (i.e. blocks of 1024 bytes)</dd>
340 341
      <dt><code>swap_hard_limit</code></dt>
      <dd> The optional <code>swap_hard_limit</code> element is the maximum
342 343 344
        memory plus swap the guest can use. The units for this value are
        kilobytes (i.e. blocks of 1024 bytes). This has to be more than
        hard_limit value provided</dd>
345 346
      <dt><code>min_guarantee</code></dt>
      <dd> The optional <code>min_guarantee</code> element is the guaranteed
E
Eric Blake 已提交
347 348
        minimum memory allocation for the guest. The units for this value are
        kilobytes (i.e. blocks of 1024 bytes)</dd>
D
Daniel P. Berrange 已提交
349
      <dt><code>vcpu</code></dt>
350
      <dd>The content of this element defines the maximum number of virtual
E
Eric Blake 已提交
351 352 353 354 355 356 357
        CPUs allocated for the guest OS, which must be between 1 and
        the maximum supported by the hypervisor.  <span class="since">Since
        0.4.4</span>, this element can contain an optional
        <code>cpuset</code> attribute, which is a comma-separated
        list of physical CPU numbers that virtual CPUs can be pinned
        to.  Each element in that list is either a single CPU number,
        a range of CPU numbers, or a caret followed by a CPU number to
358 359 360 361
        be excluded from a previous range.  <span class="since">Since
        0.8.5</span>, the optional attribute <code>current</code> can
        be used to specify whether fewer than the maximum number of
        virtual CPUs should be enabled.
E
Eric Blake 已提交
362
      </dd>
363
      <dt><code>cputune</code></dt>
364 365 366 367 368
      <dd>
         The optional <code>cputune</code> element provides details
         regarding the cpu tunable parameters for the domain.
         <span class="since">Since 0.9.0</span>
      </dd>
369
      <dt><code>vcpupin</code></dt>
370 371
      <dd>
        The optional <code>vcpupin</code> element specifies which of host
372 373
        physical CPUS the domain VCPU will be pinned to. If this is ommited,
        each VCPU pinned to all the physical CPUS by default. It contains two
374
        required attributes, the attribute <code>vcpu</code> specifies vcpu id,
375
        and the attribute <code>cpuset</code> is same as attribute <code>cpuset</code>
376 377 378
        of element <code>vcpu</code>. (NB: Only qemu driver support)
        <span class="since">Since 0.9.0</span>
       </dd>
379
      <dt><code>shares</code></dt>
380 381
      <dd>
        The optional <code>shares</code> element specifies the proportional
382 383 384
        weighted share for the domain. If this is ommited, it defaults to
        the OS provided defaults. NB, There is no unit for the value, it's a relative
        measure based on the setting of other VM, e.g. A VM configured with value
385 386 387
        2048 will get twice as much CPU time as a VM configured with value 1024.
        <span class="since">Since 0.9.0</span>
      </dd>
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
      <dt><code>numatune</code></dt>
      <dd>
        The optional <code>numatune</code> element provides details of
        how to tune the performance of a NUMA host via controlling NUMA policy
        for domain process. NB, only supported by QEMU driver.
        <span class='since'>Since 0.9.3</span>
      <dt><code>memory</code></dt>
      <dd>
        The optional <code>memory</code> element specify how to allocate memory
        for the domain process on a NUMA host. It contains two attributes,
        attribute <code>mode</code> is either 'interleave', 'strict', or 'preferred',
        attribute <code>nodeset</code> specifies the NUMA nodes, it leads same
        syntax with attribute <code>cpuset</code> of element <code>vcpu</code>.
        <span class='since'>Since 0.9.3</span>
      </dd>
D
Daniel P. Berrange 已提交
403 404
    </dl>

405 406 407 408 409 410 411 412
    <h3><a name="elementsCPU">CPU model and topology</a></h3>

    <p>
      Requirements for CPU model, its features and topology can be specified
      using the following collection of elements.
      <span class="since">Since 0.7.5</span>
    </p>

413 414 415 416
<pre>
  ...
  &lt;cpu match='exact'&gt;
    &lt;model&gt;core2duo&lt;/model&gt;
J
Jiri Denemark 已提交
417
    &lt;vendor&gt;Intel&lt;/vendor&gt;
418 419 420 421
    &lt;topology sockets='1' cores='2' threads='1'/&gt;
    &lt;feature policy='disable' name='lahf_lm'/&gt;
  &lt;/cpu&gt;
  ...</pre>
422 423 424 425 426 427 428

    <p>
      In case no restrictions need to be put on CPU model and its features, a
      simpler <code>cpu</code> element can be used.
      <span class="since">Since 0.7.6</span>
    </p>

429 430 431 432 433 434
<pre>
  ...
  &lt;cpu&gt;
    &lt;topology sockets='1' cores='2' threads='1'/&gt;
  &lt;/cpu&gt;
  ...</pre>
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456

    <dl>
      <dt><code>cpu</code></dt>
      <dd>The <code>cpu</code> element is the main container for describing
        guest CPU requirements. Its <code>match</code> attribute specified how
        strictly has the virtual CPU provided to the guest match these
        requirements. <span class="since">Since 0.7.6</span> the
        <code>match</code> attribute can be omitted if <code>topology</code>
        is the only element within <code>cpu</code>. Possible values for the
        <code>match</code> attribute are:

        <dl>
          <dt><code>minimum</code></dt>
          <dd>The specified CPU model and features describes the minimum
            requested CPU.</dd>
          <dt><code>exact</code></dt>
          <dd>The virtual CPU provided to the guest will exactly match the
            specification</dd>
          <dt><code>strict</code></dt>
          <dd>The guest will not be created unless the host CPU does exactly
            match the specification.</dd>
        </dl>
457

E
Eric Blake 已提交
458 459
        <span class="since">Since 0.8.5</span> the <code>match</code>
        attribute can be omitted and will default to <code>exact</code>.
460 461 462 463 464 465 466 467
      </dd>

      <dt><code>model</code></dt>
      <dd>The content of the <code>model</code> element specifies CPU model
        requested by the guest. The list of available CPU models and their
        definition can be found in <code>cpu_map.xml</code> file installed
        in libvirt's data directory.</dd>

J
Jiri Denemark 已提交
468 469 470 471 472 473 474
      <dt><code>vendor</code></dt>
      <dd><span class="since">Since 0.8.3</span> the content of the
        <code>vendor</code> element specifies CPU vendor requested by the
        guest. If this element is missing, the guest can be run on a CPU
        matching given features regardless on its vendor. The list of
        supported vendors can be found in <code>cpu_map.xml</code>.</dd>

475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
      <dt><code>topology</code></dt>
      <dd>The <code>topology</code> element specifies requested topology of
        virtual CPU provided to the guest. Three non-zero values have to be
        given for <code>sockets</code>, <code>cores</code>, and
        <code>threads</code>: total number of CPU sockets, number of cores per
        socket, and number of threads per core, respectively.</dd>

      <dt><code>feature</code></dt>
      <dd>The <code>cpu</code> element can contain zero or more
        <code>elements</code> used to fine-tune features provided by the
        selected CPU model. The list of known feature names can be found in
        the same file as CPU models. The meaning of each <code>feature</code>
        element depends on its <code>policy</code> attribute, which has to be
        set to one of the following values:

        <dl>
          <dt><code>force</code></dt>
          <dd>The virtual CPU will claim the feature is supported regardless
            of it being supported by host CPU.</dd>
          <dt><code>require</code></dt>
          <dd>Guest creation will fail unless the feature is supported by host
            CPU.</dd>
          <dt><code>optional</code></dt>
          <dd>The feature will be supported by virtual CPU if and only if it
            is supported by host CPU.</dd>
          <dt><code>disable</code></dt>
          <dd>The feature will not be supported by virtual CPU.</dd>
          <dt><code>forbid</code></dt>
          <dd>Guest creation will fail if the feature is supported by host
            CPU.</dd>
        </dl>
506

E
Eric Blake 已提交
507 508
        <span class="since">Since 0.8.5</span> the <code>policy</code>
        attribute can be omitted and will default to <code>require</code>.
509 510 511
      </dd>
    </dl>

D
Daniel P. Berrange 已提交
512 513 514
    <h3><a name="elementsLifecycle">Lifecycle control</a></h3>

    <p>
A
Atsushi SAKAI 已提交
515
      It is sometimes necessary to override the default actions taken
D
Daniel P. Berrange 已提交
516 517 518 519 520 521 522
      when a guest OS triggers a lifecycle operation. The following
      collections of elements allow the actions to be specified. A
      common use case is to force a reboot to be treated as a poweroff
      when doing the initial OS installation. This allows the VM to be
      re-configured for the first post-install bootup.
    </p>

523 524 525 526 527 528
<pre>
  ...
  &lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
  &lt;on_reboot&gt;restart&lt;/on_reboot&gt;
  &lt;on_crash&gt;restart&lt;/on_crash&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
529 530 531 532

    <dl>
      <dt><code>on_poweroff</code></dt>
      <dd>The content of this element specifies the action to take when
M
Matthew Booth 已提交
533
        the guest requests a poweroff.</dd>
D
Daniel Veillard 已提交
534
      <dt><code>on_reboot</code></dt>
D
Daniel P. Berrange 已提交
535
      <dd>The content of this element specifies the action to take when
M
Matthew Booth 已提交
536
        the guest requests a reboot.</dd>
D
Daniel Veillard 已提交
537
      <dt><code>on_crash</code></dt>
D
Daniel P. Berrange 已提交
538
      <dd>The content of this element specifies the action to take when
M
Matthew Booth 已提交
539
        the guest crashes.</dd>
D
Daniel P. Berrange 已提交
540 541 542 543 544 545 546 547 548
    </dl>

    <p>
      Each of these states allow for the same four possible actions.
    </p>

    <dl>
      <dt><code>destroy</code></dt>
      <dd>The domain will be terminated completely and all resources
M
Matthew Booth 已提交
549
        released</dd>
D
Daniel P. Berrange 已提交
550 551
      <dt><code>restart</code></dt>
      <dd>The domain will be terminated, and then restarted with
M
Matthew Booth 已提交
552
        the same configuration</dd>
D
Daniel P. Berrange 已提交
553 554
      <dt><code>preserve</code></dt>
      <dd>The domain will be terminated, and its resource preserved
M
Matthew Booth 已提交
555
        to allow analysis.</dd>
D
Daniel P. Berrange 已提交
556 557
      <dt><code>rename-restart</code></dt>
      <dd>The domain will be terminated, and then restarted with
M
Matthew Booth 已提交
558
        a new name</dd>
D
Daniel P. Berrange 已提交
559 560
    </dl>

561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
    <p>
      on_crash supports these additional
      actions <span class="since">since 0.8.4</span>.
    </p>

    <dl>
      <dt><code>coredump-destroy</code></dt>
      <dd>The crashed domain's core will be dumped, and then the
        domain will be terminated completely and all resources
        released</dd>
      <dt><code>coredump-restart</code></dt>
      <dd>The crashed domain's core will be dumped, and then the
        domain will be restarted with the same configuration</dd>
    </dl>

D
Daniel P. Berrange 已提交
576 577 578 579 580 581 582
    <h3><a name="elementsFeatures">Hypervisor features</a></h3>

    <p>
      Hypervisors may allow certain CPU / machine features to be
      toggled on/off.
    </p>

583 584 585 586 587 588
<pre>
  ...
  &lt;features&gt;
    &lt;pae/&gt;
    &lt;acpi/&gt;
    &lt;apic/&gt;
J
Jim Fehlig 已提交
589
    &lt;hap/&gt;
590 591
  &lt;/features&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
592 593 594 595 596 597 598 599 600 601 602 603

    <p>
      All features are listed within the <code>features</code>
      element, omitting a togglable feature tag turns it off.
      The available features can be found by asking
      for the <a href="formatcaps.html">capabilities XML</a>,
      but a common set for fully virtualized domains are:
    </p>

    <dl>
      <dt><code>pae</code></dt>
      <dd>Physical address extension mode allows 32-bit guests
M
Matthew Booth 已提交
604
        to address more than 4 GB of memory.</dd>
D
Daniel P. Berrange 已提交
605 606
      <dt><code>acpi</code></dt>
      <dd>ACPI is useful for power management, for example, with
M
Matthew Booth 已提交
607
        KVM guests it is required for graceful shutdown to work.
D
Daniel P. Berrange 已提交
608
      </dd>
J
Jim Fehlig 已提交
609 610 611 612
      <dt><code>hap</code></dt>
      <dd>Enable use of Hardware Assisted Paging if available in
        the hardware.
      </dd>
D
Daniel P. Berrange 已提交
613 614 615 616 617 618 619 620 621 622 623
    </dl>

    <h3><a name="elementsTime">Time keeping</a></h3>

    <p>
      The guest clock is typically initialized from the host clock.
      Most operating systems expect the hardware clock to be kept
      in UTC, and this is the default. Windows, however, expects
      it to be in so called 'localtime'.
    </p>

624 625
<pre>
  ...
626 627 628 629 630 631
  &lt;clock offset="localtime"&gt;
    &lt;timer name="rtc" tickpolicy="catchup" track="guest"&gt;
      &lt;catchup threshold=123 slew=120 limit=10000/&gt;
    &lt;/timer&gt;
    &lt;timer name="pit" tickpolicy="none"/&gt;
  &lt;/clock&gt;
632
  ...</pre>
D
Daniel P. Berrange 已提交
633 634 635

    <dl>
      <dt><code>clock</code></dt>
636
      <dd>
E
Eric Blake 已提交
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
        <p>The <code>offset</code> attribute takes four possible
          values, allowing fine grained control over how the guest
          clock is synchronized to the host. NB, not all hypervisors
          support all modes.</p>
        <dl>
          <dt><code>utc</code></dt>
          <dd>
            The guest clock will always be synchronized to UTC when
            booted</dd>
          <dt><code>localtime</code></dt>
          <dd>
            The guest clock will be synchronized to the host's configured
            timezone when booted, if any.
          </dd>
          <dt><code>timezone</code></dt>
          <dd>
            The guest clock will be synchronized to the requested timezone
            using the <code>timezone</code> attribute.
            <span class="since">Since 0.7.7</span>
          </dd>
          <dt><code>variable</code></dt>
          <dd>
            The guest clock will have an arbitrary offset applied
            relative to UTC. The delta relative to UTC is specified
            in seconds, using the <code>adjustment</code> attribute.
            The guest is free to adjust the RTC over time an expect
            that it will be honoured at next reboot. This is in
            contrast to 'utc' mode, where the RTC adjustments are
            lost at each reboot. <span class="since">Since 0.7.7</span>
          </dd>
        </dl>
        <p>
          A <code>clock</code> may have zero or more
          <code>timer</code>sub-elements. <span class="since">Since
          0.8.0</span>
        </p>
D
Daniel P. Berrange 已提交
673
      </dd>
674 675
      <dt><code>timer</code></dt>
      <dd>
E
Eric Blake 已提交
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
        <p>
          Each timer element requires a <code>name</code> attribute,
          and has other optional attributes that depend on
          the <code>name</code> specified.  Various hypervisors
          support different combinations of attributes.
        </p>
        <dl>
          <dt><code>name</code></dt>
          <dd>
            The <code>name</code> attribute selects which timer is
            being modified, and can be one of "platform", "pit",
            "rtc", "hpet", or "tsc".
          </dd>
          <dt><code>track</code></dt>
          <dd>
            The <code>track</code> attribute specifies what the timer
            tracks, and can be "boot", "guest", or "wall".
            Only valid for <code>name="rtc"</code>
            or <code>name="platform"</code>.
          </dd>
          <dt><code>tickpolicy</code></dt>
          <dd>
            The <code>tickpolicy</code> attribute determines how
            missed ticks in the guest are handled, and can be "delay",
            "catchup", "merge", or "discard".  If the policy is
            "catchup", there can be further details in
            the <code>catchup</code> sub-element.
            <dl>
              <dt><code>catchup</code></dt>
              <dd>
                The <code>catchup</code> element has three optional
                attributes, each a positive integer.  The attributes
                are <code>threshold</code>, <code>slew</code>,
                and <code>limit</code>.
              </dd>
            </dl>
          </dd>
          <dt><code>frequency</code></dt>
          <dd>
            The <code>frequency</code> attribute is an unsigned
            integer specifying the frequency at
            which <code>name="tsc"</code> runs.
          </dd>
          <dt><code>mode</code></dt>
          <dd>
            The <code>mode</code> attribute controls how
            the <code>name="tsc"</code> timer is managed, and can be
            "auto", "native", "emulate", "paravirt", or "smpsafe".
            Other timers are always emulated.
          </dd>
          <dt><code>present</code></dt>
          <dd>
            The <code>present</code> attribute can be "yes" or "no" to
            specify whether a particular timer is available to the guest.
          </dd>
        </dl>
732
      </dd>
D
Daniel P. Berrange 已提交
733 734 735 736 737
    </dl>

    <h3><a name="elementsDevices">Devices</a></h3>

    <p>
A
Atsushi SAKAI 已提交
738
      The final set of XML elements are all used to describe devices
D
Daniel P. Berrange 已提交
739 740 741 742 743
      provided to the guest domain. All devices occur as children
      of the main <code>devices</code> element.
      <span class="since">Since 0.1.3</span>
    </p>

744 745 746 747 748 749
<pre>
  ...
  &lt;devices&gt;
    &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
750 751 752 753

    <dl>
      <dt><code>emulator</code></dt>
      <dd>
M
Matthew Booth 已提交
754 755 756 757 758
        The contents of the <code>emulator</code> element specify
        the fully qualified path to the device model emulator binary.
        The <a href="formatcaps.html">capabilities XML</a> specifies
        the recommended default emulator to use for each particular
        domain type / architecture combination.
D
Daniel P. Berrange 已提交
759 760 761 762 763 764 765 766 767 768 769
      </dd>
    </dl>

    <h4><a name="elementsDisks">Hard drives, floppy disks, CDROMs</a></h4>

    <p>
      Any device that looks like a disk, be it a floppy, harddisk,
      cdrom, or paravirtualized driver is specified via the <code>disk</code>
      element.
    </p>

770 771 772 773
<pre>
  ...
  &lt;devices&gt;
    &lt;disk type='file'&gt;
774
      &lt;driver name="tap" type="aio" cache="default"/&gt;
775 776
      &lt;source file='/var/lib/xen/images/fv0'/&gt;
      &lt;target dev='hda' bus='ide'/&gt;
777
      &lt;boot order='2'/&gt;
778 779 780 781
      &lt;encryption type='...'&gt;
        ...
      &lt;/encryption&gt;
      &lt;shareable/&gt;
782 783 784
      &lt;serial&gt;
        ...
      &lt;/serial&gt;
785
    &lt;/disk&gt;
M
MORITA Kazutaka 已提交
786 787
      ...
    &lt;disk type='network'&gt;
788
      &lt;driver name="qemu" type="raw" io="threads" ioeventfd="on"/&gt;
M
MORITA Kazutaka 已提交
789 790 791 792
      &lt;source protocol="sheepdog" name="image_name"&gt;
        &lt;host name="hostname" port="7000"/&gt;
      &lt;/source&gt;
      &lt;target dev="hdb" bus="ide"/&gt;
793
      &lt;boot order='1'/&gt;
E
Eric Blake 已提交
794
      &lt;address type='drive' controller='0' bus='1' unit='0'/&gt;
M
MORITA Kazutaka 已提交
795
    &lt;/disk&gt;
796 797
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
798 799 800 801

    <dl>
      <dt><code>disk</code></dt>
      <dd>The <code>disk</code> element is the main container for describing
M
MORITA Kazutaka 已提交
802 803
        disks. The <code>type</code> attribute is either "file",
        "block", "dir", or "network"
M
Matthew Booth 已提交
804 805 806 807
        and refers to the underlying source for the disk. The optional
        <code>device</code> attribute indicates how the disk is to be exposed
        to the guest OS. Possible values for this attribute are "floppy", "disk"
        and "cdrom", defaulting to "disk".
M
MORITA Kazutaka 已提交
808 809
        <span class="since">Since 0.0.3; "device" attribute since 0.1.4;
        "network" attribute since 0.8.7</span></dd>
D
Daniel P. Berrange 已提交
810
      <dt><code>source</code></dt>
E
Eric Blake 已提交
811
      <dd>If the disk <code>type</code> is "file", then
M
MORITA Kazutaka 已提交
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826
        the <code>file</code> attribute specifies the fully-qualified
        path to the file holding the disk. If the disk
        <code>type</code> is "block", then the <code>dev</code>
        attribute specifies the path to the host device to serve as
        the disk. If the disk <code>type</code> is "network", then
        the <code>protocol</code> attribute specifies the protocol to
        access to the requested image; possible values are "nbd",
        "rbd", and "sheepdog".  If the <code>protocol</code> attribute
        is "rbd" or "sheepdog", an additional
        attribute <code>name</code> is mandatory to specify which
        image to be used.  When the disk <code>type</code> is
        "network", the <code>source</code> may have zero or
        more <code>host</code> sub-elements used to specify the hosts
        to connect.
        <span class="since">Since 0.0.3</span></dd>
D
Daniel P. Berrange 已提交
827 828
      <dt><code>target</code></dt>
      <dd>The <code>target</code> element controls the bus / device under which the
M
Matthew Booth 已提交
829 830 831 832 833 834 835 836 837
        disk is exposed to the guest OS. The <code>dev</code> attribute indicates
        the "logical" device name. The actual device name specified is not guaranteed to map to
        the device name in the guest OS. Treat it as a device ordering hint.
        The optional <code>bus</code> attribute specifies the type of disk device
        to emulate; possible values are driver specific, with typical values being
        "ide", "scsi", "virtio", "xen" or "usb". If omitted, the bus type is
        inferred from the style of the device name. eg, a device named 'sda'
        will typically be exported using a SCSI bus.
        <span class="since">Since 0.0.3; <code>bus</code> attribute since 0.4.3;
838
        "usb" attribute value since after 0.4.4</span></dd>
D
Daniel P. Berrange 已提交
839
      <dt><code>driver</code></dt>
M
Matthias Dahl 已提交
840 841 842
      <dd>
        The optional driver element allows specifying further details
        related to the hypervisor driver used to provide the disk.
843
        <span class="since">Since 0.1.8</span>
M
Matthias Dahl 已提交
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
        <ul>
          <li>
            If the hypervisor supports multiple backend drivers, then
            the <code>name</code> attribute selects the primary
            backend driver name, while the optional <code>type</code>
            attribute provides the sub-type.  For example, xen
            supports a name of "tap", "tap2", "phy", or "file", with a
            type of "aio", while qemu only supports a name of "qemu",
            but multiple types including "raw", "bochs", "qcow2", and
            "qed".
          </li>
          <li>
            The optional <code>cache</code> attribute controls the
            cache mechanism, possible values are "default", "none",
            "writethrough" and "writeback".
859
            <span class="since">Since 0.6.0</span>
M
Matthias Dahl 已提交
860 861 862 863 864
          </li>
          <li>
            The optional <code>error_policy</code> attribute controls
            how the hypervisor will behave on an error, possible
            values are "stop", "ignore", and "enospace".
865
            <span class="since">Since 0.8.0</span>
M
Matthias Dahl 已提交
866 867 868 869
          </li>
          <li>
            The optional <code>io</code> attribute controls specific
            policies on I/O; qemu guests support "threads" and
870
            "native". <span class="since">Since 0.8.8</span>
M
Matthias Dahl 已提交
871
          </li>
872 873 874 875 876 877 878 879 880 881 882 883 884 885
          <li>
            The optional <code>ioeventfd</code> attribute allows users to
            set <a href='https://patchwork.kernel.org/patch/43390/'>
            domain I/O asynchronous handling</a> for disk device.
            The default is left to the discretion of the hypervisor.
            Accepted values are "on" and "off". Enabling this allows
            qemu to execute VM while a separate thread handles I/O.
            Typically guests experiencing high system CPU utilization
            during I/O will benefit from this. On the other hand,
            on overloaded host it could increase guest I/O latency.
            <span class="since">Since 0.9.3 (QEMU and KVM only)</span>
            <b>In general you should leave this option alone, unless you
            are very certain you know what you are doing.</b>
          </li>
M
Matthias Dahl 已提交
886
        </ul>
D
Daniel P. Berrange 已提交
887
      </dd>
888 889 890 891 892 893 894 895
      <dt><code>boot</code></dt>
      <dd>Specifies that the disk is bootable. The <code>order</code>
        attribute determines the order in which devices will be tried during
        boot sequence. The per-device <code>boot</code> elements cannot be
        used together with general boot elements in
        <a href="#elementsOSBIOS">BIOS bootloader</a> section.
        <span class="since">Since 0.8.8</span>
      </dd>
896 897 898 899 900
      <dt><code>encryption</code></dt>
      <dd>If present, specifies how the volume is encrypted.  See
        the <a href="formatstorageencryption.html">Storage Encryption</a> page
        for more information.
      </dd>
901 902 903 904 905
      <dt><code>shareable</code></dt>
      <dd>If present, this indicates the device is expected to be shared
          between domains (assuming the hypervisor and OS support this),
          which means that caching should be deactivated for that device.
      </dd>
906 907 908 909 910
      <dt><code>serial</code></dt>
      <dd>If present, this specify serial number of virtual hard drive.
          For example, it may look as <code>&lt;serial&gt;WD-WMAP9A966149&lt;/serial&gt;</code>.
          <span class="since">Since 0.7.1</span>
      </dd>
M
MORITA Kazutaka 已提交
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
      <dt><code>host</code></dt>
      <dd>The <code>host</code> element has two attributes "name" and "port",
        which specify the hostname and the port number. The meaning of this
        element and the number of the elements depend on the protocol attribute.
        <table class="top_table">
          <tr>
            <th> Protocol </th>
            <th> Meaning </th>
            <th> Number of hosts </th>
          </tr>
          <tr>
            <td> nbd </td>
            <td> a server running nbd-server </td>
            <td> only one </td>
          </tr>
          <tr>
            <td> rbd </td>
            <td> monitor servers of RBD </td>
            <td> one or more </td>
          </tr>
          <tr>
            <td> sheepdog </td>
            <td> one of the sheepdog servers (default is localhost:7000) </td>
            <td> zero or one </td>
          </tr>
        </table>
      </dd>
E
Eric Blake 已提交
938 939 940 941 942 943 944 945 946 947 948 949 950 951
      <dt><code>address</code></dt>
      <dd>If present, the <code>address</code> element ties the disk
        to a given slot of a controller (the
        actual <code>&lt;controller&gt;</code> device can often be
        inferred by libvirt, although it can
        be <a href="#elementsControllers">explicitly specified</a>).
        The <code>type</code> attribute is mandatory, and is typically
        "pci" or "drive".  For a "pci" controller, additional
        attributes for <code>bus</code>, <code>slot</code>,
        and <code>function</code> must be present, as well as an
        optional <code>domain</code>.  For a "drive" controller,
        additional attributes <code>controller</code>, <code>bus</code>,
        and <code>unit</code> are available, each defaulting to 0.
      </dd>
D
Daniel P. Berrange 已提交
952 953
    </dl>

954 955 956 957 958 959 960 961 962 963 964 965 966 967
    <h4><a name="elementsFilesystems">Filesystems</a></h4>

    <p>
      A directory on the host that can be accessed directly from the guest.
      <span class="since">since 0.3.3, since 0.8.5 for QEMU/KVM</span>
    </p>

<pre>
  ...
  &lt;devices&gt;
    &lt;filesystem type='template'&gt;
      &lt;source name='my-vm-template'/&gt;
      &lt;target dir='/'/&gt;
    &lt;/filesystem&gt;
968
    &lt;filesystem type='mount' accessmode='passthrough'&gt;
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
      &lt;source dir='/export/to/guest'/&gt;
      &lt;target dir='/import/from/host'/&gt;
      &lt;readonly/&gt;
    &lt;/filesystem&gt;
    ...
  &lt;/devices&gt;
  ...</pre>

    <dl>
      <dt><code>filesystem</code></dt>
      <dd>

      The filesystem attribute <code>type</code> specifies the type of the
      <code>source</code>. The possible values are:

        <dl>
        <dt><code>type='mount'</code></dt>
        <dd>
        A host directory to mount in the guest. Used by LXC,
        OpenVZ <span class="since">(since 0.6.2)</span>
        and QEMU/KVM <span class="since">(since 0.8.5)</span>.
990
        This is the default <code>type</code> if one is not specified.
991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
        </dd>
        <dt><code>type='template'</code></dt>
        <dd>
        OpenVZ filesystem template. Only used by OpenVZ driver.
        </dd>
        <dt><code>type='file'</code></dt>
        <dd>
        Currently unused.
        </dd>
        <dt><code>type='block'</code></dt>
        <dd>
        Currently unused.
        </dd>
        </dl>

1006
      The filesystem block has an optional attribute <code>accessmode</code>
1007 1008 1009 1010 1011 1012
      which specifies the security mode for accessing the source
      <span class="since">(since 0.8.5)</span>. Currently this only works
      with <code>type='mount'</code> for the QEMU/KVM driver. The possible
      values are:

        <dl>
1013
        <dt><code>accessmode='passthrough'</code></dt>
1014 1015
        <dd>
        The <code>source</code> is accessed with the permissions of the
1016
        user inside the guest. This is the default <code>accessmode</code> if
1017 1018 1019
        one is not specified.
        <a href="http://lists.gnu.org/archive/html/qemu-devel/2010-05/msg02673.html">More info</a>
        </dd>
1020
        <dt><code>accessmode='mapped'</code></dt>
1021 1022 1023 1024 1025
        <dd>
        The <code>source</code> is accessed with the permissions of the
        hypervisor (QEMU process).
        <a href="http://lists.gnu.org/archive/html/qemu-devel/2010-05/msg02673.html">More info</a>
        </dd>
1026
        <dt><code>accessmode='squash'</code></dt>
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
        <dd>
        Similar to 'passthrough', the exception is that failure of
        privileged operations like 'chown' are ignored. This makes a
        passthrough-like mode usable for people who run the hypervisor
        as non-root.
        <a href="http://lists.gnu.org/archive/html/qemu-devel/2010-09/msg00121.html">More info</a>
        </dd>
        </dl>

      </dd>

      <dt><code>source</code></dt>
      <dd>
        The resource on the host that is being accessed in the guest. The
        <code>name</code> attribute must be used with
        <code>type='template'</code>, and the <code>dir</code> attribute must
        be used with <code>type='mount'</code>
      </dd>

      <dt><code>target</code></dt>
      <dd>
        Where the <code>source</code> can be accessed in the guest. For
        most drivers this is an automatic mount point, but for QEMU/KVM
        this is merely an arbitrary string tag that is exported to the
        guest as a hint for where to mount.
      </dd>

      <dt><code>readonly</code></dt>
      <dd>
      An optional <code>readonly</code> attribute is available but currently
      unused.
      </dd>
    </dl>

E
Eric Blake 已提交
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
    <h4><a name="elementsControllers">Controllers</a></h4>

    <p>
      Many devices that have an <code>&lt;address&gt;</code>
      sub-element are designed to work with a controller to manage
      related devices.  Normally, libvirt can automatically infer such
      controllers without requiring explicit XML markup, but sometimes
      it is necessary to provide an explicit controller element.
    </p>

<pre>
  ...
  &lt;devices&gt;
    &lt;controller type='ide' index='0'/&gt;
    &lt;controller type='virtio-serial' index='0' ports='16' vectors='4'/&gt;
    &lt;controller type='virtio-serial' index='1'&gt;
      &lt;address type='pci' domain='0x0000' bus='0x00' slot='0x0a' function='0x0'/&gt;
    &lt;/controller&gt;
    ...
  &lt;/devices&gt;
  ...</pre>

    <p>
      Each controller has a mandatory attribute <code>type</code>,
1085
      which must be one of "ide", "fdc", "scsi", "sata", "ccid", or
E
Eric Blake 已提交
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
      "virtio-serial", and a mandatory attribute <code>index</code>
      which is the decimal integer describing in which order the bus
      controller is encountered (for use in <code>controller</code>
      attributes of <code>&lt;address&gt;</code> elements).  The
      "virtio-serial" controller has two additional optional
      attributes <code>ports</code> and <code>vectors</code>, which
      control how many devices can be connected through the
      controller.  A "scsi" controller has an optional
      attribute <code>model</code>, which is one of "auto",
      "buslogic", "lsilogic", "lsias1068", or "vmpvscsi".
    </p>

    <p>
      For controllers that are themselves devices on a PCI or USB bus,
      an optional sub-element <code>&lt;address&gt;</code> can specify
      the exact relationship of the controller to its master bus, with
      semantics like any other device's <code>address</code>
      sub-element.
    </p>

1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
    <h4><a name="elementsLease">Device leases</a></h4>

    <p>
      When using a lock manager, it may be desirable to record device leases
      against a VM. The lock manager will ensure the VM won't start unless
      the leases can be acquired.
    </p>

<pre>
  ...
  &lt;devices&gt;
    ...
    &lt;lease&gt;
      &lt;lockspace&gt;somearea&lt;/lockspace&gt;
      &lt;key&gt;somekey&lt;/key&gt;
      &lt;target path='/some/lease/path' offset='1024'/&gt;
    &lt;/lease&gt;
    ...
  &lt;/devices&gt;
  ...</pre>

    <dl>
      <dt>lockspace</dt>
      <dd>This is an arbitrary string, identifying the lockspace
        within which the key is held. Lock managers may impose
        extra restrictions on the format, or length of the lockspace
        name.</dd>
      <dt>key</dt>
      <dd>This is an arbitrary string, uniquely identifying the
        lease to be acquired. Lock managers may impose extra
        restrictions on the format, or length of the key.
      </dd>
      <dt>target</dt>
      <dd>This is the fully qualified path of the file associated
        with the lockspace. The offset specifies where the lease
        is stored within the file. If the lock manager does not
        require a offset, just pass 0.
      </dd>
    </dl>
E
Eric Blake 已提交
1145

1146
    <h4><a name="elementsUSB">USB and PCI devices</a></h4>
1147 1148

    <p>
1149 1150 1151
      USB and PCI devices attached to the host can be passed through to the guest using
      the <code>hostdev</code> element. <span class="since">since after
      0.4.4 for USB and 0.6.0 for PCI (KVM only)</span>:
1152 1153
    </p>

1154 1155 1156 1157 1158 1159 1160 1161
<pre>
  ...
  &lt;devices&gt;
    &lt;hostdev mode='subsystem' type='usb'&gt;
      &lt;source&gt;
        &lt;vendor id='0x1234'/&gt;
        &lt;product id='0xbeef'/&gt;
      &lt;/source&gt;
1162
      &lt;boot order='2'/&gt;
1163 1164 1165 1166
    &lt;/hostdev&gt;
  &lt;/devices&gt;
  ...</pre>

1167
    <p>or:</p>
1168 1169 1170 1171

<pre>
  ...
  &lt;devices&gt;
1172
    &lt;hostdev mode='subsystem' type='pci' managed='yes'&gt;
1173 1174 1175
      &lt;source&gt;
        &lt;address bus='0x06' slot='0x02' function='0x0'/&gt;
      &lt;/source&gt;
1176
      &lt;boot order='1'/&gt;
1177 1178 1179
    &lt;/hostdev&gt;
  &lt;/devices&gt;
  ...</pre>
1180 1181 1182 1183

    <dl>
      <dt><code>hostdev</code></dt>
      <dd>The <code>hostdev</code> element is the main container for describing
1184 1185
        host devices. For usb device passthrough <code>mode</code> is always
        "subsystem" and <code>type</code> is "usb" for a USB device and "pci"
1186
        for a PCI device. When <code>managed</code> is "yes" for a PCI
1187 1188
        device, it is detached from the host before being passed on to
        the guest.</dd>
1189 1190 1191 1192
      <dt><code>source</code></dt>
      <dd>The source element describes the device as seen from the host.
      The USB device can either be addressed by vendor / product id using the
      <code>vendor</code> and <code>product</code> elements or by the device's
1193 1194 1195
      address on the hosts using the <code>address</code> element.
      PCI devices on the other hand can only be described by their
      <code>address</code></dd>
1196 1197 1198 1199 1200
      <dt><code>vendor</code>, <code>product</code></dt>
      <dd>The <code>vendor</code> and <code>product</code> elements each have an
      <code>id</code> attribute that specifies the USB vendor and product id.
      The ids can be given in decimal, hexadecimal (starting with 0x) or
      octal (starting with 0) form.</dd>
1201 1202 1203 1204 1205 1206 1207
      <dt><code>boot</code></dt>
      <dd>Specifies that the device is bootable. The <code>order</code>
      attribute determines the order in which devices will be tried during
      boot sequence. The per-device <code>boot</code> elements cannot be
      used together with general boot elements in
      <a href="#elementsOSBIOS">BIOS bootloader</a> section.
      <span class="since">Since 0.8.8</span></dd>
1208
      <dt><code>address</code></dt>
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
      <dd>The <code>address</code> element for USB devices has a
      <code>bus</code> and <code>device</code> attribute to specify the
      USB bus and device number the device appears at on the host.
      The values of these attributes can be given in decimal, hexadecimal
      (starting with 0x) or octal (starting with 0) form.
      For PCI devices the element carries 3 attributes allowing to designate
      the device as can be found with the <code>lspci</code> or
      with <code>virsh nodedev-list</code>. The
      <code>bus</code> attribute allows the hexadecimal values 0 to ff, the
      <code>slot</code> attribute allows the hexadecimal values 0 to 1f, and
      the <code>function</code> attribute allows the hexadecimal values 0 to
      7. There is also an optional <code>domain</code> attribute for the
      PCI domain, with hexadecimal values 0 to ffff, but it is currently
      not used by qemu.</dd>
1223 1224
    </dl>

1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
    <h4><a name="elementsSmartcard">Smartcard devices</a></h4>

    <p>
      A virtual smartcard device can be supplied to the guest via the
      <code>smartcard</code> element. A USB smartcard reader device on
      the host cannot be used on a guest with simple device
      passthrough, since it will then not be available on the host,
      possibly locking the host computer when it is "removed".
      Therefore, some hypervisors provide a specialized virtual device
      that can present a smartcard interface to the guest, with
      several modes for describing how credentials are obtained from
      the host or even a from a channel created to a third-party
      smartcard provider. <span class="since">Since 0.8.8</span>
    </p>

<pre>
  ...
  &lt;devices&gt;
    &lt;smartcard mode='host'/&gt;
    &lt;smartcard mode='host-certificates'&gt;
      &lt;certificate&gt;cert1&lt;/certificate&gt;
      &lt;certificate&gt;cert2&lt;/certificate&gt;
      &lt;certificate&gt;cert3&lt;/certificate&gt;
      &lt;database&gt;/etc/pki/nssdb/&lt;/database&gt;
    &lt;/smartcard&gt;
    &lt;smartcard mode='passthrough' type='tcp'&gt;
      &lt;source mode='bind' host='127.0.0.1' service='2001'/&gt;
      &lt;protocol type='raw'/&gt;
      &lt;address type='ccid' controller='0' slot='0'/&gt;
    &lt;/smartcard&gt;
E
Eric Blake 已提交
1255
    &lt;smartcard mode='passthrough' type='spicevmc'/&gt;
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
  &lt;/devices&gt;
  ...
</pre>

    <p>
      The <code>&lt;smartcard&gt;</code> element has a mandatory
      attribute <code>mode</code>.  The following modes are supported;
      in each mode, the guest sees a device on its USB bus that
      behaves like a physical USB CCID (Chip/Smart Card Interface
      Device) card.
    </p>

    <dl>
      <dt><code>mode='host'</code></dt>
      <dd>The simplest operation, where the hypervisor relays all
      requests from the guest into direct access to the host's
      smartcard via NSS.  No other attributes or sub-elements are
      required.  See below about the use of an
      optional <code>&lt;address&gt;</code> sub-element.</dd>

      <dt><code>mode='host-certificates'</code></dt>
      <dd>Rather than requiring a smartcard to be plugged into the
      host, it is possible to provide three NSS certificate names
      residing in a database on the host.  These certificates can be
      generated via the command <code>certutil -d /etc/pki/nssdb -x -t
      CT,CT,CT -S -s CN=cert1 -n cert1</code>, and the resulting three
      certificate names must be supplied as the content of each of
      three <code>&lt;certificate&gt;</code> sub-elements.  An
      additional sub-element <code>&lt;database&gt;</code> can specify
      the absolute path to an alternate directory (matching
      the <code>-d</code> option of the <code>certutil</code> command
      when creating the certificates); if not present, it defaults to
      /etc/pki/nssdb.</dd>

      <dt><code>mode='passthrough'</code></dt>
      <dd>Rather than having the hypervisor directly communicate with
      the host, it is possible to tunnel all requests through a
      secondary character device to a third-party provider (which may
      in turn be talking to a smartcard or using three certificate
      files).  In this mode of operation, an additional
      attribute <code>type</code> is required, matching one of the
      supported <a href="#elementsConsole">serial device</a> types, to
E
Eric Blake 已提交
1298 1299 1300 1301 1302
      describe the host side of the tunnel; <code>type='tcp'</code>
      or <code>type='spicevmc'</code> (which uses the smartcard
      channel of a <a href="#elementsGraphics">SPICE graphics
      device</a>) are typical.  Further sub-elements, such
      as <code>&lt;source&gt;</code>, may be required according to the
1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
      given type, although a <code>&lt;target&gt;</code> sub-element
      is not required (since the consumer of the character device is
      the hypervisor itself, rather than a device visible in the
      guest).</dd>
    </dl>

    <p>
      Each mode supports an optional
      sub-element <code>&lt;address&gt;</code>, which fine-tunes the
      correlation between the smartcard and a ccid bus controller.
      If present, the element must have an attribute
      of <code>type='ccid'</code> as well as a <code>bus</code>
      attribute listing the index of the bus that the smartcard
      utilizes.  An optional <code>slot</code> attribute lists which
      slot within the bus.  For now, qemu only supports at most one
      smartcard, with an address of bus=0 slot=0.
    </p>

D
Daniel P. Berrange 已提交
1321 1322
    <h4><a name="elementsNICS">Network interfaces</a></h4>

1323 1324 1325 1326 1327 1328 1329
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='bridge'&gt;
      &lt;source bridge='xenbr0'/&gt;
      &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
      &lt;script path='vif-bridge'/&gt;
1330
      &lt;boot order='1'/&gt;
1331 1332 1333
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
1334

E
Eric Blake 已提交
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
    <p>
      There are several possibilities for specifying a network
      interface visible to the guest.  Each subsection below provides
      more details about common setup options.  Additionally,
      each <code>&lt;interface&gt;</code> element has an
      optional <code>&lt;address&gt;</code> sub-element that can tie
      the interface to a particular pci slot, with
      attribute <code>type='pci'</code> and additional
      attributes <code>domain</code>, <code>bus</code>, <code>slot</code>,
      and <code>function</code> as appropriate.
    </p>

D
Daniel P. Berrange 已提交
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364
    <h5><a name="elementsNICSVirtual">Virtual network</a></h5>

    <p>
      <strong><em>
      This is the recommended config for general guest connectivity on
      hosts with dynamic / wireless networking configs
      </em></strong>
    </p>

    <p>
      Provides a virtual network using a bridge device in the host.
      Depending on the virtual network configuration, the network may be
      totally isolated, NAT'ing to an explicit network device, or NAT'ing to
      the default route. DHCP and DNS are provided on the virtual network in
      all cases and the IP range can be determined by examining the virtual
      network config with '<code>virsh net-dumpxml [networkname]</code>'.
      There is one virtual network called 'default' setup out
      of the box which does NAT'ing to the default route and has an IP range of
1365
      <code>192.168.122.0/255.255.255.0</code>. Each guest will have an
D
Daniel P. Berrange 已提交
1366
      associated tun device created with a name of vnetN, which can also be
1367 1368
      overridden with the &lt;target&gt; element (see
      <a href="#elementsNICSTargetOverride">overriding the target element</a>).
D
Daniel P. Berrange 已提交
1369 1370
    </p>

1371 1372 1373 1374 1375 1376 1377 1378 1379 1380
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
    &lt;/interface&gt;
    ...
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet7'/&gt;
1381
      &lt;mac address="00:11:22:33:44:55"/&gt;
1382 1383 1384
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
1385

D
Dan Kenigsberg 已提交
1386
    <h5><a name="elementsNICSBridge">Bridge to LAN</a></h5>
D
Daniel P. Berrange 已提交
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399

    <p>
      <strong><em>
      This is the recommended config for general guest connectivity on
      hosts with static wired networking configs
      </em></strong>
    </p>

    <p>
      Provides a bridge from the VM directly onto the LAN. This assumes
      there is a bridge device on the host which has one or more of the hosts
      physical NICs enslaved. The guest VM will have an associated tun device
      created with a name of vnetN, which can also be overridden with the
1400 1401 1402 1403 1404
      &lt;target&gt; element (see
      <a href="#elementsNICSTargetOverride">overriding the target element</a>).
      The tun device will be enslaved to the bridge. The IP range / network
      configuration is whatever is used on the LAN. This provides the guest VM
      full incoming &amp; outgoing net access just like a physical machine.
D
Daniel P. Berrange 已提交
1405 1406
    </p>

1407 1408 1409 1410 1411 1412 1413 1414 1415 1416
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='bridge'&gt;
      &lt;source bridge='br0'/&gt;
    &lt;/interface&gt;
    ...
    &lt;interface type='bridge'&gt;
      &lt;source bridge='br0'/&gt;
      &lt;target dev='vnet7'/&gt;
1417
      &lt;mac address="00:11:22:33:44:55"/&gt;
1418 1419 1420
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432

    <h5><a name="elementsNICSSlirp">Userspace SLIRP stack</a></h5>

    <p>
      Provides a virtual LAN with NAT to the outside world. The virtual
      network has DHCP &amp; DNS services and will give the guest VM addresses
      starting from <code>10.0.2.15</code>. The default router will be
      <code>10.0.2.2</code> and the DNS server will be <code>10.0.2.3</code>.
      This networking is the only option for unprivileged users who need their
      VMs to have outgoing access.
    </p>

1433 1434 1435 1436 1437 1438
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='user'/&gt;
    ...
    &lt;interface type='user'&gt;
1439
      &lt;mac address="00:11:22:33:44:55"/&gt;
1440 1441 1442
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456


    <h5><a name="elementsNICSEthernet">Generic ethernet connection</a></h5>

    <p>
      Provides a means for the administrator to execute an arbitrary script
      to connect the guest's network to the LAN. The guest will have a tun
      device created with a name of vnetN, which can also be overridden with the
      &lt;target&gt; element. After creating the tun device a shell script will
      be run which is expected to do whatever host network integration is
      required. By default this script is called /etc/qemu-ifup but can be
      overridden.
    </p>

1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='ethernet'/&gt;
    ...
    &lt;interface type='ethernet'&gt;
      &lt;target dev='vnet7'/&gt;
      &lt;script path='/etc/qemu-ifup-mynet'/&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
1468

1469 1470 1471 1472
    <h5><a name="elementsNICSDirect">Direct attachment to physical interface</a></h5>

    <p>
      Provides direct attachment of the virtual machine's NIC to the given
1473
      physial interface of the host.
E
Eric Blake 已提交
1474
      <span class="since">Since 0.7.7 (QEMU and KVM only)</span><br/>
1475 1476 1477
      This setup requires the Linux macvtap
      driver to be available. <span class="since">(Since Linux 2.6.34.)</span>
      One of the modes 'vepa'
1478
      ( <a href="http://www.ieee802.org/1/files/public/docs2009/new-evb-congdon-vepa-modular-0709-v01.pdf">
1479
      'Virtual Ethernet Port Aggregator'</a>), 'bridge' or 'private'
1480
      can be chosen for the operation mode of the macvtap device, 'vepa'
1481 1482
      being the default mode. The individual modes cause the delivery of
      packets to behave as follows:
1483 1484
    </p>

1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495
    <dl>
      <dt><code>vepa</code></dt>
      <dd>All VMs' packets are sent to the external bridge. Packets
      whose destination is a VM on the same host as where the
      packet originates from are sent back to the host by the VEPA
      capable bridge (today's bridges are typically not VEPA capable).</dd>
      <dt><code>bridge</code></dt>
      <dd>Packets whose destination is on the same host as where they
      originate from are directly delivered to the target macvtap device.
      Both origin and destination devices need to be in bridge mode
      for direct delivery. If either one of them is in <code>vepa</code> mode,
E
Eric Blake 已提交
1496
      a VEPA capable bridge is required.</dd>
1497 1498 1499 1500 1501 1502
      <dt><code>private</code></dt>
      <dd>All packets are sent to the external bridge and will only be
      delivered to a target VM on the same host if they are sent through an
      external router or gateway and that device sends them back to the
      host. This procedure is followed if either the source or destination
      device is in <code>private</code> mode.</dd>
1503 1504 1505 1506 1507 1508 1509
      <dt><code>passthrough</code></dt>
      <dd>This feature attaches a virtual function of a SRIOV capable
      NIC directly to a VM without losing the migration capability.
      All packets are sent to the VF/IF of the configured network device.
      Depending on the capabilities of the device additional prerequisites or
      limitations may apply; for example, on Linux this requires
      kernel 2.6.38 or newer. <span class="since">Since 0.9.2</span></dd>
1510 1511
    </dl>

1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='direct'/&gt;
    ...
    &lt;interface type='direct'&gt;
      &lt;source dev='eth0' mode='vepa'/&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>

1523 1524 1525 1526
    <p>
      The network access of direct attached virtual machines can be
      managed by the hardware switch to which the physical interface
      of the host machine is connected to.
E
Eric Blake 已提交
1527
    </p>
1528 1529 1530 1531 1532 1533 1534 1535 1536
    <p>
      The interface can have additional parameters as shown below,
      if the switch is conforming to the IEEE 802.1Qbg standard.
      The parameters of the virtualport element are documented in more detail
      in the IEEE 802.1Qbg standard. The values are network specific and
      should be provided by the network administrator. In 802.1Qbg terms,
      the Virtual Station Interface (VSI) represents the virtual interface
      of a virtual machine.
    </p>
1537 1538 1539 1540
    <p>
      Please note that IEEE 802.1Qbg requires a non-zero value for the
      VLAN ID.
    </p>
1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
    <dl>
      <dt><code>managerid</code></dt>
      <dd>The VSI Manager ID identifies the database containing the VSI type
        and instance definitions. This is an integer value and the
        value 0 is reserved.</dd>
      <dt><code>typeid</code></dt>
      <dd>The VSI Type ID identifies a VSI type characterizing the network
        access. VSI types are typically managed by network administrator.
        This is an integer value.
      </dd>
      <dt><code>typeidversion</code></dt>
      <dd>The VSI Type Version allows multiple versions of a VSI Type.
        This is an integer value.
      </dd>
      <dt><code>instanceid</code></dt>
      <dd>The VSI Instance ID Identifier is generated when a VSI instance
        (i.e. a virtual interface of a virtual machine) is created.
        This is a globally unique identifier.
      </dd>
    </dl>
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='direct'/&gt;
    ...
    &lt;interface type='direct'&gt;
1567
      &lt;source dev='eth0.2' mode='vepa'/&gt;
1568 1569 1570 1571 1572 1573
      &lt;virtualport type="802.1Qbg"&gt;
        &lt;parameters managerid="11" typeid="1193047" typeidversion="2" instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"/&gt;
      &lt;/virtualport&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
1574

D
Daniel P. Berrange 已提交
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
    <h5><a name="elementsNICSMulticast">Multicast tunnel</a></h5>

    <p>
      A multicast group is setup to represent a virtual network. Any VMs
      whose network devices are in the same multicast group can talk to each
      other even across hosts. This mode is also available to unprivileged
      users. There is no default DNS or DHCP support and no outgoing network
      access. To provide outgoing network access, one of the VMs should have a
      2nd NIC which is connected to one of the first 4 network types and do the
      appropriate routing. The multicast protocol is compatible with that used
      by user mode linux guests too. The source address used must be from the
      multicast address block.
    </p>

1589 1590 1591 1592 1593 1594 1595 1596
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='mcast'&gt;
      &lt;source address='230.0.0.1' port='5558'/&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608

    <h5><a name="elementsNICSTCP">TCP tunnel</a></h5>

    <p>
      A TCP client/server architecture provides a virtual network. One VM
      provides the server end of the network, all other VMS are configured as
      clients. All network traffic is routed between the VMs via the server.
      This mode is also available to unprivileged users. There is no default
      DNS or DHCP support and no outgoing network access. To provide outgoing
      network access, one of the VMs should have a 2nd NIC which is connected
      to one of the first 4 network types and do the appropriate routing.</p>

1609 1610 1611 1612
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='server'&gt;
D
Daniel P. Berrange 已提交
1613
      &lt;source address='192.168.0.1' port='5558'/&gt;
1614 1615 1616 1617 1618 1619 1620
    &lt;/interface&gt;
    ...
    &lt;interface type='client'&gt;
    &lt;source address='192.168.0.1' port='5558'/&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
1621

1622 1623
    <h5><a name="elementsNICSModel">Setting the NIC model</a></h5>

1624 1625 1626 1627 1628 1629 1630 1631 1632 1633
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet1'/&gt;
      <b>&lt;model type='ne2k_pci'/&gt;</b>
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655

    <p>
      For hypervisors which support this, you can set the model of
      emulated network interface card.
    </p>

    <p>
      The values for <code>type</code> aren't defined specifically by
      libvirt, but by what the underlying hypervisor supports (if
      any).  For QEMU and KVM you can get a list of supported models
      with these commands:
    </p>

<pre>
qemu -net nic,model=? /dev/null
qemu-kvm -net nic,model=? /dev/null
</pre>

    <p>
      Typical values for QEMU and KVM include:
      ne2k_isa i82551 i82557b i82559er ne2k_pci pcnet rtl8139 e1000 virtio
    </p>
D
Daniel P. Berrange 已提交
1656

1657 1658 1659 1660 1661 1662 1663 1664 1665
    <h5><a name="elementsDriverBackendOptions">Setting NIC driver-specific options</a></h5>

<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet1'/&gt;
      &lt;model type='virtio'/&gt;
1666
      <b>&lt;driver name='vhost' txmode='iothread' ioeventfd='on'/&gt;</b>
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>

    <p>
      Some NICs may have tunable driver-specific options. These are
      set as attributes of the <code>driver</code> sub-element of the
      interface definition. Currently the following attributes are
      available for the <code>"virtio"</code> NIC driver:
    </p>

    <dl>
1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690
      <dt><code>name</code></dt>
      <dd>
        The optional <code>name</code> attribute forces which type of
        backend driver to use. The value can be either 'qemu' (a
        user-space backend) or 'vhost' (a kernel backend, which
        requires the vhost module to be provided by the kernel); an
        attempt to require the vhost driver without kernel support
        will be rejected.  If this attribute is not present, then the
        domain defaults to 'vhost' if present, but silently falls back
        to 'qemu' without error.
        <span class="since">Since 0.8.8 (QEMU and KVM only)</span>
      </dd>
1691 1692 1693 1694 1695
      <dt><code>txmode</code></dt>
      <dd>
        The <code>txmode</code> attribute specifies how to handle
        transmission of packets when the transmit buffer is full. The
        value can be either 'iothread' or 'timer'.
E
Eric Blake 已提交
1696
        <span class="since">Since 0.8.8 (QEMU and KVM only)</span><br/><br/>
1697 1698 1699 1700

        If set to 'iothread', packet tx is all done in an iothread in
        the bottom half of the driver (this option translates into
        adding "tx=bh" to the qemu commandline -device virtio-net-pci
E
Eric Blake 已提交
1701
        option).<br/><br/>
1702 1703 1704 1705

        If set to 'timer', tx work is done in qemu, and if there is
        more tx data than can be sent at the present time, a timer is
        set before qemu moves on to do other things; when the timer
E
Eric Blake 已提交
1706
        fires, another attempt is made to send more data.<br/><br/>
1707 1708 1709 1710 1711

        The resulting difference, according to the qemu developer who
        added the option is: "bh makes tx more asynchronous and reduces
        latency, but potentially causes more processor bandwidth
        contention since the cpu doing the tx isn't necessarily the
E
Eric Blake 已提交
1712
        cpu where the guest generated the packets."<br/><br/>
1713

1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729
        <b>In general you should leave this option alone, unless you
        are very certain you know what you are doing.</b>
      </dd>
      <dt><code>ioeventfd</code></dt>
      <dd>
        This optional attribute allows users to set
        <a href='https://patchwork.kernel.org/patch/43390/'>
        domain I/O asynchronous handling</a> for interface device.
        The default is left to the discretion of the hypervisor.
        Accepted values are "on" and "off". Enabling this allows
        qemu to execute VM while a separate thread handles I/O.
        Typically guests experiencing high system CPU utilization
        during I/O will benefit from this. On the other hand,
        on overloaded host it could increase guest I/O latency.
        <span class="since">Since 0.9.3 (QEMU and KVM only)</span><br/><br/>

1730 1731 1732 1733 1734
        <b>In general you should leave this option alone, unless you
        are very certain you know what you are doing.</b>
      </dd>
    </dl>

1735 1736
    <h5><a name="elementsNICSTargetOverride">Overriding the target element</a></h5>

1737 1738 1739 1740 1741 1742 1743 1744 1745
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      <b>&lt;target dev='vnet1'/&gt;</b>
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
1746 1747 1748 1749 1750 1751 1752 1753 1754 1755

    <p>
        If no target is specified, certain hypervisors will automatically
        generate a name for the created tun device. This name can be manually
        specifed, however the name <i>must not start with either 'vnet' or
        'vif'</i>, which are prefixes reserved by libvirt and certain
        hypervisors. Manually specified targets using these prefixes will be
        ignored.
    </p>

1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778
    <h5><a name="elementsNICSBoot">Specifying boot order</a></h5>

<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet1'/&gt;
      <b>&lt;boot order='1'/&gt;</b>
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>

    <p>
      For hypervisors which support this, you can set exact NIC which should
      be used for network boot. The <code>order</code> attribute determines
      the order in which devices will be tried during boot sequence. The
      per-device <code>boot</code> elements cannot be used together with
      general boot elements in
      <a href="#elementsOSBIOS">BIOS bootloader</a> section.
      <span class="since">Since 0.8.8</span>
    </p>

D
Daniel P. Berrange 已提交
1779 1780 1781 1782 1783 1784 1785 1786 1787
    <h4><a name="elementsInput">Input devices</a></h4>

    <p>
      Input devices allow interaction with the graphical framebuffer in the guest
      virtual machine. When enabling the framebuffer, an input device is automatically
      provided. It may be possible to add additional devices explicitly, for example,
      to provide a graphics tablet for absolute cursor movement.
    </p>

1788 1789 1790 1791 1792 1793
<pre>
  ...
  &lt;devices&gt;
    &lt;input type='mouse' bus='usb'/&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
1794 1795 1796

    <dl>
      <dt><code>input</code></dt>
A
Atsushi SAKAI 已提交
1797
      <dd>The <code>input</code> element has one mandatory attribute, the <code>type</code>
M
Matthew Booth 已提交
1798 1799 1800 1801
        whose value can be either 'mouse' or 'tablet'. The latter provides absolute
        cursor movement, while the former uses relative movement. The optional
        <code>bus</code> attribute can be used to refine the exact device type.
        It takes values "xen" (paravirtualized), "ps2" and "usb".</dd>
D
Daniel P. Berrange 已提交
1802 1803
    </dl>

E
Eric Blake 已提交
1804 1805 1806 1807 1808
    <p>
      The <code>input</code> element has an optional
      sub-element <code>&lt;address&gt;</code> which can tie the
      device to a particular PCI slot.
    </p>
D
Daniel P. Berrange 已提交
1809 1810 1811 1812 1813 1814 1815 1816 1817 1818

    <h4><a name="elementsGraphics">Graphical framebuffers</a></h4>

    <p>
      A graphics device allows for graphical interaction with the
      guest OS. A guest will typically have either a framebuffer
      or a text console configured to allow interaction with the
      admin.
    </p>

1819 1820 1821 1822 1823 1824 1825 1826 1827
<pre>
  ...
  &lt;devices&gt;
    &lt;graphics type='sdl' display=':0.0'/&gt;
    &lt;graphics type='vnc' port='5904'/&gt;
    &lt;graphics type='rdp' autoport='yes' multiUser='yes' /&gt;
    &lt;graphics type='desktop' fullscreen='yes'/&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
1828 1829 1830 1831

    <dl>
      <dt><code>graphics</code></dt>
      <dd>The <code>graphics</code> element has a mandatory <code>type</code>
1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849
  attribute which takes the value "sdl", "vnc", "rdp" or "desktop":
        <dl>
          <dt><code>"sdl"</code></dt>
          <dd>
  This displays a window on the host desktop, it can take 3 optional arguments:
  a <code>display</code> attribute for the display to use, an <code>xauth</code>
  attribute for the authentication identifier, and an optional <code>fullscreen</code>
  attribute accepting values 'yes' or 'no'.
          </dd>
          <dt><code>"vnc"</code></dt>
          <dd>
  Starts a VNC server. The <code>port</code> attribute specifies the TCP
  port number (with -1 as legacy syntax indicating that it should be
  auto-allocated). The <code>autoport</code> attribute is the new
  preferred syntax for indicating autoallocation of the TCP port to use.
  The <code>listen</code> attribute is an IP address for the server to
  listen on. The <code>passwd</code> attribute provides a VNC password
  in clear text. The <code>keymap</code> attribute specifies the keymap
1850 1851
  to use. It is possible to set a limit on the validity of the password
  be giving an timestamp <code>passwdValidTo='2010-04-09T15:51:00'</code>
E
Eric Blake 已提交
1852 1853
  assumed to be in UTC. NB, this may not be supported by all hypervisors.<br/>
  <br/>
1854 1855 1856
  Rather than using listen/port, QEMU supports a <code>socket</code>
  attribute for listening on a unix domain socket path.
  <span class="since">Since 0.8.8</span>
1857 1858 1859
          </dd>
          <dt><code>"spice"</code></dt>
          <dd>
E
Eric Blake 已提交
1860
            <p>
1861 1862 1863 1864 1865 1866 1867 1868
  Starts a SPICE server. The <code>port</code> attribute specifies the TCP
  port number (with -1 as legacy syntax indicating that it should be
  auto-allocated), while <code>tlsPort</code> gives an alternative
  secure port number. The <code>autoport</code> attribute is the new
  preferred syntax for indicating autoallocation of both port numbers.
  The <code>listen</code> attribute is an IP address for the server to
  listen on. The <code>passwd</code> attribute provides a SPICE password
  in clear text. The <code>keymap</code> attribute specifies the keymap
1869 1870 1871
  to use. It is possible to set a limit on the validity of the password
  be giving an timestamp <code>passwdValidTo='2010-04-09T15:51:00'</code>
  assumed to be in UTC. NB, this may not be supported by all hypervisors.
1872
  <span class="since">"spice" since 0.8.6</span>.
E
Eric Blake 已提交
1873 1874
            </p>
            <p>
1875 1876 1877 1878
  When SPICE has both a normal and TLS secured TCP port configured, it
  can be desirable to restrict what channels can be run on each port.
  This is achieved by adding one or more &lt;channel&gt; elements inside
  the main &lt;graphics&gt; element. Valid channel names include
E
Eric Blake 已提交
1879 1880 1881
  <code>main</code>, <code>display</code>, <code>inputs</code>,
  <code>cursor</code>, <code>playback</code>, <code>record</code>;
  and <span class="since">since 0.8.8</span>: <code>smartcard</code>.
E
Eric Blake 已提交
1882 1883
            </p>
            <pre>
1884 1885 1886
  &lt;graphics type='spice' port='-1' tlsPort='-1' autoport='yes'&gt;
    &lt;channel name='main' mode='secure'/&gt;
    &lt;channel name='record' mode='insecure'/&gt;
1887
    &lt;image compression='auto_glz'/&gt;
1888
    &lt;streaming mode='filter'/&gt;
1889
    &lt;clipboard copypaste='no'/&gt;
1890
  &lt;/graphics&gt;</pre>
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907
            <p>
              Spice supports variable compression settings for audio,
              images and streaming, <span class="since">since
              0.9.1</span>.  These settings are accessible via
              the <code>compression</code> attribute in all following
              elements: <code>image</code> to set image compression
              (accepts <code>auto_glz</code>, <code>auto_lz</code>,
              <code>quic</code>, <code>glz</code>, <code>lz</code>,
              <code>off</code>), <code>jpeg</code> for JPEG
              compression for images over wan
              (accepts <code>auto</code>, <code>never</code>,
              <code>always</code>), <code>zlib</code> for configuring
              wan image compression (accepts <code>auto</code>,
              <code>never</code>, <code>always</code>)
              and <code>playback</code> for enabling audio stream
              compression (accepts <code>on</code> or <code>off</code>).
            </p>
1908 1909 1910 1911 1912 1913
            <p>
              Streaming mode is set by the <code>streaming</code>
              element, settings it's <code>mode</code> attribute to one
              of <code>filter</code>, <code>all</code>
              or <code>off</code>, <span class="since">since 0.9.2</span>.
            </p>
1914 1915 1916 1917 1918 1919 1920 1921
            <p>
              Copy &amp; Paste functionality (via Spice agent) is set
              by the <code>clipboard</code> element. It is enabled by
              default, and can be disabled by setting
              the <code>copypaste</code> property
              to <code>no</code>, <span class="since">since
              0.9.3</span>.
            </>
1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951
          </dd>
          <dt><code>"rdp"</code></dt>
          <dd>
  Starts a RDP server. The <code>port</code> attribute
  specifies the TCP port number (with -1 as legacy syntax indicating
  that it should be auto-allocated). The <code>autoport</code> attribute
  is the new preferred syntax for indicating autoallocation of the TCP
  port to use. The <code>replaceUser</code> attribute is a boolean deciding
  whether multiple simultaneous connections to the VM are permitted.
  The <code>multiUser</code> whether the existing connection must be dropped
  and a new connection must be established by the VRDP server, when a new
  client connects in single connection mode.

          </dd>
          <dt><code>"desktop"</code></dt>
          <dd>
  This value is reserved for VirtualBox domains for the moment. It displays
  a window on the host desktop, similarly to "sdl", but using the VirtualBox
  viewer. Just like "sdl", it accepts the optional attributes <code>display</code>
  and <code>fullscreen</code>.
          </dd>
        </dl>
      </dd>
    </dl>

    <h4><a name="elementsVideo">Video devices</a></h4>
    <p>
      A video device.
    </p>

1952 1953 1954 1955 1956 1957 1958 1959 1960 1961
<pre>
  ...
  &lt;devices&gt;
    &lt;video&gt;
      &lt;model type='vga' vram='8192' heads='1'&gt;
        &lt;acceleration accel3d='yes' accel3d='yes'/&gt;
      &lt;/model&gt;
    &lt;/video&gt;
  &lt;/devices&gt;
  ...</pre>
1962 1963 1964

    <dl>
      <dt><code>video</code></dt>
1965 1966
      <dd>
        The <code>video</code> element is the a container for describing
O
Osier Yang 已提交
1967 1968 1969 1970 1971 1972
        video devices. For backwards compatability, if no <code>video</code>
        is set but there is a <code>graphics</code> in domain xml, then libvirt
        will add a default <code>video</code> according to the guest type.
        For a guest of type "kvm", the default <code>video</code> for it is:
        <code>type</code> with value "cirrus", <code>vram</code> with value
        "9216", and <code>heads</code> with value "1".
1973
      </dd>
1974

1975 1976 1977
      <dt><code>model</code></dt>
      <dd>
        The <code>model</code> element has a mandatory <code>type</code>
1978 1979 1980
        attribute which takes the value "vga", "cirrus", "vmvga", "xen",
        "vbox", or "qxl" (<span class="since">since 0.8.6</span>)
        depending on the hypervisor features available.
1981 1982 1983 1984 1985 1986 1987 1988 1989 1990
        You can also provide the amount of video memory in kilobytes using
        <code>vram</code> and the number of screen with <code>heads</code>.
      </dd>

      <dt><code>acceleration</code></dt>
      <dd>
        If acceleration should be enabled (if supported) using the
        <code>accel3d</code> and <code>accel2d</code> attributes in the
        <code>acceleration</code> element.
      </dd>
E
Eric Blake 已提交
1991 1992 1993 1994 1995 1996

      <dt><code>address</code></dt>
      <dd>
        The optional <code>address</code> sub-element can be used to
        tie the video device to a particular PCI slot.
      </dd>
D
Daniel P. Berrange 已提交
1997 1998
    </dl>

1999
    <h4><a name="elementsConsole">Consoles, serial, parallel &amp; channel devices</a></h4>
D
Daniel P. Berrange 已提交
2000 2001 2002

    <p>
      A character device provides a way to interact with the virtual machine.
2003 2004
      Paravirtualized consoles, serial ports, parallel ports and channels are
      all classed as character devices and so represented using the same syntax.
D
Daniel P. Berrange 已提交
2005 2006
    </p>

2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
<pre>
  ...
  &lt;devices&gt;
    &lt;parallel type='pty'&gt;
      &lt;source path='/dev/pts/2'/&gt;
      &lt;target port='0'/&gt;
    &lt;/parallel&gt;
    &lt;serial type='pty'&gt;
      &lt;source path='/dev/pts/3'/&gt;
      &lt;target port='0'/&gt;
    &lt;/serial&gt;
    &lt;console type='pty'&gt;
      &lt;source path='/dev/pts/4'/&gt;
      &lt;target port='0'/&gt;
    &lt;/console&gt;
    &lt;channel type='unix'&gt;
      &lt;source mode='bind' path='/tmp/guestfwd'/&gt;
      &lt;target type='guestfwd' address='10.0.2.1' port='4600'/&gt;
    &lt;/channel&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2028

2029 2030 2031 2032 2033
    <p>
      In each of these directives, the top-level element name (parallel, serial,
      console, channel) describes how the device is presented to the guest. The
      guest interface is configured by the <code>target</code> element.
    </p>
D
Daniel P. Berrange 已提交
2034

2035 2036 2037 2038 2039 2040
    <p>
      The interface presented to the host is given in the <code>type</code>
      attribute of the top-level element. The host interface is
      configured by the <code>source</code> element.
    </p>

E
Eric Blake 已提交
2041 2042 2043 2044 2045 2046 2047 2048
    <p>
      Each character device element has an optional
      sub-element <code>&lt;address&gt;</code> which can tie the
      device to a
      particular <a href="#elementsControllers">controller</a> or PCI
      slot.
    </p>

2049 2050 2051 2052 2053 2054 2055 2056 2057
    <h5><a name="elementsCharGuestInterface">Guest interface</a></h5>

    <p>
      A character device presents itself to the guest as one of the following
      types.
    </p>

    <h6><a name="elementCharParallel">Parallel port</a></h6>

2058 2059 2060 2061 2062 2063 2064 2065 2066
<pre>
  ...
  &lt;devices&gt;
    &lt;parallel type='pty'&gt;
      &lt;source path='/dev/pts/2'/&gt;
      &lt;target port='0'/&gt;
    &lt;/parallel&gt;
  &lt;/devices&gt;
  ...</pre>
2067 2068 2069

    <p>
      <code>target</code> can have a <code>port</code> attribute, which
2070
      specifies the port number. Ports are numbered starting from 0. There are
2071 2072 2073 2074 2075
      usually 0, 1 or 2 parallel ports.
    </p>

    <h6><a name="elementCharSerial">Serial port</a></h6>

2076 2077 2078 2079 2080 2081 2082 2083 2084
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type='pty'&gt;
      &lt;source path='/dev/pts/3'/&gt;
      &lt;target port='0'/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
2085 2086 2087

    <p>
      <code>target</code> can have a <code>port</code> attribute, which
2088
      specifies the port number. Ports are numbered starting from 0. There are
2089 2090 2091 2092 2093 2094 2095
      usually 0, 1 or 2 serial ports.
    </p>

    <h6><a name="elementCharConsole">Console</a></h6>

    <p>
      This represents the primary console. This can be the paravirtualized
C
Cole Robinson 已提交
2096 2097 2098 2099 2100 2101 2102 2103 2104 2105
      console with Xen guests, virtio console for QEMU/KVM, or duplicates
      the primary serial port for fully virtualized guests without a
      paravirtualized console.
    </p>

    <p>
      A virtio console device is exposed in the
      guest as /dev/hvc[0-7] (for more information, see
      <a href="http://fedoraproject.org/wiki/Features/VirtioSerial">http://fedoraproject.org/wiki/Features/VirtioSerial</a>)
      <span class="since">Since 0.8.3</span>
2106 2107
    </p>

2108 2109 2110 2111 2112 2113 2114
<pre>
  ...
  &lt;devices&gt;
    &lt;console type='pty'&gt;
      &lt;source path='/dev/pts/4'/&gt;
      &lt;target port='0'/&gt;
    &lt;/console&gt;
C
Cole Robinson 已提交
2115 2116 2117 2118 2119 2120

    &lt;!-- KVM virtio console --&gt;
    &lt;console type='pty'&gt;
      &lt;source path='/dev/pts/5'/&gt;
      &lt;target type='virtio' port='0'/&gt;
    &lt;/console&gt;
2121 2122
  &lt;/devices&gt;
  ...</pre>
2123 2124 2125 2126 2127 2128 2129

    <p>
      If the console is presented as a serial port, the <code>target</code>
      element has the same attributes as for a serial port. There is usually
      only 1 console.
    </p>

2130 2131 2132 2133 2134 2135 2136
    <h6><a name="elementCharChannel">Channel</a></h6>

    <p>
      This represents a private communication channel between the host and the
      guest.
    </p>

2137 2138 2139 2140 2141 2142 2143
<pre>
  ...
  &lt;devices&gt;
    &lt;channel type='unix'&gt;
      &lt;source mode='bind' path='/tmp/guestfwd'/&gt;
      &lt;target type='guestfwd' address='10.0.2.1' port='4600'/&gt;
    &lt;/channel&gt;
2144 2145 2146 2147 2148

    &lt;!-- KVM virtio channel --&gt;
    &lt;channel type='pty'&gt;
      &lt;target type='virtio' name='arbitrary.virtio.serial.port.name'/&gt;
    &lt;/channel&gt;
2149 2150 2151
    &lt;channel type='spicevmc'&gt;
      &lt;target type='virtio' name='com.redhat.spice.0'/&gt;
    &lt;/channel&gt;
2152 2153
  &lt;/devices&gt;
  ...</pre>
2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167

    <p>
      This can be implemented in a variety of ways. The specific type of
      channel is given in the <code>type</code> attribute of the
      <code>target</code> element. Different channel types have different
      <code>target</code> attributes.
    </p>

    <dl>
      <dt><code>guestfwd</code></dt>
      <dd>TCP traffic sent by the guest to a given IP address and port is
        forwarded to the channel device on the host. The <code>target</code>
        element must have <code>address</code> and <code>port</code> attributes.
        <span class="since">Since 0.7.3</span></dd>
2168 2169 2170

      <dt><code>virtio</code></dt>
      <dd>Paravirtualized virtio channel. Channel is exposed in the guest under
E
Eric Blake 已提交
2171
        /dev/vport*, and if the optional element <code>name</code> is specified,
2172
        /dev/virtio-ports/$name (for more info, please see
E
Eric Blake 已提交
2173 2174 2175
        <a href="http://fedoraproject.org/wiki/Features/VirtioSerial">http://fedoraproject.org/wiki/Features/VirtioSerial</a>). The
        optional element <code>address</code> can tie the channel to a
        particular <code>type='virtio-serial'</code> controller.
2176
        <span class="since">Since 0.7.7</span></dd>
2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190

      <dt><code>spicevmc</code></dt>
      <dd>Paravirtualized SPICE channel. The domain must also have a
        SPICE server as a <a href="#elementsGraphics">graphics
        device</a>, at which point the host piggy-backs messages
        across the <code>main</code> channel.  The <code>target</code>
        element must be present, with
        attribute <code>type='virtio'</code>; an optional
        attribute <code>name</code> controls how the guest will have
        access to the channel, and defaults
        to <code>name='com.redhat.spice.0'</code>.  The
        optional <code>address</code> element can tie the channel to a
        particular <code>type='virtio-serial'</code> controller.
        <span class="since">Since 0.8.8</span></dd>
2191 2192
    </dl>

2193 2194 2195 2196 2197 2198
    <h5><a name="elementsCharHostInterface">Host interface</a></h5>

    <p>
      A character device presents itself to the host as one of the following
      types.
    </p>
D
Daniel P. Berrange 已提交
2199

2200
    <h6><a name="elementsCharSTDIO">Domain logfile</a></h6>
D
Daniel P. Berrange 已提交
2201 2202 2203 2204 2205 2206

    <p>
      This disables all input on the character device, and sends output
      into the virtual machine's logfile
    </p>

2207 2208 2209 2210 2211 2212 2213 2214
<pre>
  ...
  &lt;devices&gt;
    &lt;console type='stdio'&gt;
      &lt;target port='1'&gt;
    &lt;/console&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2215 2216


2217
    <h6><a name="elementsCharFle">Device logfile</a></h6>
D
Daniel P. Berrange 已提交
2218 2219 2220 2221 2222 2223

    <p>
      A file is opened and all data sent to the character
      device is written to the file.
    </p>

2224 2225 2226 2227 2228 2229 2230 2231 2232
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="file"&gt;
      &lt;source path="/var/log/vm/vm-serial.log"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2233

2234
    <h6><a name="elementsCharVC">Virtual console</a></h6>
D
Daniel P. Berrange 已提交
2235 2236 2237 2238 2239 2240 2241

    <p>
      Connects the character device to the graphical framebuffer in
      a virtual console. This is typically accessed via a special
      hotkey sequence such as "ctrl+alt+3"
    </p>

2242 2243 2244 2245 2246 2247 2248 2249
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type='vc'&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2250

2251
    <h6><a name="elementsCharNull">Null device</a></h6>
D
Daniel P. Berrange 已提交
2252 2253 2254 2255 2256 2257

    <p>
      Connects the character device to the void. No data is ever
      provided to the input. All data written is discarded.
    </p>

2258 2259 2260 2261 2262 2263 2264 2265
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type='null'&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2266

2267
    <h6><a name="elementsCharPTY">Pseudo TTY</a></h6>
D
Daniel P. Berrange 已提交
2268 2269 2270 2271 2272 2273 2274

    <p>
      A Pseudo TTY is allocated using /dev/ptmx. A suitable client
      such as 'virsh console' can connect to interact with the
      serial port locally.
    </p>

2275 2276 2277 2278 2279 2280 2281 2282 2283
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="pty"&gt;
      &lt;source path="/dev/pts/3"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2284 2285 2286

    <p>
      NB special case if &lt;console type='pty'&gt;, then the TTY
A
Atsushi SAKAI 已提交
2287
      path is also duplicated as an attribute tty='/dev/pts/3'
D
Daniel P. Berrange 已提交
2288 2289 2290 2291
      on the top level &lt;console&gt; tag. This provides compat
      with existing syntax for &lt;console&gt; tags.
    </p>

2292
    <h6><a name="elementsCharHost">Host device proxy</a></h6>
D
Daniel P. Berrange 已提交
2293 2294 2295 2296 2297

    <p>
      The character device is passed through to the underlying
      physical character device. The device types must match,
      eg the emulated serial port should only be connected to
A
Atsushi SAKAI 已提交
2298
      a host serial port - don't connect a serial port to a parallel
D
Daniel P. Berrange 已提交
2299 2300 2301
      port.
    </p>

2302 2303 2304 2305 2306 2307 2308 2309 2310
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="dev"&gt;
      &lt;source path="/dev/ttyS0"/&gt;
      &lt;target port="1"/&gt;
  &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2311

2312
    <h6><a name="elementsCharPipe">Named pipe</a></h6>
2313 2314 2315 2316 2317 2318

    <p>
      The character device writes output to a named pipe. See pipe(7) for
      more info.
    </p>

2319 2320 2321 2322 2323 2324 2325 2326 2327
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="pipe"&gt;
      &lt;source path="/tmp/mypipe"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
2328

2329
    <h6><a name="elementsCharTCP">TCP client/server</a></h6>
D
Daniel P. Berrange 已提交
2330 2331 2332

    <p>
      The character device acts as a TCP client connecting to a
2333
      remote server.
D
Daniel P. Berrange 已提交
2334 2335
    </p>

2336 2337 2338 2339 2340 2341 2342 2343 2344 2345
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="tcp"&gt;
      &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
      &lt;protocol type="raw"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
   ...</pre>
2346 2347 2348 2349 2350

    <p>
      Or as a TCP server waiting for a client connection.
    </p>

2351 2352 2353 2354 2355 2356 2357 2358 2359 2360
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="tcp"&gt;
      &lt;source mode="bind" host="127.0.0.1" service="2445"/&gt;
      &lt;protocol type="raw"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
2361 2362

    <p>
2363 2364 2365
      Alternatively you can use <code>telnet</code> instead of <code>raw</code> TCP.
      <span class="since">Since 0.8.5</span> you can also use <code>telnets</code>
      (secure telnet) and <code>tls</code>.
E
Eric Blake 已提交
2366
    </p>
2367

2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="tcp"&gt;
      &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
      &lt;protocol type="telnet"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
    ...
    &lt;serial type="tcp"&gt;
      &lt;source mode="bind" host="127.0.0.1" service="2445"/&gt;
      &lt;protocol type="telnet"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2384

2385
    <h6><a name="elementsCharUDP">UDP network console</a></h6>
D
Daniel P. Berrange 已提交
2386 2387 2388 2389 2390 2391

    <p>
      The character device acts as a UDP netconsole service,
      sending and receiving packets. This is a lossy service.
    </p>

2392 2393 2394 2395 2396 2397 2398 2399 2400 2401
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="udp"&gt;
      &lt;source mode="bind" host="0.0.0.0" service="2445"/&gt;
      &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2402

2403
    <h6><a name="elementsCharUNIX">UNIX domain socket client/server</a></h6>
D
Daniel P. Berrange 已提交
2404 2405 2406 2407 2408 2409

    <p>
      The character device acts as a UNIX domain socket server,
      accepting connections from local clients.
    </p>

2410 2411 2412 2413 2414 2415 2416 2417 2418
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="unix"&gt;
      &lt;source mode="bind" path="/tmp/foo"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2419

2420 2421 2422 2423 2424 2425 2426 2427

    <h4><a name="elementsSound">Sound devices</a></h4>

    <p>
      A virtual sound card can be attached to the host via the
      <code>sound</code> element. <span class="since">Since 0.4.3</span>
    </p>

2428 2429 2430 2431 2432 2433
<pre>
  ...
  &lt;devices&gt;
    &lt;sound model='es1370'/&gt;
  &lt;/devices&gt;
  ...</pre>
2434 2435 2436 2437 2438 2439 2440

    <dl>
      <dt><code>sound</code></dt>
      <dd>
        The <code>sound</code> element has one mandatory attribute,
        <code>model</code>, which specifies what real sound device is emulated.
        Valid values are specific to the underlying hypervisor, though typical
2441 2442 2443
        choices are 'es1370', 'sb16', 'ac97', and 'ich6'
        (<span class="since">
         'ac97' only since 0.6.0, 'ich6' only since 0.8.8</span>)
2444 2445 2446
      </dd>
    </dl>

E
Eric Blake 已提交
2447 2448 2449 2450 2451 2452
    <p>
      Each <code>sound</code> element has an optional
      sub-element <code>&lt;address&gt;</code> which can tie the
      device to a particular PCI slot.
    </p>

R
Richard Jones 已提交
2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472
    <h4><a name="elementsWatchdog">Watchdog device</a></h4>

    <p>
      A virtual hardware watchdog device can be added to the guest via
      the <code>watchdog</code> element.
      <span class="since">Since 0.7.3, QEMU and KVM only</span>
    </p>

    <p>
      The watchdog device requires an additional driver and management
      daemon in the guest.  Just enabling the watchdog in the libvirt
      configuration does not do anything useful on its own.
    </p>

    <p>
      Currently libvirt does not support notification when the
      watchdog fires.  This feature is planned for a future version of
      libvirt.
    </p>

2473 2474 2475 2476 2477 2478
<pre>
  ...
  &lt;devices&gt;
    &lt;watchdog model='i6300esb'/&gt;
  &lt;/devices&gt;
  ...</pre>
R
Richard Jones 已提交
2479

2480 2481 2482 2483 2484 2485
<pre>
  ...
  &lt;devices&gt;
    &lt;watchdog model='i6300esb' action='poweroff'/&gt;
  &lt;/devices&gt;
&lt;/domain&gt;</pre>
R
Richard Jones 已提交
2486 2487 2488 2489

    <dl>
      <dt><code>model</code></dt>
      <dd>
M
Matthew Booth 已提交
2490
        <p>
R
Richard Jones 已提交
2491
        The required <code>model</code> attribute specifies what real
M
Matthew Booth 已提交
2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502
        watchdog device is emulated.  Valid values are specific to the
        underlying hypervisor.
        </p>
        <p>
        QEMU and KVM support:
        </p>
        <ul>
          <li> 'i6300esb' &mdash; the recommended device,
            emulating a PCI Intel 6300ESB </li>
          <li> 'ib700' &mdash; emulating an ISA iBase IB700 </li>
        </ul>
R
Richard Jones 已提交
2503 2504 2505
      </dd>
      <dt><code>action</code></dt>
      <dd>
M
Matthew Booth 已提交
2506
        <p>
R
Richard Jones 已提交
2507
        The optional <code>action</code> attribute describes what
M
Matthew Booth 已提交
2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520
        action to take when the watchdog expires.  Valid values are
        specific to the underlying hypervisor.
        </p>
        <p>
        QEMU and KVM support:
        </p>
        <ul>
          <li>'reset' &mdash; default, forcefully reset the guest</li>
          <li>'shutdown' &mdash; gracefully shutdown the guest
            (not recommended) </li>
          <li>'poweroff' &mdash; forcefully power off the guest</li>
          <li>'pause' &mdash; pause the guest</li>
          <li>'none' &mdash; do nothing</li>
2521 2522
          <li>'dump' &mdash; automatically dump the guest
            <span class="since">Since 0.8.7</span></li>
M
Matthew Booth 已提交
2523 2524
        </ul>
        <p>
2525
        Note 1: the 'shutdown' action requires that the guest
M
Matthew Booth 已提交
2526 2527 2528 2529 2530
        is responsive to ACPI signals.  In the sort of situations
        where the watchdog has expired, guests are usually unable
        to respond to ACPI signals.  Therefore using 'shutdown'
        is not recommended.
        </p>
2531 2532 2533 2534
        <p>
        Note 2: the directory to save dump files can be configured
        by <code>auto_dump_path</code> in file /etc/libvirt/qemu.conf.
        </p>
R
Richard Jones 已提交
2535 2536 2537
      </dd>
    </dl>

2538 2539 2540 2541 2542 2543 2544 2545 2546
    <h4><a name="elementsMemBalloon">Memory balloon device</a></h4>

    <p>
      A virtual memory balloon device is added to all Xen and KVM/QEMU
      guests. It will be seen as <code>memballoon</code> element.
      It will be automatically added when appropriate, so there is no
      need to explicitly add this element in the guest XML unless a
      specific PCI slot needs to be assigned.
      <span class="since">Since 0.8.3, Xen, QEMU and KVM only</span>
2547 2548 2549
      Additionally, <span class="since">since 0.8.4</span>, if the
      memballoon device needs to be explicitly disabled,
      <code>model='none'</code> may be used.
2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577
    </p>

    <p>
      Example automatically added device with KVM
    </p>
<pre>
  ...
  &lt;devices&gt;
    &lt;memballoon model='virtio'/&gt;
  &lt;/devices&gt;
  ...</pre>

    <p>
      Example manually added device with static PCI slot 2 requested
    </p>
<pre>
  ...
  &lt;devices&gt;
    &lt;watchdog model='virtio'/&gt;
    &lt;address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x0'/&gt;
  &lt;/devices&gt;
&lt;/domain&gt;</pre>

    <dl>
      <dt><code>model</code></dt>
      <dd>
        <p>
          The required <code>model</code> attribute specifies what type
E
Eric Blake 已提交
2578 2579
          of balloon device is provided. Valid values are specific to
          the virtualization platform
2580 2581 2582 2583 2584 2585 2586 2587
        </p>
        <ul>
          <li>'virtio' &mdash; default with QEMU/KVM</li>
          <li>'xen' &mdash; default with Xen</li>
        </ul>
      </dd>
    </dl>

D
Daniel P. Berrange 已提交
2588
    <h2><a name="examples">Example configs</a></h2>
2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600

    <p>
      Example configurations for each driver are provide on the
      driver specific pages listed below
    </p>

    <ul>
      <li><a href="drvxen.html#xmlconfig">Xen examples</a></li>
      <li><a href="drvqemu.html#xmlconfig">QEMU/KVM examples</a></li>
    </ul>
  </body>
</html>