Skip to content

L
libvirt

openeuler / libvirt

通知 3
Star 0
Fork 0
L
libvirt

体验新版 GitCode，发现更多精彩内容 >>

切换分支/标签
查找文件 普通视图历史永久链接Permalink
formatdomain.html.in 339.2 KB
Newer Older
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
1 
<?xml version="1.0" encoding="UTF-8"?>
D
docs: switch to using HTML5 doctype declaration  
Daniel P. Berrange 已提交
2 
<!DOCTYPE html>
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
3 
<html xmlns="http://www.w3.org/1999/xhtml">
D
Split website out into one file per page. APply new layout and styling  
Daniel P. Berrange 已提交
4 5 6 
  <body>
    <h1>Domain XML format</h1>
D
Update domain XML docs  
Daniel P. Berrange 已提交
7 8 9 10 11 12 13 14 15 16 
    <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>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
17 
    <h2><a id="elements">Element and attribute overview</a></h2>
D
Update domain XML docs  
Daniel P. Berrange 已提交
18 19 20 21 22 23 24 25 26 27 28 29 30 

    <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>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
31 
    <h3><a id="elementsMetadata">General metadata</a></h3>
D
Update domain XML docs  
Daniel P. Berrange 已提交
32
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
33 34 35 36 
<pre>
&lt;domain type='xen' id='3'&gt;
  &lt;name&gt;fv0&lt;/name&gt;
  &lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
P
xml: Add element <title> to allow short description of domains  
Peter Krempa 已提交
37 
  &lt;title&gt;A short description - title - of the domain&lt;/title&gt;
C
docs: domain: Document <description> element  
Cole Robinson 已提交
38 
  &lt;description&gt;Some human readable description&lt;/description&gt;
E
metadata: group metadata next to description  
Eric Blake 已提交
39 40 41 42 
  &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;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
43 
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
44 45 46 47 

    <dl>
      <dt><code>name</code></dt>
      <dd>The content of the <code>name</code> element provides
M
Cleanup whitespace in docs  
Matthew Booth 已提交
48 49 50 51 52 
        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
Update domain XML docs  
Daniel P. Berrange 已提交
53 54 
      <dt><code>uuid</code></dt>
      <dd>The content of the <code>uuid</code> element provides
M
Cleanup whitespace in docs  
Matthew Booth 已提交
55 
        a globally unique identifier for the virtual machine.
E
docs: minor whitespace cleanups  
Eric Blake 已提交
56 57 
        The format must be RFC 4122 compliant,
        eg <code>3e3fce45-4f53-4fa7-bb32-11f34168b82b</code>.
M
Cleanup whitespace in docs  
Matthew Booth 已提交
58 
        If omitted when defining/creating a new machine, a random
E
docs: document <sysinfo> and <smbios> elements  
Eric Blake 已提交
59 60 61 62 
        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>
C
docs: domain: Document <description> element  
Cole Robinson 已提交
63
P
xml: Add element <title> to allow short description of domains  
Peter Krempa 已提交
64 65 66 67 68 
      <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>
C
docs: domain: Document <description> element  
Cole Robinson 已提交
69 70 
      <dt><code>description</code></dt>
      <dd>The content of the <code>description</code> element provides a
E
metadata: group metadata next to description  
Eric Blake 已提交
71 72 73 74 75 76 77 78 79 80 81 82 
        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>
P
xml: Add element <title> to allow short description of domains  
Peter Krempa 已提交
83 
   </dl>
D
Update domain XML docs  
Daniel P. Berrange 已提交
84
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
85 
    <h3><a id="elementsOS">Operating system booting</a></h3>
D
Update domain XML docs  
Daniel P. Berrange 已提交
86 87 88 89 90 91 

    <p>
      There are a number of different ways to boot virtual machines
      each with their own pros and cons.
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
92 
    <h4><a id="elementsOSBIOS">BIOS bootloader</a></h4>
D
Update domain XML docs  
Daniel P. Berrange 已提交
93 94 95 96 97 98 99 100 

    <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>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
101 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
102 103 104 105 106 107 108 109 110 111 112 113 
...
&lt;os&gt;
  &lt;type&gt;hvm&lt;/type&gt;
  &lt;loader readonly='yes' secure='no' type='rom'&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
  &lt;nvram template='/usr/share/OVMF/OVMF_VARS.fd'&gt;/var/lib/libvirt/nvram/guest_VARS.fd&lt;/nvram&gt;
  &lt;boot dev='hd'/&gt;
  &lt;boot dev='cdrom'/&gt;
  &lt;bootmenu enable='yes' timeout='3000'/&gt;
  &lt;smbios mode='sysinfo'/&gt;
  &lt;bios useserial='yes' rebootTimeout='0'/&gt;
&lt;/os&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
114 115 116 117 

    <dl>
      <dt><code>type</code></dt>
      <dd>The content of the <code>type</code> element specifies the
M
Cleanup whitespace in docs  
Matthew Booth 已提交
118 119 120 121 122 
        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
docs: minor whitespace cleanups  
Eric Blake 已提交
123 124 125 126 127 
        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
Update domain XML docs  
Daniel P. Berrange 已提交
128 
      <dt><code>loader</code></dt>
E
doc: Add info (where necessary) that paths should be specified as absolute  
Erik Skultety 已提交
129 130 
      <dd>The optional <code>loader</code> tag refers to a firmware blob,
        which is specified by absolute path,
C
docs: update docs for setting the QEMU BIOS path  
Chen Hanxiao 已提交
131 132 133 
        used to assist the domain creation process. It is used by Xen
        fully virtualized domains as well as setting the QEMU BIOS file
        path for QEMU/KVM domains. <span class="since">Xen since 0.1.0,
M
conf: Extend <loader/> and introduce <nvram/>  
Michal Privoznik 已提交
134 135 136 137 138 139 140 141 142 
        QEMU/KVM since 0.9.12</span> Then, <span class="since">since
        1.2.8</span> it's possible for the element to have two
        optional attributes: <code>readonly</code> (accepted values are
        <code>yes</code> and <code>no</code>) to reflect the fact that the
        image should be writable or read-only. The second attribute
        <code>type</code> accepts values <code>rom</code> and
        <code>pflash</code>. It tells the hypervisor where in the guest
        memory the file should be mapped.  For instance, if the loader
        path points to an UEFI image, <code>type</code> should be
M
Introduce @secure attribute to os loader element  
Michal Privoznik 已提交
143 144 145 146 
        <code>pflash</code>. Moreover, some firmwares may
        implement the Secure boot feature. Attribute
        <code>secure</code> can be used then to control it.
        <span class="since">Since 2.1.0</span></dd>
M
conf: Extend <loader/> and introduce <nvram/>  
Michal Privoznik 已提交
147 148 
      <dt><code>nvram</code></dt>
      <dd>Some UEFI firmwares may want to use a non-volatile memory to store
E
doc: Add info (where necessary) that paths should be specified as absolute  
Erik Skultety 已提交
149 150 151 152 
        some variables. In the host, this is represented as a file and the
        absolute path to the file is stored in this element. Moreover, when the
        domain is started up libvirt copies so called master NVRAM store file
        defined in <code>qemu.conf</code>. If needed, the <code>template</code>
M
qemu: Automatically create NVRAM store  
Michal Privoznik 已提交
153 
        attribute can be used to per domain override map of master NVRAM stores
M
docs: Document NVRAM behavior on transient domains  
Michal Privoznik 已提交
154 155 156 157 
        from the config file. Note, that for transient domains if the NVRAM file
        has been created by libvirt it is left behind and it is management
        application's responsibility to save and remove file (if needed to be
        persistent). <span class="since">Since 1.2.8</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
158 159 
      <dt><code>boot</code></dt>
      <dd>The <code>dev</code> attribute takes one of the values "fd", "hd",
M
Cleanup whitespace in docs  
Matthew Booth 已提交
160 161 
        "cdrom" or "network" and is used to specify the next boot device
        to consider. The <code>boot</code> element can be repeated multiple
J
docs: Enhance documentation of the old-style boot configuration  
Jiri Denemark 已提交
162 163 164 165 166 167 168 169 170 171 172 173 
        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>,
J
Support booting from hostdev devices  
Jiri Denemark 已提交
174 
        <a href="#elementsNICS">network interfaces</a>, and
P
doc: Fix reference to #elementsUSB  
Philipp Hahn 已提交
175 
        <a href="#elementsHostDev">USB and PCI devices</a> sections below) were
J
docs: Enhance documentation of the old-style boot configuration  
Jiri Denemark 已提交
176 177 178 179 
        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
Update domain XML docs  
Daniel P. Berrange 已提交
180 
      </dd>
M
docs: Document some -boot option limitations on UEFI  
Michal Privoznik 已提交
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 
      <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
        SMBIOS values;
        the <a href="html/libvirt-libvirt-host.html#virConnectGetSysinfo">
        <code>virConnectGetSysinfo</code></a> call can be
        used to see what values are copied), or "sysinfo" (use the values in
        the <a href="#elementsSysinfo">sysinfo</a> element).  If not
        specified, the hypervisor default is used. <span class="since">
        Since 0.8.7</span>
      </dd>
  </dl>
      <p>Up till here the BIOS/UEFI configuration knobs are generic enough to
      be implemented by majority (if not all) firmwares out there. However,
      from now on not every single setting makes sense to all firmwares. For
      instance, <code>rebootTimeout</code> doesn't make sense for UEFI,
      <code>useserial</code> might not be usable with a BIOS firmware that
      doesn't produce any output onto serial line, etc. Moreover, firmwares
      don't usually export their capabilities for libvirt (or users) to check.
      And the set of their capabilities can change with every new release.
      Hence users are advised to try the settings they use before relying on
      them in production.</p>
  <dl>
C
qemu: Allow setting boot menu on/off  
Cole Robinson 已提交
206 207 208 209 210 
      <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>
M
docs, conf: add support for bootmenu timeout  
Martin Kletzander 已提交
211 212 
      Additional attribute <code>timeout</code> takes the number of milliseconds
      the boot menu should wait until it times out.  Allowed values are numbers
M
docs: fix bootmenu timeout description  
Martin Kletzander 已提交
213 214 
      in range [0, 65535] inclusive and it is ignored unless <code>enable</code>
      is set to "yes". <span class="since">Since 1.2.8</span>
C
qemu: Allow setting boot menu on/off  
Cole Robinson 已提交
215 
      </dd>
M
bios: Add support for SGA  
Michal Privoznik 已提交
216 217 218 219 220 221 
      <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.
M
Add support for reboot-timeout  
Martin Kletzander 已提交
222 223 224 225 226 227 228 
        <span class="since">Since 0.9.4</span>.
        <span class="since">Since 0.10.2 (QEMU only)</span> there is
        another attribute, <code>rebootTimeout</code> that controls
        whether and after how long the guest should start booting
        again in case the boot fails (according to BIOS). The value is
        in milliseconds with maximum of <code>65535</code> and special
        value <code>-1</code> disables the reboot.
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
229 
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
230 231 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
232 
    <h4><a id="elementsOSBootloader">Host bootloader</a></h4>
D
Update domain XML docs  
Daniel P. Berrange 已提交
233 234 235 236 

    <p>
      Hypervisors employing paravirtualization do not usually emulate
      a BIOS, and instead the host is responsible to kicking off the
A
fix typos in docs  
Atsushi SAKAI 已提交
237 
      operating system boot. This may use a pseudo-bootloader in the
D
Update domain XML docs  
Daniel P. Berrange 已提交
238 
      host to provide an interface to choose a kernel for the guest.
C
bhyve: Support /domain/bootloader configuration for non-FreeBSD guests.  
Conrad Meyer 已提交
239 240 241 
      An example is <code>pygrub</code> with Xen. The Bhyve hypervisor
      also uses a host bootloader, either <code>bhyveload</code> or
      <code>grub-bhyve</code>.
D
Update domain XML docs  
Daniel P. Berrange 已提交
242 243 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
244 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
245 246 247 248 
...
&lt;bootloader&gt;/usr/bin/pygrub&lt;/bootloader&gt;
&lt;bootloader_args&gt;--append single&lt;/bootloader_args&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
249 250 251 252 

    <dl>
      <dt><code>bootloader</code></dt>
      <dd>The content of the <code>bootloader</code> element provides
M
Cleanup whitespace in docs  
Matthew Booth 已提交
253 254 255 256 
        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
Update domain XML docs  
Daniel P. Berrange 已提交
257 258 
      <dt><code>bootloader_args</code></dt>
      <dd>The optional <code>bootloader_args</code> element allows
M
Cleanup whitespace in docs  
Matthew Booth 已提交
259 260 261 
        command line arguments to be passed to the bootloader.
        <span class="since">Since 0.2.3</span>
        </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
262 263 264 

    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
265 
    <h4><a id="elementsOSKernel">Direct kernel boot</a></h4>
D
Update domain XML docs  
Daniel P. Berrange 已提交
266 267 268 269 270 271 272 273 

    <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>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
274 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
275 276 277 278 279 280 281 282 283 284 285 286 287 
...
&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;dtb&gt;/root/ppc.dtb&lt;/dtb&gt;
  &lt;acpi&gt;
    &lt;table type='slic'&gt;/path/to/slic.dat&lt;/table&gt;
  &lt;/acpi&gt;
&lt;/os&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
288 289 290 291 

    <dl>
      <dt><code>type</code></dt>
      <dd>This element has the same semantics as described earlier in the
M
Cleanup whitespace in docs  
Matthew Booth 已提交
292 
        <a href="#elementsOSBIOS">BIOS boot section</a></dd>
D
"copy-paste" errors  
Daniel Veillard 已提交
293 
      <dt><code>loader</code></dt>
D
Update domain XML docs  
Daniel P. Berrange 已提交
294 
      <dd>This element has the same semantics as described earlier in the
M
Cleanup whitespace in docs  
Matthew Booth 已提交
295 
        <a href="#elementsOSBIOS">BIOS boot section</a></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
296 297 
      <dt><code>kernel</code></dt>
      <dd>The contents of this element specify the fully-qualified path
M
Cleanup whitespace in docs  
Matthew Booth 已提交
298 
        to the kernel image in the host OS.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
299 300 
      <dt><code>initrd</code></dt>
      <dd>The contents of this element specify the fully-qualified path
M
Cleanup whitespace in docs  
Matthew Booth 已提交
301 
        to the (optional) ramdisk image in the host OS.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
302 303 
      <dt><code>cmdline</code></dt>
      <dd>The contents of this element specify arguments to be passed to
O
docs, comments: minor typo fixes  
Oskari Saarenmaa 已提交
304 
        the kernel (or installer) at boot time. This is often used to
M
Cleanup whitespace in docs  
Matthew Booth 已提交
305 306 
        specify an alternate primary console (eg serial port), or the
        installation media source / kickstart file</dd>
O
conf: support <dtb> tag in XML domain file  
Olivia Yin 已提交
307 308 309 310 
      <dt><code>dtb</code></dt>
      <dd>The contents of this element specify the fully-qualified path
        to the (optional) device tree binary (dtb) image in the host OS.
        <span class="since">Since 1.0.4</span></dd>
J
conf: add <acpi><table> to <os>  
Ján Tomko 已提交
311 312 313 314 315 
      <dt><code>acpi</code></dt>
      <dd>The <code>table</code> element contains a fully-qualified path
        to the ACPI table. The <code>type</code> attribute contains the
        ACPI table type (currently only <code>slic</code> is supported)
        <span class="since">Since 1.3.5 (QEMU only)</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
316 317 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
318 
    <h4><a id="elementsOSContainer">Container boot</a></h4>
D
Add support for setting init argv for LXC  
Daniel P. Berrange 已提交
319 320 321 322 323 324 325 326 

    <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>
C
docs: fix a typo in formatdomain  
Chen Hanxiao 已提交
327 
      but will not affect init argv.
D
Add support for setting init argv for LXC  
Daniel P. Berrange 已提交
328 
    </p>
C
lxc: allow defining environment variables  
Cédric Bosdonnat 已提交
329 330 331 332 
    <p>
      To set environment variables, use the <code>initenv</code> element, one
      for each variable.
    </p>
C
lxc: allow user to specify command working directory  
Cédric Bosdonnat 已提交
333 334 335 336 
    <p>
      To set a custom work directory for the init, use the <code>initdir</code>
      element.
    </p>
C
lxc: add possibility to define init uid/gid  
Cédric Bosdonnat 已提交
337 338 339 340 341 342 343 
    <p>
      To run the init command as a given user or group, use the <code>inituser</code>
      or <code>initgroup</code> elements respectively. Both elements can be provided
      either a user (resp. group) id or a name. Prefixing the user or group id with
      a <code>+</code> will force it to be considered like a numeric value. Without
      this, it will be first tried as a user or group name.
    </p>
D
Add support for setting init argv for LXC  
Daniel P. Berrange 已提交
344 345 

    <pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
346 347 348 349 350 
&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;
C
lxc: allow defining environment variables  
Cédric Bosdonnat 已提交
351 
  &lt;initenv name='MYENV'&gt;some value&lt;/initenv&gt;
C
lxc: allow user to specify command working directory  
Cédric Bosdonnat 已提交
352 
  &lt;initdir&gt;/my/custom/cwd&lt;/initdir&gt;
C
lxc: add possibility to define init uid/gid  
Cédric Bosdonnat 已提交
353 354 
  &lt;inituser&gt;tester&lt;/inituser&gt;
  &lt;initgroup&gt;1000&lt;/initgroup&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
355 
&lt;/os&gt;
D
Add support for setting init argv for LXC  
Daniel P. Berrange 已提交
356 357 358 
    </pre>
G
LXC: Introduce New XML element for user namespace  
Gao feng 已提交
359 
    <p>
C
docs: grammar fixes in formatdomain  
Chen Hanxiao 已提交
360 361 
      If you want to enable user namespace, set the <code>idmap</code> element.
      The <code>uid</code> and <code>gid</code> elements have three attributes:
G
LXC: Introduce New XML element for user namespace  
Gao feng 已提交
362 363 364 365 
    </p>

    <dl>
      <dt><code>start</code></dt>
C
LXC: emphasis uid start of idmap only accept '0' in docs  
Chen Hanxiao 已提交
366 
      <dd>First user ID in container. It must be '0'.</dd>
G
LXC: Introduce New XML element for user namespace  
Gao feng 已提交
367 
      <dt><code>target</code></dt>
C
docs: grammar fixes in formatdomain  
Chen Hanxiao 已提交
368 369 
      <dd>The first user ID in container will be mapped to this target user
          ID in host.</dd>
G
LXC: Introduce New XML element for user namespace  
Gao feng 已提交
370 
      <dt><code>count</code></dt>
C
docs: grammar fixes in formatdomain  
Chen Hanxiao 已提交
371 
      <dd>How many users in container are allowed to map to host's user.</dd>
G
LXC: Introduce New XML element for user namespace  
Gao feng 已提交
372 373 374 
    </dl>

    <pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
375 376 377 378 
&lt;idmap&gt;
  &lt;uid start='0' target='1000' count='10'/&gt;
  &lt;gid start='0' target='1000' count='10'/&gt;
&lt;/idmap&gt;
G
LXC: Introduce New XML element for user namespace  
Gao feng 已提交
379 380 381 
    </pre>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
382 
    <h3><a id="elementsSysinfo">SMBIOS System Information</a></h3>
E
docs: document <sysinfo> and <smbios> elements  
Eric Blake 已提交
383 384 385 386 387 388 389 390 391 392 393 

    <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>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
394 395 396 
...
&lt;os&gt;
  &lt;smbios mode='sysinfo'/&gt;
E
docs: document <sysinfo> and <smbios> elements  
Eric Blake 已提交
397 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 
&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='product'&gt;Virt-Manager&lt;/entry&gt;
    &lt;entry name='version'&gt;0.9.4&lt;/entry&gt;
  &lt;/system&gt;
  &lt;baseBoard&gt;
    &lt;entry name='manufacturer'&gt;LENOVO&lt;/entry&gt;
    &lt;entry name='product'&gt;20BE0061MC&lt;/entry&gt;
    &lt;entry name='version'&gt;0B98401 Pro&lt;/entry&gt;
    &lt;entry name='serial'&gt;W1KS427111E&lt;/entry&gt;
  &lt;/baseBoard&gt;
Z
conf: Add support for setting Chassis SMBIOS data fields  
Zhuang Yanying 已提交
414 415 416 417 418 419 420 
  &lt;chassis&gt;
    &lt;entry name='manufacturer'&gt;Dell Inc.&lt;/entry&gt;
    &lt;entry name='version'&gt;2.12&lt;/entry&gt;
    &lt;entry name='serial'&gt;65X0XF2&lt;/entry&gt;
    &lt;entry name='asset'&gt;40000101&lt;/entry&gt;
    &lt;entry name='sku'&gt;Type3Sku1&lt;/entry&gt;
  &lt;/chassis&gt;
D
conf: add support for setting OEM strings SMBIOS data fields  
Daniel P. Berrange 已提交
421 422 423 424 
  &lt;oemStrings&gt;
    &lt;entry&gt;myappname:some arbitrary data&lt;/entry&gt;
    &lt;entry&gt;otherappname:more arbitrary data&lt;/entry&gt;
  &lt;/oemStrings&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
425 426 
&lt;/sysinfo&gt;
...</pre>
E
docs: document <sysinfo> and <smbios> elements  
Eric Blake 已提交
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 

    <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>
J
docs: Fix/update syntax in Sysinfo/SMBIOS description  
John Ferlan 已提交
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 
            This is block 0 of SMBIOS, with entry names drawn from:
            <dl>
               <dt><code>vendor</code></dt>
               <dd>BIOS Vendor's Name</dd>
               <dt><code>version</code></dt>
               <dd>BIOS Version</dd>
               <dt><code>date</code></dt>
               <dd>BIOS release date. If supplied, is in either mm/dd/yy or
                   mm/dd/yyyy format. If the year portion of the string is
                   two digits, the year is assumed to be 19yy.</dd>
               <dt><code>release</code></dt>
               <dd>System BIOS Major and Minor release number values
                   concatenated together as one string separated by
                   a period, for example, 10.22.</dd>
           </dl>
E
docs: document <sysinfo> and <smbios> elements  
Eric Blake 已提交
462 463 464 
          </dd>
          <dt><code>system</code></dt>
          <dd>
J
docs: Fix/update syntax in Sysinfo/SMBIOS description  
John Ferlan 已提交
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 
            This is block 1 of SMBIOS, with entry names drawn from:
            <dl>
                <dt><code>manufacturer</code></dt>
                <dd>Manufacturer of BIOS</dd>
                <dt><code>product</code></dt>
                <dd>Product Name</dd>
                <dt><code>version</code></dt>
                <dd>Version of the product</dd>
                <dt><code>serial</code></dt>
                <dd>Serial number</dd>
                <dt><code>uuid</code></dt>
                <dd>Universal Unique ID number. If this entry is provided
                alongside a top-level
                <a href="#elementsMetadata"><code>uuid</code></a> element,
                then the two values must match.</dd>
                <dt><code>sku</code></dt>
                <dd>SKU number to identify a particular configuration.</dd>
                <dt><code>family</code></dt>
                <dd>Identify the family a particular computer belongs to.</dd>
            </dl>
M
virSysinfo: Introduce SMBIOS type 2 support  
Michal Privoznik 已提交
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 
          </dd>
          <dt><code>baseBoard</code></dt>
          <dd>
            This is block 2 of SMBIOS. This element can be repeated multiple
            times to describe all the base boards; however, not all
            hypervisors necessarily support the repetition. The element can
            have the following children:
            <dl>
                <dt><code>manufacturer</code></dt>
                <dd>Manufacturer of BIOS</dd>
                <dt><code>product</code></dt>
                <dd>Product Name</dd>
                <dt><code>version</code></dt>
                <dd>Version of the product</dd>
                <dt><code>serial</code></dt>
                <dd>Serial number</dd>
                <dt><code>asset</code></dt>
                <dd>Asset tag</dd>
                <dt><code>location</code></dt>
                <dd>Location in chassis</dd>
            </dl>
            NB: Incorrectly supplied entries for the
            <code>bios</code>, <code>system</code> or <code>baseBoard</code>
            blocks will be ignored without error.  Other than <code>uuid</code>
            validation and <code>date</code> format checking, all values are
            passed as strings to the hypervisor driver.
E
docs: document <sysinfo> and <smbios> elements  
Eric Blake 已提交
511 
          </dd>
Z
conf: Add support for setting Chassis SMBIOS data fields  
Zhuang Yanying 已提交
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 
          <dt><code>chassis</code></dt>
          <dd>
            <span class="since">Since 4.1.0,</span> this is block 3 of
            SMBIOS, with entry names drawn from:
            <dl>
                <dt><code>manufacturer</code></dt>
                <dd>Manufacturer of Chassis</dd>
                <dt><code>version</code></dt>
                <dd>Version of the Chassis</dd>
                <dt><code>serial</code></dt>
                <dd>Serial number</dd>
                <dt><code>asset</code></dt>
                <dd>Asset tag</dd>
                <dt><code>sku</code></dt>
                <dd>SKU number</dd>
            </dl>
          </dd>
D
conf: add support for setting OEM strings SMBIOS data fields  
Daniel P. Berrange 已提交
529 530 531 532 533 534 535 536 537 
          <dt><code>oemStrings</code></dt>
          <dd>
            This is block 11 of SMBIOS. This element should appear once and
            can have multiple <code>entry</code> child elements, each providing
            arbitrary string data. There are no restrictions on what data can
            be provided in the entries, however, if the data is intended to be
            consumed by an application in the guest, it is recommended to use
            the application name as a prefix in the string. (<span class="since">Since 4.1.0</span>)
          </dd>
E
docs: document <sysinfo> and <smbios> elements  
Eric Blake 已提交
538 539 540 541 
        </dl>
      </dd>
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
542 
    <h3><a id="elementsCPUAllocation">CPU Allocation</a></h3>
D
Update domain XML docs  
Daniel P. Berrange 已提交
543
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
544 
<pre>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
545 
&lt;domain&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
546 
  ...
O
qemu: Support numad  
Osier Yang 已提交
547 
  &lt;vcpu placement='static' cpuset="1-4,^3,6" current="1"&gt;2&lt;/vcpu&gt;
P
conf: Add XML for individual vCPU hotplug  
Peter Krempa 已提交
548 549 550 551 
  &lt;vcpus&gt;
    &lt;vcpu id='0' enabled='yes' hotpluggable='no' order='1'/&gt;
    &lt;vcpu id='1' enabled='no' hotpluggable='yes'/&gt;
  &lt;/vcpus&gt;
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
552 553 554 
  ...
&lt;/domain&gt;
</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
555 556 557 

    <dl>
      <dt><code>vcpu</code></dt>
E
vcpu: add current attribute to <vcpu> element  
Eric Blake 已提交
558 
      <dd>The content of this element defines the maximum number of virtual
E
vcpu: improve cpuset attribute  
Eric Blake 已提交
559 
        CPUs allocated for the guest OS, which must be between 1 and
J
formatdomain: Reformat vCPU description  
John Ferlan 已提交
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 
        the maximum supported by the hypervisor.
        <dl>
         <dt><code>cpuset</code></dt>
         <dd>
           The optional attribute <code>cpuset</code> is a comma-separated
           list of physical CPU numbers that domain process and virtual CPUs
           can be pinned to by default. (NB: The pinning policy of domain
           process and virtual CPUs can be specified separately by
           <code>cputune</code>. If the attribute <code>emulatorpin</code>
           of <code>cputune</code> is specified, the <code>cpuset</code>
           specified by <code>vcpu</code> here will be ignored. Similarly,
           for virtual CPUs which have the <code>vcpupin</code> specified,
           the <code>cpuset</code> specified by <code>cpuset</code> here
           will be ignored. For virtual CPUs which don't have
           <code>vcpupin</code> specified, each will be pinned to the physical
           CPUs specified by <code>cpuset</code> here).
           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
           be excluded from a previous range.
           <span class="since">Since 0.4.4</span>
         </dd>
         <dt><code>current</code></dt>
         <dd>
           The optional attribute <code>current</code> can
           be used to specify whether fewer than the maximum number of
           virtual CPUs should be enabled.
           <span class="since">Since 0.8.5</span>
         </dd>
         <dt><code>placement</code></dt>
         <dd>
           The optional attribute <code>placement</code> can be used to
           indicate the CPU placement mode for domain process. The value can
           be either "static" or "auto", but defaults to <code>placement</code>
           of <code>numatune</code> or "static" if <code>cpuset</code> is
           specified. Using "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 ignored 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.
           <span class="since">Since 0.9.11 (QEMU and KVM only)</span>
         </dd>
        </dl>
E
vcpu: improve cpuset attribute  
Eric Blake 已提交
604 
      </dd>
P
conf: Add XML for individual vCPU hotplug  
Peter Krempa 已提交
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 
      <dt><code>vcpus</code></dt>
      <dd>
        The vcpus element allows to control state of individual vcpus.

        The <code>id</code> attribute specifies the vCPU id as used by libvirt
        in other places such as vcpu pinning, scheduler information and NUMA
        assignment. Note that the vcpu ID as seen in the guest may differ from
        libvirt ID in certain cases. Valid IDs are from 0 to the maximum vcpu
        count as set by the <code>vcpu</code> element minus 1.

        The <code>enabled</code> attribute allows to control the state of the
        vcpu. Valid values are <code>yes</code> and <code>no</code>.

        <code>hotpluggable</code> controls whether given vcpu can be hotplugged
        and hotunplugged in cases when the cpu is enabled at boot. Note that
        all disabled vcpus must be hotpluggable. Valid values are
        <code>yes</code> and <code>no</code>.
P
doc: clarify documentation for vcpu order  
Peter Krempa 已提交
623 624 
        <code>order</code> allows to specify the order to add the online vcpus.
        For hypervisors/platforms that require to insert multiple vcpus at once
Y
Fix minor typos  
Yuri Chornoivan 已提交
625 
        the order may be duplicated accross all vcpus that need to be
P
conf: Add XML for individual vCPU hotplug  
Peter Krempa 已提交
626 
        enabled at once. Specifying order is not necessary, vcpus are then
P
doc: clarify documentation for vcpu order  
Peter Krempa 已提交
627 
        added in an arbitrary order. If order info is used, it must be used for
P
qemu: vcpu: Clear vcpu order information rather than making it invalid  
Peter Krempa 已提交
628 629 
        all online vcpus. Hypervisors may clear or update ordering information
        during certain operations to assure valid configuration.
P
conf: Add XML for individual vCPU hotplug  
Peter Krempa 已提交
630 631 632 633 634 635 636 637 638 639 640 

        Note that hypervisors may create hotpluggable vcpus differently from
        boot vcpus thus special initialization may be necessary.

        Hypervisors may require that vcpus enabled on boot which are not
        hotpluggable are clustered at the beginning starting with ID 0. It may
        be also required that vcpu 0 is always present and non-hotpluggable.

        Note that providing state for individual cpus may be necessary to enable
        support of addressable vCPU hotplug and this feature may not be
        supported by all hypervisors.
P
qemu: command: Add support for sparse vcpu topologies  
Peter Krempa 已提交
641 642 643 644 645 

        For QEMU the following conditions are required. Vcpu 0 needs to be
        enabled and non-hotpluggable. On PPC64 along with it vcpus that are in
        the same core need to be enabled as well. All non-hotpluggable cpus
        present at boot need to be grouped after vcpu 0.
P
conf: Add XML for individual vCPU hotplug  
Peter Krempa 已提交
646 647 
        <span class="since">Since 2.2.0 (QEMU only)</span>
      </dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
648 649 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
650 
    <h3><a id="elementsIOThreadsAllocation">IOThreads Allocation</a></h3>
J
domain_conf: Introduce iothreads XML  
John Ferlan 已提交
651 652 653 654 655 656 657 658 659 660 661 662 663 
      <p>
        IOThreads are dedicated event loop threads for supported disk
        devices to perform block I/O requests in order to improve
        scalability especially on an SMP host/guest with many LUNs.
        <span class="since">Since 1.2.8 (QEMU only)</span>
      </p>

<pre>
&lt;domain&gt;
  ...
  &lt;iothreads&gt;4&lt;/iothreads&gt;
  ...
&lt;/domain&gt;
J
conf: Add new domain XML element 'iothreadids'  
John Ferlan 已提交
664 665 666 667 668 669 670 671 672 673 674 675 
</pre>
<pre>
&lt;domain&gt;
  ...
  &lt;iothreadids&gt;
    &lt;iothread id="2"/&gt;
    &lt;iothread id="4"/&gt;
    &lt;iothread id="6"/&gt;
    &lt;iothread id="8"/&gt;
  &lt;/iothreadids&gt;
  ...
&lt;/domain&gt;
J
domain_conf: Introduce iothreads XML  
John Ferlan 已提交
676 677 678 679 680 681 682 
</pre>

    <dl>
      <dt><code>iothreads</code></dt>
      <dd>
        The content of this optional element defines the number
        of IOThreads to be assigned to the domain for use by
J
docs: clarify disk iothread support  
John Ferlan 已提交
683 
        supported target storage devices. There
B
qemu: Allow use of iothreads for virtio ccw disk definitions  
Boris Fiuczynski 已提交
684 685 
        should be only 1 or 2 IOThreads per host CPU. There may be more
        than one supported device assigned to each IOThread.
J
conf: Add new domain XML element 'iothreadids'  
John Ferlan 已提交
686 
        <span class="since">Since 1.2.8</span>
J
domain_conf: Introduce iothreads XML  
John Ferlan 已提交
687 
      </dd>
J
conf: Add new domain XML element 'iothreadids'  
John Ferlan 已提交
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 
      <dt><code>iothreadids</code></dt>
      <dd>
        The optional <code>iothreadids</code> element provides the capability
        to specifically define the IOThread ID's for the domain.  By default,
        IOThread ID's are sequentially numbered starting from 1 through the
        number of <code>iothreads</code> defined for the domain. The
        <code>id</code> attribute is used to define the IOThread ID. The
        <code>id</code> attribute must be a positive integer greater than 0.
        If there are less <code>iothreadids</code> defined than
        <code>iothreads</code> defined for the domain, then libvirt will
        sequentially fill <code>iothreadids</code> starting at 1 avoiding
        any predefined <code>id</code>. If there are more
        <code>iothreadids</code> defined than <code>iothreads</code>
        defined for the domain, then the <code>iothreads</code> value
        will be adjusted accordingly.
        <span class="since">Since 1.2.15</span>
       </dd>
J
domain_conf: Introduce iothreads XML  
John Ferlan 已提交
705 
    </dl>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
706
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
707 
    <h3><a id="elementsCPUTuning">CPU Tuning</a></h3>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
708 709 710 711 712 713 714 715 716 

<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;
J
docs: Fix typo in CPU tuning  
Jiri Denemark 已提交
717 
    &lt;emulatorpin cpuset="1-3"/&gt;
J
domain_conf: Add iothreadpin to cputune  
John Ferlan 已提交
718 719 
    &lt;iothreadpin iothread="1" cpuset="5,6"/&gt;
    &lt;iothreadpin iothread="2" cpuset="7,8"/&gt;
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
720 721 722 
    &lt;shares&gt;2048&lt;/shares&gt;
    &lt;period&gt;1000000&lt;/period&gt;
    &lt;quota&gt;-1&lt;/quota&gt;
P
doc: Fix emulator pinning example in formatdomain.html  
Peter Krempa 已提交
723 724 
    &lt;emulator_period&gt;1000000&lt;/emulator_period&gt;
    &lt;emulator_quota&gt;-1&lt;/emulator_quota&gt;
J
conf: Add IOThread quota and period scheduler/cputune defs  
John Ferlan 已提交
725 726 
    &lt;iothread_period&gt;1000000&lt;/iothread_period&gt;
    &lt;iothread_quota&gt;-1&lt;/iothread_quota&gt;
M
docs, schema, conf: Add support for setting scheduler parameters of guest threads  
Martin Kletzander 已提交
727 728 
    &lt;vcpusched vcpus='0-4,^3' scheduler='fifo' priority='1'/&gt;
    &lt;iothreadsched iothreads='2' scheduler='batch'/&gt;
M
conf: Add support for cputune/cachetune  
Martin Kletzander 已提交
729 730 731 732 
    &lt;cachetune vcpus='0-3'&gt;
      &lt;cache id='0' level='3' type='both' size='3' unit='MiB'/&gt;
      &lt;cache id='1' level='3' type='both' size='3' unit='MiB'/&gt;
    &lt;/cachetune&gt;
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
733 734 735 736 737 738 
  &lt;/cputune&gt;
  ...
&lt;/domain&gt;
</pre>

    <dl>
O
cputune: Add document for cputune XML  
Osier Yang 已提交
739 
      <dt><code>cputune</code></dt>
O
docs: Fix documentation for cputune parameters  
Osier Yang 已提交
740 741 742 743 744 
      <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>
O
cputune: Add document for cputune XML  
Osier Yang 已提交
745 
      <dt><code>vcpupin</code></dt>
O
docs: Fix documentation for cputune parameters  
Osier Yang 已提交
746 
      <dd>
M
docs: CPU allocation and pinning clarification  
Martin Kletzander 已提交
747 
        The optional <code>vcpupin</code> element specifies which of host's
O
doc: Sort out the relationship between <vcpu>, <vcpupin>, and <emulatorpin>  
Osier Yang 已提交
748 749 750 751 752 753 754 
        physical CPUs the domain VCPU will be pinned to. If this is omitted,
        and attribute <code>cpuset</code> of element <code>vcpu</code> is
        not specified, the vCPU is pinned to all the physical CPUs by default.
        It contains two required attributes, the attribute <code>vcpu</code>
        specifies vcpu id, and the attribute <code>cpuset</code> is same as
        attribute <code>cpuset</code> of element <code>vcpu</code>.
        (NB: Only qemu driver support)
O
docs: Fix documentation for cputune parameters  
Osier Yang 已提交
755 756 
        <span class="since">Since 0.9.0</span>
       </dd>
T
Support emulatorpin xml parse.  
Tang Chen 已提交
757 758 759 
       <dt><code>emulatorpin</code></dt>
       <dd>
         The optional <code>emulatorpin</code> element specifies which of host
M
conf: Don't mangle vcpu placement randomly  
Michal Privoznik 已提交
760 761 
         physical CPUs the "emulator", a subset of a domain not including vcpu
         or iothreads will be pinned to. If this is omitted, and attribute
O
doc: Sort out the relationship between <vcpu>, <vcpupin>, and <emulatorpin>  
Osier Yang 已提交
762 763 764 
         <code>cpuset</code> of element <code>vcpu</code> is not specified,
         "emulator" is pinned to all the physical CPUs by default. It contains
         one required attribute <code>cpuset</code> specifying which physical
M
conf: Don't mangle vcpu placement randomly  
Michal Privoznik 已提交
765 
         CPUs to pin to.
T
Support emulatorpin xml parse.  
Tang Chen 已提交
766 
       </dd>
J
domain_conf: Add iothreadpin to cputune  
John Ferlan 已提交
767 768 769 770 771 772 773 
       <dt><code>iothreadpin</code></dt>
       <dd>
         The optional <code>iothreadpin</code> element specifies which of host
         physical CPUs the IOThreads will be pinned to. If this is omitted
         and attribute <code>cpuset</code> of element <code>vcpu</code> is
         not specified, the IOThreads are pinned to all the physical CPUs
         by default. There are two required attributes, the attribute
J
Move iothreadspin information into iothreadids  
John Ferlan 已提交
774 775 776 777 778 
         <code>iothread</code> specifies the IOThread ID and the attribute
         <code>cpuset</code> specifying which physical CPUs to pin to. See
         the <code>iothreadids</code>
         <a href="#elementsIOThreadsAllocation"><code>description</code></a>
         for valid <code>iothread</code> values.
J
domain_conf: Add iothreadpin to cputune  
John Ferlan 已提交
779 780 
        <span class="since">Since 1.2.9</span>
       </dd>
O
cputune: Add document for cputune XML  
Osier Yang 已提交
781 
      <dt><code>shares</code></dt>
O
docs: Fix documentation for cputune parameters  
Osier Yang 已提交
782 783 
      <dd>
        The optional <code>shares</code> element specifies the proportional
C
docs: fix 'omitted' typo in <cputune> doc  
Christophe Fergeau 已提交
784 
        weighted share for the domain. If this is omitted, it defaults to
E
docs: minor whitespace cleanups  
Eric Blake 已提交
785 786 787 
        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
O
docs: Fix documentation for cputune parameters  
Osier Yang 已提交
788 789 790 
        2048 will get twice as much CPU time as a VM configured with value 1024.
        <span class="since">Since 0.9.0</span>
      </dd>
W
doc: Add documentation for new cputune elements period and quota  
Wen Congyang 已提交
791 792 793 794 795 796 
      <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
S
Update documentation for CPU quota/period support for LXC  
Sukadev Bhattiprolu 已提交
797 798 799 
        with value 0 means no value.
        <span class="since">Only QEMU driver support since 0.9.4, LXC since
        0.9.10</span>
W
doc: Add documentation for new cputune elements period and quota  
Wen Congyang 已提交
800 801 802 803 804 805 806 807 808 
      </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
S
Update documentation for CPU quota/period support for LXC  
Sukadev Bhattiprolu 已提交
809 810 811 
        speed.
        <span class="since">Only QEMU driver support since 0.9.4, LXC since
        0.9.10</span>
W
doc: Add documentation for new cputune elements period and quota  
Wen Congyang 已提交
812 
      </dd>
H
qemu: introduce period/quota tuning for emulator  
Hu Tao 已提交
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 

      <dt><code>emulator_period</code></dt>
      <dd>
        The optional <code>emulator_period</code> element specifies the enforcement
        interval(unit: microseconds). Within <code>emulator_period</code>, emulator
        threads(those excluding vcpus) of the domain will not be allowed to consume
        more than <code>emulator_quota</code> worth of runtime. The value should be
        in range [1000, 1000000]. A period with value 0 means no value.
        <span class="since">Only QEMU driver support since 0.10.0</span>
      </dd>
      <dt><code>emulator_quota</code></dt>
      <dd>
        The optional <code>emulator_quota</code> element specifies the maximum
        allowed bandwidth(unit: microseconds) for domain's emulator threads(those
        excluding vcpus). A domain with <code>emulator_quota</code> as any negative
        value indicates that the domain has infinite bandwidth for emulator threads
        (those excluding vcpus), 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.
        <span class="since">Only QEMU driver support since 0.10.0</span>
      </dd>
J
conf: Add IOThread quota and period scheduler/cputune defs  
John Ferlan 已提交
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 
      <dt><code>iothread_period</code></dt>
      <dd>
        The optional <code>iothread_period</code> element specifies the
        enforcement interval(unit: microseconds) for IOThreads. Within
        <code>iothread_period</code>, each IOThread of the domain will
        not be allowed to consume more than <code>iothread_quota</code>
        worth of runtime. The value should be in range [1000, 1000000].
        An iothread_period with value 0 means no value.
        <span class="since">Only QEMU driver support since 2.1.0</span>
      </dd>
      <dt><code>iothread_quota</code></dt>
      <dd>
        The optional <code>iothread_quota</code> element specifies the maximum
        allowed bandwidth(unit: microseconds) for IOThreads. A domain with
        <code>iothread_quota</code> as any negative value indicates that the
        domain IOThreads have infinite bandwidth, which means that it is
        not bandwidth controlled. The value should be in range
        [1000, 18446744073709551] or less than 0. An <code>iothread_quota</code>
        with value 0 means no value. You can use this feature to ensure that
        all IOThreads run at the same speed.
        <span class="since">Only QEMU driver support since 2.1.0</span>
      </dd>
M
docs, schema, conf: Add support for setting scheduler parameters of guest threads  
Martin Kletzander 已提交
858 859 860 861 862 863 
      <dt><code>vcpusched</code> and <code>iothreadsched</code></dt>
      <dd>
        The optional <code>vcpusched</code> elements specifies the scheduler
        type (values <code>batch</code>, <code>idle</code>, <code>fifo</code>,
        <code>rr</code>) for particular vCPU/IOThread threads (based on
        <code>vcpus</code> and <code>iothreads</code>, leaving out
J
conf: Adjust the iothreadsched expectations  
John Ferlan 已提交
864 865 866 867 868 869 870 871 
        <code>vcpus</code>/<code>iothreads</code> sets the default). Valid
        <code>vcpus</code> values start at 0 through one less than the
        number of vCPU's defined for the domain. Valid <code>iothreads</code>
        values are described in the <code>iothreadids</code>
        <a href="#elementsIOThreadsAllocation"><code>description</code></a>.
        If no <code>iothreadids</code> are defined, then libvirt numbers
        IOThreads from 1 to the number of <code>iothreads</code> available
        for the domain. For real-time schedulers (<code>fifo</code>,
M
docs: Fix trivial copy-paste error  
Martin Kletzander 已提交
872 
        <code>rr</code>), priority must be specified as
J
conf: Adjust the iothreadsched expectations  
John Ferlan 已提交
873 874 
        well (and is ignored for non-real-time ones). The value range
        for the priority depends on the host kernel (usually 1-99).
M
docs: Fix version reference in vcpu/iothread scheduling  
Martin Kletzander 已提交
875 
        <span class="since">Since 1.2.13</span>
M
docs, schema, conf: Add support for setting scheduler parameters of guest threads  
Martin Kletzander 已提交
876 877 
      </dd>
M
conf: Add support for cputune/cachetune  
Martin Kletzander 已提交
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 
      <dt><code>cachetune</code><span class="since">Since 4.1.0</span></dt>
      <dd>
        Optional <code>cachetune</code> element can control allocations for CPU
        caches using the resctrl on the host. Whether or not is this supported
        can be gathered from capabilities where some limitations like minimum
        size and required granularity are reported as well. The required
        attribute <code>vcpus</code> specifies to which vCPUs this allocation
        applies. A vCPU can only be member of one <code>cachetune</code> element
        allocations. Supported subelements are:
        <dl>
          <dt><code>cache</code></dt>
          <dd>
            This element controls the allocation of CPU cache and has the
            following attributes:
            <dl>
              <dt><code>level</code></dt>
              <dd>
                Host cache level from which to allocate.
              </dd>
              <dt><code>id</code></dt>
              <dd>
                Host cache id from which to allocate.
              </dd>
              <dt><code>type</code></dt>
              <dd>
                Type of allocation. Can be <code>code</code> for code
                (instructions), <code>data</code> for data or <code>both</code>
                for both code and data (unified). Currently the allocation can
                be done only with the same type as the host supports, meaning
                you cannot request <code>both</code> for host with CDP
                (code/data prioritization) enabled.
              </dd>
              <dt><code>size</code></dt>
              <dd>
                The size of the region to allocate. The value by default is in
                bytes, but the <code>unit</code> attribute can be used to scale
                the value.
              </dd>
              <dt><code>unit</code> (optional)</dt>
              <dd>
                If specified it is the unit such as KiB, MiB, GiB, or TiB
                (described in the <code>memory</code> element
                for <a href="#elementsMemoryAllocation">Memory Allocation</a>)
                in which <code>size</code> is specified, defaults to bytes.
              </dd>
            </dl>
          </dd>
        </dl>

      </dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
928 929 930 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
931 
    <h3><a id="elementsMemoryAllocation">Memory Allocation</a></h3>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
932 933 934 935 

<pre>
&lt;domain&gt;
  ...
P
conf: Add support for parsing and formatting max memory and slot count  
Peter Krempa 已提交
936 
  &lt;maxMemory slots='16' unit='KiB'&gt;1524288&lt;/maxMemory&gt;
E
xml: allow scaled memory on input  
Eric Blake 已提交
937 938 
  &lt;memory unit='KiB'&gt;524288&lt;/memory&gt;
  &lt;currentMemory unit='KiB'&gt;524288&lt;/currentMemory&gt;
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
939 940 941 942 943 944 
  ...
&lt;/domain&gt;
</pre>

    <dl>
      <dt><code>memory</code></dt>
P
conf: Add interface to parse and format memory device information  
Peter Krempa 已提交
945 946 947 
      <dd>The maximum allocation of memory for the guest at boot time. The
        memory allocation includes possible additional memory devices specified
        at start or hotplugged later.
E
xml: allow scaled memory on input  
Eric Blake 已提交
948 
        The units for this value are determined by the optional
Y
Fix some typos in messages, docs and comments.  
Yuri Chornoivan 已提交
949 
        attribute <code>unit</code>, which defaults to "KiB"
E
xml: allow scaled memory on input  
Eric Blake 已提交
950 951 952 953 954 955 956 957 958 959 960 961 962 
        (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
M
Add support for limiting guest coredump  
Martin Kletzander 已提交
963 964 
        minimum, such as 4000KiB.
P
conf: Add interface to parse and format memory device information  
Peter Krempa 已提交
965 966 967 
        In case <a href="#elementsCPU">NUMA</a> is configured for the guest the
        <code>memory</code> element can be omitted.
M
Add support for limiting guest coredump  
Martin Kletzander 已提交
968 969 970 971 972 973 974 
        In the case of crash, optional attribute <code>dumpCore</code>
        can be used to control whether the guest memory should be
        included in the generated coredump or not (values "on", "off").

        <span class='since'><code>unit</code> since 0.9.11</span>,
        <span class='since'><code>dumpCore</code> since 0.10.2
        (QEMU only)</span></dd>
P
conf: Add support for parsing and formatting max memory and slot count  
Peter Krempa 已提交
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 
      <dt><code>maxMemory</code></dt>
      <dd>The run time maximum memory allocation of the guest. The initial
        memory specified by either the <code>&lt;memory&gt;</code> element or
        the NUMA cell size configuration can be increased by hot-plugging of
        memory to the limit specified by this element.

        The <code>unit</code> attribute behaves the same as for
        <code>&lt;memory&gt;</code>.

        The <code>slots</code> attribute specifies the number of slots
        available for adding memory to the guest. The bounds are hypervisor
        specific.

        Note that due to alignment of the memory chunks added via memory
        hotplug the full size allocation specified by this element may be
        impossible to achieve.
P
qemu: Implement setup of memory hotplug parameters  
Peter Krempa 已提交
991 
        <span class='since'>Since 1.2.14 supported by the QEMU driver.</span>
P
conf: Add support for parsing and formatting max memory and slot count  
Peter Krempa 已提交
992 993 
      </dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
994 995 996 997 
      <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
xml: allow scaled memory on input  
Eric Blake 已提交
998 999 1000 
        to the same value as the <code>memory</code> element.
        The <code>unit</code> attribute behaves the same as
        for <code>memory</code>.</dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1001 1002 1003 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
1004 
    <h3><a id="elementsMemoryBacking">Memory Backing</a></h3>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1005 1006 1007 1008 1009 

<pre>
&lt;domain&gt;
  ...
  &lt;memoryBacking&gt;
M
domain: Introduce ./hugepages/page/[@size, @unit, @nodeset]  
Michal Privoznik 已提交
1010 1011 1012 
    &lt;hugepages&gt;
      &lt;page size="1" unit="G" nodeset="0-3,5"/&gt;
      &lt;page size="2" unit="M" nodeset="4"/&gt;
C
docs: fix an incorrect example for memoryBacking  
Chen Hanxiao 已提交
1013 
    &lt;/hugepages&gt;
O
qemu: New XML to disable memory merge at guest startup  
Osier Yang 已提交
1014 
    &lt;nosharepages/&gt;
J
Add support for locking domain's memory pages  
Jiri Denemark 已提交
1015 
    &lt;locked/&gt;
J
conf: Add new xml elements for file memorybacking support  
Jaroslav Safka 已提交
1016 1017 1018 
    &lt;source type="file|anonymous"/&gt;
    &lt;access mode="shared|private"/&gt;
    &lt;allocation mode="immediate|ondemand"/&gt;
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1019 1020 1021 1022 1023 
  &lt;/memoryBacking&gt;
  ...
&lt;/domain&gt;
</pre>
J
Add support for locking domain's memory pages  
Jiri Denemark 已提交
1024 1025 1026 1027 
    <p>The optional <code>memoryBacking</code> element may contain several
      elements that influence how virtual memory pages are backed by host
      pages.</p>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1028 
    <dl>
J
Add support for locking domain's memory pages  
Jiri Denemark 已提交
1029 1030 
      <dt><code>hugepages</code></dt>
      <dd>This tells the hypervisor that the guest should have its memory
M
domain: Introduce ./hugepages/page/[@size, @unit, @nodeset]  
Michal Privoznik 已提交
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 
      allocated using hugepages instead of the normal native page size.
      <span class='since'>Since 1.2.5</span> it's possible to set hugepages
      more specifically per numa node. The <code>page</code> element is
      introduced. It has one compulsory attribute <code>size</code> which
      specifies which hugepages should be used (especially useful on systems
      supporting hugepages of different sizes). The default unit for the
      <code>size</code> attribute is kilobytes (multiplier of 1024). If you
      want to use different unit, use optional <code>unit</code> attribute.
      For systems with NUMA, the optional <code>nodeset</code> attribute may
      come handy as it ties given guest's NUMA nodes to certain hugepage
      sizes. From the example snippet, one gigabyte hugepages are used for
      every NUMA node except node number four. For the correct syntax see
      <a href="#elementsNUMATuning">this</a>.</dd>
J
Add support for locking domain's memory pages  
Jiri Denemark 已提交
1044 1045 1046 1047 1048 1049 
      <dt><code>nosharepages</code></dt>
      <dd>Instructs hypervisor to disable shared pages (memory merge, KSM) for
        this domain. <span class="since">Since 1.0.6</span></dd>
      <dt><code>locked</code></dt>
      <dd>When set and supported by the hypervisor, memory pages belonging
        to the domain will be locked in host's memory and the host will not
A
docs: Improve documentation related to memory locking  
Andrea Bolognani 已提交
1050 1051 1052 1053 1054 1055 1056 1057 
        be allowed to swap them out, which might be required for some
        workloads such as real-time. For QEMU/KVM guests, the memory used by
        the QEMU process itself will be locked too: unlike guest memory, this
        is an amount libvirt has no way of figuring out in advance, so it has
        to remove the limit on locked memory altogether. Thus, enabling this
        option opens up to a potential security risk: the host will be unable
        to reclaim the locked memory back from the guest when it's running out
        of memory, which means a malicious guest allocating large amounts of
N
docs: Fix typo in memory backing section  
Nitesh Konkar 已提交
1058 
        locked memory could cause a denial-of-service attack on the host.
A
docs: Improve documentation related to memory locking  
Andrea Bolognani 已提交
1059 1060 1061 1062 1063 1064 
        Because of this, using this option is discouraged unless your workload
        demands it; even then, it's highly recommended to set an
        <code>hard_limit</code> (see
        <a href="#elementsMemoryTuning">memory tuning</a>) on memory allocation
        suitable for the specific environment at the same time to mitigate
        the risks described above. <span class="since">Since 1.0.6</span></dd>
J
conf: Add new xml elements for file memorybacking support  
Jaroslav Safka 已提交
1065 1066 1067 1068 1069 1070 
       <dt><code>source</code></dt>
       <dd>In this attribute you can switch to file memorybacking or keep default anonymous.</dd>
       <dt><code>access</code></dt>
       <dd>Specify if memory is shared or private. This can be overridden per numa node by <code>memAccess</code></dd>
       <dt><code>allocation</code></dt>
       <dd>Specify when allocate the memory</dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1071 1072 1073 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
1074 
    <h3><a id="elementsMemoryTuning">Memory Tuning</a></h3>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1075 1076 1077 1078 1079 

<pre>
&lt;domain&gt;
  ...
  &lt;memtune&gt;
E
xml: allow scaled memory on input  
Eric Blake 已提交
1080 1081 1082 1083 
    &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;
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 
  &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
xml: allow scaled memory on input  
Eric Blake 已提交
1097 1098 1099 1100 1101 1102 
        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>
P
memtune: change the way how we store unlimited value  
Pavel Hrdina 已提交
1103 1104 1105 
        since 0.9.11</span>
        Possible values for all *_limit parameters are in range from 0 to
        VIR_DOMAIN_MEMORY_PARAM_UNLIMITED.</dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1106 1107 
      <dt><code>hard_limit</code></dt>
      <dd> The optional <code>hard_limit</code> element is the maximum memory
E
docs: use correct terminology for 1024 bytes  
Eric Blake 已提交
1108 
        the guest can use. The units for this value are kibibytes (i.e. blocks
A
docs: Improve documentation related to memory locking  
Andrea Bolognani 已提交
1109 1110 1111 
        of 1024 bytes). Users of QEMU and KVM are strongly advised not to set
        this limit as domain may get killed by the kernel if the guess is too
        low, and determining the memory needed for a process to run is an
M
docs: Discourage users to set hard_limit  
Michal Privoznik 已提交
1112 
        <a href="http://en.wikipedia.org/wiki/Undecidable_problem">
A
docs: Improve documentation related to memory locking  
Andrea Bolognani 已提交
1113 1114 1115 1116 1117 1118 1119 1120 
        undecidable problem</a>; that said, if you already set
        <code>locked</code> in
        <a href="#elementsMemoryBacking">memory backing</a> because your
        workload demands it, you'll have to take into account the specifics of
        your deployment and figure out a value for <code>hard_limit</code> that
        balances the risk of your guest being killed because the limit was set
        too low and the risk of your host crashing because it cannot reclaim
        the memory used by the guest due to <code>locked</code>. Good luck!</dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1121 1122 1123 
      <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
E
docs: use correct terminology for 1024 bytes  
Eric Blake 已提交
1124 
        kibibytes (i.e. blocks of 1024 bytes)</dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1125 1126 1127 
      <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
E
docs: use correct terminology for 1024 bytes  
Eric Blake 已提交
1128 
        kibibytes (i.e. blocks of 1024 bytes). This has to be more than
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1129 1130 1131 1132 
        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
E
qemu: min_guarantee: Parameter 'min_guarantee' not supported  
Erik Skultety 已提交
1133 1134 
        kibibytes (i.e. blocks of 1024 bytes). This element is only supported
        by VMware ESX and OpenVZ drivers.</dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1135 1136 1137 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
1138 
    <h3><a id="elementsNUMATuning">NUMA Node Tuning</a></h3>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1139 1140 1141 1142 1143 1144 

<pre>
&lt;domain&gt;
  ...
  &lt;numatune&gt;
    &lt;memory mode="strict" nodeset="1-4,^3"/&gt;
M
conf, schema: add support for memnode elements  
Martin Kletzander 已提交
1145 1146 
    &lt;memnode cellid="0" mode="strict" nodeset="1"/&gt;
    &lt;memnode cellid="2" mode="preferred" nodeset="2"/&gt;
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1147 1148 1149 1150 1151 1152 
  &lt;/numatune&gt;
  ...
&lt;/domain&gt;
</pre>

    <dl>
O
numatune: Add doc for new numatune XML  
Osier Yang 已提交
1153 1154 1155 1156 1157 1158 
      <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>
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
1159 
      </dd>
O
numatune: Add doc for new numatune XML  
Osier Yang 已提交
1160 1161 
      <dt><code>memory</code></dt>
      <dd>
O
qemu: Support numad  
Osier Yang 已提交
1162 
        The optional <code>memory</code> element specifies how to allocate memory
O
numad: Set memory policy from numad advisory nodeset  
Osier Yang 已提交
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 
        for the domain process on a NUMA host. It contains several optional
        attributes. Attribute <code>mode</code> is either 'interleave',
        'strict', or 'preferred', defaults to 'strict'. Attribute
        <code>nodeset</code> specifies the NUMA nodes, using the same syntax as
        attribute <code>cpuset</code> of element <code>vcpu</code>. Attribute
        <code>placement</code> (<span class='since'>since 0.9.12</span>) can be
        used to indicate the memory placement mode for domain process, its value
        can be either "static" or "auto", defaults to <code>placement</code> of
        <code>vcpu</code>, or "static" if <code>nodeset</code> is specified.
        "auto" indicates the domain process will only allocate memory from the
        advisory nodeset returned from querying numad, and the value of attribute
        <code>nodeset</code> will be ignored if it's specified.

        If <code>placement</code> of <code>vcpu</code> is 'auto', and
        <code>numatune</code> is not specified, a default <code>numatune</code>
        with <code>placement</code> 'auto' and <code>mode</code> 'strict' will
        be added implicitly.
O
numatune: Add doc for new numatune XML  
Osier Yang 已提交
1181 1182 
        <span class='since'>Since 0.9.3</span>
      </dd>
M
conf, schema: add support for memnode elements  
Martin Kletzander 已提交
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 
      <dt><code>memnode</code></dt>
      <dd>
        Optional <code>memnode</code> elements can specify memory allocation
        policies per each guest NUMA node.  For those nodes having no
        corresponding <code>memnode</code> element, the default from
        element <code>memory</code> will be used.  Attribute <code>cellid</code>
        addresses guest NUMA node for which the settings are applied.
        Attributes <code>mode</code> and <code>nodeset</code> have the same
        meaning and syntax as in <code>memory</code> element.

        This setting is not compatible with automatic placement.
        <span class='since'>QEMU Since 1.2.7</span>
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1196 1197 
    </dl>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1198
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
1199 
    <h3><a id="elementsBlockTuning">Block I/O Tuning</a></h3>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1200 1201 1202 1203 1204 
<pre>
&lt;domain&gt;
  ...
  &lt;blkiotune&gt;
    &lt;weight&gt;800&lt;/weight&gt;
H
blkiotune: add interface for blkiotune.device_weight  
Hu Tao 已提交
1205 1206 1207 1208 1209 1210 1211 
    &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;
C
docs: domain: document blkiotune {read, write}_{bytes, iops}_sec  
Cole Robinson 已提交
1212 1213 1214 1215 
      &lt;read_bytes_sec&gt;10000&lt;/read_bytes_sec&gt;
      &lt;write_bytes_sec&gt;10000&lt;/write_bytes_sec&gt;
      &lt;read_iops_sec&gt;20000&lt;/read_iops_sec&gt;
      &lt;write_iops_sec&gt;20000&lt;/write_iops_sec&gt;
H
blkiotune: add interface for blkiotune.device_weight  
Hu Tao 已提交
1216 
    &lt;/device&gt;
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1217 1218 1219 1220 1221 1222 1223 1224 1225 
  &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
H
blkiotune: add interface for blkiotune.device_weight  
Hu Tao 已提交
1226 1227 
        omitted, it defaults to the OS provided
        defaults. <span class="since">Since 0.8.8</span></dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1228 
      <dt><code>weight</code></dt>
H
blkiotune: add interface for blkiotune.device_weight  
Hu Tao 已提交
1229 1230 
      <dd> The optional <code>weight</code> element is the overall I/O
        weight of the guest. The value should be in the range [100,
C
docs: change the minimum weight description for blkio  
Chen Hanxiao 已提交
1231 1232 
        1000]. After kernel 2.6.39, the value could be in the
        range [10, 1000].</dd>
H
blkiotune: add interface for blkiotune.device_weight  
Hu Tao 已提交
1233 1234 1235 1236 1237 1238 1239 1240 
      <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
Support block I/O throttle in XML  
Lei Li 已提交
1241 1242 1243 1244 1245 
        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
H
blkiotune: add interface for blkiotune.device_weight  
Hu Tao 已提交
1246 1247 1248 
        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,
C
docs: change the minimum weight description for blkio  
Chen Hanxiao 已提交
1249 
        1000]. After kernel 2.6.39, the value could be in the
C
docs: domain: document blkiotune {read, write}_{bytes, iops}_sec  
Cole Robinson 已提交
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 
        range [10, 1000]. <span class="since">Since 0.9.8</span><br/>
        Additionally, the following optional sub-elements can be used:
        <dl>
          <dt><code>read_bytes_sec</code></dt>
          <dd>Read throughput limit in bytes per second.
            <span class="since">Since 1.2.2</span></dd>
          <dt><code>write_bytes_sec</code></dt>
          <dd>Write throughput limit in bytes per second.
            <span class="since">Since 1.2.2</span></dd>
          <dt><code>read_iops_sec</code></dt>
          <dd>Read I/O operations per second limit.
            <span class="since">Since 1.2.2</span></dd>
          <dt><code>write_iops_sec</code></dt>
          <dd>Write I/O operations per second limit.
            <span class="since">Since 1.2.2</span></dd>
      </dl></dd></dl>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
1266 1267
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
1268 
    <h3><a id="resPartition">Resource partitioning</a></h3>
D
Add XML config for resource partitions  
Daniel P. Berrange 已提交
1269 1270 1271 1272 1273 1274 

    <p>
      Hypervisors may allow for virtual machines to be placed into
      resource partitions, potentially with nesting of said partitions.
      The <code>resource</code> element groups together configuration
      related to resource partitioning. It currently supports a child
E
doc: Add info (where necessary) that paths should be specified as absolute  
Erik Skultety 已提交
1275 
      element <code>partition</code> whose content defines the absolute path
D
Add XML config for resource partitions  
Daniel P. Berrange 已提交
1276 1277 1278 1279 1280 1281 1282 1283 
      of the resource partition in which to place the domain. If no
      partition is listed, then the domain will be placed in a default
      partition. It is the responsibility of the app/admin to ensure
      that the partition exists prior to starting the guest. Only the
      (hypervisor specific) default partition can be assumed to exist
      by default.
    </p>
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
1284 1285 1286 1287 1288 
...
&lt;resource&gt;
  &lt;partition&gt;/virtualmachines/production&lt;/partition&gt;
&lt;/resource&gt;
...
D
Add XML config for resource partitions  
Daniel P. Berrange 已提交
1289 1290 1291 1292 
</pre>

    <p>
      Resource partitions are currently supported by the QEMU and
E
docs: fix usage of 'onto'  
Eric Blake 已提交
1293 
      LXC drivers, which map partition paths to cgroups directories,
D
Add XML config for resource partitions  
Daniel P. Berrange 已提交
1294 1295 1296 
      in all mounted controllers. <span class="since">Since 1.0.5</span>
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
1297 
    <h3><a id="elementsCPU">CPU model and topology</a></h3>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1298 1299 1300 1301 1302 1303 1304 

    <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>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1305 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
1306 1307 1308 1309 1310 
...
&lt;cpu match='exact'&gt;
  &lt;model fallback='allow'&gt;core2duo&lt;/model&gt;
  &lt;vendor&gt;Intel&lt;/vendor&gt;
  &lt;topology sockets='1' cores='2' threads='1'/&gt;
J
Add support for CPU cache specification  
Jiri Denemark 已提交
1311 
  &lt;cache level='3' mode='emulate'/&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
1312 1313 1314 
  &lt;feature policy='disable' name='lahf_lm'/&gt;
&lt;/cpu&gt;
...</pre>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1315
J
Add support for cpu mode attribute  
Jiri Denemark 已提交
1316 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
1317 1318 1319 1320 1321 
&lt;cpu mode='host-model'&gt;
  &lt;model fallback='forbid'/&gt;
  &lt;topology sockets='1' cores='2' threads='1'/&gt;
&lt;/cpu&gt;
...</pre>
J
Add support for cpu mode attribute  
Jiri Denemark 已提交
1322 1323 

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
1324 
&lt;cpu mode='host-passthrough'&gt;
J
Add support for CPU cache specification  
Jiri Denemark 已提交
1325 
  &lt;cache mode='passthrough'/&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
1326 1327 
  &lt;feature policy='disable' name='lahf_lm'/&gt;
...</pre>
J
Add support for cpu mode attribute  
Jiri Denemark 已提交
1328
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1329 1330 1331 1332 1333 1334 
    <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>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1335 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
1336 1337 1338 1339 1340 
...
&lt;cpu&gt;
  &lt;topology sockets='1' cores='2' threads='1'/&gt;
&lt;/cpu&gt;
...</pre>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1341 1342 1343 1344 

    <dl>
      <dt><code>cpu</code></dt>
      <dd>The <code>cpu</code> element is the main container for describing
J
docs: Clarify /domain/cpu/@match description  
Jiri Denemark 已提交
1345 1346 
        guest CPU requirements. Its <code>match</code> attribute specifies how
        strictly the virtual CPU provided to the guest matches these
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1347 1348 1349 1350 1351 1352 1353 1354 
        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
J
docs: Clarify /domain/cpu/@match description  
Jiri Denemark 已提交
1355 1356 1357 1358 1359 1360 
            requested CPU. A better CPU will be provided to the guest if it
            is possible with the requested hypervisor on the current host.
            This is a constrained <code>host-model</code> mode; the domain
            will not be created if the provided virtual CPU does not meet
            the requirements.</dd>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1361 
          <dt><code>exact</code></dt>
J
docs: Clarify /domain/cpu/@match description  
Jiri Denemark 已提交
1362 1363 1364 1365 
          <dd>The virtual CPU provided to the guest should exactly match the
            specification. If such CPU is not supported, libvirt will refuse
            to start the domain.</dd>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1366 
          <dt><code>strict</code></dt>
J
docs: Clarify /domain/cpu/@match description  
Jiri Denemark 已提交
1367 1368 1369 
          <dd>The domain will not be created unless the host CPU exactly
            matches the specification. This is not very useful in practice
            and should only be used if there is a real reason.</dd>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1370 
        </dl>
D
Set sensible defaults for cpu match and feature policy  
Daniel P. Berrange 已提交
1371
E
maint: whitespace cleanup  
Eric Blake 已提交
1372 1373 
        <span class="since">Since 0.8.5</span> the <code>match</code>
        attribute can be omitted and will default to <code>exact</code>.
J
Add support for cpu mode attribute  
Jiri Denemark 已提交
1374
J
Introduce /domain/cpu/@check XML attribute  
Jiri Denemark 已提交
1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 
        Sometimes the hypervisor is not able to create a virtual CPU exactly
        matching the specification passed by libvirt.
        <span class="since">Since 3.2.0</span>, an optional <code>check</code>
        attribute can be used to request a specific way of checking whether
        the virtual CPU matches the specification. It is usually safe to omit
        this attribute when starting a domain and stick with the default
        value. Once the domain starts, libvirt will automatically change the
        <code>check</code> attribute to the best supported value to ensure the
        virtual CPU does not change when the domain is migrated to another
        host. The following values can be used:

        <dl>
          <dt><code>none</code></dt>
          <dd>Libvirt does no checking and it is up to the hypervisor to
            refuse to start the domain if it cannot provide the requested CPU.
            With QEMU this means no checking is done at all since the default
            behavior of QEMU is to emit warnings, but start the domain anyway.
          </dd>

          <dt><code>partial</code></dt>
          <dd>Libvirt will check the guest CPU specification before starting
            a domain, but the rest is left on the hypervisor. It can still
            provide a different virtual CPU.</dd>

          <dt><code>full</code></dt>
          <dd>The virtual CPU created by the hypervisor will be checked
            against the CPU specification and the domain will not be started
            unless the two CPUs match.</dd>
        </dl>
J
Add support for cpu mode attribute  
Jiri Denemark 已提交
1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 
        <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
P
cpu: Allow fine tuning of "host-model" cpu  
Peter Krempa 已提交
1422 1423 1424 1425 1426 1427 1428 1429 1430 
          providing the best guest CPU each host supports. The
          <code>match</code> attribute can't 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. Using the
          <code>feature</code> element, specific flags may be enabled or
          disabled specifically in addition to the host model. This may be
          used to fine tune features that can be emulated.
          <span class="since">(Since 1.1.1)</span>.
          Libvirt does not model every aspect of each CPU so
J
Add support for cpu mode attribute  
Jiri Denemark 已提交
1431 1432 1433 1434 1435 1436 1437 
          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
J
docs: Update description of the host-model CPU mode  
Jiri Denemark 已提交
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 
          the capabilities of the new host. Prior to libvirt 3.2.0 and QEMU
          2.9.0 detection of the host CPU model via QEMU is not supported.
          Thus the CPU configuration created using <code>host-model</code>
          may not work as expected.
          <span class="since">Since 3.2.0 and QEMU 2.9.0</span> this mode
          works the way it was designed and it is indicated by the
          <code>fallback</code> attribute set to <code>forbid</code> in the
          host-model CPU definition advertised in
          <a href="formatdomaincaps.html#elementsCPU">domain capabilities XML</a>.
          When <code>fallback</code> attribute is set to <code>allow</code>
          in the domain capabilities XML, it is recommended to use
          <code>custom</code> mode with just the CPU model from the host
          capabilities XML. <span class="since">Since 1.2.11</span> PowerISA
          allows processors to run VMs in binary compatibility mode supporting
          an older version of ISA.  Libvirt on PowerPC architecture uses the
P
docs: Add documentation for compat mode.  
Prerna Saxena 已提交
1453 1454 1455 1456 1457 
          <code>host-model</code> to signify a guest mode CPU running in
          binary compatibility mode. Example:
          When a user needs a power7 VM to run in compatibility mode
          on a Power8 host, this can be described in XML as follows :
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
1458 1459 1460 1461 
&lt;cpu mode='host-model'&gt;
  &lt;model&gt;power7&lt;/model&gt;
&lt;/cpu&gt;
...</pre>
P
docs: Add documentation for compat mode.  
Prerna Saxena 已提交
1462 
          </dd>
J
Add support for cpu mode attribute  
Jiri Denemark 已提交
1463 1464 1465 1466 1467 
          <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
M
qemu: Allow enabling/disabling features with host-passthrough  
Martin Kletzander 已提交
1468 
          hit any bugs, you are on your own. Further details of that CPU can
J
docs: document cpu host-passthrough migration issue  
Jason J. Herne 已提交
1469 1470 1471 1472 1473 
          be changed using <code>feature</code> elements. Migration of a guest
          using host-passthrough is dangerous if the source and destination
          hosts are not identical in both hardware and configuration. If such
          a migration is attempted then the guest may hang or crash upon
          resuming execution on the destination host.</dd>
J
Add support for cpu mode attribute  
Jiri Denemark 已提交
1474 
        </dl>
J
docs: Update description of the host-model CPU mode  
Jiri Denemark 已提交
1475 1476 1477 1478 1479 1480 1481 1482 1483 

        Both <code>host-model</code> and <code>host-passthrough</code> modes
        make sense when a domain can run directly on the host CPUs (for
        example, domains with type <code>kvm</code>). The actual host CPU is
        irrelevant for domains with emulated virtual CPUs (such as domains with
        type <code>qemu</code>). However, for backward compatibility
        <code>host-model</code> may be implemented even for domains running on
        emulated CPUs in which case the best CPU the hypervisor is able to
        emulate may be used rather then trying to mimic the host CPU model.
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1484 1485 1486 1487 1488 1489 
      </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
J
cpu: Optionally forbid fallback CPU models  
Jiri Denemark 已提交
1490 1491 1492 1493 1494 1495 1496 1497 
        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
H
docs: added description of the vendor_id attribute  
Hendrik Schwartke 已提交
1498 
        <code>forbid</code>. The optional <code>vendor_id</code> attribute
E
build: commit to 0.10.0 release naming  
Eric Blake 已提交
1499 
        (<span class="since">Since 0.10.0</span>)  can be used to set the
H
docs: added description of the vendor_id attribute  
Hendrik Schwartke 已提交
1500 1501 1502 
        vendor id seen by the guest. It must be exactly 12 characters long.
        If not set the vendor id of the host is used. Typical possible
        values are "AuthenticAMD" and "GenuineIntel".</dd>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1503
J
cpu: Add support for CPU vendor  
Jiri Denemark 已提交
1504 1505 1506 1507 1508 1509 1510 
      <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>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1511 1512 1513 1514 1515 
      <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
P
docs: Document limitation of maximum vcpu count used with <topology>  
Peter Krempa 已提交
1516 1517 1518 1519 
        socket, and number of threads per core, respectively. Hypervisors may
        require that the maximum number of vCPUs specified by the
        <code>cpus</code> element equals to the number of vcpus resulting
        from the topology.</dd>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 

      <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>
K
docs: formatdomain: Clarify CPU feature policy option "require"  
Kashyap Chamarthy 已提交
1534 1535 
          <dd>Guest creation will fail unless the feature is supported by the
            host CPU or the hypervisor is able to emulate it.</dd>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1536 1537 1538 1539 1540 1541 1542 1543 1544 
          <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>
D
Set sensible defaults for cpu match and feature policy  
Daniel P. Berrange 已提交
1545
E
maint: whitespace cleanup  
Eric Blake 已提交
1546 1547 
        <span class="since">Since 0.8.5</span> the <code>policy</code>
        attribute can be omitted and will default to <code>require</code>.
K
docs: formatdomain: Document the CPU feature 'name' attribute  
Kashyap Chamarthy 已提交
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 

        <p> Individual CPU feature names are specified as part of the
        <code>name</code> attribute. For example, to explicitly specify
        the 'pcid' feature with Intel IvyBridge CPU model:
        </p>

<pre>
...
&lt;cpu match='exact'&gt;
  &lt;model fallback='forbid'&gt;IvyBridge&lt;/model&gt;
  &lt;vendor&gt;Intel&lt;/vendor&gt;
  &lt;feature policy='require' name='pcid'/&gt;
&lt;/cpu&gt;
...</pre>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1563 
      </dd>
J
Add support for CPU cache specification  
Jiri Denemark 已提交
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 

      <dt><code>cache</code></dt>
      <dd><span class="since">Since 3.3.0</span> the <code>cache</code>
        element describes the virtual CPU cache. If the element is missing,
        the hypervisor will use a sensible default.

        <dl>
          <dt><code>level</code></dt>
          <dd>This optional attribute specifies which cache level is described
            by the element. Missing attribute means the element describes all
            CPU cache levels at once. Mixing <code>cache</code> elements with
            the <code>level</code> attribute set and those without the
            attribute is forbidden.</dd>

          <dt><code>mode</code></dt>
          <dd>
            The following values are supported:
            <dl>
              <dt><code>emulate</code></dt>
              <dd>The hypervisor will provide a fake CPU cache data.</dd>

              <dt><code>passthrough</code></dt>
              <dd>The real CPU cache data reported by the host CPU will be
                passed through to the virtual CPU.</dd>

              <dt><code>disable</code></dt>
              <dd>The virtual CPU will report no CPU cache of the specified
                level (or no cache at all if the <code>level</code> attribute
                is missing).</dd>
            </dl>
          </dd>
        </dl>
      </dd>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1597 1598 
    </dl>
B
XML definitions for guest NUMA and parsing routines  
Bharata B Rao 已提交
1599 
    <p>
Y
Fix minor typos in messages and docs  
Yuri Chornoivan 已提交
1600 
      Guest NUMA topology can be specified using the <code>numa</code> element.
B
XML definitions for guest NUMA and parsing routines  
Bharata B Rao 已提交
1601 1602 1603 1604 
      <span class="since">Since 0.9.8</span>
    </p>

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
1605 1606 
...
&lt;cpu&gt;
B
XML definitions for guest NUMA and parsing routines  
Bharata B Rao 已提交
1607 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
1608 1609 1610 1611 1612 1613 1614 
  &lt;numa&gt;
    &lt;cell id='0' cpus='0-3' memory='512000' unit='KiB'/&gt;
    &lt;cell id='1' cpus='4-7' memory='512000' unit='KiB' memAccess='shared'/&gt;
  &lt;/numa&gt;
  ...
&lt;/cpu&gt;
...</pre>
B
XML definitions for guest NUMA and parsing routines  
Bharata B Rao 已提交
1615 1616 1617 

    <p>
      Each <code>cell</code> element specifies a NUMA cell or a NUMA node.
M
conf, schema: add 'id' field for cells  
Martin Kletzander 已提交
1618 1619 1620 
      <code>cpus</code> specifies the CPU or range of CPUs that are
      part of the node. <code>memory</code> specifies the node memory
      in kibibytes (i.e. blocks of 1024 bytes).
P
cpu_conf: Allow specification of 'units' for @memory on numa nodes.  
Prerna Saxena 已提交
1621 1622 1623 
      <span class="since">Since 1.2.11</span> one can use an additional <a
          href="#elementsMemoryAllocation"><code>unit</code></a> attribute to
      define units in which <code>memory</code> is specified.
M
conf, schema: add 'id' field for cells  
Martin Kletzander 已提交
1624 1625 1626 1627 1628 1629 
      <span class="since">Since 1.2.7</span> all cells should
      have <code>id</code> attribute in case referring to some cell is
      necessary in the code, otherwise the cells are
      assigned <code>id</code>s in the increasing order starting from
      0.  Mixing cells with and without the <code>id</code> attribute
      is not recommended as it may result in unwanted behaviour.
M
docs, conf, schema: add support for shared memory mapping  
Martin Kletzander 已提交
1630 1631 1632 1633 

      <span class='since'>Since 1.2.9</span> the optional attribute
      <code>memAccess</code> can control whether the memory is to be
      mapped as "shared" or "private".  This is valid only for
M
conf: Introduce @access to <memory/>  
Michal Privoznik 已提交
1634 
      hugepages-backed memory and nvdimm modules.
B
XML definitions for guest NUMA and parsing routines  
Bharata B Rao 已提交
1635 1636 1637 
    </p>

    <p>
W
numa: describe siblings distances within cells  
Wim ten Have 已提交
1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 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 1696 1697 
      This guest NUMA specification is currently available only for
      QEMU/KVM and Xen.
    </p>

    <p>
      A NUMA hardware architecture supports the notion of distances
      between NUMA cells. <span class="since">Since 3.10.0</span> it
      is possible to define the distance between NUMA cells using the
      <code>distances</code> element within a NUMA <code>cell</code>
      description. The <code>sibling</code> sub-element is used to
      specify the distance value between sibling NUMA cells. For more
      details, see the chapter explaining the system's SLIT (System
      Locality Information Table) within the ACPI (Advanced
      Configuration and Power Interface) specification.
    </p>

<pre>
...
&lt;cpu&gt;
  ...
  &lt;numa&gt;
    &lt;cell id='0' cpus='0,4-7' memory='512000' unit='KiB'&gt;
      &lt;distances&gt;
        &lt;sibling id='0' value='10'/&gt;
        &lt;sibling id='1' value='21'/&gt;
        &lt;sibling id='2' value='31'/&gt;
        &lt;sibling id='3' value='41'/&gt;
      &lt;/distances&gt;
    &lt;/cell&gt;
    &lt;cell id='1' cpus='1,8-10,12-15' memory='512000' unit='KiB' memAccess='shared'&gt;
      &lt;distances&gt;
        &lt;sibling id='0' value='21'/&gt;
        &lt;sibling id='1' value='10'/&gt;
        &lt;sibling id='2' value='21'/&gt;
        &lt;sibling id='3' value='31'/&gt;
      &lt;/distances&gt;
    &lt;/cell&gt;
    &lt;cell id='2' cpus='2,11' memory='512000' unit='KiB' memAccess='shared'&gt;
      &lt;distances&gt;
        &lt;sibling id='0' value='31'/&gt;
        &lt;sibling id='1' value='21'/&gt;
        &lt;sibling id='2' value='10'/&gt;
        &lt;sibling id='3' value='21'/&gt;
      &lt;/distances&gt;
    &lt;/cell&gt;
    &lt;cell id='3' cpus='3' memory='512000' unit='KiB'&gt;
      &lt;distances&gt;
        &lt;sibling id='0' value='41'/&gt;
        &lt;sibling id='1' value='31'/&gt;
        &lt;sibling id='2' value='21'/&gt;
        &lt;sibling id='3' value='10'/&gt;
      &lt;/distances&gt;
    &lt;/cell&gt;
  &lt;/numa&gt;
  ...
&lt;/cpu&gt;
...</pre>

    <p>
      Describing distances between NUMA cells is currently only supported
M
qemu: Support setting NUMA distances  
Michal Privoznik 已提交
1698 
      by Xen and QEMU. If no <code>distances</code> are given to describe
W
numa: describe siblings distances within cells  
Wim ten Have 已提交
1699 1700 
      the SLIT data between different cells, it will default to a scheme
      using 10 for local and 20 for remote distances.
B
XML definitions for guest NUMA and parsing routines  
Bharata B Rao 已提交
1701 1702 
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
1703 
    <h3><a id="elementsEvents">Events configuration</a></h3>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1704 1705 

    <p>
A
fix typos in docs  
Atsushi SAKAI 已提交
1706 
      It is sometimes necessary to override the default actions taken
J
docs: Update formatdomain for lifecycle events  
John Ferlan 已提交
1707 1708 
      on various events. Not all hypervisors support all events and actions.
      The actions may be taken as a result of calls to libvirt APIs
M
docs: Correct invalid hyperlinks  
Martin Kletzander 已提交
1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 
      <a href="html/libvirt-libvirt-domain.html#virDomainReboot">
        <code>virDomainReboot</code>
      </a>,
      <a href="html/libvirt-libvirt-domain.html#virDomainShutdown">
        <code>virDomainShutdown</code>
      </a>,
      or
      <a href="html/libvirt-libvirt-domain.html#virDomainShutdownFlags">
        <code>virDomainShutdownFlags</code>
      </a>.
J
docs: Update formatdomain for lifecycle events  
John Ferlan 已提交
1719 1720 
      Using <code>virsh reboot</code> or <code>virsh shutdown</code> would
      also trigger the event.
D
Update domain XML docs  
Daniel P. Berrange 已提交
1721 1722 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1723 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
1724 1725 1726 1727 1728 1729 
...
&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;
&lt;on_lockfailure&gt;poweroff&lt;/on_lockfailure&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1730
J
conf: Rename life cycle actions to event actions  
Jiri Denemark 已提交
1731 1732 1733 1734 1735 1736 1737 
    <p>
      The following collections of elements allow the actions to be
      specified when a guest OS triggers a lifecycle operation. 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>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1738 1739 1740 
    <dl>
      <dt><code>on_poweroff</code></dt>
      <dd>The content of this element specifies the action to take when
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1741 
        the guest requests a poweroff.</dd>
D
"copy-paste" errors  
Daniel Veillard 已提交
1742 
      <dt><code>on_reboot</code></dt>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1743 
      <dd>The content of this element specifies the action to take when
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1744 
        the guest requests a reboot.</dd>
D
"copy-paste" errors  
Daniel Veillard 已提交
1745 
      <dt><code>on_crash</code></dt>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1746 
      <dd>The content of this element specifies the action to take when
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1747 
        the guest crashes.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1748 1749 1750 1751 1752 1753 1754 1755 1756 
    </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
J
docs: Update formatdomain for lifecycle events  
John Ferlan 已提交
1757 
        released.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1758 
      <dt><code>restart</code></dt>
J
docs: Update formatdomain for lifecycle events  
John Ferlan 已提交
1759 1760 
      <dd>The domain will be terminated and then restarted with
        the same configuration.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1761 
      <dt><code>preserve</code></dt>
J
docs: Update formatdomain for lifecycle events  
John Ferlan 已提交
1762 
      <dd>The domain will be terminated and its resource preserved
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1763 
        to allow analysis.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1764 
      <dt><code>rename-restart</code></dt>
J
docs: Update formatdomain for lifecycle events  
John Ferlan 已提交
1765 1766 
      <dd>The domain will be terminated and then restarted with
        a new name.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1767 1768 
    </dl>
J
Add actions to virDomainLifecycle enum  
Jim Fehlig 已提交
1769 
    <p>
J
docs: Update formatdomain for lifecycle events  
John Ferlan 已提交
1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 
    QEMU/KVM supports the <code>on_poweroff</code> and <code>on_reboot</code>
    events handling the <code>destroy</code> and <code>restart</code> actions.
    The <code>preserve</code> action for an <code>on_reboot</code> event
    is treated as a <code>destroy</code> and the <code>rename-restart</code>
    action for an <code>on_poweroff</code> event is treated as a
    <code>restart</code> event.
    </p>

    <p>
      The <code>on_crash</code> event supports these additional
J
Add actions to virDomainLifecycle enum  
Jim Fehlig 已提交
1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 
      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>
P
lib: introduce virDomainSetLifecycleAction() API  
Pavel Hrdina 已提交
1793 1794 1795 1796 1797 1798 1799 
    <p>
      <span class="since">Since 3.9.0</span>, the lifecycle events can
      be configured via the
      <a href="html/libvirt-libvirt-domain.html#virDomainSetLifecycleAction">
        <code>virDomainSetLifecycleAction</code></a> API.
    </p>
J
conf: Add on_lockfailure event configuration  
Jiri Denemark 已提交
1800 1801 
    <p>
      The <code>on_lockfailure</code> element (<span class="since">since
E
maint: prepare for next release number  
Eric Blake 已提交
1802 
      1.0.0</span>) may be used to configure what action should be
J
conf: Add on_lockfailure event configuration  
Jiri Denemark 已提交
1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 
      taken when a lock manager loses resource locks. The following
      actions are recognized by libvirt, although not all of them need
      to be supported by individual lock managers. When no action is
      specified, each lock manager will take its default action.
    </p>
    <dl>
      <dt><code>poweroff</code></dt>
      <dd>The domain will be forcefully powered off.</dd>
      <dt><code>restart</code></dt>
      <dd>The domain will be powered off and started up again to
        reacquire its locks.</dd>
      <dt><code>pause</code></dt>
      <dd>The domain will be paused so that it can be manually resumed
        when lock issues are solved.</dd>
      <dt><code>ignore</code></dt>
      <dd>Keep the domain running as if nothing happened.</dd>
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
1821 
    <h3><a id="elementsPowerManagement">Power Management</a></h3>
M
Add per-guest S3/S4 state configuration  
Martin Kletzander 已提交
1822 1823 1824 1825 1826 1827 1828 1829 

    <p>
      <span class="since">Since 0.10.2</span> it is possible to
      forcibly enable or disable BIOS advertisements to the guest
      OS. (NB: Only qemu driver support)
    </p>

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
1830 1831 1832 1833 1834 1835 
...
&lt;pm&gt;
  &lt;suspend-to-disk enabled='no'/&gt;
  &lt;suspend-to-mem enabled='yes'/&gt;
&lt;/pm&gt;
...</pre>
M
Add per-guest S3/S4 state configuration  
Martin Kletzander 已提交
1836 1837 1838 1839 

    <dl>
      <dt><code>pm</code></dt>
      <dd>These elements enable ('yes') or disable ('no') BIOS support
J
doc: Fix explanation of S3 and S4 states  
Jingjing Shao 已提交
1840 
        for S3 (suspend-to-mem) and S4 (suspend-to-disk) ACPI sleep
M
Add per-guest S3/S4 state configuration  
Martin Kletzander 已提交
1841 
        states. If nothing is specified, then the hypervisor will be
M
docs: Document the real behaviour of suspend-to-{mem,disk}  
Martin Kletzander 已提交
1842 1843 1844 1845 1846 
        left with its default value.<br/>
        Note: This setting cannot prevent the guest OS from performing
        a suspend as the guest OS itself can choose to circumvent the
        unavailability of the sleep states (e.g. S4 by turning off
        completely).</dd>
M
Add per-guest S3/S4 state configuration  
Martin Kletzander 已提交
1847 1848 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
1849 
    <h3><a id="elementsFeatures">Hypervisor features</a></h3>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1850 1851 1852 1853 1854 1855 

    <p>
      Hypervisors may allow certain CPU / machine features to be
      toggled on/off.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1856 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 
...
&lt;features&gt;
  &lt;pae/&gt;
  &lt;acpi/&gt;
  &lt;apic/&gt;
  &lt;hap/&gt;
  &lt;privnet/&gt;
  &lt;hyperv&gt;
    &lt;relaxed state='on'/&gt;
    &lt;vapic state='on'/&gt;
    &lt;spinlocks state='on' retries='4096'/&gt;
    &lt;vpindex state='on'/&gt;
    &lt;runtime state='on'/&gt;
    &lt;synic state='on'/&gt;
    &lt;reset state='on'/&gt;
    &lt;vendor_id state='on' value='KVM Hv'/&gt;
  &lt;/hyperv&gt;
  &lt;kvm&gt;
    &lt;hidden state='on'/&gt;
  &lt;/kvm&gt;
  &lt;pvspinlock state='on'/&gt;
  &lt;gic version='2'/&gt;
J
conf: add <ioapic driver> to <features>  
Ján Tomko 已提交
1879 
  &lt;ioapic driver='qemu'/&gt;
A
docs: Document configuration of HPT resizing  
Andrea Bolognani 已提交
1880 
  &lt;hpt resizing='required'/&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
1881 1882 
&lt;/features&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1883 1884 1885 1886 1887 

    <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
A
docs: Document the new XML elements  
Andrea Bolognani 已提交
1888 1889 
      for the <a href="formatcaps.html">capabilities XML</a> and
      <a href="formatdomaincaps.html">domain capabilities XML</a>,
D
Update domain XML docs  
Daniel P. Berrange 已提交
1890 1891 1892 1893 1894 1895 
      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
Cleanup whitespace in docs  
Matthew Booth 已提交
1896 
        to address more than 4 GB of memory.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1897 1898 
      <dt><code>acpi</code></dt>
      <dd>ACPI is useful for power management, for example, with
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1899 
        KVM guests it is required for graceful shutdown to work.
D
Update domain XML docs  
Daniel P. Berrange 已提交
1900 
      </dd>
M
Add support for EOI with APIC  
Martin Kletzander 已提交
1901 1902 
      <dt><code>apic</code></dt>
      <dd>APIC allows the use of programmable IRQ
M
Fix minor details not only in apic eoi  
Martin Kletzander 已提交
1903 1904 1905 
      management. <span class="since">Since 0.10.2 (QEMU only)</span> there is
      an optional attribute <code>eoi</code> with values <code>on</code>
      and <code>off</code> which toggles the availability of EOI (End of
M
Add support for EOI with APIC  
Martin Kletzander 已提交
1906 1907 
      Interrupt) for the guest.
      </dd>
J
Document HAP domain feature  
Jim Fehlig 已提交
1908 
      <dt><code>hap</code></dt>
J
conf: add 'state' attribute to <hap> feature  
Jim Fehlig 已提交
1909 1910 1911 1912 
      <dd>Depending on the <code>state</code> attribute (values <code>on</code>,
        <code>off</code>) enable or disable use of Hardware Assisted Paging.
        The default is <code>on</code> if the hypervisor detects availability
        of Hardware Assisted Paging.
J
Document HAP domain feature  
Jim Fehlig 已提交
1913 
      </dd>
D
Add missing docs for <viridian/> feature flag  
Daniel P. Berrange 已提交
1914 1915 1916 1917 
      <dt><code>viridian</code></dt>
      <dd>Enable Viridian hypervisor extensions for paravirtualizing
        guest operating systems
      </dd>
D
Add support for forcing a private network namespace for LXC guests  
Daniel P. Berrange 已提交
1918 1919 1920 1921 1922 1923 
      <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>
P
conf: Add support for HyperV Enlightenment features  
Peter Krempa 已提交
1924 1925 1926 1927 1928 1929 1930 1931 
      <dt><code>hyperv</code></dt>
      <dd>Enable various features improving behavior of guests
        running Microsoft Windows.
      <table class="top_table">
        <tr>
          <th>Feature</th>
          <th>Description</th>
          <th>Value</th>
J
conf: add vapic and spinlocks to hyperv features  
Ján Tomko 已提交
1932 
          <th>Since</th>
P
conf: Add support for HyperV Enlightenment features  
Peter Krempa 已提交
1933 1934 1935 
        </tr>
        <tr>
          <td>relaxed</td>
O
docs, comments: minor typo fixes  
Oskari Saarenmaa 已提交
1936 
          <td>Relax constraints on timers</td>
P
conf: Add support for HyperV Enlightenment features  
Peter Krempa 已提交
1937 
          <td> on, off</td>
J
docs: Update the hyperv feature qemu supported version  
John Ferlan 已提交
1938 
          <td><span class="since">1.0.0 (QEMU 2.0)</span></td>
J
conf: add vapic and spinlocks to hyperv features  
Ján Tomko 已提交
1939 1940 1941 1942 1943 
        </tr>
        <tr>
          <td>vapic</td>
          <td>Enable virtual APIC</td>
          <td>on, off</td>
J
docs: Update the hyperv feature qemu supported version  
John Ferlan 已提交
1944 
          <td><span class="since">1.1.0 (QEMU 2.0)</span></td>
J
conf: add vapic and spinlocks to hyperv features  
Ján Tomko 已提交
1945 1946 1947 1948 1949 
        </tr>
        <tr>
          <td>spinlocks</td>
          <td>Enable spinlock support</td>
          <td>on, off; retries - at least 4095</td>
J
docs: Update the hyperv feature qemu supported version  
John Ferlan 已提交
1950 
          <td><span class="since">1.1.0 (QEMU 2.0)</span></td>
P
conf: Add support for HyperV Enlightenment features  
Peter Krempa 已提交
1951 
        </tr>
M
conf: qemu: Add support for more HyperV Enlightenment features  
Maxim Nestratov 已提交
1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 
        <tr>
          <td>vpindex</td>
          <td>Virtual processor index</td>
          <td> on, off</td>
          <td><span class="since">1.3.3 (QEMU 2.5)</span></td>
        </tr>
        <tr>
          <td>runtime</td>
          <td>Processor time spent on running guest code and on behalf of guest code</td>
          <td> on, off</td>
          <td><span class="since">1.3.3 (QEMU 2.5)</span></td>
        </tr>
        <tr>
          <td>synic</td>
          <td>Enable Synthetic Interrupt Controller (SyNIC)</td>
          <td> on, off</td>
P
docs: fix qemu version for hyperv features  
Pavel Hrdina 已提交
1968 
          <td><span class="since">1.3.3 (QEMU 2.6)</span></td>
M
conf: qemu: Add support for more HyperV Enlightenment features  
Maxim Nestratov 已提交
1969 1970 1971 1972 1973 
        </tr>
        <tr>
          <td>stimer</td>
          <td>Enable SyNIC timers</td>
          <td> on, off</td>
P
docs: fix qemu version for hyperv features  
Pavel Hrdina 已提交
1974 
          <td><span class="since">1.3.3 (QEMU 2.6)</span></td>
M
conf: qemu: Add support for more HyperV Enlightenment features  
Maxim Nestratov 已提交
1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 
        </tr>
        <tr>
          <td>reset</td>
          <td>Enable hypervisor reset</td>
          <td> on, off</td>
          <td><span class="since">1.3.3 (QEMU 2.5)</span></td>
        </tr>
        <tr>
          <td>vendor_id</td>
          <td>Set hypervisor vendor id</td>
          <td>on, off; value - string, up to 12 characters</td>
          <td><span class="since">1.3.3 (QEMU 2.5)</span></td>
        </tr>
P
conf: Add support for HyperV Enlightenment features  
Peter Krempa 已提交
1988 1989 
      </table>
      </dd>
P
qemu: Add support for paravirtual spinlocks in the guest  
Peter Krempa 已提交
1990 1991 1992 1993 1994 1995 
      <dt><code>pvspinlock</code></dt>
      <dd>Notify the guest that the host supports paravirtual spinlocks
          for example by exposing the pvticketlocks mechanism. This feature
          can be explicitly disabled by using <code>state='off'</code>
          attribute.
      </dd>
A
Add new 'kvm' domain feature and ability to hide KVM signature  
Alex Williamson 已提交
1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 
      <dt><code>kvm</code></dt>
      <dd>Various features to change the behavior of the KVM hypervisor.
      <table class="top_table">
        <tr>
          <th>Feature</th>
          <th>Description</th>
          <th>Value</th>
          <th>Since</th>
        </tr>
        <tr>
          <td>hidden</td>
          <td>Hide the KVM hypervisor from standard MSR based discovery</td>
          <td>on, off</td>
L
docs: correct version requirements for <kvm><hidden='on'/></kvm>  
Laine Stump 已提交
2009 
          <td><span class="since">1.2.8 (QEMU 2.1.0)</span></td>
A
Add new 'kvm' domain feature and ability to hide KVM signature  
Alex Williamson 已提交
2010 2011 2012 
        </tr>
      </table>
      </dd>
M
docs, schema, conf: Add support for PMU feature  
Martin Kletzander 已提交
2013 2014 2015 2016 2017 2018 
      <dt><code>pmu</code></dt>
      <dd>Depending on the <code>state</code> attribute (values <code>on</code>,
        <code>off</code>, default <code>on</code>) enable or disable the
        performance monitoring unit for the guest.
        <span class="since">Since 1.2.12</span>
      </dd>
M
docs: add domain vmport feature  
Marc-André Lureau 已提交
2019 2020 2021 
      <dt><code>vmport</code></dt>
      <dd>Depending on the <code>state</code> attribute (values <code>on</code>,
        <code>off</code>, default <code>on</code>) enable or disable
J
Spell VMware with a lowercase w  
Ján Tomko 已提交
2022 
        the emulation of VMware IO port, for vmmouse etc.
M
docs: add domain vmport feature  
Marc-André Lureau 已提交
2023 2024 
        <span class="since">Since 1.2.16</span>
      </dd>
M
Introduce GIC feature  
Michal Privoznik 已提交
2025 2026 2027 2028 2029 2030 
      <dt><code>gic</code></dt>
      <dd>Enable for architectures using a General Interrupt
          Controller instead of APIC in order to handle interrupts.
          For example, the 'aarch64' architecture uses
          <code>gic</code> instead of <code>apic</code>. The optional
          attribute <code>version</code> specifies the GIC version;
A
docs: List possible GIC versions  
Andrea Bolognani 已提交
2031 2032 2033 
          however, it may not be supported by all hypervisors. Accepted
          values are <code>2</code>, <code>3</code> and <code>host</code>.
          <span class="since">Since 1.2.16</span>
M
Introduce GIC feature  
Michal Privoznik 已提交
2034 
      </dd>
M
Introduce SMM feature  
Michal Privoznik 已提交
2035 2036 2037 2038 2039 2040 
      <dt><code>smm</code></dt>
      <dd>Enable System Management Mode. Possible values are
          <code>on</code> and <code>off</code>. The default is left
          for hypervisor to decide.
          <span class="since">Since 2.1.0</span>
      </dd>
J
conf: add <ioapic driver> to <features>  
Ján Tomko 已提交
2041 2042 2043 2044 2045 2046 2047 2048 
      <dt><code>ioapic</code></dt>
      <dd>Tune the I/O APIC. Possible values for the
          <code>driver</code> attribute are:
          <code>kvm</code> (default for KVM domains)
          and <code>qemu</code> which puts I/O APIC in userspace
          which is also known as a split I/O APIC mode.
          <span class="since">Since 3.4.0</span> (QEMU/KVM only)
      </dd>
A
docs: Document configuration of HPT resizing  
Andrea Bolognani 已提交
2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 
      <dt><code>hpt</code></dt>
      <dd>Configure the HPT (Hash Page Table) of a pSeries guest. Possible
          values for the <code>resizing</code> attribute are
          <code>enabled</code>, which causes HPT resizing to be enabled if
          both the guest and the host support it; <code>disabled</code>, which
          causes HPT resizing to be disabled regardless of guest and host
          support; and <code>required</code>, which prevents the guest from
          starting unless both the guest and the host support HPT resizing. If
          the attribute is not defined, the hypervisor default will be used.
          <span class="since">Since 3.10.0</span> (QEMU/KVM only)
      </dd>
M
qemu: add vmcoreinfo support  
Marc-André Lureau 已提交
2060 2061 2062 2063 
      <dt><code>vmcoreinfo</code></dt>
      <dd>Enable QEMU vmcoreinfo device to let the guest kernel save debug
          details. <span class="since">Since 3.10.0</span> (QEMU only)
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
2064 2065 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
2066 
    <h3><a id="elementsTime">Time keeping</a></h3>
D
Update domain XML docs  
Daniel P. Berrange 已提交
2067 2068 2069 2070 2071 2072 2073 2074 

    <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>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
2075 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
2076 2077 2078 2079 2080 2081 2082 2083 
...
&lt;clock offset='localtime'&gt;
  &lt;timer name='rtc' tickpolicy='catchup' track='guest'&gt;
    &lt;catchup threshold='123' slew='120' limit='10000'/&gt;
  &lt;/timer&gt;
  &lt;timer name='pit' tickpolicy='delay'/&gt;
&lt;/clock&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
2084 2085 2086 

    <dl>
      <dt><code>clock</code></dt>
D
Expand docs about clock modes  
Daniel P. Berrange 已提交
2087 
      <dd>
E
maint: whitespace cleanup  
Eric Blake 已提交
2088 2089 2090 2091 2092 2093 2094 2095 
        <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
P
Support clock=variable relative to localtime  
Philipp Hahn 已提交
2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 
            booted.
            <span class="since">Since 0.9.11</span> 'utc' mode can be converted
            to 'variable' mode, which can be controlled by using the
            <code>adjustment</code> attribute. If the value is 'reset', the
            conversion is never done (not all hypervisors can
            synchronize to UTC on each boot; use of 'reset' will cause
            an error on those hypervisors). A numeric value
            forces the conversion to 'variable' mode using the value as the
            initial adjustment. The default <code>adjustment</code> is
            hypervisor specific.
          </dd>
E
maint: whitespace cleanup  
Eric Blake 已提交
2107 2108 2109 2110 
          <dt><code>localtime</code></dt>
          <dd>
            The guest clock will be synchronized to the host's configured
            timezone when booted, if any.
P
Support clock=variable relative to localtime  
Philipp Hahn 已提交
2111 2112 
            <span class="since">Since 0.9.11,</span> the <code>adjustment</code>
            attribute behaves the same as in 'utc' mode.
E
maint: whitespace cleanup  
Eric Blake 已提交
2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 
          </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
P
Support clock=variable relative to localtime  
Philipp Hahn 已提交
2123 2124 
            relative to UTC or localtime, depending on the <code>basis</code>
            attribute. The delta relative to UTC (or localtime) is specified
E
maint: whitespace cleanup  
Eric Blake 已提交
2125 
            in seconds, using the <code>adjustment</code> attribute.
P
documentation: trivial spelling fix  
Philipp Hahn 已提交
2126 
            The guest is free to adjust the RTC over time and expect
P
Support clock=variable relative to localtime  
Philipp Hahn 已提交
2127 2128 2129 
            that it will be honored at next reboot. This is in
            contrast to 'utc' and 'localtime' mode (with the optional
            attribute adjustment='reset'), where the RTC adjustments are
E
maint: whitespace cleanup  
Eric Blake 已提交
2130 
            lost at each reboot. <span class="since">Since 0.7.7</span>
P
Support clock=variable relative to localtime  
Philipp Hahn 已提交
2131 2132 
            <span class="since">Since 0.9.11</span> the <code>basis</code>
            attribute can be either 'utc' (default) or 'localtime'.
E
maint: whitespace cleanup  
Eric Blake 已提交
2133 2134 2135 2136 
          </dd>
        </dl>
        <p>
          A <code>clock</code> may have zero or more
C
doc: Add missing space in <clock> documentation  
Christophe Fergeau 已提交
2137 
          <code>timer</code> sub-elements. <span class="since">Since
E
maint: whitespace cleanup  
Eric Blake 已提交
2138 2139 
          0.8.0</span>
        </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
2140 
      </dd>
E
docs: mention domain <clock> improvements  
Eric Blake 已提交
2141 2142 
      <dt><code>timer</code></dt>
      <dd>
E
maint: whitespace cleanup  
Eric Blake 已提交
2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 
        <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
docs: Document hypervisor drivers that support certain timer models  
Peter Krempa 已提交
2153 2154 2155 
            being modified, and can be one of
            "platform" (currently unsupported),
            "hpet" (libxl, xen, qemu), "kvmclock" (qemu),
P
qemu: hyperv: Add support for timer enlightenments  
Peter Krempa 已提交
2156 2157 2158 2159 2160 2161 2162 
            "pit" (qemu), "rtc" (qemu), "tsc" (libxl) or "hypervclock"
            (qemu - <span class="since">since 1.2.2</span>).

            The <code>hypervclock</code> timer adds support for the
            reference time counter and the reference page for iTSC
            feature for guests running the Microsoft Windows
            operating system.
E
maint: whitespace cleanup  
Eric Blake 已提交
2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 
          </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>
D
Expand docs for timer tick policy  
Daniel P. Berrange 已提交
2173 2174 
            <p>
            The <code>tickpolicy</code> attribute determines what
O
docs, comments: minor typo fixes  
Oskari Saarenmaa 已提交
2175 
            happens when QEMU misses a deadline for injecting a
D
Expand docs for timer tick policy  
Daniel P. Berrange 已提交
2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 
            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
maint: whitespace cleanup  
Eric Blake 已提交
2199 2200 2201 2202 2203 2204 2205 2206 2207 
            <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>
D
Expand docs for timer tick policy  
Daniel P. Berrange 已提交
2208 2209 2210 
            <p>
              Note that hypervisors are not required to support all policies across all time sources
            </p>
E
maint: whitespace cleanup  
Eric Blake 已提交
2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 
          </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>
E
docs: mention domain <clock> improvements  
Eric Blake 已提交
2231 
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
2232 2233 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
2234 
    <h3><a id="elementsPerf">Performance monitoring events</a></h3>
P
docs: Add at least some docs and fix schema entry for perf events  
Peter Krempa 已提交
2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 

    <p>
      Some platforms allow monitoring of performance of the virtual machine and
      the code executed inside. To enable the performance monitoring events
      you can either specify them in the <code>perf</code> element or enable
      them via <code>virDomainSetPerfEvents</code> API. The performance values
      are then retrieved using the virConnectGetAllDomainStats API.
      <span class="since">Since 2.0.0</span>
    </p>

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
2246 2247 2248 2249 2250 2251 2252 2253 2254 
...
&lt;perf&gt;
  &lt;event name='cmt' enabled='yes'/&gt;
  &lt;event name='mbmt' enabled='no'/&gt;
  &lt;event name='mbml' enabled='yes'/&gt;
  &lt;event name='cpu_cycles' enabled='no'/&gt;
  &lt;event name='instructions' enabled='yes'/&gt;
  &lt;event name='cache_references' enabled='no'/&gt;
  &lt;event name='cache_misses' enabled='no'/&gt;
N
perf: add one more perf event support  
Nitesh Konkar 已提交
2255 
  &lt;event name='branch_instructions' enabled='no'/&gt;
N
perf: add branch_misses perf event support  
Nitesh Konkar 已提交
2256 
  &lt;event name='branch_misses' enabled='no'/&gt;
N
perf: add bus_cycles perf event support  
Nitesh Konkar 已提交
2257 
  &lt;event name='bus_cycles' enabled='no'/&gt;
N
perf: add stalled_cycles_frontend perf event support  
Nitesh Konkar 已提交
2258 
  &lt;event name='stalled_cycles_frontend' enabled='no'/&gt;
N
perf: add stalled_cycles_backend perf event support  
Nitesh Konkar 已提交
2259 
  &lt;event name='stalled_cycles_backend' enabled='no'/&gt;
N
perf: add ref_cpu_cycles perf event support  
Nitesh Konkar 已提交
2260 
  &lt;event name='ref_cpu_cycles' enabled='no'/&gt;
N
perf: add cpu_clock software perf event support  
Nitesh Konkar 已提交
2261 
  &lt;event name='cpu_clock' enabled='no'/&gt;
N
perf: add task_clock software perf event support  
Nitesh Konkar 已提交
2262 
  &lt;event name='task_clock' enabled='no'/&gt;
N
perf: add page_faults software perf event support  
Nitesh Konkar 已提交
2263 
  &lt;event name='page_faults' enabled='no'/&gt;
N
perf: add context_switches software perf event support  
Nitesh Konkar 已提交
2264 
  &lt;event name='context_switches' enabled='no'/&gt;
N
perf: add cpu_migrations software perf event support  
Nitesh Konkar 已提交
2265 
  &lt;event name='cpu_migrations' enabled='no'/&gt;
N
perf: add page_faults_min software perf event support  
Nitesh Konkar 已提交
2266 
  &lt;event name='page_faults_min' enabled='no'/&gt;
N
perf: add page_faults_maj software perf event support  
Nitesh Konkar 已提交
2267 
  &lt;event name='page_faults_maj' enabled='no'/&gt;
N
perf: add alignment_faults software perf event support  
Nitesh Konkar 已提交
2268 
  &lt;event name='alignment_faults' enabled='no'/&gt;
N
perf: add emulation_faults software perf event support  
Nitesh Konkar 已提交
2269 
  &lt;event name='emulation_faults' enabled='no'/&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
2270 2271 
&lt;/perf&gt;
...
P
docs: Add at least some docs and fix schema entry for perf events  
Peter Krempa 已提交
2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 
</pre>

  <table class="top_table">
    <tr>
      <th>event name</th>
      <th>Description</th>
      <th>stats parameter name</th>
    </tr>
    <tr>
      <td><code>cmt</code></td>
      <td>usage of l3 cache in bytes by applications running on the platform</td>
      <td><code>perf.cmt</code></td>
    </tr>
    <tr>
      <td><code>mbmt</code></td>
      <td>total system bandwidth from one level of cache</td>
      <td><code>perf.mbmt</code></td>
    </tr>
    <tr>
      <td><code>mbml</code></td>
      <td>bandwidth of memory traffic for a memory controller</td>
      <td><code>perf.mbml</code></td>
    </tr>
Q
perf: add more perf events support  
Qiaowei Ren 已提交
2295 2296 
    <tr>
      <td><code>cpu_cycles</code></td>
J
docs: Alter descriptions of perf cpu_cycles  
John Ferlan 已提交
2297 
      <td>the count of cpu cycles (total/elapsed)</td>
Q
perf: add more perf events support  
Qiaowei Ren 已提交
2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 
      <td><code>perf.cpu_cycles</code></td>
    </tr>
    <tr>
      <td><code>instructions</code></td>
      <td>the count of instructions by applications running on the platform</td>
      <td><code>perf.instructions</code></td>
    </tr>
    <tr>
      <td><code>cache_references</code></td>
      <td>the count of cache hits by applications running on the platform</td>
      <td><code>perf.cache_references</code></td>
    </tr>
    <tr>
      <td><code>cache_misses</code></td>
      <td>the count of cache misses by applications running on the platform</td>
      <td><code>perf.cache_misses</code></td>
    </tr>
N
perf: add one more perf event support  
Nitesh Konkar 已提交
2315 2316 2317 2318 2319 
    <tr>
      <td><code>branch_instructions</code></td>
      <td>the count of branch instructions by applications running on the platform</td>
      <td><code>perf.branch_instructions</code></td>
    </tr>
N
perf: add branch_misses perf event support  
Nitesh Konkar 已提交
2320 2321 2322 2323 2324 
    <tr>
      <td><code>branch_misses</code></td>
      <td>the count of branch misses by applications running on the platform</td>
      <td><code>perf.branch_misses</code></td>
    </tr>
N
perf: add bus_cycles perf event support  
Nitesh Konkar 已提交
2325 2326 2327 2328 2329 
    <tr>
      <td><code>bus_cycles</code></td>
      <td>the count of bus cycles by applications running on the platform</td>
      <td><code>perf.bus_cycles</code></td>
    </tr>
N
perf: add stalled_cycles_frontend perf event support  
Nitesh Konkar 已提交
2330 2331 2332 2333 2334 2335 
    <tr>
      <td><code>stalled_cycles_frontend</code></td>
      <td>the count of stalled cpu cycles in the frontend of the instruction
          processor pipeline by applications running on the platform</td>
      <td><code>perf.stalled_cycles_frontend</code></td>
    </tr>
N
perf: add stalled_cycles_backend perf event support  
Nitesh Konkar 已提交
2336 2337 2338 2339 2340 2341 
    <tr>
      <td><code>stalled_cycles_backend</code></td>
      <td>the count of stalled cpu cycles in the backend of the instruction
          processor pipeline by applications running on the platform</td>
      <td><code>perf.stalled_cycles_backend</code></td>
    </tr>
N
perf: add ref_cpu_cycles perf event support  
Nitesh Konkar 已提交
2342 2343 2344 2345 2346 2347 
    <tr>
      <td><code>ref_cpu_cycles</code></td>
      <td>the count of total cpu cycles not affected by CPU frequency scaling
         by applications running on the platform</td>
      <td><code>perf.ref_cpu_cycles</code></td>
    </tr>
N
perf: add cpu_clock software perf event support  
Nitesh Konkar 已提交
2348 2349 2350 2351 2352 2353 2354 
    <tr>
      <td><code>cpu_clock</code></td>
      <td>the count of cpu clock time, as measured by a monotonic
          high-resolution per-CPU timer, by applications running on
          the platform</td>
      <td><code>perf.cpu_clock</code></td>
    </tr>
N
perf: add task_clock software perf event support  
Nitesh Konkar 已提交
2355 2356 2357 2358 2359 2360 2361 
    <tr>
      <td><code>task_clock</code></td>
      <td>the count of task clock time, as measured by a monotonic
          high-resolution CPU timer, specific to the task that
          is run by applications running on the platform</td>
      <td><code>perf.task_clock</code></td>
    </tr>
N
perf: add page_faults software perf event support  
Nitesh Konkar 已提交
2362 2363 2364 2365 2366 2367 2368 
    <tr>
      <td><code>page_faults</code></td>
      <td>the count of page faults by applications running on the
          platform. This includes minor, major, invalid and other
          types of page faults</td>
      <td><code>perf.page_faults</code></td>
    </tr>
N
perf: add context_switches software perf event support  
Nitesh Konkar 已提交
2369 2370 2371 2372 2373 2374 
    <tr>
      <td><code>context_switches</code></td>
      <td>the count of context switches by applications running on
          the platform</td>
      <td><code>perf.context_switches</code></td>
    </tr>
N
perf: add cpu_migrations software perf event support  
Nitesh Konkar 已提交
2375 2376 2377 2378 2379 2380 2381 
    <tr>
      <td><code>cpu_migrations</code></td>
      <td>the count of cpu migrations, that is, where the process
          moved from one logical processor to another, by
          applications running on the platform</td>
      <td><code>perf.cpu_migrations</code></td>
    </tr>
N
perf: add page_faults_min software perf event support  
Nitesh Konkar 已提交
2382 2383 2384 2385 2386 2387 2388 2389 
    <tr>
      <td><code>page_faults_min</code></td>
      <td>the count of minor page faults, that is, where the
          page was present in the page cache, and therefore
          the fault avoided loading it from storage, by
          applications running on the platform</td>
      <td><code>perf.page_faults_min</code></td>
    </tr>
N
perf: add page_faults_maj software perf event support  
Nitesh Konkar 已提交
2390 2391 2392 2393 2394 2395 2396 2397 
    <tr>
      <td><code>page_faults_maj</code></td>
      <td>the count of major page faults, that is, where the
          page was not present in the page cache, and
          therefore had to be fetched from storage, by
          applications running on the platform</td>
      <td><code>perf.page_faults_maj</code></td>
    </tr>
N
perf: add alignment_faults software perf event support  
Nitesh Konkar 已提交
2398 2399 2400 2401 2402 2403 2404 
    <tr>
      <td><code>alignment_faults</code></td>
      <td>the count of alignment faults, that is when
          the load or store is not aligned properly, by
          applications running on the platform</td>
      <td><code>perf.alignment_faults</code></td>
    </tr>
N
perf: add emulation_faults software perf event support  
Nitesh Konkar 已提交
2405 2406 2407 2408 2409 2410 2411 2412 
    <tr>
      <td><code>emulation_faults</code></td>
      <td>the count of emulation faults, that is when
          the kernel traps on unimplemented instrucions
          and emulates them for user space, by
          applications running on the platform</td>
      <td><code>perf.emulation_faults</code></td>
    </tr>
P
docs: Add at least some docs and fix schema entry for perf events  
Peter Krempa 已提交
2413 2414 
  </table>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
2415 
    <h3><a id="elementsDevices">Devices</a></h3>
D
Update domain XML docs  
Daniel P. Berrange 已提交
2416 2417 

    <p>
A
fix typos in docs  
Atsushi SAKAI 已提交
2418 
      The final set of XML elements are all used to describe devices
D
Update domain XML docs  
Daniel P. Berrange 已提交
2419 2420 2421 2422 2423 
      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>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
2424 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
2425 2426 2427 2428 2429 
...
&lt;devices&gt;
  &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
&lt;/devices&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
2430 2431 2432 2433 

    <dl>
      <dt><code>emulator</code></dt>
      <dd>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
2434 2435 2436 2437 2438 
        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
Update domain XML docs  
Daniel P. Berrange 已提交
2439 2440 2441 
      </dd>
    </dl>
M
docs: Document user aliases  
Michal Privoznik 已提交
2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 
    <p>
      To help users identifying devices they care about, every
      device can have direct child <code>alias</code> element
      which then has <code>name</code> attribute where users can
      store identifier for the device. The identifier has to have
      "ua-" prefix and must be unique within the domain. Additionally, the
      identifier must consist only of the following characters:
      <code>[a-zA-Z0-9_-]</code>.
      <span class="since">Since 3.9.0</span>
    </p>

<pre>
&lt;devices&gt;
  &lt;disk type='file'&gt;
    &lt;alias name='ua-myDisk'/&gt;
  &lt;/disk&gt;
  &lt;interface type='network' trustGuestRxFilters='yes'&gt;
    &lt;alias name='ua-myNIC'/&gt;
  &lt;/interface&gt;
  ...
&lt;/devices&gt;
</pre>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
2465 
    <h4><a id="elementsDisks">Hard drives, floppy disks, CDROMs</a></h4>
D
Update domain XML docs  
Daniel P. Berrange 已提交
2466 2467 2468 2469 2470 2471 2472 

    <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>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
2473 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 
...
&lt;devices&gt;
  &lt;disk type='file' snapshot='external'&gt;
    &lt;driver name="tap" type="aio" cache="default"/&gt;
    &lt;source file='/var/lib/xen/images/fv0' startupPolicy='optional'&gt;
      &lt;seclabel relabel='no'/&gt;
    &lt;/source&gt;
    &lt;target dev='hda' bus='ide'/&gt;
    &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;
    &lt;boot order='2'/&gt;
    &lt;encryption type='...'&gt;
M
update docs for network disks  
MORITA Kazutaka 已提交
2489 
      ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 
    &lt;/encryption&gt;
    &lt;shareable/&gt;
    &lt;serial&gt;
      ...
    &lt;/serial&gt;
  &lt;/disk&gt;
    ...
  &lt;disk type='network'&gt;
    &lt;driver name="qemu" type="raw" io="threads" ioeventfd="on" event_idx="off"/&gt;
    &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;
    &lt;boot order='1'/&gt;
    &lt;transient/&gt;
    &lt;address type='drive' controller='0' bus='1' unit='0'/&gt;
  &lt;/disk&gt;
  &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;snapshot name="snapname"/&gt;
      &lt;config file="/path/to/file"/&gt;
J
conf: Add/Allow parsing the auth in the disk source  
John Ferlan 已提交
2513 2514 2515 
      &lt;auth username='myuser'&gt;
        &lt;secret type='ceph' usage='mypassid'/&gt;
      &lt;/auth&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 
    &lt;/source&gt;
    &lt;target dev="hdc" bus="ide"/&gt;
  &lt;/disk&gt;
  &lt;disk type='block' device='cdrom'&gt;
    &lt;driver name='qemu' type='raw'/&gt;
    &lt;target dev='hdd' bus='ide' tray='open'/&gt;
    &lt;readonly/&gt;
  &lt;/disk&gt;
  &lt;disk type='network' device='cdrom'&gt;
    &lt;driver name='qemu' type='raw'/&gt;
    &lt;source protocol="http" name="url_path"&gt;
      &lt;host name="hostname" port="80"/&gt;
    &lt;/source&gt;
    &lt;target dev='hde' bus='ide' tray='open'/&gt;
    &lt;readonly/&gt;
  &lt;/disk&gt;
  &lt;disk type='network' device='cdrom'&gt;
    &lt;driver name='qemu' type='raw'/&gt;
    &lt;source protocol="https" name="url_path"&gt;
      &lt;host name="hostname" port="443"/&gt;
    &lt;/source&gt;
    &lt;target dev='hdf' bus='ide' tray='open'/&gt;
    &lt;readonly/&gt;
  &lt;/disk&gt;
  &lt;disk type='network' device='cdrom'&gt;
    &lt;driver name='qemu' type='raw'/&gt;
    &lt;source protocol="ftp" name="url_path"&gt;
      &lt;host name="hostname" port="21"/&gt;
    &lt;/source&gt;
    &lt;target dev='hdg' bus='ide' tray='open'/&gt;
    &lt;readonly/&gt;
  &lt;/disk&gt;
  &lt;disk type='network' device='cdrom'&gt;
    &lt;driver name='qemu' type='raw'/&gt;
    &lt;source protocol="ftps" name="url_path"&gt;
      &lt;host name="hostname" port="990"/&gt;
    &lt;/source&gt;
    &lt;target dev='hdh' bus='ide' tray='open'/&gt;
    &lt;readonly/&gt;
  &lt;/disk&gt;
  &lt;disk type='network' device='cdrom'&gt;
    &lt;driver name='qemu' type='raw'/&gt;
    &lt;source protocol="tftp" name="url_path"&gt;
      &lt;host name="hostname" port="69"/&gt;
    &lt;/source&gt;
    &lt;target dev='hdi' bus='ide' tray='open'/&gt;
    &lt;readonly/&gt;
  &lt;/disk&gt;
  &lt;disk type='block' device='lun'&gt;
    &lt;driver name='qemu' type='raw'/&gt;
    &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;
  &lt;/disk&gt;
  &lt;disk type='block' device='disk'&gt;
    &lt;driver name='qemu' type='raw'/&gt;
    &lt;source dev='/dev/sda'/&gt;
    &lt;geometry cyls='16383' heads='16' secs='63' trans='lba'/&gt;
    &lt;blockio logical_block_size='512' physical_block_size='4096'/&gt;
    &lt;target dev='hdj' bus='ide'/&gt;
  &lt;/disk&gt;
  &lt;disk type='volume' device='disk'&gt;
    &lt;driver name='qemu' type='raw'/&gt;
    &lt;source pool='blk-pool0' volume='blk-pool0-vol0'/&gt;
    &lt;target dev='hdk' bus='ide'/&gt;
  &lt;/disk&gt;
  &lt;disk type='network' device='disk'&gt;
    &lt;driver name='qemu' type='raw'/&gt;
    &lt;source protocol='iscsi' name='iqn.2013-07.com.example:iscsi-nopool/2'&gt;
      &lt;host name='example.com' port='3260'/&gt;
J
conf: Add/Allow parsing the auth in the disk source  
John Ferlan 已提交
2586 2587 2588 
      &lt;auth username='myuser'&gt;
        &lt;secret type='iscsi' usage='libvirtiscsi'/&gt;
      &lt;/auth&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
2589 2590 2591 2592 2593 2594 2595 
    &lt;/source&gt;
    &lt;target dev='vda' bus='virtio'/&gt;
  &lt;/disk&gt;
  &lt;disk type='network' device='lun'&gt;
    &lt;driver name='qemu' type='raw'/&gt;
    &lt;source protocol='iscsi' name='iqn.2013-07.com.example:iscsi-nopool/1'&gt;
      &lt;host name='example.com' port='3260'/&gt;
J
conf: Add/Allow parsing the auth in the disk source  
John Ferlan 已提交
2596 2597 2598 
      &lt;auth username='myuser'&gt;
        &lt;secret type='iscsi' usage='libvirtiscsi'/&gt;
      &lt;/auth&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 
    &lt;/source&gt;
    &lt;target dev='sdb' bus='scsi'/&gt;
  &lt;/disk&gt;
  &lt;disk type='volume' device='disk'&gt;
    &lt;driver name='qemu' type='raw'/&gt;
    &lt;source pool='iscsi-pool' volume='unit:0:0:1' mode='host'/&gt;
    &lt;target dev='vdb' bus='virtio'/&gt;
  &lt;/disk&gt;
  &lt;disk type='volume' device='disk'&gt;
    &lt;driver name='qemu' type='raw'/&gt;
    &lt;source pool='iscsi-pool' volume='unit:0:0:2' mode='direct'/&gt;
    &lt;target dev='vdc' bus='virtio'/&gt;
  &lt;/disk&gt;
  &lt;disk type='file' device='disk'&gt;
L
qemu: Support multiqueue virtio-blk  
Lin Ma 已提交
2613 
    &lt;driver name='qemu' type='qcow2' queues='4'/&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
2614 2615 2616 2617 2618 2619 2620 2621 
    &lt;source file='/var/lib/libvirt/images/domain.qcow'/&gt;
    &lt;backingStore type='file'&gt;
      &lt;format type='qcow2'/&gt;
      &lt;source file='/var/lib/libvirt/images/snapshot.qcow'/&gt;
      &lt;backingStore type='block'&gt;
        &lt;format type='raw'/&gt;
        &lt;source dev='/dev/mapper/base'/&gt;
        &lt;backingStore/&gt;
J
conf: Output disk backing store details in domain XML  
Jiri Denemark 已提交
2622 
      &lt;/backingStore&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
2623 2624 2625 2626 2627 
    &lt;/backingStore&gt;
    &lt;target dev='vdd' bus='virtio'/&gt;
  &lt;/disk&gt;
&lt;/devices&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
2628 2629 2630 

    <dl>
      <dt><code>disk</code></dt>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2631 2632 
      <dd>The <code>disk</code> element is the main container for
      describing disks and supports the following attributes:
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
2633 
        <dl>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2634 
          <dt><code>type</code></dt>
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
2635 2636 2637 2638 2639 2640 
            <dd>
            Valid values are "file", "block",
            "dir" (<span class="since">since 0.7.5</span>),
            "network" (<span class="since">since 0.8.7</span>), or
            "volume" (<span class="since">since 1.0.5</span>)
            and refer to the underlying source for the disk.
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2641 
            <span class="since">Since 0.0.3</span>
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
2642 
            </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2643 
          <dt><code>device</code></dt>
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
2644 2645 2646 2647 2648 2649 
            <dd>
            Indicates how the disk is to be exposed to the guest OS. Possible
            values for this attribute are "floppy", "disk", "cdrom", and "lun",
            defaulting to "disk".
            <p>
            Using "lun" (<span class="since">since 0.9.10</span>) is only
J
scsi: Need to translate disk source pool in config attach path  
John Ferlan 已提交
2650 2651 
            valid when the <code>type</code> is "block" or "network" for
            <code>protocol='iscsi'</code> or when the <code>type</code>
J
docs: Clarification for when allowed to use 'lun' for "volume"  
John Ferlan 已提交
2652 
            is "volume" when using an iSCSI source <code>pool</code>
J
docs: Add Fibre Channel NPIV supported option for volume lun config  
John Ferlan 已提交
2653 2654 2655 
            for <code>mode</code> "host" or as an
            <a href="http://wiki.libvirt.org/page/NPIV_in_libvirt">NPIV</a>
            virtual Host Bus Adapter (vHBA) using a Fibre Channel storage pool.
J
scsi: Need to translate disk source pool in config attach path  
John Ferlan 已提交
2656 
            Configured in this manner, the LUN behaves identically to "disk",
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
2657 2658 2659 2660 2661 2662 
            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,
            but never for individual partitions or LVM partitions (in those
            cases, the kernel will reject the generic SCSI commands, making
            it identical to device='disk').
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2663 
            <span class="since">Since 0.1.4</span>
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
2664 2665 
            </p>
            </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2666 
          <dt><code>rawio</code></dt>
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
2667 
            <dd>
J
hostdev: Add "rawio" attribute to _virDomainHostdevSubsysSCSI  
John Ferlan 已提交
2668 
            Indicates whether the disk needs rawio capability. Valid
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 
            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". NB, <code>rawio</code> intends
            to confine the capability per-device, however, current QEMU
            implementation gives the domain process broader capability
            than that (per-process basis, affects all the domain disks).
            To confine the capability as much as possible for QEMU driver
            as this stage, <code>sgio</code> is recommended, it's more
            secure than <code>rawio</code>.
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2680 
            <span class="since">Since 0.9.10</span>
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
2681 
            </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2682 
          <dt><code>sgio</code></dt>
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
2683 
            <dd>
J
docs: Clarify unprivileged sgio feature  
John Ferlan 已提交
2684 2685 2686 2687 
            If supported by the hypervisor and OS, indicates whether
            unprivileged SG_IO commands are filtered for the disk. Valid
            settings are "filtered" or "unfiltered" where the default is
            "filtered". Only available when the <code>device</code> is 'lun'.
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2688 
            <span class="since">Since 1.0.2</span>
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
2689 
            </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2690 
          <dt><code>snapshot</code></dt>
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
2691 2692 
            <dd>
            Indicates the default behavior of the disk during disk snapshots:
P
docs: domain: Fix documentation of the 'snapshot' attribute for <disk>  
Peter Krempa 已提交
2693 2694 2695 2696 2697 2698 2699 
            "<code>internal</code>" requires a file format such as qcow2 that
            can store both the snapshot and the data changes since the snapshot;
            "<code>external</code>" will separate the snapshot from the live
            data; and "<code>no</code>" means the disk will not participate in
            snapshots. Read-only disks default to "<code>no</code>", while the
            default for other disks depends on the hypervisor's capabilities.
            Some hypervisors allow a per-snapshot choice as well, during
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
2700 
            <a href="formatsnapshot.html">domain snapshot creation</a>.
P
docs: domain: Fix documentation of the 'snapshot' attribute for <disk>  
Peter Krempa 已提交
2701 2702 
            Not all snapshot modes are supported; for example, enabling
            snapshots with a transient disk generally does not make sense.
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2703 
            <span class="since">Since 0.9.5</span>
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
2704 2705 2706 
            </dd>
        </dl>
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
2707 
      <dt><code>source</code></dt>
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2708 2709 2710 
      <dd>Representation of the disk <code>source</code> depends on the
      disk <code>type</code> attribute value as follows:
          <dl>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2711 
            <dt><code>file</code></dt>
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2712 2713 2714 
              <dd>
              The <code>file</code> attribute specifies the fully-qualified
              path to the file holding the disk.
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2715 
              <span class="since">Since 0.0.3</span>
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2716 
              </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2717 
            <dt><code>block</code></dt>
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2718 
              <dd>
E
doc: Add info (where necessary) that paths should be specified as absolute  
Erik Skultety 已提交
2719 2720 
              The <code>dev</code> attribute specifies the fully-qualified path
              to the host device to serve as the disk.
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2721 
              <span class="since">Since 0.0.3</span>
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2722 
              </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2723 
            <dt><code>dir</code></dt>
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2724 2725 2726 
              <dd>
              The <code>dir</code> attribute specifies the fully-qualified path
              to the directory to use as the disk.
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2727 
              <span class="since">Since 0.7.5</span>
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2728 
              </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2729 
            <dt><code>network</code></dt>
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2730 2731 2732 
              <dd>
              The <code>protocol</code> attribute specifies the protocol to
              access to the requested image. Possible values are "nbd",
J
docs: Clean up the description for network disk protocol options  
John Ferlan 已提交
2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 
              "iscsi", "rbd", "sheepdog", "gluster" or "vxhs".

              <p>If the <code>protocol</code> attribute is "rbd", "sheepdog",
              "gluster", or "vxhs", an additional attribute <code>name</code>
              is mandatory to specify which volume/image will be used.
              </p>

              <p>For "nbd", the <code>name</code> attribute is optional.
              </p>

              <p>For "iscsi" (<span class="since">since 1.0.4</span>), the
              <code>name</code> attribute may include a logical unit number,
              separated from the target's name by a slash (e.g.,
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2746 2747 
              <code>iqn.2013-07.com.example:iscsi-pool/1</code>). If not
              specified, the default LUN is zero.
J
docs: Clean up the description for network disk protocol options  
John Ferlan 已提交
2748 2749 
              </p>
A
util: Add TLS attributes to virStorageSource  
Ashish Mittal 已提交
2750 
              <p>For "vxhs" (<span class="since">since 3.8.0</span>), the
A
docs: Add schema and docs for Veritas HyperScale (VxHS)  
Ashish Mittal 已提交
2751 
              <code>name</code> is the UUID of the volume, assigned by the
A
util: Add TLS attributes to virStorageSource  
Ashish Mittal 已提交
2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 
              HyperScale server. Additionally, an optional attribute
              <code>tls</code> (QEMU only) can be used to control whether a
              VxHS block device would utilize a hypervisor configured TLS
              X.509 certificate environment in order to encrypt the data
              channel. For the QEMU hypervisor, usage of a TLS environment can
              also be globally controlled on the host by the
              <code>vxhs_tls</code> and <code>vxhs_tls_x509_cert_dir</code> or
              <code>default_tls_x509_cert_dir</code> settings in the file
              /etc/libvirt/qemu.conf. If <code>vxhs_tls</code> is enabled,
              then unless the domain <code>tls</code> attribute is set to "no",
              libvirt will use the host configured TLS environment. If the
              <code>tls</code> attribute is set to "yes", then regardless of
              the qemu.conf setting, TLS authentication will be attempted.
J
docs: Clean up the description for network disk protocol options  
John Ferlan 已提交
2765 
              </p>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2766 
              <span class="since">Since 0.8.7</span>
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2767 
              </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2768 
            <dt><code>volume</code></dt>
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 
              <dd>
              The underlying disk source is represented by attributes
              <code>pool</code> and <code>volume</code>. Attribute
              <code>pool</code> specifies the name of the
              <a href="formatstorage.html">storage pool</a> (managed
              by libvirt) where the disk source resides. Attribute
              <code>volume</code> specifies the name of storage volume (managed
              by libvirt) used as the disk source. The value for the
              <code>volume</code> attribute will be the output from the "Name"
              column of a <code>virsh vol-list [pool-name]</code> command.
              <p>
              Use the attribute <code>mode</code>
              (<span class="since">since 1.1.1</span>) to indicate how to
              represent the LUN as the disk source. Valid values are
              "direct" and "host". If <code>mode</code> is not specified,
              the default is to use "host".

              Using "direct" as the <code>mode</code> value indicates to use
              the <a href="formatstorage.html">storage pool's</a>
              <code>source</code> element <code>host</code> attribute as
              the disk source to generate the libiscsi URI (e.g.
              'file=iscsi://example.com:3260/iqn.2013-07.com.example:iscsi-pool/1').

              Using "host" as the <code>mode</code> value indicates to use the
              LUN's path as it shows up on host (e.g.
              'file=/dev/disk/by-path/ip-example.com:3260-iscsi-iqn.2013-07.com.example:iscsi-pool-lun-1').
J
scsi: Need to translate disk source pool in config attach path  
John Ferlan 已提交
2795 2796 2797 

              Using a LUN from an iSCSI source pool provides the same
              features as a <code>disk</code> configured using
J
docs: Fix disk "volume" description  
John Ferlan 已提交
2798 
              <code>type</code> 'block' or 'network' and <code>device</code>
J
scsi: Need to translate disk source pool in config attach path  
John Ferlan 已提交
2799 
              of 'lun' with respect to how the LUN is presented to and
J
docs: Fix disk "volume" description  
John Ferlan 已提交
2800 
              may be used by the guest.
J
scsi: Need to translate disk source pool in config attach path  
John Ferlan 已提交
2801
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2802 
              <span class="since">Since 1.0.5</span>
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2803 2804 2805 2806 
              </p>
              </dd>
          </dl>
        With "file", "block", and "volume", one or more optional
M
Multiple security drivers in XML data  
Marcelo Cerri 已提交
2807 
        sub-elements <code>seclabel</code>, <a href="#seclabel">described
E
seclabel: extend XML to allow per-disk label overrides  
Eric Blake 已提交
2808 2809 
        below</a> (and <span class="since">since 0.9.9</span>), can be
        used to override the domain security labeling policy for just
O
Support seclabels for volume type disk  
Osier Yang 已提交
2810 2811 
        that source file. (NB, for "volume" type disk, <code>seclabel</code>
        is only valid when the specified storage volume is of 'file' or
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2812 2813 
        'block' type).
        <p>
P
storage: rbd: qemu: Add support for specifying internal RBD snapshots  
Peter Krempa 已提交
2814 
        The <code>source</code> element may contain the following sub elements:
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2815 
        </p>
P
docs: domain: Move docs for storage hosts under the <source> element  
Peter Krempa 已提交
2816 2817 2818 2819 2820 

        <dl>
          <dt><code>host</code></dt>
          <dd>
            <p>
P
storage: rbd: qemu: Add support for specifying internal RBD snapshots  
Peter Krempa 已提交
2821 2822 2823 2824 
            When the disk <code>type</code> is "network", the <code>source</code>
            may have zero or more <code>host</code> sub-elements used to
            specify the hosts to connect.
P
docs: domain: Move docs for storage hosts under the <source> element  
Peter Krempa 已提交
2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 
            The <code>host</code> element supports 4 attributes, viz.  "name",
            "port", "transport" and "socket", which specify the hostname,
            the port number, transport type and path to socket, respectively.
            The meaning of this element and the number of the elements depend
            on the protocol attribute.
            </p>
            <table class="top_table">
              <tr>
                <th> Protocol </th>
                <th> Meaning </th>
                <th> Number of hosts </th>
                <th> Default port </th>
              </tr>
              <tr>
                <td> nbd </td>
                <td> a server running nbd-server </td>
                <td> only one </td>
                <td> 10809 </td>
              </tr>
              <tr>
                <td> iscsi </td>
                <td> an iSCSI server </td>
                <td> only one </td>
                <td> 3260 </td>
              </tr>
              <tr>
                <td> rbd </td>
                <td> monitor servers of RBD </td>
                <td> one or more </td>
W
rbd: Do not append Ceph monitor port number 6789 if not provided  
Wido den Hollander 已提交
2854 
                <td> librados default </td>
P
docs: domain: Move docs for storage hosts under the <source> element  
Peter Krempa 已提交
2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 
              </tr>
              <tr>
                <td> sheepdog </td>
                <td> one of the sheepdog servers (default is localhost:7000) </td>
                <td> zero or one </td>
                <td> 7000 </td>
              </tr>
              <tr>
                <td> gluster </td>
                <td> a server running glusterd daemon </td>
P
qemu: command: Add support for multi-host gluster disks  
Prasanna Kumar Kalever 已提交
2865 
                <td> one or more (<span class="since">Since 2.1.0</span>), just one prior to that </td>
P
docs: domain: Move docs for storage hosts under the <source> element  
Peter Krempa 已提交
2866 2867 
                <td> 24007 </td>
              </tr>
A
docs: Add schema and docs for Veritas HyperScale (VxHS)  
Ashish Mittal 已提交
2868 2869 2870 2871 2872 2873 
              <tr>
                <td> vxhs </td>
                <td> a server running Veritas HyperScale daemon </td>
                <td> only one </td>
                <td> 9999 </td>
              </tr>
P
docs: domain: Move docs for storage hosts under the <source> element  
Peter Krempa 已提交
2874 2875 2876 2877 2878 2879 2880 2881 2882 
            </table>
            <p>
            gluster supports "tcp", "rdma", "unix" as valid values for the
            transport attribute.  nbd supports "tcp" and "unix".  Others only
            support "tcp".  If nothing is specified, "tcp" is assumed. If the
            transport is "unix", the socket attribute specifies the path to an
            AF_UNIX socket.
            </p>
          </dd>
P
storage: rbd: qemu: Add support for specifying internal RBD snapshots  
Peter Krempa 已提交
2883 2884 2885 2886 2887 2888 2889 
          <dt><code>snapshot</code></dt>
          <dd>
            The <code>name</code> attribute of <code>snapshot</code> element can
            optionally specify an internal snapshot name to be used as the
            source for storage protocols.
            Supported for 'rbd' <span class="since">since 1.2.11 (QEMU only).</span>
          </dd>
P
storage: rbd: Implement support for passing config file option  
Peter Krempa 已提交
2890 2891 2892 2893 2894 2895 2896 2897 
          <dt><code>config</code></dt>
          <dd>
            The <code>file</code> attribute for the <code>config</code> element
            provides a fully qualified path to a configuration file to be
            provided as a parameter to the client of a networked storage
            protocol. Supported for 'rbd' <span class="since">since 1.2.11
            (QEMU only).</span>
          </dd>
J
conf: Add/Allow parsing the auth in the disk source  
John Ferlan 已提交
2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 
          <dt><code>auth</code></dt>
          <dd><span class="since">Since libvirt 3.9.0</span>, the
            <code>auth</code> element is supported for a disk
            <code>type</code> "network" that is using a <code>source</code>
            element with the <code>protocol</code> attributes "rbd" or "iscsi".
            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).
            Known secret types are "ceph" for Ceph RBD network sources and
            "iscsi" for CHAP authentication of iSCSI targets.
            Both will require either a <code>uuid</code> attribute
            with the UUID of the secret object or a <code>usage</code>
            attribute matching the key that was specified in the
            secret object.
          </dd>
J
docs: Add missing element encryption description term entry  
John Ferlan 已提交
2920 
          <dt><code>encryption</code></dt>
J
conf: Add/Allow parsing the encryption in the disk source  
John Ferlan 已提交
2921 2922 2923 2924 2925 2926 2927 2928 
          <dd><span class="since">Since libvirt 3.9.0</span>, the
            <code>encryption</code> can be a sub-element of the
            <code>source</code> element for encrypted storage sources.
            If present, specifies how the storage source is encrypted
            See the
            <a href="formatstorageencryption.html">Storage Encryption</a>
            page for more information.
          </dd>
P
docs: domain: Move docs for storage hosts under the <source> element  
Peter Krempa 已提交
2929 2930 
        </dl>
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2931 
        <p>
O
Support startupPolicy for 'volume' disk  
Osier Yang 已提交
2932 
        For a "file" or "volume" disk type which represents a cdrom or floppy
C
Add documentation for <disk><source type="dir">  
Christophe Fergeau 已提交
2933 2934 
        (the <code>device</code> attribute), it is possible to define
        policy what to do with the disk if the source file is not accessible.
O
Support startupPolicy for 'volume' disk  
Osier Yang 已提交
2935 2936 
        (NB, <code>startupPolicy</code> is not valid for "volume" disk unless
         the specified storage volume is of "file" type). This is done by the
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2937 2938 
        <code>startupPolicy</code> attribute
        (<span class="since">since 0.9.7</span>),
G
conf: add startupPolicy attribute for harddisk  
Guannan Ren 已提交
2939 
        accepting these values:
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2940 
        </p>
M
conf: Introduce optional startupPolicy attribute for cdrom and floppy  
Michal Privoznik 已提交
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 
        <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>
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2956 2957 2958 2959 2960 2961 2962 
        <p>
        <span class="since">Since 1.1.2</span> the <code>startupPolicy</code>
        is extended to support hard disks besides cdrom and floppy. On guest
        cold bootup, if a certain disk is not accessible or its disk chain is
        broken, with startupPolicy 'optional' the guest will drop this disk.
        This feature doesn't support migration currently.
        </p>
M
conf: Introduce optional startupPolicy attribute for cdrom and floppy  
Michal Privoznik 已提交
2963 
        </dd>
J
conf: Output disk backing store details in domain XML  
Jiri Denemark 已提交
2964 2965 
      <dt><code>backingStore</code></dt>
      <dd>
D
doc: Fix doc for backingStore  
Deepak Shetty 已提交
2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 
        This element describes the backing store used by the disk
        specified by sibling <code>source</code> element. It is
        currently ignored on input and only used for output to
        describe the detected backing chains of running
        domains <span class="since">since 1.2.4</span> (although a
        future version of libvirt may start accepting chains on input,
        or output information for offline domains). An
        empty <code>backingStore</code> element means the sibling
        source is self-contained and is not based on any backing
        store. For backing chain information to be accurate, the
        backing format must be correctly specified in the metadata of
        each file of the chain (files created by libvirt satisfy this
        property, but using existing external files for snapshot or
        block copy operations requires the end user to pre-create the
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2980 
        file correctly). The following attributes are
D
doc: Fix doc for backingStore  
Deepak Shetty 已提交
2981 
        supported in <code>backingStore</code>:
J
conf: Output disk backing store details in domain XML  
Jiri Denemark 已提交
2982 
        <dl>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2983 
          <dt><code>type</code></dt>
J
conf: Output disk backing store details in domain XML  
Jiri Denemark 已提交
2984 2985 2986 2987 2988 
          <dd>
            The <code>type</code> attribute represents the type of disk used
            by the backing store, see disk type attribute above for more
            details and possible values.
          </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2989 
          <dt><code>index</code></dt>
J
conf: Output disk backing store details in domain XML  
Jiri Denemark 已提交
2990 2991 2992 2993 2994 2995 2996 2997 
          <dd>
            This attribute is only valid in output (and ignored on input) and
            it can be used to refer to a specific part of the disk chain when
            doing block operations (such as via the
            <code>virDomainBlockRebase</code> API). For example,
            <code>vda[2]</code> refers to the backing store with
            <code>index='2'</code> of the disk with <code>vda</code> target.
          </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
2998 2999 3000 3001 
        </dl>
        Moreover, <code>backingStore</code> supports the following sub-elements:
        <dl>
          <dt><code>format</code></dt>
J
conf: Output disk backing store details in domain XML  
Jiri Denemark 已提交
3002 3003 3004 3005 3006 
          <dd>
            The <code>format</code> element contains <code>type</code>
            attribute which specifies the internal format of the backing
            store, such as <code>raw</code> or <code>qcow2</code>.
          </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3007 
          <dt><code>source</code></dt>
J
conf: Output disk backing store details in domain XML  
Jiri Denemark 已提交
3008 3009 3010 3011 3012 3013 
          <dd>
            This element has the same structure as the <code>source</code>
            element in <code>disk</code>. It specifies which file, device,
            or network location contains the data of the described backing
            store.
          </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3014 
          <dt><code>backingStore</code></dt>
J
conf: Output disk backing store details in domain XML  
Jiri Denemark 已提交
3015 3016 3017 3018 3019 3020 3021 
          <dd>
            If the backing store is not self-contained, the next element
            in the chain is described by nested <code>backingStore</code>
            element.
          </dd>
        </dl>
      </dd>
E
blockjob: enhance xml to track mirrors across libvirtd restart  
Eric Blake 已提交
3022 3023 
      <dt><code>mirror</code></dt>
      <dd>
E
blockcommit: track job type in xml  
Eric Blake 已提交
3024 3025 3026 3027 
        This element is present if the hypervisor has started a
        long-running block job operation, where the mirror location in
        the <code>source</code> sub-element will eventually have the
        same contents as the source, and with the file format in the
E
conf: alter disk mirror xml output  
Eric Blake 已提交
3028 3029 3030 3031 
        sub-element <code>format</code> (which might differ from the
        format of the source).  The details of the <code>source</code>
        sub-element are determined by the <code>type</code> attribute
        of the mirror, similar to what is done for the
E
blockcommit: track job type in xml  
Eric Blake 已提交
3032 3033 3034 3035 3036 
        overall <code>disk</code> device element. The <code>job</code>
        attribute mentions which API started the operation ("copy" for
        the <code>virDomainBlockRebase</code> API, or "active-commit"
        for the <code>virDomainBlockCommit</code>
        API), <span class="since">since 1.2.7</span>.  The
E
blockcopy: add more XML for state tracking  
Eric Blake 已提交
3037 3038 3039 3040 3041 3042 
        attribute <code>ready</code>, if present, tracks progress of
        the job: <code>yes</code> if the disk is known to be ready to
        pivot, or, <span class="since">since
        1.2.7</span>, <code>abort</code> or <code>pivot</code> if the
        job is in the process of completing.  If <code>ready</code> is
        not present, the disk is probably still
E
blockjob: enhance xml to track mirrors across libvirtd restart  
Eric Blake 已提交
3043 
        copying.  For now, this element only valid in output; it is
E
blockjob: don't remove older-style mirror XML  
Eric Blake 已提交
3044 3045 3046 3047 3048 3049 3050 
        ignored on input.  The <code>source</code> sub-element exists
        for all two-phase jobs <span class="since">since 1.2.6</span>.
        Older libvirt supported only block copy to a
        file, <span class="since">since 0.9.12</span>; for
        compatibility with older clients, such jobs include redundant
        information in the attributes <code>file</code>
        and <code>format</code> in the <code>mirror</code> element.
E
blockjob: enhance xml to track mirrors across libvirtd restart  
Eric Blake 已提交
3051 
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
3052 
      <dt><code>target</code></dt>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
3053 3054 3055 3056 3057 3058 3059 3060 
      <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
C
domain_conf: Add disk bus=sd, wire it up for qemu  
Cole Robinson 已提交
3061 3062 
        "ide", "scsi", "virtio", "xen", "usb", "sata", or
        "sd" <span class="since">"sd" since 1.1.2</span>. If omitted, the bus
M
docs: aesthetical cleanups  
Martin Kletzander 已提交
3063 3064 
        type is inferred from the style of the device name (e.g. a device named
        'sda' will typically be exported using a SCSI bus). The optional
O
docs: Add documentation for new attribute tray of disk target  
Osier Yang 已提交
3065 3066 3067 3068 
        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.
F
qemu: Support setting the 'removable' flag for USB disks  
Fred A. Kemp 已提交
3069 3070 3071 3072 
        The optional attribute <code>removable</code> sets the
        removable flag for USB disks, and its value can be either "on"
        or "off", defaulting to "off". <span class="since">Since
        0.0.3; <code>bus</code> attribute since 0.4.3;
O
docs: Add documentation for new attribute tray of disk target  
Osier Yang 已提交
3073 
        <code>tray</code> attribute since 0.9.11; "usb" attribute value since
F
qemu: Support setting the 'removable' flag for USB disks  
Fred A. Kemp 已提交
3074 3075 
        after 0.4.4; "sata" attribute value since 0.9.7; "removable" attribute
        value since 1.1.3</span>
O
docs: Add documentation for new attribute tray of disk target  
Osier Yang 已提交
3076 
      </dd>
L
Support block I/O throttle in XML  
Lei Li 已提交
3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 
      <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>
M
qemu: Modify the structure _virDomainBlockIoTuneInfo.  
Matthias Gatto 已提交
3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 
          <dt><code>total_bytes_sec_max</code></dt>
          <dd>The optional <code>total_bytes_sec_max</code> element is the
            maximum total throughput limit in bytes per second.  This cannot
            appear with <code>read_bytes_sec_max</code>
            or <code>write_bytes_sec_max</code>.</dd>
          <dt><code>read_bytes_sec_max</code></dt>
          <dd>The optional <code>read_bytes_sec_max</code> element is the
            maximum read throughput limit in bytes per second.</dd>
          <dt><code>write_bytes_sec_max</code></dt>
          <dd>The optional <code>write_bytes_sec_max</code> element is the
            maximum write throughput limit in bytes per second.</dd>
          <dt><code>total_iops_sec_max</code></dt>
          <dd>The optional <code>total_iops_sec_max</code> element is the
            maximum total I/O operations per second.  This cannot
            appear with <code>read_iops_sec_max</code>
            or <code>write_iops_sec_max</code>.</dd>
          <dt><code>read_iops_sec_max</code></dt>
          <dd>The optional <code>read_iops_sec_max</code> element is the
            maximum read I/O operations per second.</dd>
          <dt><code>write_iops_sec_max</code></dt>
          <dd>The optional <code>write_iops_sec_max</code> element is the
            maximum write I/O operations per second.</dd>
          <dt><code>size_iops_sec</code></dt>
          <dd>The optional <code>size_iops_sec</code> element is the
J
conf: Add support for blkiotune "_length" options  
John Ferlan 已提交
3134 3135 3136 3137 3138 
            size of I/O operations per second.
          <p>
            <span class="since">Throughput limits since 1.2.11 and QEMU 1.7</span>
          </p>
          </dd>
J
conf: Add support for blkiotune group_name option  
John Ferlan 已提交
3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 
          <dt><code>group_name</code></dt>
          <dd>The optional <code>group_name</code> provides the cability
            to share I/O throttling quota between multiple drives. This
            prevents end-users from circumventing a hosting provider's
            throttling policy by splitting 1 large drive in N small drives
            and getting N times the normal throttling quota. Any name may
            be used.
          <p>
            <span class="since">group_name since 3.0.0 and QEMU 2.4</span>
          </p>
          </dd>
J
conf: Add support for blkiotune "_length" options  
John Ferlan 已提交
3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 
          <dt><code>total_bytes_sec_max_length</code></dt>
          <dd>The optional <code>total_bytes_sec_max_length</code>
            element is the maximum duration in seconds for the
            <code>total_bytes_sec_max</code> burst period. Only valid
            when the <code>total_bytes_sec_max</code> is set.</dd>
          <dt><code>read_bytes_sec_max_length</code></dt>
          <dd>The optional <code>read_bytes_sec_max_length</code>
            element is the maximum duration in seconds for the
            <code>read_bytes_sec_max</code> burst period. Only valid
            when the <code>read_bytes_sec_max</code> is set.</dd>
          <dt><code>write_bytes_sec_max</code></dt>
          <dd>The optional <code>write_bytes_sec_max_length</code>
            element is the maximum duration in seconds for the
            <code>write_bytes_sec_max</code> burst period. Only valid
            when the <code>write_bytes_sec_max</code> is set.</dd>
          <dt><code>total_iops_sec_max_length</code></dt>
          <dd>The optional <code>total_iops_sec_max_length</code>
            element is the maximum duration in seconds for the
            <code>total_iops_sec_max</code> burst period. Only valid
            when the <code>total_iops_sec_max</code> is set.</dd>
          <dt><code>read_iops_sec_max_length</code></dt>
          <dd>The optional <code>read_iops_sec_max_length</code>
            element is the maximum duration in seconds for the
            <code>read_iops_sec_max</code> burst period. Only valid
            when the <code>read_iops_sec_max</code> is set.</dd>
          <dt><code>write_iops_sec_max</code></dt>
          <dd>The optional <code>write_iops_sec_max_length</code>
            element is the maximum duration in seconds for the
            <code>write_iops_sec_max</code> burst period. Only valid
            when the <code>write_iops_sec_max</code> is set.
          <p>
            <span class="since">Throughput length since 2.4.0 and QEMU 2.6</span>
          </p>
          </dd>
L
Support block I/O throttle in XML  
Lei Li 已提交
3184 
        </dl>
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
3185 
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
3186 
      <dt><code>driver</code></dt>
M
qemu aio: add XML parsing  
Matthias Dahl 已提交
3187 3188 3189 
      <dd>
        The optional driver element allows specifying further details
        related to the hypervisor driver used to provide the disk.
C
docs/formatdomain: Add release info for disk <driver> attributes  
Cole Robinson 已提交
3190 
        <span class="since">Since 0.1.8</span>
M
qemu aio: add XML parsing  
Matthias Dahl 已提交
3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 
        <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",
O
Add unsafe cache mode support for disk driver  
Oskari Saarenmaa 已提交
3205 3206 3207 3208 3209 3210 3211 3212 3213 
            "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
qemu aio: add XML parsing  
Matthias Dahl 已提交
3214 3215 3216 
          </li>
          <li>
            The optional <code>error_policy</code> attribute controls
L
qemu: add separate rerror_policy for disk errors  
Laine Stump 已提交
3217 3218 3219 
            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
P
doc: Correct the default werror policy  
Philipp Hahn 已提交
3220 3221 
            0.9.7</span> The default is left to the discretion of the
            hypervisor. There is also an
L
qemu: add separate rerror_policy for disk errors  
Laine Stump 已提交
3222 3223 
            optional <code>rerror_policy</code> that controls behavior
            for read errors only. <span class="since">Since
E
docs: fix html bug  
Eric Blake 已提交
3224 
            0.9.7</span>. If no rerror_policy is given, error_policy
L
qemu: add separate rerror_policy for disk errors  
Laine Stump 已提交
3225 3226 3227 3228 3229 
            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
P
doc: Correct the default werror policy  
Philipp Hahn 已提交
3230 
            given, the read error policy will be left at its default.
M
qemu aio: add XML parsing  
Matthias Dahl 已提交
3231 3232 3233 3234 
          </li>
          <li>
            The optional <code>io</code> attribute controls specific
            policies on I/O; qemu guests support "threads" and
C
docs/formatdomain: Add release info for disk <driver> attributes  
Cole Robinson 已提交
3235 
            "native". <span class="since">Since 0.8.8</span>
M
qemu aio: add XML parsing  
Matthias Dahl 已提交
3236 
          </li>
M
qemu: domain I/O asynchronous handling  
Michal Privoznik 已提交
3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 
          <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>
L
qemu: support event_idx parameter for virtio disk and net devices  
Laine Stump 已提交
3251 3252 3253 3254 
          <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
Y
Fix some typos in messages, docs and comments.  
Yuri Chornoivan 已提交
3255 
            number of interrupts and exits for the guest. The default
L
qemu: support event_idx parameter for virtio disk and net devices  
Laine Stump 已提交
3256 3257 3258 3259 3260 3261 3262 3263 
            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
qemu: Support copy on read for disk  
Osier Yang 已提交
3264 3265 
          <li>
            The optional <code>copy_on_read</code> attribute controls
Y
Fix some typos in messages, docs and comments.  
Yuri Chornoivan 已提交
3266 
            whether to copy read backing file into the image file. The
O
qemu: Support copy on read for disk  
Osier Yang 已提交
3267 3268 3269 3270 3271 3272 
            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>
O
qemu: Support discard for disk  
Osier Yang 已提交
3273 3274 
          <li>
            The optional <code>discard</code> attribute controls whether
C
docs: formatdomain: Tweak disk discard= docs  
Cole Robinson 已提交
3275 
            discard requests (also known as "trim" or "unmap") are
O
qemu: Support discard for disk  
Osier Yang 已提交
3276 
            ignored or passed to the filesystem. The value can be either
O
qemu: Change values of disk discard  
Osier Yang 已提交
3277 3278 
            "unmap" (allow the discard request to be passed) or "ignore"
            (ignore the discard request).
O
qemu: Support discard for disk  
Osier Yang 已提交
3279 3280 
            <span class='since'>Since 1.0.6 (QEMU and KVM only)</span>
          </li>
M
conf: Add support of zero-detection for disks  
Martin Kletzander 已提交
3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 
          <li>
            The optional <code>detect_zeroes</code> attribute controls whether
            to detect zero write requests.  The value can be "off", "on" or
            "unmap".  First two values turn the detection off and on,
            respectively.  The third value ("unmap") turns the detection on
            and additionally tries to discard such areas from the image based
            on the value of <code>discard</code> above (it will act as "on"
            if <code>discard</code> is set to "ignore").  NB enabling the
            detection is a compute intensive operation, but can save file
            space and/or time on slow media.
M
Change 1.3.6 occurrences to 2.0.0 to follow version bump  
Martin Kletzander 已提交
3291 
            <span class='since'>Since 2.0.0</span>
M
conf: Add support of zero-detection for disks  
Martin Kletzander 已提交
3292 
          </li>
J
domain_conf: Add support for iothreads in disk definition  
John Ferlan 已提交
3293 3294 3295 3296 
          <li>
            The optional <code>iothread</code> attribute assigns the
            disk to an IOThread as defined by the range for the domain
            <a href="#elementsIOThreadsAllocation"><code>iothreads</code></a>
J
docs: clarify disk iothread support  
John Ferlan 已提交
3297 3298 3299 3300 3301 
            value. Multiple disks may be assigned to the same IOThread and
            are numbered from 1 to the domain iothreads value. Available
            for a disk device <code>target</code> configured to use "virtio"
            <code>bus</code> and "pci" or "ccw" <code>address</code> types.
            <span class='since'>Since 1.2.8 (QEMU 2.1)</span>
J
domain_conf: Add support for iothreads in disk definition  
John Ferlan 已提交
3302 
          </li>
L
qemu: Support multiqueue virtio-blk  
Lin Ma 已提交
3303 3304 3305 3306 
          <li>
            The optional <code>queues</code> attribute specifies the number of
            virt queues for virtio-blk. (<span class="since">Since 3.9.0</span>)
          </li>
J
Add virtio-related options to disks  
Ján Tomko 已提交
3307 3308 3309 3310 3311 
          <li>
          For virtio disks,
          <a href="#elementsVirtio">Virtio-specific options</a> can also be
          set. (<span class="since">Since 3.5.0</span>)
          </li>
M
qemu aio: add XML parsing  
Matthias Dahl 已提交
3312 
        </ul>
D
Update domain XML docs  
Daniel P. Berrange 已提交
3313 
      </dd>
M
conf: support backend domain name in disk and network devices  
Marek Marczykowski 已提交
3314 3315 3316 3317 3318 3319 
      <dt><code>backenddomain</code></dt>
      <dd>The optional <code>backenddomain</code> element allows specifying a
          backend domain (aka driver domain) hosting the disk.  Use the
          <code>name</code> attribute to specify the backend domain name.
          <span class="since">Since 1.2.13 (Xen only)</span>
      </dd>
J
Introduce per-device boot element  
Jiri Denemark 已提交
3320 3321 3322 
      <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
F
conf: Add loadparm boot option for a boot device  
Farhan Ali 已提交
3323 3324 3325 3326 3327 3328 3329 
        boot sequence. On the S390 architecture only the first boot device is
        used. The optional <code>loadparm</code> attribute is an 8 character
        string which can be queried by guests on S390 via sclp or diag 308.
        Linux guests on S390 can use <code>loadparm</code> to select a boot
        entry. <span class="since">Since 3.5.0</span>
        The per-device <code>boot</code> elements cannot be used together
        with general boot elements in
J
Introduce per-device boot element  
Jiri Denemark 已提交
3330 3331 3332 
        <a href="#elementsOSBIOS">BIOS bootloader</a> section.
        <span class="since">Since 0.8.8</span>
      </dd>
M
Attach encryption information to virDomainDiskDef.  
Miloslav Trmač 已提交
3333 
      <dt><code>encryption</code></dt>
J
conf: Add/Allow parsing the encryption in the disk source  
John Ferlan 已提交
3334 3335 3336 3337 3338 
      <dd>Starting with <span class="since">libvirt 3.9.0</span> the
        <code>encryption</code> element is preferred to be a sub-element
        of the <code>source</code> element. If present, specifies how the
        volume is encrypted using "qcow". See the
        <a href="formatstorageencryption.html">Storage Encryption</a> page
M
Attach encryption information to virDomainDiskDef.  
Miloslav Trmač 已提交
3339 3340 
        for more information.
      </dd>
E
snapshot: additions to domain xml for disks  
Eric Blake 已提交
3341 3342 3343 
      <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
J
docs: Fix documentation for readonly element  
Jiri Denemark 已提交
3344 
        attribute <code>device='cdrom'</code>.
E
snapshot: additions to domain xml for disks  
Eric Blake 已提交
3345 
      </dd>
D
add missing doc for device <shareable/> option  
Daniel Veillard 已提交
3346 3347 3348 3349 3350 
      <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>
E
snapshot: additions to domain xml for disks  
Eric Blake 已提交
3351 3352 3353 3354 3355 3356 3357 
      <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>
М
Add docs on drive <serial> element  
Марк Коренберг 已提交
3358 3359 
      <dt><code>serial</code></dt>
      <dd>If present, this specify serial number of virtual hard drive.
E
docs: minor whitespace cleanups  
Eric Blake 已提交
3360 3361 
          For example, it may look
          like <code>&lt;serial&gt;WD-WMAP9A966149&lt;/serial&gt;</code>.
J
qemu: Do not support 'serial' scsi-block 'lun' devices  
John Ferlan 已提交
3362 3363 3364 
          Not supported for scsi-block devices, that is those using
          disk <code>type</code> 'block' using <code>device</code> 'lun'
          on <code>bus</code> 'scsi'.
М
Add docs on drive <serial> element  
Марк Коренберг 已提交
3365 3366 
          <span class="since">Since 0.7.1</span>
      </dd>
O
schema: Add schema for disk <wwn>  
Osier Yang 已提交
3367 3368 3369 
      <dt><code>wwn</code></dt>
      <dd>If present, this element specifies the WWN (World Wide Name)
        of a virtual hard disk or CD-ROM drive. It must be composed
P
docs: Drop mention that WWN for disks must be unique  
Peter Krempa 已提交
3370 
        of 16 hexadecimal digits.
O
schema: Add schema for disk <wwn>  
Osier Yang 已提交
3371 3372 
        <span class='since'>Since 0.10.1</span>
      </dd>
O
qemu: Allow the user to specify vendor and product for disk  
Osier Yang 已提交
3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 
      <dt><code>vendor</code></dt>
      <dd>If present, this element specifies the vendor of a virtual hard
        disk or CD-ROM device. It must not be longer than 8 printable
        characters.
        <span class='since'>Since 1.0.1</span>
      </dd>
      <dt><code>product</code></dt>
      <dd>If present, this element specifies the product of a virtual hard
        disk or CD-ROM device. It must not be longer than 16 printable
        characters.
        <span class='since'>Since 1.0.1</span>
      </dd>
E
docs: document <controller> element  
Eric Blake 已提交
3385 3386 3387 3388 3389 3390 3391 3392 3393 
      <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>,
L
qemu: make PCI multifunction support more manual  
Laine Stump 已提交
3394 3395 3396 3397 3398 
        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
O
conf: Introduce new attribute for device address format  
Osier Yang 已提交
3399 3400 3401 
        <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.
J
storage: add auth to virDomainDiskDef  
Josh Durgin 已提交
3402 3403 
      </dd>
      <dt><code>auth</code></dt>
J
conf: Add/Allow parsing the auth in the disk source  
John Ferlan 已提交
3404 3405 3406 3407 3408 3409 3410 3411 
      <dd>Starting with <span class="since">libvirt 3.9.0</span> the
        <code>auth</code> element is preferred to be a sub-element of
        the <code>source</code> element. The element is still read and
        managed as a <code>disk</code> sub-element. It is invalid to use
        <code>auth</code> as both a sub-element of <code>disk</code>
        and <code>source</code>. The <code>auth</code> element was
        introduced as a <code>disk</code> sub-element in
        <span class="since">libvirt 0.9.7.</span>
E
docs: document <controller> element  
Eric Blake 已提交
3412 
      </dd>
J
Support for Disk Geometry Override  
J.B. Joret 已提交
3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 
      <dt><code>geometry</code></dt>
      <dd>The optional <code>geometry</code> element provides the
        ability to override geometry settings. This mostly useful for
        S390 DASD-disks or older DOS-disks.  <span class="since">0.10.0</span>
        <dl>
          <dt><code>cyls</code></dt>
          <dd>The <code>cyls</code> attribute is the
            number of cylinders. </dd>
          <dt><code>heads</code></dt>
          <dd>The <code>heads</code> attribute is the
            number of heads. </dd>
          <dt><code>secs</code></dt>
          <dd>The <code>secs</code> attribute is the
            number of sectors per track. </dd>
          <dt><code>trans</code></dt>
          <dd>The optional <code>trans</code> attribute is the
            BIOS-Translation-Modus (none, lba or auto)</dd>
        </dl>
      </dd>
V
Rename iolimit to blockio.  
Viktor Mihajlovski 已提交
3432 3433 
      <dt><code>blockio</code></dt>
      <dd>If present, the <code>blockio</code> element allows
V
conf: Support for Block Device IO Limits  
Viktor Mihajlovski 已提交
3434 3435 3436 3437 3438 3439 3440 3441 
        to override any of the block device properties listed below.
        <span class="since">Since 0.10.2 (QEMU and KVM)</span>
        <dl>
          <dt><code>logical_block_size</code></dt>
          <dd>The logical block size the disk will report to the guest
            OS. For Linux this would be the value returned by the
            BLKSSZGET ioctl and describes the smallest units for disk
            I/O.
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
3442 
          </dd>
V
conf: Support for Block Device IO Limits  
Viktor Mihajlovski 已提交
3443 3444 3445 3446 3447 
          <dt><code>physical_block_size</code></dt>
          <dd>The physical block size the disk will report to the guest
            OS. For Linux this would be the value returned by the
            BLKPBSZGET ioctl and describes the disk's hardware sector
            size which can be relevant for the alignment of disk data.
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
3448 
          </dd>
V
conf: Support for Block Device IO Limits  
Viktor Mihajlovski 已提交
3449 3450 
        </dl>
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
3451 3452 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
3453 
    <h4><a id="elementsFilesystems">Filesystems</a></h4>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3454 3455 3456 3457 3458 3459 3460 

    <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>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 
...
&lt;devices&gt;
  &lt;filesystem type='template'&gt;
    &lt;source name='my-vm-template'/&gt;
    &lt;target dir='/'/&gt;
  &lt;/filesystem&gt;
  &lt;filesystem type='mount' accessmode='passthrough'&gt;
    &lt;driver type='path' wrpolicy='immediate'/&gt;
    &lt;source dir='/export/to/guest'/&gt;
    &lt;target dir='/import/from/host'/&gt;
    &lt;readonly/&gt;
  &lt;/filesystem&gt;
  &lt;filesystem type='file' accessmode='passthrough'&gt;
    &lt;driver name='loop' type='raw'/&gt;
    &lt;driver type='path' wrpolicy='immediate'/&gt;
    &lt;source file='/export/to/guest.img'/&gt;
    &lt;target dir='/import/from/host'/&gt;
    &lt;readonly/&gt;
  &lt;/filesystem&gt;
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3480 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
3481 3482 
&lt;/devices&gt;
...</pre>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3483 3484 3485 3486 3487 3488 3489 3490 3491 

    <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>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3492 
        <dt><code>mount</code></dt>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3493 3494 3495 3496 
        <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>.
C
docs: <filesystem> attr is 'accessmode', not 'mode'  
Cole Robinson 已提交
3497 
        This is the default <code>type</code> if one is not specified.
H
Introduce <driver> under <filesystem> to support open-by-handle  
Harsh Prateek Bora 已提交
3498 3499 3500 3501 
        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
D
Add new attribute wrpolicy to <driver> element  
Deepak C Shetty 已提交
3502 3503 3504 3505 3506 3507 
        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>.
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3508 
        </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3509 
        <dt><code>template</code></dt>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3510 3511 3512 
        <dd>
        OpenVZ filesystem template. Only used by OpenVZ driver.
        </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3513 
        <dt><code>file</code></dt>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3514 
        <dd>
D
Add support for RAM filesystems for LXC  
Daniel P. Berrange 已提交
3515 3516 3517 
        A host file will be treated as an image and mounted in
        the guest. The filesystem format will be autodetected.
        Only used by LXC driver.
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3518 
        </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3519 
        <dt><code>block</code></dt>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3520 
        <dd>
R
docs: Document filesystem type='block' for LXC  
Ryota Ozaki 已提交
3521 3522 3523 
        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>.
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3524 
        </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3525 
        <dt><code>ram</code></dt>
D
Add support for RAM filesystems for LXC  
Daniel P. Berrange 已提交
3526 3527 3528 
        <dd>
          An in-memory filesystem, using memory from the host OS.
          The source element has a single attribute <code>usage</code>
J
LXC: Fix handling of RAM filesystem size units  
Ján Tomko 已提交
3529 3530 
          which gives the memory usage limit in KiB, unless units
          are specified by the <code>units</code> attribute. Only used
D
Add support for RAM filesystems for LXC  
Daniel P. Berrange 已提交
3531 3532 
          by LXC driver.
          <span class="since"> (since 0.9.13)</span></dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3533 
        <dt><code>bind</code></dt>
D
Add support for guest bind mounts with LXC  
Daniel P. Berrange 已提交
3534 3535 3536 3537 
        <dd>
          A directory inside the guest will be bound to another
          directory inside the guest. Only used by LXC driver
          <span class="since"> (since 0.9.13)</span></dd>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3538 3539 
        </dl>
C
docs: <filesystem> attr is 'accessmode', not 'mode'  
Cole Robinson 已提交
3540 
      The filesystem block has an optional attribute <code>accessmode</code>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3541 3542 3543 3544 3545 3546 
      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>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3547 
        <dt><code>passthrough</code></dt>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3548 3549 
        <dd>
        The <code>source</code> is accessed with the permissions of the
C
docs: <filesystem> attr is 'accessmode', not 'mode'  
Cole Robinson 已提交
3550 
        user inside the guest. This is the default <code>accessmode</code> if
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3551 3552 3553 
        one is not specified.
        <a href="http://lists.gnu.org/archive/html/qemu-devel/2010-05/msg02673.html">More info</a>
        </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3554 
        <dt><code>mapped</code></dt>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3555 3556 3557 3558 3559 
        <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>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3560 
        <dt><code>squash</code></dt>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 
        <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>
D
Add support for storage format in FS <driver>  
Daniel P. Berrange 已提交
3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 
      <dt><code>driver</code></dt>
      <dd>
        The optional driver element allows specifying further details
        related to the hypervisor driver used to provide the filesystem.
        <span class="since">Since 1.0.6</span>
        <ul>
          <li>
            If the hypervisor supports multiple backend drivers, then
            the <code>type</code> attribute selects the primary
            backend driver name, while the <code>format</code>
            attribute provides the format type. For example, LXC
D
Add 'nbd' as a valid filesystem driver type  
Daniel P. Berrange 已提交
3583 3584 
            supports a type of "loop", with a format of "raw" or
            "nbd" with any format. QEMU supports a type of "path"
S
docs: Rename 'parallels' to 'vz'  
Sergey Bronnikov 已提交
3585 
            or "handle", but no formats. Virtuozzo driver supports
D
add ploop fs driver type  
Dmitry Guryanov 已提交
3586 
            a type of "ploop" with a format of "ploop".
D
Add support for storage format in FS <driver>  
Daniel P. Berrange 已提交
3587 
          </li>
J
Add virtio-related options to filesystems  
Ján Tomko 已提交
3588 3589 3590 3591 3592 
          <li>
          For virtio-backed devices,
          <a href="#elementsVirtio">Virtio-specific options</a> can also be
          set. (<span class="since">Since 3.5.0</span>)
          </li>
D
Add support for storage format in FS <driver>  
Daniel P. Berrange 已提交
3593 3594 3595 
        </ul>
      </dd>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3596 3597 3598 3599 3600 
      <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
D
Add support for RAM filesystems for LXC  
Daniel P. Berrange 已提交
3601 
        be used with <code>type='mount'</code>. The <code>usage</code> attribute
J
LXC: Fix handling of RAM filesystem size units  
Ján Tomko 已提交
3602 3603 
        is used with <code>type='ram'</code> to set the memory limit in KiB,
        unless units are specified by the <code>units</code> attribute.
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 
      </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>
O
docs, comments: minor typo fixes  
Oskari Saarenmaa 已提交
3616 
        Enables exporting filesystem as a readonly mount for guest, by
O
qemu: Support readonly filesystem passthrough  
Osier Yang 已提交
3617 3618 
        default read-write access is given (currently only works for
        QEMU/KVM driver).
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3619 
      </dd>
G
Introduce filesystem limits to virDomainFSDef  
Guido Günther 已提交
3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 

      <dt><code>space_hard_limit</code></dt>
      <dd>
        Maximum space available to this guest's filesystem.
        <span class="since">Since 0.9.13</span>
      </dd>

      <dt><code>space_soft_limit</code></dt>
      <dd>
        Maximum space available to this guest's filesystem. The container is
        permitted to exceed its soft limits for a grace period of time. Afterwards the
        hard limit is enforced.
        <span class="since">Since 0.9.13</span>
      </dd>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
3634 3635 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
3636 
    <h4><a id="elementsAddress">Device Addresses</a></h4>
E
docs: document <address> elements in one place  
Eric Blake 已提交
3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 

    <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
M
docs: fix address type for disks  
Martin Kletzander 已提交
3655 
      uses <code>type='drive'</code>, while
E
docs: document <address> elements in one place  
Eric Blake 已提交
3656 3657 3658 3659 3660 3661 3662 3663 
      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>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3664 
      <dt><code>pci</code></dt>
E
docs: document <address> elements in one place  
Eric Blake 已提交
3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 
      <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
L
conf: allow type='pci' addresses with no address attributes specified  
Laine Stump 已提交
3677 3678 3679 3680 3681 3682 3683 
        have multiple functions used.<br/>
        <span class="since">Since 1.3.5</span>, some hypervisor
        drivers may accept an <code>&lt;address type='pci'/&gt;</code>
        element with no other attributes as an explicit request to
        assign a PCI address for the device rather than some other
        type of address that may also be appropriate for that same
        device (e.g. virtio-mmio).
E
docs: document <address> elements in one place  
Eric Blake 已提交
3684 
      </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3685 
      <dt><code>drive</code></dt>
E
docs: document <address> elements in one place  
Eric Blake 已提交
3686 3687 3688 
      <dd>Drive addresses have the following additional
        attributes: <code>controller</code> (a 2-digit controller
        number), <code>bus</code> (a 2-digit bus number),
E
docs: Correct typos in scsi hostdev and address elements  
Eric Farman 已提交
3689 
        <code>target</code> (a 2-digit target number),
E
docs: document <address> elements in one place  
Eric Blake 已提交
3690 3691 
        and <code>unit</code> (a 2-digit unit number on the bus).
      </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3692 
      <dt><code>virtio-serial</code></dt>
E
docs: document <address> elements in one place  
Eric Blake 已提交
3693 3694 3695 3696 3697 
      <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>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3698 
      <dt><code>ccid</code></dt>
E
docs: document <address> elements in one place  
Eric Blake 已提交
3699 3700 3701 3702 
      <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>
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
3703 
      </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3704 
      <dt><code>usb</code></dt>
E
docs: document <address> elements in one place  
Eric Blake 已提交
3705 3706 3707 3708 3709 
      <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>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3710 
      <dt><code>spapr-vio</code></dt>
E
docs: document <address> elements in one place  
Eric Blake 已提交
3711 3712 3713 3714 3715 3716 3717 3718 
      <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>
V
S390: Documentation for CCW address type  
Viktor Mihajlovski 已提交
3719 
      </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3720 
      <dt><code>ccw</code></dt>
B
docs: align spelling of S390  
Boris Fiuczynski 已提交
3721 
      <dd>S390 guests with a <code>machine</code> value of
V
S390: Documentation for CCW address type  
Viktor Mihajlovski 已提交
3722 3723 3724 3725 3726 3727 3728 
        s390-ccw-virtio use the native CCW bus for I/O devices.
        CCW bus addresses have the following additional attributes:
        <code>cssid</code> (a hex value between 0 and 0xfe, inclusive),
        <code>ssid</code> (a value between 0 and 3, inclusive) and
        <code>devno</code> (a hex value between 0 and 0xffff, inclusive).
        Partially specified bus addresses are not allowed.
        If omitted, libvirt will assign a free bus address with
S
S390: Documentation for ccw address type  
Stefan Zimmermann 已提交
3729 3730 
        cssid=0xfe and ssid=0. Virtio-ccw devices must have their cssid
        set to 0xfe.
V
S390: Documentation for CCW address type  
Viktor Mihajlovski 已提交
3731 
        <span class="since">Since 1.0.4</span>
E
docs: document <address> elements in one place  
Eric Blake 已提交
3732 
      </dd>
C
docs: formatdomain: document virtio-mmio device addresses  
Cole Robinson 已提交
3733 3734 3735 3736 3737 
      <dt><code>virtio-mmio</code></dt>
      <dd>This places the device on the virtio-mmio transport, which is
        currently only available for some <code>armv7l</code> and
        <code>aarch64</code> virtual machines. virtio-mmio addresses
        do not have any additional attributes.
A
docs: Document virtio-pci by default for mach-virt guests  
Andrea Bolognani 已提交
3738 3739 3740 3741 3742 3743 3744 
        <span class="since">Since 1.1.3</span><br/>
        If the guest architecture is <code>aarch64</code> and the machine
        type is <code>virt</code>, libvirt will automatically assign PCI
        addresses to devices; however, the presence of a single device
        with virtio-mmio address in the guest configuration will cause
        libvirt to assign virtio-mmio addresses to all further devices.
        <span class="since">Since 3.0.0</span>
C
docs: formatdomain: document virtio-mmio device addresses  
Cole Robinson 已提交
3745 
      </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
3746 
      <dt><code>isa</code></dt>
H
conf: introduce generic ISA address  
Hu Tao 已提交
3747 3748 3749 3750 
      <dd>ISA addresses have the following additional
        attributes: <code>iobase</code> and <code>irq</code>.
        <span class="since">Since 1.2.1</span>
      </dd>
E
docs: document <address> elements in one place  
Eric Blake 已提交
3751 3752 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
3753 
    <h4><a id="elementsVirtio">Virtio-related options</a></h4>
J
Add virtio-related options to interfaces  
Ján Tomko 已提交
3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 

    <p>
      QEMU's virtio devices have some attributes related to the virtio transport under
      the <code>driver</code> element:
      The <code>iommu</code> attribute enables the use of emulated IOMMU
      by the device. The attribute <code>ats</code> controls the Address
      Translation Service support for PCIe devices. This is needed to make use
      of IOTLB support (see <a href="#elementsIommu">IOMMU device</a>).
      Possible values are <code>on</code> or <code>off</code>.
      <span class="since">Since 3.5.0</span>
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
3766 
    <h4><a id="elementsControllers">Controllers</a></h4>
E
docs: document <controller> element  
Eric Blake 已提交
3767 3768 

    <p>
O
docs, comments: minor typo fixes  
Oskari Saarenmaa 已提交
3769 
      Depending on the guest architecture, some device buses can
E
docs: document <address> elements in one place  
Eric Blake 已提交
3770 3771 
      appear more than once, with a group of virtual devices tied to a
      virtual controller.  Normally, libvirt can automatically infer such
E
docs: document <controller> element  
Eric Blake 已提交
3772 
      controllers without requiring explicit XML markup, but sometimes
A
docs: Add "PCI topology and hotplug" guidelines  
Andrea Bolognani 已提交
3773 3774 3775 
      it is necessary to provide an explicit controller element, notably
      when planning the <a href="pci-hotplug.html">PCI topology</a>
      for guests where device hotplug is expected.
E
docs: document <controller> element  
Eric Blake 已提交
3776 3777 3778 
    </p>

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 
...
&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;controller type='scsi' index='0' model='virtio-scsi'&gt;
    &lt;driver iothread='4'/&gt;
    &lt;address type='pci' domain='0x0000' bus='0x00' slot='0x0b' function='0x0'/&gt;
  &lt;/controller&gt;
E
docs: document <controller> element  
Eric Blake 已提交
3790 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
3791 3792 
&lt;/devices&gt;
...</pre>
E
docs: document <controller> element  
Eric Blake 已提交
3793 3794 3795 

    <p>
      Each controller has a mandatory attribute <code>type</code>,
J
docs: Reformat the Controllers description  
John Ferlan 已提交
3796 3797 
      which must be one of 'ide', 'fdc', 'scsi', 'sata', 'usb',
      'ccid', 'virtio-serial' or 'pci', and a mandatory
M
Add a new controller type 'usb' with optionnal 'model'  
Marc-André Lureau 已提交
3798 3799 
      attribute <code>index</code> which is the decimal integer
      describing in which order the bus controller is encountered (for
J
docs: Reformat the Controllers description  
John Ferlan 已提交
3800 
      use in <code>controller</code> attributes of
L
conf: permit auto-assignment of controller indexes  
Laine Stump 已提交
3801 3802 3803 3804 3805 
      <code>&lt;address&gt;</code> elements).
      <span class="since">Since 1.3.5</span> the index is optional; if
      not specified, it will be auto-assigned to be the lowest unused
      index for the given controller type. Some controller types have
      additional attributes that control specific features, such as:
J
docs: Reformat the Controllers description  
John Ferlan 已提交
3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 
    </p>

      <dl>
        <dt><code>virtio-serial</code></dt>
        <dd>The <code>virtio-serial</code> controller has two additional
        optional attributes <code>ports</code> and <code>vectors</code>,
        which control how many devices can be connected through the
        controller.</dd>
        <dt><code>scsi</code></dt>
        <dd>A <code>scsi</code> controller has an optional attribute
        <code>model</code>, which is one of 'auto', 'buslogic', 'ibmvscsi',
        'lsilogic', 'lsisas1068', 'lsisas1078', 'virtio-scsi' or
        'vmpvscsi'.</dd>
        <dt><code>usb</code></dt>
        <dd>A <code>usb</code> 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",
C
extend usb controller model to support xen pvusb  
Chunyan Liu 已提交
3823 
        "vt82c686b-uhci", "pci-ohci", "nec-xhci", "qusb1" (xen pvusb
P
qemu: add support for qemu-xhci USB controller  
Pavel Hrdina 已提交
3824 3825 
        with qemu backend, version 1.1), "qusb2" (xen pvusb with qemu
        backend, version 2.0) or "qemu-xhci". Additionally,
J
docs: Reformat the Controllers description  
John Ferlan 已提交
3826 3827 3828 3829 3830 3831 3832 
         <span class="since">since 0.10.0</span>, if the USB bus needs to
         be explicitly disabled for the guest, <code>model='none'</code>
         may be used.  <span class="since">Since 1.0.5</span>, no default
         USB controller will be built on s390.
         <span class="since">Since 1.3.5</span>, USB controllers accept a
         <code>ports</code> attribute to configure how many devices can be
         connected to the controller.</dd>
D
domain: Allow 'model' attribute for ide controller  
Dawid Zamirski 已提交
3833 3834 3835 3836 
        <dt><code>ide</code></dt>
        <dd><span class="since">Since 3.10.0</span> for the vbox driver, the
        <code>ide</code> controller has an optional attribute
        <code>model</code>, which is one of "piix3", "piix4" or "ich6".</dd>
J
docs: Reformat the Controllers description  
John Ferlan 已提交
3837 3838 3839 3840 3841 
      </dl>

    <p>
      Note: The PowerPC64 "spapr-vio" addresses do not have an
      associated controller.
E
docs: document <controller> element  
Eric Blake 已提交
3842 3843 3844 3845 3846 3847 
    </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
E
docs: document <address> elements in one place  
Eric Blake 已提交
3848 
      semantics <a href="#elementsAddress">given above</a>.
E
docs: document <controller> element  
Eric Blake 已提交
3849 3850 
    </p>
O
Introduce a sub-element <driver> for controller  
Osier Yang 已提交
3851 3852 
    <p>
      An optional sub-element <code>driver</code> can specify the driver
M
qemu: Add cmd_per_lun, max_sectors to virtio-scsi  
Mike Perez 已提交
3853 
      specific options:
O
Introduce a sub-element <driver> for controller  
Osier Yang 已提交
3854 
    </p>
M
qemu: Add cmd_per_lun, max_sectors to virtio-scsi  
Mike Perez 已提交
3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 
    <dl>
      <dt><code>queues</code></dt>
      <dd>
        The optional <code>queues</code> attribute specifies the number of
        queues for the controller. For best performance, it's recommended to
        specify a value matching the number of vCPUs.
        <span class="since">Since 1.0.5 (QEMU and KVM only)</span>
      </dd>
      <dt><code>cmd_per_lun</code></dt>
      <dd>
        The optional <code>cmd_per_lun</code> attribute specifies the maximum
        number of commands that can be queued on devices controlled by the
        host.
        <span class="since">Since 1.2.7 (QEMU and KVM only)</span>
      </dd>
      <dt><code>max_sectors</code></dt>
      <dd>
        The optional <code>max_sectors</code> attribute specifies the maximum
        amount of data in bytes that will be transferred to or from the device
        in a single command. The transfer length is measured in sectors, where
        a sector is 512 bytes.
        <span class="since">Since 1.2.7 (QEMU and KVM only)</span>
      </dd>
M
conf: Add ioeventfd option for controllers  
Martin Kletzander 已提交
3878 3879 3880 3881 3882 3883 3884 3885 
      <dt><code>ioeventfd</code></dt>
      <dd>
        The optional <code>ioeventfd</code> attribute specifies
        whether the controller should use
        <a href='https://patchwork.kernel.org/patch/43390/'>
        I/O asynchronous handling</a> or not.  Accepted values are
        "on" and "off". <span class="since">Since 1.2.18</span>
      </dd>
J
conf: Add support for virtio-scsi iothreads  
John Ferlan 已提交
3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 
      <dt><code>iothread</code></dt>
      <dd>
        Supported for controller type <code>scsi</code> using model
        <code>virtio-scsi</code> for <code>address</code> types
        <code>pci</code> and <code>ccw</code>
        <span class="since">since 1.3.5 (QEMU 2.4)</span>.

        The optional <code>iothread</code> attribute assigns the controller
        to an IOThread as defined by the range for the domain
        <a href="#elementsIOThreadsAllocation"><code>iothreads</code></a>
        value. Each SCSI <code>disk</code> assigned to use the specified
        <code>controller</code> will utilize the same IOThread. If a specific
        IOThread is desired for a specific SCSI <code>disk</code>, then
        multiple controllers must be defined each having a specific
        <code>iothread</code> value. The <code>iothread</code> value
        must be within the range 1 to the domain iothreads value.
      </dd>
J
Add virtio-related options to controllers  
Ján Tomko 已提交
3903 3904 3905 3906 3907 3908 
      <dt>virtio options</dt>
      <dd>
        For virtio controllers,
        <a href="#elementsVirtio">Virtio-specific options</a> can also be
        set. (<span class="since">Since 3.5.0</span>)
      </dd>
M
qemu: Add cmd_per_lun, max_sectors to virtio-scsi  
Mike Perez 已提交
3909 
    </dl>
M
Add USB companion controllers support  
Marc-André Lureau 已提交
3910 3911 3912 3913 3914 3915 
    <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.
M
docs: Document how libvirt handles companion controllers  
Martin Kletzander 已提交
3916 3917 3918 3919 3920 
      Not all controller models can be used as companion controllers
      and libvirt might provide some sensible defaults (settings
      of <code>master startport</code> and <code>function</code> of an
      address) for some particular models.
      Preferred companion controllers are <code>ich-uhci[123]</code>.
M
Add USB companion controllers support  
Marc-André Lureau 已提交
3921 3922 3923 
    </p>

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
3924 3925 3926 3927 3928 3929 3930 3931 3932 
...
&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;
    &lt;address type='pci' domain='0' bus='0' slot='4' function='0' multifunction='on'/&gt;
  &lt;/controller&gt;
M
Add USB companion controllers support  
Marc-André Lureau 已提交
3933 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
3934 3935 
&lt;/devices&gt;
...</pre>
J
conf: add PCI controllers  
Ján Tomko 已提交
3936 3937 3938 

    <p>
      PCI controllers have an optional <code>model</code> attribute with
L
qemu: add dmi-to-pci-bridge controller  
Laine Stump 已提交
3939 
      possible values <code>pci-root</code>, <code>pcie-root</code>,
L
conf: new pci controller model "pcie-root-port"  
Laine Stump 已提交
3940 
      <code>pcie-root-port</code>, <code>pci-bridge</code>,
L
conf: new pci controller model pci-expander-bus  
Laine Stump 已提交
3941 
      <code>dmi-to-pci-bridge</code>, <code>pcie-switch-upstream-port</code>,
L
conf: new pci controller model pcie-expander-bus  
Laine Stump 已提交
3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 
      <code>pcie-switch-downstream-port</code>, <code>pci-expander-bus</code>,
      or <code>pcie-expander-bus</code>.  (pci-root and
      pci-bridge <span class="since">since 1.0.5</span>, pcie-root and
      dmi-to-pci-bridge <span class="since">since 1.1.2</span>,
      pcie-root-port, pcie-switch-upstream-port,
      pcie-switch-downstream-port <span class="since">since
      1.2.19</span>, and pci-expander-bus and
      pcie-expander-bus <span class="since">since 1.3.4</span>) The
      root controllers (<code>pci-root</code>
      and <code>pcie-root</code>) have an
      optional <code>pcihole64</code> element specifying how big (in
      kilobytes, or in the unit specified by <code>pcihole64</code>'s
J
Add pcihole64 element to root PCI controllers  
Ján Tomko 已提交
3954 3955 3956 3957 3958 
      <code>unit</code> attribute) the 64-bit PCI hole should be. Some guests (like
      Windows XP or Windows Server 2003) might crash when QEMU and Seabios
      are recent enough to support 64-bit PCI holes, unless this is disabled
      (set to 0). <span class="since">Since 1.1.2 (QEMU only)</span>
    </p>
L
conf: add new <model> subelement with name attribute to <controller>  
Laine Stump 已提交
3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 
    <p>
      PCI controllers also have an optional
      subelement <code>&lt;model&gt;</code> with an attribute
      <code>name</code>. The name attribute holds the name of the
      specific device that qemu is emulating (e.g. "i82801b11-bridge")
      rather than simply the class of device ("dmi-to-pci-bridge",
      "pci-bridge"), which is set in the controller element's
      model <b>attribute</b>.  In almost all cases, you should not
      manually add a <code>&lt;model&gt;</code> subelement to a
      controller, nor should you modify one that is automatically
      generated by libvirt. <span class="since">Since 1.2.19 (QEMU
      only).</span>
    </p>
L
conf: add new <target> subelement with chassisNr attribute to <controller>  
Laine Stump 已提交
3972 3973 
    <p>
      PCI controllers also have an optional
L
conf: new pci controller model pci-expander-bus  
Laine Stump 已提交
3974 3975 3976 
      subelement <code>&lt;target&gt;</code> with the attributes and
      subelements listed below. These are configurable items that 1)
      are visible to the guest OS so must be preserved for guest ABI
L
conf: add new <target> subelement with chassisNr attribute to <controller>  
Laine Stump 已提交
3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 
      compatibility, and 2) are usually left to default values or
      derived automatically by libvirt. In almost all cases, you
      should not manually add a <code>&lt;target&gt;</code> subelement
      to a controller, nor should you modify the values in the those
      that are automatically generated by
      libvirt. <span class="since">Since 1.2.19 (QEMU only).</span>
    </p>
    <dl>
      <dt><code>chassisNr</code></dt>
      <dd>
        PCI controllers that have attribute model="pci-bridge", can
        also have a <code>chassisNr</code> attribute in
        the <code>&lt;target&gt;</code> subelement, which is used to
        control QEMU's "chassis_nr" option for the pci-bridge device
        (normally libvirt automatically sets this to the same value as
        the index attribute of the pci controller). If set, chassisNr
L
conf: limit chassisNr, and busNr to a minimum value of 1, not 0  
Laine Stump 已提交
3993 
        must be between 1 and 255.
L
conf: add new <target> subelement with chassisNr attribute to <controller>  
Laine Stump 已提交
3994 
      </dd>
L
conf: new pci controller model "pcie-root-port"  
Laine Stump 已提交
3995 3996 
      <dt><code>chassis</code></dt>
      <dd>
L
conf: new pcie-controller model "pcie-switch-downstream-port"  
Laine Stump 已提交
3997 3998 
        pcie-root-port and pcie-switch-downstream-port controllers can
        also have a <code>chassis</code> attribute in
L
conf: new pci controller model "pcie-root-port"  
Laine Stump 已提交
3999 4000 4001 4002 4003 4004 4005 
        the <code>&lt;target&gt;</code> subelement, which is used to
        set the controller's "chassis" configuration value, which is
        visible to the virtual machine. If set, chassis must be
        between 0 and 255.
      </dd>
      <dt><code>port</code></dt>
      <dd>
L
conf: new pcie-controller model "pcie-switch-downstream-port"  
Laine Stump 已提交
4006 4007 4008 
        pcie-root-port and pcie-switch-downstream-port controllers can
        also have a <code>port</code> attribute in
        the <code>&lt;target&gt;</code> subelement, which
L
conf: new pci controller model "pcie-root-port"  
Laine Stump 已提交
4009 4010 4011 4012 
        is used to set the controller's "port" configuration value,
        which is visible to the virtual machine. If set, port must be
        between 0 and 255.
      </dd>
L
conf: new pci controller model pci-expander-bus  
Laine Stump 已提交
4013 4014 
      <dt><code>busNr</code></dt>
      <dd>
L
conf: new pci controller model pcie-expander-bus  
Laine Stump 已提交
4015 
        pci-expander-bus and pcie-expander-bus controllers can have an
L
conf: new pci controller model pci-expander-bus  
Laine Stump 已提交
4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 
        optional <code>busNr</code> attribute (1-254). This will be
        the bus number of the new bus; All bus numbers between that
        specified and 255 will be available only for assignment to
        PCI/PCIe controllers plugged into the hierarchy starting with
        this expander bus, and bus numbers less than the specified
        value will be available to the next lower expander-bus (or the
        root-bus if there are no lower expander buses). If you do not
        specify a busNumber, libvirt will find the lowest existing
        busNumber in all other expander buses (or use 256 if there are
        no others) and auto-assign the busNr of that found bus - 2,
        which provides one bus number for the pci-expander-bus and one
        for the pci-bridge that is automatically attached to it (if
        you plan on adding more pci-bridges to the hierarchy of the
        bus, you should manually set busNr to a lower value).
L
conf: new pci controller model pcie-expander-bus  
Laine Stump 已提交
4030 4031 4032 4033 4034 4035 4036 
        <p>
          A similar algorithm is used for automatically determining
          the busNr attribute for pcie-expander-bus, but since the
          pcie-expander-bus doesn't have any built-in pci-bridge, the
          2nd bus-number is just being reserved for the pcie-root-port
          that must necessarily be connected to the bus in order to
          actually plug in an endpoint device. If you intend to plug
L
conf: don't allow connecting upstream-port directly to pce-expander-bus  
Laine Stump 已提交
4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 
          multiple devices into a pcie-expander-bus, you must connect
          a pcie-switch-upstream-port to the pcie-root-port that is
          plugged into the pcie-expander-bus, and multiple
          pcie-switch-downstream-ports to the
          pcie-switch-upstream-port, and of course for this to work
          properly, you will need to decrease the pcie-expander-bus'
          busNr accordingly so that there are enough unused bus
          numbers above it to accomodate giving out one bus number for
          the upstream-port and one for each downstream-port (in
          addition to the pcie-root-port and the pcie-expander-bus
          itself).
L
conf: new pci controller model pcie-expander-bus  
Laine Stump 已提交
4048 
        </p>
L
conf: new pci controller model pci-expander-bus  
Laine Stump 已提交
4049 
      </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
4050 
      <dt><code>node</code></dt>
L
conf: new pci controller model pci-expander-bus  
Laine Stump 已提交
4051 
      <dd>
S
qemu: Enable NUMA node tag in pci-root for PPC64  
Shivaprasad G Bhat 已提交
4052 4053 4054 4055 
        Some PCI controllers (<code>pci-expander-bus</code> for the pc
        machine type, <code>pcie-expander-bus</code> for the q35 machine
        type and, <span class="since">since 3.6.0</span>,
        <code>pci-root</code> for the pseries machine type) can have an
L
conf: new pci controller model pci-expander-bus  
Laine Stump 已提交
4056 4057 4058 4059 4060 4061 4062 4063 
        optional <code>&lt;node&gt;</code> subelement within
        the <code>&lt;target&gt;</code> subelement, which is used to
        set the NUMA node reported to the guest OS for that bus - the
        guest OS will then know that all devices on that bus are a
        part of the specified NUMA node (it is up to the user of the
        libvirt API to attach host devices to the correct
        pci-expander-bus when assigning them to the domain).
      </dd>
A
conf: Parse and format <target index='...'/>  
Andrea Bolognani 已提交
4064 4065 4066 4067 4068 4069 
      <dt><code>index</code></dt>
      <dd>
        pci-root controllers for pSeries guests use this attribute to
        record the order they will show up in the guest.
        <span class="since">Since 3.6.0</span>
      </dd>
L
conf: add new <target> subelement with chassisNr attribute to <controller>  
Laine Stump 已提交
4070 
    </dl>
J
Add pcihole64 element to root PCI controllers  
Ján Tomko 已提交
4071 
    <p>
L
qemu: add pcie-root controller  
Laine Stump 已提交
4072 
      For machine types which provide an implicit PCI bus, the pci-root
J
conf: add PCI controllers  
Ján Tomko 已提交
4073 
      controller with index=0 is auto-added and required to use PCI devices.
L
qemu: add pcie-root controller  
Laine Stump 已提交
4074 
      pci-root has no address.
L
qemu: add dmi-to-pci-bridge controller  
Laine Stump 已提交
4075 4076 4077 
      PCI bridges are auto-added if there are too many devices to fit on
      the one bus provided by pci-root, or a PCI bus number greater than zero
      was specified.
J
conf: add PCI controllers  
Ján Tomko 已提交
4078 4079 4080 4081 4082 4083 
      PCI bridges can also be specified manually, but their addresses should
      only refer to PCI buses provided by already specified PCI controllers.
      Leaving gaps in the PCI controller indexes might lead to an invalid
      configuration.
    </p>
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4084 4085 4086 4087 4088 4089 4090 4091 
...
&lt;devices&gt;
  &lt;controller type='pci' index='0' model='pci-root'/&gt;
  &lt;controller type='pci' index='1' model='pci-bridge'&gt;
    &lt;address type='pci' domain='0' bus='0' slot='5' function='0' multifunction='off'/&gt;
  &lt;/controller&gt;
&lt;/devices&gt;
...</pre>
L
qemu: add pcie-root controller  
Laine Stump 已提交
4092 4093 4094 4095 4096 4097 

    <p>
      For machine types which provide an implicit PCI Express (PCIe)
      bus (for example, the machine types based on the Q35 chipset),
      the pcie-root controller with index=0 is auto-added to the
      domain's configuration. pcie-root has also no address, provides
L
qemu: always permit PCI devices to be manually assigned to a PCIe bus  
Laine Stump 已提交
4098 4099 4100 4101 4102 4103 
      31 slots (numbered 1-31) that can be used to attach PCIe or PCI
      devices (although libvirt will never auto-assign a PCI device to
      a PCIe slot, it will allow manual specification of such an
      assignment). Devices connected to pcie-root cannot be
      hotplugged. In order to make standard PCI slots available on a
      system which has a pcie-root controller, a pci controller
L
qemu: add dmi-to-pci-bridge controller  
Laine Stump 已提交
4104 
      with <code>model='dmi-to-pci-bridge'</code> is automatically
L
qemu: always permit PCI devices to be manually assigned to a PCIe bus  
Laine Stump 已提交
4105 4106 4107 4108 
      added, usually at the defacto standard location of slot=0x1e. A
      dmi-to-pci-bridge controller plugs into a PCIe slot (as provided
      by pcie-root), and itself provides 31 standard PCI slots (which
      also do not support device hotplug). In order to have
L
qemu: add dmi-to-pci-bridge controller  
Laine Stump 已提交
4109 4110 4111 
      hot-pluggable PCI slots in the guest system, a pci-bridge
      controller will also be automatically created and connected to
      one of the slots of the auto-created dmi-to-pci-bridge
L
qemu: always permit PCI devices to be manually assigned to a PCIe bus  
Laine Stump 已提交
4112 
      controller; all guest PCI devices with addresses that are
L
qemu: add dmi-to-pci-bridge controller  
Laine Stump 已提交
4113 4114 
      auto-determined by libvirt will be placed on this pci-bridge
      device.  (<span class="since">since 1.1.2</span>).
L
qemu: add pcie-root controller  
Laine Stump 已提交
4115 
    </p>
L
conf: new pci controller model "pcie-root-port"  
Laine Stump 已提交
4116 4117 
    <p>
      Domains with an implicit pcie-root can also add controllers
L
conf: new pcie-controller model "pcie-switch-downstream-port"  
Laine Stump 已提交
4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 
      with <code>model='pcie-root-port'</code>,
      <code>model='pcie-switch-upstream-port'</code>,
      and <code>model='pcie-switch-downstream-port'</code>. pcie-root-port
      is a simple type of bridge device that can connect only to one
      of the 31 slots on the pcie-root bus on its upstream side, and
      makes a single (PCIe, hotpluggable) port available on the
      downstream side (at slot='0'). pcie-root-port can be used to
      provide a single slot to later hotplug a PCIe device (but is not
      itself hotpluggable - it must be in the configuration when the
      domain is started).
      (<span class="since">since 1.2.19</span>)
    </p>
    <p>
      pcie-switch-upstream-port is a more flexible (but also more
      complex) device that can only plug into a pcie-root-port or
      pcie-switch-downstream-port on the upstream side (and only
      before the domain is started - it is not hot-pluggable), and
      provides 32 ports on the downstream side (slot='0' - slot='31')
      that accept only pcie-switch-downstream-port devices; each
      pcie-switch-downstream-port device can only plug into a
      pcie-switch-upstream-port on its upstream side (again, not
      hot-pluggable), and on its downstream side provides a single
      hotpluggable pcie port that can accept any standard pci or pcie
      device (or another pcie-switch-upstream-port), i.e. identical in
      function to a pcie-root-port.  (<span class="since">since
      1.2.19</span>)
L
conf: new pci controller model "pcie-root-port"  
Laine Stump 已提交
4144 
    </p>
L
qemu: add pcie-root controller  
Laine Stump 已提交
4145 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 
...
&lt;devices&gt;
  &lt;controller type='pci' index='0' model='pcie-root'/&gt;
  &lt;controller type='pci' index='1' model='dmi-to-pci-bridge'&gt;
    &lt;address type='pci' domain='0' bus='0' slot='0xe' function='0'/&gt;
  &lt;/controller&gt;
  &lt;controller type='pci' index='2' model='pci-bridge'&gt;
    &lt;address type='pci' domain='0' bus='1' slot='1' function='0'/&gt;
  &lt;/controller&gt;
&lt;/devices&gt;
...</pre>
M
Add USB companion controllers support  
Marc-André Lureau 已提交
4157
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
4158 
    <h4><a id="elementsLease">Device leases</a></h4>
D
Support leases in guest XML and lock manager  
Daniel P. Berrange 已提交
4159 4160 4161 4162 4163 4164 4165 4166 

    <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>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4167 4168 
...
&lt;devices&gt;
D
Support leases in guest XML and lock manager  
Daniel P. Berrange 已提交
4169 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4170 4171 4172 4173 4174 4175 4176 4177 
  &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>
D
Support leases in guest XML and lock manager  
Daniel P. Berrange 已提交
4178 4179 

    <dl>
A
docs: Use <code> inside <dt> for symbols  
Andrea Bolognani 已提交
4180 
      <dt><code>lockspace</code></dt>
D
Support leases in guest XML and lock manager  
Daniel P. Berrange 已提交
4181 4182 4183 4184 
      <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>
A
docs: Use <code> inside <dt> for symbols  
Andrea Bolognani 已提交
4185 
      <dt><code>key</code></dt>
D
Support leases in guest XML and lock manager  
Daniel P. Berrange 已提交
4186 4187 4188 4189 
      <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>
A
docs: Use <code> inside <dt> for symbols  
Andrea Bolognani 已提交
4190 
      <dt><code>target</code></dt>
D
Support leases in guest XML and lock manager  
Daniel P. Berrange 已提交
4191 4192 4193 4194 4195 4196 
      <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
docs: document <controller> element  
Eric Blake 已提交
4197
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
4198 
    <h4><a id="elementsHostDev">Host device assignment</a></h4>
D
Add support for <hostdev mode="capabilities">  
Daniel P. Berrange 已提交
4199
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
4200 
    <h5><a id="elementsHostDevSubsys">USB / PCI / SCSI devices</a></h5>
D
documentation for USB passthrough  
Daniel Veillard 已提交
4201 4202 

    <p>
H
conf: Generic XMLs for scsi hostdev  
Han Cheng 已提交
4203 
      USB, PCI and SCSI devices attached to the host can be passed through
D
Add support for <hostdev mode="capabilities">  
Daniel P. Berrange 已提交
4204 
      to the guest using the <code>hostdev</code> element.
H
conf: Generic XMLs for scsi hostdev  
Han Cheng 已提交
4205 4206 
      <span class="since">since after 0.4.4 for USB, 0.6.0 for PCI(KVM only)
        and 1.0.6 for SCSI(KVM only)</span>:
D
documentation for USB passthrough  
Daniel Veillard 已提交
4207 4208 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4209 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 
...
&lt;devices&gt;
  &lt;hostdev mode='subsystem' type='usb'&gt;
    &lt;source startupPolicy='optional'&gt;
      &lt;vendor id='0x1234'/&gt;
      &lt;product id='0xbeef'/&gt;
    &lt;/source&gt;
    &lt;boot order='2'/&gt;
  &lt;/hostdev&gt;
&lt;/devices&gt;
...</pre>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4221
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
4222 
    <p>or:</p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4223 4224 

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 
...
&lt;devices&gt;
  &lt;hostdev mode='subsystem' type='pci' managed='yes'&gt;
    &lt;source&gt;
      &lt;address domain='0x0000' bus='0x06' slot='0x02' function='0x0'/&gt;
    &lt;/source&gt;
    &lt;boot order='1'/&gt;
    &lt;rom bar='on' file='/etc/fake/boot.bin'/&gt;
  &lt;/hostdev&gt;
&lt;/devices&gt;
...</pre>
H
conf: Generic XMLs for scsi hostdev  
Han Cheng 已提交
4236 4237 4238 4239 

    <p>or:</p>

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 
...
&lt;devices&gt;
  &lt;hostdev mode='subsystem' type='scsi' sgio='filtered' rawio='yes'&gt;
    &lt;source&gt;
      &lt;adapter name='scsi_host0'/&gt;
      &lt;address bus='0' target='0' unit='0'/&gt;
    &lt;/source&gt;
    &lt;readonly/&gt;
    &lt;address type='drive' controller='0' bus='0' target='0' unit='0'/&gt;
  &lt;/hostdev&gt;
&lt;/devices&gt;
...</pre>
D
documentation for USB passthrough  
Daniel Veillard 已提交
4252
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
4253 4254 4255 4256 

    <p>or:</p>

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 
...
&lt;devices&gt;
  &lt;hostdev mode='subsystem' type='scsi'&gt;
    &lt;source protocol='iscsi' name='iqn.2014-08.com.example:iscsi-nopool/1'&gt;
      &lt;host name='example.com' port='3260'/&gt;
      &lt;auth username='myuser'&gt;
        &lt;secret type='iscsi' usage='libvirtiscsi'/&gt;
      &lt;/auth&gt;
    &lt;/source&gt;
    &lt;address type='drive' controller='0' bus='0' target='0' unit='0'/&gt;
  &lt;/hostdev&gt;
&lt;/devices&gt;
...</pre>
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
4270
E
conf: Wire up the vhost-scsi connection from/to XML  
Eric Farman 已提交
4271 4272 4273 4274 4275 4276 4277 4278 4279 
    <p>or:</p>

<pre>
  ...
  &lt;devices&gt;
    &lt;hostdev mode='subsystem' type='scsi_host'&gt;
      &lt;source protocol='vhost' wwpn='naa.50014057667280d8'/&gt;
    &lt;/hostdev&gt;
  &lt;/devices&gt;
E
docs: Document the new hostdev type 'mdev'  
Erik Skultety 已提交
4280 4281 4282 4283 4284 4285 4286 4287 4288 
  ...</pre>

    <p>or:</p>

<pre>
  ...
  &lt;devices&gt;
    &lt;hostdev mode='subsystem' type='mdev' model='vfio-pci'&gt;
    &lt;source&gt;
E
docs: Add the closing </address> tag for mdev example  
Erik Skultety 已提交
4289 
      &lt;address uuid='c2177883-f1bb-47f0-914d-32a22e3a8804'/&gt;
E
docs: Document the new hostdev type 'mdev'  
Erik Skultety 已提交
4290 4291 4292 
    &lt;/source&gt;
    &lt;/hostdev&gt;
  &lt;/devices&gt;
E
conf: Wire up the vhost-scsi connection from/to XML  
Eric Farman 已提交
4293 4294 
  ...</pre>
D
documentation for USB passthrough  
Daniel Veillard 已提交
4295 4296 4297 
    <dl>
      <dt><code>hostdev</code></dt>
      <dd>The <code>hostdev</code> element is the main container for describing
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
4298 4299 4300 4301 
        host devices. For each device, the <code>mode</code> is always
        "subsystem" and the <code>type</code> is one of the following values
        with additional attributes noted.
        <dl>
A
docs: Use <code> inside <dt> for symbols  
Andrea Bolognani 已提交
4302 
          <dt><code>usb</code></dt>
J
Document that USB hostdevs do not need nodeDettach  
Ján Tomko 已提交
4303 4304 4305 
          <dd>USB devices are detached from the host on guest startup
            and reattached after the guest exits or the device is
            hot-unplugged.
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
4306 
          </dd>
A
docs: Use <code> inside <dt> for symbols  
Andrea Bolognani 已提交
4307 
          <dt><code>pci</code></dt>
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
4308 4309 4310 
          <dd>For PCI devices, when <code>managed</code> is "yes" it is
            detached from the host before being passed on to the guest
            and reattached to the host after the guest exits. If
J
Document that USB hostdevs do not need nodeDettach  
Ján Tomko 已提交
4311 4312 4313 4314 4315 4316 
            <code>managed</code> is omitted or "no", the user is
            responsible to call <code>virNodeDeviceDetachFlags</code>
            (or <code>virsh nodedev-detach</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.
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
4317 
          </dd>
A
docs: Use <code> inside <dt> for symbols  
Andrea Bolognani 已提交
4318 
          <dt><code>scsi</code></dt>
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
4319 
          <dd>For SCSI devices, user is responsible to make sure the device
J
docs: Clarify unprivileged sgio feature  
John Ferlan 已提交
4320 4321 4322 4323 4324 4325 
            is not used by host. If supported by the hypervisor and OS, the
            optional <code>sgio</code> (<span class="since">since 1.0.6</span>)
            attribute indicates whether unprivileged SG_IO commands are
            filtered for the disk. Valid settings are "filtered" or
            "unfiltered", where the default is "filtered".
            The optional <code>rawio</code>
J
hostdev: Add "rawio" attribute to _virDomainHostdevSubsysSCSI  
John Ferlan 已提交
4326 4327 4328 4329 4330 4331 
            (<span class="since">since 1.2.9</span>) attribute indicates
            whether the lun needs the rawio capability. Valid settings are
            "yes" or "no". See the rawio description within the
            <a href="#elementsDisks">disk</a> section.
            If a disk lun in the domain already has the rawio capability,
            then this setting not required.
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
4332 
          </dd>
E
conf: Wire up the vhost-scsi connection from/to XML  
Eric Farman 已提交
4333 4334 4335 4336 4337 4338 
          <dt><code>scsi_host</code></dt>
          <dd><span class="since">since 2.5.0</span>For SCSI devices, user
            is responsible to make sure the device is not used by host. This
            <code>type</code> passes all LUNs presented by a single HBA to
            the guest.
          </dd>
E
docs: Document the new hostdev type 'mdev'  
Erik Skultety 已提交
4339 4340 4341 4342 4343 4344 4345 4346 
          <dt><code>mdev</code></dt>
          <dd>For mediated devices (<span class="since">Since 3.2.0</span>)
          the <code>model</code> attribute specifies the device API which
          determines how the host's vfio driver will expose the device to the
          guest. Currently, only <code>model='vfio-pci'</code> is supported.
          There are also some implications on the usage of guest's address type
          depending on the <code>model</code> attribute, see the
          <code>address</code> element below.</dd>
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
4347 
        </dl>
E
docs: add a note that attr 'managed' is only used by PCI devices  
Erik Skultety 已提交
4348 
        <p>
E
docs: Document the new hostdev type 'mdev'  
Erik Skultety 已提交
4349 4350 4351 4352 4353 4354 
          Note: The <code>managed</code> attribute is only used with
          <code>type='pci'</code> and is ignored by all the other device types,
          thus setting <code>managed</code> explicitly with other than a PCI
          device has the same effect as omitting it. Similarly,
          <code>model</code> attribute is only supported by mediated devices and
          ignored by all other device types.
E
docs: add a note that attr 'managed' is only used by PCI devices  
Erik Skultety 已提交
4355 
        </p>
O
conf: Introduce sgio for hostdev  
Osier Yang 已提交
4356 
      </dd>
D
documentation for USB passthrough  
Daniel Veillard 已提交
4357 
      <dt><code>source</code></dt>
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
4358 4359 4360 
      <dd>The source element describes the device as seen from the host using
        the following mechanism to describe:
        <dl>
A
docs: Use <code> inside <dt> for symbols  
Andrea Bolognani 已提交
4361 
          <dt><code>usb</code></dt>
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 
          <dd>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 address on the host using the
            <code>address</code> element.
            <p>
            <span class="since">Since 1.0.0</span>, the <code>source</code>
            element of USB devices may contain <code>startupPolicy</code>
            attribute which can be used to define policy what to do if the
            specified host USB device is not found. The attribute accepts
            the following values:
            </p>
            <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>
          </dd>
A
docs: Use <code> inside <dt> for symbols  
Andrea Bolognani 已提交
4389 
          <dt><code>pci</code></dt>
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
4390 4391 
          <dd>PCI devices can only be described by their <code>address</code>.
          </dd>
A
docs: Use <code> inside <dt> for symbols  
Andrea Bolognani 已提交
4392 
          <dt><code>scsi</code></dt>
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
4393 
          <dd>SCSI devices are described by both the <code>adapter</code>
E
docs: Fix XML schema handling of LUN address in hostdev tag  
Eric Farman 已提交
4394 4395 4396 4397 4398 4399 4400 4401 
            and <code>address</code> elements. The <code>address</code>
            element includes a <code>bus</code> attribute (a 2-digit bus
            number), a <code>target</code> attribute (a 10-digit target
            number), and a <code>unit</code> attribute (a 20-digit unit
            number on the bus). Not all hypervisors support larger
            <code>target</code> and <code>unit</code> values. It is up
            to each hypervisor to determine the maximum value supported
            for the adapter.
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 
            <p>
            <span class="since">Since 1.2.8</span>, the <code>source</code>
            element of a SCSI device may contain the <code>protocol</code>
            attribute. When the attribute is set to "iscsi", the host
            device XML follows the network <a href="#elementsDisks">disk</a>
            device using the same <code>name</code> attribute and optionally
            using the <code>auth</code> element to provide the authentication
            credentials to the iSCSI server.
            </p>
          </dd>
E
conf: Wire up the vhost-scsi connection from/to XML  
Eric Farman 已提交
4412 4413 4414 4415 4416 4417 4418 
          <dt><code>scsi_host</code></dt>
          <dd><span class="since">Since 2.5.0</span>, multiple LUNs behind a
            single SCSI HBA are described by a <code>protocol</code>
            attribute set to "vhost" and a <code>wwpn</code> attribute that
            is the vhost_scsi wwpn (16 hexadecimal digits with a prefix of
            "naa.") established in the host configfs.
          </dd>
E
docs: Document the new hostdev type 'mdev'  
Erik Skultety 已提交
4419 4420 4421 4422 4423 4424 
          <dt><code>mdev</code></dt>
          <dd>Mediated devices (<span class="since">Since 3.2.0</span>) are
            described by the <code>address</code> element. The
            <code>address</code> element contains a single mandatory attribute
            <code>uuid</code>.
          </dd>
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
4425 
        </dl>
J
conf: Add support for startupPolicy for USB devices  
Jiri Denemark 已提交
4426 
      </dd>
D
documentation for USB passthrough  
Daniel Veillard 已提交
4427 4428 4429 4430 4431 
      <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>
J
Support booting from hostdev devices  
Jiri Denemark 已提交
4432 4433 4434 4435 4436 4437 
      <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.
J
docs: boot order for host and redirected USB devices  
Ján Tomko 已提交
4438 4439 
      <span class="since">Since 0.8.8</span> for PCI devices,
      <span class="since">Since 1.0.1</span> for USB devices.
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
4440 
      </dd>
L
qemu: add ability to set PCI device "rombar" on or off  
Laine Stump 已提交
4441 4442 
      <dt><code>rom</code></dt>
      <dd>The <code>rom</code> element is used to change how a PCI
L
qemu: add "romfile" support to specify device boot ROM  
Laine Stump 已提交
4443 
        device's ROM is presented to the guest. The optional <code>bar</code>
L
qemu: add ability to set PCI device "rombar" on or off  
Laine Stump 已提交
4444 4445 4446 4447 4448 4449 4450 
        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
L
qemu: add "romfile" support to specify device boot ROM  
Laine Stump 已提交
4451 
        0.9.7 (QEMU and KVM only)</span>. The optional
E
doc: Add info (where necessary) that paths should be specified as absolute  
Erik Skultety 已提交
4452 
        <code>file</code> attribute contains an absolute path to a binary file
L
qemu: add "romfile" support to specify device boot ROM  
Laine Stump 已提交
4453 4454 4455 4456 4457 
        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>.
L
qemu: add ability to set PCI device "rombar" on or off  
Laine Stump 已提交
4458 
      </dd>
D
documentation for USB passthrough  
Daniel Veillard 已提交
4459 
      <dt><code>address</code></dt>
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
4460 4461 4462 4463 4464 
      <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.
H
doc: add domain to address of hostdev pci  
Hu Tao 已提交
4465 
      For PCI devices the element carries 4 attributes allowing to designate
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
4466 
      the device as can be found with the <code>lspci</code> or
J
conf: Change when virDomainHostdevAssignAddress is called  
John Ferlan 已提交
4467 
      with <code>virsh nodedev-list</code>. For SCSI devices a 'drive'
E
docs: Document the new hostdev type 'mdev'  
Erik Skultety 已提交
4468 4469 4470 4471 4472 4473 4474 
      address type must be used. For mediated devices, which are software-only
      devices defining an allocation of resources on the physical parent device,
      the address type used must conform to the <code>model</code> attribute
      of element <code>hostdev</code>, e.g. any address type other than PCI for
      <code>vfio-pci</code> device API will result in an error.
      <a href="#elementsAddress">See above</a> for more details on the address
      element.</dd>
L
conf: formatter/parser/RNG/docs for hostdev <driver name='kvm|vfio'/>  
Laine Stump 已提交
4475 4476 4477 4478 4479 4480 4481 
      <dt><code>driver</code></dt>
      <dd>
        PCI devices can have an optional <code>driver</code>
        subelement that specifies which backend driver to use for PCI
        device assignment. Use the <code>name</code> attribute to
        select either "vfio" (for the new VFIO device assignment
        backend, which is compatible with UEFI SecureBoot) or "kvm"
L
docs: document that vfio is default for hostdev networks too  
Laine Stump 已提交
4482 
        (the legacy device assignment handled directly by the KVM
L
conf: formatter/parser/RNG/docs for hostdev <driver name='kvm|vfio'/>  
Laine Stump 已提交
4483 
        kernel module)<span class="since">Since 1.0.5 (QEMU and KVM
L
docs: document that vfio is default for hostdev networks too  
Laine Stump 已提交
4484 4485 4486 4487 4488 4489 4490 4491 
        only, requires kernel 3.6 or newer)</span>. When specified,
        device assignment will fail if the requested method of device
        assignment isn't available on the host. When not specified,
        the default is "vfio" on systems where the VFIO driver is
        available and loaded, and "kvm" on older systems, or those
        where the VFIO driver hasn't been
        loaded <span class="since">Since 1.1.3</span> (prior to that
        the default was always "kvm").
L
conf: formatter/parser/RNG/docs for hostdev <driver name='kvm|vfio'/>  
Laine Stump 已提交
4492 
      </dd>
O
Introduce <readonly> for hostdev  
Osier Yang 已提交
4493 4494 4495 4496 
      <dt><code>readonly</code></dt>
      <dd>Indicates that the device is readonly, only supported by SCSI host
        device now. <span class="since">Since 1.0.6 (QEMU and KVM only)</span>
      </dd>
O
conf: Introduce <shareable> for hostdev  
Osier Yang 已提交
4497 4498 4499 4500 4501 
      <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).
        Only supported by SCSI host device.
        <span class="since">Since 1.0.6</span>
O
qemu: Don't fail if the SCSI host device is shareable between domains  
Osier Yang 已提交
4502 4503 4504 4505 4506 
        <p>
          Note: Although <code>shareable</code> was introduced
          <span class="since">in 1.0.6</span>, it did not work as
          as expected until <span class="since">1.2.2</span>.
        </p>
O
conf: Introduce <shareable> for hostdev  
Osier Yang 已提交
4507 
      </dd>
D
documentation for USB passthrough  
Daniel Veillard 已提交
4508 4509 
    </dl>
D
Add support for <hostdev mode="capabilities">  
Daniel P. Berrange 已提交
4510
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
4511 
    <h5><a id="elementsHostDevCaps">Block / character devices</a></h5>
D
Add support for <hostdev mode="capabilities">  
Daniel P. Berrange 已提交
4512 4513 4514 4515 

    <p>
      Block / character devices from the host can be passed through
      to the guest using the <code>hostdev</code> element. This is
E
doc: Add info (where necessary) that paths should be specified as absolute  
Erik Skultety 已提交
4516 4517 
      only possible with container based virtualization. Devices are specified
      by a fully qualified path.
D
Add support for <hostdev mode="capabilities">  
Daniel P. Berrange 已提交
4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 
      <span class="since">since after 1.0.1 for LXC</span>:
    </p>

    <pre>
...
&lt;hostdev mode='capabilities' type='storage'&gt;
  &lt;source&gt;
    &lt;block&gt;/dev/sdf1&lt;/block&gt;
  &lt;/source&gt;
&lt;/hostdev&gt;
...
    </pre>

    <pre>
...
&lt;hostdev mode='capabilities' type='misc'&gt;
  &lt;source&gt;
    &lt;char&gt;/dev/input/event3&lt;/char&gt;
  &lt;/source&gt;
&lt;/hostdev&gt;
B
Update structure & XML definitions to support <hostdev caps=net>  
Bogdan Purcareata 已提交
4538 4539 4540 
...
    </pre>
O
docs: Add the missed <pre> tag  
Osier Yang 已提交
4541 
    <pre>
B
Update structure & XML definitions to support <hostdev caps=net>  
Bogdan Purcareata 已提交
4542 4543 4544 4545 4546 4547 
...
&lt;hostdev mode='capabilities' type='net'&gt;
  &lt;source&gt;
    &lt;interface&gt;eth0&lt;/interface&gt;
  &lt;/source&gt;
&lt;/hostdev&gt;
D
Add support for <hostdev mode="capabilities">  
Daniel P. Berrange 已提交
4548 4549 4550 4551 4552 4553 4554 
...
    </pre>

    <dl>
      <dt><code>hostdev</code></dt>
      <dd>The <code>hostdev</code> element is the main container for describing
        host devices. For block/character device passthrough <code>mode</code> is
J
docs: fix some typos in formatdomain.html  
Jincheng Miao 已提交
4555 4556 
        always "capabilities" and <code>type</code> is "storage" for a block
        device, "misc" for a character device and "net" for a host network
B
Update structure & XML definitions to support <hostdev caps=net>  
Bogdan Purcareata 已提交
4557 
        interface.
D
Add support for <hostdev mode="capabilities">  
Daniel P. Berrange 已提交
4558 4559 4560 4561 4562 
      </dd>
      <dt><code>source</code></dt>
      <dd>The source element describes the device as seen from the host.
        For block devices, the path to the block device in the host
        OS is provided in the nested "block" element, while for character
B
Update structure & XML definitions to support <hostdev caps=net>  
Bogdan Purcareata 已提交
4563 4564 
        devices the "char" element is used. For network interfaces, the
        name of the interface is provided in the "interface" element.
D
Add support for <hostdev mode="capabilities">  
Daniel P. Berrange 已提交
4565 4566 4567 
      </dd>
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
4568 
    <h4><a id="elementsRedir">Redirected devices</a></h4>
M
Add "redirdev" redirection device  
Marc-André Lureau 已提交
4569 4570 4571 4572 4573 4574 4575 4576 

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

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 
...
&lt;devices&gt;
  &lt;redirdev bus='usb' type='tcp'&gt;
    &lt;source mode='connect' host='localhost' service='4000'/&gt;
    &lt;boot order='1'/&gt;
  &lt;/redirdev&gt;
  &lt;redirfilter&gt;
    &lt;usbdev class='0x08' vendor='0x1234' product='0xbeef' version='2.56' allow='yes'/&gt;
    &lt;usbdev allow='no'/&gt;
  &lt;/redirfilter&gt;
&lt;/devices&gt;
...</pre>
M
Add "redirdev" redirection device  
Marc-André Lureau 已提交
4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 

    <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
J
docs: Fix a few spaces  
Ján Tomko 已提交
4603 4604 
        device</a>) are typical. The redirdev element has an optional
        sub-element <code>&lt;address&gt;</code> which can tie the
G
doc: update usb redirection filter infomation on formatdomain.html  
Guannan Ren 已提交
4605 4606 4607 4608 
        device to a particular controller. 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
J
docs: boot order for host and redirected USB devices  
Ján Tomko 已提交
4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 
        the hypervisor itself, rather than a device visible in the guest).
      </dd>
      <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 1.0.1</span>)
G
doc: update usb redirection filter infomation on formatdomain.html  
Guannan Ren 已提交
4619 4620 4621 4622 
      </dd>
      <dt><code>redirfilter</code></dt>
      <dd>The<code> redirfilter </code>element is used for creating the
        filter rule to filter out certain devices from redirection.
J
docs: Fix a few spaces  
Ján Tomko 已提交
4623 4624 
        It uses sub-element <code>&lt;usbdev&gt;</code> to define each filter rule.
        <code>class</code> attribute is the USB Class code, for example,
G
doc: update usb redirection filter infomation on formatdomain.html  
Guannan Ren 已提交
4625 
        0x08 represents mass storage devices. The USB device can be addressed by
J
docs: Fix a few spaces  
Ján Tomko 已提交
4626 
        vendor / product id using the <code>vendor</code> and <code>product</code> attributes.
J
Clarify the meaning of version in redirdev filters  
Ján Tomko 已提交
4627 4628 
        <code>version</code> is the device revision from the bcdDevice field (not
        the version of the USB protocol).
G
doc: update usb redirection filter infomation on formatdomain.html  
Guannan Ren 已提交
4629 
        These four attributes are optional and <code>-1</code> can be used to allow
J
docs: Fix a few spaces  
Ján Tomko 已提交
4630 
        any value for them. <code>allow</code> attribute is mandatory,
G
doc: update usb redirection filter infomation on formatdomain.html  
Guannan Ren 已提交
4631 4632 
        'yes' means allow, 'no' for deny.
      </dd>
M
Add "redirdev" redirection device  
Marc-André Lureau 已提交
4633 4634 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
4635 
    <h4><a id="elementsSmartcard">Smartcard devices</a></h4>
E
smartcard: add XML support for <smartcard> device  
Eric Blake 已提交
4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 

    <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>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 
...
&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;
  &lt;smartcard mode='passthrough' type='spicevmc'/&gt;
&lt;/devices&gt;
...
E
smartcard: add XML support for <smartcard> device  
Eric Blake 已提交
4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 
</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>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
4679 
      <dt><code>host</code></dt>
E
smartcard: add XML support for <smartcard> device  
Eric Blake 已提交
4680 4681 4682 4683 4684 4685 
      <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>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
4686 
      <dt><code>host-certificates</code></dt>
E
smartcard: add XML support for <smartcard> device  
Eric Blake 已提交
4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 
      <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>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
4700 
      <dt><code>passthrough</code></dt>
E
smartcard: add XML support for <smartcard> device  
Eric Blake 已提交
4701 4702 4703 4704 4705 4706 4707 
      <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
smartcard: add spicevmc support  
Eric Blake 已提交
4708 4709 4710 4711 4712 
      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
E
smartcard: add XML support for <smartcard> device  
Eric Blake 已提交
4713 4714 4715 4716 4717 4718 4719 4720 4721 
      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
E
docs: document <address> elements in one place  
Eric Blake 已提交
4722 4723 4724 
      correlation between the smartcard and a ccid bus
      controller, <a href="#elementsAddress">documented above</a>.
      For now, qemu only supports at most one
E
smartcard: add XML support for <smartcard> device  
Eric Blake 已提交
4725 4726 4727 
      smartcard, with an address of bus=0 slot=0.
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
4728 
    <h4><a id="elementsNICS">Network interfaces</a></h4>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4729
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4730 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 
...
&lt;devices&gt;
  &lt;interface type='direct' trustGuestRxFilters='yes'&gt;
    &lt;source dev='eth0'/&gt;
    &lt;mac address='52:54:00:5d:c7:9e'/&gt;
    &lt;boot order='1'/&gt;
    &lt;rom bar='off'/&gt;
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4741
E
docs: document <controller> element  
Eric Blake 已提交
4742 4743 4744 
    <p>
      There are several possibilities for specifying a network
      interface visible to the guest.  Each subsection below provides
L
conf: add trustGuestRxFilters attribute to network and domain interface  
Laine Stump 已提交
4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 
      more details about common setup options.
    </p>
    <p>
      <span class="since">Since 1.2.10</span>),
      the <code>interface</code> element
      property <code>trustGuestRxFilters</code> provides the
      capability for the host to detect and trust reports from the
      guest regarding changes to the interface mac address and receive
      filters by setting the attribute to <code>yes</code>. The default
      setting for the attribute is <code>no</code> for security
      reasons and support depends on the guest network device model as
      well as the type of connection on the host - currently it is
C
docs: fix a typo in formatdomain.html  
Chen Fan 已提交
4757 
      only supported for the virtio device model and for macvtap
L
conf: add trustGuestRxFilters attribute to network and domain interface  
Laine Stump 已提交
4758 4759 4760 4761 
      connections on the host.
    </p>
    <p>
      Each <code>&lt;interface&gt;</code> element has an
E
docs: document <controller> element  
Eric Blake 已提交
4762 4763 
      optional <code>&lt;address&gt;</code> sub-element that can tie
      the interface to a particular pci slot, with
E
docs: document <address> elements in one place  
Eric Blake 已提交
4764 4765 
      attribute <code>type='pci'</code>
      as <a href="#elementsAddress">documented above</a>.
E
docs: document <controller> element  
Eric Blake 已提交
4766 4767 
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
4768 
    <h5><a id="elementsNICSVirtual">Virtual network</a></h5>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4769 4770 4771 4772 

    <p>
      <strong><em>
      This is the recommended config for general guest connectivity on
L
conf: support abstracted interface info in domain interface XML  
Laine Stump 已提交
4773 4774 4775 4776 
      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
Update domain XML docs  
Daniel P. Berrange 已提交
4777 4778 4779 4780 
      </em></strong>
    </p>

    <p>
L
conf: support abstracted interface info in domain interface XML  
Laine Stump 已提交
4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 

      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
C
Document overriding domain interface target  
Cole Robinson 已提交
4808 
      <a href="#elementsNICSTargetOverride">overriding the target element</a>).
D
Update domain XML docs  
Daniel P. Berrange 已提交
4809 
    </p>
L
conf: support abstracted interface info in domain interface XML  
Laine Stump 已提交
4810 4811 4812 4813 4814 4815 
    <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
L
network: merge relevant virtualports rather than choosing one  
Laine Stump 已提交
4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 
      connections. <span class="since">Since 0.9.4</span>.
    </p>
    <p>
      Also, similar to <code>direct</code> network connections
      (described below), a connection of type <code>network</code> may
      specify a <code>virtualport</code> element, with configuration
      data to be forwarded to a vepa (802.1Qbg) or 802.1Qbh compliant
      switch (<span class="since">Since 0.8.2</span>), or to an
      Open vSwitch virtual switch (<span class="since">Since
      0.9.11</span>).
    </p>
    <p>
      Since the actual type of switch may vary depending on the
      configuration in the <code>&lt;network&gt;</code> on the host,
      it is acceptable to omit the virtualport <code>type</code>
      attribute, and specify attributes from multiple different
      virtualport types (and also to leave out certain attributes); at
      domain startup time, a complete <code>&lt;virtualport&gt;</code>
      element will be constructed by merging together the type and
G
network: fix typos and docs  
Guannan Ren 已提交
4835 4836 4837 4838 4839 
      attributes defined in the network and the portgroup referenced
      by the interface. The newly-constructed virtualport is a combination
      of them. The attributes from lower virtualport can't make change
      on the ones defined in higher virtualport.
      Interface takes the highest priority, portgroup is lowest priority.
L
network: merge relevant virtualports rather than choosing one  
Laine Stump 已提交
4840 4841 4842 
      (<span class="since">Since 0.10.0</span>). For example, in order
      to work properly with both an 802.1Qbh switch and an Open vSwitch
      switch, you may choose to specify no type, but both
G
network: fix typos and docs  
Guannan Ren 已提交
4843 
      an <code>profileid</code> (in case the switch is 802.1Qbh) and
L
network: merge relevant virtualports rather than choosing one  
Laine Stump 已提交
4844 4845 4846 4847 4848 4849 4850 4851 4852 
      an <code>interfaceid</code> (in case the switch is Open vSwitch)
      (you may also omit the other attributes, such as managerid,
      typeid, or profileid, to be filled in from the
      network's <code>&lt;virtualport&gt;</code>). If you want to
      limit a guest to connecting only to certain types of switches,
      you can specify the virtualport type, but still omit some/all of
      the parameters - in this case if the host's network has a
      different type of virtualport, connection of the interface will
      fail.
L
conf: support abstracted interface info in domain interface XML  
Laine Stump 已提交
4853 
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4854
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4855 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4856 4857 4858 4859 4860 
...
&lt;devices&gt;
  &lt;interface type='network'&gt;
    &lt;source network='default'/&gt;
  &lt;/interface&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4861 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 
  &lt;interface type='network'&gt;
    &lt;source network='default' portgroup='engineering'/&gt;
    &lt;target dev='vnet7'/&gt;
    &lt;mac address="00:11:22:33:44:55"/&gt;
    &lt;virtualport&gt;
      &lt;parameters instanceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f'/&gt;
    &lt;/virtualport&gt;

  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4873
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
4874 
    <h5><a id="elementsNICSBridge">Bridge to LAN</a></h5>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4875 4876 4877 4878 

    <p>
      <strong><em>
      This is the recommended config for general guest connectivity on
L
network: merge relevant virtualports rather than choosing one  
Laine Stump 已提交
4879 
      hosts with static wired networking configs.
D
Update domain XML docs  
Daniel P. Berrange 已提交
4880 4881 4882 4883 
      </em></strong>
    </p>

    <p>
E
docs: fix usage of 'onto'  
Eric Blake 已提交
4884 
      Provides a bridge from the VM directly to the LAN. This assumes
D
Update domain XML docs  
Daniel P. Berrange 已提交
4885 4886 4887 
      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
C
Document overriding domain interface target  
Cole Robinson 已提交
4888 4889 4890 4891 4892 
      &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
Update domain XML docs  
Daniel P. Berrange 已提交
4893 
    </p>
L
network: merge relevant virtualports rather than choosing one  
Laine Stump 已提交
4894 4895 4896 
    <p>
      On Linux systems, the bridge device is normally a standard Linux
      host bridge. On hosts that support Open vSwitch, it is also
L
util: set vlan tag for macvtap passthrough mode on SRIOV VFs  
Laine Stump 已提交
4897 
      possible to connect to an Open vSwitch bridge device by adding
L
network: merge relevant virtualports rather than choosing one  
Laine Stump 已提交
4898 4899 4900 4901 4902 4903 
      a <code>&lt;virtualport type='openvswitch'/&gt;</code> to the
      interface definition.  (<span class="since">Since
      0.9.11</span>). The Open vSwitch type virtualport accepts two
      parameters in its <code>&lt;parameters&gt;</code> element -
      an <code>interfaceid</code> which is a standard uuid used to
      uniquely identify this particular interface to Open vSwitch (if
C
doc: fix a typo in formatdomain  
Chen Hanxiao 已提交
4904 
      you do not specify one, a random interfaceid will be generated
L
network: merge relevant virtualports rather than choosing one  
Laine Stump 已提交
4905 4906 4907 4908 
      for you when you first define the interface), and an
      optional <code>profileid</code> which is sent to Open vSwitch as
      the interfaces "port-profile".
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4909 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4910 4911 
...
&lt;devices&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4912 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 
  &lt;interface type='bridge'&gt;
    &lt;source bridge='br0'/&gt;
  &lt;/interface&gt;
  &lt;interface type='bridge'&gt;
    &lt;source bridge='br1'/&gt;
    &lt;target dev='vnet7'/&gt;
    &lt;mac address="00:11:22:33:44:55"/&gt;
  &lt;/interface&gt;
  &lt;interface type='bridge'&gt;
    &lt;source bridge='ovsbr'/&gt;
    &lt;virtualport type='openvswitch'&gt;
      &lt;parameters profileid='menial' interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f'/&gt;
    &lt;/virtualport&gt;
  &lt;/interface&gt;
  ...
&lt;/devices&gt;
...</pre>
A
docs: schema and docs for the midonet virtualport type  
Antoni Segura Puimedon 已提交
4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 

    <p>
      On hosts that support Open vSwitch on the kernel side and have the
      Midonet Host Agent configured, it is also possible to connect to the
      'midonet' bridge device by adding a
      <code>&lt;virtualport type='midonet'/&gt;</code> to the
      interface definition.  (<span class="since">Since
      1.2.13</span>). The Midonet virtualport type requires an
      <code>interfaceid</code> attribute in its
      <code>&lt;parameters&gt;</code> element. This interface id is the UUID
      that specifies which port in the virtual network topology will be bound
      to the interface.
    </p>
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4944 4945 
...
&lt;devices&gt;
A
docs: schema and docs for the midonet virtualport type  
Antoni Segura Puimedon 已提交
4946 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 
  &lt;interface type='bridge'&gt;
    &lt;source bridge='br0'/&gt;
  &lt;/interface&gt;
  &lt;interface type='bridge'&gt;
    &lt;source bridge='br1'/&gt;
    &lt;target dev='vnet7'/&gt;
    &lt;mac address="00:11:22:33:44:55"/&gt;
  &lt;/interface&gt;
  &lt;interface type='bridge'&gt;
    &lt;source bridge='midonet'/&gt;
    &lt;virtualport type='midonet'&gt;
      &lt;parameters interfaceid='0b2d64da-3d0e-431e-afdd-804415d6ebbb'/&gt;
    &lt;/virtualport&gt;
  &lt;/interface&gt;
  ...
&lt;/devices&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4964
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
4965 
    <h5><a id="elementsNICSSlirp">Userspace SLIRP stack</a></h5>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4966 4967 4968 4969 4970 4971 4972 

    <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
M
conf: Allow usernet to have an address  
Michal Privoznik 已提交
4973 4974 4975 4976 4977 4978 4979 4980 4981 
      VMs to have outgoing access. <span class="since">Since 3.8.0</span>
      it is possible to override the default network address by
      including an <code>ip</code> element specifying an IPv4
      address in its one mandatory attribute, <code>address</code>.
      Optionally, a second <code>ip</code> element with a
      <code>family</code> attribute set to "ipv6" can be
      specified to add an IPv6 address to the interface.
      <code>address</code>. Optionally, address
      <code>prefix</code> can be specified.
D
Update domain XML docs  
Daniel P. Berrange 已提交
4982 4983 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4984 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4985 4986 4987 
...
&lt;devices&gt;
  &lt;interface type='user'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4988 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4989 4990 
  &lt;interface type='user'&gt;
    &lt;mac address="00:11:22:33:44:55"/&gt;
M
conf: Allow usernet to have an address  
Michal Privoznik 已提交
4991 4992 
    &lt;ip family='ipv4' address='172.17.2.0' prefix='24'/&gt;
    &lt;ip family='ipv6' address='2001:db8:ac10:fd01::' prefix='64'/&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
4993 4994 4995 
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4996 4997
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
4998 
    <h5><a id="elementsNICSEthernet">Generic ethernet connection</a></h5>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 

    <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>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5010 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5011 5012 5013 
...
&lt;devices&gt;
  &lt;interface type='ethernet'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5014 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5015 5016 5017 5018 5019 5020 
  &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
Update domain XML docs  
Daniel P. Berrange 已提交
5021
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5022 
    <h5><a id="elementsNICSDirect">Direct attachment to physical interface</a></h5>
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
5023 5024 5025 

    <p>
      Provides direct attachment of the virtual machine's NIC to the given
Y
Fix minor typos in messages and docs  
Yuri Chornoivan 已提交
5026 
      physical interface of the host.
E
docs: correct invalid xml  
Eric Blake 已提交
5027 
      <span class="since">Since 0.7.7 (QEMU and KVM only)</span><br/>
S
Mention direct device support since 0.7.7 in docs  
Stefan Berger 已提交
5028 5029 5030 
      This setup requires the Linux macvtap
      driver to be available. <span class="since">(Since Linux 2.6.34.)</span>
      One of the modes 'vepa'
S
web docs -- macvtap mode explanation  
Stefan Berger 已提交
5031 
      ( <a href="http://www.ieee802.org/1/files/public/docs2009/new-evb-congdon-vepa-modular-0709-v01.pdf">
E
docs: correct range of default NAT subnet  
Eric Blake 已提交
5032 
      'Virtual Ethernet Port Aggregator'</a>), 'bridge' or 'private'
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
5033 
      can be chosen for the operation mode of the macvtap device, 'vepa'
S
web docs -- macvtap mode explanation  
Stefan Berger 已提交
5034 5035 
      being the default mode. The individual modes cause the delivery of
      packets to behave as follows:
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
5036 
    </p>
L
conf: add trustGuestRxFilters attribute to network and domain interface  
Laine Stump 已提交
5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 
    <p>
      If the model type is set to <code>virtio</code> and
      interface's <code>trustGuestRxFilters</code> attribute is set
      to <code>yes</code>, changes made to the interface mac address,
      unicast/multicast receive filters, and vlan settings in the
      guest will be monitored and propagated to the associated macvtap
      device on the host (<span class="since">Since
      1.2.10</span>). If <code>trustGuestRxFilters</code> is not set,
      or is not supported for the device model in use, an attempted
      change to the mac address originating from the guest side will
      result in a non-working network connection.
    </p>
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
5049
S
web docs -- macvtap mode explanation  
Stefan Berger 已提交
5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 
    <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
docs: correct invalid xml  
Eric Blake 已提交
5061 
      a VEPA capable bridge is required.</dd>
S
web docs -- macvtap mode explanation  
Stefan Berger 已提交
5062 5063 5064 5065 5066 5067 
      <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>
D
Add support for 'passthru' mode for direct network interfaces  
Dirk Herrendorefer 已提交
5068 5069 5070 5071 5072 5073 5074 
      <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>
S
web docs -- macvtap mode explanation  
Stefan Berger 已提交
5075 5076 
    </dl>
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
5077 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5078 5079 
...
&lt;devices&gt;
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
5080 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5081 5082 5083 5084 5085 
  &lt;interface type='direct' trustGuestRxFilters='no'&gt;
    &lt;source dev='eth0' mode='vepa'/&gt;
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
5086
G
documenting the 802.1Qbg parameters of a 'direct' interface  
Gerhard Stenzel 已提交
5087 5088 5089 5090 
    <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
docs: fix missing </p>  
Eric Blake 已提交
5091 
    </p>
G
documenting the 802.1Qbg parameters of a 'direct' interface  
Gerhard Stenzel 已提交
5092 5093 5094 5095 5096 5097 5098 
    <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
D
documenting the 802.1Qbh parameters of a 'direct' interface  
David S. Wang 已提交
5099 
      of a virtual machine. <span class="since">Since 0.8.2</span>
G
documenting the 802.1Qbg parameters of a 'direct' interface  
Gerhard Stenzel 已提交
5100 
    </p>
G
fix missing VLAN id for Qbg example  
Gerhard Stenzel 已提交
5101 5102 5103 5104 
    <p>
      Please note that IEEE 802.1Qbg requires a non-zero value for the
      VLAN ID.
    </p>
G
documenting the 802.1Qbg parameters of a 'direct' interface  
Gerhard Stenzel 已提交
5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 
    <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>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5126 5127 
...
&lt;devices&gt;
G
documenting the 802.1Qbg parameters of a 'direct' interface  
Gerhard Stenzel 已提交
5128 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5129 5130 5131 5132 5133 5134 5135 5136 
  &lt;interface type='direct'&gt;
    &lt;source dev='eth0.2' mode='vepa'/&gt;
    &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>
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
5137
D
documenting the 802.1Qbh parameters of a 'direct' interface  
David S. Wang 已提交
5138 5139 5140 5141 5142 5143 5144 5145 5146 
    <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
E
docs: fix usage of 'onto'  
Eric Blake 已提交
5147 
        be applied to this interface.  This name is resolved by the port
D
documenting the 802.1Qbh parameters of a 'direct' interface  
David S. Wang 已提交
5148 5149 5150 5151 5152 
        profile database into the network parameters from the port profile,
        and those network parameters will be applied to this interface.
      </dd>
    </dl>
  <pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5153 5154 
...
&lt;devices&gt;
D
documenting the 802.1Qbh parameters of a 'direct' interface  
David S. Wang 已提交
5155 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5156 5157 5158 5159 5160 5161 5162 5163 5164 
  &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>
D
documenting the 802.1Qbh parameters of a 'direct' interface  
David S. Wang 已提交
5165
L
conf: parse/format type='hostdev' network interfaces  
Laine Stump 已提交
5166
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5167 
    <h5><a id="elementsNICSHostdev">PCI Passthrough</a></h5>
L
conf: parse/format type='hostdev' network interfaces  
Laine Stump 已提交
5168 5169 5170 5171 5172 5173 

    <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
L
docs: small typo in formatdomain.html  
Laine Stump 已提交
5174 
      an 802.1Qbh capable switch using an optionally specified
L
docs: minor fixes to domain interface documentation  
Laine Stump 已提交
5175 
      &lt;virtualport&gt; element (see the examples of virtualport
L
conf: parse/format type='hostdev' network interfaces  
Laine Stump 已提交
5176 5177 5178 5179 5180 5181 5182 5183 5184 
      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>
L
conf: formatter/parser/RNG/docs for hostdev <driver name='kvm|vfio'/>  
Laine Stump 已提交
5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 
    <p>
      To use VFIO device assignment rather than traditional/legacy KVM
      device assignment (VFIO is a new method of device assignment
      that is compatible with UEFI Secure Boot), a type='hostdev'
      interface can have an optional <code>driver</code> sub-element
      with a <code>name</code> attribute set to "vfio". To use legacy
      KVM device assignment you can set <code>name</code> to "kvm" (or
      simply omit the <code>&lt;driver&gt;</code> element, since "kvm"
      is currently the default).
      <span class="since">Since 1.0.5 (QEMU and KVM only, requires kernel 3.6 or newer)</span>
    </p>
L
conf: parse/format type='hostdev' network interfaces  
Laine Stump 已提交
5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 
    <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>
C
update documentation of <interface type='hostdev'>  
Chunyan Liu 已提交
5211 5212 5213 5214 5215 5216 
    <p>
      Similar to the functionality of a standard &lt;hostdev&gt; device,
      when <code>managed</code> is "yes", it is detached from the host
      before being passed on to the guest, and reattached to the host
      after the guest exits. If <code>managed</code> is omitted or "no",
      the user is responsible to call <code>virNodeDeviceDettach</code>
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
5217 
      (or <code>virsh nodedev-detach</code>) before starting the guest
C
update documentation of <interface type='hostdev'>  
Chunyan Liu 已提交
5218 5219 5220 5221 5222 
      or hot-plugging the device, and <code>virNodeDeviceReAttach</code>
      (or <code>virsh nodedev-reattach</code>) after hot-unplug or
      stopping the guest.
    </p>
L
conf: parse/format type='hostdev' network interfaces  
Laine Stump 已提交
5223 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 
...
&lt;devices&gt;
  &lt;interface type='hostdev' managed='yes'&gt;
    &lt;driver name='vfio'/&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>
L
conf: parse/format type='hostdev' network interfaces  
Laine Stump 已提交
5238 5239
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5240 
    <h5><a id="elementsNICSMulticast">Multicast tunnel</a></h5>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 

    <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>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5254 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5255 5256 5257 5258 5259 5260 5261 5262 
...
&lt;devices&gt;
  &lt;interface type='mcast'&gt;
    &lt;mac address='52:54:00:6d:90:01'/&gt;
    &lt;source address='230.0.0.1' port='5558'/&gt;
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5263
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5264 
    <h5><a id="elementsNICSTCP">TCP tunnel</a></h5>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 

    <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>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5275 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5276 5277 5278 5279 5280 5281 
...
&lt;devices&gt;
  &lt;interface type='server'&gt;
    &lt;mac address='52:54:00:22:c9:42'/&gt;
    &lt;source address='192.168.0.1' port='5558'/&gt;
  &lt;/interface&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5282 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5283 5284 5285 5286 5287 5288 
  &lt;interface type='client'&gt;
    &lt;mac address='52:54:00:8b:c9:51'/&gt;
    &lt;source address='192.168.0.1' port='5558'/&gt;
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>
J
qemu: add udp interface support  
Jonathan Toppins 已提交
5289
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5290 
    <h5><a id="elementsNICSUDP">UDP unicast tunnel</a></h5>
J
qemu: add udp interface support  
Jonathan Toppins 已提交
5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 

    <p>
    A UDP unicast architecture provides a virtual network which enables
    connections between QEMU instances using QEMU's UDP infrastructure.

    The xml "source" address is the endpoint address to which the UDP socket
    packets will be sent from the host running QEMU.
    The xml "local" address is the address of the interface from which the
    UDP socket packets will originate from the QEMU host.
    <span class="since">Since 1.2.20</span></p>

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 
...
&lt;devices&gt;
  &lt;interface type='udp'&gt;
    &lt;mac address='52:54:00:22:c9:42'/&gt;
    &lt;source address='127.0.0.1' port='11115'&gt;
      &lt;local address='127.0.0.1' port='11116'/&gt;
    &lt;/source&gt;
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5313
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5314 
    <h5><a id="elementsNICSModel">Setting the NIC model</a></h5>
R
Documentation for NIC model selection.  
Richard W.M. Jones 已提交
5315
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5316 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5317 5318 5319 5320 5321 5322 5323 5324 5325 
...
&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>
R
Documentation for NIC model selection.  
Richard W.M. Jones 已提交
5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 

    <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
Update domain XML docs  
Daniel P. Berrange 已提交
5348
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5349 
    <h5><a id="elementsDriverBackendOptions">Setting NIC driver-specific options</a></h5>
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
5350 5351 

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5352 5353 5354 5355 5356 5357 
...
&lt;devices&gt;
  &lt;interface type='network'&gt;
    &lt;source network='default'/&gt;
    &lt;target dev='vnet1'/&gt;
    &lt;model type='virtio'/&gt;
M
Add support for virtio-net.tx_queue_size  
Michal Privoznik 已提交
5358 
    <b>&lt;driver name='vhost' txmode='iothread' ioeventfd='on' event_idx='off' queues='5' rx_queue_size='256' tx_queue_size='256'&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5359 5360 5361 5362 5363 5364 5365 
      &lt;host csum='off' gso='off' tso4='off' tso6='off' ecn='off' ufo='off' mrg_rxbuf='off'/&gt;
      &lt;guest csum='off' tso4='off' tso6='off' ecn='off' ufo='off'/&gt;
    &lt;/driver&gt;
    </b>
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
5366 5367 5368 5369 5370 5371 5372 5373 5374 

    <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>
E
docs: document <driver name='vhost'/> for interfaces  
Eric Blake 已提交
5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 
      <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>
L
conf: formatter/parser/RNG/docs for hostdev <driver name='kvm|vfio'/>  
Laine Stump 已提交
5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 
      <dd>
        For interfaces of type='hostdev' (PCI passthrough devices)
        the <code>name</code> attribute can optionally be set to
        "vfio" or "kvm". "vfio" tells libvirt to use VFIO device
        assignment rather than traditional KVM device assignment (VFIO
        is a new method of device assignment that is compatible with
        UEFI Secure Boot), and "kvm" tells libvirt to use the legacy
        device assignment performed directly by the kvm kernel module
        (the default is currently "kvm", but is subject to change).
        <span class="since">Since 1.0.5 (QEMU and KVM only, requires
        kernel 3.6 or newer)</span>
      </dd>
M
docs: Clarify that attribute name is not used for vhostuser  
Maxime Leroy 已提交
5399 5400 5401 5402 5403 
      <dd>
        For interfaces of type='vhostuser', the <code>name</code>
        attribute is ignored. The backend driver used is always
        vhost-user.
      </dd>
L
conf: formatter/parser/RNG/docs for hostdev <driver name='kvm|vfio'/>  
Laine Stump 已提交
5404
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
5405 5406 5407 5408 5409 
      <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
docs: correct invalid xml  
Eric Blake 已提交
5410 
        <span class="since">Since 0.8.8 (QEMU and KVM only)</span><br/><br/>
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
5411 5412 5413 5414 

        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
docs: correct invalid xml  
Eric Blake 已提交
5415 
        option).<br/><br/>
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
5416 5417 5418 5419 

        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
docs: correct invalid xml  
Eric Blake 已提交
5420 
        fires, another attempt is made to send more data.<br/><br/>
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
5421 5422 5423 5424 5425 

        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
docs: correct invalid xml  
Eric Blake 已提交
5426 
        cpu where the guest generated the packets."<br/><br/>
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
5427
M
qemu: domain I/O asynchronous handling  
Michal Privoznik 已提交
5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 
        <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/>
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
5444 
        <b>In general you should leave this option alone, unless you
L
qemu: support event_idx parameter for virtio disk and net devices  
Laine Stump 已提交
5445 5446 5447 5448 5449 5450 
        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'
Y
Fix some typos in messages, docs and comments.  
Yuri Chornoivan 已提交
5451 
        - if it is on, it will reduce the number of interrupts and
L
qemu: support event_idx parameter for virtio disk and net devices  
Laine Stump 已提交
5452 5453 5454 5455 5456 5457 5458 
        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
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
5459 5460 
        are very certain you know what you are doing.</b>
      </dd>
M
Introduce /domain/devices/interface/driver/@queues attribute  
Michal Privoznik 已提交
5461 5462 
      <dt><code>queues</code></dt>
      <dd>
M
qemu: add multiqueue vhost-user support  
Maxime Leroy 已提交
5463 5464 
        The optional <code>queues</code> attribute controls the number
        of queues to be used for either
D
Use https:// links for most sites  
Daniel P. Berrange 已提交
5465 
        <a href="https://www.linux-kvm.org/page/Multiqueue"> Multiqueue
M
qemu: add multiqueue vhost-user support  
Maxime Leroy 已提交
5466 5467 5468 5469 
        virtio-net</a> or <a href="#elementVhostuser">vhost-user</a> network
        interfaces.  Use of multiple packet processing queues requires the
        interface having the <code>&lt;model type='virtio'/&gt;</code>
        element.  Each queue will potentially be handled by a different
M
Introduce /domain/devices/interface/driver/@queues attribute  
Michal Privoznik 已提交
5470 
        processor, resulting in much higher throughput.
M
qemu: add multiqueue vhost-user support  
Maxime Leroy 已提交
5471 
        <span class="since">virtio-net since 1.0.6 (QEMU and KVM only)</span>
M
Revert "Change livbirt version to 1.3.0 for the next release"  
Martin Kletzander 已提交
5472 
        <span class="since">vhost-user since 1.2.17 (QEMU and KVM only)</span>
M
Introduce /domain/devices/interface/driver/@queues attribute  
Michal Privoznik 已提交
5473 
      </dd>
M
conf: Add support for virtio-net.rx_queue_size  
Michal Privoznik 已提交
5474 5475 5476 5477 5478 5479 5480 5481 5482 
      <dt><code>rx_queue_size</code></dt>
      <dd>
        The optional <code>rx_queue_size</code> attribute controls
        the size of virtio ring for each queue as described above.
        The default value is hypervisor dependent and may change
        across its releases. Moreover, some hypervisors may pose
        some restrictions on actual value. For instance, latest
        QEMU (as of 2016-09-01) requires value to be a power of two
        from [256, 1024] range.
D
Revert "qemu: Expose rx/tx_queue_size in qemu.conf too"  
Daniel P. Berrangé 已提交
5483 
        <span class="since">Since 2.3.0 (QEMU and KVM only)</span><br/><br/>
M
conf: Add support for virtio-net.rx_queue_size  
Michal Privoznik 已提交
5484 5485 5486 5487 

        <b>In general you should leave this option alone, unless you
        are very certain you know what you are doing.</b>
      </dd>
M
Add support for virtio-net.tx_queue_size  
Michal Privoznik 已提交
5488 5489 5490 5491 5492 5493 5494 
      <dt><code>tx_queue_size</code></dt>
      <dd>
        The optional <code>tx_queue_size</code> attribute controls
        the size of virtio ring for each queue as described above.
        The default value is hypervisor dependent and may change
        across its releases. Moreover, some hypervisors may pose
        some restrictions on actual value. For instance, QEMU
M
docs: Document yet another limitation of tx_queue_size  
Michal Privoznik 已提交
5495 5496 5497 5498 
        v2.9  requires value to be a power of two from [256, 1024]
        range. In addition to that, this may work only for a subset of
        interface types, e.g. aforementioned QEMU enables this option
        only for <code>vhostuser</code> type.
D
Revert "qemu: Expose rx/tx_queue_size in qemu.conf too"  
Daniel P. Berrangé 已提交
5499 
        <span class="since">Since 3.7.0 (QEMU and KVM only)</span><br/><br/>
M
Add support for virtio-net.tx_queue_size  
Michal Privoznik 已提交
5500 5501 5502 5503 

        <b>In general you should leave this option alone, unless you
        are very certain you know what you are doing.</b>
      </dd>
J
Add virtio-related options to interfaces  
Ján Tomko 已提交
5504 5505 5506 5507 5508 5509 
      <dt>virtio options</dt>
      <dd>
        For virtio interfaces,
        <a href="#elementsVirtio">Virtio-specific options</a> can also be
        set. (<span class="since">Since 3.5.0</span>)
      </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
5510 5511 5512 5513 5514 5515 5516 
    </dl>
    <p>
      Offloading options for the host and guest can be configured using
      the following sub-elements:
    </p>
    <dl>
      <dt><code>host</code></dt>
J
conf: add options for disabling segment offloading  
Ján Tomko 已提交
5517 5518 5519 5520 5521 5522 5523 
      <dd>
        The <code>csum</code>, <code>gso</code>, <code>tso4</code>,
        <code>tso6</code>, <code>ecn</code> and <code>ufo</code>
        attributes with possible values <code>on</code>
        and <code>off</code> can be used to turn off host offloading options.
        By default, the supported offloads are enabled by QEMU.
        <span class="since">Since 1.2.9 (QEMU only)</span>
J
Add mrg_rxbuf option to virtio interfaces  
Ján Tomko 已提交
5524 5525 5526 5527 
        The <code>mrg_rxbuf</code> attribute can be used to control
        mergeable rx buffers on the host side. Possible values are
        <code>on</code> (default) and <code>off</code>.
        <span class="since">Since 1.2.13 (QEMU only)</span>
J
conf: add options for disabling segment offloading  
Ján Tomko 已提交
5528 
      </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
5529 
      <dt><code>guest</code></dt>
J
conf: add options for disabling segment offloading  
Ján Tomko 已提交
5530 5531 5532 5533 5534 5535 5536 5537 
      <dd>
        The <code>csum</code>, <code>tso4</code>,
        <code>tso6</code>, <code>ecn</code> and <code>ufo</code>
        attributes with possible values <code>on</code>
        and <code>off</code> can be used to turn off guest offloading options.
        By default, the supported offloads are enabled by QEMU.
        <span class="since">Since 1.2.9 (QEMU only)</span>
      </dd>
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
5538 5539 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5540 
    <h5><a id="elementsBackendOptions">Setting network backend-specific options</a></h5>
J
conf: add backend element to interfaces  
Ján Tomko 已提交
5541 5542 

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5543 5544 5545 5546 5547 5548 5549 5550 
...
&lt;devices&gt;
  &lt;interface type='network'&gt;
    &lt;source network='default'/&gt;
    &lt;target dev='vnet1'/&gt;
    &lt;model type='virtio'/&gt;
    <b>&lt;backend tap='/dev/net/tun' vhost='/dev/vhost-net'/&gt;</b>
    &lt;driver name='vhost' txmode='iothread' ioeventfd='on' event_idx='off' queues='5'/&gt;
M
docs: Document <sndbuf/>  
Michal Privoznik 已提交
5551 5552 5553 
    <b>&lt;tune&gt;
      &lt;sndbuf&gt;1600&lt;/sndbuf&gt;
    &lt;/tune&gt;</b>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5554 5555 5556 
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>
J
conf: add backend element to interfaces  
Ján Tomko 已提交
5557 5558 5559 

    <p>
      For tuning the backend of the network, the <code>backend</code> element
J
Only parse custom vhost path for virtio interfaces  
Ján Tomko 已提交
5560 5561 
      can be used. The <code>vhost</code> attribute can override the default vhost
      device path (<code>/dev/vhost-net</code>) for devices with <code>virtio</code> model.
J
Error out when custom tap device path makes no sense  
Ján Tomko 已提交
5562 5563 
      The <code>tap</code> attribute overrides the tun/tap device path (default:
      <code>/dev/net/tun</code>) for network and bridge interfaces. This does not work
M
docs: Document <sndbuf/>  
Michal Privoznik 已提交
5564 5565 5566 5567 5568 5569 
      in session mode. <span class="since">Since 1.2.9</span>
    </p>
    <p>
      For tap devices there is also <code>sndbuf</code> element which can
      adjust the size of send buffer in the host. <span class="since">Since
      0.8.8</span>
J
conf: add backend element to interfaces  
Ján Tomko 已提交
5570 
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5571 
    <h5><a id="elementsNICSTargetOverride">Overriding the target element</a></h5>
C
Document overriding domain interface target  
Cole Robinson 已提交
5572
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5573 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5574 5575 5576 5577 5578 5579 5580 5581 
...
&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>
C
Document overriding domain interface target  
Cole Robinson 已提交
5582 5583 

    <p>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
5584 5585 
      If no target is specified, certain hypervisors will
      automatically generate a name for the created tun device. This
J
docs: Clarify interface/target/@dev docs  
Jiri Denemark 已提交
5586 
      name can be manually specified, however the name <i>should not
L
conf: don't ignore <target dev='blah'/> for macvtap interfaces  
Laine Stump 已提交
5587 5588 5589 
      start with either 'vnet', 'vif', 'macvtap', or 'macvlan'</i>,
      which are prefixes reserved by libvirt and certain hypervisors.
      Manually specified targets using these prefixes may be ignored.
C
Document overriding domain interface target  
Cole Robinson 已提交
5590 5591 
    </p>
C
lxc network configuration allows setting target container NIC name  
Cédric Bosdonnat 已提交
5592 5593 5594 5595 5596 5597 5598 5599 
    <p>
      Note that for LXC containers, this defines the name of the interface
      on the host side. <span class="since">Since 1.2.7</span>, to define
      the name of the device on the guest side, the <code>guest</code>
      element should be used, as in the following snippet:
    </p>

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5600 5601 5602 5603 5604 5605 5606 5607 
...
&lt;devices&gt;
  &lt;interface type='network'&gt;
    &lt;source network='default'/&gt;
    <b>&lt;guest dev='myeth'/&gt;</b>
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>
C
lxc network configuration allows setting target container NIC name  
Cédric Bosdonnat 已提交
5608
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5609 
    <h5><a id="elementsNICSBoot">Specifying boot order</a></h5>
J
Introduce per-device boot element  
Jiri Denemark 已提交
5610 5611 

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5612 5613 5614 5615 5616 5617 5618 5619 5620 
...
&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>
J
Introduce per-device boot element  
Jiri Denemark 已提交
5621 5622 

    <p>
L
docs: fix a few small typos in formatdomain.html.in  
Laine Stump 已提交
5623 
      For hypervisors which support this, you can set a specific NIC to
J
Introduce per-device boot element  
Jiri Denemark 已提交
5624 5625 5626 5627 5628 5629 5630 5631 
      be used for network boot. The <code>order</code> attribute determines
      the order in which devices will be tried during boot sequence. The
      per-device <code>boot</code> elements cannot be used together with
      general boot elements in
      <a href="#elementsOSBIOS">BIOS bootloader</a> section.
      <span class="since">Since 0.8.8</span>
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5632 
    <h5><a id="elementsNICSROM">Interface ROM BIOS configuration</a></h5>
L
qemu: (and conf) support rombar for network devices  
Laine Stump 已提交
5633 5634 

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5635 5636 5637 5638 5639 5640 5641 5642 5643 
...
&lt;devices&gt;
  &lt;interface type='network'&gt;
    &lt;source network='default'/&gt;
    &lt;target dev='vnet1'/&gt;
    <b>&lt;rom bar='on' file='/etc/fake/boot.bin'/&gt;</b>
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>
L
qemu: (and conf) support rombar for network devices  
Laine Stump 已提交
5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 

    <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
L
qemu: add "romfile" support to specify device boot ROM  
Laine Stump 已提交
5654 5655 5656 5657 5658 5659 
      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>.
L
qemu: (and conf) support rombar for network devices  
Laine Stump 已提交
5660 
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5661 
    <h5><a id="elementDomain">Setting up a network backend in a driver domain</a></h5>
M
conf: support backend domain name in disk and network devices  
Marek Marczykowski 已提交
5662 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5663 5664 
...
&lt;devices&gt;
M
conf: support backend domain name in disk and network devices  
Marek Marczykowski 已提交
5665 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5666 5667 5668 5669 5670 5671 5672 
  &lt;interface type='bridge'&gt;
    &lt;source bridge='br0'/&gt;
    <b>&lt;backenddomain name='netvm'/&gt;</b>
  &lt;/interface&gt;
  ...
&lt;/devices&gt;
...</pre>
M
conf: support backend domain name in disk and network devices  
Marek Marczykowski 已提交
5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 

    <p>
      The optional <code>backenddomain</code> element allows specifying a
      backend domain (aka driver domain) for the interface. Use the
      <code>name</code> attribute to specify the backend domain name. You
      can use it to create a direct network link between domains (so data
      will not go through host system). Use with type 'ethernet' to create
      plain network link, or with type 'bridge' to connect to a bridge inside
      the backend domain.
      <span class="since">Since 1.2.13 (Xen only)</span>
    </p>
L
qemu: (and conf) support rombar for network devices  
Laine Stump 已提交
5684
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5685 
    <h5><a id="elementQoS">Quality of service</a></h5>
M
bandwidth: Define schema and create documentation  
Michal Privoznik 已提交
5686 5687 

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 
...
&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' floor='200' burst='1024'/&gt;
      &lt;outbound average='128' peak='256' burst='256'/&gt;
    &lt;/bandwidth&gt;</b>
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>
M
bandwidth: Define schema and create documentation  
Michal Privoznik 已提交
5700 5701 5702 

    <p>
      This part of interface XML provides setting quality of service. Incoming
J
bandwidth: Adjust documentation  
John Ferlan 已提交
5703 5704 5705 5706 
      and outgoing traffic can be shaped independently.
      The <code>bandwidth</code> element and its child elements are described
      in the <a href="formatnetwork.html#elementQoS">QoS</a> section of
      the Network XML.
M
bandwidth: Define schema and create documentation  
Michal Privoznik 已提交
5707 5708 
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5709 
    <h5><a id="elementVlanTag">Setting VLAN tag (on supported network types only)</a></h5>
L
conf: add <vlan> element to network and domain interface elements  
Laine Stump 已提交
5710 5711 

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 
...
&lt;devices&gt;
  &lt;interface type='bridge'&gt;
    <b>&lt;vlan&gt;</b>
      <b>&lt;tag id='42'/&gt;</b>
    <b>&lt;/vlan&gt;</b>
    &lt;source bridge='ovsbr0'/&gt;
    &lt;virtualport type='openvswitch'&gt;
      &lt;parameters interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f'/&gt;
    &lt;/virtualport&gt;
  &lt;/interface&gt;
  &lt;interface type='bridge'&gt;
    <b>&lt;vlan trunk='yes'&gt;</b>
      <b>&lt;tag id='42'/&gt;</b>
      <b>&lt;tag id='123' nativeMode='untagged'/&gt;</b>
    <b>&lt;/vlan&gt;</b>
    ...
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>
L
conf: add <vlan> element to network and domain interface elements  
Laine Stump 已提交
5732 5733 5734 

    <p>
      If (and only if) the network connection used by the guest
L
util: set vlan tag for macvtap passthrough mode on SRIOV VFs  
Laine Stump 已提交
5735 
      supports VLAN tagging transparent to the guest, an
L
conf: add <vlan> element to network and domain interface elements  
Laine Stump 已提交
5736 
      optional <code>&lt;vlan&gt;</code> element can specify one or
L
util: set vlan tag for macvtap passthrough mode on SRIOV VFs  
Laine Stump 已提交
5737 5738 5739 5740 5741 5742 5743 5744 5745 
      more VLAN tags to apply to the guest's network
      traffic <span class="since">Since 0.10.0</span>. Network
      connections that support guest-transparent VLAN tagging include
      1) type='bridge' interfaces connected to an Open vSwitch bridge
      <span class="since">Since 0.10.0</span>, 2) SRIOV Virtual
      Functions (VF) used via type='hostdev' (direct device
      assignment) <span class="since">Since 0.10.0</span>, and 3)
      SRIOV VFs used via type='direct' with mode='passthrough'
      (macvtap "passthru" mode) <span class="since">Since
L
docs: fix version number in vlan tagging documentation  
Laine Stump 已提交
5746 
      1.3.5</span>. All other connection types, including standard
L
conf: add <vlan> element to network and domain interface elements  
Laine Stump 已提交
5747 5748 5749 
      linux bridges and libvirt's own virtual networks, <b>do not</b>
      support it. 802.1Qbh (vn-link) and 802.1Qbg (VEPA) switches
      provide their own way (outside of libvirt) to tag guest traffic
L
util: set vlan tag for macvtap passthrough mode on SRIOV VFs  
Laine Stump 已提交
5750 5751 5752 5753 5754 5755 5756 5757 5758 
      onto a specific VLAN. Each tag is given in a
      separate <code>&lt;tag&gt;</code> subelement
      of <code>&lt;vlan&gt;</code> (for example: <code>&lt;tag
      id='42'/&gt;</code>). For VLAN trunking of multiple tags (which
      is supported only on Open vSwitch connections),
      multiple <code>&lt;tag&gt;</code> subelements can be specified,
      which implies that the user wants to do VLAN trunking on the
      interface for all the specified tags. In the case that VLAN
      trunking of a single tag is desired, the optional
L
conf: add <vlan> element to network and domain interface elements  
Laine Stump 已提交
5759 
      attribute <code>trunk='yes'</code> can be added to the toplevel
L
util: set vlan tag for macvtap passthrough mode on SRIOV VFs  
Laine Stump 已提交
5760 5761 
      <code>&lt;vlan&gt;</code> element to differentiate trunking of a
      single tag from normal tagging.
L
conf: add <vlan> element to network and domain interface elements  
Laine Stump 已提交
5762 
    </p>
J
Configure native vlan modes on Open vSwitch ports  
james robson 已提交
5763 
    <p>
L
util: set vlan tag for macvtap passthrough mode on SRIOV VFs  
Laine Stump 已提交
5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 
      For network connections using Open vSwitch it is also possible
      to configure 'native-tagged' and 'native-untagged' VLAN modes
      <span class="since">Since 1.1.0.</span> This is done with the
      optional <code>nativeMode</code> attribute on
      the <code>&lt;tag&gt;</code> subelement: <code>nativeMode</code>
      may be set to 'tagged' or 'untagged'. The <code>id</code>
      attribute of the <code>&lt;tag&gt;</code> subelement
      containing <code>nativeMode</code> sets which VLAN is considered
      to be the "native" VLAN for this interface, and
      the <code>nativeMode</code> attribute determines whether or not
      traffic for that VLAN will be tagged.
J
Configure native vlan modes on Open vSwitch ports  
james robson 已提交
5775 5776 
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5777 
    <h5><a id="elementLink">Modifying virtual link state</a></h5>
P
link-state: conf: Add element to XML for controling link state  
Peter Krempa 已提交
5778 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5779 5780 5781 5782 5783 5784 5785 5786 5787 
...
&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
link-state: conf: Add element to XML for controling link state  
Peter Krempa 已提交
5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 

    <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
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5798 
    <h5><a id="mtu">MTU configuration</a></h5>
M
domain_conf: Introduce <mtu/> to <interface/>  
Michal Privoznik 已提交
5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 
<pre>
...
&lt;devices&gt;
  &lt;interface type='network'&gt;
    &lt;source network='default'/&gt;
    &lt;target dev='vnet0'/&gt;
    <b>&lt;mtu size='1500'/&gt;</b>
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>

    <p>
      This element provides means of setting MTU of the virtual network link.
      Currently there is just one attribute <code>size</code> which accepts a
      non-negative integer which specifies the MTU size for the interface.
      <span class="since">Since 3.1.0</span>
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5817 
    <h5><a id="coalesce">Coalesce settings</a></h5>
M
conf, docs: Add support for coalesce setting(s)  
Martin Kletzander 已提交
5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 
<pre>
...
&lt;devices&gt;
  &lt;interface type='network'&gt;
    &lt;source network='default'/&gt;
    &lt;target dev='vnet0'/&gt;
    <b>&lt;coalesce&gt;
      &lt;rx&gt;
        &lt;frames max='7'/&gt;
      &lt;/rx&gt;
    &lt;/coalesce&gt;</b>
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>

    <p>
      This element provides means of setting coalesce settings for
      some interface devices (currently only type <code>network</code>
      and <code>bridge</code>.  Currently there is just one attribute,
D
docs: fix typo in closing HTML element  
Daniel P. Berrange 已提交
5837 
      <code>max</code>, to tweak, in element <code>frames</code> for
M
conf, docs: Add support for coalesce setting(s)  
Martin Kletzander 已提交
5838 5839 5840 5841 5842 5843 
      the <code>rx</code> group, which accepts a non-negative integer
      that specifies the maximum number of packets that will be
      received before an interrupt.
      <span class="since">Since 3.3.0</span>
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5844 
    <h5><a id="ipconfig">IP configuration</a></h5>
C
Domain conf: allow more than one IP address for net devices  
Cédric Bosdonnat 已提交
5845 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 
...
&lt;devices&gt;
  &lt;interface type='network'&gt;
    &lt;source network='default'/&gt;
    &lt;target dev='vnet0'/&gt;
    <b>&lt;ip address='192.168.122.5' prefix='24'/&gt;</b>
    <b>&lt;ip address='192.168.122.5' prefix='24' peer='10.0.0.10'/&gt;</b>
    <b>&lt;route family='ipv4' address='192.168.122.0' prefix='24' gateway='192.168.122.1'/&gt;</b>
    <b>&lt;route family='ipv4' address='192.168.122.8' gateway='192.168.122.1'/&gt;</b>
  &lt;/interface&gt;
C
Domain conf: allow more than one IP address for net devices  
Cédric Bosdonnat 已提交
5856 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 
  &lt;hostdev mode='capabilities' type='net'&gt;
    &lt;source&gt;
      &lt;interface&gt;eth0&lt;/interface&gt;
    &lt;/source&gt;
    <b>&lt;ip address='192.168.122.6' prefix='24'/&gt;</b>
    <b>&lt;route family='ipv4' address='192.168.122.0' prefix='24' gateway='192.168.122.1'/&gt;</b>
    <b>&lt;route family='ipv4' address='192.168.122.8' gateway='192.168.122.1'/&gt;</b>
  &lt;/hostdev&gt;

&lt;/devices&gt;
...
C
Domain conf: allow more than one IP address for net devices  
Cédric Bosdonnat 已提交
5868 5869 5870 
</pre>

    <p>
V
conf: allow setting peer address in <ip> element of <interface>  
Vasiliy Tolstov 已提交
5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 
      <span class="since">Since 1.2.12</span> network devices and
      hostdev devices with network capabilities can optionally be provided
      one or more IP addresses to set on the network device in the
      guest. Note that some hypervisors or network device types will
      simply ignore them or only use the first one.
      The <code>family</code> attribute can be set to
      either <code>ipv4</code> or <code>ipv6</code>, and the
      <code>address</code> attribute contains the IP address. The
      optional <code>prefix</code> is the number of 1 bits in the
      netmask, and will be automatically set if not specified - for
      IPv4 the default prefix is determined according to the network
      "class" (A, B, or C - see RFC870), and for IPv6 the default
      prefix is 64. The optional <code>peer</code> attribute holds the
      IP address of the other end of a point-to-point network
      device <span class="since">(since 2.1.0)</span>.
C
Domain conf: allow more than one IP address for net devices  
Cédric Bosdonnat 已提交
5886 5887 
    </p>
C
Domain network devices can now have a <route> element  
Cédric Bosdonnat 已提交
5888 
    <p>
V
conf: allow setting peer address in <ip> element of <interface>  
Vasiliy Tolstov 已提交
5889 5890 5891 5892 5893 5894 
    <span class="since">Since 1.2.12</span> route elements can also be
    added to define IP routes to add in the guest.  The attributes of
    this element are described in the documentation for
    the <code>route</code> element
    in <a href="formatnetwork.html#elementsStaticroute">network
    definitions</a>.  This is used by the LXC driver.
C
Domain network devices can now have a <route> element  
Cédric Bosdonnat 已提交
5895 5896 
    </p>
L
conf: support host-side IP/route information in <interface>  
Laine Stump 已提交
5897 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5898 5899 5900 5901 5902 5903 5904 5905 
...
&lt;devices&gt;
  &lt;interface type='ethernet'&gt;
    <b>&lt;source/&gt;</b>
      <b>&lt;ip address='192.168.123.1' prefix='24'/&gt;</b>
      <b>&lt;ip address='10.0.0.10' prefix='24' peer='192.168.122.5'/&gt;</b>
      <b>&lt;route family='ipv4' address='192.168.42.0' prefix='24' gateway='192.168.123.4'/&gt;</b>
    <b>&lt;source/&gt;</b>
L
conf: support host-side IP/route information in <interface>  
Laine Stump 已提交
5906 
    ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5907 
  &lt;/interface&gt;
L
conf: support host-side IP/route information in <interface>  
Laine Stump 已提交
5908 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5909 5910 
&lt;/devices&gt;
...
L
conf: support host-side IP/route information in <interface>  
Laine Stump 已提交
5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 
</pre>

    <p>
      <span class="since">Since 2.1.0</span> network devices of type
      "ethernet" can optionally be provided one or more IP addresses
      and one or more routes to set on the <b>host</b> side of the
      network device. These are configured as subelements of
      the <code>&lt;source&gt;</code> element of the interface, and
      have the same attributes as the similarly named elements used to
      configure the guest side of the interface (described above).
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5923 
    <h5><a id="elementVhostuser">vhost-user interface</a></h5>
M
support for QEMU vhost-user  
Michele Paolino 已提交
5924 5925 5926 5927 5928 5929 5930 5931 5932 

    <p>
    <span class="since">Since 1.2.7</span> the vhost-user enables the
    communication between a QEMU virtual machine and other userspace process
    using the Virtio transport protocol.  A char dev (e.g. Unix socket) is used
    for the control plane, while the data plane is based on shared memory.
    </p>

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5933 5934 5935 5936 5937 5938 5939 5940 5941 
...
&lt;devices&gt;
  &lt;interface type='vhostuser'&gt;
    &lt;mac address='52:54:00:3b:83:1a'/&gt;
    &lt;source type='unix' path='/tmp/vhost1.sock' mode='server'/&gt;
    &lt;model type='virtio'/&gt;
  &lt;/interface&gt;
  &lt;interface type='vhostuser'&gt;
    &lt;mac address='52:54:00:3b:83:1b'/&gt;
Z
vhost-user: add support reconnect for vhost-user ports  
ZhiPeng Lu 已提交
5942 5943 5944 
    &lt;source type='unix' path='/tmp/vhost2.sock' mode='client'&gt;
      &lt;reconnect enabled='yes' timeout='10'/&gt;
    &lt;/source&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5945 5946 5947 5948 5949 
    &lt;model type='virtio'/&gt;
    &lt;driver queues='5'/&gt;
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>
M
support for QEMU vhost-user  
Michele Paolino 已提交
5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 

    <p>
      The <code>&lt;source&gt;</code> element has to be specified
      along with the type of char device.
      Currently, only type='unix' is supported, where the path (the
      directory path of the socket) and mode attributes are required.
      Both <code>mode='server'</code> and <code>mode='client'</code>
      are supported.
      vhost-user requires the virtio model type, thus the
      <code>&lt;model&gt;</code> element is mandatory.
Z
vhost-user: add support reconnect for vhost-user ports  
ZhiPeng Lu 已提交
5960 5961 5962 5963 5964 5965 5966 
      <span class="since">Since 4.1.0</span> the element has an
      optional child element <code>reconnect</code> which
      configures reconnect timeout if the connection is lost. It
      has two attributes <code>enabled</code> (which accepts
      <code>yes</code> and <code>no</code>) and
      <code>timeout</code> which specifies the amount of seconds
      after which hypervisor tries to reconnect.
M
support for QEMU vhost-user  
Michele Paolino 已提交
5967 5968 
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
5969 
    <h5><a id="elementNwfilter">Traffic filtering with NWFilter</a></h5>
C
docs: domain: Document network <filterref>  
Cole Robinson 已提交
5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 

    <p>
    <span class="since">Since 0.8.0</span> an <code>nwfilter</code> profile
    can be assigned to a domain interface, which allows configuring
    traffic filter rules for the virtual machine.

    See the <a href="formatnwfilter.html">nwfilter</a> documentation for more
    complete details.
    </p>

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 
...
&lt;devices&gt;
  &lt;interface ...&gt;
    ...
    &lt;filterref filter='clean-traffic'/&gt;
  &lt;/interface&gt;
  &lt;interface ...&gt;
    ...
    &lt;filterref filter='myfilter'&gt;
      &lt;parameter name='IP' value='104.207.129.11'/&gt;
      &lt;parameter name='IP6_ADDR' value='2001:19f0:300:2102::'/&gt;
      &lt;parameter name='IP6_MASK' value='64'/&gt;
C
docs: domain: Document network <filterref>  
Cole Robinson 已提交
5993 
      ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
5994 5995 5996 5997 
    &lt;/filterref&gt;
  &lt;/interface&gt;
&lt;/devices&gt;
...</pre>
C
docs: domain: Document network <filterref>  
Cole Robinson 已提交
5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 

    <p>
      The <code>filter</code> attribute specifies the name of the nwfilter
      to use. Optional <code>&lt;parameter&gt;</code> elements may be
      specified for passing additional info to the nwfilter via the
      <code>name</code> and <code>value</code> attributes. See
      the <a href="formatnwfilter.html#nwfconceptsvars">nwfilter</a>
      docs for info on parameters.
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
6009 
    <h4><a id="elementsInput">Input devices</a></h4>
D
Update domain XML docs  
Daniel P. Berrange 已提交
6010 6011 

    <p>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
6012 6013 6014 6015 
      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
Update domain XML docs  
Daniel P. Berrange 已提交
6016 6017 6018 
      to provide a graphics tablet for absolute cursor movement.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
6019 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 
...
&lt;devices&gt;
  &lt;input type='mouse' bus='usb'/&gt;
  &lt;input type='keyboard' bus='usb'/&gt;
  &lt;input type='mouse' bus='virtio'/&gt;
  &lt;input type='keyboard' bus='virtio'/&gt;
  &lt;input type='tablet' bus='virtio'/&gt;
  &lt;input type='passthrough' bus='virtio'&gt;
    &lt;source evdev='/dev/input/event1/&gt;
  &lt;/input&gt;
&lt;/devices&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
6032 6033 6034 

    <dl>
      <dt><code>input</code></dt>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
6035 
      <dd>The <code>input</code> element has one mandatory attribute,
J
conf: add XML for input device passthrough  
Ján Tomko 已提交
6036 6037 6038 
        the <code>type</code> whose value can be 'mouse', 'tablet',
        (<span class="since">since 1.2.2</span>) 'keyboard' or
        (<span class="since">since 1.3.0</span>) 'passthrough'.
J
Document the keyboard as a valid input type  
Ján Tomko 已提交
6039 6040 
        The tablet provides absolute cursor movement,
        while the mouse uses relative movement. The optional
M
Cleanup whitespace in docs  
Matthew Booth 已提交
6041 
        <code>bus</code> attribute can be used to refine the exact device type.
J
conf: parse and format virtio input bus in domain XML  
Ján Tomko 已提交
6042 6043 
        It takes values "xen" (paravirtualized), "ps2" and "usb" or
        (<span class="since">since 1.3.0</span>) "virtio".</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
6044 6045 
    </dl>
E
docs: document <controller> element  
Eric Blake 已提交
6046 6047 6048 
    <p>
      The <code>input</code> element has an optional
      sub-element <code>&lt;address&gt;</code> which can tie the
E
docs: document <address> elements in one place  
Eric Blake 已提交
6049 6050 
      device to a particular PCI
      slot, <a href="#elementsAddress">documented above</a>.
F
qemu: Add support for virtio input ccw devices  
Farhan Ali 已提交
6051 6052 
      On S390, <code>address</code> can be used to provide a CCW address for
      an input device (<span class="since">since 4.2.0</span>).
J
conf: add XML for input device passthrough  
Ján Tomko 已提交
6053 6054 6055 6056 

      For type <code>passthrough</code>, the mandatory sub-element <code>source</code>
      must have an <code>evdev</code> attribute containing the absolute path to the
      event device passed through to guests. (KVM only)
E
docs: document <controller> element  
Eric Blake 已提交
6057 
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
6058
J
Add virtio-related options to input devices  
Ján Tomko 已提交
6059 6060 6061 6062 6063 6064 6065 
    <p>
        The subelement <code>driver</code> can be used to tune the virtio
        options of the device:
        <a href="#elementsVirtio">Virtio-specific options</a> can also be
        set. (<span class="since">Since 3.5.0</span>)
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
6066 
    <h4><a id="elementsHub">Hub devices</a></h4>
M
Add USB hub device  
Marc-André Lureau 已提交
6067 6068 6069 6070 6071 6072 6073 6074 

    <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>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6075 6076 6077 6078 6079 
...
&lt;devices&gt;
  &lt;hub type='usb'/&gt;
&lt;/devices&gt;
...</pre>
M
Add USB hub device  
Marc-André Lureau 已提交
6080 6081 6082 6083 6084 6085 6086 6087 6088 

    <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
E
docs: document <address> elements in one place  
Eric Blake 已提交
6089 6090 6091 6092 
      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
Add USB hub device  
Marc-André Lureau 已提交
6093 6094 
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
6095 
    <h4><a id="elementsGraphics">Graphical framebuffers</a></h4>
D
Update domain XML docs  
Daniel P. Berrange 已提交
6096 6097 6098 6099 6100 6101 6102 6103 

    <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>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
6104 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 
...
&lt;devices&gt;
  &lt;graphics type='sdl' display=':0.0'/&gt;
  &lt;graphics type='vnc' port='5904' sharePolicy='allow-exclusive'&gt;
    &lt;listen type='address' address='1.2.3.4'/&gt;
  &lt;/graphics&gt;
  &lt;graphics type='rdp' autoport='yes' multiUser='yes' /&gt;
  &lt;graphics type='desktop' fullscreen='yes'/&gt;
  &lt;graphics type='spice'&gt;
    &lt;listen type='network' network='rednet'/&gt;
  &lt;/graphics&gt;
&lt;/devices&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
6118 6119 6120 

    <dl>
      <dt><code>graphics</code></dt>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6121 6122 6123 6124 6125 6126 
      <dd>
        <p>
          The <code>graphics</code> element has a mandatory <code>type</code>
          attribute which takes the value <code>sdl</code>, <code>vnc</code>,
          <code>spice</code>, <code>rdp</code> or <code>desktop</code>:
        </p>
F
add doc for graphic and video elements  
Florian Vichot 已提交
6127 
        <dl>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
6128 
          <dt><code>sdl</code></dt>
F
add doc for graphic and video elements  
Florian Vichot 已提交
6129 
          <dd>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6130 6131 6132 6133 6134 6135 6136 
            <p>
              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
              <code>yes</code> or <code>no</code>.
            </p>
F
add doc for graphic and video elements  
Florian Vichot 已提交
6137 
          </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
6138 
          <dt><code>vnc</code></dt>
F
add doc for graphic and video elements  
Florian Vichot 已提交
6139 
          <dd>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6140 6141 6142 6143 6144 
            <p>
              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 auto-allocation of the TCP
P
graphics: make address attribute for listen type='address' optional  
Pavel Hrdina 已提交
6145 
              port to use. The <code>passwd</code> attribute provides a VNC
P
doc: improve VNC/SPICE password documentation  
Pavel Hrdina 已提交
6146 6147 6148 6149 6150 6151 6152 
              password in clear text. If the <code>passwd</code> attribute is
              set to an empty string, then VNC access is disabled. The
              <code>keymap</code> attribute specifies the keymap to use. It is
              possible to set a limit on the validity of the password by giving
              an timestamp <code>passwdValidTo='2010-04-09T15:51:00'</code>
              assumed to be in UTC. The <code>connected</code> attribute allows
              control of connected client during password changes. VNC accepts
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 
              <code>keep</code> value only <span class="since">since 0.9.3</span>.
              NB, this may not be supported by all hypervisors.
            </p>
            <p>
              The optional <code>sharePolicy</code> attribute specifies vnc
              server display sharing policy. <code>allow-exclusive</code> allows
              clients to ask for exclusive access by dropping other connections.
              Connecting multiple clients in parallel requires all clients asking
              for a shared session (vncviewer: -Shared switch). This is
              the default value. <code>force-shared</code> disables exclusive
              client access, every connection has to specify -Shared switch for
              vncviewer. <code>ignore</code> welcomes every connection
              unconditionally <span class="since">since 1.0.6</span>.
            </p>
            <p>
              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>.
            </p>
            <p>
              For VNC WebSocket functionality, <code>websocket</code> attribute
              may be used to specify port to listen on (with -1 meaning
              auto-allocation and <code>autoport</code> having no effect due to
              security reasons) <span class="since">Since 1.0.6</span>.
            </p>
D
Add a <graphics> type for SPICE protocol  
Daniel P. Berrange 已提交
6178 
          </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
6179 
          <dt><code>spice</code> <span class="since">Since 0.8.6</span></dt>
D
Add a <graphics> type for SPICE protocol  
Daniel P. Berrange 已提交
6180 
          <dd>
E
maint: whitespace cleanup  
Eric Blake 已提交
6181 
            <p>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6182 6183 6184 6185 6186 
              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
P
graphics: make address attribute for listen type='address' optional  
Pavel Hrdina 已提交
6187 
              auto-allocation of needed port numbers. The <code>passwd</code>
P
doc: improve VNC/SPICE password documentation  
Pavel Hrdina 已提交
6188 6189 6190 6191 6192 6193 6194 
              attribute provides a SPICE password in clear text. If the
              <code>passwd</code> attribute is set to an empty string, then
              SPICE access is disabled. The <code>keymap</code> attribute
              specifies the keymap to use. It is possible to set a limit on
              the validity of the password by giving an timestamp
              <code>passwdValidTo='2010-04-09T15:51:00'</code> assumed to be
              in UTC.
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6195 6196 6197 6198 6199 6200 6201 
            </p>
            <p>
              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 . NB, this may not
              be supported by all hypervisors.
M
graphics: add support for action_if_connected in qemu  
Michal Privoznik 已提交
6202 
              <span class="since">Since 0.9.3</span>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6203 6204 
            </p>
            <p>
A
domain_conf: add "default" to list of valid spice channels  
Alon Levy 已提交
6205 6206 
              The <code>defaultMode</code> attribute sets the default channel
              security policy, valid values are <code>secure</code>,
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6207 6208 6209 6210 
              <code>insecure</code> and the default <code>any</code> (which is
              secure if possible, but falls back to insecure rather than erroring
              out if no secure path is available).
              <span class="since">Since 0.9.12</span>
E
maint: whitespace cleanup  
Eric Blake 已提交
6211 6212 
            </p>
            <p>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6213 6214 6215 6216 6217 6218 6219 6220 
              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 <code>&lt;channel&gt;
              </code> elements inside the main <code>&lt;graphics&gt;</code>
              element and setting the <code>mode</code> attribute to either
              <code>secure</code> or <code>insecure</code>. Setting the mode
              attribute overrides the default value as set by
              the <code>defaultMode</code> attribute. (Note that specifying
P
doc: Explicitly specify how to override spice channel mode  
Peter Krempa 已提交
6221 
              <code>any</code> as mode discards the entry as the channel would
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6222 6223 6224 
              inherit the default mode anyways.) Valid channel names include
              <code>main</code>, <code>display</code>, <code>inputs</code>,
              <code>cursor</code>, <code>playback</code>, <code>record</code>
A
domain_conf: add "usbredir" to list of valid spice channels  
Alon Levy 已提交
6225 
              (all <span class="since"> since 0.8.6</span>);
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6226 6227 
              <code>smartcard</code> (<span class="since">since 0.8.8</span>);
              and <code>usbredir</code> (<span class="since">since 0.9.12</span>).
E
maint: whitespace cleanup  
Eric Blake 已提交
6228 6229 
            </p>
            <pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6230 6231 6232 6233 6234 6235 6236 6237 
&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;
  &lt;image compression='auto_glz'/&gt;
  &lt;streaming mode='filter'/&gt;
  &lt;clipboard copypaste='no'/&gt;
  &lt;mouse mode='client'/&gt;
  &lt;filetransfer enable='no'/&gt;
M
qemu: add rendernode argument  
Marc-André Lureau 已提交
6238 
  &lt;gl enable='yes' rendernode='/dev/dri/by-path/pci-0000:00:02.0-render'/&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6239 
&lt;/graphics&gt;</pre>
M
Spice: support audio, images and stream compression  
Michal Privoznik 已提交
6240 
            <p>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 
              Spice supports variable compression settings for audio, images and
              streaming. 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>). <span class="since">Since 0.9.1</span>
M
Spice: support audio, images and stream compression  
Michal Privoznik 已提交
6253 
            </p>
A
spice: support streaming-video parameter  
Alon Levy 已提交
6254 
            <p>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6255 6256 6257 6258 
              Streaming mode is set by the <code>streaming</code> element,
              settings its <code>mode</code> attribute to one of
              <code>filter</code>, <code>all</code> or <code>off</code>.
              <span class="since">Since 0.9.2</span>
A
spice: support streaming-video parameter  
Alon Levy 已提交
6259 
            </p>
M
spice: add <clipboard copypaste='yes|no'> option  
Marc-André Lureau 已提交
6260 
            <p>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6261 6262 6263 6264 
              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>
M
docs: Fix spice documentation typo  
Michal Privoznik 已提交
6265 
            </p>
P
qemu: spice agent-mouse support  
Peng Zhou 已提交
6266 
            <p>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6267 6268 6269 6270 
              Mouse mode is set by the <code>mouse</code> element, setting its
              <code>mode</code> attribute to one of <code>server</code> or
              <code>client</code>. If no mode is specified, the qemu default will
              be used (client mode). <span class="since">Since 0.9.11</span>
P
qemu: spice agent-mouse support  
Peng Zhou 已提交
6271 
            </p>
F
spice: expose the QEMU disable file transfer option  
Francesco Romani 已提交
6272 6273 
            <p>
              File transfer functionality (via Spice agent) is set using the
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6274 6275 6276 
              <code>filetransfer</code> element. It is enabled by default, and
              can be disabled by setting the <code>enable</code> property to
              <code>no</code>. <span class="since">Since 1.2.2</span>
F
spice: expose the QEMU disable file transfer option  
Francesco Romani 已提交
6277 
            </p>
M
qemu: add spice opengl support  
Marc-André Lureau 已提交
6278 
            <p>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6279 6280 6281 
              Spice may provide accelerated server-side rendering with OpenGL.
              You can enable or disable OpenGL support explicitly with
              the <code>gl</code> element, by setting the <code>enable</code>
J
docs: fix <spice><gl enable> since version  
Ján Tomko 已提交
6282 
              property. (QEMU only, <span class="since">since 1.3.3</span>).
M
qemu: add spice opengl support  
Marc-André Lureau 已提交
6283 
            </p>
M
qemu: add rendernode argument  
Marc-André Lureau 已提交
6284 6285 6286 6287 6288 
            <p>
              By default, QEMU will pick the first available GPU DRM render node.
              You may specify a DRM render node path to use instead. (QEMU only,
              <span class="since">since 3.1.0</span>).
            </p>
F
add doc for graphic and video elements  
Florian Vichot 已提交
6289 
          </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
6290 
          <dt><code>rdp</code></dt>
F
add doc for graphic and video elements  
Florian Vichot 已提交
6291 
          <dd>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6292 6293 6294 6295 6296 
            <p>
              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 auto-allocation of the TCP port to
D
docs: Document autoport behavior in the vbox driver  
Dawid Zamirski 已提交
6297 6298 6299 6300 
              use. In the VirtualBox driver, the <code>autoport</code> will make
              the hypervisor pick available port from 3389-3689 range when the VM
              is started. The chosen port will be reflected in the <code>port</code>
              attribute. The <code>multiUser</code> attribute is a boolean deciding
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6301 
              whether multiple simultaneous connections to the VM are permitted.
D
docs: Fix multiUser/replaceUser in RDP display doc.  
Dawid Zamirski 已提交
6302 
              The <code>replaceUser</code> attribute is a boolean deciding whether
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6303 6304 6305 6306 
              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.
            </p>
F
add doc for graphic and video elements  
Florian Vichot 已提交
6307 
          </dd>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
6308 
          <dt><code>desktop</code></dt>
F
add doc for graphic and video elements  
Florian Vichot 已提交
6309 
          <dd>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6310 6311 6312 6313 6314 6315 6316 
            <p>
              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>.
            </p>
F
add doc for graphic and video elements  
Florian Vichot 已提交
6317 6318 6319 6320 6321 
          </dd>
        </dl>
      </dd>
    </dl>
L
conf: add <listen> subelement to domain <graphics> element  
Laine Stump 已提交
6322 
    <p>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6323 6324 6325 6326 6327 6328 
      Graphics device uses a <code>&lt;listen&gt;</code> to set up where
      the device should listen for clients. It has a mandatory attribute
      <code>type</code> which specifies the listen type. Only <code>vnc</code>,
      <code>spice</code> and <code>rdp</code> supports <code>&lt;listen&gt;
      </code> element. <span class="since">Since 0.9.4</span>.
      Available types are:
L
conf: add <listen> subelement to domain <graphics> element  
Laine Stump 已提交
6329 6330 6331 
    </p>
    <dl>
      <dt><code>address</code></dt>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6332 6333 6334 6335 6336 6337 6338 
      <dd>
        <p>
          Tells a graphics device to use an address specified in the
          <code>address</code> attribute, which will contain either an IP address
          or hostname (which will be resolved to an IP address via a DNS query)
          to listen on.
        </p>
P
graphics: make address attribute for listen type='address' optional  
Pavel Hrdina 已提交
6339 6340 6341 6342 6343 6344 6345 6346 6347 
        <p>
          It is possible to omit the <code>address</code> attribute in order to
          use an address from config files <span class="since">Since 1.3.5</span>.
        </p>
        <p>
          The <code>address</code> attribute is duplicated as <code>listen</code>
          attribute in <code>graphics</code> element for backward compatibility.
          If both are provided they must be equal.
        </p>
L
conf: add <listen> subelement to domain <graphics> element  
Laine Stump 已提交
6348 6349 
      </dd>
      <dt><code>network</code></dt>
P
docs: rewrite graphics XML documentation  
Pavel Hrdina 已提交
6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 
      <dd>
        <p>
          This is used to specify an existing network in the <code>network</code>
          attribute from libvirt's list of configured networks. The named network
          configuration will be examined to determine an appropriate listen
          address and the address will be stored in live XML in <code>address
          </code> attribute. 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.
        </p>
L
conf: add <listen> subelement to domain <graphics> element  
Laine Stump 已提交
6365 
      </dd>
M
Change 1.3.6 occurrences to 2.0.0 to follow version bump  
Martin Kletzander 已提交
6366 
      <dt><code>socket</code> <span class="since">since 2.0.0 (QEMU only)</span></dt>
P
graphics: introduce new listen type 'socket'  
Pavel Hrdina 已提交
6367 6368 6369 6370 6371 
      <dd>
        <p>
          This listen type tells a graphics server to listen on unix socket.
          Attribute <code>socket</code> contains a path to unix socket. If this
          attribute is omitted libvirt will generate this path for you.
P
spice: add support for listen type socket  
Pavel Hrdina 已提交
6372 
          Supported by graphics type <code>vnc</code> and <code>spice</code>.
P
vnc: add support for listen type 'socket'  
Pavel Hrdina 已提交
6373 6374 6375 6376 6377 6378 6379 
        </p>
        <p>
          For <code>vnc</code> graphics be backward compatible
          the <code>socket</code> attribute of first <code>listen</code> element
          is duplicated as <code>socket</code> attribute in <code>graphics</code>
          element. If <code>graphics</code> element contains a <code>socket</code>
          attribute all <code>listen</code> elements are ignored.
P
graphics: introduce new listen type 'socket'  
Pavel Hrdina 已提交
6380 6381 
        </p>
      </dd>
M
Change 1.3.6 occurrences to 2.0.0 to follow version bump  
Martin Kletzander 已提交
6382 
      <dt><code>none</code> <span class="since">since 2.0.0 (QEMU only)</span></dt>
P
spice: introduce listen type none  
Pavel Hrdina 已提交
6383 6384 6385 6386 6387 6388 6389 
      <dd>
        <p>
          This listen type doesn't have any other attribute. Libvirt supports
          passing a file descriptor through our APIs virDomainOpenGraphics() and
          virDomainOpenGraphicsFD(). No other listen types are allowed if this
          one is used and the graphics device doesn't listen anywhere. You need
          to use one of the two APIs to pass a FD to QEMU in order to connect to
P
vnc: add support for listen type none  
Pavel Hrdina 已提交
6390 6391 
          this graphics device. Supported by graphics type <code>vnc</code> and
          <code>spice</code>.
P
spice: introduce listen type none  
Pavel Hrdina 已提交
6392 6393 
        </p>
      </dd>
L
conf: add <listen> subelement to domain <graphics> element  
Laine Stump 已提交
6394 6395 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
6396 
    <h4><a id="elementsVideo">Video devices</a></h4>
F
add doc for graphic and video elements  
Florian Vichot 已提交
6397 6398 6399 6400 
    <p>
      A video device.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
6401 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6402 6403 6404 6405 6406 6407 6408 6409 6410 
...
&lt;devices&gt;
  &lt;video&gt;
    &lt;model type='vga' vram='16384' heads='1'&gt;
      &lt;acceleration accel3d='yes' accel2d='yes'/&gt;
    &lt;/model&gt;
  &lt;/video&gt;
&lt;/devices&gt;
...</pre>
F
add doc for graphic and video elements  
Florian Vichot 已提交
6411 6412 6413 

    <dl>
      <dt><code>video</code></dt>
M
Fix and improve domain xml video element description  
Matthias Bolte 已提交
6414 
      <dd>
P
video: cleanup usage of vram attribute and update documentation  
Pavel Hrdina 已提交
6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 
        <p>
          The <code>video</code> element is the container for describing
          video devices. For backwards compatibility, if no <code>video</code>
          is set but there is a <code>graphics</code> in domain xml, then
          libvirt will add a default <code>video</code> according to the guest
          type.
        </p>
        <p>
          For a guest of type "kvm", the default <code>video</code> is:
          <code>type</code> with value "cirrus", <code>vram</code> with value
          "16384" and <code>heads</code> with value "1". By default, the first
          video device in domain xml is the primary one, but the optional
          attribute <code>primary</code> (<span class="since">since 1.0.2</span>)
          with value 'yes' can be used to mark the primary in cases of multiple
P
qemu_command: add support to use virtio as secondary video device  
Pavel Hrdina 已提交
6429 6430 
          video device. The non-primary must be type of "qxl" or
          (<span class="since">since 2.4.0</span>) "virtio".
P
video: cleanup usage of vram attribute and update documentation  
Pavel Hrdina 已提交
6431 
        </p>
M
Fix and improve domain xml video element description  
Matthias Bolte 已提交
6432 
      </dd>
F
add doc for graphic and video elements  
Florian Vichot 已提交
6433
M
Fix and improve domain xml video element description  
Matthias Bolte 已提交
6434 6435 
      <dt><code>model</code></dt>
      <dd>
P
video: cleanup usage of vram attribute and update documentation  
Pavel Hrdina 已提交
6436 6437 6438 
        <p>
          The <code>model</code> element has a mandatory <code>type</code>
          attribute which takes the value "vga", "cirrus", "vmvga", "xen",
F
bhyve: add video support  
Fabian Freyer 已提交
6439 
          "vbox", "qxl" (<span class="since">since 0.8.6</span>),
M
qemu: add virtio video device  
Marc-André Lureau 已提交
6440 
          "virtio" (<span class="since">since 1.3.0</span>)
F
bhyve: add video support  
Fabian Freyer 已提交
6441 
          or "gop" (<span class="since">since 3.2.0</span>)
M
qemu: add virtio video device  
Marc-André Lureau 已提交
6442 
          depending on the hypervisor features available.
P
video: cleanup usage of vram attribute and update documentation  
Pavel Hrdina 已提交
6443 6444 6445 6446 
        </p>
        <p>
          You can provide the amount of video memory in kibibytes (blocks of
          1024 bytes) using <code>vram</code>. This is supported only for guest
S
docs: Rename 'parallels' to 'vz'  
Sergey Bronnikov 已提交
6447 
          type of "libxl", "vz", "qemu", "vbox", "vmx" and "xen". If no
P
video: cleanup usage of vram attribute and update documentation  
Pavel Hrdina 已提交
6448 6449 6450 6451 6452 
          value is provided the default is used. If the size is not a power of
          two it will be rounded to closest one.
        </p>
        <p>
          The number of screen can be set using <code>heads</code>. This is
S
docs: Rename 'parallels' to 'vz'  
Sergey Bronnikov 已提交
6453 
          supported only for guests type of "vz", "kvm", "vbox" and "vmx".
P
video: cleanup usage of vram attribute and update documentation  
Pavel Hrdina 已提交
6454 6455 
        </p>
        <p>
P
docs/formatdomain: rewrite video documentation  
Pavel Hrdina 已提交
6456 6457 6458 
          For guest type of "kvm" or "qemu" and model type "qxl" there are
          optional attributes. Attribute <code>ram</code> (<span class="since">
          since 1.0.2</span>) specifies the size of the primary bar, while the
P
video: cleanup usage of vram attribute and update documentation  
Pavel Hrdina 已提交
6459 
          attribute <code>vram</code> specifies the secondary bar size.
P
docs/formatdomain: rewrite video documentation  
Pavel Hrdina 已提交
6460 6461 6462 6463 6464 
          If <code>ram</code> or <code>vram</code> are not supplied a default
          value is used. The <code>ram</code> should also be rounded to power of
          two as <code>vram</code>. There is also optional attribute
          <code>vgamem</code> (<span class="since">since 1.2.11</span>) to set
          the size of VGA framebuffer for fallback mode of QXL device.
P
docs: fix libvirt version for vram64 in formatdomain.html.in  
Pavel Hrdina 已提交
6465 
          Attribute <code>vram64</code> (<span class="since">since 1.3.3</span>)
P
qemu: introduce vram64 attribute for QXL video device  
Pavel Hrdina 已提交
6466 
          extends secondary bar and makes it addressable as 64bit memory.
P
video: cleanup usage of vram attribute and update documentation  
Pavel Hrdina 已提交
6467 
        </p>
M
Fix and improve domain xml video element description  
Matthias Bolte 已提交
6468 6469 6470 6471 
      </dd>

      <dt><code>acceleration</code></dt>
      <dd>
C
docs: formatdomain: document versions for video acceleration  
Cole Robinson 已提交
6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 
        Configure if video acceleration should be enabled.
        <dl>
        <dt><code>accel2d</code></dt>
        <dd>Enable 2D acceleration (for vbox driver only,
        <span class="since">since 0.7.1</span>)</dd>

        <dt><code>accel3d</code></dt>
        <dd>Enable 3D acceleration (for vbox driver
        <span class="since">since 0.7.1</span>, qemu driver
        <span class="since">since 1.3.0</span>)</dd>
        </dl>
M
Fix and improve domain xml video element description  
Matthias Bolte 已提交
6483 
      </dd>
E
docs: document <controller> element  
Eric Blake 已提交
6484 6485 6486 6487 6488 

      <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.
F
qemu: Add support for virtio-gpu-ccw video device on S390  
Farhan Ali 已提交
6489 6490 6491 
        On S390, <code>address</code> can be used to provide the
        CCW address for the video device (<span class="since">
        since 4.2.0</span>).
E
docs: document <controller> element  
Eric Blake 已提交
6492 
      </dd>
J
Add virtio-related options to video  
Ján Tomko 已提交
6493 6494 6495 6496 6497 6498 6499 6500 

      <dt><code>driver</code></dt>
      <dd>
        The subelement <code>driver</code> can be used to tune the device:
        <dl>
          <dt>virtio options</dt>
          <dd>
          <a href="#elementsVirtio">Virtio-specific options</a> can also be
R
bhyve: add vga configuration for video driver  
Roman Bogorodskiy 已提交
6501 6502 6503 6504 6505 6506 6507 6508 
          set (<span class="since">Since 3.5.0</span>)
          </dd>
          <dt>VGA configuration</dt>
          <dd>
          Control how the video devices exposed to the guest using the
          <code>vgaconf</code> attribute which takes the value "io", "on" or "off".
          At present, it's only applicable to the bhyve's "gop" video model type
          (<span class="since">Since 3.5.0</span>)
J
Add virtio-related options to video  
Ján Tomko 已提交
6509 6510 6511 
          </dd>
        </dl>
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
6512 6513 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
6514 
    <h4><a id="elementsConsole">Consoles, serial, parallel &amp; channel devices</a></h4>
D
Update domain XML docs  
Daniel P. Berrange 已提交
6515 6516 6517 

    <p>
      A character device provides a way to interact with the virtual machine.
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
6518 6519 
      Paravirtualized consoles, serial ports, parallel ports and channels are
      all classed as character devices and so represented using the same syntax.
D
Update domain XML docs  
Daniel P. Berrange 已提交
6520 6521 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
6522 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 
...
&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;serial type='file'&gt;
    &lt;source path='/tmp/file' append='on'&gt;
      &lt;seclabel model='dac' relabel='no'/&gt;
    &lt;/source&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
Update domain XML docs  
Daniel P. Berrange 已提交
6549
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
6550 6551 6552 6553 6554 
    <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
Update domain XML docs  
Daniel P. Berrange 已提交
6555
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
6556 6557 6558 6559 6560 6561 
    <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>
R
Add <seclabel> to character devices.  
Richard W.M. Jones 已提交
6562 6563 6564 6565 6566 6567 6568 6569 
    <p>
      The <code>source</code> element may contain an optional
      <code>seclabel</code> to override the way that labelling
      is done on the socket path.  If this element is not present,
      the <a href="#seclabel">security label is inherited from
        the per-domain setting</a>.
    </p>
D
docs: Describe new 'append' attribute for chardevs source  
Dmitry Mishin 已提交
6570 6571 6572 6573 6574 6575 6576 6577 
    <p>
      If the interface <code>type</code> presented to the host is "file",
      then the <code>source</code> element may contain an optional attribute
      <code>append</code> that specifies whether or not the information in
      the file should be preserved on domain restart. Allowed values are
      "on" and "off" (default). <span class="since">Since 1.3.1</span>.
    </p>
D
conf: allow use of a logfile with chardev backends  
Daniel P. Berrange 已提交
6578 
    <p>
B
docs: fix logfile paragraph  
Boris Fiuczynski 已提交
6579 
      Regardless of the <code>type</code>, character devices can
D
conf: allow use of a logfile with chardev backends  
Daniel P. Berrange 已提交
6580 6581 
      have an optional log file associated with them. This is
      expressed via a <code>log</code> sub-element, with a
B
docs: fix logfile paragraph  
Boris Fiuczynski 已提交
6582 6583 6584 
      <code>file</code> attribute. There can also be an <code>append</code>
      attribute which takes the same values described above.
      <span class="since">Since 1.3.3</span>.
D
conf: allow use of a logfile with chardev backends  
Daniel P. Berrange 已提交
6585 6586 6587 
    </p>

    <pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6588 6589 6590 
...
&lt;log file="/var/log/libvirt/qemu/guestname-serial0.log" append="off"/&gt;
...</pre>
D
conf: allow use of a logfile with chardev backends  
Daniel P. Berrange 已提交
6591
E
docs: document <controller> element  
Eric Blake 已提交
6592 6593 6594 6595 6596 6597 6598 6599 
    <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>
P
conf: introduce reconnect element for chardev source  
Pavel Hrdina 已提交
6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 
    <p>
      For character device with type <code>unix</code> or <code>tcp</code>
      the <code>source</code> has an optional element <code>reconnect</code>
      which configures reconnect timeout if the connection is lost.
      There are two attributes, <code>enabled</code> where possible
      values are "yes" and "no" and <code>timeout</code> which is in
      seconds. The <code>reconnect</code> attribute is valid only
      for <code>connect</code> mode.
      <span class="since">Since 3.7.0 (QEMU driver only)</span>.
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
6611 
    <h5><a id="elementsCharGuestInterface">Guest interface</a></h5>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
6612 6613 6614 6615 6616 6617 

    <p>
      A character device presents itself to the guest as one of the following
      types.
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
6618 
    <h6><a id="elementCharParallel">Parallel port</a></h6>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
6619
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
6620 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6621 6622 6623 6624 6625 6626 6627 6628 
...
&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>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
6629 6630 6631 

    <p>
      <code>target</code> can have a <code>port</code> attribute, which
M
docs: Serial and parallel device target ports actually start from 0  
Matthias Bolte 已提交
6632 
      specifies the port number. Ports are numbered starting from 0. There are
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
6633 6634 6635 
      usually 0, 1 or 2 parallel ports.
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
6636 
    <h6><a id="elementCharSerial">Serial port</a></h6>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
6637
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
6638 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6639 6640 
...
&lt;devices&gt;
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6641 
  &lt;!-- Serial port --&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6642 6643 6644 6645 6646 
  &lt;serial type='pty'&gt;
    &lt;source path='/dev/pts/3'/&gt;
    &lt;target port='0'/&gt;
  &lt;/serial&gt;
&lt;/devices&gt;
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6647 6648 6649 6650 6651 6652 6653 
...</pre>

<pre>
...
&lt;devices&gt;
  &lt;!-- USB serial port --&gt;
  &lt;serial type='pty'&gt;
A
conf: Parse and format virDomainChrSerialTargetModel  
Andrea Bolognani 已提交
6654 6655 6656 
    &lt;target type='usb-serial' port='0'&gt;
      &lt;model name='usb-serial'/&gt;
    &lt;/target&gt;
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6657 6658 6659 
    &lt;address type='usb' bus='0' port='1'/&gt;
  &lt;/serial&gt;
&lt;/devices&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6660 
...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
6661 6662 

    <p>
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6663 6664 6665 6666 6667 6668 
      The <code>target</code> element can have an optional <code>port</code>
      attribute, which specifies the port number (starting from 0), and an
      optional <code>type</code> attribute: valid values are,
      <span class="since">since 1.0.2</span>, <code>isa-serial</code> (usable
      with x86 guests), <code>usb-serial</code> (usable whenever USB support
      is available) and <code>pci-serial</code> (usable whenever PCI support
A
conf: Add target type and model for spapr-vty  
Andrea Bolognani 已提交
6669 
      is available); <span class="since">since 3.10.0</span>,
P
conf: add VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_SCLP  
Pino Toscano 已提交
6670 6671 6672 
      <code>spapr-vio-serial</code> (usable with ppc64/pseries guests),
      <code>system-serial</code> (usable with aarch64/virt guests) and
      <code>sclp-serial</code> (usable with s390 and s390x guests) are
A
conf: Add target type and model for pl011  
Andrea Bolognani 已提交
6673 
      available as well.
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
6674 6675 
    </p>
A
conf: Parse and format virDomainChrSerialTargetModel  
Andrea Bolognani 已提交
6676 6677 6678 6679 6680 6681 6682 
    <p>
      <span class="since">Since 3.10.0</span>, the <code>target</code>
      element can have an optional <code>model</code> subelement;
      valid values for its <code>name</code> attribute are:
      <code>isa-serial</code> (usable with the <code>isa-serial</code> target
      type); <code>usb-serial</code> (usable with the <code>usb-serial</code>
      target type); <code>pci-serial</code>
A
conf: Add target type and model for spapr-vty  
Andrea Bolognani 已提交
6683 6684 
      (usable with the <code>pci-serial</code> target type);
      <code>spapr-vty</code> (usable with the <code>spapr-vio-serial</code>
A
conf: Add target type and model for pl011  
Andrea Bolognani 已提交
6685 
      target type); <code>pl011</code> (usable with the
P
conf: add VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_SCLP  
Pino Toscano 已提交
6686 6687 6688 
      <code>system-serial</code> target type); <code>sclpconsole</code> and
      <code>sclplmconsole</code> (usable with the <code>sclp-serial</code>
      target type).
A
conf: Parse and format virDomainChrSerialTargetModel  
Andrea Bolognani 已提交
6689 6690 
    </p>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
6691 
    <p>
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6692 6693 
      If any of the attributes is not specified by the user, libvirt will
      choose a value suitable for most users.
D
Allow multiple consoles per virtual guest  
Daniel P. Berrange 已提交
6694 6695 
    </p>
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6696 
    <p>
A
conf: Add target type and model for pl011  
Andrea Bolognani 已提交
6697 
      Most target types support configuring the guest-visible device
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6698 6699 
      address as <a href="#elementsAddress">documented above</a>; more
      specifically, acceptable address types are <code>isa</code> (for
A
conf: Add target type and model for spapr-vty  
Andrea Bolognani 已提交
6700 6701 
      <code>isa-serial</code>), <code>usb</code> (for <code>usb-serial</code>),
      <code>pci</code> (for <code>pci-serial</code>) and <code>spapr-vio</code>
A
conf: Add target type and model for pl011  
Andrea Bolognani 已提交
6702 
      (for <code>spapr-vio-serial</code>). The <code>system-serial</code>
P
conf: add VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_SCLP  
Pino Toscano 已提交
6703 6704 
      and <code>sclp-serial</code> target types don't support specifying an
      address.
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6705 
    </p>
C
qemu: virtio console support  
Cole Robinson 已提交
6706 6707 

    <p>
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6708 6709 
      For the relationship between serial ports and consoles,
      <a href="#elementCharSerialAndConsole">see below</a>.
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
6710 6711 
    </p>
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6712 6713 
    <h6><a id="elementCharConsole">Console</a></h6>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
6714 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6715 6716 
...
&lt;devices&gt;
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6717 
  &lt;!-- Serial console --&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6718 
  &lt;console type='pty'&gt;
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6719 
    &lt;source path='/dev/pts/2'/&gt;
A
conf: Parse and format virDomainChrSerialTargetModel  
Andrea Bolognani 已提交
6720 
   &lt;target type='serial' port='0'/&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6721 
  &lt;/console&gt;
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6722 6723 
&lt;/devices&gt;
...</pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6724
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6725 6726 
<pre>
...
A
docs: Fix serial console configuration examples  
Andrea Bolognani 已提交
6727 
&lt;devices&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6728 6729 6730 6731 6732 6733 6734 
  &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;
&lt;/devices&gt;
...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
6735
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 
    <p>
      The <code>console</code> element is used to represent interactive
      serial consoles. Depending on the type of guest in use and the specifics
      of the configuration, the <code>console</code> element might represent
      the same device as an existing <code>serial</code> element or a separate
      device.
    </p>

    <p>
      A <code>target</code> subelement is supported and works the same
      way as with the <code>serial</code> element
      (<a href="#elementCharSerial">see above</a> for details).
      Valid values for the <code>type</code> attribute are:
      <code>serial</code> (described below);
      <code>virtio</code> (usable whenever VirtIO support is available);
      <code>xen</code>, <code>lxc</code>, <code>uml</code> and
      <code>openvz</code> (available when the corresponding hypervisor is in
P
conf: add VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_SCLP  
Pino Toscano 已提交
6753 6754 6755 6756 6757 
      use). <code>sclp</code> and <code>sclplm</code> (usable for s390 and
      s390x QEMU guests) are supported for compatibility reasons but should
      not be used for new guests: use the <code>sclpconsole</code> and
      <code>sclplmconsole</code> target models, respectively, with the
      <code>serial</code> element instead.
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 
    </p>

    <p>
      Of the target types listed above, <code>serial</code> is special in
      that it doesn't represents a separate device, but rather the same
      device as the first <code>serial</code> element. Due to this, there can
      only be a single <code>console</code> element with target type
      <code>serial</code> per guest.
    </p>

    <p>
      Virtio consoles are usually accessible as <code>/dev/hvc[0-7]</code>
      from inside the guest; 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>
    </p>

    <p>
      For the relationship between serial ports and consoles,
      <a href="#elementCharSerialAndConsole">see below</a>.
    </p>

    <h6><a id="elementCharSerialAndConsole">Relationship between serial ports and consoles</a></h6>

    <p>
      Due to hystorical reasons, the <code>serial</code> and
      <code>console</code> elements have partially overlapping scopes.
    </p>

    <p>
      In general, both elements are used to configure one or more serial
      consoles to be used for interacting with the guest. The main difference
      between the two is that <code>serial</code> is used for emulated,
      usually native, serial consoles, whereas <code>console</code> is used
      for paravirtualized ones.
    </p>

    <p>
      Both emulated and paravirtualized serial consoles have advantages and
      disadvantages:
    </p>

    <ul>
      <li>
        emulated serial consoles are usually initialized much earlier than
        paravirtualized ones, so they can be used to control the bootloader
        and display both firmware and early boot messages;
      </li>
      <li>
        on several platforms, there can only be a single emulated serial
        console per guest but paravirtualized consoles don't suffer from the
        same limitation.
      </li>
    </ul>

    <p>
      A configuration such as:
    </p>
J
S390: Add SCLP console front end support  
J.B. Joret 已提交
6817 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6818 
...
A
docs: Fix serial console configuration examples  
Andrea Bolognani 已提交
6819 
&lt;devices&gt;
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6820 6821 6822 
  &lt;console type='pty'&gt;
    &lt;target type='serial'/&gt;
  &lt;/console&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6823 
  &lt;console type='pty'&gt;
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6824 
    &lt;target type='virtio'/&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6825 6826 6827 
  &lt;/console&gt;
&lt;/devices&gt;
...</pre>
J
S390: Add SCLP console front end support  
J.B. Joret 已提交
6828
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
6829 
    <p>
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 
      will work on any platform and will result in one emulated serial console
      for early boot logging / interactive / recovery use, and one
      paravirtualized serial console to be used eg. as a side channel. Most
      people will be fine with having just the first <code>console</code>
      element in their configuration.
    </p>

    <p>
      Note that, due to the compatibility concerns mentioned earlier, all the
      following configurations:
    </p>

<pre>
...
A
docs: Fix serial console configuration examples  
Andrea Bolognani 已提交
6844 
&lt;devices&gt;
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6845 6846 6847 6848 6849 6850 
  &lt;serial type='pty'/&gt;
&lt;/devices&gt;
...</pre>

<pre>
...
A
docs: Fix serial console configuration examples  
Andrea Bolognani 已提交
6851 
&lt;devices&gt;
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6852 6853 6854 6855 6856 6857 
  &lt;console type='pty'/&gt;
&lt;/devices&gt;
...</pre>

<pre>
...
A
docs: Fix serial console configuration examples  
Andrea Bolognani 已提交
6858 
&lt;devices&gt;
A
docs: Improve documentation for serial consoles  
Andrea Bolognani 已提交
6859 6860 6861 6862 6863 6864 6865 6866 
  &lt;serial type='pty'/&gt;
  &lt;console type='pty'/&gt;
&lt;/devices&gt;
...</pre>

    <p>
      will be treated the same and will result in a single emulated serial
      console being available to the guest.
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
6867 6868 
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
6869 
    <h6><a id="elementCharChannel">Channel</a></h6>
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
6870 6871 6872 6873 6874 6875 

    <p>
      This represents a private communication channel between the host and the
      guest.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
6876 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 
...
&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;

  &lt;!-- KVM virtio channel --&gt;
  &lt;channel type='pty'&gt;
    &lt;target type='virtio' name='arbitrary.virtio.serial.port.name'/&gt;
  &lt;/channel&gt;
  &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' state='connected'/&gt;
  &lt;/channel&gt;
  &lt;channel type='spicevmc'&gt;
    &lt;target type='virtio' name='com.redhat.spice.0'/&gt;
  &lt;/channel&gt;
&lt;/devices&gt;
...</pre>
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 

    <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>
C
docs: domain: Document virtio <channel>  
Cole Robinson 已提交
6911 6912 6913 

      <dt><code>virtio</code></dt>
      <dd>Paravirtualized virtio channel. Channel is exposed in the guest under
E
docs: document <controller> element  
Eric Blake 已提交
6914 
        /dev/vport*, and if the optional element <code>name</code> is specified,
C
docs: domain: Document virtio <channel>  
Cole Robinson 已提交
6915 
        /dev/virtio-ports/$name (for more info, please see
E
docs: document <controller> element  
Eric Blake 已提交
6916 6917 
        <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
E
docs: document <address> elements in one place  
Eric Blake 已提交
6918 6919 
        particular <code>type='virtio-serial'</code>
        controller, <a href="#elementsAddress">documented above</a>.
D
QEMU guest agent support  
Daniel P. Berrange 已提交
6920 6921 6922 6923 
        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
J
docs: fix 'since' for socket path generation  
Ján Tomko 已提交
6924 
        since 0.9.10</span> Moreover, <span class="since">since 1.0.6</span>
M
qemu: Generate agent socket path if missing  
Michal Privoznik 已提交
6925 6926 6927 6928 
        it is possible to have source path auto generated for virtio unix channels.
        This is very useful in case of a qemu guest agent, where users don't
        usually care about the source path since it's libvirt who talks to
        the guest agent. In case users want to utilize this feature, they should
P
conf: Add channel state for virtio channels to the XML  
Peter Krempa 已提交
6929 6930 6931 6932 6933 6934 
        leave <code>&lt;source&gt;</code> element out. <span class="since">Since
        1.2.11</span> the active XML for a virtio channel may contain an optional
        <code>state</code> attribute that reflects whether a process in the
        guest is active on the channel. This is an output-only attribute.
        Possible values for the <code>state</code> attribute are
        <code>connected</code> and <code>disconnected</code>.
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
6935 
      </dd>
J
conf: add xen type for channels  
Joao Martins 已提交
6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 
      <dt><code>xen</code></dt>
      <dd> Paravirtualized Xen channel. Channel is exposed in the guest as a
        Xen console but identified with a name. Setup and consumption of a Xen
        channel depends on software and configuration in the guest
        (for more info, please see <a href="http://xenbits.xen.org/docs/unstable/misc/channel.txt">http://xenbits.xen.org/docs/unstable/misc/channel.txt</a>).
        Channel source path semantics are the same as the virtio target type.
        The <code>state</code> attribute is not supported since Xen channels
        lack the necessary probing mechanism.
        <span class="since">Since 2.3.0</span>
      </dd>
D
spicevmc: support new qemu chardev  
Daniel P. Berrange 已提交
6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 
      <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>
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
6959 6960 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
6961 
    <h5><a id="elementsCharHostInterface">Host interface</a></h5>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
6962 6963 6964 6965 6966 

    <p>
      A character device presents itself to the host as one of the following
      types.
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
6967
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
6968 
    <h6><a id="elementsCharSTDIO">Domain logfile</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
6969 6970 6971 6972 6973 6974 

    <p>
      This disables all input on the character device, and sends output
      into the virtual machine's logfile
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
6975 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6976 6977 6978 6979 6980 6981 6982 
...
&lt;devices&gt;
  &lt;console type='stdio'&gt;
    &lt;target port='1'/&gt;
  &lt;/console&gt;
&lt;/devices&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
6983 6984
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
6985 
    <h6><a id="elementsCharFle">Device logfile</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
6986 6987 6988 6989 6990 6991 

    <p>
      A file is opened and all data sent to the character
      device is written to the file.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
6992 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
6993 6994 6995 6996 6997 6998 6999 7000 
...
&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
Update domain XML docs  
Daniel P. Berrange 已提交
7001
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7002 
    <h6><a id="elementsCharVC">Virtual console</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
7003 7004 7005 7006 7007 7008 7009 

    <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>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
7010 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7011 7012 7013 7014 7015 7016 7017 
...
&lt;devices&gt;
  &lt;serial type='vc'&gt;
    &lt;target port="1"/&gt;
  &lt;/serial&gt;
&lt;/devices&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
7018
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7019 
    <h6><a id="elementsCharNull">Null device</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
7020 7021 7022 7023 7024 7025 

    <p>
      Connects the character device to the void. No data is ever
      provided to the input. All data written is discarded.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
7026 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7027 7028 7029 7030 7031 7032 7033 
...
&lt;devices&gt;
  &lt;serial type='null'&gt;
    &lt;target port="1"/&gt;
  &lt;/serial&gt;
&lt;/devices&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
7034
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7035 
    <h6><a id="elementsCharPTY">Pseudo TTY</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
7036 7037 7038 7039 7040 7041 7042 

    <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>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
7043 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7044 7045 7046 7047 7048 7049 7050 7051 
...
&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
Update domain XML docs  
Daniel P. Berrange 已提交
7052 7053 7054 

    <p>
      NB special case if &lt;console type='pty'&gt;, then the TTY
A
fix typos in docs  
Atsushi SAKAI 已提交
7055 
      path is also duplicated as an attribute tty='/dev/pts/3'
D
Update domain XML docs  
Daniel P. Berrange 已提交
7056 7057 7058 7059 
      on the top level &lt;console&gt; tag. This provides compat
      with existing syntax for &lt;console&gt; tags.
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7060 
    <h6><a id="elementsCharHost">Host device proxy</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
7061 7062 7063 7064 7065 

    <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
fix typos in docs  
Atsushi SAKAI 已提交
7066 
      a host serial port - don't connect a serial port to a parallel
D
Update domain XML docs  
Daniel P. Berrange 已提交
7067 7068 7069 
      port.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
7070 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7071 7072 7073 7074 7075 7076 7077 7078 
...
&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
Update domain XML docs  
Daniel P. Berrange 已提交
7079
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7080 
    <h6><a id="elementsCharPipe">Named pipe</a></h6>
C
Fix docs and code disagreements for character devices.  
Cole Robinson 已提交
7081 7082 7083 7084 7085 7086 

    <p>
      The character device writes output to a named pipe. See pipe(7) for
      more info.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
7087 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7088 7089 7090 7091 7092 7093 7094 7095 
...
&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>
C
Fix docs and code disagreements for character devices.  
Cole Robinson 已提交
7096
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7097 
    <h6><a id="elementsCharTCP">TCP client/server</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
7098 7099 7100 

    <p>
      The character device acts as a TCP client connecting to a
G
document tcp listen and raw wire option  
Guido Günther 已提交
7101 
      remote server.
D
Update domain XML docs  
Daniel P. Berrange 已提交
7102 7103 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
7104 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7105 7106 7107 7108 7109 7110 7111 7112 7113 
...
&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>
G
document tcp listen and raw wire option  
Guido Günther 已提交
7114 7115 7116 7117 7118 

    <p>
      Or as a TCP server waiting for a client connection.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
7119 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7120 7121 7122 7123 7124 7125 7126 7127 7128 
...
&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>
G
document tcp listen and raw wire option  
Guido Günther 已提交
7129 7130 

    <p>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
7131 
      Alternatively you can use <code>telnet</code> instead
J
docs: Clarify chardev protocol  
John Ferlan 已提交
7132 7133 7134 7135 7136 7137 7138 
      of <code>raw</code> TCP in order to utilize the telnet protocol
      for the connection.
    </p>
    <p>
      <span class="since">Since 0.8.5,</span> some hypervisors support
      use of either <code>telnets</code> (secure telnet) or <code>tls</code>
      (via secure sockets layer) as the transport protocol for connections.
E
docs: correct invalid xml  
Eric Blake 已提交
7139 
    </p>
G
document tcp listen and raw wire option  
Guido Günther 已提交
7140
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
7141 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7142 7143 7144 7145 7146 7147 7148 
...
&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;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
7149 
  ...
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7150 7151 7152 7153 7154 7155 7156 
  &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>
P
domain: Add optional 'tls' attribute for TCP chardev  
Pavel Hrdina 已提交
7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 

    <p>
      <span class="since">Since 2.4.0,</span> the optional attribute
      <code>tls</code> can be used to control whether a chardev
      TCP communication channel would utilize a hypervisor configured
      TLS X.509 certificate environment in order to encrypt the data
      channel. For the QEMU hypervisor, usage of a TLS environment can
      be controlled on the host by the <code>chardev_tls</code> and
      <code>chardev_tls_x509_cert_dir</code> or
      <code>default_tls_x509_cert_dir</code> settings in the file
      /etc/libvirt/qemu.conf. If <code>chardev_tls</code> is enabled,
      then unless the <code>tls</code> attribute is set to "no", libvirt
      will use the host configured TLS environment.
      If <code>chardev_tls</code> is disabled, but the <code>tls</code>
      attribute is set to "yes", then libvirt will attempt to use the
      host TLS environment if either the <code>chardev_tls_x509_cert_dir</code>
      or <code>default_tls_x509_cert_dir</code> TLS directory structure exists.
    </p>
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7176 7177 7178 7179 7180 7181 7182 7183 7184 
...
&lt;devices&gt;
  &lt;serial type="tcp"&gt;
    &lt;source mode='connect' host="127.0.0.1" service="5555" tls="yes"/&gt;
    &lt;protocol type="raw"/&gt;
    &lt;target port="0"/&gt;
  &lt;/serial&gt;
&lt;/devices&gt;
...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
7185
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7186 
    <h6><a id="elementsCharUDP">UDP network console</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
7187 7188 7189 7190 7191 7192 

    <p>
      The character device acts as a UDP netconsole service,
      sending and receiving packets. This is a lossy service.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
7193 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7194 7195 7196 7197 7198 7199 7200 7201 7202 
...
&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
Update domain XML docs  
Daniel P. Berrange 已提交
7203
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7204 
    <h6><a id="elementsCharUNIX">UNIX domain socket client/server</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
7205 7206 7207 7208 7209 7210 

    <p>
      The character device acts as a UNIX domain socket server,
      accepting connections from local clients.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
7211 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7212 7213 7214 7215 7216 7217 7218 7219 
...
&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
Update domain XML docs  
Daniel P. Berrange 已提交
7220
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7221 
    <h6><a id="elementsCharSpiceport">Spice channel</a></h6>
M
conf: introduce spiceport chardev backend  
Martin Kletzander 已提交
7222 7223 7224 7225 7226 7227 

    <p>
      The character device is accessible through spice connection
      under a channel name specified in the <code>channel</code>
      attribute.  <span class="since">Since 1.2.2</span>
    </p>
P
docs: add a note that spice channel is usable only with spice graphics  
Pavel Hrdina 已提交
7228 7229 7230 7231 7232 
    <p>
      Note: depending on the hypervisor, spiceports might (or might not)
      be enabled on domains with or without <a href="#elementsGraphics">spice
      graphics</a>.
    </p>
M
conf: introduce spiceport chardev backend  
Martin Kletzander 已提交
7233 7234 

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7235 7236 7237 7238 7239 7240 7241 7242 
...
&lt;devices&gt;
  &lt;serial type="spiceport"&gt;
    &lt;source channel="org.qemu.console.serial.0"/&gt;
    &lt;target port="1"/&gt;
  &lt;/serial&gt;
&lt;/devices&gt;
...</pre>
M
conf: introduce spiceport chardev backend  
Martin Kletzander 已提交
7243
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7244 
    <h6><a id="elementsNmdm">Nmdm device</a></h6>
R
docs: document nmdm type console  
Roman Bogorodskiy 已提交
7245 7246 7247 

    <p>
      The nmdm device driver, available on FreeBSD, provides two
C
docs: fix a typo in formatdomain  
Chen Hanxiao 已提交
7248 
      tty devices connected together by a virtual null modem cable.
R
docs: document nmdm type console  
Roman Bogorodskiy 已提交
7249 7250 7251 7252 
      <span class="since">Since 1.2.4</span>
    </p>

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7253 7254 7255 7256 7257 7258 7259 
...
&lt;devices&gt;
  &lt;serial type="nmdm"&gt;
    &lt;source master="/dev/nmdm0A" slave="/dev/nmdm0B"/&gt;
  &lt;/serial&gt;
&lt;/devices&gt;
...</pre>
R
docs: document nmdm type console  
Roman Bogorodskiy 已提交
7260 7261 7262 7263 7264 7265 7266 

    <p>
      The <code>source</code> element has these attributes:
    </p>

    <dl>
      <dt><code>master</code></dt>
E
doc: Add info (where necessary) that paths should be specified as absolute  
Erik Skultety 已提交
7267 7268 
      <dd>Master device of the pair, that is passed to the hypervisor.
      Device is specified by a fully qualified path.</dd>
R
docs: document nmdm type console  
Roman Bogorodskiy 已提交
7269 7270 7271 

      <dt><code>slave</code></dt>
      <dd>Slave device of the pair, that is passed to the clients for connection
E
doc: Add info (where necessary) that paths should be specified as absolute  
Erik Skultety 已提交
7272 
      to the guest console. Device is specified by a fully qualified path.</dd>
R
docs: document nmdm type console  
Roman Bogorodskiy 已提交
7273 
    </dl>
C
Add documentation for <sound> device XML format.  
Cole Robinson 已提交
7274
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7275 
    <h4><a id="elementsSound">Sound devices</a></h4>
C
Add documentation for <sound> device XML format.  
Cole Robinson 已提交
7276 7277 7278 7279 7280 7281 

    <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>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
7282 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7283 7284 7285 7286 7287 
...
&lt;devices&gt;
  &lt;sound model='es1370'/&gt;
&lt;/devices&gt;
...</pre>
C
Add documentation for <sound> device XML format.  
Cole Robinson 已提交
7288 7289 7290 7291 7292 7293 7294 

    <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
P
conf: Add USB sound card support and implement it for qemu  
Peter Krempa 已提交
7295 
        choices are 'es1370', 'sb16', 'ac97', 'ich6' and 'usb'.
C
qemu: sound: Support intel 'ich6' model  
Cole Robinson 已提交
7296 
        (<span class="since">
P
conf: Add USB sound card support and implement it for qemu  
Peter Krempa 已提交
7297 7298 
         'ac97' only since 0.6.0, 'ich6' only since 0.8.8,
         'usb' only since 1.2.7</span>)
C
Add documentation for <sound> device XML format.  
Cole Robinson 已提交
7299 7300 7301 
      </dd>
    </dl>
M
domain: add <codec> sound sub-element  
Marc-André Lureau 已提交
7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 
    <p>
      <span class="since">Since 0.9.13</span>, a sound element
      with <code>ich6</code> model can have optional
      sub-elements <code>&lt;codec&gt;</code> to attach various audio
      codecs to the audio device. If not specified, a default codec
      will be attached to allow playback and recording. Valid values
      are 'duplex' (advertise a line-in and a line-out) and 'micro'
      (advertise a speaker and a microphone).
    </p>

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7313 7314 7315 7316 7317 7318 7319 
...
&lt;devices&gt;
  &lt;sound model='ich6'&gt;
    &lt;codec type='micro'/&gt;
  &lt;/sound&gt;
&lt;/devices&gt;
...</pre>
M
domain: add <codec> sound sub-element  
Marc-André Lureau 已提交
7320
E
docs: document <controller> element  
Eric Blake 已提交
7321 7322 7323 
    <p>
      Each <code>sound</code> element has an optional
      sub-element <code>&lt;address&gt;</code> which can tie the
E
docs: document <address> elements in one place  
Eric Blake 已提交
7324 7325 
      device to a particular PCI
      slot, <a href="#elementsAddress">documented above</a>.
E
docs: document <controller> element  
Eric Blake 已提交
7326 7327 
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7328 
    <h4><a id="elementsWatchdog">Watchdog device</a></h4>
R
Support QEMU watchdog device.  
Richard Jones 已提交
7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 

    <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>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
7348 
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7349 7350 7351 7352 7353 
...
&lt;devices&gt;
  &lt;watchdog model='i6300esb'/&gt;
&lt;/devices&gt;
...</pre>
R
Support QEMU watchdog device.  
Richard Jones 已提交
7354
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
7355 7356 7357 7358 7359 7360 
<pre>
  ...
  &lt;devices&gt;
    &lt;watchdog model='i6300esb' action='poweroff'/&gt;
  &lt;/devices&gt;
&lt;/domain&gt;</pre>
R
Support QEMU watchdog device.  
Richard Jones 已提交
7361 7362 7363 7364 

    <dl>
      <dt><code>model</code></dt>
      <dd>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
7365 
        <p>
R
Support QEMU watchdog device.  
Richard Jones 已提交
7366 
        The required <code>model</code> attribute specifies what real
M
Cleanup whitespace in docs  
Matthew Booth 已提交
7367 7368 7369 7370 7371 7372 7373 
        watchdog device is emulated.  Valid values are specific to the
        underlying hypervisor.
        </p>
        <p>
        QEMU and KVM support:
        </p>
        <ul>
D
docs: remove use of &mdash; entity  
Daniel P. Berrange 已提交
7374 
          <li>'i6300esb' - the recommended device,
M
Cleanup whitespace in docs  
Matthew Booth 已提交
7375 
            emulating a PCI Intel 6300ESB </li>
D
docs: remove use of &mdash; entity  
Daniel P. Berrange 已提交
7376 7377 
          <li>'ib700' - emulating an ISA iBase IB700 </li>
          <li>'diag288' - emulating an S390 DIAG288 device
M
Revert "Change livbirt version to 1.3.0 for the next release"  
Martin Kletzander 已提交
7378 
            <span class="since">Since 1.2.17</span></li>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
7379 
        </ul>
R
Support QEMU watchdog device.  
Richard Jones 已提交
7380 7381 7382 
      </dd>
      <dt><code>action</code></dt>
      <dd>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
7383 
        <p>
R
Support QEMU watchdog device.  
Richard Jones 已提交
7384 
        The optional <code>action</code> attribute describes what
M
Cleanup whitespace in docs  
Matthew Booth 已提交
7385 7386 7387 7388 7389 7390 7391 
        action to take when the watchdog expires.  Valid values are
        specific to the underlying hypervisor.
        </p>
        <p>
        QEMU and KVM support:
        </p>
        <ul>
D
docs: remove use of &mdash; entity  
Daniel P. Berrange 已提交
7392 7393 
          <li>'reset' - default, forcefully reset the guest</li>
          <li>'shutdown' - gracefully shutdown the guest
M
Cleanup whitespace in docs  
Matthew Booth 已提交
7394 
            (not recommended) </li>
D
docs: remove use of &mdash; entity  
Daniel P. Berrange 已提交
7395 7396 7397 7398 
          <li>'poweroff' - forcefully power off the guest</li>
          <li>'pause' - pause the guest</li>
          <li>'none' - do nothing</li>
          <li>'dump' - automatically dump the guest
H
Update documentation of watchdog dump option and add test data for it  
Hu Tao 已提交
7399 
            <span class="since">Since 0.8.7</span></li>
D
docs: remove use of &mdash; entity  
Daniel P. Berrange 已提交
7400 
          <li>'inject-nmi' - inject a non-maskable interrupt
B
Support for a new watchdog action inject-nmi  
Boris Fiuczynski 已提交
7401 
            into the guest
M
Revert "Change livbirt version to 1.3.0 for the next release"  
Martin Kletzander 已提交
7402 
            <span class="since">Since 1.2.17</span></li>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
7403 7404 
        </ul>
        <p>
H
Update documentation of watchdog dump option and add test data for it  
Hu Tao 已提交
7405 
        Note 1: the 'shutdown' action requires that the guest
M
Cleanup whitespace in docs  
Matthew Booth 已提交
7406 7407 7408 7409 7410 
        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>
H
Update documentation of watchdog dump option and add test data for it  
Hu Tao 已提交
7411 7412 7413 7414 
        <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
Support QEMU watchdog device.  
Richard Jones 已提交
7415 7416 7417 
      </dd>
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7418 
    <h4><a id="elementsMemBalloon">Memory balloon device</a></h4>
D
Document the memory balloon device  
Daniel P. Berrange 已提交
7419 7420 7421 7422 7423 7424 7425 7426 

    <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>
E
docs: document how to disable memballoon  
Eric Blake 已提交
7427 7428 7429 
      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.
D
Document the memory balloon device  
Daniel P. Berrange 已提交
7430 7431 7432 
    </p>

    <p>
J
docs: fix memballoon examples  
Ján Tomko 已提交
7433 
      Example: automatically added device with KVM
D
Document the memory balloon device  
Daniel P. Berrange 已提交
7434 7435 
    </p>
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7436 7437 7438 7439 7440 
...
&lt;devices&gt;
  &lt;memballoon model='virtio'/&gt;
&lt;/devices&gt;
...</pre>
D
Document the memory balloon device  
Daniel P. Berrange 已提交
7441 7442 

    <p>
J
docs: fix memballoon examples  
Ján Tomko 已提交
7443 
      Example: manually added device with static PCI slot 2 requested
D
Document the memory balloon device  
Daniel P. Berrange 已提交
7444 7445 7446 7447 
    </p>
<pre>
  ...
  &lt;devices&gt;
J
docs: fix memballoon examples  
Ján Tomko 已提交
7448 7449 
    &lt;memballoon model='virtio'&gt;
      &lt;address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x0'/&gt;
J
Add 'period' for Memballoon statistics gathering capability  
John Ferlan 已提交
7450 
      &lt;stats period='10'/&gt;
J
add virtio-related options to memballoon  
Ján Tomko 已提交
7451 
      &lt;driver iommu='on' ats='on'/&gt;
J
docs: fix memballoon examples  
Ján Tomko 已提交
7452 
    &lt;/memballoon&gt;
D
Document the memory balloon device  
Daniel P. Berrange 已提交
7453 7454 7455 7456 7457 7458 7459 7460 
  &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
maint: whitespace cleanup  
Eric Blake 已提交
7461 7462 
          of balloon device is provided. Valid values are specific to
          the virtualization platform
D
Document the memory balloon device  
Daniel P. Berrange 已提交
7463 7464 
        </p>
        <ul>
D
docs: remove use of &mdash; entity  
Daniel P. Berrange 已提交
7465 7466 
          <li>'virtio' - default with QEMU/KVM</li>
          <li>'xen' - default with Xen</li>
D
Document the memory balloon device  
Daniel P. Berrange 已提交
7467 7468 
        </ul>
      </dd>
D
conf: introduce 'autodeflate' attribute for memballoon device  
Dmitry Andreev 已提交
7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 
      <dt><code>autodeflate</code></dt>
      <dd>
        <p>
          The optional <code>autodeflate</code> attribute allows to
          enable/disable (values "on"/"off", respectively) the ability of the
          QEMU virtio memory balloon to release some memory at the last moment
          before a guest's process get killed by Out of Memory killer.
          <span class="since">Since 1.3.1, QEMU and KVM only</span>
        </p>
      </dd>
J
Add 'period' for Memballoon statistics gathering capability  
John Ferlan 已提交
7479 7480 7481 
      <dt><code>period</code></dt>
      <dd>
        <p>
M
conf: Use correct type for balloon stats period  
Martin Kletzander 已提交
7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 
          The optional <code>period</code> allows the QEMU virtio memory balloon
          driver to provide statistics through the <code>virsh dommemstat
          [domain]</code> command. By default, collection is not enabled. In
          order to enable, use the <code>virsh dommemstat [domain] --period
          [number]</code> command or <code>virsh edit</code> command to add the
          option to the XML definition.  The <code>virsh dommemstat</code> will
          accept the options <code>--live</code>, <code>--current</code>,
          or <code>--config</code>.  If an option is not provided, the change
          for a running domain will only be made to the active guest.  If the
          QEMU driver is not at the right revision, the attempt to set the
          period will fail.  Large values (e.g. many years) might be ignored.
J
Add 'period' for Memballoon statistics gathering capability  
John Ferlan 已提交
7493 7494 7495 
          <span class='since'>Since 1.1.1, requires QEMU 1.5</span>
        </p>
      </dd>
J
add virtio-related options to memballoon  
Ján Tomko 已提交
7496 7497 7498 7499 7500 7501 
      <dt><code>driver</code></dt>
      <dd>
        For model <code>virtio</code> memballoon,
        <a href="#elementsVirtio">Virtio-specific options</a> can also be
        set. (<span class="since">Since 3.5.0</span>)
      </dd>
D
Document the memory balloon device  
Daniel P. Berrange 已提交
7502 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7503 
    <h4><a id="elementsRng">Random number generator device</a></h4>
P
doc: schema: Add basic documentation for the virtual RNG device support  
Peter Krempa 已提交
7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 

    <p>
      The virtual random number generator device allows the host to pass
      through entropy to guest operating systems.
      <span class="since">Since 1.0.3</span>
    </p>

    <p>
      Example: usage of the RNG device:
    </p>
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 
...
&lt;devices&gt;
  &lt;rng model='virtio'&gt;
    &lt;rate period="2000" bytes="1234"/&gt;
    &lt;backend model='random'&gt;/dev/random&lt;/backend&gt;
    &lt;!-- OR --&gt;
    &lt;backend model='egd' type='udp'&gt;
      &lt;source mode='bind' service='1234'/&gt;
      &lt;source mode='connect' host='1.2.3.4' service='1234'/&gt;
    &lt;/backend&gt;
  &lt;/rng&gt;
&lt;/devices&gt;
...
P
doc: schema: Add basic documentation for the virtual RNG device support  
Peter Krempa 已提交
7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 
</pre>
    <dl>
      <dt><code>model</code></dt>
      <dd>
        <p>
          The required <code>model</code> attribute specifies what type
          of RNG device is provided. Valid values are specific to
          the virtualization platform:
        </p>
        <ul>
D
docs: remove use of &mdash; entity  
Daniel P. Berrange 已提交
7538 
          <li>'virtio' - supported by qemu and virtio-rng kernel module</li>
P
doc: schema: Add basic documentation for the virtual RNG device support  
Peter Krempa 已提交
7539 7540 
        </ul>
      </dd>
P
virtio-rng: Add rate limiting options for virtio-RNG  
Peter Krempa 已提交
7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 
      <dt><code>rate</code></dt>
      <dd>
        <p>
          The optional <code>rate</code> element allows limiting the rate at
          which entropy can be consumed from the source.  The mandatory
          attribute <code>bytes</code> specifies how many bytes are permitted
          to be consumed per period.  An optional <code>period</code> attribute
          specifies the duration of a period in milliseconds; if omitted, the
          period is taken as 1000 milliseconds (1 second).
          <span class='since'>Since 1.0.4</span>
        </p>
      </dd>
P
doc: schema: Add basic documentation for the virtual RNG device support  
Peter Krempa 已提交
7553 7554 7555 7556 7557 7558 7559 
      <dt><code>backend</code></dt>
      <dd>
        <p>
          The <code>backend</code> element specifies the source of entropy
          to be used for the domain. The source model is configured using the
          <code>model</code> attribute. Supported source models are:
        </p>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
7560 7561 7562 7563 7564 
        <dl>
          <dt><code>random</code></dt>
          <dd>
            <p>
              This backend type expects a non-blocking character device as
C
conf: Drop restrictions on rng backend path  
Cole Robinson 已提交
7565 
              input. The file name is specified as contents of the
J
docs: document rng backend path restrictions of older libvirt  
Ján Tomko 已提交
7566 7567 7568 7569 
              <code>backend</code> element. <span class='since'>Since 1.3.4</span>
              any path is accepted. Before that /dev/random and /dev/hwrng were
              the only accepted paths. When no file name is specified the hypervisor
              default is used. For qemu, the default is /dev/random
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 
            </p>
          </dd>
          <dt><code>egd</code></dt>
          <dd>
            <p>
              This backend connects to a source using the EGD protocol.
              The source is specified as a character device. Refer to
              <a href='#elementsCharHostInterface'>character device host interface</a>
              for more information.
            </p>
          </dd>
        </dl>
P
doc: schema: Add basic documentation for the virtual RNG device support  
Peter Krempa 已提交
7582 
      </dd>
J
Add virtio-related options to rng devices  
Ján Tomko 已提交
7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 
      <dt><code>driver</code></dt>
      <dd>
        The subelement <code>driver</code> can be used to tune the device:
        <dl>
          <dt>virtio options</dt>
          <dd>
          <a href="#elementsVirtio">Virtio-specific options</a> can also be
          set. (<span class="since">Since 3.5.0</span>)
          </dd>
        </dl>
      </dd>
P
doc: schema: Add basic documentation for the virtual RNG device support  
Peter Krempa 已提交
7594 7595 

    </dl>
D
Document the memory balloon device  
Daniel P. Berrange 已提交
7596
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7597 
    <h4><a id="elementsTpm">TPM device</a></h4>
S
Add documentation and schema for TPM passthrough  
Stefan Berger 已提交
7598 7599 7600 7601 7602 7603 7604 

    <p>
      The TPM device enables a QEMU guest to have access to TPM
      functionality.
    </p>
    <p>
      The TPM passthrough device type provides access to the host's TPM
M
docs: fix simple typo in TPM paragraph  
Martin Kletzander 已提交
7605 
      for one QEMU guest. No other software may be using the TPM device,
S
Add documentation and schema for TPM passthrough  
Stefan Berger 已提交
7606 7607 7608 7609 7610 7611 7612 7613 
      typically /dev/tpm0, at the time the QEMU guest is started.
      <span class="since">'passthrough' since 1.0.5</span>
    </p>

    <p>
     Example: usage of the TPM passthrough device
    </p>
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7614 7615 7616 7617 7618 7619 7620 7621 7622 
...
&lt;devices&gt;
  &lt;tpm model='tpm-tis'&gt;
    &lt;backend type='passthrough'&gt;
      &lt;device path='/dev/tpm0'/&gt;
    &lt;/backend&gt;
  &lt;/tpm&gt;
&lt;/devices&gt;
...
S
Add documentation and schema for TPM passthrough  
Stefan Berger 已提交
7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 
</pre>
    <dl>
      <dt><code>model</code></dt>
      <dd>
        <p>
          The <code>model</code> attribute specifies what device
          model QEMU provides to the guest. If no model name is provided,
          <code>tpm-tis</code> will automatically be chosen.
        </p>
      </dd>
      <dt><code>backend</code></dt>
      <dd>
        <p>
          The <code>backend</code> element specifies the type of
          TPM device. The following types are supported:
        </p>
A
docs: Fix some formatting oddities  
Andrea Bolognani 已提交
7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 
        <dl>
          <dt><code>passthrough</code></dt>
          <dd>
            <p>
              Use the host's TPM device.
            </p>
            <p>
              This backend type requires exclusive access to a TPM device on
              the host. An example for such a device is /dev/tpm0. The fully
              qualified file name is specified by path attribute of the
              <code>source</code> element. If no file name is specified then
              /dev/tpm0 is automatically used.
            </p>
          </dd>
        </dl>
S
Add documentation and schema for TPM passthrough  
Stefan Berger 已提交
7654 7655 7656 
      </dd>
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7657 
    <h4><a id="elementsNVRAM">NVRAM device</a></h4>
L
Add NVRAM device  
Li Zhang 已提交
7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 
    <p>
      nvram device is always added to pSeries guest on PPC64, and its address
      is allowed to be changed.  Element <code>nvram</code> (only valid for
      pSeries guest, <span class="since">since 1.0.5</span>) is provided to
      enable the address setting.
    </p>
    <p>
      Example: usage of NVRAM configuration
    </p>
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7668 7669 7670 7671 7672 7673 7674 
...
&lt;devices&gt;
  &lt;nvram&gt;
    &lt;address type='spapr-vio' reg='0x3000'/&gt;
  &lt;/nvram&gt;
&lt;/devices&gt;
...
L
Add NVRAM device  
Li Zhang 已提交
7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 
</pre>
  <dl>
    <dt><code>spapr-vio</code></dt>
    <dd>
      <p>
        VIO device address type, only valid for PPC64.
      </p>
    </dd>
    <dt><code>reg</code></dt>
    <dd>
      <p>
        Device address
      </p>
    </dd>
  </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7691 
    <h4><a id="elementsPanic">panic device</a></h4>
H
conf: add support for panic device  
Hu Tao 已提交
7692 7693 7694 7695 7696 
    <p>
      panic device enables libvirt to receive panic notification from a QEMU
      guest.
      <span class="since">Since 1.2.1, QEMU and KVM only</span>
    </p>
A
qemu: Automatically add <panic> element for pSeries guests.  
Andrea Bolognani 已提交
7697 
    <p>
B
qemu: add panic device support for S390  
Boris Fiuczynski 已提交
7698 7699 7700 7701 7702 7703 7704 7705 7706 
      This feature is always enabled for:
    </p>
    <ul>
      <li>pSeries guests, since it's implemented by the guest firmware</li>
      <li>S390 guests, since it's an integral part of the S390 architecture</li>
    </ul>
    <p>
      For the guest types listed above, libvirt automatically adds a
      <code>panic</code> element to the domain XML.
A
qemu: Automatically add <panic> element for pSeries guests.  
Andrea Bolognani 已提交
7707 
    </p>
H
conf: add support for panic device  
Hu Tao 已提交
7708 7709 7710 7711 
    <p>
      Example: usage of panic configuration
    </p>
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7712 7713 7714 7715 7716 7717 7718 7719 
...
&lt;devices&gt;
  &lt;panic model='hyperv'/&gt;
  &lt;panic model='isa'&gt;
    &lt;address type='isa' iobase='0x505'/&gt;
  &lt;/panic&gt;
&lt;/devices&gt;
...
H
conf: add support for panic device  
Hu Tao 已提交
7720 7721 
</pre>
  <dl>
D
conf: add 'model' attribute for panic device with values isa, pseries, hyperv  
Dmitry Andreev 已提交
7722 7723 7724 7725 7726 7727 7728 7729 
    <dt><code>model</code></dt>
      <dd>
        <p>
          The optional <code>model</code> attribute specifies what type
          of panic device is provided. The panic model used when this attribute
          is missing depends on the hypervisor and guest arch.
        </p>
        <ul>
D
docs: remove use of &mdash; entity  
Daniel P. Berrange 已提交
7730 7731 7732 
          <li>'isa' - for ISA pvpanic device</li>
          <li>'pseries' - default and valid only for pSeries guests.</li>
          <li>'hyperv' - for Hyper-V crash CPU feature.
D
conf: add 'model' attribute for panic device with values isa, pseries, hyperv  
Dmitry Andreev 已提交
7733 
            <span class="since">Since 1.3.0, QEMU and KVM only</span></li>
D
docs: remove use of &mdash; entity  
Daniel P. Berrange 已提交
7734 
          <li>'s390' - default for S390 guests.
B
qemu: add panic device support for S390  
Boris Fiuczynski 已提交
7735 
            <span class="since">Since 1.3.5</span></li>
D
conf: add 'model' attribute for panic device with values isa, pseries, hyperv  
Dmitry Andreev 已提交
7736 7737 
        </ul>
      </dd>
H
conf: add support for panic device  
Hu Tao 已提交
7738 7739 7740 7741 
    <dt><code>address</code></dt>
    <dd>
      <p>
        address of panic. The default ioport is 0x505. Most users
A
qemu: Allow panic device for pSeries guests  
Andrea Bolognani 已提交
7742 
        don't need to specify an address, and doing so is forbidden
B
qemu: add panic device support for S390  
Boris Fiuczynski 已提交
7743 
        altogether for s390, pseries and hyperv models.
H
conf: add support for panic device  
Hu Tao 已提交
7744 7745 7746 7747 
      </p>
    </dd>
  </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7748 
  <h4><a id="elementsShmem">Shared memory device</a></h4>
M
docs, conf, schema: add support for shmem device  
Martin Kletzander 已提交
7749 7750 7751 7752 

    <p>
      A shared memory device allows to share a memory region between
      different virtual machines and the host.
M
minor shmem clean-ups  
Martin Kletzander 已提交
7753 
      <span class="since">Since 1.2.10, QEMU and KVM only</span>
M
docs, conf, schema: add support for shmem device  
Martin Kletzander 已提交
7754 7755 7756 
    </p>

<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 
...
&lt;devices&gt;
  &lt;shmem name='my_shmem0'&gt;
    &lt;model type='ivshmem-plain'/&gt;
    &lt;size unit='M'&gt;4&lt;/size&gt;
  &lt;/shmem&gt;
  &lt;shmem name='shmem_server'&gt;
    &lt;model type='ivshmem-doorbell'/&gt;
    &lt;size unit='M'&gt;2&lt;/size&gt;
    &lt;server path='/tmp/socket-shmem'/&gt;
    &lt;msi vectors='32' ioeventfd='on'/&gt;
  &lt;/shmem&gt;
&lt;/devices&gt;
...
M
docs, conf, schema: add support for shmem device  
Martin Kletzander 已提交
7771 7772 7773 7774 7775 7776 7777 7778 
</pre>

  <dl>
    <dt><code>shmem</code></dt>
    <dd>
      The <code>shmem</code> element has one mandatory attribute,
      <code>name</code> to identify the shared memory.
    </dd>
M
conf, qemu: Add support for shmem model  
Martin Kletzander 已提交
7779 7780 7781 7782 
    <dt><code>model</code></dt>
    <dd>
      Attribute <code>type</code> of the optional element <code>model</code>
      specifies the model of the underlying device providing the
M
conf, qemu: Add newer shmem models  
Martin Kletzander 已提交
7783 7784 7785 7786 7787 
      <code>shmem</code> device.  The models currently supported are
      <code>ivshmem</code> (supports both server and server-less shmem, but is
      deprecated by newer QEMU in favour of the -plain and -doorbell variants),
      <code>ivshmem-plain</code> (only for server-less shmem) and
      <code>ivshmem-doorbell</code> (only for shmem with the server).
M
conf, qemu: Add support for shmem model  
Martin Kletzander 已提交
7788 
    </dd>
M
docs, conf, schema: add support for shmem device  
Martin Kletzander 已提交
7789 7790 7791 7792 7793 7794 7795 7796 7797 
    <dt><code>size</code></dt>
    <dd>
      The optional <code>size</code> element specifies the size of the shared
      memory. This must be power of 2 and greater than or equal to 1 MiB.
    </dd>
    <dt><code>server</code></dt>
    <dd>
      The optional <code>server</code> element can be used to configure a server
      socket the device is supposed to connect to.  The optional
E
doc: Add info (where necessary) that paths should be specified as absolute  
Erik Skultety 已提交
7798 7799 
      <code>path</code> attribute specifies the absolute path to the unix socket
      and defaults to <code>/var/lib/libvirt/shmem/$shmem-$name-sock</code>.
M
docs, conf, schema: add support for shmem device  
Martin Kletzander 已提交
7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 
    </dd>
    <dt><code>msi</code></dt>
    <dd>
      The optional <code>msi</code> element enables/disables (values "on"/"off",
      respectively) MSI interrupts. This option can currently be used only
      together with the <code>server</code> element. The <code>vectors</code>
      attribute can be used to specify the number of interrupt
      vectors. The <code>ioeventd</code> attribute enables/disables (values
      "on"/"off", respectively) ioeventfd.
    </dd>
  </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7812 
    <h4><a id="elementsMemory">Memory devices</a></h4>
P
conf: Add interface to parse and format memory device information  
Peter Krempa 已提交
7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 

    <p>
        In addition to the initial memory assigned to the guest, memory devices
        allow additional memory to be assigned to the guest in the form of
        memory modules.

        A memory device can be hot-plugged or hot-unplugged depending on the
        guests' memory resource needs.

        Some hypervisors may require NUMA configured for the guest.
    </p>

    <p>
      Example: usage of the memory devices
    </p>
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7829 7830 
...
&lt;devices&gt;
M
conf: Introduce @access to <memory/>  
Michal Privoznik 已提交
7831 
  &lt;memory model='dimm' access='private'&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 
    &lt;target&gt;
      &lt;size unit='KiB'&gt;524287&lt;/size&gt;
      &lt;node&gt;0&lt;/node&gt;
    &lt;/target&gt;
  &lt;/memory&gt;
  &lt;memory model='dimm'&gt;
    &lt;source&gt;
      &lt;pagesize unit='KiB'&gt;4096&lt;/pagesize&gt;
      &lt;nodemask&gt;1-3&lt;/nodemask&gt;
    &lt;/source&gt;
    &lt;target&gt;
      &lt;size unit='KiB'&gt;524287&lt;/size&gt;
      &lt;node&gt;1&lt;/node&gt;
    &lt;/target&gt;
  &lt;/memory&gt;
M
Introduce NVDIMM memory model  
Michal Privoznik 已提交
7847 7848 7849 7850 7851 7852 7853 
  &lt;memory model='nvdimm'&gt;
    &lt;source&gt;
      &lt;path&gt;/tmp/nvdimm&lt;/path&gt;
    &lt;/source&gt;
    &lt;target&gt;
      &lt;size unit='KiB'&gt;524288&lt;/size&gt;
      &lt;node&gt;1&lt;/node&gt;
M
qemu: Introduce label-size for NVDIMMs  
Michal Privoznik 已提交
7854 7855 7856 
      &lt;label&gt;
        &lt;size unit='KiB'&gt;128&lt;/size&gt;
      &lt;/label&gt;
M
Introduce NVDIMM memory model  
Michal Privoznik 已提交
7857 7858 
    &lt;/target&gt;
  &lt;/memory&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7859 7860 
&lt;/devices&gt;
...
P
conf: Add interface to parse and format memory device information  
Peter Krempa 已提交
7861 7862 7863 7864 7865 
</pre>
    <dl>
      <dt><code>model</code></dt>
      <dd>
        <p>
M
Introduce NVDIMM memory model  
Michal Privoznik 已提交
7866 7867 7868 7869 
          Provide <code>dimm</code> to add a virtual DIMM module to the guest.
          <span class="since">Since 1.2.14</span>
          Provide <code>nvdimm</code> model adds a Non-Volatile DIMM
          module. <span class="since">Since 3.2.0</span>
P
conf: Add interface to parse and format memory device information  
Peter Krempa 已提交
7870 7871 7872 
        </p>
      </dd>
M
conf: Introduce @access to <memory/>  
Michal Privoznik 已提交
7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 
      <dt><code>access</code></dt>
      <dd>
        <p>
          An optional attribute <code>access</code>
          (<span class="since">since 3.2.0</span>) that provides
          capability to fine tune mapping of the memory on per
          module basis. Values are the same as
          <a href="#elementsMemoryBacking">Memory Backing</a>:
          <code>shared</code> and <code>private</code>.
        </p>
      </dd>
P
conf: Add interface to parse and format memory device information  
Peter Krempa 已提交
7885 7886 7887 
      <dt><code>source</code></dt>
      <dd>
        <p>
M
Introduce NVDIMM memory model  
Michal Privoznik 已提交
7888 7889 7890 7891 7892 
          For model <code>dimm</code> this element is optional and allows to
          fine tune the source of the memory used for the given memory device.
          If the element is not provided defaults configured via
          <code>numatune</code> are used. If <code>dimm</code> is provided,
          then the following optional elements can be provided as well:
P
conf: Add interface to parse and format memory device information  
Peter Krempa 已提交
7893 7894 
        </p>
M
Introduce NVDIMM memory model  
Michal Privoznik 已提交
7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 
        <dl>
          <dt><code>pagesize</code></dt>
          <dd>
            <p>
              This element can be used to override the default
              host page size used for backing the memory device.
              The configured value must correspond to a page size
              supported by the host.
            </p>
          </dd>

          <dt><code>nodemask</code></dt>
          <dd>
            <p>
              This element can be used to override the default
              set of NUMA nodes where the memory would be
              allocated.
            </p>
          </dd>
        </dl>
P
conf: Add interface to parse and format memory device information  
Peter Krempa 已提交
7916 
        <p>
M
Introduce NVDIMM memory model  
Michal Privoznik 已提交
7917 7918 7919 
          For model <code>nvdimm</code> this element is mandatory and has a
          single child element <code>path</code> that represents a path
          in the host that backs the nvdimm module in the guest.
P
conf: Add interface to parse and format memory device information  
Peter Krempa 已提交
7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 
        </p>
      </dd>

      <dt><code>target</code></dt>
      <dd>
        <p>
          The mandatory <code>target</code> element configures the placement and
          sizing of the added memory from the perspective of the guest.
        </p>
        <p>
          The mandatory <code>size</code> subelement configures the size of the
          added memory as a scaled integer.
        </p>
        <p>
P
conf: Prepare making memory device target node optional  
Peter Krempa 已提交
7934 7935 7936 
          The <code>node</code> subelement configures the guest NUMA node to
          attach the memory to. The element shall be used only if the guest has
          NUMA nodes configured.
P
conf: Add interface to parse and format memory device information  
Peter Krempa 已提交
7937 
        </p>
M
qemu: Introduce label-size for NVDIMMs  
Michal Privoznik 已提交
7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 
        <p>
          For NVDIMM type devices one can optionally use
          <code>label</code> and its subelement <code>size</code>
          to configure the size of namespaces label storage
          within the NVDIMM module. The <code>size</code> element
          has usual meaning described
          <a href="#elementsMemoryAllocation">here</a>.
          For QEMU domains the following restrictions apply:
        </p>
        <ol>
          <li>the minimum label size is 128KiB,</li>
          <li>the remaining size (total-size - label-size) has to be aligned to
            4KiB</li>
        </ol>
P
conf: Add interface to parse and format memory device information  
Peter Krempa 已提交
7952 7953 7954 
      </dd>
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
7955 
    <h4><a id="elementsIommu">IOMMU devices</a></h4>
J
Introduce <iommu> device  
Ján Tomko 已提交
7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 

    <p>
      The <code>iommu</code> element can be used to add an IOMMU device.
      <span class="since">Since 2.1.0</span>
    </p>

    <p>
      Example:
    </p>
<pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7966 7967 
...
&lt;devices&gt;
J
conf: add <driver intremap> to <iommu>  
Ján Tomko 已提交
7968 7969 7970 
  &lt;iommu model='intel'&gt;
    &lt;driver intremap='on'/&gt;
  &lt;/iommu&gt;
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
7971 7972 
&lt;/devices&gt;
...
J
Introduce <iommu> device  
Ján Tomko 已提交
7973 7974 7975 7976 7977 7978 7979 7980 
</pre>
    <dl>
      <dt><code>model</code></dt>
      <dd>
        <p>
          Currently only the <code>intel</code> model is supported.
        </p>
      </dd>
J
conf: add <driver intremap> to <iommu>  
Ján Tomko 已提交
7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 
      <dt><code>driver</code></dt>
      <dd>
        <p>
          The <code>driver</code> subelement can be used to configure
          additional options:
        </p>
        <dl>
          <dt><code>intremap</code></dt>
          <dd>
            <p>
              The <code>intremap</code> attribute with possible values
              <code>on</code> and <code>off</code> can be used to
              turn on interrupt remapping, a part of the VT-d functionality.
              Currently this requires split I/O APIC
              (<code>&lt;ioapic driver='qemu'/&gt;</code>).
              <span class="since">Since 3.4.0</span> (QEMU/KVM only)
            </p>
          </dd>
J
conf: add caching_mode attribute to iommu device  
Ján Tomko 已提交
7999 8000 8001 8002 8003 8004 8005 8006 8007 
          <dt><code>caching_mode</code></dt>
          <dd>
            <p>
              The <code>caching_mode</code> attribute with possible values
              <code>on</code> and <code>off</code> can be used to
              turn on the VT-d caching mode (useful for assigned devices).
              <span class="since">Since 3.4.0</span> (QEMU/KVM only)
            </p>
          </dd>
J
conf: add eim attribute to <iommu><driver>  
Ján Tomko 已提交
8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 
          <dt><code>eim</code></dt>
          <dd>
            <p>
              The <code>eim</code> attribute (with possible values
              <code>on</code> and <code>off</code>) can be used to
              configure Extended Interrupt Mode. A q35 domain with
              split I/O APIC (as described in
              <a href="#elementsFeatures">hypervisor features</a>),
              and both interrupt remapping and EIM turned on for
              the IOMMU, will be able to use more than 255 vCPUs.
              <span class="since">Since 3.4.0</span> (QEMU/KVM only)
            </p>
          </dd>
J
conf: add iotlb attribute to iommu  
Ján Tomko 已提交
8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 
          <dt><code>iotlb</code></dt>
          <dd>
            <p>
              The <code>iotlb</code> attribute with possible values
              <code>on</code> and <code>off</code> can be used to
              turn on the IOTLB used to cache address translation
              requests from devices.
              <span class="since">Since 3.5.0</span> (QEMU/KVM only)
            </p>
          </dd>
J
conf: add <driver intremap> to <iommu>  
Ján Tomko 已提交
8031 8032 
        </dl>
      </dd>
J
Introduce <iommu> device  
Ján Tomko 已提交
8033 8034 
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
8035 
    <h3><a id="seclabel">Security label</a></h3>
D
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
8036 8037 8038 

    <p>
      The <code>seclabel</code> element allows control over the
D
Add two new security label types  
Daniel P. Berrange 已提交
8039 8040 8041 8042 8043 
      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
D
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
8044 8045 8046 8047 8048 
      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
D
Add two new security label types  
Daniel P. Berrange 已提交
8049 8050 
      if desired.  <span class="since">'dynamic' since 0.6.1, 'static'
      since 0.6.2, and 'none' since 0.9.10.</span>
D
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
8051 8052 
    </p>
M
Multiple security drivers in XML data  
Marcelo Cerri 已提交
8053 8054 8055 8056 8057 8058 8059 
    <p>
      If more than one security driver is used by libvirt, multiple
      <code>seclabel</code> tags can be used, one for each driver and
      the security driver referenced by each tag can be defined using
      the attribute <code>model</code>
    </p>
D
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
8060 
    <p>
E
seclabel: extend XML to allow per-disk label overrides  
Eric Blake 已提交
8061 
      Valid input XML configurations for the top-level security label
D
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
8062 8063 8064 8065 
      are:
    </p>

    <pre>
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
8066 
&lt;seclabel type='dynamic' model='selinux'/&gt;
D
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
8067
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
8068 8069 8070 
&lt;seclabel type='dynamic' model='selinux'&gt;
  &lt;baselabel&gt;system_u:system_r:my_svirt_t:s0&lt;/baselabel&gt;
&lt;/seclabel&gt;
D
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
8071
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
8072 8073 8074 
&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;
D
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
8075
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
8076 8077 8078 
&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;
D
Add two new security label types  
Daniel P. Berrange 已提交
8079
M
formatdomain.html.in: Kill useless spaces in <pre/>  
Michal Privoznik 已提交
8080 
&lt;seclabel type='none'/&gt;
D
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
8081 8082 
    </pre>
D
Add two new security label types  
Daniel P. Berrange 已提交
8083 8084 8085 8086 8087 8088 8089 
    <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>
D
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
8090 8091 8092 8093 8094 8095 8096 8097 8098 
    <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>
D
Add two new security label types  
Daniel P. Berrange 已提交
8099 8100 8101 
      <dd>Either <code>static</code>, <code>dynamic</code> or <code>none</code>
        to determine whether libvirt automatically generates a unique security
        label or not.
D
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 
      </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
M
doc: update description about security labels on formatdomain.html  
Marcelo Cerri 已提交
8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 
        of the content depends on the security driver in use:
        <ul>
          <li>SELinux: a SELinux context.</li>
          <li>AppArmor: an AppArmor profile.</li>
          <li>
            DAC: owner and group separated by colon. They can be
            defined both as user/group names or uid/gid. The driver will first
            try to parse these values as names, but a leading plus sign can
            used to force the driver to parse them as uid or gid.
          </li>
        </ul>
D
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
8126 8127 8128 
      </dd>
      <dt><code>baselabel</code></dt>
      <dd>If dynamic labelling is used, this can optionally be
P
doc: Clarify usage of SELinux baselabel  
Peter Krempa 已提交
8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 
        used to specify the base security label that will be used to generate
        the actual label. The format of the content depends on the security
        driver in use.

        The SELinux driver uses only the <code>type</code> field of the
        baselabel in the generated label. Other fields are inherited from
        the parent process when using SELinux baselabels.

        (The example above demonstrates the use of <code>my_svirt_t</code>
        as the value for the <code>type</code> field.)
D
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
8139 8140 8141 8142 8143 8144 8145 8146 
      </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>
E
seclabel: extend XML to allow per-disk label overrides  
Eric Blake 已提交
8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 
    <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
E
selinux: distinguish failure to label from request to avoid label  
Eric Blake 已提交
8157 8158 8159 8160 8161 
      sub-element <code>label</code> are supported.  Additionally,
      <span class="since">since 1.1.2</span>, an output-only
      element <code>labelskip</code> will be present for active
      domains on disks where labeling was skipped due to the image
      being on a file system that lacks security labeling.
E
seclabel: extend XML to allow per-disk label overrides  
Eric Blake 已提交
8162 8163 
    </p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
8164 
    <h3><a id="keywrap">Key Wrap</a></h3>
T
libvirt: Introduce protected key mgmt ops  
Tony Krowiak 已提交
8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 

       <p>The content of the optional <code>keywrap</code> element specifies
        whether the guest will be allowed to perform the S390 cryptographic key
        management operations. A clear key can be protected by encrypting it
        under a unique wrapping key that is generated for each guest VM running
        on the host. Two variations of wrapping keys are generated: one version
        for encrypting protected keys using the DEA/TDEA algorithm, and another
        version for keys encrypted using the AES algorithm. If a
        <code>keywrap</code> element is not included, the guest will be granted
        access to both AES and DEA/TDEA key wrapping by default.</p>

        <pre>
&lt;domain&gt;
  ...
  &lt;keywrap&gt;
    &lt;cipher name='aes' state='off'/&gt;
  &lt;/keywrap&gt;
  ...
&lt;/domain&gt;
</pre>
    <p>
      At least one <code>cipher</code> element must be nested within the
      <code>keywrap</code> element.
    </p>
    <dl>
      <dt><code>cipher</code></dt>
      <dd>The <code>name</code> attribute identifies the algorithm
        for encrypting a protected key. The values supported for this attribute
        are <code>aes</code> for encryption under the AES wrapping key, or
        <code>dea</code> for encryption under the DEA/TDEA wrapping key. The
        <code>state</code> attribute indicates whether the cryptographic key
        management operations should be turned on for the specified encryption
        algorithm. The value can be set to <code>on</code> or <code>off</code>.
      </dd>
    </dl>

    <p>Note: DEA/TDEA is synonymous with DES/TDES.</p>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
8203 
    <h2><a id="examples">Example configs</a></h2>
D
Split website out into one file per page. APply new layout and styling  
Daniel P. Berrange 已提交
8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 

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