formatdomain.html.in 150.5 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;title&gt;A short description - title - of the domain&lt;/title&gt;
36
  &lt;description&gt;Some human readable description&lt;/description&gt;
37 38 39 40
  &lt;metadata&gt;
    &lt;app1:foo xmlns:app1="http://app1.org/app1/"&gt;..&lt;/app1:foo&gt;
    &lt;app2:bar xmlns:app2="http://app1.org/app2/"&gt;..&lt;/app2:bar&gt;
  &lt;/metadata&gt;
41
  ...</pre>
D
Daniel P. Berrange 已提交
42 43 44 45

    <dl>
      <dt><code>name</code></dt>
      <dd>The content of the <code>name</code> element provides
M
Matthew Booth 已提交
46 47 48 49 50
        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 已提交
51 52
      <dt><code>uuid</code></dt>
      <dd>The content of the <code>uuid</code> element provides
M
Matthew Booth 已提交
53
        a globally unique identifier for the virtual machine.
E
Eric Blake 已提交
54 55
        The format must be RFC 4122 compliant,
        eg <code>3e3fce45-4f53-4fa7-bb32-11f34168b82b</code>.
M
Matthew Booth 已提交
56
        If omitted when defining/creating a new machine, a random
57 58 59 60
        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>
61

62 63 64 65 66
      <dt><code>title</code></dt>
      <dd>The optional element <code>title</code> provides space for a
        short description of the domain. The title should not contain
        any newlines. <span class="since">Since 0.9.10</span>.</dd>

67 68
      <dt><code>description</code></dt>
      <dd>The content of the <code>description</code> element provides a
69 70 71 72 73 74 75 76 77 78 79 80
        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>

      <dt><code>metadata</code></dt>
      <dd>The <code>metadata</code> node can be used by applications
        to store custom metadata in the form of XML
        nodes/trees. Applications must use custom namespaces on their
        XML nodes/trees, with only one top-level element per namespace
        (if the application needs structure, they should have
        sub-elements to their namespace
        element). <span class="since">Since 0.9.10</span></dd>
81
   </dl>
D
Daniel P. Berrange 已提交
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98

    <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>

99 100 101 102 103 104
<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;
105 106
    &lt;boot dev='cdrom'/&gt;
    &lt;bootmenu enable='yes'/&gt;
107
    &lt;smbios mode='sysinfo'/&gt;
M
Michal Privoznik 已提交
108
    &lt;bios useserial='yes'/&gt;
109 110
  &lt;/os&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
111 112 113 114

    <dl>
      <dt><code>type</code></dt>
      <dd>The content of the <code>type</code> element specifies the
M
Matthew Booth 已提交
115 116 117 118 119
        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>
E
Eric Blake 已提交
120 121 122 123 124
        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 已提交
125 126
      <dt><code>loader</code></dt>
      <dd>The optional <code>loader</code> tag refers to a firmware blob
M
Matthew Booth 已提交
127
        used to assist the domain creation process. At this time, it is
E
Eric Blake 已提交
128 129
        only needed by Xen fully virtualized
        domains. <span class="since">Since 0.1.0</span></dd>
D
Daniel P. Berrange 已提交
130 131
      <dt><code>boot</code></dt>
      <dd>The <code>dev</code> attribute takes one of the values "fd", "hd",
M
Matthew Booth 已提交
132 133
        "cdrom" or "network" and is used to specify the next boot device
        to consider. The <code>boot</code> element can be repeated multiple
134 135 136 137 138 139 140 141 142 143 144 145
        times to setup a priority list of boot devices to try in turn.
        Multiple devices of the same type are sorted according to their
        targets while preserving the order of buses. After defining the
        domain, its XML configuration returned by libvirt (through
        virDomainGetXMLDesc) lists devices in the sorted order. Once sorted,
        the first device is marked as bootable. Thus, e.g., a domain
        configured to boot from "hd" with vdb, hda, vda, and hdc disks
        assigned to it will boot from vda (the sorted list is vda, vdb, hda,
        hdc). Similar domain with hdc, vda, vdb, and hda disks will boot from
        hda (sorted disks are: hda, hdc, vda, vdb). It can be tricky to
        configure in the desired way, which is why per-device boot elements
        (see <a href="#elementsDisks">disks</a>,
146
        <a href="#elementsNICS">network interfaces</a>, and
147 148 149 150 151
        <a href="#elementsUSB">USB and PCI devices</a> sections below) were
        introduced and they are the preferred way providing full control over
        booting order. The <code>boot</code> element and per-device boot
        elements are mutually exclusive. <span class="since">Since 0.1.3,
        per-device boot since 0.8.8</span>
D
Daniel P. Berrange 已提交
152
      </dd>
153 154 155 156 157 158
      <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>
159 160 161 162 163
      <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 已提交
164 165 166 167
      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
168 169 170 171
      the <a href="#elementsSysinfo">sysinfo</a> element).  If not
      specified, the hypervisor default is used. <span class="since">
      Since 0.8.7</span>
      </dd>
M
Michal Privoznik 已提交
172 173 174 175 176 177 178 179
      <dt><code>bios</code></dt>
      <dd>This element has attribute <code>useserial</code> with possible
        values <code>yes</code> or <code>no</code>. It enables or disables
        Serial Graphics Adapter which allows users to see BIOS messages
        on a serial port. Therefore, one needs to have
        <a href="#elementCharSerial">serial port</a> defined.
        <span class="since">Since 0.9.4</span>
      </dd>
D
Daniel P. Berrange 已提交
180 181 182 183 184 185 186
    </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 已提交
187
      operating system boot. This may use a pseudo-bootloader in the
D
Daniel P. Berrange 已提交
188 189 190 191
      host to provide an interface to choose a kernel for the guest.
      An example is <code>pygrub</code> with Xen.
    </p>

192 193 194 195 196
<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 已提交
197 198 199 200

    <dl>
      <dt><code>bootloader</code></dt>
      <dd>The content of the <code>bootloader</code> element provides
M
Matthew Booth 已提交
201 202 203 204
        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 已提交
205 206
      <dt><code>bootloader_args</code></dt>
      <dd>The optional <code>bootloader_args</code> element allows
M
Matthew Booth 已提交
207 208 209
        command line arguments to be passed to the bootloader.
        <span class="since">Since 0.2.3</span>
        </dd>
D
Daniel P. Berrange 已提交
210 211 212 213 214 215 216 217 218 219 220 221

    </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>

222 223 224 225 226 227 228 229 230 231
<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 已提交
232 233 234 235

    <dl>
      <dt><code>type</code></dt>
      <dd>This element has the same semantics as described earlier in the
M
Matthew Booth 已提交
236
        <a href="#elementsOSBIOS">BIOS boot section</a></dd>
D
Daniel Veillard 已提交
237
      <dt><code>loader</code></dt>
D
Daniel P. Berrange 已提交
238
      <dd>This element has the same semantics as described earlier in the
M
Matthew Booth 已提交
239
        <a href="#elementsOSBIOS">BIOS boot section</a></dd>
D
Daniel P. Berrange 已提交
240 241
      <dt><code>kernel</code></dt>
      <dd>The contents of this element specify the fully-qualified path
M
Matthew Booth 已提交
242
        to the kernel image in the host OS.</dd>
D
Daniel P. Berrange 已提交
243 244
      <dt><code>initrd</code></dt>
      <dd>The contents of this element specify the fully-qualified path
M
Matthew Booth 已提交
245
        to the (optional) ramdisk image in the host OS.</dd>
D
Daniel P. Berrange 已提交
246 247
      <dt><code>cmdline</code></dt>
      <dd>The contents of this element specify arguments to be passed to
M
Matthew Booth 已提交
248 249 250
        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 已提交
251 252
    </dl>

253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
    <h4><a name="eleemntsOSContainer">Container boot</a></h4>

    <p>
      When booting a domain using container based virtualization, instead
      of a kernel / boot image, a path to the init binary is required, using
      the <code>init</code> element. By default this will be launched with
      no arguments. To specify the initial argv, use the <code>initarg</code>
      element, repeated as many time as is required. The <code>cmdline</code>
      element, if set will be used to provide an equivalent to <code>/proc/cmdline</code>
      but will not effect init argv.
    </p>

    <pre>
  &lt;os&gt;
    &lt;type arch='x86_64'&gt;exe&lt;/type&gt;
    &lt;init&gt;/bin/systemd&lt;/init&gt;
    &lt;initarg&gt;--unit&lt;/initarg&gt;
    &lt;initarg&gt;emergency.service&lt;/initarg&gt;
  &lt;/os&gt;
    </pre>


275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
    <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>

338
    <h3><a name="elementsCPUAllocation">CPU Allocation</a></h3>
D
Daniel P. Berrange 已提交
339

340
<pre>
341
&lt;domain&gt;
342
  ...
O
Osier Yang 已提交
343
  &lt;vcpu placement='static' cpuset="1-4,^3,6" current="1"&gt;2&lt;/vcpu&gt;
344 345 346
  ...
&lt;/domain&gt;
</pre>
D
Daniel P. Berrange 已提交
347 348 349

    <dl>
      <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
        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
O
Osier Yang 已提交
361 362 363 364 365 366 367 368 369 370 371 372
        virtual CPUs should be enabled.  <span class="since">Since
        0.9.11 (QEMU and KVM only), the optional attribute
        <code>placement</code> can be used to indicate the CPU placement
        mode for domain process, its value can be either "static" or
        "auto", defaults to "static" if <code>cpuset</code> is specified,
        "auto" indicates the domain process will be pinned to the advisory
        nodeset from querying numad, and the value of attribute
        <code>cpuset</code> will be overridden by the advisory nodeset
        from numad if it's specified. If both <code>cpuset</code> and
        <code>placement</code> are not specified, or if <code>placement</code>
        is "static", but no <code>cpuset</code> is specified, the domain
        process will be pinned to all the available physical CPUs.
E
Eric Blake 已提交
373
      </dd>
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
    </dl>


    <h3><a name="elementsCPUTuning">CPU Tuning</a></h3>

<pre>
&lt;domain&gt;
  ...
  &lt;cputune&gt;
    &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;
    &lt;shares&gt;2048&lt;/shares&gt;
    &lt;period&gt;1000000&lt;/period&gt;
    &lt;quota&gt;-1&lt;/quota&gt;
  &lt;/cputune&gt;
  ...
&lt;/domain&gt;
</pre>

    <dl>
396
      <dt><code>cputune</code></dt>
397 398 399 400 401
      <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>
402
      <dt><code>vcpupin</code></dt>
403 404
      <dd>
        The optional <code>vcpupin</code> element specifies which of host
405 406
        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
407
        required attributes, the attribute <code>vcpu</code> specifies vcpu id,
E
Eric Blake 已提交
408 409
        and the attribute <code>cpuset</code> is same as
        attribute <code>cpuset</code>
410 411 412
        of element <code>vcpu</code>. (NB: Only qemu driver support)
        <span class="since">Since 0.9.0</span>
       </dd>
413
      <dt><code>shares</code></dt>
414 415
      <dd>
        The optional <code>shares</code> element specifies the proportional
416
        weighted share for the domain. If this is ommited, it defaults to
E
Eric Blake 已提交
417 418 419
        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
420 421 422
        2048 will get twice as much CPU time as a VM configured with value 1024.
        <span class="since">Since 0.9.0</span>
      </dd>
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
      <dt><code>period</code></dt>
      <dd>
        The optional <code>period</code> element specifies the enforcement
        interval(unit: microseconds). Within <code>period</code>, each vcpu of
        the domain will not be allowed to consume more than <code>quota</code>
        worth of runtime. The value should be in range [1000, 1000000]. A period
        with value 0 means no value. (NB: Only qemu driver support)
        <span class="since">Since 0.9.4</span>
      </dd>
      <dt><code>quota</code></dt>
      <dd>
        The optional <code>quota</code> element specifies the maximum allowed
        bandwidth(unit: microseconds). A domain with <code>quota</code> as any
        negative value indicates that the domain has infinite bandwidth, which
        means that it is not bandwidth controlled. The value should be in range
        [1000, 18446744073709551] or less than 0. A quota with value 0 means no
        value. You can use this feature to ensure that all vcpus run at the same
        speed. (NB: Only qemu driver support)
        <span class="since">Since 0.9.4</span>
      </dd>
443 444 445 446 447 448 449 450
    </dl>


    <h3><a name="elementsMemoryAllocation">Memory Allocation</a></h3>

<pre>
&lt;domain&gt;
  ...
