Skip to content

L
libvirt

openeuler / libvirt

通知 3
Star 0
Fork 0
L
libvirt

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

切换分支/标签
查找文件 普通视图历史永久链接Permalink
formatdomain.html.in 250.0 KB
Newer Older
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
1 2 3 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<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 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 
    <ul id="toc"></ul>

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


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

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


    <h3><a name="elementsMetadata">General metadata</a></h3>
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 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 

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

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

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

    <p>
      Booting via the BIOS is available for hypervisors supporting
      full virtualization. In this case the BIOS has a boot order
      priority (floppy, harddisk, cdrom, network) determining where
      to obtain/find the boot image.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
101 102 103 104 
<pre>
  ...
  &lt;os&gt;
    &lt;type&gt;hvm&lt;/type&gt;
M
formatdomain: Update <loader/> example to match the rest  
Michal Privoznik 已提交
105 
    &lt;loader readonly='yes' type='rom'&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
M
qemu: Automatically create NVRAM store  
Michal Privoznik 已提交
106 
    &lt;nvram template='/usr/share/OVMF/OVMF_VARS.fd'&gt;/var/lib/libvirt/nvram/guest_VARS.fd&lt;/nvram&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
107 
    &lt;boot dev='hd'/&gt;
C
qemu: Allow setting boot menu on/off  
Cole Robinson 已提交
108 
    &lt;boot dev='cdrom'/&gt;
M
docs, conf: add support for bootmenu timeout  
Martin Kletzander 已提交
109 
    &lt;bootmenu enable='yes' timeout='3000'/&gt;
E
docs: document <sysinfo> and <smbios> elements  
Eric Blake 已提交
110 
    &lt;smbios mode='sysinfo'/&gt;
M
Add support for reboot-timeout  
Martin Kletzander 已提交
111 
    &lt;bios useserial='yes' rebootTimeout='0'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
112 113 
  &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 129 
      <dt><code>loader</code></dt>
      <dd>The optional <code>loader</code> tag refers to a firmware blob
C
docs: update docs for setting the QEMU BIOS path  
Chen Hanxiao 已提交
130 131 132 
        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 已提交
133 134 135 136 137 138 139 140 141 142 143 144 
        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
        <code>pflash</code>.</dd>
      <dt><code>nvram</code></dt>
      <dd>Some UEFI firmwares may want to use a non-volatile memory to store
M
qemu: Automatically create NVRAM store  
Michal Privoznik 已提交
145 146 147 148 149 
        some variables. In the host, this is represented as a file and the 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>
        attribute can be used to per domain override map of master NVRAM stores
M
docs: Document NVRAM behavior on transient domains  
Michal Privoznik 已提交
150 151 152 153 
        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 已提交
154 155 
      <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 已提交
156 157 
        "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 已提交
158 159 160 161 162 163 164 165 166 167 168 169 
        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 已提交
170 
        <a href="#elementsNICS">network interfaces</a>, and
P
doc: Fix reference to #elementsUSB  
Philipp Hahn 已提交
171 
        <a href="#elementsHostDev">USB and PCI devices</a> sections below) were
J
docs: Enhance documentation of the old-style boot configuration  
Jiri Denemark 已提交
172 173 174 175 
        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 已提交
176 
      </dd>
M
docs: Document some -boot option limitations on UEFI  
Michal Privoznik 已提交
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 
      <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 已提交
202 203 204 205 206 
      <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 已提交
207 208 
      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 已提交
209 210 
      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 已提交
211 
      </dd>
M
bios: Add support for SGA  
Michal Privoznik 已提交
212 213 214 215 216 217 
      <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 已提交
218 219 220 221 222 223 224 
        <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 已提交
225 
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
226 227 228 229 230 231 232 
    </dl>

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

    <p>
      Hypervisors employing paravirtualization do not usually emulate
      a BIOS, and instead the host is responsible to kicking off the
A
fix typos in docs  
Atsushi SAKAI 已提交
233 
      operating system boot. This may use a pseudo-bootloader in the
D
Update domain XML docs  
Daniel P. Berrange 已提交
234 
      host to provide an interface to choose a kernel for the guest.
C
bhyve: Support /domain/bootloader configuration for non-FreeBSD guests.  
Conrad Meyer 已提交
235 236 237 
      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 已提交
238 239 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
240 241 242 243 244 
<pre>
  ...
  &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 已提交
245 246 247 248 

    <dl>
      <dt><code>bootloader</code></dt>
      <dd>The content of the <code>bootloader</code> element provides
M
Cleanup whitespace in docs  
Matthew Booth 已提交
249 250 251 252 
        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 已提交
253 254 
      <dt><code>bootloader_args</code></dt>
      <dd>The optional <code>bootloader_args</code> element allows
M
Cleanup whitespace in docs  
Matthew Booth 已提交
255 256 257 
        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 已提交
258 259 260 261 262 263 264 265 266 267 268 269 

    </dl>

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

    <p>
      When installing a new guest OS it is often useful to boot directly
      from a kernel and initrd stored in the host OS, allowing command
      line arguments to be passed directly to the installer. This capability
      is usually available for both para and full virtualized guests.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
270 271 272 273 274 275 276 277 
<pre>
  ...
  &lt;os&gt;
    &lt;type&gt;hvm&lt;/type&gt;
    &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
    &lt;kernel&gt;/root/f8-i386-vmlinuz&lt;/kernel&gt;
    &lt;initrd&gt;/root/f8-i386-initrd&lt;/initrd&gt;
    &lt;cmdline&gt;console=ttyS0 ks=http://example.com/f8-i386/os/&lt;/cmdline&gt;
O
conf: support <dtb> tag in XML domain file  
Olivia Yin 已提交
278 
    &lt;dtb&gt;/root/ppc.dtb&lt;/dtb&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
279 280 
  &lt;/os&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
281 282 283 284 

    <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 已提交
285 
        <a href="#elementsOSBIOS">BIOS boot section</a></dd>
D
"copy-paste" errors  
Daniel Veillard 已提交
286 
      <dt><code>loader</code></dt>
D
Update domain XML docs  
Daniel P. Berrange 已提交
287 
      <dd>This element has the same semantics as described earlier in the
M
Cleanup whitespace in docs  
Matthew Booth 已提交
288 
        <a href="#elementsOSBIOS">BIOS boot section</a></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
289 290 
      <dt><code>kernel</code></dt>
      <dd>The contents of this element specify the fully-qualified path
M
Cleanup whitespace in docs  
Matthew Booth 已提交
291 
        to the kernel image in the host OS.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
292 293 
      <dt><code>initrd</code></dt>
      <dd>The contents of this element specify the fully-qualified path
M
Cleanup whitespace in docs  
Matthew Booth 已提交
294 
        to the (optional) ramdisk image in the host OS.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
295 296 
      <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 已提交
297 
        the kernel (or installer) at boot time. This is often used to
M
Cleanup whitespace in docs  
Matthew Booth 已提交
298 299 
        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 已提交
300 301 302 303 
      <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>
D
Update domain XML docs  
Daniel P. Berrange 已提交
304 305 
    </dl>
D
Update docs about user namespace for LXC  
Daniel P. Berrange 已提交
306 
    <h4><a name="elementsOSContainer">Container boot</a></h4>
D
Add support for setting init argv for LXC  
Daniel P. Berrange 已提交
307 308 309 310 311 312 313 314 

    <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 已提交
315 
      but will not affect init argv.
D
Add support for setting init argv for LXC  
Daniel P. Berrange 已提交
316 317 318 319 320 321 322 323 324 325 326 327 
    </p>

    <pre>
  &lt;os&gt;
    &lt;type arch='x86_64'&gt;exe&lt;/type&gt;
    &lt;init&gt;/bin/systemd&lt;/init&gt;
    &lt;initarg&gt;--unit&lt;/initarg&gt;
    &lt;initarg&gt;emergency.service&lt;/initarg&gt;
  &lt;/os&gt;
    </pre>
G
LXC: Introduce New XML element for user namespace  
Gao feng 已提交
328 
    <p>
C
docs: grammar fixes in formatdomain  
Chen Hanxiao 已提交
329 330 
      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 已提交
331 332 333 334 
    </p>

    <dl>
      <dt><code>start</code></dt>
C
LXC: emphasis uid start of idmap only accept '0' in docs  
Chen Hanxiao 已提交
335 
      <dd>First user ID in container. It must be '0'.</dd>
G
LXC: Introduce New XML element for user namespace  
Gao feng 已提交
336 
      <dt><code>target</code></dt>
C
docs: grammar fixes in formatdomain  
Chen Hanxiao 已提交
337 338 
      <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 已提交
339 
      <dt><code>count</code></dt>
C
docs: grammar fixes in formatdomain  
Chen Hanxiao 已提交
340 
      <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 已提交
341 342 343 344 345 346 347 348 349 350 
    </dl>

    <pre>
  &lt;idmap&gt;
    &lt;uid start='0' target='1000' count='10'/&gt;
    &lt;gid start='0' target='1000' count='10'/&gt;
  &lt;/idmap&gt;
    </pre>
E
docs: document <sysinfo> and <smbios> elements  
Eric Blake 已提交
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 
    <h3><a name="elementsSysinfo">SMBIOS System Information</a></h3>

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

<pre>
  ...
  &lt;os&gt;
    &lt;smbios mode='sysinfo'/&gt;
    ...
  &lt;/os&gt;
  &lt;sysinfo type='smbios'&gt;
    &lt;bios&gt;
      &lt;entry name='vendor'&gt;LENOVO&lt;/entry&gt;
    &lt;/bios&gt;
    &lt;system&gt;
      &lt;entry name='manufacturer'&gt;Fedora&lt;/entry&gt;
J
docs: Fix/update syntax in Sysinfo/SMBIOS description  
John Ferlan 已提交
374 375 
      &lt;entry name='product'&gt;Virt-Manager&lt;/entry&gt;
      &lt;entry name='version'&gt;0.9.4&lt;/entry&gt;
E
docs: document <sysinfo> and <smbios> elements  
Eric Blake 已提交
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 
    &lt;/system&gt;
  &lt;/sysinfo&gt;
  ...</pre>

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

    <dl>
      <dt><code>smbios</code></dt>
      <dd>Sub-elements call out specific SMBIOS values, which will
      affect the guest if used in conjunction with
      the <code>smbios</code> sub-element of
      the <a href="#elementsOS"><code>os</code></a> element.  Each
      sub-element of <code>sysinfo</code> names a SMBIOS block, and
      within those elements can be a list of <code>entry</code>
      elements that describe a field within the block.  The following
      blocks and entries are recognized:
        <dl>
          <dt><code>bios</code></dt>
          <dd>
J
docs: Fix/update syntax in Sysinfo/SMBIOS description  
John Ferlan 已提交
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 
            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 已提交
414 415 416 
          </dd>
          <dt><code>system</code></dt>
          <dd>
J
docs: Fix/update syntax in Sysinfo/SMBIOS description  
John Ferlan 已提交
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 
            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>
            NB: Incorrectly supplied entries in either the <code>bios</code>
            or <code>system</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 已提交
442 443 444 445 446 
          </dd>
        </dl>
      </dd>
    </dl>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
447 
    <h3><a name="elementsCPUAllocation">CPU Allocation</a></h3>
D
Update domain XML docs  
Daniel P. Berrange 已提交
448
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
449 
<pre>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
450 
&lt;domain&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
451 
  ...
O
qemu: Support numad  
Osier Yang 已提交
452 
  &lt;vcpu placement='static' cpuset="1-4,^3,6" current="1"&gt;2&lt;/vcpu&gt;
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
453 454 455 
  ...
&lt;/domain&gt;
</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
456 457 458 

    <dl>
      <dt><code>vcpu</code></dt>
E
vcpu: add current attribute to <vcpu> element  
Eric Blake 已提交
459 
      <dd>The content of this element defines the maximum number of virtual
E
vcpu: improve cpuset attribute  
Eric Blake 已提交
460 
        CPUs allocated for the guest OS, which must be between 1 and
J
formatdomain: Reformat vCPU description  
John Ferlan 已提交
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 
        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 已提交
505 
      </dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
506 507 
    </dl>
J
domain_conf: Introduce iothreads XML  
John Ferlan 已提交
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 
    <h3><a name="elementsIOThreadsAllocation">IOThreads Allocation</a></h3>
      <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;
</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
B
qemu: Allow use of iothreads for virtio ccw disk definitions  
Boris Fiuczynski 已提交
529 530 531 
        virtio-blk-pci and virtio-blk-ccw target storage devices. There
        should be only 1 or 2 IOThreads per host CPU. There may be more
        than one supported device assigned to each IOThread.
J
domain_conf: Introduce iothreads XML  
John Ferlan 已提交
532 533 
      </dd>
    </dl>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
534 535 536 537 538 539 540 541 542 543 544 

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

<pre>
&lt;domain&gt;
  ...
  &lt;cputune&gt;
    &lt;vcpupin vcpu="0" cpuset="1-4,^2"/&gt;
    &lt;vcpupin vcpu="1" cpuset="0,1"/&gt;
    &lt;vcpupin vcpu="2" cpuset="2,3"/&gt;
    &lt;vcpupin vcpu="3" cpuset="0,4"/&gt;
J
docs: Fix typo in CPU tuning  
Jiri Denemark 已提交
545 
    &lt;emulatorpin cpuset="1-3"/&gt;
J
domain_conf: Add iothreadpin to cputune  
John Ferlan 已提交
546 547 
    &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 已提交
548 549 550 
    &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 已提交
551 552 
    &lt;emulator_period&gt;1000000&lt;/emulator_period&gt;
    &lt;emulator_quota&gt;-1&lt;/emulator_quota&gt;
M
docs, schema, conf: Add support for setting scheduler parameters of guest threads  
Martin Kletzander 已提交
553 554 
    &lt;vcpusched vcpus='0-4,^3' scheduler='fifo' priority='1'/&gt;
    &lt;iothreadsched iothreads='2' scheduler='batch'/&gt;
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
555 556 557 558 559 560 
  &lt;/cputune&gt;
  ...
&lt;/domain&gt;
</pre>

    <dl>
O
cputune: Add document for cputune XML  
Osier Yang 已提交
561 
      <dt><code>cputune</code></dt>
O
docs: Fix documentation for cputune parameters  
Osier Yang 已提交
562 563 564 565 566 
      <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 已提交
567 
      <dt><code>vcpupin</code></dt>
O
docs: Fix documentation for cputune parameters  
Osier Yang 已提交
568 
      <dd>
M
docs: CPU allocation and pinning clarification  
Martin Kletzander 已提交
569 
        The optional <code>vcpupin</code> element specifies which of host's
O
doc: Sort out the relationship between <vcpu>, <vcpupin>, and <emulatorpin>  
Osier Yang 已提交
570 571 572 573 574 575 576 
        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 已提交
577 578 
        <span class="since">Since 0.9.0</span>
       </dd>
T
Support emulatorpin xml parse.  
Tang Chen 已提交
579 580 581 
       <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 已提交
582 583 
         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 已提交
584 585 586 
         <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 已提交
587 
         CPUs to pin to.
T
Support emulatorpin xml parse.  
Tang Chen 已提交
588 
       </dd>
J
domain_conf: Add iothreadpin to cputune  
John Ferlan 已提交
589 590 591 592 593 594 595 596 597 598 599 600 601 602 
       <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
         <code>iothread</code> specifies the IOThread id and the attribute
         <code>cpuset</code> specifying which physical CPUs to pin to. The
         <code>iothread</code> value begins at "1" through the number of
          <a href="#elementsIOThreadsAllocation"><code>iothreads</code></a>
         allocated to the domain. A value of "0" is not permitted.
        <span class="since">Since 1.2.9</span>
       </dd>
O
cputune: Add document for cputune XML  
Osier Yang 已提交
603 
      <dt><code>shares</code></dt>
O
docs: Fix documentation for cputune parameters  
Osier Yang 已提交
604 605 
      <dd>
        The optional <code>shares</code> element specifies the proportional
C
docs: fix 'omitted' typo in <cputune> doc  
Christophe Fergeau 已提交
606 
        weighted share for the domain. If this is omitted, it defaults to
E
docs: minor whitespace cleanups  
Eric Blake 已提交
607 608 609 
        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 已提交
610 611 612 
        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 已提交
613 614 615 616 617 618 
      <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 已提交
619 620 621 
        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 已提交
622 623 624 625 626 627 628 629 630 
      </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 已提交
631 632 633 
        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 已提交
634 
      </dd>
H
qemu: introduce period/quota tuning for emulator  
Hu Tao 已提交
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 

      <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>
M
docs, schema, conf: Add support for setting scheduler parameters of guest threads  
Martin Kletzander 已提交
657 658 659 660 661 662 663 664 665 666 
      <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
        <code>vcpus</code>/<code>iothreads</code> sets the default).  For
        real-time schedulers (<code>fifo</code>, <code>rr</code>), priority must
        be specified as 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 已提交
667 
        <span class="since">Since 1.2.13</span>
M
docs, schema, conf: Add support for setting scheduler parameters of guest threads  
Martin Kletzander 已提交
668 669 
      </dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
670 671 672 673 674 675 676 677 
    </dl>


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

<pre>
&lt;domain&gt;
  ...
P
conf: Add support for parsing and formatting max memory and slot count  
Peter Krempa 已提交
678 
  &lt;maxMemory slots='16' unit='KiB'&gt;1524288&lt;/maxMemory&gt;
E
xml: allow scaled memory on input  
Eric Blake 已提交
679 680 
  &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 已提交
681 682 683 684 685 686 687 
  ...
&lt;/domain&gt;
</pre>

    <dl>
      <dt><code>memory</code></dt>
      <dd>The maximum allocation of memory for the guest at boot time.
E
xml: allow scaled memory on input  
Eric Blake 已提交
688 
        The units for this value are determined by the optional
Y
Fix some typos in messages, docs and comments.  
Yuri Chornoivan 已提交
689 
        attribute <code>unit</code>, which defaults to "KiB"
E
xml: allow scaled memory on input  
Eric Blake 已提交
690 691 692 693 694 695 696 697 698 699 700 701 702 
        (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 已提交
703 704 705 706 707 708 709 710 711 
        minimum, such as 4000KiB.

        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 已提交
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 
      <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.
        <span class='since'>Since 1.2.14</span>
      </dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
731 732 733 734 
      <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 已提交
735 736 737 
        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 已提交
738 739 740 741 742 743 744 745 746 
    </dl>


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

<pre>
&lt;domain&gt;
  ...
  &lt;memoryBacking&gt;
M
domain: Introduce ./hugepages/page/[@size, @unit, @nodeset]  
Michal Privoznik 已提交
747 748 749 
    &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 已提交
750 
    &lt;/hugepages&gt;
O
qemu: New XML to disable memory merge at guest startup  
Osier Yang 已提交
751 
    &lt;nosharepages/&gt;
J
Add support for locking domain's memory pages  
Jiri Denemark 已提交
752 
    &lt;locked/&gt;
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
753 754 755 756 757 
  &lt;/memoryBacking&gt;
  ...
&lt;/domain&gt;
</pre>
J
Add support for locking domain's memory pages  
Jiri Denemark 已提交
758 759 760 761 
    <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 已提交
762 
    <dl>
J
Add support for locking domain's memory pages  
Jiri Denemark 已提交
763 764 
      <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 已提交
765 766 767 768 769 770 771 772 773 774 775 776 777 
      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 已提交
778 779 780 781 782 783 
      <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
J
docs: Enhance memoryBacking/locked documentation  
Jiri Denemark 已提交
784 
        be allowed to swap them out. For QEMU/KVM this requires
E
docs: fix recent typo  
Eric Blake 已提交
785 
        <code>hard_limit</code> <a href="#elementsMemoryTuning">memory tuning</a>
J
docs: Enhance memoryBacking/locked documentation  
Jiri Denemark 已提交
786 787 
        element to be used and set to the maximum memory configured for the
        domain plus any memory consumed by the QEMU process itself.
J
Add support for locking domain's memory pages  
Jiri Denemark 已提交
788 
        <span class="since">Since 1.0.6</span></dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
789 790 791 792 793 794 795 796 797 
    </dl>


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

<pre>
&lt;domain&gt;
  ...
  &lt;memtune&gt;
E
xml: allow scaled memory on input  
Eric Blake 已提交
798 799 800 801 
    &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 已提交
802 803 804 805 806 807 808 809 810 811 812 813 814 
  &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 已提交
815 816 817 818 819 820 
        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 已提交
821 822 823 
        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 已提交
824 825 
      <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 已提交
826 
        the guest can use. The units for this value are kibibytes (i.e. blocks
M
docs: Discourage users to set hard_limit  
Michal Privoznik 已提交
827 
        of 1024 bytes). <strong>However, users of QEMU and KVM are strongly
M
docs: Clean 09adfdc62de2b up  
Michal Privoznik 已提交
828 829 830 
        advised not to set this limit as domain may get killed by the kernel
        if the guess is too low. To determine the memory needed for a process
        to run is an
M
docs: Discourage users to set hard_limit  
Michal Privoznik 已提交
831 832 
        <a href="http://en.wikipedia.org/wiki/Undecidable_problem">
        undecidable problem</a>.</strong></dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
833 834 835 
      <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 已提交
836 
        kibibytes (i.e. blocks of 1024 bytes)</dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
837 838 839 
      <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 已提交
840 
        kibibytes (i.e. blocks of 1024 bytes). This has to be more than
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
841 842 843 844 
        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 已提交
845 846 
        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 已提交
847 848 849 850 851 852 853 854 855 856 
    </dl>


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

<pre>
&lt;domain&gt;
  ...
  &lt;numatune&gt;
    &lt;memory mode="strict" nodeset="1-4,^3"/&gt;
M
conf, schema: add support for memnode elements  
Martin Kletzander 已提交
857 858 
    &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 已提交
859 860 861 862 863 864 
  &lt;/numatune&gt;
  ...
&lt;/domain&gt;
</pre>

    <dl>
O
numatune: Add doc for new numatune XML  
Osier Yang 已提交
865 866 867 868 869 870 
      <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 已提交
871 
      </dd>
O
numatune: Add doc for new numatune XML  
Osier Yang 已提交
872 873 
      <dt><code>memory</code></dt>
      <dd>
O
qemu: Support numad  
Osier Yang 已提交
874 
        The optional <code>memory</code> element specifies how to allocate memory
O
numad: Set memory policy from numad advisory nodeset  
Osier Yang 已提交
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 
        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 已提交
893 894 
        <span class='since'>Since 0.9.3</span>
      </dd>
M
conf, schema: add support for memnode elements  
Martin Kletzander 已提交
895 896 897 898 899 900 901 902 903 904 905 906 907 
      <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 已提交
908 909 
    </dl>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
910 911 912 913 914 915 916 

    <h3><a name="elementsBlockTuning">Block I/O Tuning</a></h3>
<pre>
&lt;domain&gt;
  ...
  &lt;blkiotune&gt;
    &lt;weight&gt;800&lt;/weight&gt;
H
blkiotune: add interface for blkiotune.device_weight  
Hu Tao 已提交
917 918 919 920 921 922 923 924 
    &lt;device&gt;
      &lt;path&gt;/dev/sda&lt;/path&gt;
      &lt;weight&gt;1000&lt;/weight&gt;
    &lt;/device&gt;
    &lt;device&gt;
      &lt;path&gt;/dev/sdb&lt;/path&gt;
      &lt;weight&gt;500&lt;/weight&gt;
    &lt;/device&gt;
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
925 926 927 928 929 930 931 932 933 
  &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 已提交
934 935 
        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 已提交
936 
      <dt><code>weight</code></dt>
H
blkiotune: add interface for blkiotune.device_weight  
Hu Tao 已提交
937 938 
      <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 已提交
939 940 
        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 已提交
941 942 943 944 945 946 947 948 
      <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 已提交
949 950 951 952 953 
        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 已提交
954 955 956 
        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 已提交
957 958 
        1000]. After kernel 2.6.39, the value could be in the
        range [10, 1000].<span class="since">Since 0.9.8</span></dd>