E
Eric Blake 已提交
451 452
  &lt;memory unit='KiB'&gt;524288&lt;/memory&gt;
  &lt;currentMemory unit='KiB'&gt;524288&lt;/currentMemory&gt;
453 454 455 456 457 458 459
  ...
&lt;/domain&gt;
</pre>

    <dl>
      <dt><code>memory</code></dt>
      <dd>The maximum allocation of memory for the guest at boot time.
E
Eric Blake 已提交
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
        The units for this value are determined by the optional
        atttribute <code>unit</code>, which defaults to "KiB"
        (kibibytes, 2<sup>10</sup> or blocks of 1024 bytes).  Valid
        units are "b" or "bytes" for bytes, "KB" for kilobytes
        (10<sup>3</sup> or 1,000 bytes), "k" or "KiB" for kibibytes
        (1024 bytes), "MB" for megabytes (10<sup>6</sup> or 1,000,000
        bytes), "M" or "MiB" for mebibytes (2<sup>20</sup> or
        1,048,576 bytes), "GB" for gigabytes (10<sup>9</sup> or
        1,000,000,000 bytes), "G" or "GiB" for gibibytes
        (2<sup>30</sup> or 1,073,741,824 bytes), "TB" for terabytes
        (10<sup>12</sup> or 1,000,000,000,000 bytes), or "T" or "TiB"
        for tebibytes (2<sup>40</sup> or 1,099,511,627,776 bytes).
        However, the value will be rounded up to the nearest kibibyte
        by libvirt, and may be further rounded to the granularity
        supported by the hypervisor.  Some hypervisors also enforce a
        minimum, such as
        4000KiB. <span class='since'><code>unit</code> since
        0.9.11</span></dd>
478 479 480 481
      <dt><code>currentMemory</code></dt>
      <dd>The actual allocation of memory for the guest. This value can
        be less than the maximum allocation, to allow for ballooning
        up the guests memory on the fly. If this is omitted, it defaults
E
Eric Blake 已提交
482 483 484
        to the same value as the <code>memory</code> element.
        The <code>unit</code> attribute behaves the same as
        for <code>memory</code>.</dd>
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
    </dl>


    <h3><a name="elementsMemoryBacking">Memory Backing</a></h3>

<pre>
&lt;domain&gt;
  ...
  &lt;memoryBacking&gt;
    &lt;hugepages/&gt;
  &lt;/memoryBacking&gt;
  ...
&lt;/domain&gt;
</pre>

    <dl>
      <dt><code>memoryBacking</code></dt>
      <dd>The optional <code>memoryBacking</code> element, may have an
        <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>
    </dl>


    <h3><a name="elementsMemoryTuning">Memory Tuning</a></h3>

<pre>
&lt;domain&gt;
  ...
  &lt;memtune&gt;
E
Eric Blake 已提交
515 516 517 518
    &lt;hard_limit unit='G'&gt;1&lt;/hard_limit&gt;
    &lt;soft_limit unit='M'&gt;128&lt;/soft_limit&gt;
    &lt;swap_hard_limit unit='G'&gt;2&lt;/swap_hard_limit&gt;
    &lt;min_guarantee unit='bytes'&gt;67108864&lt;/min_guarantee&gt;
519 520 521 522 523 524 525 526 527 528 529 530 531
  &lt;/memtune&gt;
  ...
&lt;/domain&gt;
</pre>

    <dl>
      <dt><code>memtune</code></dt>
      <dd> The optional <code>memtune</code> element provides details
        regarding the memory tunable parameters for the domain. If this is
        omitted, it defaults to the OS provided defaults. For QEMU/KVM, the
        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
E
Eric Blake 已提交
532 533 534 535 536 537 538
        determine so one needs guess and try.  For each tunable, it
        is possible to designate which unit the number is in on
        input, using the same values as
        for <code>&lt;memory&gt;</code>.  For backwards
        compatibility, output is always in
        KiB.  <span class='since'><code>unit</code>
        since 0.9.11</span></dd>
539 540
      <dt><code>hard_limit</code></dt>
      <dd> The optional <code>hard_limit</code> element is the maximum memory
541
        the guest can use. The units for this value are kibibytes (i.e. blocks
542 543 544 545
        of 1024 bytes)</dd>
      <dt><code>soft_limit</code></dt>
      <dd> The optional <code>soft_limit</code> element is the memory limit to
        enforce during memory contention. The units for this value are
546
        kibibytes (i.e. blocks of 1024 bytes)</dd>
547 548 549
      <dt><code>swap_hard_limit</code></dt>
      <dd> The optional <code>swap_hard_limit</code> element is the maximum
        memory plus swap the guest can use. The units for this value are
550
        kibibytes (i.e. blocks of 1024 bytes). This has to be more than
551 552 553 554
        hard_limit value provided</dd>
      <dt><code>min_guarantee</code></dt>
      <dd> The optional <code>min_guarantee</code> element is the guaranteed
        minimum memory allocation for the guest. The units for this value are
555
        kibibytes (i.e. blocks of 1024 bytes)</dd>
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
    </dl>


    <h3><a name="elementsNUMATuning">NUMA Node Tuning</a></h3>

<pre>
&lt;domain&gt;
  ...
  &lt;numatune&gt;
    &lt;memory mode="strict" nodeset="1-4,^3"/&gt;
  &lt;/numatune&gt;
  ...
&lt;/domain&gt;
</pre>

    <dl>
572 573 574 575 576 577 578 579
      <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>
O
Osier Yang 已提交
580
        The optional <code>memory</code> element specifies how to allocate memory
581
        for the domain process on a NUMA host. It contains two attributes,
E
Eric Blake 已提交
582 583
        attribute <code>mode</code> is either 'interleave', 'strict',
        or 'preferred',
584 585 586 587
        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 已提交
588 589
    </dl>

590 591 592 593 594 595 596

    <h3><a name="elementsBlockTuning">Block I/O Tuning</a></h3>
<pre>
&lt;domain&gt;
  ...
  &lt;blkiotune&gt;
    &lt;weight&gt;800&lt;/weight&gt;
597 598 599 600 601 602 603 604
    &lt;device&gt;
      &lt;path&gt;/dev/sda&lt;/path&gt;
      &lt;weight&gt;1000&lt;/weight&gt;
    &lt;/device&gt;
    &lt;device&gt;
      &lt;path&gt;/dev/sdb&lt;/path&gt;
      &lt;weight&gt;500&lt;/weight&gt;
    &lt;/device&gt;
605 606 607 608 609 610 611 612 613
  &lt;/blkiotune&gt;
  ...
&lt;/domain&gt;
</pre>

    <dl>
      <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
614 615
        omitted, it defaults to the OS provided
        defaults. <span class="since">Since 0.8.8</span></dd>
616
      <dt><code>weight</code></dt>
617 618 619 620 621 622 623 624 625 626 627
      <dd> The optional <code>weight</code> element is the overall I/O
        weight of the guest. The value should be in the range [100,
        1000].</dd>
      <dt><code>device</code></dt>
      <dd>The domain may have multiple <code>device</code> elements
        that further tune the weights for each host block device in
        use by the domain.  Note that
        multiple <a href="#elementsDisks">guest disks</a> can share a
        single host block device, if they are backed by files within
        the same host file system, which is why this tuning parameter
        is at the global domain level rather than associated with each
L
Lei Li 已提交
628 629 630 631 632
        guest disk device (contrast this to
        the <a href="#elementsDisks"><code>&lt;iotune&gt;</code></a>
        element which can apply to an
        individual <code>&lt;disk&gt;</code>).
        Each <code>device</code> element has two
633 634 635 636
        mandatory sub-elements, <code>path</code> describing the
        absolute path of the device, and <code>weight</code> giving
        the relative weight of that device, in the range [100,
        1000].  <span class="since">Since 0.9.8</span></dd>
637 638 639
    </dl>


640 641 642 643 644 645 646 647
    <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>

648 649 650
<pre>
  ...
  &lt;cpu match='exact'&gt;
651
    &lt;model fallback='allow'&gt;core2duo&lt;/model&gt;
J
Jiri Denemark 已提交
652
    &lt;vendor&gt;Intel&lt;/vendor&gt;
653 654 655 656
    &lt;topology sockets='1' cores='2' threads='1'/&gt;
    &lt;feature policy='disable' name='lahf_lm'/&gt;
  &lt;/cpu&gt;
  ...</pre>
657

658 659 660 661 662 663 664 665 666 667 668
<pre>
  &lt;cpu mode='host-model'&gt;
    &lt;model fallback='forbid'/&gt;
    &lt;topology sockets='1' cores='2' threads='1'/&gt;
  &lt;/cpu&gt;
  ...</pre>

<pre>
  &lt;cpu mode='host-passthrough'/&gt;
  ...</pre>

669 670 671 672 673 674
    <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>

675 676 677 678 679 680
<pre>
  ...
  &lt;cpu&gt;
    &lt;topology sockets='1' cores='2' threads='1'/&gt;
  &lt;/cpu&gt;
  ...</pre>
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702

    <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>
703

E
Eric Blake 已提交
704 705
        <span class="since">Since 0.8.5</span> the <code>match</code>
        attribute can be omitted and will default to <code>exact</code>.
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 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754

        <span class="since">Since 0.9.10</span>, an optional <code>mode</code>
        attribute may be used to make it easier to configure a guest CPU to be
        as close to host CPU as possible. Possible values for the
        <code>mode</code> attribute are:

        <dl>
          <dt><code>custom</code></dt>
          <dd>In this mode, the <code>cpu</code> element describes the CPU
          that should be presented to the guest. This is the default when no
          <code>mode</code> attribute is specified. This mode makes it so that
          a persistent guest will see the same hardware no matter what host
          the guest is booted on.</dd>
          <dt><code>host-model</code></dt>
          <dd>The <code>host-model</code> mode is essentially a shortcut to
          copying host CPU definition from capabilities XML into domain XML.
          Since the CPU definition is copied just before starting a domain,
          exactly the same XML can be used on different hosts while still
          providing the best guest CPU each host supports. Neither
          <code>match</code> attribute nor any <code>feature</code> elements
          can be used in this mode. Specifying CPU model is not supported
          either, but <code>model</code>'s <code>fallback</code> attribute may
          still be used. Libvirt does not model every aspect of each CPU so
          the guest CPU will not match the host CPU exactly. On the other
          hand, the ABI provided to the guest is reproducible. During
          migration, complete CPU model definition is transferred to the
          destination host so the migrated guest will see exactly the same CPU
          model even if the destination host contains more capable CPUs for
          the running instance of the guest; but shutting down and restarting
          the guest may present different hardware to the guest according to
          the capabilities of the new host.</dd>
          <dt><code>host-passthrough</code></dt>
          <dd>With this mode, the CPU visible to the guest should be exactly
          the same as the host CPU even in the aspects that libvirt does not
          understand. Though the downside of this mode is that the guest
          environment cannot be reproduced on different hardware. Thus, if you
          hit any bugs, you are on your own. Neither <code>model</code> nor
          <code>feature</code> elements are allowed in this mode.</dd>
        </dl>

        In both <code>host-model</code> and <code>host-passthrough</code>
        mode, the real (approximate in <code>host-passthrough</code> mode) CPU
        definition which would be used on current host can be determined by
        specifying <code>VIR_DOMAIN_XML_UPDATE_CPU</code> flag when calling
        <code>virDomainGetXMLDesc</code> API. When running a guest that might
        be prone to operating system reactivation when presented with
        different hardware, and which will be migrated between hosts with
        different capabilities, you can use this output to rewrite XML to the
        <code>custom</code> mode for more robust migration.
755 756 757 758 759 760
      </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
761 762 763 764 765 766 767 768 769
        in libvirt's data directory. If a hypervisor is not able to use the
        exact CPU model, libvirt automatically falls back to a closest model
        supported by the hypervisor while maintaining the list of CPU
        features. <span class="since">Since 0.9.10</span>, an optional
        <code>fallback</code> attribute can be used to forbid this behavior,
        in which case an attempt to start a domain requesting an unsupported
        CPU model will fail. Supported values for <code>fallback</code>
        attribute are: <code>allow</code> (this is the default), and
        <code>forbid</code>.</dd>
770

J
Jiri Denemark 已提交
771 772 773 774 775 776 777
      <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>

778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
      <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>
809

E
Eric Blake 已提交
810 811
        <span class="since">Since 0.8.5</span> the <code>policy</code>
        attribute can be omitted and will default to <code>require</code>.
812 813 814
      </dd>
    </dl>

815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
    <p>
      Guest NUMA topology can be specifed using the <code>numa</code> element.
      <span class="since">Since 0.9.8</span>
    </p>

<pre>
  ...
  &lt;cpu&gt;
    ...
    &lt;numa&gt;
      &lt;cell cpus='0-3' memory='512000'/&gt;
      &lt;cell cpus='4-7' memory='512000'/&gt;
    &lt;/numa&gt;
    ...
  &lt;/cpu&gt;
  ...</pre>

    <p>
      Each <code>cell</code> element specifies a NUMA cell or a NUMA node.
      <code>cpus</code> specifies the CPU or range of CPUs that are part of
835
      the node. <code>memory</code> specifies the node memory in kibibytes
836 837 838 839 840 841 842 843
      (i.e. blocks of 1024 bytes). Each cell or node is assigned cellid
      or nodeid in the increasing order starting from 0.
    </p>

    <p>
      This guest NUMA specification is currently available only for QEMU/KVM.
    </p>

D
Daniel P. Berrange 已提交
844 845 846
    <h3><a name="elementsLifecycle">Lifecycle control</a></h3>

    <p>
A
Atsushi SAKAI 已提交
847
      It is sometimes necessary to override the default actions taken
D
Daniel P. Berrange 已提交
848 849 850 851 852 853 854
      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>

855 856 857 858 859 860
<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 已提交
861 862 863 864

    <dl>
      <dt><code>on_poweroff</code></dt>
      <dd>The content of this element specifies the action to take when
M
Matthew Booth 已提交
865
        the guest requests a poweroff.</dd>
D
Daniel Veillard 已提交
866
      <dt><code>on_reboot</code></dt>
D
Daniel P. Berrange 已提交
867
      <dd>The content of this element specifies the action to take when
M
Matthew Booth 已提交
868
        the guest requests a reboot.</dd>
D
Daniel Veillard 已提交
869
      <dt><code>on_crash</code></dt>
D
Daniel P. Berrange 已提交
870
      <dd>The content of this element specifies the action to take when
M
Matthew Booth 已提交
871
        the guest crashes.</dd>
D
Daniel P. Berrange 已提交
872 873 874 875 876 877 878 879 880
    </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 已提交
881
        released</dd>
D
Daniel P. Berrange 已提交
882 883
      <dt><code>restart</code></dt>
      <dd>The domain will be terminated, and then restarted with
M
Matthew Booth 已提交
884
        the same configuration</dd>
D
Daniel P. Berrange 已提交
885 886
      <dt><code>preserve</code></dt>
      <dd>The domain will be terminated, and its resource preserved
M
Matthew Booth 已提交
887
        to allow analysis.</dd>
D
Daniel P. Berrange 已提交
888 889
      <dt><code>rename-restart</code></dt>
      <dd>The domain will be terminated, and then restarted with
M
Matthew Booth 已提交
890
        a new name</dd>
D
Daniel P. Berrange 已提交
891 892
    </dl>

893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
    <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 已提交
908 909 910 911 912 913 914
    <h3><a name="elementsFeatures">Hypervisor features</a></h3>

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

915 916 917 918 919 920
<pre>
  ...
  &lt;features&gt;
    &lt;pae/&gt;
    &lt;acpi/&gt;
    &lt;apic/&gt;
J
Jim Fehlig 已提交
921
    &lt;hap/&gt;
922
    &lt;privnet/&gt;
923 924
  &lt;/features&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
925 926 927 928 929 930 931 932 933 934 935 936

    <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 已提交
937
        to address more than 4 GB of memory.</dd>
D
Daniel P. Berrange 已提交
938 939
      <dt><code>acpi</code></dt>
      <dd>ACPI is useful for power management, for example, with
M
Matthew Booth 已提交
940
        KVM guests it is required for graceful shutdown to work.
D
Daniel P. Berrange 已提交
941
      </dd>
J
Jim Fehlig 已提交
942 943 944 945
      <dt><code>hap</code></dt>
      <dd>Enable use of Hardware Assisted Paging if available in
        the hardware.
      </dd>
946 947 948 949
      <dt><code>viridian</code></dt>
      <dd>Enable Viridian hypervisor extensions for paravirtualizing
        guest operating systems
      </dd>
950 951 952 953 954 955
      <dt><code>privnet</code></dt>
      <dd>Always create a private network namespace. This is
        automatically set if any interface devices are defined.
        This feature is only relevant for container based
        virtualization drivers, such as LXC.
      </dd>
D
Daniel P. Berrange 已提交
956 957 958 959 960 961 962 963 964 965 966
    </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>

967 968
<pre>
  ...
969 970 971 972
  &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;
973
    &lt;timer name="pit" tickpolicy="delay"/&gt;
974
  &lt;/clock&gt;
975
  ...</pre>
D
Daniel P. Berrange 已提交
976 977 978

    <dl>
      <dt><code>clock</code></dt>
979
      <dd>
E
Eric Blake 已提交
980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
        <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.
P
Philipp Hahn 已提交
1005
            The guest is free to adjust the RTC over time and expect
E
Eric Blake 已提交
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
            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 已提交
1016
      </dd>
1017 1018
      <dt><code>timer</code></dt>
      <dd>
E
Eric Blake 已提交
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
        <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
P
Paolo Bonzini 已提交
1029 1030
            being modified, and can be one of "platform", "hpet",
            "kvmclock", "pit", "rtc", or "tsc".
E
Eric Blake 已提交
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
          </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>
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
            <p>
            The <code>tickpolicy</code> attribute determines what
            happens whens QEMU misses a deadline for injecting a
            tick to the guest:
            </p>
            <dl>
              <dt><code>delay</code></dt>
              <dd>Continue to deliver ticks at the normal rate.
                The guest time will be delayed due to the late
                tick</dd>
              <dt><code>catchup</code></dt>
              <dd>Deliver ticks at a higher rate to catch up
                with the missed tick. The guest time should
                not be delayed once catchup is complete.</dd>
              <dt><code>merge</code></dt>
              <dd>Merge the missed tick(s) into one tick and
                inject. The guest time may be delayed, depending
                on how the OS reacts to the merging of ticks</dd>
              <dt><code>discard</code></dt>
              <dd>Throw away the missed tick(s) and continue
                with future injection normally. The guest time
                may be delayed, unless the OS has explicit
                handling of lost ticks</dd>
            </dl>
            <p>If the policy is "catchup", there can be further details in
            the <code>catchup</code> sub-element.</p>
E
Eric Blake 已提交
1067 1068 1069 1070 1071 1072 1073 1074 1075
            <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>
1076 1077 1078
            <p>
              Note that hypervisors are not required to support all policies across all time sources
            </p>
E
Eric Blake 已提交
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
          </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>
1099
      </dd>
D
Daniel P. Berrange 已提交
1100 1101 1102 1103 1104
    </dl>

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

    <p>
A
Atsushi SAKAI 已提交
1105
      The final set of XML elements are all used to describe devices
D
Daniel P. Berrange 已提交
1106 1107 1108 1109 1110
      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>

1111 1112 1113 1114 1115 1116
<pre>
  ...
  &lt;devices&gt;
    &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
1117 1118 1119 1120

    <dl>
      <dt><code>emulator</code></dt>
      <dd>
M
Matthew Booth 已提交
1121 1122 1123 1124 1125
        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 已提交
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
      </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>

1137 1138 1139
<pre>
  ...
  &lt;devices&gt;
1140
    &lt;disk type='file' snapshot='external'&gt;
1141
      &lt;driver name="tap" type="aio" cache="default"/&gt;
E
Eric Blake 已提交
1142
      &lt;source file='/var/lib/xen/images/fv0' startupPolicy='optional'&gt;
1143 1144
        &lt;seclabel relabel='no'/&gt;
      &lt;/source&gt;
1145
      &lt;target dev='hda' bus='ide'/&gt;
L
Lei Li 已提交
1146 1147 1148 1149 1150
      &lt;iotune&gt;
        &lt;total_bytes_sec&gt;10000000&lt;/total_bytes_sec&gt;
        &lt;read_iops_sec&gt;400000&lt;/read_iops_sec&gt;
        &lt;write_iops_sec&gt;100000&lt;/write_iops_sec&gt;
      &lt;/iotune&gt;
1151
      &lt;boot order='2'/&gt;
1152 1153 1154 1155
      &lt;encryption type='...'&gt;
        ...
      &lt;/encryption&gt;
      &lt;shareable/&gt;
1156 1157 1158
      &lt;serial&gt;
        ...
      &lt;/serial&gt;
1159
    &lt;/disk&gt;
M
MORITA Kazutaka 已提交
1160 1161
      ...
    &lt;disk type='network'&gt;
1162
      &lt;driver name="qemu" type="raw" io="threads" ioeventfd="on" event_idx="off"/&gt;
M
MORITA Kazutaka 已提交
1163 1164 1165 1166
      &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;
1167
      &lt;boot order='1'/&gt;
1168
      &lt;transient/&gt;
E
Eric Blake 已提交
1169
      &lt;address type='drive' controller='0' bus='1' unit='0'/&gt;
M
MORITA Kazutaka 已提交
1170
    &lt;/disk&gt;
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
    &lt;disk type='network'&gt;
      &lt;driver name="qemu" type="raw"/&gt;
      &lt;source protocol="rbd" name="image_name2"&gt;
        &lt;host name="hostname" port="7000"/&gt;
      &lt;/source&gt;
      &lt;target dev="hdd" bus="ide"/&gt;
      &lt;auth username='myuser'&gt;
        &lt;secret type='ceph' usage='mypassid'/&gt;
      &lt;/auth&gt;
    &lt;/disk&gt;
1181 1182
    &lt;disk type='block' device='cdrom'&gt;
      &lt;driver name='qemu' type='raw'/&gt;
1183
      &lt;target dev='hdc' bus='ide' tray='open'/&gt;
1184 1185
      &lt;readonly/&gt;
    &lt;/disk&gt;
1186 1187
    &lt;disk type='block' device='lun'&gt;
      &lt;driver name='qemu' type='raw'/&gt;
O
Osier Yang 已提交
1188 1189 1190
      &lt;source dev='/dev/sda'/&gt;
      &lt;target dev='sda' bus='scsi'/&gt;
      &lt;address type='drive' controller='0' bus='0' target='3' unit='0'/&gt;
1191
    &lt;/disk&gt;
1192 1193
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
1194 1195 1196 1197

    <dl>
      <dt><code>disk</code></dt>
      <dd>The <code>disk</code> element is the main container for describing
M
MORITA Kazutaka 已提交
1198 1199
        disks. The <code>type</code> attribute is either "file",
        "block", "dir", or "network"
M
Matthew Booth 已提交
1200 1201
        and refers to the underlying source for the disk. The optional
        <code>device</code> attribute indicates how the disk is to be exposed
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
        to the guest OS. Possible values for this attribute are
        "floppy", "disk", "cdrom", and "lun", defaulting to
        "disk". "lun" (<span class="since">since 0.9.10</span>) is only
        valid when type is "block" and the target element's "bus"
        attribute is "virtio", and behaves identically to "disk",
        except that generic SCSI commands from the guest are accepted
        and passed through to the physical device
        - also note that device='lun' will only be recognized for
        actual raw devices, never for individual partitions or LVM
        partitions (in those cases, the kernel will reject the generic
1212
        SCSI commands, making it identical to device='disk').
L
Laine Stump 已提交
1213 1214 1215 1216 1217 1218 1219 1220
        The optional <code>rawio</code> attribute
        (<span class="since">since 0.9.10</span>) indicates whether
        the disk is needs rawio capability; valid settings are "yes"
        or "no" (default is "no"). If any one disk in a domain has
        rawio='yes', rawio capability will be enabled for all disks in
        the domain (because, in the case of QEMU, this capability can
        only be set on a per-process basis). This attribute is only
        valid when device is "lun".
1221
        The optional <code>snapshot</code> attribute indicates the default
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
        behavior of the disk during disk snapshots: "internal"
        requires a file format such as qcow2 that can store both the
        snapshot and the data changes since the snapshot;
        "external" will separate the snapshot from the live data; and
        "no" means the disk will not participate in snapshots.
        Read-only disks default to "no", while the default for other
        disks depends on the hypervisor's capabilities.  Some
        hypervisors allow a per-snapshot choice as well,
        during <a href="formatsnapshot.html">domain snapshot
        creation</a>.  Not all snapshot modes are supported;
        for example, <code>snapshot='yes'</code> with a transient disk
        generally does not make sense.  <span class="since">Since 0.0.3;
        "device" attribute since 0.1.4;
        "network" attribute since 0.8.7; "snapshot" since
        0.9.5</span></dd>
D
Daniel P. Berrange 已提交
1237
      <dt><code>source</code></dt>