C
docs: Break up 'Basic Resources' XML section  
Cole Robinson 已提交
959 960 961 
    </dl>
D
Add XML config for resource partitions  
Daniel P. Berrange 已提交
962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 
    <h3><a name="resPartition">Resource partitioning</a></h3>

    <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
      element <code>partition</code> whose content defines the path
      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>
  ...
  &lt;resource&gt;
    &lt;partition&gt;/virtualmachines/production&lt;/partition&gt;
  &lt;/resource&gt;
  ...
</pre>

    <p>
      Resource partitions are currently supported by the QEMU and
E
docs: fix usage of 'onto'  
Eric Blake 已提交
987 
      LXC drivers, which map partition paths to cgroups directories,
D
Add XML config for resource partitions  
Daniel P. Berrange 已提交
988 989 990 
      in all mounted controllers. <span class="since">Since 1.0.5</span>
    </p>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
991 992 993 994 995 996 997 998 
    <h3><a name="elementsCPU">CPU model and topology</a></h3>

    <p>
      Requirements for CPU model, its features and topology can be specified
      using the following collection of elements.
      <span class="since">Since 0.7.5</span>
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
999 1000 1001 
<pre>
  ...
  &lt;cpu match='exact'&gt;
J
cpu: Optionally forbid fallback CPU models  
Jiri Denemark 已提交
1002 
    &lt;model fallback='allow'&gt;core2duo&lt;/model&gt;
J
cpu: Add support for CPU vendor  
Jiri Denemark 已提交
1003 
    &lt;vendor&gt;Intel&lt;/vendor&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1004 1005 1006 1007 
    &lt;topology sockets='1' cores='2' threads='1'/&gt;
    &lt;feature policy='disable' name='lahf_lm'/&gt;
  &lt;/cpu&gt;
  ...</pre>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1008
J
Add support for cpu mode attribute  
Jiri Denemark 已提交
1009 1010 1011 1012 1013 1014 1015 1016 1017 
<pre>
  &lt;cpu mode='host-model'&gt;
    &lt;model fallback='forbid'/&gt;
    &lt;topology sockets='1' cores='2' threads='1'/&gt;
  &lt;/cpu&gt;
  ...</pre>

<pre>
  &lt;cpu mode='host-passthrough'/&gt;
M
qemu: Allow enabling/disabling features with host-passthrough  
Martin Kletzander 已提交
1018 
    &lt;feature policy='disable' name='lahf_lm'/&gt;
J
Add support for cpu mode attribute  
Jiri Denemark 已提交
1019 1020 
  ...</pre>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1021 1022 1023 1024 1025 1026 
    <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 已提交
1027 1028 1029 1030 1031 1032 
<pre>
  ...
  &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 已提交
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 

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

        <dl>
          <dt><code>minimum</code></dt>
          <dd>The specified CPU model and features describes the minimum
            requested CPU.</dd>
          <dt><code>exact</code></dt>
          <dd>The virtual CPU provided to the guest will exactly match the
            specification</dd>
          <dt><code>strict</code></dt>
          <dd>The guest will not be created unless the host CPU does exactly
            match the specification.</dd>
        </dl>
D
Set sensible defaults for cpu match and feature policy  
Daniel P. Berrange 已提交
1055
E
maint: whitespace cleanup  
Eric Blake 已提交
1056 1057 
        <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 已提交
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 

        <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 已提交
1076 1077 1078 1079 1080 1081 1082 1083 1084 
          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 已提交
1085 1086 1087 1088 1089 1090 1091 
          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: Expand description of host-model CPU mode  
Jiri Denemark 已提交
1092 1093 1094 1095 1096 1097 1098 1099 1100 
          the capabilities of the new host. <strong>Beware</strong>, due to the
          way libvirt detects host CPU and due to the fact libvirt does not
          talk to QEMU/KVM when creating the CPU model, CPU configuration
          created using <code>host-model</code> may not work as expected. The
          guest CPU may differ from the configuration and it may also confuse
          guest OS by using a combination of CPU features and other parameters
          (such as CPUID level) that don't work. Until these issues are fixed,
          it's a good idea to avoid using <code>host-model</code> and use
          <code>custom</code> mode with just the CPU model from host
P
docs: Add documentation for compat mode.  
Prerna Saxena 已提交
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 
          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
          <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>
  &lt;cpu mode='host-model'&gt;
    &lt;model&gt;power7&lt;/model&gt;
  &lt;/cpu&gt;
  ...</pre>
          </dd>
J
Add support for cpu mode attribute  
Jiri Denemark 已提交
1115 1116 1117 1118 1119 
          <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 已提交
1120 1121 
          hit any bugs, you are on your own. Further details of that CPU can
          be changed using <code>feature</code> elements.</dd>
J
Add support for cpu mode attribute  
Jiri Denemark 已提交
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 
        </dl>

        In both <code>host-model</code> and <code>host-passthrough</code>
        mode, the real (approximate in <code>host-passthrough</code> mode) CPU
        definition which would be used on current host can be determined by
        specifying <code>VIR_DOMAIN_XML_UPDATE_CPU</code> flag when calling
        <code>virDomainGetXMLDesc</code> API. When running a guest that might
        be prone to operating system reactivation when presented with
        different hardware, and which will be migrated between hosts with
        different capabilities, you can use this output to rewrite XML to the
        <code>custom</code> mode for more robust migration.
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1133 1134 1135 1136 1137 1138 
      </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 已提交
1139 1140 1141 1142 1143 1144 1145 1146 
        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 已提交
1147 
        <code>forbid</code>. The optional <code>vendor_id</code> attribute
E
build: commit to 0.10.0 release naming  
Eric Blake 已提交
1148 
        (<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 已提交
1149 1150 1151 
        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 已提交
1152
J
cpu: Add support for CPU vendor  
Jiri Denemark 已提交
1153 1154 1155 1156 1157 1158 1159 
      <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 已提交
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 
      <dt><code>topology</code></dt>
      <dd>The <code>topology</code> element specifies requested topology of
        virtual CPU provided to the guest. Three non-zero values have to be
        given for <code>sockets</code>, <code>cores</code>, and
        <code>threads</code>: total number of CPU sockets, number of cores per
        socket, and number of threads per core, respectively.</dd>

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

        <dl>
          <dt><code>force</code></dt>
          <dd>The virtual CPU will claim the feature is supported regardless
            of it being supported by host CPU.</dd>
          <dt><code>require</code></dt>
          <dd>Guest creation will fail unless the feature is supported by host
            CPU.</dd>
          <dt><code>optional</code></dt>
          <dd>The feature will be supported by virtual CPU if and only if it
            is supported by host CPU.</dd>
          <dt><code>disable</code></dt>
          <dd>The feature will not be supported by virtual CPU.</dd>
          <dt><code>forbid</code></dt>
          <dd>Guest creation will fail if the feature is supported by host
            CPU.</dd>
        </dl>
D
Set sensible defaults for cpu match and feature policy  
Daniel P. Berrange 已提交
1191
E
maint: whitespace cleanup  
Eric Blake 已提交
1192 1193 
        <span class="since">Since 0.8.5</span> the <code>policy</code>
        attribute can be omitted and will default to <code>require</code>.
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
1194 1195 1196 
      </dd>
    </dl>
B
XML definitions for guest NUMA and parsing routines  
Bharata B Rao 已提交
1197 
    <p>
Y
Fix minor typos in messages and docs  
Yuri Chornoivan 已提交
1198 
      Guest NUMA topology can be specified using the <code>numa</code> element.
B
XML definitions for guest NUMA and parsing routines  
Bharata B Rao 已提交
1199 1200 1201 1202 1203 1204 1205 1206 
      <span class="since">Since 0.9.8</span>
    </p>

<pre>
  ...
  &lt;cpu&gt;
    ...
    &lt;numa&gt;
P
cpu_conf: Allow specification of 'units' for @memory on numa nodes.  
Prerna Saxena 已提交
1207 1208 
      &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;
B
XML definitions for guest NUMA and parsing routines  
Bharata B Rao 已提交
1209 1210 1211 1212 1213 1214 1215 
    &lt;/numa&gt;
    ...
  &lt;/cpu&gt;
  ...</pre>

    <p>
      Each <code>cell</code> element specifies a NUMA cell or a NUMA node.
M
conf, schema: add 'id' field for cells  
Martin Kletzander 已提交
1216 1217 1218 
      <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 已提交
1219 1220 1221 
      <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 已提交
1222 1223 1224 1225 1226 1227 
      <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 已提交
1228 1229 1230 1231 1232 

      <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
      hugepages-backed memory.
B
XML definitions for guest NUMA and parsing routines  
Bharata B Rao 已提交
1233 1234 1235 1236 1237 1238 
    </p>

    <p>
      This guest NUMA specification is currently available only for QEMU/KVM.
    </p>
J
conf: Rename life cycle actions to event actions  
Jiri Denemark 已提交
1239 
    <h3><a name="elementsEvents">Events configuration</a></h3>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1240 1241 

    <p>
A
fix typos in docs  
Atsushi SAKAI 已提交
1242 
      It is sometimes necessary to override the default actions taken
J
docs: Update formatdomain for lifecycle events  
John Ferlan 已提交
1243 1244 
      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 已提交
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 
      <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 已提交
1255 1256 
      Using <code>virsh reboot</code> or <code>virsh shutdown</code> would
      also trigger the event.
D
Update domain XML docs  
Daniel P. Berrange 已提交
1257 1258 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1259 1260 1261 1262 1263 
<pre>
  ...
  &lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
  &lt;on_reboot&gt;restart&lt;/on_reboot&gt;
  &lt;on_crash&gt;restart&lt;/on_crash&gt;
J
conf: Add on_lockfailure event configuration  
Jiri Denemark 已提交
1264 
  &lt;on_lockfailure&gt;poweroff&lt;/on_lockfailure&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1265 
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1266
J
conf: Rename life cycle actions to event actions  
Jiri Denemark 已提交
1267 1268 1269 1270 1271 1272 1273 
    <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 已提交
1274 1275 1276 
    <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 已提交
1277 
        the guest requests a poweroff.</dd>
D
"copy-paste" errors  
Daniel Veillard 已提交
1278 
      <dt><code>on_reboot</code></dt>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1279 
      <dd>The content of this element specifies the action to take when
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1280 
        the guest requests a reboot.</dd>
D
"copy-paste" errors  
Daniel Veillard 已提交
1281 
      <dt><code>on_crash</code></dt>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1282 
      <dd>The content of this element specifies the action to take when
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1283 
        the guest crashes.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1284 1285 1286 1287 1288 1289 1290 1291 1292 
    </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 已提交
1293 
        released.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1294 
      <dt><code>restart</code></dt>
J
docs: Update formatdomain for lifecycle events  
John Ferlan 已提交
1295 1296 
      <dd>The domain will be terminated and then restarted with
        the same configuration.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1297 
      <dt><code>preserve</code></dt>
J
docs: Update formatdomain for lifecycle events  
John Ferlan 已提交
1298 
      <dd>The domain will be terminated and its resource preserved
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1299 
        to allow analysis.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1300 
      <dt><code>rename-restart</code></dt>
J
docs: Update formatdomain for lifecycle events  
John Ferlan 已提交
1301 1302 
      <dd>The domain will be terminated and then restarted with
        a new name.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1303 1304 
    </dl>
J
Add actions to virDomainLifecycle enum  
Jim Fehlig 已提交
1305 
    <p>
J
docs: Update formatdomain for lifecycle events  
John Ferlan 已提交
1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 
    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 已提交
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 
      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>
J
conf: Add on_lockfailure event configuration  
Jiri Denemark 已提交
1329 1330 
    <p>
      The <code>on_lockfailure</code> element (<span class="since">since
E
maint: prepare for next release number  
Eric Blake 已提交
1331 
      1.0.0</span>) may be used to configure what action should be
J
conf: Add on_lockfailure event configuration  
Jiri Denemark 已提交
1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 
      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>
M
Add per-guest S3/S4 state configuration  
Martin Kletzander 已提交
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 
    <h3><a name="elementsPowerManagement">Power Management</a></h3>

    <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>
  ...
  &lt;pm&gt;
    &lt;suspend-to-disk enabled='no'/&gt;
Z
Correct name of domain/pm/suspend-to-mem in docs  
Zeeshan Ali (Khattak) 已提交
1362 
    &lt;suspend-to-mem enabled='yes'/&gt;
M
Add per-guest S3/S4 state configuration  
Martin Kletzander 已提交
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 
  &lt;/pm&gt;
  ...</pre>

    <dl>
      <dt><code>pm</code></dt>
      <dd>These elements enable ('yes') or disable ('no') BIOS support
        for S3 (suspend-to-disk) and S4 (suspend-to-mem) ACPI sleep
        states. If nothing is specified, then the hypervisor will be
        left with its default value.</dd>
    </dl>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1374 1375 1376 1377 1378 1379 1380 
    <h3><a name="elementsFeatures">Hypervisor features</a></h3>

    <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 已提交
1381 1382 1383 1384 1385 1386 
<pre>
  ...
  &lt;features&gt;
    &lt;pae/&gt;
    &lt;acpi/&gt;
    &lt;apic/&gt;
J
Document HAP domain feature  
Jim Fehlig 已提交
1387 
    &lt;hap/&gt;
D
Add support for forcing a private network namespace for LXC guests  
Daniel P. Berrange 已提交
1388 
    &lt;privnet/&gt;
P
conf: Add support for HyperV Enlightenment features  
Peter Krempa 已提交
1389 
    &lt;hyperv&gt;
E
docs: fix some typos in examples  
Eric Blake 已提交
1390 
      &lt;relaxed state='on'/&gt;
J
conf: add vapic and spinlocks to hyperv features  
Ján Tomko 已提交
1391 
      &lt;vapic state='on'/&gt;
J
Remove leftovers from hyperv spinlocks documentation  
Ján Tomko 已提交
1392 
      &lt;spinlocks state='on' retries='4096'/&gt;
P
conf: Add support for HyperV Enlightenment features  
Peter Krempa 已提交
1393 
    &lt;/hyperv&gt;
A
Add new 'kvm' domain feature and ability to hide KVM signature  
Alex Williamson 已提交
1394 1395 1396 
    &lt;kvm&gt;
      &lt;hidden state='on'/&gt;
    &lt;/kvm&gt;
P
qemu: Add support for paravirtual spinlocks in the guest  
Peter Krempa 已提交
1397 
    &lt;pvspinlock/&gt;
P
conf: Add support for HyperV Enlightenment features  
Peter Krempa 已提交
1398
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1399 1400 
  &lt;/features&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 

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

    <dl>
      <dt><code>pae</code></dt>
      <dd>Physical address extension mode allows 32-bit guests
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1413 
        to address more than 4 GB of memory.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1414 1415 
      <dt><code>acpi</code></dt>
      <dd>ACPI is useful for power management, for example, with
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1416 
        KVM guests it is required for graceful shutdown to work.
D
Update domain XML docs  
Daniel P. Berrange 已提交
1417 
      </dd>
M
Add support for EOI with APIC  
Martin Kletzander 已提交
1418 1419 
      <dt><code>apic</code></dt>
      <dd>APIC allows the use of programmable IRQ
M
Fix minor details not only in apic eoi  
Martin Kletzander 已提交
1420 1421 1422 
      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 已提交
1423 1424 
      Interrupt) for the guest.
      </dd>
J
Document HAP domain feature  
Jim Fehlig 已提交
1425 1426 1427 1428 
      <dt><code>hap</code></dt>
      <dd>Enable use of Hardware Assisted Paging if available in
        the hardware.
      </dd>
D
Add missing docs for <viridian/> feature flag  
Daniel P. Berrange 已提交
1429 1430 1431 1432 
      <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 已提交
1433 1434 1435 1436 1437 1438 
      <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 已提交
1439 1440 1441 1442 1443 1444 1445 1446 
      <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 已提交
1447 
          <th>Since</th>
P
conf: Add support for HyperV Enlightenment features  
Peter Krempa 已提交
1448 1449 1450 
        </tr>
        <tr>
          <td>relaxed</td>
O
docs, comments: minor typo fixes  
Oskari Saarenmaa 已提交
1451 
          <td>Relax constraints on timers</td>
P
conf: Add support for HyperV Enlightenment features  
Peter Krempa 已提交
1452 
          <td> on, off</td>
J
conf: add vapic and spinlocks to hyperv features  
Ján Tomko 已提交
1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 
          <td><span class="since">1.0.0 (QEMU only)</span></td>
        </tr>
        <tr>
          <td>vapic</td>
          <td>Enable virtual APIC</td>
          <td>on, off</td>
          <td><span class="since">1.1.0 (QEMU only)</span></td>
        </tr>
        <tr>
          <td>spinlocks</td>
          <td>Enable spinlock support</td>
          <td>on, off; retries - at least 4095</td>
          <td><span class="since">1.1.0 (QEMU only)</span></td>
P
conf: Add support for HyperV Enlightenment features  
Peter Krempa 已提交
1466 1467 1468 
        </tr>
      </table>
      </dd>
P
qemu: Add support for paravirtual spinlocks in the guest  
Peter Krempa 已提交
1469 1470 1471 1472 1473 1474 
      <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 已提交
1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 
      <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>
          <td><span class="since">2.1.0 (QEMU only)</span></td>
        </tr>
      </table>
      </dd>
M
docs, schema, conf: Add support for PMU feature  
Martin Kletzander 已提交
1492 1493 1494 1495 1496 1497 
      <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>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 
    </dl>

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

    <p>
      The guest clock is typically initialized from the host clock.
      Most operating systems expect the hardware clock to be kept
      in UTC, and this is the default. Windows, however, expects
      it to be in so called 'localtime'.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1509 1510 
<pre>
  ...
D
doc: Fix time keeping example for the guest clock  
Doug Goldstein 已提交
1511 1512 1513 
  &lt;clock offset='localtime'&gt;
    &lt;timer name='rtc' tickpolicy='catchup' track='guest'&gt;
      &lt;catchup threshold='123' slew='120' limit='10000'/&gt;
E
docs: mention domain <clock> improvements  
Eric Blake 已提交
1514 
    &lt;/timer&gt;
D
doc: Fix time keeping example for the guest clock  
Doug Goldstein 已提交
1515 
    &lt;timer name='pit' tickpolicy='delay'/&gt;
E
docs: mention domain <clock> improvements  
Eric Blake 已提交
1516 
  &lt;/clock&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1517 
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1518 1519 1520 

    <dl>
      <dt><code>clock</code></dt>
D
Expand docs about clock modes  
Daniel P. Berrange 已提交
1521 
      <dd>
E
maint: whitespace cleanup  
Eric Blake 已提交
1522 1523 1524 1525 1526 1527 1528 1529 
        <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 已提交
1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 
            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 已提交
1541 1542 1543 1544 
          <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 已提交
1545 1546 
            <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 已提交
1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 
          </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 已提交
1557 1558 
            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 已提交
1559 
            in seconds, using the <code>adjustment</code> attribute.
P
documentation: trivial spelling fix  
Philipp Hahn 已提交
1560 
            The guest is free to adjust the RTC over time and expect
P
Support clock=variable relative to localtime  
Philipp Hahn 已提交
1561 1562 1563 
            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 已提交
1564 
            lost at each reboot. <span class="since">Since 0.7.7</span>
P
Support clock=variable relative to localtime  
Philipp Hahn 已提交
1565 1566 
            <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 已提交
1567 1568 1569 1570 
          </dd>
        </dl>
        <p>
          A <code>clock</code> may have zero or more
C
doc: Add missing space in <clock> documentation  
Christophe Fergeau 已提交
1571 
          <code>timer</code> sub-elements. <span class="since">Since
E
maint: whitespace cleanup  
Eric Blake 已提交
1572 1573 
          0.8.0</span>
        </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1574 
      </dd>
E
docs: mention domain <clock> improvements  
Eric Blake 已提交
1575 1576 
      <dt><code>timer</code></dt>
      <dd>
E
maint: whitespace cleanup  
Eric Blake 已提交
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 
        <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 已提交
1587 1588 1589 
            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 已提交
1590 1591 1592 1593 1594 1595 1596 
            "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 已提交
1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 
          </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 已提交
1607 1608 
            <p>
            The <code>tickpolicy</code> attribute determines what
O
docs, comments: minor typo fixes  
Oskari Saarenmaa 已提交
1609 
            happens when QEMU misses a deadline for injecting a
D
Expand docs for timer tick policy  
Daniel P. Berrange 已提交
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 
            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 已提交
1633 1634 1635 1636 1637 1638 1639 1640 1641 
            <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 已提交
1642 1643 1644 
            <p>
              Note that hypervisors are not required to support all policies across all time sources
            </p>
E
maint: whitespace cleanup  
Eric Blake 已提交
1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 
          </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 已提交
1665 
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1666 1667 1668 1669 1670 
    </dl>

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

    <p>
A
fix typos in docs  
Atsushi SAKAI 已提交
1671 
      The final set of XML elements are all used to describe devices
D
Update domain XML docs  
Daniel P. Berrange 已提交
1672 1673 1674 1675 1676 
      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 已提交
1677 1678 1679 1680 1681 1682 
<pre>
  ...
  &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 已提交
1683 1684 1685 1686 

    <dl>
      <dt><code>emulator</code></dt>
      <dd>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1687 1688 1689 1690 1691 
        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 已提交
1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 
      </dd>
    </dl>

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

    <p>
      Any device that looks like a disk, be it a floppy, harddisk,
      cdrom, or paravirtualized driver is specified via the <code>disk</code>
      element.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1703 1704 1705 
<pre>
  ...
  &lt;devices&gt;
E
snapshot: additions to domain xml for disks  
Eric Blake 已提交
1706 
    &lt;disk type='file' snapshot='external'&gt;
М
Add docs on drive <serial> element  
Марк Коренберг 已提交
1707 
      &lt;driver name="tap" type="aio" cache="default"/&gt;
E
docs: re-fix stray /  
Eric Blake 已提交
1708 
      &lt;source file='/var/lib/xen/images/fv0' startupPolicy='optional'&gt;
E
seclabel: extend XML to allow per-disk label overrides  
Eric Blake 已提交
1709 1710 
        &lt;seclabel relabel='no'/&gt;
      &lt;/source&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1711 
      &lt;target dev='hda' bus='ide'/&gt;
L
Support block I/O throttle in XML  
Lei Li 已提交
1712 1713 1714 1715 1716 
      &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;