E
Eric Blake 已提交
1238
      <dd>If the disk <code>type</code> is "file", then
M
MORITA Kazutaka 已提交
1239 1240 1241 1242
        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
1243 1244 1245 1246 1247
        the disk. With both "file" and "block", an optional
        sub-element <code>seclabel</code>, <a href="#seclabel">described
        below</a> (and <span class="since">since 0.9.9</span>), can be
        used to override the domain security labeling policy for just
        that source file.  If the disk <code>type</code> is "dir", then the
1248 1249 1250 1251 1252 1253
        <code>dir</code> attribute specifies the fully-qualified path
        to the directory to use 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
M
MORITA Kazutaka 已提交
1254
        attribute <code>name</code> is mandatory to specify which
1255
        image will be used.  When the disk <code>type</code> is
M
MORITA Kazutaka 已提交
1256 1257 1258
        "network", the <code>source</code> may have zero or
        more <code>host</code> sub-elements used to specify the hosts
        to connect.
1259 1260 1261 1262 1263 1264
        <span class="since">Since 0.0.3; <code>type='dir'</code> since
        0.7.5; <code>type='network'</code> since 0.8.7</span><br/>
        For a "file" disk type which represents a cdrom or floppy
        (the <code>device</code> attribute), it is possible to define
        policy what to do with the disk if the source file is not accessible.
        This is done by the <code>startupPolicy</code> attribute, accepting
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
        these values:
        <table class="top_table">
          <tr>
            <td> mandatory </td>
            <td> fail if missing for any reason (the default) </td>
          </tr>
          <tr>
            <td> requisite </td>
            <td> fail if missing on boot up,
                 drop if missing on migrate/restore/revert </td>
          </tr>
          <tr>
            <td> optional </td>
            <td> drop if missing at any start attempt </td>
          </tr>
        </table>
        <span class="since">Since 0.9.7</span>
        </dd>
D
Daniel P. Berrange 已提交
1283
      <dt><code>target</code></dt>
E
Eric Blake 已提交
1284 1285 1286 1287 1288 1289 1290 1291
      <dd>The <code>target</code> element controls the bus / device
        under which the 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
J
Jim Fehlig 已提交
1292 1293
        "ide", "scsi", "virtio", "xen", "usb" or "sata". If omitted, the bus
        type is inferred from the style of the device name. eg, a device named
1294 1295 1296 1297 1298
        'sda' will typically be exported using a SCSI bus. The optional
        attribute <code>tray</code> indicates the tray status of the
        removable disks (i.e. CDROM or Floppy disk), the value can be either
        "open" or "closed", defaults to "closed". NB, the value of
        <code>tray</code> could be updated while the domain is running.
M
Matthew Booth 已提交
1299
        <span class="since">Since 0.0.3; <code>bus</code> attribute since 0.4.3;
1300 1301 1302
        <code>tray</code> attribute since 0.9.11; "usb" attribute value since
        after 0.4.4; "sata" attribute value since 0.9.7</span>
      </dd>
L
Lei Li 已提交
1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
      <dt><code>iotune</code></dt>
      <dd>The optional <code>iotune</code> element provides the
        ability to provide additional per-device I/O tuning, with
        values that can vary for each device (contrast this to
        the <a href="#elementsBlockTuning"><code>&lt;blkiotune&gt;</code></a>
        element, which applies globally to the domain).  Currently,
        the only tuning available is Block I/O throttling for qemu.
        This element has optional sub-elements; any sub-element not
        specified or given with a value of 0 implies no
        limit.  <span class="since">Since 0.9.8</span>
        <dl>
          <dt><code>total_bytes_sec</code></dt>
          <dd>The optional <code>total_bytes_sec</code> element is the
            total throughput limit in bytes per second.  This cannot
            appear with <code>read_bytes_sec</code>
            or <code>write_bytes_sec</code>.</dd>
          <dt><code>read_bytes_sec</code></dt>
          <dd>The optional <code>read_bytes_sec</code> element is the
            read throughput limit in bytes per second.</dd>
          <dt><code>write_bytes_sec</code></dt>
          <dd>The optional <code>write_bytes_sec</code> element is the
            write throughput limit in bytes per second.</dd>
          <dt><code>total_iops_sec</code></dt>
          <dd>The optional <code>total_iops_sec</code> element is the
            total I/O operations per second.  This cannot
            appear with <code>read_iops_sec</code>
            or <code>write_iops_sec</code>.</dd>
          <dt><code>read_iops_sec</code></dt>
          <dd>The optional <code>read_iops_sec</code> element is the
            read I/O operations per second.</dd>
          <dt><code>write_iops_sec</code></dt>
          <dd>The optional <code>write_iops_sec</code> element is the
            write I/O operations per second.</dd>
        </dl>
D
Daniel P. Berrange 已提交
1337
      <dt><code>driver</code></dt>
M
Matthias Dahl 已提交
1338 1339 1340
      <dd>
        The optional driver element allows specifying further details
        related to the hypervisor driver used to provide the disk.
1341
        <span class="since">Since 0.1.8</span>
M
Matthias Dahl 已提交
1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
        <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",
1356 1357 1358 1359 1360 1361 1362 1363 1364
            "writethrough", "writeback", "directsync" (like
            "writethrough", but it bypasses the host page cache) and
            "unsafe" (host may cache all disk io, and sync requests from
            guest are ignored).
            <span class="since">
              Since 0.6.0,
              "directsync" since 0.9.5,
              "unsafe" since 0.9.7
            </span>
M
Matthias Dahl 已提交
1365 1366 1367
          </li>
          <li>
            The optional <code>error_policy</code> attribute controls
1368 1369 1370 1371 1372 1373 1374
            how the hypervisor will behave on a disk read or write
            error, possible values are "stop", "report", "ignore", and
            "enospace".<span class="since">Since 0.8.0, "report" since
            0.9.7</span> The default setting of error_policy is "report".
            There is also an
            optional <code>rerror_policy</code> that controls behavior
            for read errors only. <span class="since">Since
E
Eric Blake 已提交
1375
            0.9.7</span>. If no rerror_policy is given, error_policy
1376 1377 1378 1379 1380 1381 1382
            is used for both read and write errors. If rerror_policy
            is given, it overrides the <code>error_policy</code> for
            read errors. Also note that "enospace" is not a valid
            policy for read errors, so if <code>error_policy</code> is
            set to "enospace" and no <code>rerror_policy</code> is
            given, the read error policy will be left at its default,
            which is "report".
M
Matthias Dahl 已提交
1383 1384 1385 1386
          </li>
          <li>
            The optional <code>io</code> attribute controls specific
            policies on I/O; qemu guests support "threads" and
1387
            "native". <span class="since">Since 0.8.8</span>
M
Matthias Dahl 已提交
1388
          </li>
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
          <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>