J
Introduce per-device boot element  
Jiri Denemark 已提交
1717 
      &lt;boot order='2'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1718 1719 1720 1721 
      &lt;encryption type='...'&gt;
        ...
      &lt;/encryption&gt;
      &lt;shareable/&gt;
М
Add docs on drive <serial> element  
Марк Коренберг 已提交
1722 1723 1724 
      &lt;serial&gt;
        ...
      &lt;/serial&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1725 
    &lt;/disk&gt;
M
update docs for network disks  
MORITA Kazutaka 已提交
1726 1727 
      ...
    &lt;disk type='network'&gt;
L
qemu: support event_idx parameter for virtio disk and net devices  
Laine Stump 已提交
1728 
      &lt;driver name="qemu" type="raw" io="threads" ioeventfd="on" event_idx="off"/&gt;
M
update docs for network disks  
MORITA Kazutaka 已提交
1729 1730 1731 1732 
      &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;
J
Introduce per-device boot element  
Jiri Denemark 已提交
1733 
      &lt;boot order='1'/&gt;
E
snapshot: additions to domain xml for disks  
Eric Blake 已提交
1734 
      &lt;transient/&gt;
E
docs: document <controller> element  
Eric Blake 已提交
1735 
      &lt;address type='drive' controller='0' bus='1' unit='0'/&gt;
M
update docs for network disks  
MORITA Kazutaka 已提交
1736 
    &lt;/disk&gt;
J
storage: add auth to virDomainDiskDef  
Josh Durgin 已提交
1737 1738 1739 1740 
    &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;
P
storage: rbd: qemu: Add support for specifying internal RBD snapshots  
Peter Krempa 已提交
1741 
        &lt;snapshot name="snapname"/&gt;
P
storage: rbd: Implement support for passing config file option  
Peter Krempa 已提交
1742 
        &lt;config file="/path/to/file"/&gt;
J
storage: add auth to virDomainDiskDef  
Josh Durgin 已提交
1743 
      &lt;/source&gt;
E
docs: use unique dev names in <disk> examples  
Eric Blake 已提交
1744 
      &lt;target dev="hdc" bus="ide"/&gt;
J
storage: add auth to virDomainDiskDef  
Josh Durgin 已提交
1745 1746 1747 1748 
      &lt;auth username='myuser'&gt;
        &lt;secret type='ceph' usage='mypassid'/&gt;
      &lt;/auth&gt;
    &lt;/disk&gt;
E
snapshot: additions to domain xml for disks  
Eric Blake 已提交
1749 1750 
    &lt;disk type='block' device='cdrom'&gt;
      &lt;driver name='qemu' type='raw'/&gt;
E
docs: use unique dev names in <disk> examples  
Eric Blake 已提交
1751 
      &lt;target dev='hdd' bus='ide' tray='open'/&gt;
E
snapshot: additions to domain xml for disks  
Eric Blake 已提交
1752 1753 
      &lt;readonly/&gt;
    &lt;/disk&gt;
A
Add http protocol support for cdrom disk  
Aline Manera 已提交
1754 1755 1756 1757 1758 
    &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;
E
docs: use unique dev names in <disk> examples  
Eric Blake 已提交
1759 
      &lt;target dev='hde' bus='ide' tray='open'/&gt;
A
Add http protocol support for cdrom disk  
Aline Manera 已提交
1760 1761 
      &lt;readonly/&gt;
    &lt;/disk&gt;
A
Add https protocol support for cdrom disk  
Aline Manera 已提交
1762 1763 1764 1765 1766 
    &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;
E
docs: use unique dev names in <disk> examples  
Eric Blake 已提交
1767 
      &lt;target dev='hdf' bus='ide' tray='open'/&gt;
A
Add https protocol support for cdrom disk  
Aline Manera 已提交
1768 1769 
      &lt;readonly/&gt;
    &lt;/disk&gt;
A
Add ftp protocol support for cdrom disk  
Aline Manera 已提交
1770 1771 1772 1773 1774 
    &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;
E
docs: use unique dev names in <disk> examples  
Eric Blake 已提交
1775 
      &lt;target dev='hdg' bus='ide' tray='open'/&gt;
A
Add ftp protocol support for cdrom disk  
Aline Manera 已提交
1776 1777 
      &lt;readonly/&gt;
    &lt;/disk&gt;
A
Add ftps protocol support for cdrom disk  
Aline Manera 已提交
1778 1779 1780 1781 1782 
    &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;
E
docs: use unique dev names in <disk> examples  
Eric Blake 已提交
1783 
      &lt;target dev='hdh' bus='ide' tray='open'/&gt;
A
Add ftps protocol support for cdrom disk  
Aline Manera 已提交
1784 1785 
      &lt;readonly/&gt;
    &lt;/disk&gt;
A
Add tftp protocol support for cdrom disk  
Aline Manera 已提交
1786 1787 1788 1789 1790 
    &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;
E
docs: use unique dev names in <disk> examples  
Eric Blake 已提交
1791 
      &lt;target dev='hdi' bus='ide' tray='open'/&gt;
A
Add tftp protocol support for cdrom disk  
Aline Manera 已提交
1792 1793 
      &lt;readonly/&gt;
    &lt;/disk&gt;
O
conf: Introduce new attribute for device address format  
Osier Yang 已提交
1794 1795 
    &lt;disk type='block' device='lun'&gt;
      &lt;driver name='qemu' type='raw'/&gt;
O
docs: Fix typo  
Osier Yang 已提交
1796 1797 1798 
      &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;
O
conf: Introduce new attribute for device address format  
Osier Yang 已提交
1799 
    &lt;/disk&gt;
J
Support for Disk Geometry Override  
J.B. Joret 已提交
1800 1801 1802 1803 
    &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;
V
Rename iolimit to blockio.  
Viktor Mihajlovski 已提交
1804 
      &lt;blockio logical_block_size='512' physical_block_size='4096'/&gt;
E
docs: use correct hints per bus type in <disk> examples  
Eric Blake 已提交
1805 
      &lt;target dev='hdj' bus='ide'/&gt;
J
Support for Disk Geometry Override  
J.B. Joret 已提交
1806 
    &lt;/disk&gt;
O
Introduce new XMLs to specify disk source using libvirt storage  
Osier Yang 已提交
1807 1808 1809 
    &lt;disk type='volume' device='disk'&gt;
      &lt;driver name='qemu' type='raw'/&gt;
      &lt;source pool='blk-pool0' volume='blk-pool0-vol0'/&gt;
E
docs: use correct hints per bus type in <disk> examples  
Eric Blake 已提交
1810 
      &lt;target dev='hdk' bus='ide'/&gt;
O
Introduce new XMLs to specify disk source using libvirt storage  
Osier Yang 已提交
1811 
    &lt;/disk&gt;
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
1812 1813 1814 1815 1816 1817 
    &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;
      &lt;/source&gt;
      &lt;auth username='myuser'&gt;
J
formatdomain: Fix issues found describing auth  
John Ferlan 已提交
1818 
        &lt;secret type='iscsi' usage='libvirtiscsi'/&gt;
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
1819 1820 1821 1822 1823 1824 1825 1826 1827 
      &lt;/auth&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;
      &lt;/source&gt;
      &lt;auth username='myuser'&gt;
J
formatdomain: Fix issues found describing auth  
John Ferlan 已提交
1828 
        &lt;secret type='iscsi' usage='libvirtiscsi'/&gt;
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
1829 
      &lt;/auth&gt;
E
docs: use correct hints per bus type in <disk> examples  
Eric Blake 已提交
1830 
      &lt;target dev='sdb' bus='scsi'/&gt;
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
1831 1832 1833 1834 1835 
    &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;auth username='myuser'&gt;
J
formatdomain: Fix issues found describing auth  
John Ferlan 已提交
1836 
        &lt;secret type='iscsi' usage='libvirtiscsi'/&gt;
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
1837 
      &lt;/auth&gt;
E
docs: use correct hints per bus type in <disk> examples  
Eric Blake 已提交
1838 
      &lt;target dev='vdb' bus='virtio'/&gt;
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
1839 1840 1841 1842 1843 
    &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;auth username='myuser'&gt;
J
formatdomain: Fix issues found describing auth  
John Ferlan 已提交
1844 
        &lt;secret type='iscsi' usage='libvirtiscsi'/&gt;
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
1845 
      &lt;/auth&gt;
E
docs: use correct hints per bus type in <disk> examples  
Eric Blake 已提交
1846 
      &lt;target dev='vdc' bus='virtio'/&gt;
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
1847 
    &lt;/disk&gt;
J
conf: Output disk backing store details in domain XML  
Jiri Denemark 已提交
1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 
    &lt;disk type='file' device='disk'&gt;
      &lt;driver name='qemu' type='qcow2'/&gt;
      &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;
        &lt;/backingStore&gt;
      &lt;/backingStore&gt;
E
docs: use correct hints per bus type in <disk> examples  
Eric Blake 已提交
1860 
      &lt;target dev='vdd' bus='virtio'/&gt;
J
conf: Output disk backing store details in domain XML  
Jiri Denemark 已提交
1861 
    &lt;/disk&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
1862 1863 
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1864 1865 1866 1867 

    <dl>
      <dt><code>disk</code></dt>
      <dd>The <code>disk</code> element is the main container for describing
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 
      disks (<span class="since">since 0.0.3</span>).
        <dl>
          <dt><code>type</code> attribute
          <span class="since">since 0.0.3</span></dt>
            <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.
            </dd>
          <dt><code>device</code> attribute
          <span class="since">since 0.1.4</span></dt>
            <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
P
doc: domain: Clarify that disk type 'lun' works with iSCSI too  
Peter Krempa 已提交
1887 1888 
            valid when type is "block" or "network" using the iSCSI protocol,
            and behaves identically to "disk",
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 
            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').
            </p>
            </dd>
          <dt><code>rawio</code> attribute
          <span class="since">since 0.9.10</span></dt>
            <dd>
J
hostdev: Add "rawio" attribute to _virDomainHostdevSubsysSCSI  
John Ferlan 已提交
1900 
            Indicates whether the disk needs rawio capability. Valid
J
docs: Reformat <disk> attribute description in formatdomain  
John Ferlan 已提交
1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 
            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>.
            </dd>
          <dt><code>sgio</code> attribute
          <span class="since">since 1.0.2</span></dt>
            <dd>
            Indicates whether the kernel will filter unprivileged
            SG_IO commands for the disk, valid settings are "filtered" or
            "unfiltered". Defaults to "filtered". Similar to <code>rawio</code>,
            <code>sgio</code> is only valid for device 'lun'.
            </dd>
          <dt><code>snapshot</code> attribute
          <span class="since">since 0.9.5</span></dt>
            <dd>
            Indicates the default behavior of the disk during disk snapshots:
            "internal" requires a file format such as qcow2 that can store
            both the snapshot and the data changes since the snapshot;
            "external" will separate the snapshot from the live data; and
            "no" means the disk will not participate in snapshots. Read-only
            disks default to "no", while the default for other disks depends
            on the hypervisor's capabilities.  Some hypervisors allow a
            per-snapshot choice as well, during
            <a href="formatsnapshot.html">domain snapshot creation</a>.
            Not all snapshot modes are supported; for example,
            <code>snapshot='yes'</code> with a transient disk generally
            does not make sense.
            </dd>
        </dl>
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1939 
      <dt><code>source</code></dt>
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 
      <dd>Representation of the disk <code>source</code> depends on the
      disk <code>type</code> attribute value as follows:
          <dl>
            <dt><code>type='file'</code>
            <span class="since">since 0.0.3</span></dt>
              <dd>
              The <code>file</code> attribute specifies the fully-qualified
              path to the file holding the disk.
              </dd>
            <dt><code>type='block'</code>
            <span class="since">since 0.0.3</span></dt>
              <dd>
              The <code>dev</code> attribute specifies the path to the
              host device to serve as the disk.
              </dd>
            <dt><code>type='dir'</code>
            <span class="since">since 0.7.5</span></dt>
              <dd>
              The <code>dir</code> attribute specifies the fully-qualified path
              to the directory to use as the disk.
              </dd>
            <dt><code>type='network'</code>
            <span class="since">since 0.8.7</span></dt>
              <dd>
              The <code>protocol</code> attribute specifies the protocol to
              access to the requested image. Possible values are "nbd",
              "iscsi", "rbd", "sheepdog" or "gluster".  If the
              <code>protocol</code> attribute is "rbd", "sheepdog" or
              "gluster", an additional attribute <code>name</code> is
              mandatory to specify which volume/image will be used. For "nbd",
              the <code>name</code> attribute is optional. 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.,
              <code>iqn.2013-07.com.example:iscsi-pool/1</code>). If not
              specified, the default LUN is zero.
              </dd>
            <dt><code>type='volume'</code>
            <span class="since">since 1.0.5</span></dt>
              <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').
              </p>
              </dd>
          </dl>
        With "file", "block", and "volume", one or more optional
M
Multiple security drivers in XML data  
Marcelo Cerri 已提交
2009 
        sub-elements <code>seclabel</code>, <a href="#seclabel">described
E
seclabel: extend XML to allow per-disk label overrides  
Eric Blake 已提交
2010 2011 
        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 已提交
2012 2013 
        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 已提交
2014 2015 
        'block' type).
        <p>
P
storage: rbd: qemu: Add support for specifying internal RBD snapshots  
Peter Krempa 已提交
2016 
        The <code>source</code> element may contain the following sub elements:
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2017 
        </p>
P
docs: domain: Move docs for storage hosts under the <source> element  
Peter Krempa 已提交
2018 2019 2020 2021 2022 

        <dl>
          <dt><code>host</code></dt>
          <dd>
            <p>
P
storage: rbd: qemu: Add support for specifying internal RBD snapshots  
Peter Krempa 已提交
2023 2024 2025 2026 
            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 已提交
2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 
            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>
                <td> 6789 </td>
              </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>
                <td> only one </td>
                <td> 24007 </td>
              </tr>
            </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 已提交
2079 2080 2081 2082 2083 2084 2085 
          <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 已提交
2086 2087 2088 2089 2090 2091 2092 2093 
          <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>
P
docs: domain: Move docs for storage hosts under the <source> element  
Peter Krempa 已提交
2094 2095 
        </dl>
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2096 
        <p>
O
Support startupPolicy for 'volume' disk  
Osier Yang 已提交
2097 
        For a "file" or "volume" disk type which represents a cdrom or floppy