1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415
          <li>
            The optional <code>event_idx</code> attribute controls
            some aspects of device event processing. The value can be
            either 'on' or 'off' - if it is on, it will reduce the
            number of interupts and exits for the guest. The default
            is determined by QEMU; usually if the feature is
            supported, default is on. In case there is a situation
            where this behavior is suboptimal, this attribute provides
            a way to force the feature off.
            <span class="since">Since 0.9.5 (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>
O
Osier Yang 已提交
1416 1417 1418 1419 1420 1421 1422 1423 1424
          <li>
            The optional <code>copy_on_read</code> attribute controls
            wether to copy read backing file into the image file. The
            value can be either "on" or "off".
            Copy-on-read avoids accessing the same backing file sectors
            repeatedly and is useful when the backing file is over a slow
            network. By default copy-on-read is off.
            <span class='since'>Since 0.9.10 (QEMU and KVM only)</span>
          </li>
M
Matthias Dahl 已提交
1425
        </ul>
D
Daniel P. Berrange 已提交
1426
      </dd>
1427 1428 1429 1430 1431 1432 1433 1434
      <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>
1435 1436 1437 1438 1439
      <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>
1440 1441 1442 1443 1444
      <dt><code>readonly</code></dt>
      <dd>If present, this indicates the device cannot be modified by
        the guest.  For now, this is the default for disks with
        attribute <code>type='cdrom'</code>.
      </dd>
1445 1446 1447 1448 1449
      <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>
1450 1451 1452 1453 1454 1455 1456
      <dt><code>transient</code></dt>
      <dd>If present, this indicates that changes to the device
        contents should be reverted automatically when the guest
        exits.  With some hypervisors, marking a disk transient
        prevents the domain from participating in migration or
        snapshots. <span class="since">Since 0.9.5</span>
      </dd>
1457 1458
      <dt><code>serial</code></dt>
      <dd>If present, this specify serial number of virtual hard drive.
E
Eric Blake 已提交
1459 1460
          For example, it may look
          like <code>&lt;serial&gt;WD-WMAP9A966149&lt;/serial&gt;</code>.
1461 1462
          <span class="since">Since 0.7.1</span>
      </dd>
M
MORITA Kazutaka 已提交
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
      <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 已提交
1490 1491 1492 1493 1494 1495 1496 1497 1498
      <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>,
1499 1500 1501 1502 1503
        and <code>function</code> must be present, as well as
        optional <code>domain</code> and <code>multifunction</code>.
        Multifunction defaults to 'off'; any other value requires
        QEMU 0.1.3 and <span class="since">libvirt 0.9.7</span>.  For a
        "drive" controller, additional attributes
1504 1505 1506
        <code>controller</code>, <code>bus</code>, <code>target</code>
        (<span class="since">libvirt 0.9.11</span>), and <code>unit</code>
        are available, each defaulting to 0.
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524
      </dd>
      <dt><code>auth</code></dt>
      <dd>If present, the <code>auth</code> element provides the
        authentication credentials needed to access the source.  It
        includes a mandatory attribute <code>username</code>, which
        identifies the username to use during authentication, as well
        as a sub-element <code>secret</code> with mandatory
        attribute <code>type</code>, to tie back to
        a <a href="formatsecret.html">libvirt secret object</a> that
        holds the actual password or other credentials (the domain XML
        intentionally does not expose the password, only the reference
        to the object that does manage the password).  For now, the
        only known secret <code>type</code> is "ceph", for Ceph RBD
        network sources, and requires either an
        attribute <code>uuid</code> with the UUID of the Ceph secret
        object, or an attribute <code>usage</code> with the name
        associated with the Ceph secret
        object.  <span class="since">libvirt 0.9.7</span>
E
Eric Blake 已提交
1525
      </dd>
D
Daniel P. Berrange 已提交
1526 1527
    </dl>

1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
    <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;
1542
    &lt;filesystem type='mount' accessmode='passthrough'&gt;
1543
      &lt;driver type='path' wrpolicy='immediate'/&gt;
1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
      &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>.
1565
        This is the default <code>type</code> if one is not specified.
1566 1567 1568 1569
        This mode also has an optional
        sub-element <code>driver</code>, with an
        attribute <code>type='path'</code>
        or <code>type='handle'</code> <span class="since">(since
1570 1571 1572 1573 1574 1575
        0.9.7)</span>. The driver block has an optional attribute
        <code>wrpolicy</code> that further controls interaction with
        the host page cache; omitting the attribute gives default behavior,
        while the value <code>immediate</code> means that a host writeback
        is immediately triggered for all pages touched during a guest file
        write operation <span class="since">(since 0.9.10)</span>.
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
        </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>
1587 1588 1589
        A host block device to mount in the guest. The filesystem
        format will be autodetected. Only used by LXC driver
        <span class="since">(since 0.9.5)</span>.
1590 1591 1592
        </dd>
        </dl>

1593
      The filesystem block has an optional attribute <code>accessmode</code>
1594 1595 1596 1597 1598 1599
      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>
1600
        <dt><code>accessmode='passthrough'</code></dt>
1601 1602
        <dd>
        The <code>source</code> is accessed with the permissions of the
1603
        user inside the guest. This is the default <code>accessmode</code> if
1604 1605 1606
        one is not specified.
        <a href="http://lists.gnu.org/archive/html/qemu-devel/2010-05/msg02673.html">More info</a>
        </dd>
1607
        <dt><code>accessmode='mapped'</code></dt>
1608 1609 1610 1611 1612
        <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>
1613
        <dt><code>accessmode='squash'</code></dt>
1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642
        <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>
1643 1644 1645
        Enables exporting filesytem as a readonly mount for guest, by
        default read-write access is given (currently only works for
        QEMU/KVM driver).
1646 1647 1648
      </dd>
    </dl>

1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695
    <h4><a name="elementsAddress">Device Addresses</a></h4>

    <p>
      Many devices have an optional <code>&lt;address&gt;</code>
      sub-element to describe where the device is placed on the
      virtual bus presented to the guest.  If an address (or any
      optional attribute within an address) is omitted on
      input, libvirt will generate an appropriate address; but an
      explicit address is required if more control over layout is
      required.  See below for device examples including an address
      element.
    </p>

    <p>
      Every address has a mandatory attribute <code>type</code> that
      describes which bus the device is on.  The choice of which
      address to use for a given device is constrained in part by the
      device and the architecture of the guest.  For example,
      a <code>&lt;disk&gt;</code> device
      uses <code>type='disk'</code>, while
      a <code>&lt;console&gt;</code> device would
      use <code>type='pci'</code> on i686 or x86_64 guests,
      or <code>type='spapr-vio'</code> on PowerPC64 pseries guests.
      Each address type has further optional attributes that control
      where on the bus the device will be placed:
    </p>

    <dl>
      <dt><code>type='pci'</code></dt>
      <dd>PCI addresses have the following additional
        attributes: <code>domain</code> (a 2-byte hex integer, not
        currently used by qemu), <code>bus</code> (a hex value between
        0 and 0xff, inclusive), <code>slot</code> (a hex value between
        0x0 and 0x1f, inclusive), and <code>function</code> (a value
        between 0 and 7, inclusive).  Also available is
        the <code>multifunction</code> attribute, which controls
        turning on the multifunction bit for a particular
        slot/function in the PCI control register
        (<span class="since">since 0.9.7, requires QEMU
        0.13</span>). <code>multifunction</code> defaults to 'off',
        but should be set to 'on' for function 0 of a slot that will
        have multiple functions used.
      </dd>
      <dt><code>type='drive'</code></dt>
      <dd>Drive addresses have the following additional
        attributes: <code>controller</code> (a 2-digit controller
        number), <code>bus</code> (a 2-digit bus number),
1696
        <code>target</code> (a 2-digit bus number),
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727
        and <code>unit</code> (a 2-digit unit number on the bus).
      </dd>
      <dt><code>type='virtio-serial'</code></dt>
      <dd>Each virtio-serial address has the following additional
        attributes: <code>controller</code> (a 2-digit controller
        number), <code>bus</code> (a 2-digit bus number),
        and <code>slot</code> (a 2-digit slot within the bus).
      </dd>
      <dt><code>type='ccid'</code></dt>
      <dd>A CCID address, for smart-cards, has the following
        additional attributes: <code>bus</code> (a 2-digit bus
        number), and <code>slot</code> attribute (a 2-digit slot
        within the bus).  <span class="since">Since 0.8.8.</span>
      <dt><code>type='usb'</code></dt>
      <dd>USB addresses have the following additional
        attributes: <code>bus</code> (a hex value between 0 and 0xfff,
        inclusive), and <code>port</code> (a dotted notation of up to
        four octets, such as 1.2 or 2.1.3.1).
      </dd>
      <dt><code>type='spapr-vio'</code></dt>
      <dd>On PowerPC pseries guests, devices can be assigned to the
        SPAPR-VIO bus.  It has a flat 64-bit address space; by
        convention, devices are generally assigned at a non-zero
        multiple of 0x1000, but other addresses are valid and
        permitted by libvirt.  Each address has the following
        additional attribute: <code>reg</code> (the hex value address
        of the starting register).  <span class="since">Since
        0.9.9.</span>
      </dd>
    </dl>

E
Eric Blake 已提交
1728 1729 1730
    <h4><a name="elementsControllers">Controllers</a></h4>

    <p>
1731 1732 1733
      Depending on the guest architecture, some device busses can
      appear more than once, with a group of virtual devices tied to a
      virtual controller.  Normally, libvirt can automatically infer such
E
Eric Blake 已提交
1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751
      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>,
1752 1753 1754 1755 1756 1757 1758
      which must be one of "ide", "fdc", "scsi", "sata", "usb",
      "ccid", or "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
E
Eric Blake 已提交
1759 1760 1761
      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
1762
      attribute <code>model</code>, which is one of "auto", "buslogic",
1763
      "ibmvscsi", "lsilogic", "lsias1068", "virtio-scsi" or "vmpvscsi".
1764 1765 1766
      A "usb" controller has an optional attribute <code>model</code>,
      which is one of "piix3-uhci", "piix4-uhci", "ehci",
      "ich9-ehci1", "ich9-uhci1", "ich9-uhci2", "ich9-uhci3",
1767 1768
      "vt82c686b-uhci" or "pci-ohci".  The PowerPC64 "spapr-vio"
      addresses do not have an associated controller.
E
Eric Blake 已提交
1769 1770 1771 1772 1773 1774
    </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
1775
      semantics <a href="#elementsAddress">given above</a>.
E
Eric Blake 已提交
1776 1777
    </p>

1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793
    <p>
      USB companion controllers have an optional
      sub-element <code>&lt;master&gt;</code> to specify the exact
      relationship of the companion to its master controller.
      A companion controller is on the same bus as its master, so
      the companion <code>index</code> value should be equal.
    </p>

<pre>
  ...
  &lt;devices&gt;
    &lt;controller type='usb' index='0' model='ich9-ehci1'&gt;
      &lt;address type='pci' domain='0' bus='0' slot='4' function='7'/&gt;
    &lt;/controller&gt;
    &lt;controller type='usb' index='0' model='ich9-uhci1'&gt;
      &lt;master startport='0'/&gt;
1794
      &lt;address type='pci' domain='0' bus='0' slot='4' function='0' multifunction='on'/&gt;
1795 1796 1797 1798 1799
    &lt;/controller&gt;
    ...
  &lt;/devices&gt;
  ...</pre>

1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838
    <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 已提交
1839

1840
    <h4><a name="elementsUSB">USB and PCI devices</a></h4>
1841 1842

    <p>
E
Eric Blake 已提交
1843 1844
      USB and PCI devices attached to the host can be passed through
      to the guest using
1845 1846
      the <code>hostdev</code> element. <span class="since">since after
      0.4.4 for USB and 0.6.0 for PCI (KVM only)</span>:
1847 1848
    </p>

1849 1850 1851 1852 1853 1854 1855 1856
<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;
1857
      &lt;boot order='2'/&gt;
1858 1859 1860 1861
    &lt;/hostdev&gt;
  &lt;/devices&gt;
  ...</pre>

1862
    <p>or:</p>
1863 1864 1865 1866

<pre>
  ...
  &lt;devices&gt;
1867
    &lt;hostdev mode='subsystem' type='pci' managed='yes'&gt;
1868 1869 1870
      &lt;source&gt;
        &lt;address bus='0x06' slot='0x02' function='0x0'/&gt;
      &lt;/source&gt;
1871
      &lt;boot order='1'/&gt;
1872
      &lt;rom bar='on' file='/etc/fake/boot.bin'/&gt;
1873 1874 1875
    &lt;/hostdev&gt;
  &lt;/devices&gt;
  ...</pre>
1876 1877 1878 1879

    <dl>
      <dt><code>hostdev</code></dt>
      <dd>The <code>hostdev</code> element is the main container for describing
1880 1881
        host devices. For usb device passthrough <code>mode</code> is always
        "subsystem" and <code>type</code> is "usb" for a USB device and "pci"
1882
        for a PCI device. When <code>managed</code> is "yes" for a PCI
1883
        device, it is detached from the host before being passed on to
1884 1885 1886 1887 1888 1889 1890 1891 1892
        the guest, and reattached to the host after the guest exits.
        If <code>managed</code> is omitted or "no", and for USB
        devices, the user is responsible to
        call <code>virNodeDeviceDettach</code> (or <code>virsh
        nodedev-dettach</code>) before starting the guest or
        hot-plugging the device,
        and <code>virNodeDeviceReAttach</code> (or <code>virsh
        nodedev-reattach</code>) after hot-unplug or stopping the
        guest.</dd>
1893 1894 1895 1896
      <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
1897 1898 1899
      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>
1900 1901 1902 1903 1904
      <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>
1905 1906 1907 1908 1909 1910 1911
      <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>
1912 1913
      <dt><code>rom</code></dt>
      <dd>The <code>rom</code> element is used to change how a PCI
1914
        device's ROM is presented to the guest. The optional <code>bar</code>
1915 1916 1917 1918 1919 1920 1921
        attribute can be set to "on" or "off", and determines whether
        or not the device's ROM will be visible in the guest's memory
        map. (In PCI documentation, the "rombar" setting controls the
        presence of the Base Address Register for the ROM). If no rom
        bar is specified, the qemu default will be used (older
        versions of qemu used a default of "off", while newer qemus
        have a default of "on"). <span class="since">Since
1922 1923 1924 1925 1926 1927 1928
        0.9.7 (QEMU and KVM only)</span>. The optional
        <code>file</code> attribute is used to point to a binary file
        to be presented to the guest as the device's ROM BIOS. This
        can be useful, for example, to provide a PXE boot ROM for a
        virtual function of an sr-iov capable ethernet device (which
        has no boot ROMs for the VFs).
        <span class="since">Since 0.9.10 (QEMU and KVM only)</span>.
1929
      </dd>
1930
      <dt><code>address</code></dt>
1931 1932 1933 1934 1935 1936 1937
      <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
1938 1939 1940
      with <code>virsh
      nodedev-list</code>. <a href="#elementsAddress">See above</a> for
      more details on the address element.
1941 1942
    </dl>

1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972
    <h4><a name="elementsRedir">Redirected devices</a></h4>

    <p>
      USB device redirection through a character device is
      supported <span class="since">since after 0.9.5 (KVM
      only)</span>:
    </p>

<pre>
  ...
  &lt;devices&gt;
    &lt;redirdev bus='usb' type='tcp'&gt;
      &lt;source mode='connect' host='localhost' service='4000'/&gt;
    &lt;/redirdev&gt;
  &lt;/devices&gt;
  ...</pre>

    <dl>
      <dt><code>redirdev</code></dt>
      <dd>The <code>redirdev</code> element is the main container for
        describing redirected devices. <code>bus</code> must be "usb"
        for a USB device.

        An additional attribute <code>type</code> is required,
        matching one of the
        supported <a href="#elementsConsole">serial device</a> types,
        to describe the host side of the
        tunnel; <code>type='tcp'</code>
        or <code>type='spicevmc'</code> (which uses the usbredir
        channel of a <a href="#elementsGraphics">SPICE graphics
1973
        device</a>) are typical.</dd>
1974 1975

    </dl>
1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987
    <p>
      The redirdev element has an optional sub-element
      <code>&lt;address&gt;</code> which can tie the device to a
      particular controller.
    </p>
    <p>
      Further sub-elements, such as <code>&lt;source&gt;</code>, may
      be required according to the 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).
    </p>
1988

1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018
    <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 已提交
2019
    &lt;smartcard mode='passthrough' type='spicevmc'/&gt;
2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
  &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 已提交
2062 2063 2064 2065 2066
      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
2067 2068 2069 2070 2071 2072 2073 2074 2075
      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
2076 2077 2078
      correlation between the smartcard and a ccid bus
      controller, <a href="#elementsAddress">documented above</a>.
      For now, qemu only supports at most one
2079 2080 2081
      smartcard, with an address of bus=0 slot=0.
    </p>

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

2084 2085 2086 2087 2088 2089 2090
<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;
2091
      &lt;boot order='1'/&gt;
2092
      &lt;rom bar='off'/&gt;
2093 2094 2095
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2096

E
Eric Blake 已提交
2097 2098 2099 2100 2101 2102 2103
    <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
2104 2105
      attribute <code>type='pci'</code>
      as <a href="#elementsAddress">documented above</a>.
E
Eric Blake 已提交
2106 2107
    </p>

D
Daniel P. Berrange 已提交
2108 2109 2110 2111 2112
    <h5><a name="elementsNICSVirtual">Virtual network</a></h5>

    <p>
      <strong><em>
      This is the recommended config for general guest connectivity on
2113 2114 2115 2116
      hosts with dynamic / wireless networking configs (or multi-host
      environments where the host hardware details are described
      separately in a <code>&lt;network&gt;</code>
      definition <span class="since">Since 0.9.4</span>).
D
Daniel P. Berrange 已提交
2117 2118 2119 2120
      </em></strong>
    </p>

    <p>
2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147

      Provides a connection whose details are described by the named
      network definition. Depending on the virtual network's "forward
      mode" configuration, the network may be totally isolated
      (no <code>&lt;forward&gt;</code> element given), NAT'ing to an
      explicit network device or to the default route
      (<code>&lt;forward mode='nat'&gt;</code>), routed with no NAT
      (<code>&lt;forward mode='route'/&gt;</code>), or connected
      directly to one of the host's network interfaces (via macvtap)
      or bridge devices ((<code>&lt;forward
      mode='bridge|private|vepa|passthrough'/&gt;</code> <span class="since">Since
      0.9.4</span>)
    </p>
    <p>
      For networks with a forward mode of bridge, private, vepa, and
      passthrough, it is assumed that the host has any necessary DNS
      and DHCP services already setup outside the scope of libvirt. In
      the case of isolated, nat, and routed networks, DHCP and DNS are
      provided on the virtual network by libvirt, 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 <code>192.168.122.0/255.255.255.0</code>. Each guest will
      have an associated tun device created with a name of vnetN,
      which can also be overridden with the &lt;target&gt; element
      (see
2148
      <a href="#elementsNICSTargetOverride">overriding the target element</a>).
D
Daniel P. Berrange 已提交
2149
    </p>
2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161
    <p>
      When the source of an interface is a network,
      a <code>portgroup</code> can be specified along with the name of
      the network; one network may have multiple portgroups defined,
      with each portgroup containing slightly different configuration
      information for different classes of network
      connections. <span class="since">Since 0.9.4</span>). Also,
      similar to <code>direct</code> network connections (described
      below), a connection of type <code>network</code> may specify
      a <code>virtportprofile</code> element, with configuration data
      to be forwarded to a vepa or 802.1Qbh compliant switch.
    </p>
D
Daniel P. Berrange 已提交
2162

2163 2164 2165 2166 2167 2168 2169 2170
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
    &lt;/interface&gt;
    ...
    &lt;interface type='network'&gt;
2171
      &lt;source network='default' portgroup='engineering'/&gt;
2172
      &lt;target dev='vnet7'/&gt;
2173
      &lt;mac address="00:11:22:33:44:55"/&gt;
2174 2175 2176 2177
      &lt;virtualport type='802.1Qbg'&gt;
        &lt;parameters managerid='11' typeid='1193047' typeidversion='2' instanceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f'/&gt;
      &lt;/virtualport&gt;

2178 2179 2180
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2181

D
Dan Kenigsberg 已提交
2182
    <h5><a name="elementsNICSBridge">Bridge to LAN</a></h5>
D
Daniel P. Berrange 已提交
2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195

    <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
2196 2197 2198 2199 2200
      &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 已提交
2201 2202
    </p>

2203 2204 2205 2206 2207 2208 2209 2210 2211 2212
<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;
2213
      &lt;mac address="00:11:22:33:44:55"/&gt;
2214 2215 2216
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228

    <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>

2229 2230 2231 2232 2233 2234
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='user'/&gt;
    ...
    &lt;interface type='user'&gt;
2235
      &lt;mac address="00:11:22:33:44:55"/&gt;
2236 2237 2238
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252


    <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>

2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263
<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 已提交
2264

2265 2266 2267 2268
    <h5><a name="elementsNICSDirect">Direct attachment to physical interface</a></h5>

    <p>
      Provides direct attachment of the virtual machine's NIC to the given
2269
      physial interface of the host.
E
Eric Blake 已提交
2270
      <span class="since">Since 0.7.7 (QEMU and KVM only)</span><br/>
2271 2272 2273
      This setup requires the Linux macvtap
      driver to be available. <span class="since">(Since Linux 2.6.34.)</span>
      One of the modes 'vepa'
2274
      ( <a href="http://www.ieee802.org/1/files/public/docs2009/new-evb-congdon-vepa-modular-0709-v01.pdf">
2275
      'Virtual Ethernet Port Aggregator'</a>), 'bridge' or 'private'
2276
      can be chosen for the operation mode of the macvtap device, 'vepa'
2277 2278
      being the default mode. The individual modes cause the delivery of
      packets to behave as follows:
2279 2280
    </p>

2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291
    <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 已提交
2292
      a VEPA capable bridge is required.</dd>
2293 2294 2295 2296 2297 2298
      <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>
2299 2300 2301 2302 2303 2304 2305
      <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>
2306 2307
    </dl>

2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318
<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>

2319 2320 2321 2322
    <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 已提交
2323
    </p>
2324 2325 2326 2327 2328 2329 2330
    <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
2331
      of a virtual machine. <span class="since">Since 0.8.2</span>
2332
    </p>
2333 2334 2335 2336
    <p>
      Please note that IEEE 802.1Qbg requires a non-zero value for the
      VLAN ID.
    </p>
2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362
    <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;
2363
      &lt;source dev='eth0.2' mode='vepa'/&gt;
2364 2365 2366 2367 2368 2369
      &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>
2370

2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399
    <p>
      The interface can have additional parameters as shown below
      if the switch is conforming to the IEEE 802.1Qbh standard.
      The values are network specific and should be provided by the
      network administrator. <span class="since">Since 0.8.2</span>
    </p>
    <dl>
      <dt><code>profileid</code></dt>
      <dd>The profile ID contains the name of the port profile that is to
        be applied onto this interface.  This name is resolved by the port
        profile database into the network parameters from the port profile,
        and those network parameters will be applied to this interface.
      </dd>
    </dl>
  <pre>
  ...
  &lt;devices&gt;
    &lt;interface type='direct'/&gt;
    ...
    &lt;interface type='direct'&gt;
      &lt;source dev='eth0' mode='private'/&gt;
      &lt;virtualport type='802.1Qbh'&gt;
        &lt;parameters profileid='finance'/&gt;
      &lt;/virtualport&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...
  </pre>

2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448

    <h5><a name="elementsNICSHostdev">PCI Passthrough</a></h5>

    <p>
      A PCI network device (specified by the &lt;source&gt; element)
      is directly assigned to the guest using generic device
      passthrough, after first optionally setting the device's MAC
      address to the configured value, and associating the device with
      an 802.1Qgh capable switch using an optionally specified
      %lt;virtualport%gt; element (see the examples of virtualport
      given above for type='direct' network devices). Note that - due
      to limitations in standard single-port PCI ethernet card driver
      design - only SR-IOV (Single Root I/O Virtualization) virtual
      function (VF) devices can be assigned in this manner; to assign
      a standard single-port PCI or PCIe ethernet card to a guest, use
      the traditional &lt;hostdev&gt; device definition and
      <span class="since">Since 0.9.11</span>
    </p>

    <p>
      Note that this "intelligent passthrough" of network devices is
      very similar to the functionality of a standard &lt;hostdev&gt;
      device, the difference being that this method allows specifying
      a MAC address and &lt;virtualport&gt; for the passed-through
      device. If these capabilities are not required, if you have a
      standard single-port PCI, PCIe, or USB network card that doesn't
      support SR-IOV (and hence would anyway lose the configured MAC
      address during reset after being assigned to the guest domain),
      or if you are using a version of libvirt older than 0.9.11, you
      should use standard &lt;hostdev&gt; to assign the device to the
      guest instead of &lt;interface type='hostdev'/&gt;.
    </p>

<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='hostdev'&gt;
      &lt;source&gt;
        &lt;address type='pci' domain='0x0000' bus='0x00' slot='0x07' function='0x0'/&gt;
      &lt;/source&gt;
      &lt;mac address='52:54:00:6d:90:02'&gt;
      &lt;virtualport type='802.1Qbh'&gt;
        &lt;parameters profileid='finance'/&gt;
      &lt;/virtualport&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>


D
Daniel P. Berrange 已提交
2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462
    <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>

2463 2464 2465 2466
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='mcast'&gt;
2467
      &lt;mac address='52:54:00:6d:90:01'&gt;
2468 2469 2470 2471
      &lt;source address='230.0.0.1' port='5558'/&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483

    <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>

2484 2485 2486 2487
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='server'&gt;
2488
      &lt;mac address='52:54:00:22:c9:42'&gt;
D
Daniel P. Berrange 已提交
2489
      &lt;source address='192.168.0.1' port='5558'/&gt;
2490 2491 2492
    &lt;/interface&gt;
    ...
    &lt;interface type='client'&gt;
2493 2494
      &lt;mac address='52:54:00:8b:c9:51'&gt;
      &lt;source address='192.168.0.1' port='5558'/&gt;
2495 2496 2497
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2498

2499 2500
    <h5><a name="elementsNICSModel">Setting the NIC model</a></h5>

2501 2502 2503 2504 2505 2506 2507 2508 2509 2510
<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>
2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532

    <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 已提交
2533

2534 2535 2536 2537 2538 2539 2540 2541 2542
    <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;
2543
      <b>&lt;driver name='vhost' txmode='iothread' ioeventfd='on' event_idx='off'/&gt;</b>
2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555
    &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>
2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567
      <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>
2568 2569 2570 2571 2572
      <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 已提交
2573
        <span class="since">Since 0.8.8 (QEMU and KVM only)</span><br/><br/>
2574 2575 2576 2577

        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 已提交
2578
        option).<br/><br/>
2579 2580 2581 2582

        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 已提交
2583
        fires, another attempt is made to send more data.<br/><br/>
2584 2585 2586 2587 2588

        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 已提交
2589
        cpu where the guest generated the packets."<br/><br/>
2590

2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606
        <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/>

2607
        <b>In general you should leave this option alone, unless you
2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621
        are very certain you know what you are doing.</b>
      </dd>
      <dt><code>event_idx</code></dt>
      <dd>
        The <code>event_idx</code> attribute controls some aspects of
        device event processing. The value can be either 'on' or 'off'
        - if it is on, it will reduce the number of interupts and
        exits for the guest. The default is determined by QEMU;
        usually if the feature is supported, default is on. In case
        there is a situation where this behavior is suboptimal, this
        attribute provides a way to force the feature off.
        <span class="since">Since 0.9.5 (QEMU and KVM only)</span><br/><br/>

        <b>In general you should leave this option alone, unless you
2622 2623 2624 2625
        are very certain you know what you are doing.</b>
      </dd>
    </dl>

2626 2627
    <h5><a name="elementsNICSTargetOverride">Overriding the target element</a></h5>

2628 2629 2630 2631 2632 2633 2634 2635 2636
<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>
2637 2638

    <p>
E
Eric Blake 已提交
2639 2640 2641 2642 2643 2644
      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.
2645 2646
    </p>

2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660
    <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>
2661
      For hypervisors which support this, you can set a specific NIC to
2662 2663 2664 2665 2666 2667 2668 2669
      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>

2670 2671 2672 2673 2674 2675 2676 2677
    <h5><a name="elementsNICSROM">Interface ROM BIOS configuration</a></h5>

<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet1'/&gt;
2678
      <b>&lt;rom bar='on' file='/etc/fake/boot.bin'/&gt;</b>
2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>

    <p>
      For hypervisors which support this, you can change how a PCI Network
      device's ROM is presented to the guest. The <code>bar</code>
      attribute can be set to "on" or "off", and determines whether
      or not the device's ROM will be visible in the guest's memory
      map. (In PCI documentation, the "rombar" setting controls the
      presence of the Base Address Register for the ROM). If no rom
      bar is specified, the qemu default will be used (older
      versions of qemu used a default of "off", while newer qemus
2692 2693 2694 2695 2696 2697
      have a default of "on").
      The optional <code>file</code> attribute is used to point to a
      binary file to be presented to the guest as the device's ROM
      BIOS. This can be useful to provide an alternative boot ROM for a
      network device.
      <span class="since">Since 0.9.10 (QEMU and KVM only)</span>.
2698 2699
    </p>

2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733
    <h5><a name="elementQoS">Quality of service</a></h5>

<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet0'/&gt;
      <b>&lt;bandwidth&gt;
        &lt;inbound average='1000' peak='5000' burst='1024'/&gt;
        &lt;outbound average='128' peak='256' burst='256'/&gt;
      &lt;/bandwidth&gt;</b>
    &lt;/interface&gt;
  &lt;devices&gt;
  ...</pre>

    <p>
      This part of interface XML provides setting quality of service. Incoming
      and outgoing traffic can be shaped independently. The
      <code>bandwidth</code> element can have at most one <code>inbound</code>
      and at most one <code>outbound</code> child elements. Leaving any of these
      children element out result in no QoS applied on that traffic direction.
      So, when you want to shape only domain's incoming traffic, use
      <code>inbound</code> only, and vice versa. Each of these elements have one
      mandatory attribute <code>average</code>. It specifies average bit rate on
      interface being shaped. Then there are two optional attributes:
      <code>peak</code>, which specifies maximum rate at which interface can send
      data, and <code>burst</code>, amount of bytes that can be burst at
      <code>peak</code> speed. Accepted values for attributes are integer
      numbers. The units for <code>average</code> and <code>peak</code> attributes
      are kilobytes per second, and for the <code>burst</code> just kilobytes.
      <span class="since">Since 0.9.4</span>
    </p>