C
Add documentation for <disk><source type="dir">  
Christophe Fergeau 已提交
2098 2099 
        (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 已提交
2100 2101 
        (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 已提交
2102 2103 
        <code>startupPolicy</code> attribute
        (<span class="since">since 0.9.7</span>),
G
conf: add startupPolicy attribute for harddisk  
Guannan Ren 已提交
2104 
        accepting these values:
J
docs: Update the formatdomain disk examples  
John Ferlan 已提交
2105 
        </p>
M
conf: Introduce optional startupPolicy attribute for cdrom and floppy  
Michal Privoznik 已提交
2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 
        <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 已提交
2121 2122 2123 2124 2125 2126 2127 
        <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 已提交
2128 
        </dd>
J
conf: Output disk backing store details in domain XML  
Jiri Denemark 已提交
2129 2130 
      <dt><code>backingStore</code></dt>
      <dd>
D
doc: Fix doc for backingStore  
Deepak Shetty 已提交
2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 
        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
        file correctly). The following attributes and sub-elements are
        supported in <code>backingStore</code>:
J
conf: Output disk backing store details in domain XML  
Jiri Denemark 已提交
2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 
        <dl>
          <dt><code>type</code> attribute</dt>
          <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>
          <dt><code>index</code> attribute</dt>
          <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>
          <dt><code>format</code> sub-element</dt>
          <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>
          <dt><code>source</code> sub-element</dt>
          <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>
          <dt><code>backingStore</code> sub-element</dt>
          <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 已提交
2184 2185 
      <dt><code>mirror</code></dt>
      <dd>
E
blockcommit: track job type in xml  
Eric Blake 已提交
2186 2187 2188 2189 
        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 已提交
2190 2191 2192 2193 
        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 已提交
2194 2195 2196 2197 2198 
        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 已提交
2199 2200 2201 2202 2203 2204 
        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 已提交
2205 
        copying.  For now, this element only valid in output; it is
E
blockjob: don't remove older-style mirror XML  
Eric Blake 已提交
2206 2207 2208 2209 2210 2211 2212 
        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 已提交
2213 
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
2214 
      <dt><code>target</code></dt>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
2215 2216 2217 2218 2219 2220 2221 2222 
      <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 已提交
2223 2224 
        "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 已提交
2225 2226 
        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 已提交
2227 2228 2229 2230 
        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 已提交
2231 2232 2233 2234 
        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 已提交
2235 
        <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 已提交
2236 2237 
        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 已提交
2238 
      </dd>
L
Support block I/O throttle in XML  
Lei Li 已提交
2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 
      <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 已提交
2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 
          <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
            size of I/O operations per second.</dd>
L
Support block I/O throttle in XML  
Lei Li 已提交
2297 
        </dl>
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
2298 
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
2299 
      <dt><code>driver</code></dt>
M
qemu aio: add XML parsing  
Matthias Dahl 已提交
2300 2301 2302 
      <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 已提交
2303 
        <span class="since">Since 0.1.8</span>
M
qemu aio: add XML parsing  
Matthias Dahl 已提交
2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 
        <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 已提交
2318 2319 2320 2321 2322 2323 2324 2325 2326 
            "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 已提交
2327 2328 2329 
          </li>
          <li>
            The optional <code>error_policy</code> attribute controls
L
qemu: add separate rerror_policy for disk errors  
Laine Stump 已提交
2330 2331 2332 2333 2334 2335 2336 
            how the hypervisor will behave on a disk read or write
            error, possible values are "stop", "report", "ignore", and
            "enospace".<span class="since">Since 0.8.0, "report" since
            0.9.7</span> The default setting of error_policy is "report".
            There is also an
            optional <code>rerror_policy</code> that controls behavior
            for read errors only. <span class="since">Since
E
docs: fix html bug  
Eric Blake 已提交
2337 
            0.9.7</span>. If no rerror_policy is given, error_policy
L
qemu: add separate rerror_policy for disk errors  
Laine Stump 已提交
2338 2339 2340 2341 2342 2343 2344 
            is used for both read and write errors. If rerror_policy
            is given, it overrides the <code>error_policy</code> for
            read errors. Also note that "enospace" is not a valid
            policy for read errors, so if <code>error_policy</code> is
            set to "enospace" and no <code>rerror_policy</code> is
            given, the read error policy will be left at its default,
            which is "report".
M
qemu aio: add XML parsing  
Matthias Dahl 已提交
2345 2346 2347 2348 
          </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 已提交
2349 
            "native". <span class="since">Since 0.8.8</span>
M
qemu aio: add XML parsing  
Matthias Dahl 已提交
2350 
          </li>
M
qemu: domain I/O asynchronous handling  
Michal Privoznik 已提交
2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 
          <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 已提交
2365 2366 2367 2368 
          <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 已提交
2369 
            number of interrupts and exits for the guest. The default
L
qemu: support event_idx parameter for virtio disk and net devices  
Laine Stump 已提交
2370 2371 2372 2373 2374 2375 2376 2377 
            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 已提交
2378 2379 
          <li>
            The optional <code>copy_on_read</code> attribute controls
Y
Fix some typos in messages, docs and comments.  
Yuri Chornoivan 已提交
2380 
            whether to copy read backing file into the image file. The
O
qemu: Support copy on read for disk  
Osier Yang 已提交
2381 2382 2383 2384 2385 2386 
            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 已提交
2387 2388 2389 2390 
          <li>
            The optional <code>discard</code> attribute controls whether
            to discard (also known as "trim" or "unmap") requests are
            ignored or passed to the filesystem. The value can be either
O
qemu: Change values of disk discard  
Osier Yang 已提交
2391 2392 
            "unmap" (allow the discard request to be passed) or "ignore"
            (ignore the discard request).
O
qemu: Support discard for disk  
Osier Yang 已提交
2393 2394 
            <span class='since'>Since 1.0.6 (QEMU and KVM only)</span>
          </li>
J
domain_conf: Add support for iothreads in disk definition  
John Ferlan 已提交
2395 2396 2397 2398 2399 2400 2401 2402 
          <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>
            value. Multiple devices may be assigned to the same IOThread and
            are numbered from 1 to the domain iothreads value.
            <span class='since'>Since 1.2.8 (QEMU only)</span>
          </li>
M
qemu aio: add XML parsing  
Matthias Dahl 已提交
2403 
        </ul>
D
Update domain XML docs  
Daniel P. Berrange 已提交
2404 
      </dd>
M
conf: support backend domain name in disk and network devices  
Marek Marczykowski 已提交
2405 2406 2407 2408 2409 2410 
      <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 已提交
2411 2412 2413 2414 2415 2416 2417 2418 
      <dt><code>boot</code></dt>
      <dd>Specifies that the disk is bootable. The <code>order</code>
        attribute determines the order in which devices will be tried during
        boot sequence. The per-device <code>boot</code> elements cannot be
        used together with general boot elements in
        <a href="#elementsOSBIOS">BIOS bootloader</a> section.
        <span class="since">Since 0.8.8</span>
      </dd>
M
Attach encryption information to virDomainDiskDef.  
Miloslav Trmač 已提交
2419 2420 2421 2422 2423 
      <dt><code>encryption</code></dt>
      <dd>If present, specifies how the volume is encrypted.  See
        the <a href="formatstorageencryption.html">Storage Encryption</a> page
        for more information.
      </dd>
E
snapshot: additions to domain xml for disks  
Eric Blake 已提交
2424 2425 2426 
      <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 已提交
2427 
        attribute <code>device='cdrom'</code>.
E
snapshot: additions to domain xml for disks  
Eric Blake 已提交
2428 
      </dd>
D
add missing doc for device <shareable/> option  
Daniel Veillard 已提交
2429 2430 2431 2432 2433 
      <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 已提交
2434 2435 2436 2437 2438 2439 2440 
      <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  
Марк Коренберг 已提交
2441 2442 
      <dt><code>serial</code></dt>
      <dd>If present, this specify serial number of virtual hard drive.
E
docs: minor whitespace cleanups  
Eric Blake 已提交
2443 2444 
          For example, it may look
          like <code>&lt;serial&gt;WD-WMAP9A966149&lt;/serial&gt;</code>.
М
Add docs on drive <serial> element  
Марк Коренберг 已提交
2445 2446 
          <span class="since">Since 0.7.1</span>
      </dd>
O
schema: Add schema for disk <wwn>  
Osier Yang 已提交
2447 2448 2449 2450 2451 2452 
      <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
        of 16 hexadecimal digits.
        <span class='since'>Since 0.10.1</span>
      </dd>
O
qemu: Allow the user to specify vendor and product for disk  
Osier Yang 已提交
2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 
      <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 已提交
2465 2466 2467 2468 2469 2470 2471 2472 2473 
      <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 已提交
2474 2475 2476 2477 2478 
        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 已提交
2479 2480 2481 
        <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 已提交
2482 2483 
      </dd>
      <dt><code>auth</code></dt>
J
formatdomain: Fix issues found describing auth  
John Ferlan 已提交
2484 2485 2486 2487 
      <dd>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
J
storage: add auth to virDomainDiskDef  
Josh Durgin 已提交
2488 2489 2490 2491 2492 2493 2494 2495 
        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
J
formatdomain: Fix issues found describing auth  
John Ferlan 已提交
2496 2497 2498 2499 2500 
        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>
P
domain: parse XML for iscsi authorization credentials  
Paolo Bonzini 已提交
2501 2502 
        attribute matching the key that was specified in the
        secret object.  <span class="since">libvirt 0.9.7</span>
E
docs: document <controller> element  
Eric Blake 已提交
2503 
      </dd>
J
Support for Disk Geometry Override  
J.B. Joret 已提交
2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 
      <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 已提交
2523 2524 
      <dt><code>blockio</code></dt>
      <dd>If present, the <code>blockio</code> element allows
V
conf: Support for Block Device IO Limits  
Viktor Mihajlovski 已提交
2525 2526 2527 2528 2529 2530 2531 2532 
        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 已提交
2533 
          </dd>
V
conf: Support for Block Device IO Limits  
Viktor Mihajlovski 已提交
2534 2535 2536 2537 2538 
          <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 已提交
2539 
          </dd>
V
conf: Support for Block Device IO Limits  
Viktor Mihajlovski 已提交
2540 2541 
        </dl>
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
2542 2543 
    </dl>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 
    <h4><a name="elementsFilesystems">Filesystems</a></h4>

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

<pre>
  ...
  &lt;devices&gt;
    &lt;filesystem type='template'&gt;
      &lt;source name='my-vm-template'/&gt;
      &lt;target dir='/'/&gt;
    &lt;/filesystem&gt;
C
docs: <filesystem> attr is 'accessmode', not 'mode'  
Cole Robinson 已提交
2558 
    &lt;filesystem type='mount' accessmode='passthrough'&gt;
D
Add new attribute wrpolicy to <driver> element  
Deepak C Shetty 已提交
2559 
      &lt;driver type='path' wrpolicy='immediate'/&gt;
C
docs: Document <filesystem> device  
Cole Robinson 已提交
2560 2561 2562 2563 
      &lt;source dir='/export/to/guest'/&gt;
      &lt;target dir='/import/from/host'/&gt;
      &lt;readonly/&gt;
    &lt;/filesystem&gt;
D
Add support for storage format in FS <driver>  
Daniel P. Berrange 已提交
2564 2565 2566 2567 2568 2569 2570 
    &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 已提交
2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 
    ...
  &lt;/devices&gt;
  ...</pre>

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

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

        <dl>
        <dt><code>type='mount'</code></dt>
        <dd>
        A host directory to mount in the guest. Used by LXC,
        OpenVZ <span class="since">(since 0.6.2)</span>
        and QEMU/KVM <span class="since">(since 0.8.5)</span>.
C
docs: <filesystem> attr is 'accessmode', not 'mode'  
Cole Robinson 已提交
2588 
        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 已提交
2589 2590 2591 2592 
        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 已提交
2593 2594 2595 2596 2597 2598 
        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 已提交
2599 2600 2601 2602 2603 2604 2605 
        </dd>
        <dt><code>type='template'</code></dt>
        <dd>
        OpenVZ filesystem template. Only used by OpenVZ driver.
        </dd>
        <dt><code>type='file'</code></dt>
        <dd>
D
Add support for RAM filesystems for LXC  
Daniel P. Berrange 已提交
2606 2607 2608 
        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 已提交
2609 2610 2611 
        </dd>
        <dt><code>type='block'</code></dt>
        <dd>
R
docs: Document filesystem type='block' for LXC  
Ryota Ozaki 已提交
2612 2613 2614 
        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 已提交
2615 
        </dd>
D
Add support for RAM filesystems for LXC  
Daniel P. Berrange 已提交
2616 2617 2618 2619 
        <dt><code>type='ram'</code></dt>
        <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 已提交
2620 2621 
          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 已提交
2622 2623 
          by LXC driver.
          <span class="since"> (since 0.9.13)</span></dd>
E
docs: fix typo in filesystem docs  
Eric Blake 已提交
2624 
        <dt><code>type='bind'</code></dt>
D
Add support for guest bind mounts with LXC  
Daniel P. Berrange 已提交
2625 2626 2627 2628 
        <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 已提交
2629 2630 
        </dl>
C
docs: <filesystem> attr is 'accessmode', not 'mode'  
Cole Robinson 已提交
2631 
      The filesystem block has an optional attribute <code>accessmode</code>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
2632 2633 2634 2635 2636 2637 
      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>
C
docs: <filesystem> attr is 'accessmode', not 'mode'  
Cole Robinson 已提交
2638 
        <dt><code>accessmode='passthrough'</code></dt>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
2639 2640 
        <dd>
        The <code>source</code> is accessed with the permissions of the
C
docs: <filesystem> attr is 'accessmode', not 'mode'  
Cole Robinson 已提交
2641 
        user inside the guest. This is the default <code>accessmode</code> if
C
docs: Document <filesystem> device  
Cole Robinson 已提交
2642 2643 2644 
        one is not specified.
        <a href="http://lists.gnu.org/archive/html/qemu-devel/2010-05/msg02673.html">More info</a>
        </dd>
C
docs: <filesystem> attr is 'accessmode', not 'mode'  
Cole Robinson 已提交
2645 
        <dt><code>accessmode='mapped'</code></dt>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
2646 2647 2648 2649 2650 
        <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>
C
docs: <filesystem> attr is 'accessmode', not 'mode'  
Cole Robinson 已提交
2651 
        <dt><code>accessmode='squash'</code></dt>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 
        <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 已提交
2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 
      <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 已提交
2674 2675 
            supports a type of "loop", with a format of "raw" or
            "nbd" with any format. QEMU supports a type of "path"
D
add ploop fs driver type  
Dmitry Guryanov 已提交
2676 2677 
            or "handle", but no formats. Parallels driver supports
            a type of "ploop" with a format of "ploop".
D
Add support for storage format in FS <driver>  
Daniel P. Berrange 已提交
2678 2679 2680 2681 
          </li>
        </ul>
      </dd>
C
docs: Document <filesystem> device  
Cole Robinson 已提交
2682 2683 2684 2685 2686 
      <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 已提交
2687 
        be used with <code>type='mount'</code>. The <code>usage</code> attribute
J
LXC: Fix handling of RAM filesystem size units  
Ján Tomko 已提交
2688 2689 
        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 已提交
2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 
      </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 已提交
2702 
        Enables exporting filesystem as a readonly mount for guest, by
O
qemu: Support readonly filesystem passthrough  
Osier Yang 已提交
2703 2704 
        default read-write access is given (currently only works for
        QEMU/KVM driver).
C
docs: Document <filesystem> device  
Cole Robinson 已提交
2705 
      </dd>
G
Introduce filesystem limits to virDomainFSDef  
Guido Günther 已提交
2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 

      <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 已提交
2720 2721 
    </dl>
E
docs: document <address> elements in one place  
Eric Blake 已提交
2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 
    <h4><a name="elementsAddress">Device Addresses</a></h4>

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

    <p>
      Every address has a mandatory attribute <code>type</code> that
      describes which bus the device is on.  The choice of which
      address to use for a given device is constrained in part by the
      device and the architecture of the guest.  For example,
      a <code>&lt;disk&gt;</code> device
M
docs: fix address type for disks  
Martin Kletzander 已提交
2741 
      uses <code>type='drive'</code>, while
E
docs: document <address> elements in one place  
Eric Blake 已提交
2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 
      a <code>&lt;console&gt;</code> device would
      use <code>type='pci'</code> on i686 or x86_64 guests,
      or <code>type='spapr-vio'</code> on PowerPC64 pseries guests.
      Each address type has further optional attributes that control
      where on the bus the device will be placed:
    </p>

    <dl>
      <dt><code>type='pci'</code></dt>
      <dd>PCI addresses have the following additional
        attributes: <code>domain</code> (a 2-byte hex integer, not
        currently used by qemu), <code>bus</code> (a hex value between
        0 and 0xff, inclusive), <code>slot</code> (a hex value between
        0x0 and 0x1f, inclusive), and <code>function</code> (a value
        between 0 and 7, inclusive).  Also available is
        the <code>multifunction</code> attribute, which controls
        turning on the multifunction bit for a particular
        slot/function in the PCI control register
        (<span class="since">since 0.9.7, requires QEMU
        0.13</span>). <code>multifunction</code> defaults to 'off',
        but should be set to 'on' for function 0 of a slot that will
        have multiple functions used.
      </dd>
      <dt><code>type='drive'</code></dt>
      <dd>Drive addresses have the following additional
        attributes: <code>controller</code> (a 2-digit controller
        number), <code>bus</code> (a 2-digit bus number),
O
conf: Introduce new attribute for device address format  
Osier Yang 已提交
2769 
        <code>target</code> (a 2-digit bus number),
E
docs: document <address> elements in one place  
Eric Blake 已提交
2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 
        and <code>unit</code> (a 2-digit unit number on the bus).
      </dd>
      <dt><code>type='virtio-serial'</code></dt>
      <dd>Each virtio-serial address has the following additional
        attributes: <code>controller</code> (a 2-digit controller
        number), <code>bus</code> (a 2-digit bus number),
        and <code>slot</code> (a 2-digit slot within the bus).
      </dd>
      <dt><code>type='ccid'</code></dt>
      <dd>A CCID address, for smart-cards, has the following
        additional attributes: <code>bus</code> (a 2-digit bus
        number), and <code>slot</code> attribute (a 2-digit slot
        within the bus).  <span class="since">Since 0.8.8.</span>
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
2783 
      </dd>
E
docs: document <address> elements in one place  
Eric Blake 已提交
2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 
      <dt><code>type='usb'</code></dt>
      <dd>USB addresses have the following additional
        attributes: <code>bus</code> (a hex value between 0 and 0xfff,
        inclusive), and <code>port</code> (a dotted notation of up to
        four octets, such as 1.2 or 2.1.3.1).
      </dd>
      <dt><code>type='spapr-vio'</code></dt>
      <dd>On PowerPC pseries guests, devices can be assigned to the
        SPAPR-VIO bus.  It has a flat 64-bit address space; by
        convention, devices are generally assigned at a non-zero
        multiple of 0x1000, but other addresses are valid and
        permitted by libvirt.  Each address has the following
        additional attribute: <code>reg</code> (the hex value address
        of the starting register).  <span class="since">Since
        0.9.9.</span>
V
S390: Documentation for CCW address type  
Viktor Mihajlovski 已提交
2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 
      </dd>
      <dt><code>type='ccw'</code></dt>
      <dd>s390 guests with a <code>machine</code> value of
        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 已提交
2809 2810 
        cssid=0xfe and ssid=0. Virtio-ccw devices must have their cssid
        set to 0xfe.
V
S390: Documentation for CCW address type  
Viktor Mihajlovski 已提交
2811 
        <span class="since">Since 1.0.4</span>
E
docs: document <address> elements in one place  
Eric Blake 已提交
2812 
      </dd>
H
conf: introduce generic ISA address  
Hu Tao 已提交
2813 2814 2815 2816 2817 
      <dt><code>type='isa'</code></dt>
      <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 已提交
2818 2819 
    </dl>
E
docs: document <controller> element  
Eric Blake 已提交
2820 2821 2822 
    <h4><a name="elementsControllers">Controllers</a></h4>

    <p>
O
docs, comments: minor typo fixes  
Oskari Saarenmaa 已提交
2823 
      Depending on the guest architecture, some device buses can
E
docs: document <address> elements in one place  
Eric Blake 已提交
2824 2825 
      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 已提交
2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 
      controllers without requiring explicit XML markup, but sometimes
      it is necessary to provide an explicit controller element.
    </p>

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

    <p>
      Each controller has a mandatory attribute <code>type</code>,
M
Add a new controller type 'usb' with optionnal 'model'  
Marc-André Lureau 已提交
2844 
      which must be one of "ide", "fdc", "scsi", "sata", "usb",
J
conf: add PCI controllers  
Ján Tomko 已提交
2845 
      "ccid", "virtio-serial" or "pci", and a mandatory
M
Add a new controller type 'usb' with optionnal 'model'  
Marc-André Lureau 已提交
2846 2847 2848 2849 2850 
      attribute <code>index</code> which is the decimal integer
      describing in which order the bus controller is encountered (for
      use in <code>controller</code> attributes
      of <code>&lt;address&gt;</code> elements).  The "virtio-serial"
      controller has two additional optional
E
docs: document <controller> element  
Eric Blake 已提交
2851 2852 2853 
      attributes <code>ports</code> and <code>vectors</code>, which
      control how many devices can be connected through the
      controller.  A "scsi" controller has an optional
P
qemu: add ibmvscsi controller model  
Paolo Bonzini 已提交
2854 
      attribute <code>model</code>, which is one of "auto", "buslogic",
P
qemu: add support for LSI MegaRAID SAS1078 (aka megasas) SCSI controller  
Paolo Bonzini 已提交
2855 
      "ibmvscsi", "lsilogic", "lsisas1068", "lsisas1078", "virtio-scsi" or
O
Introduce a sub-element <driver> for controller  
Osier Yang 已提交
2856 2857 2858 2859 2860 2861 
      "vmpvscsi".  A "usb" controller has an optional attribute
      <code>model</code>, which is one of "piix3-uhci", "piix4-uhci", "ehci",
      "ich9-ehci1", "ich9-uhci1", "ich9-uhci2", "ich9-uhci3", "vt82c686b-uhci",
      "pci-ohci" or "nec-xhci".  Additionally,
      <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
V
S390: Mention changed USB behavior  
Viktor Mihajlovski 已提交
2862 2863 2864 
      used.  <span class="since">Since 1.0.5</span>, no default USB controller
      will be built on s390.  The PowerPC64 "spapr-vio" addresses do not have an
      associated controller.
E
docs: document <controller> element  
Eric Blake 已提交
2865 2866 2867 2868 2869 2870 
    </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 已提交
2871 
      semantics <a href="#elementsAddress">given above</a>.
E
docs: document <controller> element  
Eric Blake 已提交
2872 2873 
    </p>
O
Introduce a sub-element <driver> for controller  
Osier Yang 已提交
2874 2875 
    <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 已提交
2876 
      specific options:
O
Introduce a sub-element <driver> for controller  
Osier Yang 已提交
2877 
    </p>
M
qemu: Add cmd_per_lun, max_sectors to virtio-scsi  
Mike Perez 已提交
2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 
    <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>
    </dl>
M
Add USB companion controllers support  
Marc-André Lureau 已提交
2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 
    <p>
      USB companion controllers have an optional
      sub-element <code>&lt;master&gt;</code> to specify the exact
      relationship of the companion to its master controller.
      A companion controller is on the same bus as its master, so
      the companion <code>index</code> value should be equal.
    </p>

<pre>
  ...
  &lt;devices&gt;
    &lt;controller type='usb' index='0' model='ich9-ehci1'&gt;
      &lt;address type='pci' domain='0' bus='0' slot='4' function='7'/&gt;
    &lt;/controller&gt;
    &lt;controller type='usb' index='0' model='ich9-uhci1'&gt;
      &lt;master startport='0'/&gt;
L
qemu: make PCI multifunction support more manual  
Laine Stump 已提交
2918 
      &lt;address type='pci' domain='0' bus='0' slot='4' function='0' multifunction='on'/&gt;
M
Add USB companion controllers support  
Marc-André Lureau 已提交
2919 2920 2921 
    &lt;/controller&gt;
    ...
  &lt;/devices&gt;
J
conf: add PCI controllers  
Ján Tomko 已提交
2922 2923 2924 2925 
  ...</pre>

    <p>
      PCI controllers have an optional <code>model</code> attribute with
L
qemu: add dmi-to-pci-bridge controller  
Laine Stump 已提交
2926 2927 
      possible values <code>pci-root</code>, <code>pcie-root</code>,
      <code>pci-bridge</code>, or <code>dmi-to-pci-bridge</code>.
J
Add pcihole64 element to root PCI controllers  
Ján Tomko 已提交
2928 2929 2930 2931 2932 2933 2934 2935 2936 
      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
      <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>
    <p>
L
qemu: add pcie-root controller  
Laine Stump 已提交
2937 
      For machine types which provide an implicit PCI bus, the pci-root
J
conf: add PCI controllers  
Ján Tomko 已提交
2938 
      controller with index=0 is auto-added and required to use PCI devices.
L
qemu: add pcie-root controller  
Laine Stump 已提交
2939 
      pci-root has no address.
L
qemu: add dmi-to-pci-bridge controller  
Laine Stump 已提交
2940 2941 2942 
      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 已提交
2943 2944 2945 2946 
      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.
L
qemu: add pcie-root controller  
Laine Stump 已提交
2947 
      (pci-root and pci-bridge <span class="since">since 1.0.5</span>)
J
conf: add PCI controllers  
Ján Tomko 已提交
2948 2949 2950 2951 2952 2953 
    </p>
<pre>
  ...
  &lt;devices&gt;
    &lt;controller type='pci' index='0' model='pci-root'/&gt;
    &lt;controller type='pci' index='1' model='pci-bridge'&gt;
L
qemu: add pcie-root controller  
Laine Stump 已提交
2954 
      &lt;address type='pci' domain='0' bus='0' slot='5' function='0' multifunction='off'/&gt;
J
conf: add PCI controllers  
Ján Tomko 已提交
2955 2956 
    &lt;/controller&gt;
  &lt;/devices&gt;
L
qemu: add pcie-root controller  
Laine Stump 已提交
2957 2958 2959 2960 2961 2962 2963 2964 
  ...</pre>

    <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
      31 slots (numbered 1-31) and can only be used to attach PCIe
L
qemu: add dmi-to-pci-bridge controller  
Laine Stump 已提交
2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 
      devices. In order to connect standard PCI devices on a system
      which has a pcie-root controller, a pci controller
      with <code>model='dmi-to-pci-bridge'</code> is automatically
      added. A dmi-to-pci-bridge controller plugs into a PCIe slot (as
      provided by pcie-root), and itself provides 31 standard PCI
      slots (which are not hot-pluggable). In order to have
      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
      controller; all guest devices with PCI addresses that are
      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 已提交
2977 2978 2979 2980 2981 
    </p>
<pre>
  ...
  &lt;devices&gt;
    &lt;controller type='pci' index='0' model='pcie-root'/&gt;
L
qemu: add dmi-to-pci-bridge controller  
Laine Stump 已提交
2982 2983 2984 2985 2986 2987 
    &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;
L
qemu: add pcie-root controller  
Laine Stump 已提交
2988 
  &lt;/devices&gt;
M
Add USB companion controllers support  
Marc-André Lureau 已提交
2989 2990 
  ...</pre>
D
Support leases in guest XML and lock manager  
Daniel P. Berrange 已提交
2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 
    <h4><a name="elementsLease">Device leases</a></h4>

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

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

    <dl>
      <dt>lockspace</dt>
      <dd>This is an arbitrary string, identifying the lockspace
        within which the key is held. Lock managers may impose
        extra restrictions on the format, or length of the lockspace
        name.</dd>
      <dt>key</dt>
      <dd>This is an arbitrary string, uniquely identifying the
        lease to be acquired. Lock managers may impose extra
        restrictions on the format, or length of the key.
      </dd>
      <dt>target</dt>
      <dd>This is the fully qualified path of the file associated
        with the lockspace. The offset specifies where the lease
        is stored within the file. If the lock manager does not
        require a offset, just pass 0.
      </dd>
    </dl>
E
docs: document <controller> element  
Eric Blake 已提交
3030
D
Add support for <hostdev mode="capabilities">  
Daniel P. Berrange 已提交
3031 3032 
    <h4><a name="elementsHostDev">Host device assignment</a></h4>
J
docs: formatdomain: fix links in the table of contents  
Ján Tomko 已提交
3033 
    <h5><a name="elementsHostDevSubsys">USB / PCI / SCSI devices</a></h5>
D
documentation for USB passthrough  
Daniel Veillard 已提交
3034 3035 

    <p>
H
conf: Generic XMLs for scsi hostdev  
Han Cheng 已提交
3036 
      USB, PCI and SCSI devices attached to the host can be passed through
D
Add support for <hostdev mode="capabilities">  
Daniel P. Berrange 已提交
3037 
      to the guest using the <code>hostdev</code> element.
H
conf: Generic XMLs for scsi hostdev  
Han Cheng 已提交
3038 3039 
      <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 已提交
3040 3041 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3042 3043 3044 3045 
<pre>
  ...
  &lt;devices&gt;
    &lt;hostdev mode='subsystem' type='usb'&gt;
J
conf: Add support for startupPolicy for USB devices  
Jiri Denemark 已提交
3046 
      &lt;source startupPolicy='optional'&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3047 3048 3049 
        &lt;vendor id='0x1234'/&gt;
        &lt;product id='0xbeef'/&gt;
      &lt;/source&gt;
J
Support booting from hostdev devices  
Jiri Denemark 已提交
3050 
      &lt;boot order='2'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3051 3052 3053 3054 
    &lt;/hostdev&gt;
  &lt;/devices&gt;
  ...</pre>
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
3055 
    <p>or:</p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3056 3057 3058 3059 

<pre>
  ...
  &lt;devices&gt;
P
domain.rng vs. formatdomain.html#elementsUSB  
Philipp Hahn 已提交
3060 
    &lt;hostdev mode='subsystem' type='pci' managed='yes'&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3061 
      &lt;source&gt;
H
doc: add domain to address of hostdev pci  
Hu Tao 已提交
3062 
        &lt;address domain='0x0000' bus='0x06' slot='0x02' function='0x0'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3063 
      &lt;/source&gt;
J
Support booting from hostdev devices  
Jiri Denemark 已提交
3064 
      &lt;boot order='1'/&gt;
L
qemu: add "romfile" support to specify device boot ROM  
Laine Stump 已提交
3065 
      &lt;rom bar='on' file='/etc/fake/boot.bin'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3066 3067 
    &lt;/hostdev&gt;
  &lt;/devices&gt;
H
conf: Generic XMLs for scsi hostdev  
Han Cheng 已提交
3068 3069 3070 3071 3072 3073 3074 
  ...</pre>

    <p>or:</p>

<pre>
  ...
  &lt;devices&gt;
J
hostdev: Add "rawio" attribute to _virDomainHostdevSubsysSCSI  
John Ferlan 已提交
3075 
    &lt;hostdev mode='subsystem' type='scsi' sgio='filtered' rawio='yes'&gt;
H
conf: Generic XMLs for scsi hostdev  
Han Cheng 已提交
3076 3077 3078 3079 3080 3081 3082 3083 
      &lt;source&gt;
        &lt;adapter name='scsi_host0'/&gt;
        &lt;address type='scsi' 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;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3084 
  ...</pre>
D
documentation for USB passthrough  
Daniel Veillard 已提交
3085
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 

    <p>or:</p>

<pre>
  ...
  &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>
D
documentation for USB passthrough  
Daniel Veillard 已提交
3104 3105 3106 
    <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 已提交
3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 
        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>
          <dt>usb</dt>
          <dd>For USB devices, the user is responsible to call
            <code>virNodeDeviceDettach</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.
          </dd>
          <dt>pci</dt>
          <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
            <code>managed</code> is omitted or "no", follow the steps
            described for a USB device to detach before starting the
            guest or hot-plugging and reattach after stopping the guest
            or hot-unplug.
          </dd>
          <dt>scsi</dt>
          <dd>For SCSI devices, user is responsible to make sure the device
            is not used by host. The optional <code>sgio</code>
            (<span class="since">since 1.0.6</span>) attribute indicates
            whether the kernel will filter unprivileged SG_IO commands for
            the disk, valid settings are "filtered" or "unfiltered".
J
hostdev: Add "rawio" attribute to _virDomainHostdevSubsysSCSI  
John Ferlan 已提交
3134 3135 3136 3137 3138 3139 3140 
            The default is "filtered". The optional <code>rawio</code>
            (<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 已提交
3141 3142 
          </dd>
        </dl>
E
docs: add a note that attr 'managed' is only used by PCI devices  
Erik Skultety 已提交
3143 3144 3145 3146 3147 3148 
        <p>
          Note: The <code>managed</code> attribute is only used with PCI devices
          and is ignored by all the other device types, thus setting
          <code>managed</code> explicitly with other than PCI device has the same
          effect as omitting it.
        </p>
O
conf: Introduce sgio for hostdev  
Osier Yang 已提交
3149 
      </dd>
D
documentation for USB passthrough  
Daniel Veillard 已提交
3150 
      <dt><code>source</code></dt>
J
hostdev: Add iSCSI hostdev XML  
John Ferlan 已提交
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 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 
      <dd>The source element describes the device as seen from the host using
        the following mechanism to describe:
        <dl>
          <dt>usb</dt>
          <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>
          <dt>pci</dt>
          <dd>PCI devices can only be described by their <code>address</code>.
          </dd>
          <dt>scsi</dt>
          <dd>SCSI devices are described by both the <code>adapter</code>
            and <code>address</code> elements.
            <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>
        </dl>
J
conf: Add support for startupPolicy for USB devices  
Jiri Denemark 已提交
3199 
      </dd>
D
documentation for USB passthrough  
Daniel Veillard 已提交
3200 3201 3202 3203 3204 
      <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 已提交
3205 3206 3207 3208 3209 3210 
      <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 已提交
3211 3212 
      <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 已提交
3213 
      </dd>
L
qemu: add ability to set PCI device "rombar" on or off  
Laine Stump 已提交
3214 3215 
      <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 已提交
3216 
        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 已提交
3217 3218 3219 3220 3221 3222 3223 
        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 已提交
3224 3225 3226 3227 3228 3229 3230 
        0.9.7 (QEMU and KVM only)</span>. The optional
        <code>file</code> attribute is used to point to a binary file
        to be presented to the guest as the device's ROM BIOS. This
        can be useful, for example, to provide a PXE boot ROM for a
        virtual function of an sr-iov capable ethernet device (which
        has no boot ROMs for the VFs).
        <span class="since">Since 0.9.10 (QEMU and KVM only)</span>.
L
qemu: add ability to set PCI device "rombar" on or off  
Laine Stump 已提交
3231 
      </dd>
D
documentation for USB passthrough  
Daniel Veillard 已提交
3232 
      <dt><code>address</code></dt>
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
3233 3234 3235 3236 3237 
      <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 已提交
3238 
      For PCI devices the element carries 4 attributes allowing to designate
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
3239 
      the device as can be found with the <code>lspci</code> or
E
docs: document <address> elements in one place  
Eric Blake 已提交
3240 3241 
      with <code>virsh
      nodedev-list</code>. <a href="#elementsAddress">See above</a> for
L
conf: formatter/parser/RNG/docs for hostdev <driver name='kvm|vfio'/>  
Laine Stump 已提交
3242 3243 3244 3245 3246 3247 3248 3249 
      more details on the address element.</dd>
      <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 已提交
3250 
        (the legacy device assignment handled directly by the KVM
L
conf: formatter/parser/RNG/docs for hostdev <driver name='kvm|vfio'/>  
Laine Stump 已提交
3251 
        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 已提交
3252 3253 3254 3255 3256 3257 3258 3259 
        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 已提交
3260 
      </dd>
O
Introduce <readonly> for hostdev  
Osier Yang 已提交
3261 3262 3263 3264 
      <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 已提交
3265 3266 3267 3268 3269 
      <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 已提交
3270 3271 3272 3273 3274 
        <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 已提交
3275 
      </dd>
D
documentation for USB passthrough  
Daniel Veillard 已提交
3276 3277 
    </dl>
D
Add support for <hostdev mode="capabilities">  
Daniel P. Berrange 已提交
3278
J
docs: formatdomain: fix links in the table of contents  
Ján Tomko 已提交
3279 
    <h5><a name="elementsHostDevCaps">Block / character devices</a></h5>
D
Add support for <hostdev mode="capabilities">  
Daniel P. Berrange 已提交
3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 

    <p>
      Block / character devices from the host can be passed through
      to the guest using the <code>hostdev</code> element. This is
      only possible with container based virtualization.
      <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 已提交
3305 3306 3307 
...
    </pre>
O
docs: Add the missed <pre> tag  
Osier Yang 已提交
3308 
    <pre>
B
Update structure & XML definitions to support <hostdev caps=net>  
Bogdan Purcareata 已提交
3309 3310 3311 3312 3313 3314 
...
&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 已提交
3315 3316 3317 3318 3319 3320 3321 
...
    </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 已提交
3322 3323 
        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 已提交
3324 
        interface.
D
Add support for <hostdev mode="capabilities">  
Daniel P. Berrange 已提交
3325 3326 3327 3328 3329 
      </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 已提交
3330 3331 
        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 已提交
3332 3333 3334 
      </dd>
    </dl>
M
Add "redirdev" redirection device  
Marc-André Lureau 已提交
3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 
    <h4><a name="elementsRedir">Redirected devices</a></h4>

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

<pre>
  ...
  &lt;devices&gt;
    &lt;redirdev bus='usb' type='tcp'&gt;
      &lt;source mode='connect' host='localhost' service='4000'/&gt;
J
docs: boot order for host and redirected USB devices  
Ján Tomko 已提交
3348 
      &lt;boot order='1'/&gt;
M
Add "redirdev" redirection device  
Marc-André Lureau 已提交
3349 
    &lt;/redirdev&gt;
G
doc: update usb redirection filter infomation on formatdomain.html  
Guannan Ren 已提交
3350 
    &lt;redirfilter&gt;
J
Clarify the meaning of version in redirdev filters  
Ján Tomko 已提交
3351 
      &lt;usbdev class='0x08' vendor='0x1234' product='0xbeef' version='2.56' allow='yes'/&gt;
G
doc: update usb redirection filter infomation on formatdomain.html  
Guannan Ren 已提交
3352 3353 
      &lt;usbdev allow='no'/&gt;
    &lt;/redirfilter&gt;
M
Add "redirdev" redirection device  
Marc-André Lureau 已提交
3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 
  &lt;/devices&gt;
  ...</pre>

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

        An additional attribute <code>type</code> is required,
        matching one of the
        supported <a href="#elementsConsole">serial device</a> types,
        to describe the host side of the
        tunnel; <code>type='tcp'</code>
        or <code>type='spicevmc'</code> (which uses the usbredir
        channel of a <a href="#elementsGraphics">SPICE graphics
J
docs: Fix a few spaces  
Ján Tomko 已提交
3370 3371 
        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 已提交
3372 3373 3374 3375 
        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 已提交
3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 
        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 已提交
3386 3387 3388 3389 
      </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 已提交
3390 3391 
        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 已提交
3392 
        0x08 represents mass storage devices. The USB device can be addressed by
J
docs: Fix a few spaces  
Ján Tomko 已提交
3393 
        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 已提交
3394 3395 
        <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 已提交
3396 
        These four attributes are optional and <code>-1</code> can be used to allow
J
docs: Fix a few spaces  
Ján Tomko 已提交
3397 
        any value for them. <code>allow</code> attribute is mandatory,
G
doc: update usb redirection filter infomation on formatdomain.html  
Guannan Ren 已提交
3398 3399 
        'yes' means allow, 'no' for deny.
      </dd>
M
Add "redirdev" redirection device  
Marc-André Lureau 已提交
3400 3401 
    </dl>
E
smartcard: add XML support for <smartcard> device  
Eric Blake 已提交
3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 
    <h4><a name="elementsSmartcard">Smartcard devices</a></h4>

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

<pre>
  ...
  &lt;devices&gt;
    &lt;smartcard mode='host'/&gt;
    &lt;smartcard mode='host-certificates'&gt;
      &lt;certificate&gt;cert1&lt;/certificate&gt;
      &lt;certificate&gt;cert2&lt;/certificate&gt;
      &lt;certificate&gt;cert3&lt;/certificate&gt;
      &lt;database&gt;/etc/pki/nssdb/&lt;/database&gt;
    &lt;/smartcard&gt;
    &lt;smartcard mode='passthrough' type='tcp'&gt;
      &lt;source mode='bind' host='127.0.0.1' service='2001'/&gt;
      &lt;protocol type='raw'/&gt;
      &lt;address type='ccid' controller='0' slot='0'/&gt;
    &lt;/smartcard&gt;
E
smartcard: add spicevmc support  
Eric Blake 已提交
3432 
    &lt;smartcard mode='passthrough' type='spicevmc'/&gt;
E
smartcard: add XML support for <smartcard> device  
Eric Blake 已提交
3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 
  &lt;/devices&gt;
  ...
</pre>

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

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

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

      <dt><code>mode='passthrough'</code></dt>
      <dd>Rather than having the hypervisor directly communicate with
      the host, it is possible to tunnel all requests through a
      secondary character device to a third-party provider (which may
      in turn be talking to a smartcard or using three certificate
      files).  In this mode of operation, an additional
      attribute <code>type</code> is required, matching one of the
      supported <a href="#elementsConsole">serial device</a> types, to
E
smartcard: add spicevmc support  
Eric Blake 已提交
3475 3476 3477 3478 3479 
      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 已提交
3480 3481 3482 3483 3484 3485 3486 3487 3488 
      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 已提交
3489 3490 3491 
      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 已提交
3492 3493 3494 
      smartcard, with an address of bus=0 slot=0.
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
3495 3496 
    <h4><a name="elementsNICS">Network interfaces</a></h4>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3497 3498 3499 
<pre>
  ...
  &lt;devices&gt;
L
conf: add trustGuestRxFilters attribute to network and domain interface  
Laine Stump 已提交
3500 3501 3502 
    &lt;interface type='direct' trustGuestRxFilters='yes'&gt;
      &lt;source dev='eth0'/&gt;
      &lt;mac address='52:54:00:5d:c7:9e'/&gt;
J
Introduce per-device boot element  
Jiri Denemark 已提交
3503 
      &lt;boot order='1'/&gt;
L
qemu: (and conf) support rombar for network devices  
Laine Stump 已提交
3504 
      &lt;rom bar='off'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3505 3506 3507 
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
3508
E
docs: document <controller> element  
Eric Blake 已提交
3509 3510 3511 
    <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 已提交
3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 
      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 已提交
3524 
      only supported for the virtio device model and for macvtap
L
conf: add trustGuestRxFilters attribute to network and domain interface  
Laine Stump 已提交
3525 3526 3527 3528 
      connections on the host.
    </p>
    <p>
      Each <code>&lt;interface&gt;</code> element has an
E
docs: document <controller> element  
Eric Blake 已提交
3529 3530 
      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 已提交
3531 3532 
      attribute <code>type='pci'</code>
      as <a href="#elementsAddress">documented above</a>.
E
docs: document <controller> element  
Eric Blake 已提交
3533 3534 
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
3535 3536 3537 3538 3539 
    <h5><a name="elementsNICSVirtual">Virtual network</a></h5>

    <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 已提交
3540 3541 3542 3543 
      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 已提交
3544 3545 3546 3547 
      </em></strong>
    </p>

    <p>
L
conf: support abstracted interface info in domain interface XML  
Laine Stump 已提交
3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 

      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 已提交
3575 
      <a href="#elementsNICSTargetOverride">overriding the target element</a>).
D
Update domain XML docs  
Daniel P. Berrange 已提交
3576 
    </p>
L
conf: support abstracted interface info in domain interface XML  
Laine Stump 已提交
3577 3578 3579 3580 3581 3582 
    <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 已提交
3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 
      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 已提交
3602 3603 3604 3605 3606 
      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 已提交
3607 3608 3609 
      (<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 已提交
3610 
      an <code>profileid</code> (in case the switch is 802.1Qbh) and
L
network: merge relevant virtualports rather than choosing one  
Laine Stump 已提交
3611 3612 3613 3614 3615 3616 3617 3618 3619 
      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 已提交
3620 
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
3621
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3622 3623 3624 3625 3626 3627 3628 3629 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
    &lt;/interface&gt;
    ...
    &lt;interface type='network'&gt;
L
conf: support abstracted interface info in domain interface XML  
Laine Stump 已提交
3630 
      &lt;source network='default' portgroup='engineering'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3631 
      &lt;target dev='vnet7'/&gt;
R
Avoid using multicast addresses for Ethernet MAC examples  
redshift 已提交
3632 
      &lt;mac address="00:11:22:33:44:55"/&gt;
L
network: merge relevant virtualports rather than choosing one  
Laine Stump 已提交
3633 3634 
      &lt;virtualport&gt;
        &lt;parameters instanceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f'/&gt;
L
conf: support abstracted interface info in domain interface XML  
Laine Stump 已提交
3635 3636 
      &lt;/virtualport&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3637 3638 3639 
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
3640
D
Fix a number of small typos  
Dan Kenigsberg 已提交
3641 
    <h5><a name="elementsNICSBridge">Bridge to LAN</a></h5>
D
Update domain XML docs  
Daniel P. Berrange 已提交
3642 3643 3644 3645 

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

    <p>
E
docs: fix usage of 'onto'  
Eric Blake 已提交
3651 
      Provides a bridge from the VM directly to the LAN. This assumes
D
Update domain XML docs  
Daniel P. Berrange 已提交
3652 3653 3654 
      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 已提交
3655 3656 3657 3658 3659 
      &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 已提交
3660 
    </p>
L
network: merge relevant virtualports rather than choosing one  
Laine Stump 已提交
3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 
    <p>
      On Linux systems, the bridge device is normally a standard Linux
      host bridge. On hosts that support Open vSwitch, it is also
      possible to connect to an open vSwitch bridge device by adding
      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 已提交
3671 
      you do not specify one, a random interfaceid will be generated
L
network: merge relevant virtualports rather than choosing one  
Laine Stump 已提交
3672 3673 3674 3675 
      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 已提交
3676 3677 3678 
<pre>
  ...
  &lt;devices&gt;
L
network: merge relevant virtualports rather than choosing one  
Laine Stump 已提交
3679 
    ...
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3680 3681 3682 3683 
    &lt;interface type='bridge'&gt;
      &lt;source bridge='br0'/&gt;
    &lt;/interface&gt;
    &lt;interface type='bridge'&gt;
L
network: merge relevant virtualports rather than choosing one  
Laine Stump 已提交
3684 
      &lt;source bridge='br1'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3685 
      &lt;target dev='vnet7'/&gt;
R
Avoid using multicast addresses for Ethernet MAC examples  
redshift 已提交
3686 
      &lt;mac address="00:11:22:33:44:55"/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3687 
    &lt;/interface&gt;
L
network: merge relevant virtualports rather than choosing one  
Laine Stump 已提交
3688 3689 
    &lt;interface type='bridge'&gt;
      &lt;source bridge='ovsbr'/&gt;
E
docs: fix some typos in examples  
Eric Blake 已提交
3690 
      &lt;virtualport type='openvswitch'&gt;
L
network: merge relevant virtualports rather than choosing one  
Laine Stump 已提交
3691 3692 3693 3694 
        &lt;parameters profileid='menial' interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f'/&gt;
      &lt;/virtualport&gt;
    &lt;/interface&gt;
    ...
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3695 
  &lt;/devices&gt;
A
docs: schema and docs for the midonet virtualport type  
Antoni Segura Puimedon 已提交
3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 
  ...</pre>

    <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>
  ...
  &lt;devices&gt;
    ...
    &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;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3730 
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 

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

    <p>
      Provides a virtual LAN with NAT to the outside world. The virtual
      network has DHCP &amp; DNS services and will give the guest VM addresses
      starting from <code>10.0.2.15</code>. The default router will be
      <code>10.0.2.2</code> and the DNS server will be <code>10.0.2.3</code>.
      This networking is the only option for unprivileged users who need their
      VMs to have outgoing access.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3743 3744 3745 3746 3747 3748 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='user'/&gt;
    ...
    &lt;interface type='user'&gt;
R
Avoid using multicast addresses for Ethernet MAC examples  
redshift 已提交
3749 
      &lt;mac address="00:11:22:33:44:55"/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3750 3751 3752 
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 


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

    <p>
      Provides a means for the administrator to execute an arbitrary script
      to connect the guest's network to the LAN. The guest will have a tun
      device created with a name of vnetN, which can also be overridden with the
      &lt;target&gt; element. After creating the tun device a shell script will
      be run which is expected to do whatever host network integration is
      required. By default this script is called /etc/qemu-ifup but can be
      overridden.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='ethernet'/&gt;
    ...
    &lt;interface type='ethernet'&gt;
      &lt;target dev='vnet7'/&gt;
      &lt;script path='/etc/qemu-ifup-mynet'/&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
3778
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
3779 3780 3781 3782 
    <h5><a name="elementsNICSDirect">Direct attachment to physical interface</a></h5>

    <p>
      Provides direct attachment of the virtual machine's NIC to the given
Y
Fix minor typos in messages and docs  
Yuri Chornoivan 已提交
3783 
      physical interface of the host.
E
docs: correct invalid xml  
Eric Blake 已提交
3784 
      <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 已提交
3785 3786 3787 
      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 已提交
3788 
      ( <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 已提交
3789 
      'Virtual Ethernet Port Aggregator'</a>), 'bridge' or 'private'
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
3790 
      can be chosen for the operation mode of the macvtap device, 'vepa'
S
web docs -- macvtap mode explanation  
Stefan Berger 已提交
3791 3792 
      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 已提交
3793 
    </p>
L
conf: add trustGuestRxFilters attribute to network and domain interface  
Laine Stump 已提交
3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 
    <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 已提交
3806
S
web docs -- macvtap mode explanation  
Stefan Berger 已提交
3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 
    <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 已提交
3818 
      a VEPA capable bridge is required.</dd>
S
web docs -- macvtap mode explanation  
Stefan Berger 已提交
3819 3820 3821 3822 3823 3824 
      <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 已提交
3825 3826 3827 3828 3829 3830 3831 
      <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 已提交
3832 3833 
    </dl>
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
3834 3835 3836 3837 
<pre>
  ...
  &lt;devices&gt;
    ...
L
conf: add trustGuestRxFilters attribute to network and domain interface  
Laine Stump 已提交
3838 
    &lt;interface type='direct' trustGuestRxFilters='no'&gt;
S
Add descriptions for macvtap direct type interfaces  
Stefan Berger 已提交
3839 3840 3841 3842 3843 
      &lt;source dev='eth0' mode='vepa'/&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
G
documenting the 802.1Qbg parameters of a 'direct' interface  
Gerhard Stenzel 已提交
3844 3845 3846 3847 
    <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 已提交
3848 
    </p>
G
documenting the 802.1Qbg parameters of a 'direct' interface  
Gerhard Stenzel 已提交
3849 3850 3851 3852 3853 3854 3855 
    <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 已提交
3856 
      of a virtual machine. <span class="since">Since 0.8.2</span>
G
documenting the 802.1Qbg parameters of a 'direct' interface  
Gerhard Stenzel 已提交
3857 
    </p>
G
fix missing VLAN id for Qbg example  
Gerhard Stenzel 已提交
3858 3859 3860 3861 
    <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 已提交
3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 
    <dl>
      <dt><code>managerid</code></dt>
      <dd>The VSI Manager ID identifies the database containing the VSI type
        and instance definitions. This is an integer value and the
        value 0 is reserved.</dd>
      <dt><code>typeid</code></dt>
      <dd>The VSI Type ID identifies a VSI type characterizing the network
        access. VSI types are typically managed by network administrator.
        This is an integer value.
      </dd>
      <dt><code>typeidversion</code></dt>
      <dd>The VSI Type Version allows multiple versions of a VSI Type.
        This is an integer value.
      </dd>
      <dt><code>instanceid</code></dt>
      <dd>The VSI Instance ID Identifier is generated when a VSI instance
        (i.e. a virtual interface of a virtual machine) is created.
        This is a globally unique identifier.
      </dd>
    </dl>
<pre>
  ...
  &lt;devices&gt;
    ...
    &lt;interface type='direct'&gt;
G
fix missing VLAN id for Qbg example  
Gerhard Stenzel 已提交
3887 
      &lt;source dev='eth0.2' mode='vepa'/&gt;
G
documenting the 802.1Qbg parameters of a 'direct' interface  
Gerhard Stenzel 已提交
3888 3889 3890 3891 3892 3893 
      &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 已提交
3894
D
documenting the 802.1Qbh parameters of a 'direct' interface  
David S. Wang 已提交
3895 3896 3897 3898 3899 3900 3901 3902 3903 
    <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 已提交
3904 
        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 已提交
3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 
        profile database into the network parameters from the port profile,
        and those network parameters will be applied to this interface.
      </dd>
    </dl>
  <pre>
  ...
  &lt;devices&gt;
    ...
    &lt;interface type='direct'&gt;
      &lt;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>
L
conf: parse/format type='hostdev' network interfaces  
Laine Stump 已提交
3923 3924 3925 3926 3927 3928 3929 3930 

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

    <p>
      A PCI network device (specified by the &lt;source&gt; element)
      is directly assigned to the guest using generic device
      passthrough, after first optionally setting the device's MAC
      address to the configured value, and associating the device with
L
docs: small typo in formatdomain.html  
Laine Stump 已提交
3931 
      an 802.1Qbh capable switch using an optionally specified
L
docs: minor fixes to domain interface documentation  
Laine Stump 已提交
3932 
      &lt;virtualport&gt; element (see the examples of virtualport
L
conf: parse/format type='hostdev' network interfaces  
Laine Stump 已提交
3933 3934 3935 3936 3937 3938 3939 3940 3941 
      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 已提交
3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 
    <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 已提交
3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 
    <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 已提交
3968 3969 3970 3971 3972 3973 
    <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 已提交
3974 
      (or <code>virsh nodedev-detach</code>) before starting the guest
C
update documentation of <interface type='hostdev'>  
Chunyan Liu 已提交
3975 3976 3977 3978 3979 
      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 已提交
3980 3981 3982 
<pre>
  ...
  &lt;devices&gt;
C
update documentation of <interface type='hostdev'>  
Chunyan Liu 已提交
3983 
    &lt;interface type='hostdev' managed='yes'&gt;
L
conf: formatter/parser/RNG/docs for hostdev <driver name='kvm|vfio'/>  
Laine Stump 已提交
3984 
      &lt;driver name='vfio'/&gt;
L
conf: parse/format type='hostdev' network interfaces  
Laine Stump 已提交
3985 3986 3987 
      &lt;source&gt;
        &lt;address type='pci' domain='0x0000' bus='0x00' slot='0x07' function='0x0'/&gt;
      &lt;/source&gt;
L
docs: Fix missing slashes in XML examples  
Luyao Huang 已提交
3988 
      &lt;mac address='52:54:00:6d:90:02'/&gt;
L
conf: parse/format type='hostdev' network interfaces  
Laine Stump 已提交
3989 3990 3991 3992 3993 3994 3995 3996 
      &lt;virtualport type='802.1Qbh'&gt;
        &lt;parameters profileid='finance'/&gt;
      &lt;/virtualport&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 
    <h5><a name="elementsNICSMulticast">Multicast tunnel</a></h5>

    <p>
      A multicast group is setup to represent a virtual network. Any VMs
      whose network devices are in the same multicast group can talk to each
      other even across hosts. This mode is also available to unprivileged
      users. There is no default DNS or DHCP support and no outgoing network
      access. To provide outgoing network access, one of the VMs should have a
      2nd NIC which is connected to one of the first 4 network types and do the
      appropriate routing. The multicast protocol is compatible with that used
      by user mode linux guests too. The source address used must be from the
      multicast address block.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4011 4012 4013 4014 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='mcast'&gt;
L
docs: Fix missing slashes in XML examples  
Luyao Huang 已提交
4015 
      &lt;mac address='52:54:00:6d:90:01'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4016 4017 4018 4019 
      &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 已提交
4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 

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

    <p>
      A TCP client/server architecture provides a virtual network. One VM
      provides the server end of the network, all other VMS are configured as
      clients. All network traffic is routed between the VMs via the server.
      This mode is also available to unprivileged users. There is no default
      DNS or DHCP support and no outgoing network access. To provide outgoing
      network access, one of the VMs should have a 2nd NIC which is connected
      to one of the first 4 network types and do the appropriate routing.</p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4032 4033 4034 4035 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='server'&gt;
J
docs: fix missing forward slash  
Jianwei Hu 已提交
4036 
      &lt;mac address='52:54:00:22:c9:42'/&gt;
D
Update domain XML docs  
Daniel P. Berrange 已提交
4037 
      &lt;source address='192.168.0.1' port='5558'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4038 4039 4040 
    &lt;/interface&gt;
    ...
    &lt;interface type='client'&gt;
J
docs: fix missing forward slash  
Jianwei Hu 已提交
4041 
      &lt;mac address='52:54:00:8b:c9:51'/&gt;
L
docs: fix a few small typos in formatdomain.html.in  
Laine Stump 已提交
4042 
      &lt;source address='192.168.0.1' port='5558'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4043 4044 4045 
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4046
R
Documentation for NIC model selection.  
Richard W.M. Jones 已提交
4047 4048 
    <h5><a name="elementsNICSModel">Setting the NIC model</a></h5>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet1'/&gt;
      <b>&lt;model type='ne2k_pci'/&gt;</b>
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
R
Documentation for NIC model selection.  
Richard W.M. Jones 已提交
4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 

    <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 已提交
4081
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
4082 4083 4084 4085 4086 4087 4088 4089 4090 
    <h5><a name="elementsDriverBackendOptions">Setting NIC driver-specific options</a></h5>

<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet1'/&gt;
      &lt;model type='virtio'/&gt;
J
conf: add options for disabling segment offloading  
Ján Tomko 已提交
4091 
      <b>&lt;driver name='vhost' txmode='iothread' ioeventfd='on' event_idx='off' queues='5'&gt;
J
Add mrg_rxbuf option to virtio interfaces  
Ján Tomko 已提交
4092 
        &lt;host csum='off' gso='off' tso4='off' tso6='off' ecn='off' ufo='off' mrg_rxbuf='off'/&gt;
J
conf: add options for disabling segment offloading  
Ján Tomko 已提交
4093 4094 4095 
        &lt;guest csum='off' tso4='off' tso6='off' ecn='off' ufo='off'/&gt;
      &lt;/driver&gt;
      </b>
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>

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

    <dl>
E
docs: document <driver name='vhost'/> for interfaces  
Eric Blake 已提交
4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 
      <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 已提交
4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 
      <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>
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
4133 4134 4135 4136 4137 
      <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 已提交
4138 
        <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 已提交
4139 4140 4141 4142 

        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 已提交
4143 
        option).<br/><br/>
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
4144 4145 4146 4147 

        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 已提交
4148 
        fires, another attempt is made to send more data.<br/><br/>
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
4149 4150 4151 4152 4153 

        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 已提交
4154 
        cpu where the guest generated the packets."<br/><br/>
L
Add txmode attribute to interface XML for virtio backend  
Laine Stump 已提交
4155
M
qemu: domain I/O asynchronous handling  
Michal Privoznik 已提交
4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 
        <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 已提交
4172 
        <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 已提交
4173 4174 4175 4176 4177 4178 
        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 已提交
4179 
        - 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 已提交
4180 4181 4182 4183 4184 4185 4186 
        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 已提交
4187 4188 
        are very certain you know what you are doing.</b>
      </dd>
M
Introduce /domain/devices/interface/driver/@queues attribute  
Michal Privoznik 已提交
4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 
      <dt><code>queues</code></dt>
      <dd>
        The optional <code>queues</code> attribute controls the number of
        queues to be used for the<a href="http://www.linux-kvm.org/page/Multiqueue">
        Multiqueue virtio-net</a> feature. If the interface has <code>&lt;model
        type='virtio'/&gt;</code>, multiple packet processing queues can be
        created; each queue will potentially be handled by a different
        processor, resulting in much higher throughput.
        <span class="since">Since 1.0.6 (QEMU and KVM only)</span>
      </dd>
J
conf: add options for disabling segment offloading  
Ján Tomko 已提交
4199 4200 4201 4202 4203 4204 4205 4206 
      <dt><code>host</code> offloading options</dt>
      <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 已提交
4207 4208 4209 4210 
        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 已提交
4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 
      </dd>
      <dt><code>guest</code> offloading options</dt>
      <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 已提交
4221 4222 
    </dl>
J
conf: add backend element to interfaces  
Ján Tomko 已提交
4223 4224 4225 4226 4227 4228 4229 4230 4231 
    <h5><a name="elementsBackendOptions">Setting network backend-specific options</a></h5>

<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet1'/&gt;
      &lt;model type='virtio'/&gt;
J
docs: specify vhost-net instead of net-vhost  
Jianwei Hu 已提交
4232 
      <b>&lt;backend tap='/dev/net/tun' vhost='/dev/vhost-net'/&gt;</b>
J
conf: add backend element to interfaces  
Ján Tomko 已提交
4233 4234 4235 4236 4237 4238 4239 
      &lt;driver name='vhost' txmode='iothread' ioeventfd='on' event_idx='off' queues='5'/&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>

    <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 已提交
4240 4241 
      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 已提交
4242 4243 4244 
      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
      in session mode.
J
conf: add backend element to interfaces  
Ján Tomko 已提交
4245 
    </p>
C
Document overriding domain interface target  
Cole Robinson 已提交
4246 4247 
    <h5><a name="elementsNICSTargetOverride">Overriding the target element</a></h5>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4248 4249 4250 4251 4252 4253 4254 4255 4256 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      <b>&lt;target dev='vnet1'/&gt;</b>
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>
C
Document overriding domain interface target  
Cole Robinson 已提交
4257 4258 

    <p>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
4259 4260 
      If no target is specified, certain hypervisors will
      automatically generate a name for the created tun device. This
Y
Fix minor typos in messages and docs  
Yuri Chornoivan 已提交
4261 
      name can be manually specified, however the name <i>must not
E
docs: minor whitespace cleanups  
Eric Blake 已提交
4262 4263 4264 
      start with either 'vnet' or 'vif'</i>, which are prefixes
      reserved by libvirt and certain hypervisors. Manually specified
      targets using these prefixes will be ignored.
C
Document overriding domain interface target  
Cole Robinson 已提交
4265 4266 
    </p>
C
lxc network configuration allows setting target container NIC name  
Cédric Bosdonnat 已提交
4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 
    <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>
  ...
  &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>
J
Introduce per-device boot element  
Jiri Denemark 已提交
4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 
    <h5><a name="elementsNICSBoot">Specifying boot order</a></h5>

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

    <p>
L
docs: fix a few small typos in formatdomain.html.in  
Laine Stump 已提交
4298 
      For hypervisors which support this, you can set a specific NIC to
J
Introduce per-device boot element  
Jiri Denemark 已提交
4299 4300 4301 4302 4303 4304 4305 4306 
      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>
L
qemu: (and conf) support rombar for network devices  
Laine Stump 已提交
4307 4308 4309 4310 4311 4312 4313 4314 
    <h5><a name="elementsNICSROM">Interface ROM BIOS configuration</a></h5>

<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet1'/&gt;
L
qemu: add "romfile" support to specify device boot ROM  
Laine Stump 已提交
4315 
      <b>&lt;rom bar='on' file='/etc/fake/boot.bin'/&gt;</b>
L
qemu: (and conf) support rombar for network devices  
Laine Stump 已提交
4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>

    <p>
      For hypervisors which support this, you can change how a PCI Network
      device's ROM is presented to the guest. The <code>bar</code>
      attribute can be set to "on" or "off", and determines whether
      or not the device's ROM will be visible in the guest's memory
      map. (In PCI documentation, the "rombar" setting controls the
      presence of the Base Address Register for the ROM). If no rom
      bar is specified, the qemu default will be used (older
      versions of qemu used a default of "off", while newer qemus
L
qemu: add "romfile" support to specify device boot ROM  
Laine Stump 已提交
4329 4330 4331 4332 4333 4334 
      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 已提交
4335 
    </p>
M
conf: support backend domain name in disk and network devices  
Marek Marczykowski 已提交
4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 
    <h5><a name="elementDomain">Setting up a network backend in a driver domain</a></h5>
<pre>
  ...
  &lt;devices&gt;
    ...
    &lt;interface type='bridge'&gt;
      &lt;source bridge='br0'/&gt;
      <b>&lt;backenddomain name='netvm'/&gt;</b>
    &lt;/interface&gt;
    ...
  &lt;/devices&gt;
  ...</pre>

    <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 已提交
4359
M
bandwidth: Define schema and create documentation  
Michal Privoznik 已提交
4360 4361 4362 4363 4364 4365 4366 4367 4368 
    <h5><a name="elementQoS">Quality of service</a></h5>

<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet0'/&gt;
      <b>&lt;bandwidth&gt;
M
bandwidth: add new 'floor' attribute  
Michal Privoznik 已提交
4369 
        &lt;inbound average='1000' peak='5000' floor='200' burst='1024'/&gt;
M
bandwidth: Define schema and create documentation  
Michal Privoznik 已提交
4370 4371 4372 
        &lt;outbound average='128' peak='256' burst='256'/&gt;
      &lt;/bandwidth&gt;</b>
    &lt;/interface&gt;
M
docs: formatdomain.html fixes  
Michele Paolino 已提交
4373 
  &lt;/devices&gt;
M
bandwidth: Define schema and create documentation  
Michal Privoznik 已提交
4374 4375 4376 4377 
  ...</pre>

    <p>
      This part of interface XML provides setting quality of service. Incoming
J
bandwidth: Adjust documentation  
John Ferlan 已提交
4378 4379 4380 4381 
      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 已提交
4382 4383 
    </p>
L
conf: add <vlan> element to network and domain interface elements  
Laine Stump 已提交
4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 
    <h5><a name="elementVlanTag">Setting VLAN tag (on supported network types only)</a></h5>

<pre>
  ...
  &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;
J
Configure native vlan modes on Open vSwitch ports  
james robson 已提交
4398 4399 4400 4401 4402 4403 4404 
    &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;
M
docs: formatdomain.html fixes  
Michele Paolino 已提交
4405 
  &lt;/devices&gt;
L
conf: add <vlan> element to network and domain interface elements  
Laine Stump 已提交
4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 
  ...</pre>

    <p>
      If (and only if) the network connection used by the guest
      supports vlan tagging transparent to the guest, an
      optional <code>&lt;vlan&gt;</code> element can specify one or
      more vlan tags to apply to the guest's network
      traffic <span class="since">Since 0.10.0</span>. (openvswitch
      and type='hostdev' SR-IOV interfaces do support transparent vlan
      tagging of guest traffic; everything else, including standard
      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
      onto specific vlans.) To allow for specification of multiple
      tags (in the case of vlan trunking), a
P
documentation: HTML tag fix  
Philipp Hahn 已提交
4421 
      subelement, <code>&lt;tag&gt;</code>, specifies which vlan tag
L
conf: add <vlan> element to network and domain interface elements  
Laine Stump 已提交
4422 4423 4424 4425 4426 4427 4428 4429 4430 
      to use (for example: <code>&lt;tag id='42'/&gt;</code>. If an
      interface has more than one <code>&lt;vlan&gt;</code> element
      defined, it is assumed that the user wants to do VLAN trunking
      using all the specified tags. In the case that vlan trunking
      with a single tag is desired, the optional
      attribute <code>trunk='yes'</code> can be added to the toplevel
      vlan element.
    </p>
J
Configure native vlan modes on Open vSwitch ports  
james robson 已提交
4431 4432 4433 
    <p>
      For network connections using openvswitch it is possible to
      configure the 'native-tagged' and 'native-untagged' vlan modes
J
Use 1.1.0 everywhere in the documentation  
Ján Tomko 已提交
4434 
      <span class="since">Since 1.1.0.</span> This uses the optional
J
Configure native vlan modes on Open vSwitch ports  
james robson 已提交
4435 4436 
      <code>nativeMode</code> attribute on the <code>&lt;tag&gt;</code>
      element: <code>nativeMode</code> may be set to 'tagged' or
O
docs, comments: minor typo fixes  
Oskari Saarenmaa 已提交
4437 
      'untagged'. The id attribute of the element sets the native vlan.
J
Configure native vlan modes on Open vSwitch ports  
james robson 已提交
4438 4439 
    </p>
C
Fix typo in domain XML documentation  
Christophe Fergeau 已提交
4440 
    <h5><a name="elementLink">Modifying virtual link state</a></h5>
P
link-state: conf: Add element to XML for controling link state  
Peter Krempa 已提交
4441 4442 4443 4444 4445 4446 4447 4448 
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet0'/&gt;
      <b>&lt;link state='down'/&gt;</b>
    &lt;/interface&gt;
M
docs: formatdomain.html fixes  
Michele Paolino 已提交
4449 
  &lt;/devices&gt;
P
link-state: conf: Add element to XML for controling link state  
Peter Krempa 已提交
4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 
  ...</pre>

    <p>
      This element provides means of setting state of the virtual network link.
      Possible values for attribute <code>state</code> are <code>up</code> and
      <code>down</code>. If <code>down</code> is specified as the value, the interface
      behaves as if it had the network cable disconnected. Default behavior if this
      element is unspecified is to have the link state <code>up</code>.
      <span class="since">Since 0.9.5</span>
    </p>
C
Domain conf: allow more than one IP address for net devices  
Cédric Bosdonnat 已提交
4461 4462 4463 4464 4465 4466 4467 
    <h5><a name="ipconfig">IP configuration</a></h5>
<pre>
  ...
  &lt;devices&gt;
    &lt;interface type='network'&gt;
      &lt;source network='default'/&gt;
      &lt;target dev='vnet0'/&gt;
C
Domain network devices can now have a <route> element  
Cédric Bosdonnat 已提交
4468 4469 4470 
      <b>&lt;ip address='192.168.122.5' prefix='24'/&gt;</b>
      <b>&lt;route family='ipv4' address='192.168.122.0' prefix='24' via='192.168.122.1'/&gt;</b>
      <b>&lt;route family='ipv4' via='192.168.122.1'/&gt;</b>
C
Domain conf: allow more than one IP address for net devices  
Cédric Bosdonnat 已提交
4471 
    &lt;/interface&gt;
C
Allow network capabilities hostdev to configure IP addresses  
Cédric Bosdonnat 已提交
4472 4473 4474 4475 4476 
    ...
    &lt;hostdev mode='capabilities' type='net'&gt;
      &lt;source&gt;
        &lt;interface&gt;eth0&lt;/interface&gt;
      &lt;/source&gt;
C
Domain network devices can now have a <route> element  
Cédric Bosdonnat 已提交
4477 4478 4479 
      <b>&lt;ip address='192.168.122.6' prefix='24'/&gt;</b>
      <b>&lt;route family='ipv4' address='192.168.122.0' prefix='24' via='192.168.122.1'/&gt;</b>
      <b>&lt;route family='ipv4' via='192.168.122.1'/&gt;</b>
C
Allow network capabilities hostdev to configure IP addresses  
Cédric Bosdonnat 已提交
4480 4481 
    &lt;/hostdev&gt;
C
Domain conf: allow more than one IP address for net devices  
Cédric Bosdonnat 已提交
4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 
  &lt;/devices&gt;
  ...
</pre>

    <p>
    <span class="since">Since 1.2.12</span> the network devices and host devices
    with network capabilities can be provided zero or more IP addresses to set
    on the target device. 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>, the
    <code>address</code> attribute holds the IP address. The <code>prefix</code>
    is not mandatory since some hypervisors do not handle it.
    </p>
C
Domain network devices can now have a <route> element  
Cédric Bosdonnat 已提交
4496 4497 
    <p>
    <span class="since">Since 1.2.12</span> route elements can also be added
C
Use the network route definitions for domains  
Cédric Bosdonnat 已提交
4498 4499 4500 
    to define the network routes to use for the network device. 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>.
C
Domain network devices can now have a <route> element  
Cédric Bosdonnat 已提交
4501 4502 4503 
    This is only used by the LXC driver.
    </p>
M
support for QEMU vhost-user  
Michele Paolino 已提交
4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 
    <h5><a name="elementVhostuser">vhost-user interface</a></h5>

    <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>
  ...
  &lt;devices&gt;
    &lt;interface type='vhostuser'&gt;
      &lt;mac address='52:54:00:3b:83:1a'/&gt;
      &lt;source type='unix' path='/tmp/vhost.sock' mode='server'/&gt;
      &lt;model type='virtio'/&gt;
    &lt;/interface&gt;
  &lt;/devices&gt;
  ...</pre>

    <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.
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4535 4536 4537 
    <h4><a name="elementsInput">Input devices</a></h4>

    <p>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
4538 4539 4540 4541 
      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 已提交
4542 4543 4544 
      to provide a graphics tablet for absolute cursor movement.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4545 4546 4547 4548 
<pre>
  ...
  &lt;devices&gt;
    &lt;input type='mouse' bus='usb'/&gt;
J
Document the keyboard as a valid input type  
Ján Tomko 已提交
4549 
    &lt;input type='keyboard' bus='usb'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4550 4551 
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4552 4553 4554 

    <dl>
      <dt><code>input</code></dt>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
4555 
      <dd>The <code>input</code> element has one mandatory attribute,
J
Document the keyboard as a valid input type  
Ján Tomko 已提交
4556 4557 4558 4559 
        the <code>type</code> whose value can be 'mouse', 'tablet' or
        (<span class="since">since 1.2.2</span>) 'keyboard'.
        The tablet provides absolute cursor movement,
        while the mouse uses relative movement. The optional
M
Cleanup whitespace in docs  
Matthew Booth 已提交
4560 4561 
        <code>bus</code> attribute can be used to refine the exact device type.
        It takes values "xen" (paravirtualized), "ps2" and "usb".</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4562 4563 
    </dl>
E
docs: document <controller> element  
Eric Blake 已提交
4564 4565 4566 
    <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 已提交
4567 4568 
      device to a particular PCI
      slot, <a href="#elementsAddress">documented above</a>.
E
docs: document <controller> element  
Eric Blake 已提交
4569 
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4570
M
Add USB hub device  
Marc-André Lureau 已提交
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 
    <h4><a name="elementsHub">Hub devices</a></h4>

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

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

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

    <p>
      The <code>hub</code> element has an optional
E
docs: document <address> elements in one place  
Eric Blake 已提交
4594 4595 4596 4597 
      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 已提交
4598 4599 
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4600 4601 4602 4603 4604 4605 4606 4607 4608 
    <h4><a name="elementsGraphics">Graphical framebuffers</a></h4>

    <p>
      A graphics device allows for graphical interaction with the
      guest OS. A guest will typically have either a framebuffer
      or a text console configured to allow interaction with the
      admin.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4609 4610 4611 4612 
<pre>
  ...
  &lt;devices&gt;
    &lt;graphics type='sdl' display=':0.0'/&gt;
G
conf: add 'sharePolicy' attribute to graphics element for vnc  
Guannan Ren 已提交
4613 
    &lt;graphics type='vnc' port='5904' sharePolicy='allow-exclusive'&gt;
L
conf: add <listen> subelement to domain <graphics> element  
Laine Stump 已提交
4614 4615 
      &lt;listen type='address' address='1.2.3.4'/&gt;
    &lt;/graphics&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4616 4617 
    &lt;graphics type='rdp' autoport='yes' multiUser='yes' /&gt;
    &lt;graphics type='desktop' fullscreen='yes'/&gt;
L
conf: add <listen> subelement to domain <graphics> element  
Laine Stump 已提交
4618 4619 4620 
    &lt;graphics type='spice'&gt;
      &lt;listen type='network' network='rednet'/&gt;
    &lt;/graphics&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4621 4622 
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4623 4624 4625 4626 

    <dl>
      <dt><code>graphics</code></dt>
      <dd>The <code>graphics</code> element has a mandatory <code>type</code>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
4627 
        attribute which takes the value "sdl", "vnc", "rdp" or "desktop":
F
add doc for graphic and video elements  
Florian Vichot 已提交
4628 4629 4630 
        <dl>
          <dt><code>"sdl"</code></dt>
          <dd>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
4631 4632 4633 4634 4635 4636 
            This displays a window on the host desktop, it can take 3
            optional arguments: a <code>display</code> attribute for
            the display to use, an <code>xauth</code> attribute for
            the authentication identifier, and an
            optional <code>fullscreen</code> attribute accepting
            values 'yes' or 'no'.
F
add doc for graphic and video elements  
Florian Vichot 已提交
4637 4638 4639 
          </dd>
          <dt><code>"vnc"</code></dt>
          <dd>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 
            Starts a VNC server. The <code>port</code> attribute
            specifies the TCP port number (with -1 as legacy syntax
            indicating that it should be
            auto-allocated). The <code>autoport</code> attribute is
            the new preferred syntax for indicating autoallocation of
            the TCP port to use.  The <code>listen</code> attribute is
            an IP address for the server to listen
            on. The <code>passwd</code> attribute provides a VNC
            password in clear text. The <code>keymap</code> attribute
            specifies the keymap to use. It is possible to set a limit
            on the validity of the password be giving an
            timestamp <code>passwdValidTo='2010-04-09T15:51:00'</code>
M
graphics: add support for action_if_connected in qemu  
Michal Privoznik 已提交
4652 4653 4654 4655 
            assumed to be in UTC. The <code>connected</code> attribute
            allows control of connected client during password changes.
            VNC accepts <code>keep</code> value only.
            <span class="since">since 0.9.3</span>
G
conf: add 'sharePolicy' attribute to graphics element for vnc  
Guannan Ren 已提交
4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 
            NB, this may not be supported by all hypervisors.<br/>
            The optional <code>sharePolicy</code> attribute specifies vnc server
            display sharing policy. "allow-exclusive" 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. "force-shared" disables exclusive client access, every
            connection has to specify -Shared switch for vncviewer. "ignore"
            welcomes every connection unconditionally
            <span class="since">since 1.0.6</span>. <br/> <br/>
M
graphics: add support for action_if_connected in qemu  
Michal Privoznik 已提交
4666 4667 4668 
            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>
M
Add VNC WebSocket support  
Martin Kletzander 已提交
4669 4670 4671 4672 4673 4674 

            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>
D
Add a <graphics> type for SPICE protocol  
Daniel P. Berrange 已提交
4675 4676 4677 
          </dd>
          <dt><code>"spice"</code></dt>
          <dd>
E
maint: whitespace cleanup  
Eric Blake 已提交
4678 
            <p>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
4679 4680 4681 4682 4683 4684 
              Starts a SPICE server. The <code>port</code> attribute
              specifies the TCP port number (with -1 as legacy syntax
              indicating that it should be auto-allocated),
              while <code>tlsPort</code> gives an alternative secure
              port number. The <code>autoport</code> attribute is the
              new preferred syntax for indicating autoallocation of
P
qemu: Do sensible auto allocation of SPICE port numbers  
Peter Krempa 已提交
4685 
              needed port numbers.  The <code>listen</code> attribute is
E
docs: minor whitespace cleanups  
Eric Blake 已提交
4686 4687 4688 4689 4690 4691 
              an IP address for the server to listen
              on. The <code>passwd</code> attribute provides a SPICE
              password in clear text. The <code>keymap</code>
              attribute specifies the keymap to use. It is possible to
              set a limit on the validity of the password be giving an
              timestamp <code>passwdValidTo='2010-04-09T15:51:00'</code>
M
graphics: add support for action_if_connected in qemu  
Michal Privoznik 已提交
4692 4693 4694 4695 4696 4697 4698 4699 
              assumed to be in UTC. The <code>connected</code> attribute
              allows control of connected client during password changes.
              SPICE accepts <code>keep</code> to keep client connected,
              <code>disconnect</code> to disconnect client and
              <code>fail</code> to fail changing password.
              <span class="since">Since 0.9.3</span>
              NB, this may not be supported by all hypervisors.
              <span class="since">"spice" since 0.8.6</span>.
A
domain_conf: add "default" to list of valid spice channels  
Alon Levy 已提交
4700 4701 4702 4703 4704 4705 4706 
              The <code>defaultMode</code> attribute sets the default channel
              security policy, valid values are <code>secure</code>,
              <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">"defaultMode" since
              0.9.12</span>.
E
maint: whitespace cleanup  
Eric Blake 已提交
4707 4708 
            </p>
            <p>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
4709 4710 4711 4712 
              When SPICE has both a normal and TLS secured TCP port
              configured, it can be desirable to restrict what
              channels can be run on each port.  This is achieved by
              adding one or more &lt;channel&gt; elements inside the
P
doc: Explicitly specify how to override spice channel mode  
Peter Krempa 已提交
4713 4714 4715 4716 4717 4718 4719 
              main &lt;graphics&gt; 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
              <code>any</code> as mode discards the entry as the channel would
              inherit the default mode anyways)
              Valid channel names
E
docs: minor whitespace cleanups  
Eric Blake 已提交
4720 4721 
              include <code>main</code>, <code>display</code>,
              <code>inputs</code>, <code>cursor</code>,
A
domain_conf: add "usbredir" to list of valid spice channels  
Alon Levy 已提交
4722 4723 4724 4725 4726 
              <code>playback</code>, <code>record</code>
              (all <span class="since"> since 0.8.6</span>);
              <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 已提交
4727 4728 
            </p>
            <pre>
D
Support SPICE channel security options  
Daniel P. Berrange 已提交
4729 4730 4731 
  &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;
M
Spice: support audio, images and stream compression  
Michal Privoznik 已提交
4732 
    &lt;image compression='auto_glz'/&gt;
A
spice: support streaming-video parameter  
Alon Levy 已提交
4733 
    &lt;streaming mode='filter'/&gt;
M
spice: add <clipboard copypaste='yes|no'> option  
Marc-André Lureau 已提交
4734 
    &lt;clipboard copypaste='no'/&gt;
P
qemu: spice agent-mouse support  
Peng Zhou 已提交
4735 
    &lt;mouse mode='client'/&gt;
F
spice: expose the QEMU disable file transfer option  
Francesco Romani 已提交
4736 
    &lt;filetransfer enable='no'/&gt;
D
Support SPICE channel security options  
Daniel P. Berrange 已提交
4737 
  &lt;/graphics&gt;</pre>
M
Spice: support audio, images and stream compression  
Michal Privoznik 已提交
4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 
            <p>
              Spice supports variable compression settings for audio,
              images and streaming, <span class="since">since
              0.9.1</span>.  These settings are accessible via
              the <code>compression</code> attribute in all following
              elements: <code>image</code> to set image compression
              (accepts <code>auto_glz</code>, <code>auto_lz</code>,
              <code>quic</code>, <code>glz</code>, <code>lz</code>,
              <code>off</code>), <code>jpeg</code> for JPEG
              compression for images over wan
              (accepts <code>auto</code>, <code>never</code>,
              <code>always</code>), <code>zlib</code> for configuring
              wan image compression (accepts <code>auto</code>,
              <code>never</code>, <code>always</code>)
              and <code>playback</code> for enabling audio stream
              compression (accepts <code>on</code> or <code>off</code>).
            </p>
A
spice: support streaming-video parameter  
Alon Levy 已提交
4755 4756 
            <p>
              Streaming mode is set by the <code>streaming</code>
Z
docs: fix typo  
Zhou Peng 已提交
4757 
              element, settings its <code>mode</code> attribute to one
A
spice: support streaming-video parameter  
Alon Levy 已提交
4758 4759 4760 
              of <code>filter</code>, <code>all</code>
              or <code>off</code>, <span class="since">since 0.9.2</span>.
            </p>
M
spice: add <clipboard copypaste='yes|no'> option  
Marc-André Lureau 已提交
4761 4762 4763 4764 4765 4766 4767 
            <p>
              Copy &amp; Paste functionality (via Spice agent) is set
              by the <code>clipboard</code> element. It is enabled by
              default, and can be disabled by setting
              the <code>copypaste</code> property
              to <code>no</code>, <span class="since">since
              0.9.3</span>.
M
docs: Fix spice documentation typo  
Michal Privoznik 已提交
4768 
            </p>
P
qemu: spice agent-mouse support  
Peng Zhou 已提交
4769 
            <p>
Z
docs: fix typo  
Zhou Peng 已提交
4770 4771 
              Mouse mode is set by the <code>mouse</code> element,
              setting its <code>mode</code> attribute to one of
P
qemu: spice agent-mouse support  
Peng Zhou 已提交
4772 4773 4774 4775 
              <code>server</code> or <code>client</code> ,
              <span class="since">since 0.9.11</span>. If no mode is
              specified, the qemu default will be used (client mode).
            </p>
F
spice: expose the QEMU disable file transfer option  
Francesco Romani 已提交
4776 4777 4778 4779 4780 4781 4782 
            <p>
              File transfer functionality (via Spice agent) is set using the
              <code>filetransfer</code> element.
              It is enabled by default, and can be disabled by setting the
              <code>enable</code> property to <code>no</code> ,
              since <span class="since">since 1.2.2</span>.
            </p>
F
add doc for graphic and video elements  
Florian Vichot 已提交
4783 4784 4785 
          </dd>
          <dt><code>"rdp"</code></dt>
          <dd>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
4786 4787 4788 4789 4790 4791 4792 4793 
            Starts a RDP server. The <code>port</code> attribute
            specifies the TCP port number (with -1 as legacy syntax
            indicating that it should be
            auto-allocated). The <code>autoport</code> attribute is
            the new preferred syntax for indicating autoallocation of
            the TCP port to use. The <code>replaceUser</code>
            attribute is a boolean deciding whether multiple
            simultaneous connections to the VM are permitted.
C
docs: Fix truncated sentence in RDP 'multiUser' attribute  
Christophe Fergeau 已提交
4794 4795 4796 4797 
            The <code>multiUser</code> attribute is a boolean deciding
            whether the existing connection must be dropped and a new
            connection must be established by the VRDP server, when a
            new client connects in single connection mode.
F
add doc for graphic and video elements  
Florian Vichot 已提交
4798 4799 4800 
          </dd>
          <dt><code>"desktop"</code></dt>
          <dd>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
4801 4802 4803 4804 4805 4806 
            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>.
F
add doc for graphic and video elements  
Florian Vichot 已提交
4807 4808 4809 4810 4811 
          </dd>
        </dl>
      </dd>
    </dl>
L
conf: add <listen> subelement to domain <graphics> element  
Laine Stump 已提交
4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 
    <p>
      Rather than putting the address information used to set up the
      listening socket for graphics types <code>vnc</code>
      and <code>spice</code> in
      the <code>&lt;graphics&gt;</code> <code>listen</code> attribute,
      a separate subelement of <code>&lt;graphics&gt;</code>,
      called <code>&lt;listen&gt;</code> can be specified (see the
      examples above)<span class="since">since
      0.9.4</span>. <code>&lt;listen&gt;</code> accepts the following
      attributes:
    </p>
    <dl>
      <dt><code>type</code></dt>
      <dd>Set to either <code>address</code>
        or <code>network</code>. This tells whether this listen
        element is specifying the address to be used directly, or by
        naming a network (which will then be used to determine an
        appropriate address for listening).
      </dd>
    </dl>
    <dl>
      <dt><code>address</code></dt>
      <dd>if <code>type='address'</code>, the <code>address</code>
        attribute will contain either an IP address or hostname (which
        will be resolved to an IP address via a DNS query) to listen
        on. In the "live" XML of a running domain, this attribute will
        be set to the IP address used for listening, even
        if <code>type='network'</code>.
      </dd>
    </dl>
    <dl>
      <dt><code>network</code></dt>
      <dd>if <code>type='network'</code>, the <code>network</code>
        attribute will contain the name of a network in libvirt's list
        of configured networks. The named network configuration will
        be examined to determine an appropriate listen address. For
        example, if the network has an IPv4 address in its
        configuration (e.g. if it has a forward type
        of <code>route</code>, <code>nat</code>, or no forward type
        (isolated)), the first IPv4 address listed in the network's
        configuration will be used. If the network is describing a
        host bridge, the first IPv4 address associated with that
        bridge device will be used, and if the network is describing
        one of the 'direct' (macvtap) modes, the first IPv4 address of
        the first forward dev will be used.
      </dd>
    </dl>
F
add doc for graphic and video elements  
Florian Vichot 已提交
4860 4861 4862 4863 4864 
    <h4><a name="elementsVideo">Video devices</a></h4>
    <p>
      A video device.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4865 4866 4867 4868 
<pre>
  ...
  &lt;devices&gt;
    &lt;video&gt;
P
video: cleanup usage of vram attribute and update documentation  
Pavel Hrdina 已提交
4869 
      &lt;model type='vga' vram='16384' heads='1'&gt;
M
docs: typo in acceleration element  
Martin Kletzander 已提交
4870 
        &lt;acceleration accel3d='yes' accel2d='yes'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4871 4872 4873 4874 
      &lt;/model&gt;
    &lt;/video&gt;
  &lt;/devices&gt;
  ...</pre>
F
add doc for graphic and video elements  
Florian Vichot 已提交
4875 4876 4877 

    <dl>
      <dt><code>video</code></dt>
M
Fix and improve domain xml video element description  
Matthias Bolte 已提交
4878 
      <dd>
P
video: cleanup usage of vram attribute and update documentation  
Pavel Hrdina 已提交
4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 
        <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
          video device. The non-primary must be type of "qxl".
        </p>
M
Fix and improve domain xml video element description  
Matthias Bolte 已提交
4895 
      </dd>
F
add doc for graphic and video elements  
Florian Vichot 已提交
4896
M
Fix and improve domain xml video element description  
Matthias Bolte 已提交
4897 4898 
      <dt><code>model</code></dt>
      <dd>
P
video: cleanup usage of vram attribute and update documentation  
Pavel Hrdina 已提交
4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 
        <p>
          The <code>model</code> element has a mandatory <code>type</code>
          attribute which takes the value "vga", "cirrus", "vmvga", "xen",
          "vbox", or "qxl" (<span class="since">since 0.8.6</span>) depending
          on the hypervisor features available.
        </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
          type of "libxl", "parallels", "qemu", "vbox", "vmx" and "xen". If no
          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
          supported only for guests type of "parallels", "kvm", "vbox" and "vmx".
        </p>
        <p>
          For guest type of kvm the optional attribute <code>ram</code>
          (<span class="since">since 1.0.2</span>) is allowed for "qxl" type
          only and specifies the size of the primary bar, while the optional
          attribute <code>vram</code> specifies the secondary bar size.
          If "ram" or "vram" are not supplied a default value is used. The ram
P
qemu-command: introduce new vgamem attribute for QXL video device  
Pavel Hrdina 已提交
4922 4923 4924 4925 
          should also be rounded to power of two as vram. There is also optional
          attribute <code>vgamem</code> (<span class="since">since 1.2.11 (QEMU
          only)</span>) to set the size of VGA framebuffer for fallback mode of
          QXL device.
P
video: cleanup usage of vram attribute and update documentation  
Pavel Hrdina 已提交
4926 
        </p>
M
Fix and improve domain xml video element description  
Matthias Bolte 已提交
4927 4928 4929 4930 4931 4932 4933 4934 
      </dd>

      <dt><code>acceleration</code></dt>
      <dd>
        If acceleration should be enabled (if supported) using the
        <code>accel3d</code> and <code>accel2d</code> attributes in the
        <code>acceleration</code> element.
      </dd>
E
docs: document <controller> element  
Eric Blake 已提交
4935 4936 4937 4938 4939 4940 

      <dt><code>address</code></dt>
      <dd>
        The optional <code>address</code> sub-element can be used to
        tie the video device to a particular PCI slot.
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4941 4942 
    </dl>
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
4943 
    <h4><a name="elementsConsole">Consoles, serial, parallel &amp; channel devices</a></h4>
D
Update domain XML docs  
Daniel P. Berrange 已提交
4944 4945 4946 

    <p>
      A character device provides a way to interact with the virtual machine.
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
4947 4948 
      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 已提交
4949 4950 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 
<pre>
  ...
  &lt;devices&gt;
    &lt;parallel type='pty'&gt;
      &lt;source path='/dev/pts/2'/&gt;
      &lt;target port='0'/&gt;
    &lt;/parallel&gt;
    &lt;serial type='pty'&gt;
      &lt;source path='/dev/pts/3'/&gt;
      &lt;target port='0'/&gt;
    &lt;/serial&gt;
L
docs: Fix missing slashes in XML examples  
Luyao Huang 已提交
4962 
    &lt;serial type='file'&gt;
J
docs: add a serial device with a seclabel example  
Ján Tomko 已提交
4963 4964 4965 
      &lt;source path='/tmp/file'&gt;
        &lt;seclabel model='dac' relabel='no'/&gt;
      &lt;/source&gt;
L
docs: Fix missing slashes in XML examples  
Luyao Huang 已提交
4966 
      &lt;target port='0'/&gt;
J
docs: add a serial device with a seclabel example  
Ján Tomko 已提交
4967 
    &lt;/serial&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 
    &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 已提交
4978
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
4979 4980 4981 4982 4983 
    <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 已提交
4984
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
4985 4986 4987 4988 4989 4990 
    <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 已提交
4991 4992 4993 4994 4995 4996 4997 4998 
    <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>
E
docs: document <controller> element  
Eric Blake 已提交
4999 5000 5001 5002 5003 5004 5005 5006 
    <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>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5007 5008 5009 5010 5011 5012 5013 5014 5015 
    <h5><a name="elementsCharGuestInterface">Guest interface</a></h5>

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

    <h6><a name="elementCharParallel">Parallel port</a></h6>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5016 5017 5018 5019 5020 5021 5022 5023 5024 
<pre>
  ...
  &lt;devices&gt;
    &lt;parallel type='pty'&gt;
      &lt;source path='/dev/pts/2'/&gt;
      &lt;target port='0'/&gt;
    &lt;/parallel&gt;
  &lt;/devices&gt;
  ...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5025 5026 5027 

    <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 已提交
5028 
      specifies the port number. Ports are numbered starting from 0. There are
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5029 5030 5031 5032 5033 
      usually 0, 1 or 2 parallel ports.
    </p>

    <h6><a name="elementCharSerial">Serial port</a></h6>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5034 5035 5036 5037 5038 5039 5040 5041 5042 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type='pty'&gt;
      &lt;source path='/dev/pts/3'/&gt;
      &lt;target port='0'/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5043 5044 5045 

    <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 已提交
5046 
      specifies the port number. Ports are numbered starting from 0. There are
G
qemu: add usb-serial support  
Guannan Ren 已提交
5047 5048 
      usually 0, 1 or 2 serial ports. There is also an optional
      <code>type</code> attribute <span class="since">since 1.0.2</span>
L
docs: fix typo in isa-serial additions  
Laine Stump 已提交
5049 
      which has two choices for its value, one is <code>isa-serial</code>,
G
qemu: add usb-serial support  
Guannan Ren 已提交
5050 5051 5052 5053 5054 
      the other is <code>usb-serial</code>. If <code>type</code> is missing,
      <code>isa-serial</code> will be used by default. For <code>usb-serial</code>
      an optional sub-element <code>&lt;address&gt;</code> with
      <code>type='usb'</code> can tie the device to a particular controller,
      <a href="#elementsAddress">documented above</a>.
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5055 5056 5057 5058 5059 
    </p>

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

    <p>
D
Allow multiple consoles per virtual guest  
Daniel P. Berrange 已提交
5060 5061 5062 5063 5064 5065 5066 
      The console element is used to represent interactive consoles. Depending
      on the type of guest in use, the consoles might be paravirtualized devices,
      or they might be a clone of a serial device, according to the following
      rules:
    </p>

    <ul>
J
S390: Add SCLP console front end support  
J.B. Joret 已提交
5067 
      <li>If no <code>targetType</code> attribute is set, then the default
D
Allow multiple consoles per virtual guest  
Daniel P. Berrange 已提交
5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 
        device type is according to the hypervisor's rules. The default
        type will be added when re-querying the XML fed into libvirt.
        For fully virtualized guests, the default device type will usually
        be a serial port.</li>
      <li>If the <code>targetType</code> attribute is <code>serial</code>,
        then if no <code>&lt;serial&gt;</code> element exists, the console
        element will be copied to the serial element. If a <code>&lt;serial&gt;</code>
        element does already exist, the console element will be ignored.</li>
      <li>If the <code>targetType</code> attribute is not <code>serial</code>,
        it will be treated normally.</li>
      <li>Only the first <code>console</code> element may use a <code>targetType</code>
        of <code>serial</code>. Secondary consoles must all be paravirtualized.
      </li>
J
S390: Add SCLP console front end support  
J.B. Joret 已提交
5081 5082 5083 5084 5085 5086 
      <li>On s390, the <code>console</code> element may use a
        <code>targetType</code> of <code>sclp</code> or <code>sclplm</code>
        (line mode). SCLP is the native console type for s390. There's no
        controller associated to SCLP consoles.
        <span class="since">Since 1.0.2</span>
      </li>
D
Allow multiple consoles per virtual guest  
Daniel P. Berrange 已提交
5087 
    </ul>
C
qemu: virtio console support  
Cole Robinson 已提交
5088 5089 5090 5091 5092 5093 

    <p>
      A virtio console device is exposed in the
      guest as /dev/hvc[0-7] (for more information, see
      <a href="http://fedoraproject.org/wiki/Features/VirtioSerial">http://fedoraproject.org/wiki/Features/VirtioSerial</a>)
      <span class="since">Since 0.8.3</span>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5094 5095 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5096 5097 5098 5099 5100 5101 5102 
<pre>
  ...
  &lt;devices&gt;
    &lt;console type='pty'&gt;
      &lt;source path='/dev/pts/4'/&gt;
      &lt;target port='0'/&gt;
    &lt;/console&gt;
C
qemu: virtio console support  
Cole Robinson 已提交
5103 5104 5105 5106 5107 5108 

    &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;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5109 5110 
  &lt;/devices&gt;
  ...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5111
J
S390: Add SCLP console front end support  
J.B. Joret 已提交
5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 
<pre>
  ...
  &lt;devices&gt;
    &lt;!-- KVM s390 sclp console --&gt;
    &lt;console type='pty'&gt;
      &lt;source path='/dev/pts/1'/&gt;
      &lt;target type='sclp' port='0'/&gt;
    &lt;/console&gt;
  &lt;/devices&gt;
  ...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5123 5124 5125 5126 5127 5128 
    <p>
      If the console is presented as a serial port, the <code>target</code>
      element has the same attributes as for a serial port. There is usually
      only 1 console.
    </p>
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
5129 5130 5131 5132 5133 5134 5135 
    <h6><a name="elementCharChannel">Channel</a></h6>

    <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 已提交
5136 5137 5138 5139 5140 5141 5142 
<pre>
  ...
  &lt;devices&gt;
    &lt;channel type='unix'&gt;
      &lt;source mode='bind' path='/tmp/guestfwd'/&gt;
      &lt;target type='guestfwd' address='10.0.2.1' port='4600'/&gt;
    &lt;/channel&gt;
C
docs: domain: Document virtio <channel>  
Cole Robinson 已提交
5143 5144 5145 5146 5147 

    &lt;!-- KVM virtio channel --&gt;
    &lt;channel type='pty'&gt;
      &lt;target type='virtio' name='arbitrary.virtio.serial.port.name'/&gt;
    &lt;/channel&gt;
D
QEMU guest agent support  
Daniel P. Berrange 已提交
5148 5149 
    &lt;channel type='unix'&gt;
      &lt;source mode='bind' path='/var/lib/libvirt/qemu/f16x86_64.agent'/&gt;
P
conf: Add channel state for virtio channels to the XML  
Peter Krempa 已提交
5150 
      &lt;target type='virtio' name='org.qemu.guest_agent.0' state='connected'/&gt;
D
QEMU guest agent support  
Daniel P. Berrange 已提交
5151 
    &lt;/channel&gt;
D
spicevmc: support new qemu chardev  
Daniel P. Berrange 已提交
5152 5153 5154 
    &lt;channel type='spicevmc'&gt;
      &lt;target type='virtio' name='com.redhat.spice.0'/&gt;
    &lt;/channel&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5155 5156 
  &lt;/devices&gt;
  ...</pre>
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 

    <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 已提交
5171 5172 5173 

      <dt><code>virtio</code></dt>
      <dd>Paravirtualized virtio channel. Channel is exposed in the guest under
E
docs: document <controller> element  
Eric Blake 已提交
5174 
        /dev/vport*, and if the optional element <code>name</code> is specified,
C
docs: domain: Document virtio <channel>  
Cole Robinson 已提交
5175 
        /dev/virtio-ports/$name (for more info, please see
E
docs: document <controller> element  
Eric Blake 已提交
5176 5177 
        <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 已提交
5178 5179 
        particular <code>type='virtio-serial'</code>
        controller, <a href="#elementsAddress">documented above</a>.
D
QEMU guest agent support  
Daniel P. Berrange 已提交
5180 5181 5182 5183 
        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 已提交
5184 
        since 0.9.10</span> Moreover, <span class="since">since 1.0.6</span>
M
qemu: Generate agent socket path if missing  
Michal Privoznik 已提交
5185 5186 5187 5188 
        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 已提交
5189 5190 5191 5192 5193 5194 
        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 已提交
5195 
      </dd>
D
spicevmc: support new qemu chardev  
Daniel P. Berrange 已提交
5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 
      <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 已提交
5209 5210 
    </dl>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5211 5212 5213 5214 5215 5216 
    <h5><a name="elementsCharHostInterface">Host interface</a></h5>

    <p>
      A character device presents itself to the host as one of the following
      types.
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5217
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5218 
    <h6><a name="elementsCharSTDIO">Domain logfile</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5219 5220 5221 5222 5223 5224 

    <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 已提交
5225 5226 5227 5228 
<pre>
  ...
  &lt;devices&gt;
    &lt;console type='stdio'&gt;
E
docs: fix missing / in xml examples  
Eric Blake 已提交
5229 
      &lt;target port='1'/&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5230 5231 5232 
    &lt;/console&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5233 5234
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5235 
    <h6><a name="elementsCharFle">Device logfile</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5236 5237 5238 5239 5240 5241 

    <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 已提交
5242 5243 5244 5245 5246 5247 5248 5249 5250 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="file"&gt;
      &lt;source path="/var/log/vm/vm-serial.log"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5251
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5252 
    <h6><a name="elementsCharVC">Virtual console</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5253 5254 5255 5256 5257 5258 5259 

    <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 已提交
5260 5261 5262 5263 5264 5265 5266 5267 
<pre>
  ...
  &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 已提交
5268
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5269 
    <h6><a name="elementsCharNull">Null device</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5270 5271 5272 5273 5274 5275 

    <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 已提交
5276 5277 5278 5279 5280 5281 5282 5283 
<pre>
  ...
  &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 已提交
5284
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5285 
    <h6><a name="elementsCharPTY">Pseudo TTY</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5286 5287 5288 5289 5290 5291 5292 

    <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 已提交
5293 5294 5295 5296 5297 5298 5299 5300 5301 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="pty"&gt;
      &lt;source path="/dev/pts/3"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5302 5303 5304 

    <p>
      NB special case if &lt;console type='pty'&gt;, then the TTY
A
fix typos in docs  
Atsushi SAKAI 已提交
5305 
      path is also duplicated as an attribute tty='/dev/pts/3'
D
Update domain XML docs  
Daniel P. Berrange 已提交
5306 5307 5308 5309 
      on the top level &lt;console&gt; tag. This provides compat
      with existing syntax for &lt;console&gt; tags.
    </p>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5310 
    <h6><a name="elementsCharHost">Host device proxy</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5311 5312 5313 5314 5315 

    <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 已提交
5316 
      a host serial port - don't connect a serial port to a parallel
D
Update domain XML docs  
Daniel P. Berrange 已提交
5317 5318 5319 
      port.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5320 5321 5322 5323 5324 5325 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="dev"&gt;
      &lt;source path="/dev/ttyS0"/&gt;
      &lt;target port="1"/&gt;
E
docs: fix some typos in examples  
Eric Blake 已提交
5326 
    &lt;/serial&gt;
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5327 5328 
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5329
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5330 
    <h6><a name="elementsCharPipe">Named pipe</a></h6>
C
Fix docs and code disagreements for character devices.  
Cole Robinson 已提交
5331 5332 5333 5334 5335 5336 

    <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 已提交
5337 5338 5339 5340 5341 5342 5343 5344 5345 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="pipe"&gt;
      &lt;source path="/tmp/mypipe"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
C
Fix docs and code disagreements for character devices.  
Cole Robinson 已提交
5346
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5347 
    <h6><a name="elementsCharTCP">TCP client/server</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5348 5349 5350 

    <p>
      The character device acts as a TCP client connecting to a
G
document tcp listen and raw wire option  
Guido Günther 已提交
5351 
      remote server.
D
Update domain XML docs  
Daniel P. Berrange 已提交
5352 5353 
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="tcp"&gt;
      &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
      &lt;protocol type="raw"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
   ...</pre>
G
document tcp listen and raw wire option  
Guido Günther 已提交
5364 5365 5366 5367 5368 

    <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 已提交
5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="tcp"&gt;
      &lt;source mode="bind" host="127.0.0.1" service="2445"/&gt;
      &lt;protocol type="raw"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
G
document tcp listen and raw wire option  
Guido Günther 已提交
5379 5380 

    <p>
E
docs: minor whitespace cleanups  
Eric Blake 已提交
5381 5382 5383 
      Alternatively you can use <code>telnet</code> instead
      of <code>raw</code> TCP.  <span class="since">Since 0.8.5</span>
      you can also use <code>telnets</code>
M
esx: Add support for virtual serial device network backing  
Matthias Bolte 已提交
5384 
      (secure telnet) and <code>tls</code>.
E
docs: correct invalid xml  
Eric Blake 已提交
5385 
    </p>
G
document tcp listen and raw wire option  
Guido Günther 已提交
5386
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="tcp"&gt;
      &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
      &lt;protocol type="telnet"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
    ...
    &lt;serial type="tcp"&gt;
      &lt;source mode="bind" host="127.0.0.1" service="2445"/&gt;
      &lt;protocol type="telnet"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5403
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5404 
    <h6><a name="elementsCharUDP">UDP network console</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5405 5406 5407 5408 5409 5410 

    <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 已提交
5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="udp"&gt;
      &lt;source mode="bind" host="0.0.0.0" service="2445"/&gt;
      &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5421
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
5422 
    <h6><a name="elementsCharUNIX">UNIX domain socket client/server</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5423 5424 5425 5426 5427 5428 

    <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 已提交
5429 5430 5431 5432 5433 5434 5435 5436 5437 
<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="unix"&gt;
      &lt;source mode="bind" path="/tmp/foo"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5438
M
conf: introduce spiceport chardev backend  
Martin Kletzander 已提交
5439 5440 5441 5442 5443 5444 5445 
    <h6><a name="elementsCharSpiceport">Spice channel</a></h6>

    <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 已提交
5446 5447 5448 5449 5450 
    <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 已提交
5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 

<pre>
  ...
  &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>
R
docs: document nmdm type console  
Roman Bogorodskiy 已提交
5462 5463 5464 5465 
    <h6><a name="elementsNmdm">Nmdm device</a></h6>

    <p>
      The nmdm device driver, available on FreeBSD, provides two
C
docs: fix a typo in formatdomain  
Chen Hanxiao 已提交
5466 
      tty devices connected together by a virtual null modem cable.
R
docs: document nmdm type console  
Roman Bogorodskiy 已提交
5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 
      <span class="since">Since 1.2.4</span>
    </p>

<pre>
  ...
  &lt;devices&gt;
    &lt;serial type="nmdm"&gt;
      &lt;source master="/dev/nmdm0A" slave="/dev/nmdm0B"/&gt;
    &lt;/serial&gt;
  &lt;/devices&gt;
  ...</pre>

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

    <dl>
      <dt><code>master</code></dt>
      <dd>Master device of the pair, that is passed to the hypervisor.</dd>

      <dt><code>slave</code></dt>
      <dd>Slave device of the pair, that is passed to the clients for connection
      to the guest console.</dd>
    </dl>
C
Add documentation for <sound> device XML format.  
Cole Robinson 已提交
5491 5492 5493 5494 5495 5496 5497 5498 

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

    <p>
      A virtual sound card can be attached to the host via the
      <code>sound</code> element. <span class="since">Since 0.4.3</span>
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5499 5500 5501 5502 5503 5504 
<pre>
  ...
  &lt;devices&gt;
    &lt;sound model='es1370'/&gt;
  &lt;/devices&gt;
  ...</pre>
C
Add documentation for <sound> device XML format.  
Cole Robinson 已提交
5505 5506 5507 5508 5509 5510 5511 

    <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 已提交
5512 
        choices are 'es1370', 'sb16', 'ac97', 'ich6' and 'usb'.
C
qemu: sound: Support intel 'ich6' model  
Cole Robinson 已提交
5513 
        (<span class="since">
P
conf: Add USB sound card support and implement it for qemu  
Peter Krempa 已提交
5514 5515 
         '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 已提交
5516 5517 5518 
      </dd>
    </dl>
M
domain: add <codec> sound sub-element  
Marc-André Lureau 已提交
5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 
    <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>
  ...
  &lt;devices&gt;
    &lt;sound model='ich6'&gt;
      &lt;codec type='micro'/&gt;
M
docs: formatdomain.html fixes  
Michele Paolino 已提交
5534 
    &lt;/sound&gt;
M
domain: add <codec> sound sub-element  
Marc-André Lureau 已提交
5535 5536 5537 
  &lt;/devices&gt;
  ...</pre>
E
docs: document <controller> element  
Eric Blake 已提交
5538 5539 5540 
    <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 已提交
5541 5542 
      device to a particular PCI
      slot, <a href="#elementsAddress">documented above</a>.
E
docs: document <controller> element  
Eric Blake 已提交
5543 5544 
    </p>
R
Support QEMU watchdog device.  
Richard Jones 已提交
5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 
    <h4><a name="elementsWatchdog">Watchdog device</a></h4>

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

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

    <p>
      Currently libvirt does not support notification when the
      watchdog fires.  This feature is planned for a future version of
      libvirt.
    </p>
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5565 5566 5567 5568 5569 5570 
<pre>
  ...
  &lt;devices&gt;
    &lt;watchdog model='i6300esb'/&gt;
  &lt;/devices&gt;
  ...</pre>
R
Support QEMU watchdog device.  
Richard Jones 已提交
5571
M
docs: Emphasize that devices have to be inside the <devices> element  
Matthias Bolte 已提交
5572 5573 5574 5575 5576 5577 
<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 已提交
5578 5579 5580 5581 

    <dl>
      <dt><code>model</code></dt>
      <dd>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
5582 
        <p>
R
Support QEMU watchdog device.  
Richard Jones 已提交
5583 
        The required <code>model</code> attribute specifies what real
M
Cleanup whitespace in docs  
Matthew Booth 已提交
5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 
        watchdog device is emulated.  Valid values are specific to the
        underlying hypervisor.
        </p>
        <p>
        QEMU and KVM support:
        </p>
        <ul>
          <li> 'i6300esb' &mdash; the recommended device,
            emulating a PCI Intel 6300ESB </li>
          <li> 'ib700' &mdash; emulating an ISA iBase IB700 </li>
        </ul>
R
Support QEMU watchdog device.  
Richard Jones 已提交
5595 5596 5597 
      </dd>
      <dt><code>action</code></dt>
      <dd>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
5598 
        <p>
R
Support QEMU watchdog device.  
Richard Jones 已提交
5599 
        The optional <code>action</code> attribute describes what
M
Cleanup whitespace in docs  
Matthew Booth 已提交
5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 
        action to take when the watchdog expires.  Valid values are
        specific to the underlying hypervisor.
        </p>
        <p>
        QEMU and KVM support:
        </p>
        <ul>
          <li>'reset' &mdash; default, forcefully reset the guest</li>
          <li>'shutdown' &mdash; gracefully shutdown the guest
            (not recommended) </li>
          <li>'poweroff' &mdash; forcefully power off the guest</li>
          <li>'pause' &mdash; pause the guest</li>
          <li>'none' &mdash; do nothing</li>
H
Update documentation of watchdog dump option and add test data for it  
Hu Tao 已提交
5613 5614 
          <li>'dump' &mdash; automatically dump the guest
            <span class="since">Since 0.8.7</span></li>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
5615 5616 
        </ul>
        <p>
H
Update documentation of watchdog dump option and add test data for it  
Hu Tao 已提交
5617 
        Note 1: the 'shutdown' action requires that the guest
M
Cleanup whitespace in docs  
Matthew Booth 已提交
5618 5619 5620 5621 5622 
        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 已提交
5623 5624 5625 5626 
        <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 已提交
5627 5628 5629 
      </dd>
    </dl>
D
Document the memory balloon device  
Daniel P. Berrange 已提交
5630 5631 5632 5633 5634 5635 5636 5637 5638 
    <h4><a name="elementsMemBalloon">Memory balloon device</a></h4>

    <p>
      A virtual memory balloon device is added to all Xen and KVM/QEMU
      guests. It will be seen as <code>memballoon</code> element.
      It will be automatically added when appropriate, so there is no
      need to explicitly add this element in the guest XML unless a
      specific PCI slot needs to be assigned.
      <span class="since">Since 0.8.3, Xen, QEMU and KVM only</span>
E
docs: document how to disable memballoon  
Eric Blake 已提交
5639 5640 5641 
      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 已提交
5642 5643 5644 
    </p>

    <p>
J
docs: fix memballoon examples  
Ján Tomko 已提交
5645 
      Example: automatically added device with KVM
D
Document the memory balloon device  
Daniel P. Berrange 已提交
5646 5647 5648 5649 5650 5651 5652 5653 5654 
    </p>
<pre>
  ...
  &lt;devices&gt;
    &lt;memballoon model='virtio'/&gt;
  &lt;/devices&gt;
  ...</pre>

    <p>
J
docs: fix memballoon examples  
Ján Tomko 已提交
5655 
      Example: manually added device with static PCI slot 2 requested
D
Document the memory balloon device  
Daniel P. Berrange 已提交
5656 5657 5658 5659 
    </p>
<pre>
  ...
  &lt;devices&gt;
J
docs: fix memballoon examples  
Ján Tomko 已提交
5660 5661 
    &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 已提交
5662 
      &lt;stats period='10'/&gt;
J
docs: fix memballoon examples  
Ján Tomko 已提交
5663 
    &lt;/memballoon&gt;
D
Document the memory balloon device  
Daniel P. Berrange 已提交
5664 5665 5666 5667 5668 5669 5670 5671 
  &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 已提交
5672 5673 
          of balloon device is provided. Valid values are specific to
          the virtualization platform
D
Document the memory balloon device  
Daniel P. Berrange 已提交
5674 5675 5676 5677 5678 5679 
        </p>
        <ul>
          <li>'virtio' &mdash; default with QEMU/KVM</li>
          <li>'xen' &mdash; default with Xen</li>
        </ul>
      </dd>
J
Add 'period' for Memballoon statistics gathering capability  
John Ferlan 已提交
5680 5681 5682 
      <dt><code>period</code></dt>
      <dd>
        <p>
M
conf: Use correct type for balloon stats period  
Martin Kletzander 已提交
5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 
          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 已提交
5694 5695 5696 
          <span class='since'>Since 1.1.1, requires QEMU 1.5</span>
        </p>
      </dd>
D
Document the memory balloon device  
Daniel P. Berrange 已提交
5697 
    </dl>
P
doc: schema: Add basic documentation for the virtual RNG device support  
Peter Krempa 已提交
5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 
    <h4><a name="elementsRng">Random number generator device</a></h4>

    <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>
  ...
  &lt;devices&gt;
    &lt;rng model='virtio'&gt;
P
virtio-rng: Add rate limiting options for virtio-RNG  
Peter Krempa 已提交
5713 
      &lt;rate period="2000" bytes="1234"/&gt;
P
doc: schema: Add basic documentation for the virtual RNG device support  
Peter Krempa 已提交
5714 5715 5716 
      &lt;backend model='random'&gt;/dev/random&lt;/backend&gt;
      &lt;!-- OR --&gt;
      &lt;backend model='egd' type='udp'&gt;
G
doc: fix XML for the RNG device example  
Giuseppe Scrivano 已提交
5717 5718 
        &lt;source mode='bind' service='1234'/&gt;
        &lt;source mode='connect' host='1.2.3.4' service='1234'/&gt;
P
doc: schema: Add basic documentation for the virtual RNG device support  
Peter Krempa 已提交
5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 
      &lt;/backend&gt;
    &lt;/rng&gt;
  &lt;/devices&gt;
  ...
</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>
          <li>'virtio' &mdash; supported by qemu and virtio-rng kernel module</li>
        </ul>
      </dd>
P
virtio-rng: Add rate limiting options for virtio-RNG  
Peter Krempa 已提交
5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 
      <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 已提交
5748 5749 5750 5751 5752 5753 5754 5755 
      <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>
        <ul>
E
rng: restrict passthrough names to known-good files  
Eric Blake 已提交
5756 5757 
          <li>'random' &mdash; /dev/random (default) or /dev/hwrng
            device as source (for now, no other sources are permitted)</li>
P
doc: schema: Add basic documentation for the virtual RNG device support  
Peter Krempa 已提交
5758 5759 5760 
          <li>'egd' &mdash; a EGD protocol backend</li>
        </ul>
      </dd>
P
docs: Fix attribute name for virtio-rng backend  
Peter Krempa 已提交
5761 
      <dt><code>backend model='random'</code></dt>
P
doc: schema: Add basic documentation for the virtual RNG device support  
Peter Krempa 已提交
5762 5763 5764 
      <dd>
        <p>
          This backend type expects a non-blocking character device as input.
C
docs: domain: /dev/urandom isn't a valid rng patch  
Cole Robinson 已提交
5765 
          The only accepted paths are /dev/random and /dev/hwrng. The file
P
doc: schema: Add basic documentation for the virtual RNG device support  
Peter Krempa 已提交
5766 5767 5768 5769 
          name is specified as contents of the <code>backend</code> element.
          When no file name is specified the hypervisor default is used.
        </p>
      </dd>
P
docs: Fix attribute name for virtio-rng backend  
Peter Krempa 已提交
5770 
      <dt><code>backend model='egd'</code></dt>
P
doc: schema: Add basic documentation for the virtual RNG device support  
Peter Krempa 已提交
5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 
      <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>
D
Document the memory balloon device  
Daniel P. Berrange 已提交
5781
S
Add documentation and schema for TPM passthrough  
Stefan Berger 已提交
5782 5783 5784 5785 5786 5787 5788 5789 
    <h4><a name="elementsTpm">TPM device</a></h4>

    <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 已提交
5790 
      for one QEMU guest. No other software may be using the TPM device,
S
Add documentation and schema for TPM passthrough  
Stefan Berger 已提交
5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 
      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>
  ...
  &lt;devices&gt;
    &lt;tpm model='tpm-tis'&gt;
      &lt;backend type='passthrough'&gt;
S
Fix sample TPM XML  
Stefan Berger 已提交
5803 
        &lt;device path='/dev/tpm0'/&gt;
S
Add documentation and schema for TPM passthrough  
Stefan Berger 已提交
5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 
      &lt;/backend&gt;
    &lt;/tpm&gt;
  &lt;/devices&gt;
  ...
</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>
        <ul>
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
5825 
          <li>'passthrough' &mdash; use the host's TPM device.</li>
S
Add documentation and schema for TPM passthrough  
Stefan Berger 已提交
5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 
        </ul>
      </dd>
      <dt><code>backend type='passthrough'</code></dt>
      <dd>
        <p>
          This backend type requires exclusive access to a TPM device on
          the host.
          An example for such a device is /dev/tpm0. The filename is
          specified as path attribute of the <code>source</code> element.
          If no file name is specified then /dev/tpm0 is automatically used.
        </p>
      </dd>
    </dl>
L
Add NVRAM device  
Li Zhang 已提交
5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 
    <h4><a name="elementsNVRAM">NVRAM device</a></h4>
    <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>
  ...
  &lt;devices&gt;
    &lt;nvram&gt;
      &lt;address type='spapr-vio' reg='0x3000'/&gt;
    &lt;/nvram&gt;
  &lt;/devices&gt;
  ...
</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>
H
conf: add support for panic device  
Hu Tao 已提交
5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 
    <h4><a name="elementsPanic">panic device</a></h4>
    <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>
    <p>
      Example: usage of panic configuration
    </p>
<pre>
  ...
  &lt;devices&gt;
    &lt;panic&gt;
      &lt;address type='isa' iobase='0x505'/&gt;
    &lt;/panic&gt;
  &lt;/devices&gt;
  ...
</pre>
  <dl>
    <dt><code>address</code></dt>
    <dd>
      <p>
        address of panic. The default ioport is 0x505. Most users
        don't need to specify an address.
      </p>
    </dd>
  </dl>
M
docs, conf, schema: add support for shmem device  
Martin Kletzander 已提交
5902 5903 5904 5905 5906 
  <h4><a name="elementsShmem">Shared memory device</a></h4>

    <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 已提交
5907 
      <span class="since">Since 1.2.10, QEMU and KVM only</span>
M
docs, conf, schema: add support for shmem device  
Martin Kletzander 已提交
5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 
    </p>

<pre>
  ...
  &lt;devices&gt;
    &lt;shmem name='my_shmem0'&gt;
      &lt;size unit='M'&gt;4&lt;/size&gt;
    &lt;/shmem&gt;
    &lt;shmem name='shmem_server'&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;
  ...
</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>
    <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
      <code>path</code> attribute specifies the path to the unix socket and
      defaults to <code>/var/lib/libvirt/shmem/$shmem-$name-sock</code>.
    </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
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
5954 5955 5956 5957 
    <h3><a name="seclabel">Security label</a></h3>

    <p>
      The <code>seclabel</code> element allows control over the
D
Add two new security label types  
Daniel P. Berrange 已提交
5958 5959 5960 5961 5962 
      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 已提交
5963 5964 5965 5966 5967 
      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 已提交
5968 5969 
      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 已提交
5970 5971 
    </p>
M
Multiple security drivers in XML data  
Marcelo Cerri 已提交
5972 5973 5974 5975 5976 5977 5978 
    <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 已提交
5979 
    <p>
E
seclabel: extend XML to allow per-disk label overrides  
Eric Blake 已提交
5980 
      Valid input XML configurations for the top-level security label
D
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 
      are:
    </p>

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

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

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

  &lt;seclabel type='static' model='selinux' relabel='yes'&gt;
    &lt;label&gt;system_u:system_r:svirt_t:s0:c392,c662&lt;/label&gt;
  &lt;/seclabel&gt;
D
Add two new security label types  
Daniel P. Berrange 已提交
5998 5999 

  &lt;seclabel type='none'/&gt;
D
Add documentation for the seclabel XML element  
Daniel P. Berrange 已提交
6000 6001 
    </pre>
D
Add two new security label types  
Daniel P. Berrange 已提交
6002 6003 6004 6005 6006 6007 6008 
    <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 已提交
6009 6010 6011 6012 6013 6014 6015 6016 6017 
    <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 已提交
6018 6019 6020 
      <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 已提交
6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 
      </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 已提交
6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 
        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 已提交
6045 6046 6047 
      </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 已提交
6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 
        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 已提交
6058 6059 6060 6061 6062 6063 6064 6065 
      </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 已提交
6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 
    <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 已提交
6076 6077 6078 6079 6080 
      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 已提交
6081 6082 
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
6083 
    <h2><a name="examples">Example configs</a></h2>
D
Split website out into one file per page. APply new layout and styling  
Daniel P. Berrange 已提交
6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 

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