2734
    <h5><a name="elementLink">Modifying virtual link state</a></h5>
2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet0'/&gt;
      <b>&lt;link state='down'/&gt;</b>
    &lt;/interface&gt;
  &lt;devices&gt;
  ...</pre>

    <p>
      This element provides means of setting state of the virtual network link.
      Possible values for attribute <code>state</code> are <code>up</code> and
      <code>down</code>. If <code>down</code> is specified as the value, the interface
      behaves as if it had the network cable disconnected. Default behavior if this
      element is unspecified is to have the link state <code>up</code>.
      <span class="since">Since 0.9.5</span>
    </p>

D
Daniel P. Berrange 已提交
2755 2756 2757
    <h4><a name="elementsInput">Input devices</a></h4>

    <p>
E
Eric Blake 已提交
2758 2759 2760 2761
      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,
D
Daniel P. Berrange 已提交
2762 2763 2764
      to provide a graphics tablet for absolute cursor movement.
    </p>

2765 2766 2767 2768 2769 2770
<pre>
  ...
  &lt;devices&gt;
    &lt;input type='mouse' bus='usb'/&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2771 2772 2773

    <dl>
      <dt><code>input</code></dt>
E
Eric Blake 已提交
2774 2775 2776
      <dd>The <code>input</code> element has one mandatory attribute,
        the <code>type</code> whose value can be either 'mouse' or
        'tablet'. The latter provides absolute
M
Matthew Booth 已提交
2777 2778 2779
        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 已提交
2780 2781
    </dl>

E
Eric Blake 已提交
2782 2783 2784
    <p>
      The <code>input</code> element has an optional
      sub-element <code>&lt;address&gt;</code> which can tie the
2785 2786
      device to a particular PCI
      slot, <a href="#elementsAddress">documented above</a>.
E
Eric Blake 已提交
2787
    </p>
D
Daniel P. Berrange 已提交
2788

M
Marc-André Lureau 已提交
2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811
    <h4><a name="elementsHub">Hub devices</a></h4>

    <p>
      A hub is a device that expands a single port into several so
      that there are more ports available to connect devices to a host
      system.
    </p>

<pre>
  ...
  &lt;devices&gt;
    &lt;hub type='usb'/&gt;
  &lt;/devices&gt;
  ...</pre>

    <dl>
      <dt><code>hub</code></dt>
      <dd>The <code>hub</code> element has one mandatory attribute,
        the <code>type</code> whose value can only be 'usb'.</dd>
    </dl>

    <p>
      The <code>hub</code> element has an optional
2812 2813 2814 2815
      sub-element <code>&lt;address&gt;</code>
      with <code>type='usb'</code>which can tie the device to a
      particular controller, <a href="#elementsAddress">documented
      above</a>.
M
Marc-André Lureau 已提交
2816 2817
    </p>

D
Daniel P. Berrange 已提交
2818 2819 2820 2821 2822 2823 2824 2825 2826
    <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>

2827 2828 2829 2830
<pre>
  ...
  &lt;devices&gt;
    &lt;graphics type='sdl' display=':0.0'/&gt;
2831 2832 2833
    &lt;graphics type='vnc' port='5904'&gt;
      &lt;listen type='address' address='1.2.3.4'/&gt;
    &lt;/graphics&gt;
2834 2835
    &lt;graphics type='rdp' autoport='yes' multiUser='yes' /&gt;
    &lt;graphics type='desktop' fullscreen='yes'/&gt;
2836 2837 2838
    &lt;graphics type='spice'&gt;
      &lt;listen type='network' network='rednet'/&gt;
    &lt;/graphics&gt;
2839 2840
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
2841 2842 2843 2844

    <dl>
      <dt><code>graphics</code></dt>
      <dd>The <code>graphics</code> element has a mandatory <code>type</code>
E
Eric Blake 已提交
2845
        attribute which takes the value "sdl", "vnc", "rdp" or "desktop":
2846 2847 2848
        <dl>
          <dt><code>"sdl"</code></dt>
          <dd>
E
Eric Blake 已提交
2849 2850 2851 2852 2853 2854
            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'.
2855 2856 2857
          </dd>
          <dt><code>"vnc"</code></dt>
          <dd>
E
Eric Blake 已提交
2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869
            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 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>
2870 2871 2872 2873 2874 2875 2876 2877
            assumed to be in UTC. The <code>connected</code> attribute
            allows control of connected client during password changes.
            VNC accepts <code>keep</code> value only.
            <span class="since">since 0.9.3</span>
            NB, this may not be supported by all hypervisors.<br/>  <br/>
            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>
2878 2879 2880
          </dd>
          <dt><code>"spice"</code></dt>
          <dd>
E
Eric Blake 已提交
2881
            <p>
E
Eric Blake 已提交
2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894
              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 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>
2895 2896 2897 2898 2899 2900 2901 2902
              assumed to be in UTC. The <code>connected</code> attribute
              allows control of connected client during password changes.
              SPICE accepts <code>keep</code> to keep client connected,
              <code>disconnect</code> to disconnect client and
              <code>fail</code> to fail changing password.
              <span class="since">Since 0.9.3</span>
              NB, this may not be supported by all hypervisors.
              <span class="since">"spice" since 0.8.6</span>.
E
Eric Blake 已提交
2903 2904
            </p>
            <p>
E
Eric Blake 已提交
2905 2906 2907 2908 2909 2910 2911 2912 2913 2914
              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 <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 已提交
2915 2916
            </p>
            <pre>
2917 2918 2919
  &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;
2920
    &lt;image compression='auto_glz'/&gt;
2921
    &lt;streaming mode='filter'/&gt;
2922
    &lt;clipboard copypaste='no'/&gt;
P
Peng Zhou 已提交
2923
    &lt;mouse mode='client'/&gt;
2924
  &lt;/graphics&gt;</pre>
2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941
            <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>
2942 2943
            <p>
              Streaming mode is set by the <code>streaming</code>
Z
Zhou Peng 已提交
2944
              element, settings its <code>mode</code> attribute to one
2945 2946 2947
              of <code>filter</code>, <code>all</code>
              or <code>off</code>, <span class="since">since 0.9.2</span>.
            </p>
2948 2949 2950 2951 2952 2953 2954
            <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>.
2955
            </p>
P
Peng Zhou 已提交
2956
            <p>
Z
Zhou Peng 已提交
2957 2958
              Mouse mode is set by the <code>mouse</code> element,
              setting its <code>mode</code> attribute to one of
P
Peng Zhou 已提交
2959 2960 2961 2962
              <code>server</code> or <code>client</code> ,
              <span class="since">since 0.9.11</span>. If no mode is
              specified, the qemu default will be used (client mode).
            </p>
2963 2964 2965
          </dd>
          <dt><code>"rdp"</code></dt>
          <dd>
E
Eric Blake 已提交
2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977
            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.
2978 2979 2980
          </dd>
          <dt><code>"desktop"</code></dt>
          <dd>
E
Eric Blake 已提交
2981 2982 2983 2984 2985 2986
            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>.
2987 2988 2989 2990 2991
          </dd>
        </dl>
      </dd>
    </dl>

2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039
    <p>
      Rather than putting the address information used to set up the
      listening socket for graphics types <code>vnc</code>
      and <code>spice</code> in
      the <code>&lt;graphics&gt;</code> <code>listen</code> attribute,
      a separate subelement of <code>&lt;graphics&gt;</code>,
      called <code>&lt;listen&gt;</code> can be specified (see the
      examples above)<span class="since">since
      0.9.4</span>. <code>&lt;listen&gt;</code> accepts the following
      attributes:
    </p>
    <dl>
      <dt><code>type</code></dt>
      <dd>Set to either <code>address</code>
        or <code>network</code>. This tells whether this listen
        element is specifying the address to be used directly, or by
        naming a network (which will then be used to determine an
        appropriate address for listening).
      </dd>
    </dl>
    <dl>
      <dt><code>address</code></dt>
      <dd>if <code>type='address'</code>, the <code>address</code>
        attribute will contain either an IP address or hostname (which
        will be resolved to an IP address via a DNS query) to listen
        on. In the "live" XML of a running domain, this attribute will
        be set to the IP address used for listening, even
        if <code>type='network'</code>.
      </dd>
    </dl>
    <dl>
      <dt><code>network</code></dt>
      <dd>if <code>type='network'</code>, the <code>network</code>
        attribute will contain the name of a network in libvirt's list
        of configured networks. The named network configuration will
        be examined to determine an appropriate listen address. For
        example, if the network has an IPv4 address in its
        configuration (e.g. if it has a forward type
        of <code>route</code>, <code>nat</code>, or no forward type
        (isolated)), the first IPv4 address listed in the network's
        configuration will be used. If the network is describing a
        host bridge, the first IPv4 address associated with that
        bridge device will be used, and if the network is describing
        one of the 'direct' (macvtap) modes, the first IPv4 address of
        the first forward dev will be used.
      </dd>
    </dl>

3040 3041 3042 3043 3044
    <h4><a name="elementsVideo">Video devices</a></h4>
    <p>
      A video device.
    </p>

3045 3046 3047 3048 3049 3050 3051 3052 3053 3054
<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>
3055 3056 3057

    <dl>
      <dt><code>video</code></dt>
3058
      <dd>
3059 3060
        The <code>video</code> element is the container for describing
        video devices. For backwards compatibility, if no <code>video</code>
O
Osier Yang 已提交
3061 3062 3063 3064 3065
        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".
3066
      </dd>
3067

3068 3069 3070
      <dt><code>model</code></dt>
      <dd>
        The <code>model</code> element has a mandatory <code>type</code>
3071 3072 3073
        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.
3074 3075
        You can also provide the amount of video memory in kibibytes
        (blocks of 1024 bytes) using
3076 3077 3078 3079 3080 3081 3082 3083 3084
        <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 已提交
3085 3086 3087 3088 3089 3090

      <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 已提交
3091 3092
    </dl>

3093
    <h4><a name="elementsConsole">Consoles, serial, parallel &amp; channel devices</a></h4>
D
Daniel P. Berrange 已提交
3094 3095 3096

    <p>
      A character device provides a way to interact with the virtual machine.
3097 3098
      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 已提交
3099 3100
    </p>

3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121
<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 已提交
3122

3123 3124 3125 3126 3127
    <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 已提交
3128

3129 3130 3131 3132 3133 3134
    <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 已提交
3135 3136 3137 3138 3139 3140 3141 3142
    <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>

3143 3144 3145 3146 3147 3148 3149 3150 3151
    <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>

3152 3153 3154 3155 3156 3157 3158 3159 3160
<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>
3161 3162 3163

    <p>
      <code>target</code> can have a <code>port</code> attribute, which
3164
      specifies the port number. Ports are numbered starting from 0. There are
3165 3166 3167 3168 3169
      usually 0, 1 or 2 parallel ports.
    </p>

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

3170 3171 3172 3173 3174 3175 3176 3177 3178
<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>
3179 3180 3181

    <p>
      <code>target</code> can have a <code>port</code> attribute, which
3182
      specifies the port number. Ports are numbered starting from 0. There are
3183 3184 3185 3186 3187 3188
      usually 0, 1 or 2 serial ports.
    </p>

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

    <p>
3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210
      The console element is used to represent interactive consoles. Depending
      on the type of guest in use, the consoles might be paravirtualized devices,
      or they might be a clone of a serial device, according to the following
      rules:
    </p>

    <ul>
      <li>If no <code>targetType</code> attribue is set, then the default
        device type is according to the hypervisor's rules. The default
        type will be added when re-querying the XML fed into libvirt.
        For fully virtualized guests, the default device type will usually
        be a serial port.</li>
      <li>If the <code>targetType</code> attribute is <code>serial</code>,
        then if no <code>&lt;serial&gt;</code> element exists, the console
        element will be copied to the serial element. If a <code>&lt;serial&gt;</code>
        element does already exist, the console element will be ignored.</li>
      <li>If the <code>targetType</code> attribute is not <code>serial</code>,
        it will be treated normally.</li>
      <li>Only the first <code>console</code> element may use a <code>targetType</code>
        of <code>serial</code>. Secondary consoles must all be paravirtualized.
      </li>
    </ul>
C
Cole Robinson 已提交
3211 3212 3213 3214 3215 3216

    <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>
3217 3218
    </p>

3219 3220 3221 3222 3223 3224 3225
<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 已提交
3226 3227 3228 3229 3230 3231

    &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;
3232 3233
  &lt;/devices&gt;
  ...</pre>
3234 3235 3236 3237 3238 3239 3240

    <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>

3241 3242 3243 3244 3245 3246 3247
    <h6><a name="elementCharChannel">Channel</a></h6>

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

3248 3249 3250 3251 3252 3253 3254
<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;
3255 3256 3257 3258 3259

    &lt;!-- KVM virtio channel --&gt;
    &lt;channel type='pty'&gt;
      &lt;target type='virtio' name='arbitrary.virtio.serial.port.name'/&gt;
    &lt;/channel&gt;
D
Daniel P. Berrange 已提交
3260 3261 3262 3263
    &lt;channel type='unix'&gt;
      &lt;source mode='bind' path='/var/lib/libvirt/qemu/f16x86_64.agent'/&gt;
      &lt;target type='virtio' name='org.qemu.guest_agent.0'/&gt;
    &lt;/channel&gt;
3264 3265 3266
    &lt;channel type='spicevmc'&gt;
      &lt;target type='virtio' name='com.redhat.spice.0'/&gt;
    &lt;/channel&gt;
3267 3268
  &lt;/devices&gt;
  ...</pre>
3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282

    <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>
3283 3284 3285

      <dt><code>virtio</code></dt>
      <dd>Paravirtualized virtio channel. Channel is exposed in the guest under
E
Eric Blake 已提交
3286
        /dev/vport*, and if the optional element <code>name</code> is specified,
3287
        /dev/virtio-ports/$name (for more info, please see
E
Eric Blake 已提交
3288 3289
        <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
3290 3291
        particular <code>type='virtio-serial'</code>
        controller, <a href="#elementsAddress">documented above</a>.
D
Daniel P. Berrange 已提交
3292 3293 3294 3295 3296
        With qemu, if <code>name</code> is "org.qemu.guest_agent.0",
        then libvirt can interact with a guest agent installed in the
        guest, for actions such as guest shutdown or file system quiescing.
        <span class="since">Since 0.7.7, guest agent interaction
        since 0.9.10</span></dd>
3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310

      <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>
3311 3312
    </dl>

3313 3314 3315 3316 3317 3318
    <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 已提交
3319

3320
    <h6><a name="elementsCharSTDIO">Domain logfile</a></h6>
D
Daniel P. Berrange 已提交
3321 3322 3323 3324 3325 3326

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

3327 3328 3329 3330
<pre>
  ...
  &lt;devices&gt;
    &lt;console type='stdio'&gt;
E
Eric Blake 已提交
3331
      &lt;target port='1'/&gt;
3332 3333 3334
    &lt;/console&gt;
  &lt;/devices&gt;
  ...</pre>
D
Daniel P. Berrange 已提交
3335 3336


3337
    <h6><a name="elementsCharFle">Device logfile</a></h6>
D
Daniel P. Berrange 已提交
3338 3339 3340 3341 3342 3343

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

3344 3345 3346 3347 3348 3349 3350 3351 3352
<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 已提交
3353

3354
    <h6><a name="elementsCharVC">Virtual console</a></h6>
D
Daniel P. Berrange 已提交
3355 3356 3357 3358 3359 3360 3361

    <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>

3362 3363 3364 3365 3366 3367 3368 3369
<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 已提交
3370

3371
    <h6><a name="elementsCharNull">Null device</a></h6>
D
Daniel P. Berrange 已提交
3372 3373 3374 3375 3376 3377

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

3378 3379 3380 3381 3382 3383 3384 3385
<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 已提交
3386

3387
    <h6><a name="elementsCharPTY">Pseudo TTY</a></h6>
D
Daniel P. Berrange 已提交
3388 3389 3390 3391 3392 3393 3394

    <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>

3395 3396 3397 3398 3399 3400 3401 3402 3403
<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 已提交
3404 3405 3406

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

3412
    <h6><a name="elementsCharHost">Host device proxy</a></h6>
D
Daniel P. Berrange 已提交
3413 3414 3415 3416 3417

    <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 已提交
3418
      a host serial port - don't connect a serial port to a parallel
D
Daniel P. Berrange 已提交
3419 3420 3421
      port.
    </p>

3422 3423 3424 3425 3426 3427 3428 3429 3430
<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 已提交
3431

3432
    <h6><a name="elementsCharPipe">Named pipe</a></h6>
3433 3434 3435 3436 3437 3438

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

3439 3440 3441 3442 3443 3444 3445 3446 3447
<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>
3448

3449
    <h6><a name="elementsCharTCP">TCP client/server</a></h6>
D
Daniel P. Berrange 已提交
3450 3451 3452

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

3456 3457 3458 3459 3460 3461 3462 3463 3464 3465
<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>
3466 3467 3468 3469 3470

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

3471 3472 3473 3474 3475 3476 3477 3478 3479 3480
<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>
3481 3482

    <p>
E
Eric Blake 已提交
3483 3484 3485
      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>
3486
      (secure telnet) and <code>tls</code>.
E
Eric Blake 已提交
3487
    </p>
3488

3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504
<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 已提交
3505

3506
    <h6><a name="elementsCharUDP">UDP network console</a></h6>
D
Daniel P. Berrange 已提交
3507 3508 3509 3510 3511 3512

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

3513 3514 3515 3516 3517 3518 3519 3520 3521 3522
<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 已提交
3523

3524
    <h6><a name="elementsCharUNIX">UNIX domain socket client/server</a></h6>
D
Daniel P. Berrange 已提交
3525 3526 3527 3528 3529 3530

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

3531 3532 3533 3534 3535 3536 3537 3538 3539
<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 已提交
3540

3541 3542 3543 3544 3545 3546 3547 3548

    <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>

3549 3550 3551 3552 3553 3554
<pre>
  ...
  &lt;devices&gt;
    &lt;sound model='es1370'/&gt;
  &lt;/devices&gt;
  ...</pre>
3555 3556 3557 3558 3559 3560 3561

    <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
3562 3563 3564
        choices are 'es1370', 'sb16', 'ac97', and 'ich6'
        (<span class="since">
         'ac97' only since 0.6.0, 'ich6' only since 0.8.8</span>)
3565 3566 3567
      </dd>
    </dl>

E
Eric Blake 已提交
3568 3569 3570
    <p>
      Each <code>sound</code> element has an optional
      sub-element <code>&lt;address&gt;</code> which can tie the
3571 3572
      device to a particular PCI
      slot, <a href="#elementsAddress">documented above</a>.
E
Eric Blake 已提交
3573 3574
    </p>

R
Richard Jones 已提交
3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594
    <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>

3595 3596 3597 3598 3599 3600
<pre>
  ...
  &lt;devices&gt;
    &lt;watchdog model='i6300esb'/&gt;
  &lt;/devices&gt;
  ...</pre>
R
Richard Jones 已提交
3601

3602 3603 3604 3605 3606 3607
<pre>
  ...
  &lt;devices&gt;
    &lt;watchdog model='i6300esb' action='poweroff'/&gt;
  &lt;/devices&gt;
&lt;/domain&gt;</pre>
R
Richard Jones 已提交
3608 3609 3610 3611

    <dl>
      <dt><code>model</code></dt>
      <dd>
M
Matthew Booth 已提交
3612
        <p>
R
Richard Jones 已提交
3613
        The required <code>model</code> attribute specifies what real
M
Matthew Booth 已提交
3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624
        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 已提交
3625 3626 3627
      </dd>
      <dt><code>action</code></dt>
      <dd>
M
Matthew Booth 已提交
3628
        <p>
R
Richard Jones 已提交
3629
        The optional <code>action</code> attribute describes what
M
Matthew Booth 已提交
3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642
        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>
3643 3644
          <li>'dump' &mdash; automatically dump the guest
            <span class="since">Since 0.8.7</span></li>
M
Matthew Booth 已提交
3645 3646
        </ul>
        <p>
3647
        Note 1: the 'shutdown' action requires that the guest
M
Matthew Booth 已提交
3648 3649 3650 3651 3652
        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>
3653 3654 3655 3656
        <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 已提交
3657 3658 3659
      </dd>
    </dl>

3660 3661 3662 3663 3664 3665 3666 3667 3668
    <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>
3669 3670 3671
      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.
3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699
    </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 已提交
3700 3701
          of balloon device is provided. Valid values are specific to
          the virtualization platform
3702 3703 3704 3705 3706 3707 3708 3709
        </p>
        <ul>
          <li>'virtio' &mdash; default with QEMU/KVM</li>
          <li>'xen' &mdash; default with Xen</li>
        </ul>
      </dd>
    </dl>

3710 3711 3712 3713
    <h3><a name="seclabel">Security label</a></h3>

    <p>
      The <code>seclabel</code> element allows control over the
3714 3715 3716 3717 3718
      operation of the security drivers. There are three basic
      modes of operation, 'dynamic' where libvirt automatically
      generates a unique security label, 'static' where the
      application/administrator chooses the labels, or 'none'
      where confinement is disabled. With dynamic
3719 3720 3721 3722 3723
      label generation, libvirt will always automatically
      relabel any resources associated with the virtual machine.
      With static label assignment, by default, the administrator
      or application must ensure labels are set correctly on any
      resources, however, automatic relabeling can be enabled
3724 3725
      if desired.  <span class="since">'dynamic' since 0.6.1, 'static'
      since 0.6.2, and 'none' since 0.9.10.</span>
3726 3727 3728
    </p>

    <p>
3729
      Valid input XML configurations for the top-level security label
3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746
      are:
    </p>

    <pre>
  &lt;seclabel type='dynamic' model='selinux'/&gt;

  &lt;seclabel type='dynamic' model='selinux'&gt;
    &lt;baselabel&gt;system_u:system_r:my_svirt_t:s0&lt;/baselabel&gt;
  &lt;/seclabel&gt;

  &lt;seclabel type='static' model='selinux' relabel='no'&gt;
    &lt;label&gt;system_u:system_r:svirt_t:s0:c392,c662&lt;/label&gt;
  &lt;/seclabel&gt;

  &lt;seclabel type='static' model='selinux' relabel='yes'&gt;
    &lt;label&gt;system_u:system_r:svirt_t:s0:c392,c662&lt;/label&gt;
  &lt;/seclabel&gt;
3747 3748

  &lt;seclabel type='none'/&gt;
3749 3750
    </pre>

3751 3752 3753 3754 3755 3756 3757
    <p>
      If no 'type' attribute is provided in the input XML, then
      the security driver default setting will be used, which
      may be either 'none' or 'dynamic'. If a 'baselabel' is set
      but no 'type' is set, then the type is presumed to be 'dynamic'
    </p>

3758 3759 3760 3761 3762 3763 3764 3765 3766
    <p>
      When viewing the XML for a running guest with automatic
      resource relabeling active, an additional XML element,
      <code>imagelabel</code>, will be included. This is an
      output-only element, so will be ignored in user supplied
      XML documents
    </p>
    <dl>
      <dt><code>type</code></dt>
3767 3768 3769
      <dd>Either <code>static</code>, <code>dynamic</code> or <code>none</code>
        to determine whether libvirt automatically generates a unique security
        label or not.
3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796
      </dd>
      <dt><code>model</code></dt>
      <dd>A valid security model name, matching the currently
        activated security model
      </dd>
      <dt><code>relabel</code></dt>
      <dd>Either <code>yes</code> or <code>no</code>. This must always
        be <code>yes</code> if dynamic label assignment is used. With
        static label assignment it will default to <code>no</code>.
      </dd>
      <dt><code>label</code></dt>
      <dd>If static labelling is used, this must specify the full
        security label to assign to the virtual domain. The format
        of the content depends on the security driver in use
      </dd>
      <dt><code>baselabel</code></dt>
      <dd>If dynamic labelling is used, this can optionally be
        used to specify the base security label. The format
        of the content depends on the security driver in use
      </dd>
      <dt><code>imagelabel</code></dt>
      <dd>This is an output only element, which shows the
        security label used on resources associated with the virtual domain.
        The format of the content depends on the security driver in use
      </dd>
    </dl>

3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809
    <p>When relabeling is in effect, it is also possible to fine-tune
      the labeling done for specific source file names, by either
      disabling the labeling (useful if the file lives on NFS or other
      file system that lacks security labeling) or requesting an
      alternate label (useful when a management application creates a
      special label to allow sharing of some, but not all, resources
      between domains), <span class="since">since 0.9.9</span>.  When
      a <code>seclabel</code> element is attached to a specific path
      rather than the top-level domain assignment, only the
      attribute <code>relabel</code> or the
      sub-element <code>label</code> are supported.
    </p>

D
Daniel P. Berrange 已提交
3810
    <h2><a name="examples">Example configs</a></h2>
3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822

    <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>