External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-26 23:55:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
478a4d07ac
libvirt/docs/formatdomain.html.in

3382 lines
128 KiB
HTML
Raw Normal View History

Split website out into one file per page. APply new layout and styling
2008-04-23 17:08:31 +00:00
<html>
<body>
<h1>Domain XML format</h1>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
&lt;domain type='xen' id='3'&gt;
&lt;name&gt;fv0&lt;/name&gt;
&lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
docs: domain: Document <description> element
2010-02-22 21:06:04 +00:00
&lt;description&gt;Some human readable description&lt;/description&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>name</code></dt>
<dd>The content of the <code>name</code> element provides
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
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>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>uuid</code></dt>
<dd>The content of the <code>uuid</code> element provides
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
a globally unique identifier for the virtual machine.
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
The format must be RFC 4122 compliant,
eg <code>3e3fce45-4f53-4fa7-bb32-11f34168b82b</code>.
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
If omitted when defining/creating a new machine, a random
docs: document <sysinfo> and <smbios> elements * docs/formatdomain.html.in: Talk about <sysinfo> throughout.
2011-01-18 20:41:55 +00:00
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>
docs: domain: Document <description> element
2010-02-22 21:06:04 +00:00
<dt><code>description</code></dt>
<dd>The content of the <code>description</code> element provides a
human readable description of the virtual machine. This data is not
used by libvirt in any way, it can contain any information the user
wants. <span class="since">Since 0.7.2</span></dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
<h3><a name="elementsOS">Operating system booting</a></h3>
<p>
There are a number of different ways to boot virtual machines
each with their own pros and cons.
</p>
<h4><a name="elementsOSBIOS">BIOS bootloader</a></h4>
<p>
Booting via the BIOS is available for hypervisors supporting
full virtualization. In this case the BIOS has a boot order
priority (floppy, harddisk, cdrom, network) determining where
to obtain/find the boot image.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;os&gt;
&lt;type&gt;hvm&lt;/type&gt;
&lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
&lt;boot dev='hd'/&gt;
qemu: Allow setting boot menu on/off Add a new element to the <os> block: <bootmenu enable="yes|no"/> Which maps to -boot,menu=on|off on the QEMU command line. I decided to use an explicit 'enable' attribute rather than just make the bootmenu element boolean. This allows us to treat lack of a bootmenu element as 'use hypervisor default'.
2010-07-26 14:28:58 +00:00
&lt;boot dev='cdrom'/&gt;
&lt;bootmenu enable='yes'/&gt;
docs: document <sysinfo> and <smbios> elements * docs/formatdomain.html.in: Talk about <sysinfo> throughout.
2011-01-18 20:41:55 +00:00
&lt;smbios mode='sysinfo'/&gt;
bios: Add support for SGA This patch creates new <bios> element which, at this time has only the attribute useserial='yes|no'. This attribute allow users to use Serial Graphics Adapter and see BIOS messages from the very first moment domain boots up. Therefore, users can choose boot medium, set PXE, etc.
2011-07-08 07:56:17 +00:00
&lt;bios useserial='yes'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/os&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>type</code></dt>
<dd>The content of the <code>type</code> element specifies the
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
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>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
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>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>loader</code></dt>
<dd>The optional <code>loader</code> tag refers to a firmware blob
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
used to assist the domain creation process. At this time, it is
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
only needed by Xen fully virtualized
domains. <span class="since">Since 0.1.0</span></dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>boot</code></dt>
<dd>The <code>dev</code> attribute takes one of the values "fd", "hd",
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
"cdrom" or "network" and is used to specify the next boot device
to consider. The <code>boot</code> element can be repeated multiple
Introduce per-device boot element Currently, boot order can be specified per device class but there is no way to specify exact disk/NIC device to boot from. This patch adds <boot order='N'/> element which can be used inside <disk/> and <interface/>. This is incompatible with the older os/boot element. Since not all hypervisors support per-device boot specification, new deviceboot flag is included in capabilities XML for hypervisors which understand the new boot element. Presence of the flag allows (but doesn't require) users to use the new style boot order specification.
2011-01-12 14:19:34 +00:00
times to setup a priority list of boot devices to try in turn. The
<code>boot</code> element cannot be used if per-device boot elements
Support booting from hostdev devices
2011-02-03 12:06:21 +00:00
are used (see <a href="#elementsDisks">disks</a>,
<a href="#elementsNICS">network interfaces</a>, and
<a href="#elementsUSB">USB and PCI devices</a> sections below).
Introduce per-device boot element Currently, boot order can be specified per device class but there is no way to specify exact disk/NIC device to boot from. This patch adds <boot order='N'/> element which can be used inside <disk/> and <interface/>. This is incompatible with the older os/boot element. Since not all hypervisors support per-device boot specification, new deviceboot flag is included in capabilities XML for hypervisors which understand the new boot element. Presence of the flag allows (but doesn't require) users to use the new style boot order specification.
2011-01-12 14:19:34 +00:00
<span class="since">Since 0.1.3, per-device boot since 0.8.8</span>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dd>
qemu: Allow setting boot menu on/off Add a new element to the <os> block: <bootmenu enable="yes|no"/> Which maps to -boot,menu=on|off on the QEMU command line. I decided to use an explicit 'enable' attribute rather than just make the bootmenu element boolean. This allows us to treat lack of a bootmenu element as 'use hypervisor default'.
2010-07-26 14:28:58 +00:00
<dt><code>bootmenu</code></dt>
<dd> Whether or not to enable an interactive boot menu prompt on guest
startup. The <code>enable</code> attribute can be either "yes" or "no".
If not specified, the hypervisor default is used. <span class="since">
Since 0.8.3</span>
</dd>
docs: document <sysinfo> and <smbios> elements * docs/formatdomain.html.in: Talk about <sysinfo> throughout.
2011-01-18 20:41:55 +00:00
<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
sysinfo: implement the public API * src/libvirt.c (virConnectGetSysinfo): New function. * docs/formatdomain.html.in: Mention it.
2011-02-07 21:48:24 +00:00
SMBIOS values;
the <a href="html/libvirt-libvirt.html#virConnectGetSysinfo">
<code>virConnectGetSysinfo</code></a> call can be
used to see what values are copied), or "sysinfo" (use the values in
docs: document <sysinfo> and <smbios> elements * docs/formatdomain.html.in: Talk about <sysinfo> throughout.
2011-01-18 20:41:55 +00:00
the <a href="#elementsSysinfo">sysinfo</a> element). If not
specified, the hypervisor default is used. <span class="since">
Since 0.8.7</span>
</dd>
bios: Add support for SGA This patch creates new <bios> element which, at this time has only the attribute useserial='yes|no'. This attribute allow users to use Serial Graphics Adapter and see BIOS messages from the very first moment domain boots up. Therefore, users can choose boot medium, set PXE, etc.
2011-07-08 07:56:17 +00:00
<dt><code>bios</code></dt>
<dd>This element has attribute <code>useserial</code> with possible
values <code>yes</code> or <code>no</code>. It enables or disables
Serial Graphics Adapter which allows users to see BIOS messages
on a serial port. Therefore, one needs to have
<a href="#elementCharSerial">serial port</a> defined.
<span class="since">Since 0.9.4</span>
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</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
fix typos in docs docs/formatdomain.html docs/formatdomain.html.in docs/java.html docs/java.html.in
2008-08-08 10:24:14 +00:00
operating system boot. This may use a pseudo-bootloader in the
Update domain XML docs
2008-05-08 14:20:07 +00:00
host to provide an interface to choose a kernel for the guest.
An example is <code>pygrub</code> with Xen.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;bootloader&gt;/usr/bin/pygrub&lt;/bootloader&gt;
&lt;bootloader_args&gt;--append single&lt;/bootloader_args&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>bootloader</code></dt>
<dd>The content of the <code>bootloader</code> element provides
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
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>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>bootloader_args</code></dt>
<dd>The optional <code>bootloader_args</code> element allows
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
command line arguments to be passed to the bootloader.
<span class="since">Since 0.2.3</span>
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;os&gt;
&lt;type&gt;hvm&lt;/type&gt;
&lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
&lt;kernel&gt;/root/f8-i386-vmlinuz&lt;/kernel&gt;
&lt;initrd&gt;/root/f8-i386-initrd&lt;/initrd&gt;
&lt;cmdline&gt;console=ttyS0 ks=http://example.com/f8-i386/os/&lt;/cmdline&gt;
&lt;/os&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>type</code></dt>
<dd>This element has the same semantics as described earlier in the
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
<a href="#elementsOSBIOS">BIOS boot section</a></dd>
"copy-paste" errors * docs/formatdomain.html docs/formatdomain.html.in: Anton Protopopov pointed out a few "copy-paste" errors daniel
2008-05-22 14:57:32 +00:00
<dt><code>loader</code></dt>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dd>This element has the same semantics as described earlier in the
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
<a href="#elementsOSBIOS">BIOS boot section</a></dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>kernel</code></dt>
<dd>The contents of this element specify the fully-qualified path
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
to the kernel image in the host OS.</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>initrd</code></dt>
<dd>The contents of this element specify the fully-qualified path
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
to the (optional) ramdisk image in the host OS.</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>cmdline</code></dt>
<dd>The contents of this element specify arguments to be passed to
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
the kernel (or installer) at boottime. This is often used to
specify an alternate primary console (eg serial port), or the
installation media source / kickstart file</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
docs: document <sysinfo> and <smbios> elements * docs/formatdomain.html.in: Talk about <sysinfo> throughout.
2011-01-18 20:41:55 +00:00
<h3><a name="elementsSysinfo">SMBIOS System Information</a></h3>
<p>
Some hypervisors allow control over what system information is
presented to the guest (for example, SMBIOS fields can be
populated by a hypervisor and inspected via
the <code>dmidecode</code> command in the guest). The
optional <code>sysinfo</code> element covers all such categories
of information. <span class="since">Since 0.8.7</span>
</p>
<pre>
...
&lt;os&gt;
&lt;smbios mode='sysinfo'/&gt;
...
&lt;/os&gt;
&lt;sysinfo type='smbios'&gt;
&lt;bios&gt;
&lt;entry name='vendor'&gt;LENOVO&lt;/entry&gt;
&lt;/bios&gt;
&lt;system&gt;
&lt;entry name='manufacturer'&gt;Fedora&lt;/entry&gt;
&lt;entry name='vendor'&gt;Virt-Manager&lt;/entry&gt;
&lt;/system&gt;
&lt;/sysinfo&gt;
...</pre>
<p>
The <code>sysinfo</code> element has a mandatory
attribute <code>type</code> that determine the layout of
sub-elements, with supported values of:
</p>
<dl>
<dt><code>smbios</code></dt>
<dd>Sub-elements call out specific SMBIOS values, which will
affect the guest if used in conjunction with
the <code>smbios</code> sub-element of
the <a href="#elementsOS"><code>os</code></a> element. Each
sub-element of <code>sysinfo</code> names a SMBIOS block, and
within those elements can be a list of <code>entry</code>
elements that describe a field within the block. The following
blocks and entries are recognized:
<dl>
<dt><code>bios</code></dt>
<dd>
This is block 0 of SMBIOS, with entry names drawn from
"vendor", "version", "date", and "release".
</dd>
<dt><code>system</code></dt>
<dd>
This is block 1 of SMBIOS, with entry names drawn from
"manufacturer", "product", "version", "serial", "uuid",
"sku", and "family". If a "uuid" entry is provided
alongside a
top-level <a href="#elementsMetadata"><code>uuid</code>
element</a>, the two values must match.
</dd>
</dl>
</dd>
</dl>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
<h3><a name="elementsCPUAllocation">CPU Allocation</a></h3>
Update domain XML docs
2008-05-08 14:20:07 +00:00
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
&lt;domain&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
...
vcpu: add current attribute to <vcpu> element Syntax agreed on in https://www.redhat.com/archives/libvir-list/2010-September/msg00476.html <domain ...> <vcpu current='x'>y</vcpu> ... can now be used to specify 1 <= x <= y current vcpus, in relation to the boot-time max of y vcpus. If current is omitted, then current and max are assumed to be the same value. * docs/schemas/domain.rng: Add new attribute. * docs/formatdomain.html.in: Document it. * tests/qemuxml2argvdata/qemuxml2argv-smp.xml: Add to domainschematest. * tests/xml2sexprdata/xml2sexpr-pv-vcpus.xml: Likewise.
2010-09-27 23:36:06 +00:00
&lt;vcpu cpuset="1-4,^3,6" current="1"&gt;2&lt;/vcpu&gt;
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
...
&lt;/domain&gt;
</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>vcpu</code></dt>
vcpu: add current attribute to <vcpu> element Syntax agreed on in https://www.redhat.com/archives/libvir-list/2010-September/msg00476.html <domain ...> <vcpu current='x'>y</vcpu> ... can now be used to specify 1 <= x <= y current vcpus, in relation to the boot-time max of y vcpus. If current is omitted, then current and max are assumed to be the same value. * docs/schemas/domain.rng: Add new attribute. * docs/formatdomain.html.in: Document it. * tests/qemuxml2argvdata/qemuxml2argv-smp.xml: Add to domainschematest. * tests/xml2sexprdata/xml2sexpr-pv-vcpus.xml: Likewise.
2010-09-27 23:36:06 +00:00
<dd>The content of this element defines the maximum number of virtual
vcpu: improve cpuset attribute The <vcpu cpuset=...> attribute has been available since commit e193b5dd, but without documentation or RNG validation. * docs/schemas/domain.rng (vcpu): Further validate cpuset. * docs/formatdomain.html.in: Document it. * src/conf/domain_conf.c: Fix typos.
2010-09-27 23:29:13 +00:00
CPUs allocated for the guest OS, which must be between 1 and
the maximum supported by the hypervisor. <span class="since">Since
0.4.4</span>, this element can contain an optional
<code>cpuset</code> attribute, which is a comma-separated
list of physical CPU numbers that virtual CPUs can be pinned
to. Each element in that list is either a single CPU number,
a range of CPU numbers, or a caret followed by a CPU number to
vcpu: add current attribute to <vcpu> element Syntax agreed on in https://www.redhat.com/archives/libvir-list/2010-September/msg00476.html <domain ...> <vcpu current='x'>y</vcpu> ... can now be used to specify 1 <= x <= y current vcpus, in relation to the boot-time max of y vcpus. If current is omitted, then current and max are assumed to be the same value. * docs/schemas/domain.rng: Add new attribute. * docs/formatdomain.html.in: Document it. * tests/qemuxml2argvdata/qemuxml2argv-smp.xml: Add to domainschematest. * tests/xml2sexprdata/xml2sexpr-pv-vcpus.xml: Likewise.
2010-09-27 23:36:06 +00:00
be excluded from a previous range. <span class="since">Since
0.8.5</span>, the optional attribute <code>current</code> can
be used to specify whether fewer than the maximum number of
virtual CPUs should be enabled.
vcpu: improve cpuset attribute The <vcpu cpuset=...> attribute has been available since commit e193b5dd, but without documentation or RNG validation. * docs/schemas/domain.rng (vcpu): Further validate cpuset. * docs/formatdomain.html.in: Document it. * src/conf/domain_conf.c: Fix typos.
2010-09-27 23:29:13 +00:00
</dd>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
</dl>
<h3><a name="elementsCPUTuning">CPU Tuning</a></h3>
<pre>
&lt;domain&gt;
...
&lt;cputune&gt;
&lt;vcpupin vcpu="0" cpuset="1-4,^2"/&gt;
&lt;vcpupin vcpu="1" cpuset="0,1"/&gt;
&lt;vcpupin vcpu="2" cpuset="2,3"/&gt;
&lt;vcpupin vcpu="3" cpuset="0,4"/&gt;
&lt;shares&gt;2048&lt;/shares&gt;
&lt;period&gt;1000000&lt;/period&gt;
&lt;quota&gt;-1&lt;/quota&gt;
&lt;/cputune&gt;
...
&lt;/domain&gt;
</pre>
<dl>
cputune: Add document for cputune XML v1 - v3: * More clear document for "cpu shares", adopted suggestions from Matthias Bottle and Daniel Veillard.
2011-03-29 13:04:21 +00:00
<dt><code>cputune</code></dt>
docs: Fix documentation for cputune parameters This re-adds the example section originally written by Osier Yang, and indicates the version in which the cputune parameters became available in libvirt. Signed-off-by: Igor Serebryany <igor47@moomers.org>
2011-05-12 10:48:23 +00:00
<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>
cputune: Add document for cputune XML v1 - v3: * More clear document for "cpu shares", adopted suggestions from Matthias Bottle and Daniel Veillard.
2011-03-29 13:04:21 +00:00
<dt><code>vcpupin</code></dt>
docs: Fix documentation for cputune parameters This re-adds the example section originally written by Osier Yang, and indicates the version in which the cputune parameters became available in libvirt. Signed-off-by: Igor Serebryany <igor47@moomers.org>
2011-05-12 10:48:23 +00:00
<dd>
The optional <code>vcpupin</code> element specifies which of host
cputune: Add document for cputune XML v1 - v3: * More clear document for "cpu shares", adopted suggestions from Matthias Bottle and Daniel Veillard.
2011-03-29 13:04:21 +00:00
physical CPUS the domain VCPU will be pinned to. If this is ommited,
each VCPU pinned to all the physical CPUS by default. It contains two
Fix several formatting mistakes in doc
2011-03-31 11:14:03 +00:00
required attributes, the attribute <code>vcpu</code> specifies vcpu id,
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
and the attribute <code>cpuset</code> is same as
attribute <code>cpuset</code>
docs: Fix documentation for cputune parameters This re-adds the example section originally written by Osier Yang, and indicates the version in which the cputune parameters became available in libvirt. Signed-off-by: Igor Serebryany <igor47@moomers.org>
2011-05-12 10:48:23 +00:00
of element <code>vcpu</code>. (NB: Only qemu driver support)
<span class="since">Since 0.9.0</span>
</dd>
cputune: Add document for cputune XML v1 - v3: * More clear document for "cpu shares", adopted suggestions from Matthias Bottle and Daniel Veillard.
2011-03-29 13:04:21 +00:00
<dt><code>shares</code></dt>
docs: Fix documentation for cputune parameters This re-adds the example section originally written by Osier Yang, and indicates the version in which the cputune parameters became available in libvirt. Signed-off-by: Igor Serebryany <igor47@moomers.org>
2011-05-12 10:48:23 +00:00
<dd>
The optional <code>shares</code> element specifies the proportional
cputune: Add document for cputune XML v1 - v3: * More clear document for "cpu shares", adopted suggestions from Matthias Bottle and Daniel Veillard.
2011-03-29 13:04:21 +00:00
weighted share for the domain. If this is ommited, it defaults to
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
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
docs: Fix documentation for cputune parameters This re-adds the example section originally written by Osier Yang, and indicates the version in which the cputune parameters became available in libvirt. Signed-off-by: Igor Serebryany <igor47@moomers.org>
2011-05-12 10:48:23 +00:00
2048 will get twice as much CPU time as a VM configured with value 1024.
<span class="since">Since 0.9.0</span>
</dd>
doc: Add documentation for new cputune elements period and quota We have added element period and quota. Document them in formatdomain.html.in.
2011-07-21 08:36:39 +00:00
<dt><code>period</code></dt>
<dd>
The optional <code>period</code> element specifies the enforcement
interval(unit: microseconds). Within <code>period</code>, each vcpu of
the domain will not be allowed to consume more than <code>quota</code>
worth of runtime. The value should be in range [1000, 1000000]. A period
with value 0 means no value. (NB: Only qemu driver support)
<span class="since">Since 0.9.4</span>
</dd>
<dt><code>quota</code></dt>
<dd>
The optional <code>quota</code> element specifies the maximum allowed
bandwidth(unit: microseconds). A domain with <code>quota</code> as any
negative value indicates that the domain has infinite bandwidth, which
means that it is not bandwidth controlled. The value should be in range
[1000, 18446744073709551] or less than 0. A quota with value 0 means no
value. You can use this feature to ensure that all vcpus run at the same
speed. (NB: Only qemu driver support)
<span class="since">Since 0.9.4</span>
</dd>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
</dl>
<h3><a name="elementsMemoryAllocation">Memory Allocation</a></h3>
<pre>
&lt;domain&gt;
...
&lt;memory&gt;524288&lt;/memory&gt;
&lt;currentMemory&gt;524288&lt;/currentMemory&gt;
...
&lt;/domain&gt;
</pre>
<dl>
<dt><code>memory</code></dt>
<dd>The maximum allocation of memory for the guest at boot time.
The units for this value are kilobytes (i.e. blocks of 1024 bytes)</dd>
<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
to the same value as the <code>memory</code> element</dd>
</dl>
<h3><a name="elementsMemoryBacking">Memory Backing</a></h3>
<pre>
&lt;domain&gt;
...
&lt;memoryBacking&gt;
&lt;hugepages/&gt;
&lt;/memoryBacking&gt;
...
&lt;/domain&gt;
</pre>
<dl>
<dt><code>memoryBacking</code></dt>
<dd>The optional <code>memoryBacking</code> element, may have an
<code>hugepages</code> element set within it. This tells the
hypervisor that the guest should have its memory allocated using
hugepages instead of the normal native page size.</dd>
</dl>
<h3><a name="elementsMemoryTuning">Memory Tuning</a></h3>
<pre>
&lt;domain&gt;
...
&lt;memtune&gt;
&lt;hard_limit&gt;1048576&lt;/hard_limit&gt;
&lt;soft_limit&gt;131072&lt;/soft_limit&gt;
&lt;swap_hard_limit&gt;2097152&lt;/swap_hard_limit&gt;
&lt;min_guarantee&gt;65536&lt;/min_guarantee&gt;
&lt;/memtune&gt;
...
&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
determine so one needs guess and try.</dd>
<dt><code>hard_limit</code></dt>
<dd> The optional <code>hard_limit</code> element is the maximum memory
the guest can use. The units for this value are kilobytes (i.e. blocks
of 1024 bytes)</dd>
<dt><code>soft_limit</code></dt>
<dd> The optional <code>soft_limit</code> element is the memory limit to
enforce during memory contention. The units for this value are
kilobytes (i.e. blocks of 1024 bytes)</dd>
<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
kilobytes (i.e. blocks of 1024 bytes). This has to be more than
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
kilobytes (i.e. blocks of 1024 bytes)</dd>
</dl>
<h3><a name="elementsNUMATuning">NUMA Node Tuning</a></h3>
<pre>
&lt;domain&gt;
...
&lt;numatune&gt;
&lt;memory mode="strict" nodeset="1-4,^3"/&gt;
&lt;/numatune&gt;
...
&lt;/domain&gt;
</pre>
<dl>
numatune: Add doc for new numatune XML
2011-06-20 07:15:05 +00:00
<dt><code>numatune</code></dt>
<dd>
The optional <code>numatune</code> element provides details of
how to tune the performance of a NUMA host via controlling NUMA policy
for domain process. NB, only supported by QEMU driver.
<span class='since'>Since 0.9.3</span>
<dt><code>memory</code></dt>
<dd>
The optional <code>memory</code> element specify how to allocate memory
for the domain process on a NUMA host. It contains two attributes,
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
attribute <code>mode</code> is either 'interleave', 'strict',
or 'preferred',
numatune: Add doc for new numatune XML
2011-06-20 07:15:05 +00:00
attribute <code>nodeset</code> specifies the NUMA nodes, it leads same
syntax with attribute <code>cpuset</code> of element <code>vcpu</code>.
<span class='since'>Since 0.9.3</span>
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
<h3><a name="elementsBlockTuning">Block I/O Tuning</a></h3>
<pre>
&lt;domain&gt;
...
&lt;blkiotune&gt;
&lt;weight&gt;800&lt;/weight&gt;
blkiotune: add interface for blkiotune.device_weight This adds per-device weights to <blkiotune>. Note that the cgroups implementation only supports weights per block device, and not per-file within the device; hence this option must be global to the domain definition rather than tied to individual <devices>/<disk> entries: <domain ...> <blkiotune> <device> <path>/path/to/block</path> <weight>1000</weight> </device> </blkiotune> .. This patch also adds a parameter --device-weights to virsh command blkiotune for setting/getting blkiotune.weight_device for any hypervisor that supports it. All <device> entries under <blkiotune> are concatenated into a single string attribute under virDomain{Get,Set}BlkioParameters, named "device_weight". Signed-off-by: Hu Tao <hutao@cn.fujitsu.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-11-08 11:00:33 +00:00
&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;
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
&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
blkiotune: add interface for blkiotune.device_weight This adds per-device weights to <blkiotune>. Note that the cgroups implementation only supports weights per block device, and not per-file within the device; hence this option must be global to the domain definition rather than tied to individual <devices>/<disk> entries: <domain ...> <blkiotune> <device> <path>/path/to/block</path> <weight>1000</weight> </device> </blkiotune> .. This patch also adds a parameter --device-weights to virsh command blkiotune for setting/getting blkiotune.weight_device for any hypervisor that supports it. All <device> entries under <blkiotune> are concatenated into a single string attribute under virDomain{Get,Set}BlkioParameters, named "device_weight". Signed-off-by: Hu Tao <hutao@cn.fujitsu.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-11-08 11:00:33 +00:00
omitted, it defaults to the OS provided
defaults. <span class="since">Since 0.8.8</span></dd>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
<dt><code>weight</code></dt>
blkiotune: add interface for blkiotune.device_weight This adds per-device weights to <blkiotune>. Note that the cgroups implementation only supports weights per block device, and not per-file within the device; hence this option must be global to the domain definition rather than tied to individual <devices>/<disk> entries: <domain ...> <blkiotune> <device> <path>/path/to/block</path> <weight>1000</weight> </device> </blkiotune> .. This patch also adds a parameter --device-weights to virsh command blkiotune for setting/getting blkiotune.weight_device for any hypervisor that supports it. All <device> entries under <blkiotune> are concatenated into a single string attribute under virDomain{Get,Set}BlkioParameters, named "device_weight". Signed-off-by: Hu Tao <hutao@cn.fujitsu.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-11-08 11:00:33 +00:00
<dd> The optional <code>weight</code> element is the overall I/O
weight of the guest. The value should be in the range [100,
1000].</dd>
<dt><code>device</code></dt>
<dd>The domain may have multiple <code>device</code> elements
that further tune the weights for each host block device in
use by the domain. Note that
multiple <a href="#elementsDisks">guest disks</a> can share a
single host block device, if they are backed by files within
the same host file system, which is why this tuning parameter
is at the global domain level rather than associated with each
Support block I/O throttle in XML Enable block I/O throttle for per-disk in XML, as the first per-disk IO tuning parameter. Signed-off-by: Lei Li <lilei@linux.vnet.ibm.com> Signed-off-by: Zhi Yong Wu <wuzhy@linux.vnet.ibm.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-11-15 09:02:46 +00:00
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
blkiotune: add interface for blkiotune.device_weight This adds per-device weights to <blkiotune>. Note that the cgroups implementation only supports weights per block device, and not per-file within the device; hence this option must be global to the domain definition rather than tied to individual <devices>/<disk> entries: <domain ...> <blkiotune> <device> <path>/path/to/block</path> <weight>1000</weight> </device> </blkiotune> .. This patch also adds a parameter --device-weights to virsh command blkiotune for setting/getting blkiotune.weight_device for any hypervisor that supports it. All <device> entries under <blkiotune> are concatenated into a single string attribute under virDomain{Get,Set}BlkioParameters, named "device_weight". Signed-off-by: Hu Tao <hutao@cn.fujitsu.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-11-08 11:00:33 +00:00
mandatory sub-elements, <code>path</code> describing the
absolute path of the device, and <code>weight</code> giving
the relative weight of that device, in the range [100,
1000]. <span class="since">Since 0.9.8</span></dd>
docs: Break up 'Basic Resources' XML section We had a bit too many elements crammed in there. Separate it into different headings: - CPU Allocation (<vcpus>) - CPU Tuning (<cputune>) - Memory allocation (<memory> and <currentMemory>) - Memory backing (<memoryBacking>) - Memory tuning (<memtune>) - Numa tuning (<numatune>) - Block I/O tuning (<blkiotune>)
2011-07-24 02:00:26 +00:00
</dl>
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
2010-01-19 17:22:45 +00:00
<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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;cpu match='exact'&gt;
&lt;model&gt;core2duo&lt;/model&gt;
cpu: Add support for CPU vendor By specifying <vendor> element in CPU requirements a guest can be restricted to run only on CPUs by a given vendor. Host CPU vendor is also specified in capabilities XML. The vendor is checked when migrating a guest but it's not forced, i.e., guests configured without <vendor> element can be freely migrated.
2010-07-02 15:51:59 +00:00
&lt;vendor&gt;Intel&lt;/vendor&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;topology sockets='1' cores='2' threads='1'/&gt;
&lt;feature policy='disable' name='lahf_lm'/&gt;
&lt;/cpu&gt;
...</pre>
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
2010-01-19 17:22:45 +00:00
<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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;cpu&gt;
&lt;topology sockets='1' cores='2' threads='1'/&gt;
&lt;/cpu&gt;
...</pre>
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
2010-01-19 17:22:45 +00:00
<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>
Set sensible defaults for cpu match and feature policy To enable the CPU XML from the capabilities to be pasted directly into the guest XML with no editing, pick a sensible default for match and feature policy. The CPU match will be exact and the feature policy will be require. This should ensure safety for migration and give DWIM semantics for users * src/conf/cpu_conf.c: Default to exact match and require policy * docs/formatdomain.html.in: Document new defaults
2010-09-22 11:47:48 +00:00
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
<span class="since">Since 0.8.5</span> the <code>match</code>
attribute can be omitted and will default to <code>exact</code>.
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
2010-01-19 17:22:45 +00:00
</dd>
<dt><code>model</code></dt>
<dd>The content of the <code>model</code> element specifies CPU model
requested by the guest. The list of available CPU models and their
definition can be found in <code>cpu_map.xml</code> file installed
in libvirt's data directory.</dd>
cpu: Add support for CPU vendor By specifying <vendor> element in CPU requirements a guest can be restricted to run only on CPUs by a given vendor. Host CPU vendor is also specified in capabilities XML. The vendor is checked when migrating a guest but it's not forced, i.e., guests configured without <vendor> element can be freely migrated.
2010-07-02 15:51:59 +00:00
<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>
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
2010-01-19 17:22:45 +00:00
<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>
Set sensible defaults for cpu match and feature policy To enable the CPU XML from the capabilities to be pasted directly into the guest XML with no editing, pick a sensible default for match and feature policy. The CPU match will be exact and the feature policy will be require. This should ensure safety for migration and give DWIM semantics for users * src/conf/cpu_conf.c: Default to exact match and require policy * docs/formatdomain.html.in: Document new defaults
2010-09-22 11:47:48 +00:00
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
<span class="since">Since 0.8.5</span> the <code>policy</code>
attribute can be omitted and will default to <code>require</code>.
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
2010-01-19 17:22:45 +00:00
</dd>
</dl>
XML definitions for guest NUMA and parsing routines This patch adds XML definitions for guest NUMA specification and contains routines to parse the same. The guest NUMA specification looks like this: <cpu> ... <topology sockets='2' cores='4' threads='2'/> <numa> <cell cpus='0-7' memory='512000'/> <cell cpus='8-15' memory='512000'/> </numa> ... </cpu> Signed-off-by: Bharata B Rao <bharata@linux.vnet.ibm.com>
2011-11-11 12:51:45 +00:00
<p>
Guest NUMA topology can be specifed using the <code>numa</code> element.
<span class="since">Since 0.9.8</span>
</p>
<pre>
...
&lt;cpu&gt;
...
&lt;numa&gt;
&lt;cell cpus='0-3' memory='512000'/&gt;
&lt;cell cpus='4-7' memory='512000'/&gt;
&lt;/numa&gt;
...
&lt;/cpu&gt;
...</pre>
<p>
Each <code>cell</code> element specifies a NUMA cell or a NUMA node.
<code>cpus</code> specifies the CPU or range of CPUs that are part of
the node. <code>memory</code> specifies the node memory in kilobytes
(i.e. blocks of 1024 bytes). Each cell or node is assigned cellid
or nodeid in the increasing order starting from 0.
</p>
<p>
This guest NUMA specification is currently available only for QEMU/KVM.
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h3><a name="elementsLifecycle">Lifecycle control</a></h3>
<p>
fix typos in docs docs/formatdomain.html docs/formatdomain.html.in docs/java.html docs/java.html.in
2008-08-08 10:24:14 +00:00
It is sometimes necessary to override the default actions taken
Update domain XML docs
2008-05-08 14:20:07 +00:00
when a guest OS triggers a lifecycle operation. The following
collections of elements allow the actions to be specified. A
common use case is to force a reboot to be treated as a poweroff
when doing the initial OS installation. This allows the VM to be
re-configured for the first post-install bootup.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
&lt;on_reboot&gt;restart&lt;/on_reboot&gt;
&lt;on_crash&gt;restart&lt;/on_crash&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>on_poweroff</code></dt>
<dd>The content of this element specifies the action to take when
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
the guest requests a poweroff.</dd>
"copy-paste" errors * docs/formatdomain.html docs/formatdomain.html.in: Anton Protopopov pointed out a few "copy-paste" errors daniel
2008-05-22 14:57:32 +00:00
<dt><code>on_reboot</code></dt>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dd>The content of this element specifies the action to take when
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
the guest requests a reboot.</dd>
"copy-paste" errors * docs/formatdomain.html docs/formatdomain.html.in: Anton Protopopov pointed out a few "copy-paste" errors daniel
2008-05-22 14:57:32 +00:00
<dt><code>on_crash</code></dt>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dd>The content of this element specifies the action to take when
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
the guest crashes.</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</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
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
released</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>restart</code></dt>
<dd>The domain will be terminated, and then restarted with
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
the same configuration</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>preserve</code></dt>
<dd>The domain will be terminated, and its resource preserved
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
to allow analysis.</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>rename-restart</code></dt>
<dd>The domain will be terminated, and then restarted with
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
a new name</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
Add actions to virDomainLifecycle enum Xen supports on_crash actions coredump-{destroy,restart}. libvirt cannot parse config returned by xend that contains either of these actions xen52 # xm li -l test | grep on_crash (on_crash coredump-restart) xen52 # virsh dumpxml test error: internal error unknown lifecycle type coredump-restart This patch adds a new virDomainLifecycleCrash enum and appends the new options to existing destroy, restart, preserve, and rename-restart options.
2010-08-12 17:15:44 +00:00
<p>
on_crash supports these additional
actions <span class="since">since 0.8.4</span>.
</p>
<dl>
<dt><code>coredump-destroy</code></dt>
<dd>The crashed domain's core will be dumped, and then the
domain will be terminated completely and all resources
released</dd>
<dt><code>coredump-restart</code></dt>
<dd>The crashed domain's core will be dumped, and then the
domain will be restarted with the same configuration</dd>
</dl>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h3><a name="elementsFeatures">Hypervisor features</a></h3>
<p>
Hypervisors may allow certain CPU / machine features to be
toggled on/off.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;features&gt;
&lt;pae/&gt;
&lt;acpi/&gt;
&lt;apic/&gt;
Document HAP domain feature Add HAP feature to schema and documentation.
2011-01-05 23:07:54 +00:00
&lt;hap/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/features&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<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
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
to address more than 4 GB of memory.</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>acpi</code></dt>
<dd>ACPI is useful for power management, for example, with
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
KVM guests it is required for graceful shutdown to work.
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dd>
Document HAP domain feature Add HAP feature to schema and documentation.
2011-01-05 23:07:54 +00:00
<dt><code>hap</code></dt>
<dd>Enable use of Hardware Assisted Paging if available in
the hardware.
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
docs: mention domain <clock> improvements Add documentation for features added a while ago. * docs/formatdomain.html.in (Time keeping): Update documentation of <clock> element to match 0.8.0 addition.
2010-05-13 22:00:14 +00:00
&lt;clock offset="localtime"&gt;
&lt;timer name="rtc" tickpolicy="catchup" track="guest"&gt;
&lt;catchup threshold=123 slew=120 limit=10000/&gt;
&lt;/timer&gt;
formatdomain.html.in: fix tickpolicy there is no option "none": >From libvirt/src/conf/domain_conf.c <snip> VIR_ENUM_IMPL(virDomainTimerTickpolicy, VIR_DOMAIN_TIMER_TICKPOLICY_LAST, "delay", "catchup", "merge", "discard"); </snip> Replacing with delay. Signed-off-by: Douglas Schilling Landgraf <dougsland@redhat.com>
2011-09-29 00:58:00 +00:00
&lt;timer name="pit" tickpolicy="delay"/&gt;
docs: mention domain <clock> improvements Add documentation for features added a while ago. * docs/formatdomain.html.in (Time keeping): Update documentation of <clock> element to match 0.8.0 addition.
2010-05-13 22:00:14 +00:00
&lt;/clock&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>clock</code></dt>
Expand docs about clock modes * formatdomain.html.in: Document new clock options
2010-02-02 18:46:52 +00:00
<dd>
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
<p>The <code>offset</code> attribute takes four possible
values, allowing fine grained control over how the guest
clock is synchronized to the host. NB, not all hypervisors
support all modes.</p>
<dl>
<dt><code>utc</code></dt>
<dd>
The guest clock will always be synchronized to UTC when
booted</dd>
<dt><code>localtime</code></dt>
<dd>
The guest clock will be synchronized to the host's configured
timezone when booted, if any.
</dd>
<dt><code>timezone</code></dt>
<dd>
The guest clock will be synchronized to the requested timezone
using the <code>timezone</code> attribute.
<span class="since">Since 0.7.7</span>
</dd>
<dt><code>variable</code></dt>
<dd>
The guest clock will have an arbitrary offset applied
relative to UTC. The delta relative to UTC is specified
in seconds, using the <code>adjustment</code> attribute.
documentation: trivial spelling fix Signed-off-by: Philipp Hahn <hahn@univention.de>
2011-10-18 14:53:55 +00:00
The guest is free to adjust the RTC over time and expect
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
that it will be honoured at next reboot. This is in
contrast to 'utc' mode, where the RTC adjustments are
lost at each reboot. <span class="since">Since 0.7.7</span>
</dd>
</dl>
<p>
A <code>clock</code> may have zero or more
<code>timer</code>sub-elements. <span class="since">Since
0.8.0</span>
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dd>
docs: mention domain <clock> improvements Add documentation for features added a while ago. * docs/formatdomain.html.in (Time keeping): Update documentation of <clock> element to match 0.8.0 addition.
2010-05-13 22:00:14 +00:00
<dt><code>timer</code></dt>
<dd>
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
<p>
Each timer element requires a <code>name</code> attribute,
and has other optional attributes that depend on
the <code>name</code> specified. Various hypervisors
support different combinations of attributes.
</p>
<dl>
<dt><code>name</code></dt>
<dd>
The <code>name</code> attribute selects which timer is
being modified, and can be one of "platform", "pit",
"rtc", "hpet", or "tsc".
</dd>
<dt><code>track</code></dt>
<dd>
The <code>track</code> attribute specifies what the timer
tracks, and can be "boot", "guest", or "wall".
Only valid for <code>name="rtc"</code>
or <code>name="platform"</code>.
</dd>
<dt><code>tickpolicy</code></dt>
<dd>
The <code>tickpolicy</code> attribute determines how
missed ticks in the guest are handled, and can be "delay",
"catchup", "merge", or "discard". If the policy is
"catchup", there can be further details in
the <code>catchup</code> sub-element.
<dl>
<dt><code>catchup</code></dt>
<dd>
The <code>catchup</code> element has three optional
attributes, each a positive integer. The attributes
are <code>threshold</code>, <code>slew</code>,
and <code>limit</code>.
</dd>
</dl>
</dd>
<dt><code>frequency</code></dt>
<dd>
The <code>frequency</code> attribute is an unsigned
integer specifying the frequency at
which <code>name="tsc"</code> runs.
</dd>
<dt><code>mode</code></dt>
<dd>
The <code>mode</code> attribute controls how
the <code>name="tsc"</code> timer is managed, and can be
"auto", "native", "emulate", "paravirt", or "smpsafe".
Other timers are always emulated.
</dd>
<dt><code>present</code></dt>
<dd>
The <code>present</code> attribute can be "yes" or "no" to
specify whether a particular timer is available to the guest.
</dd>
</dl>
docs: mention domain <clock> improvements Add documentation for features added a while ago. * docs/formatdomain.html.in (Time keeping): Update documentation of <clock> element to match 0.8.0 addition.
2010-05-13 22:00:14 +00:00
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
<h3><a name="elementsDevices">Devices</a></h3>
<p>
fix typos in docs docs/formatdomain.html docs/formatdomain.html.in docs/java.html docs/java.html.in
2008-08-08 10:24:14 +00:00
The final set of XML elements are all used to describe devices
Update domain XML docs
2008-05-08 14:20:07 +00:00
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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>emulator</code></dt>
<dd>
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
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.
Update domain XML docs
2008-05-08 14:20:07 +00:00
</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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
snapshot: additions to domain xml for disks As discussed here: https://www.redhat.com/archives/libvir-list/2011-August/msg00361.html https://www.redhat.com/archives/libvir-list/2011-August/msg00552.html Adds snapshot attribute and transient sub-element: <devices> <disk type=... snapshot='no|internal|external'> ... <transient/> </disk> </devices> * docs/schemas/domaincommon.rng (snapshot): New define. (disk): Add snapshot and persistent attributes. * docs/formatdomain.html.in: Document them. * src/conf/domain_conf.h (virDomainDiskSnapshot): New enum. (_virDomainDiskDef): New fields. * tests/qemuxml2argvdata/qemuxml2argv-disk-transient.xml: New test of rng, no args counterpart until qemu support is complete. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.args: New file, snapshot attribute does not affect args. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.xml: Likewise. * tests/qemuxml2argvtest.c (mymain): Run new test.
2011-08-13 19:20:21 +00:00
&lt;disk type='file' snapshot='external'&gt;
Add docs on drive <serial> element * docs/formatdomain.html.in: Document <serial> element within <disk> and fix typo on <driver/> element
2010-05-27 11:44:41 +00:00
&lt;driver name="tap" type="aio" cache="default"/&gt;
conf: Introduce optional startupPolicy attribute for cdrom and floppy This attribute says what to do with cdrom (or floppy) if the source is missing. It accepts: - mandatory - fail if missing for any reason (the default) - requisite - fail if missing on boot up, drop if missing on migrate/restore/revert - optional - drop if missing at any start attempt. However, this patch introduces only XML part of this new functionality.
2011-10-17 14:54:03 +00:00
&lt;source file='/var/lib/xen/images/fv0'/ startupPolicy='optional'&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;target dev='hda' bus='ide'/&gt;
Support block I/O throttle in XML Enable block I/O throttle for per-disk in XML, as the first per-disk IO tuning parameter. Signed-off-by: Lei Li <lilei@linux.vnet.ibm.com> Signed-off-by: Zhi Yong Wu <wuzhy@linux.vnet.ibm.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-11-15 09:02:46 +00:00
&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;
Introduce per-device boot element Currently, boot order can be specified per device class but there is no way to specify exact disk/NIC device to boot from. This patch adds <boot order='N'/> element which can be used inside <disk/> and <interface/>. This is incompatible with the older os/boot element. Since not all hypervisors support per-device boot specification, new deviceboot flag is included in capabilities XML for hypervisors which understand the new boot element. Presence of the flag allows (but doesn't require) users to use the new style boot order specification.
2011-01-12 14:19:34 +00:00
&lt;boot order='2'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;encryption type='...'&gt;
...
&lt;/encryption&gt;
&lt;shareable/&gt;
Add docs on drive <serial> element * docs/formatdomain.html.in: Document <serial> element within <disk> and fix typo on <driver/> element
2010-05-27 11:44:41 +00:00
&lt;serial&gt;
...
&lt;/serial&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/disk&gt;
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
...
&lt;disk type='network'&gt;
qemu: support event_idx parameter for virtio disk and net devices In some versions of qemu, both virtio-blk-pci and virtio-net-pci devices can have an event_idx setting that determines some details of event processing. When it is enabled, it "reduces the number of interrupts and exits for the guest". qemu will automatically enable this feature when it is available, but there may be cases where this new feature could actually make performance worse (NB: no such case has been found so far). As a safety switch in case such a situation is encountered in the field, this patch adds a new attribute "event_idx" to the <driver> element of both disk and interface devices. event_idx can be set to "on" (to force event_idx on in case qemu has it disabled by default) or "off" (for force event_idx off). In the case that event_idx support isn't present in qemu, the attribute is ignored (this on the advice of the qemu developer). docs/formatdomain.html.in: document the new flag (marking it as "don't mess with this!" docs/schemas/domain.rng: add event_idx in appropriate places src/conf/domain_conf.[ch]: add event_idx to parser and formatter src/libvirt_private.syms: export virDomainVirtioEventIdx(From|To)String src/qemu/qemu_capabilities.[ch]: detect and report event_idx in disk/net src/qemu/qemu_command.c: add event_idx parameter to qemu commandline when appropriate. tests/qemuxml2argvdata/qemuxml2argv-event_idx.args, tests/qemuxml2argvdata/qemuxml2argv-event_idx.xml, tests/qemuxml2argvtest.c, tests/qemuxml2xmltest.c: test cases for event_idx.
2011-08-13 06:32:45 +00:00
&lt;driver name="qemu" type="raw" io="threads" ioeventfd="on" event_idx="off"/&gt;
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
&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;
Introduce per-device boot element Currently, boot order can be specified per device class but there is no way to specify exact disk/NIC device to boot from. This patch adds <boot order='N'/> element which can be used inside <disk/> and <interface/>. This is incompatible with the older os/boot element. Since not all hypervisors support per-device boot specification, new deviceboot flag is included in capabilities XML for hypervisors which understand the new boot element. Presence of the flag allows (but doesn't require) users to use the new style boot order specification.
2011-01-12 14:19:34 +00:00
&lt;boot order='1'/&gt;
snapshot: additions to domain xml for disks As discussed here: https://www.redhat.com/archives/libvir-list/2011-August/msg00361.html https://www.redhat.com/archives/libvir-list/2011-August/msg00552.html Adds snapshot attribute and transient sub-element: <devices> <disk type=... snapshot='no|internal|external'> ... <transient/> </disk> </devices> * docs/schemas/domaincommon.rng (snapshot): New define. (disk): Add snapshot and persistent attributes. * docs/formatdomain.html.in: Document them. * src/conf/domain_conf.h (virDomainDiskSnapshot): New enum. (_virDomainDiskDef): New fields. * tests/qemuxml2argvdata/qemuxml2argv-disk-transient.xml: New test of rng, no args counterpart until qemu support is complete. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.args: New file, snapshot attribute does not affect args. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.xml: Likewise. * tests/qemuxml2argvtest.c (mymain): Run new test.
2011-08-13 19:20:21 +00:00
&lt;transient/&gt;
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
&lt;address type='drive' controller='0' bus='1' unit='0'/&gt;
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
&lt;/disk&gt;
storage: add auth to virDomainDiskDef Add additional fields to let you specify the how to authenticate with a disk. The secret to use may be referenced by a usage string or a UUID, i.e.: <auth username='myuser'> <secret type='ceph' usage='secretname'/> </auth> or <auth username='myuser'> <secret type='ceph' uuid='0a81f5b2-8403-7b23-c8d6-21ccc2f80d6f'/> </auth> Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2011-10-28 18:29:39 +00:00
&lt;disk type='network'&gt;
&lt;driver name="qemu" type="raw"/&gt;
&lt;source protocol="rbd" name="image_name2"&gt;
&lt;host name="hostname" port="7000"/&gt;
&lt;/source&gt;
&lt;target dev="hdd" bus="ide"/&gt;
&lt;auth username='myuser'&gt;
&lt;secret type='ceph' usage='mypassid'/&gt;
&lt;/auth&gt;
&lt;/disk&gt;
snapshot: additions to domain xml for disks As discussed here: https://www.redhat.com/archives/libvir-list/2011-August/msg00361.html https://www.redhat.com/archives/libvir-list/2011-August/msg00552.html Adds snapshot attribute and transient sub-element: <devices> <disk type=... snapshot='no|internal|external'> ... <transient/> </disk> </devices> * docs/schemas/domaincommon.rng (snapshot): New define. (disk): Add snapshot and persistent attributes. * docs/formatdomain.html.in: Document them. * src/conf/domain_conf.h (virDomainDiskSnapshot): New enum. (_virDomainDiskDef): New fields. * tests/qemuxml2argvdata/qemuxml2argv-disk-transient.xml: New test of rng, no args counterpart until qemu support is complete. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.args: New file, snapshot attribute does not affect args. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.xml: Likewise. * tests/qemuxml2argvtest.c (mymain): Run new test.
2011-08-13 19:20:21 +00:00
&lt;disk type='block' device='cdrom'&gt;
&lt;driver name='qemu' type='raw'/&gt;
docs: fix typo in <disk>/<target> example * docs/formatdomain.html.in: Use dev, not def. Reported by Alexander Biryukov.
2011-11-01 16:39:48 +00:00
&lt;target dev='hdc' bus='ide'/&gt;
snapshot: additions to domain xml for disks As discussed here: https://www.redhat.com/archives/libvir-list/2011-August/msg00361.html https://www.redhat.com/archives/libvir-list/2011-August/msg00552.html Adds snapshot attribute and transient sub-element: <devices> <disk type=... snapshot='no|internal|external'> ... <transient/> </disk> </devices> * docs/schemas/domaincommon.rng (snapshot): New define. (disk): Add snapshot and persistent attributes. * docs/formatdomain.html.in: Document them. * src/conf/domain_conf.h (virDomainDiskSnapshot): New enum. (_virDomainDiskDef): New fields. * tests/qemuxml2argvdata/qemuxml2argv-disk-transient.xml: New test of rng, no args counterpart until qemu support is complete. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.args: New file, snapshot attribute does not affect args. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.xml: Likewise. * tests/qemuxml2argvtest.c (mymain): Run new test.
2011-08-13 19:20:21 +00:00
&lt;readonly/&gt;
&lt;/disk&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>disk</code></dt>
<dd>The <code>disk</code> element is the main container for describing
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
disks. The <code>type</code> attribute is either "file",
"block", "dir", or "network"
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
and refers to the underlying source for the disk. The optional
<code>device</code> attribute indicates how the disk is to be exposed
to the guest OS. Possible values for this attribute are "floppy", "disk"
snapshot: additions to domain xml for disks As discussed here: https://www.redhat.com/archives/libvir-list/2011-August/msg00361.html https://www.redhat.com/archives/libvir-list/2011-August/msg00552.html Adds snapshot attribute and transient sub-element: <devices> <disk type=... snapshot='no|internal|external'> ... <transient/> </disk> </devices> * docs/schemas/domaincommon.rng (snapshot): New define. (disk): Add snapshot and persistent attributes. * docs/formatdomain.html.in: Document them. * src/conf/domain_conf.h (virDomainDiskSnapshot): New enum. (_virDomainDiskDef): New fields. * tests/qemuxml2argvdata/qemuxml2argv-disk-transient.xml: New test of rng, no args counterpart until qemu support is complete. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.args: New file, snapshot attribute does not affect args. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.xml: Likewise. * tests/qemuxml2argvtest.c (mymain): Run new test.
2011-08-13 19:20:21 +00:00
and "cdrom", defaulting to "disk". The
optional <code>snapshot</code> attribute 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. <span class="since">Since 0.0.3;
"device" attribute since 0.1.4;
"network" attribute since 0.8.7; "snapshot" since
0.9.5</span></dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>source</code></dt>
maint: fix grammar errors Jim Meyering recently improved gnulib to catch various grammar errors during 'make syntax-check'. * .gnulib: Update to latest, for syntax-check improvements. * include/libvirt/libvirt.h.in (virConnectAuthCallbackPtr): Use cannot rather than two words. * src/driver.c: Likewise. * src/driver.h (VIR_SECRET_GET_VALUE_INTERNAL_CALL): Likewise. * src/remote/remote_driver.c (initialize_gnutls): Likewise. * src/util/pci.c (pciBindDeviceToStub): Likewise. * src/storage/storage_backend.c (virStorageBackendCreateQemuImg): Likewise. (virStorageBackendUpdateVolTargetInfoFD): Avoid doubled word. * docs/formatdomain.html.in: Likewise. * src/qemu/qemu_process.c (qemuProcessStart): Likewise. * cfg.mk (exclude_file_name_regexp--sc_prohibit_can_not) (exclude_file_name_regexp--sc_prohibit_doubled_word): Exclude existing translation problems.
2011-04-11 22:25:25 +00:00
<dd>If the disk <code>type</code> is "file", then
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
the <code>file</code> attribute specifies the fully-qualified
path to the file holding the disk. If the disk
<code>type</code> is "block", then the <code>dev</code>
attribute specifies the path to the host device to serve as
Add documentation for <disk><source type="dir">
2011-12-07 16:55:41 +00:00
the disk. If the disk <code>type</code> is "dir", then the
<code>dir</code> attribute specifies the fully-qualified path
to the directory to use as the disk. If the disk <code>type</code>
is "network", then the <code>protocol</code> attribute specifies
the protocol to access to the requested image; possible values
are "nbd", "rbd", and "sheepdog". If the <code>protocol</code>
attribute is "rbd" or "sheepdog", an additional
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
attribute <code>name</code> is mandatory to specify which
image to be used. When the disk <code>type</code> is
"network", the <code>source</code> may have zero or
more <code>host</code> sub-elements used to specify the hosts
to connect.
Add documentation for <disk><source type="dir">
2011-12-07 16:55:41 +00:00
<span class="since">Since 0.0.3; <code>type='dir'</code> since
0.7.5; <code>type='network'</code> since 0.8.7</span><br/>
For a "file" disk type which represents a cdrom or floppy
(the <code>device</code> attribute), it is possible to define
policy what to do with the disk if the source file is not accessible.
This is done by the <code>startupPolicy</code> attribute, accepting
conf: Introduce optional startupPolicy attribute for cdrom and floppy This attribute says what to do with cdrom (or floppy) if the source is missing. It accepts: - mandatory - fail if missing for any reason (the default) - requisite - fail if missing on boot up, drop if missing on migrate/restore/revert - optional - drop if missing at any start attempt. However, this patch introduces only XML part of this new functionality.
2011-10-17 14:54:03 +00:00
these values:
<table class="top_table">
<tr>
<td> mandatory </td>
<td> fail if missing for any reason (the default) </td>
</tr>
<tr>
<td> requisite </td>
<td> fail if missing on boot up,
drop if missing on migrate/restore/revert </td>
</tr>
<tr>
<td> optional </td>
<td> drop if missing at any start attempt </td>
</tr>
</table>
<span class="since">Since 0.9.7</span>
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>target</code></dt>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
<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
Add AHCI support to qemu driver Tested with multiple AHCI controllers and multiple disks attached to a controller. E.g., <disk type='file' device='disk'> <driver name='qemu' type='raw'/> <source file='/var/lib/libvirt/images/test/disk0.raw'/> <target dev='sda' bus='sata'/> <address type='drive' controller='0' bus='0' unit='0'/> </disk> <disk type='file' device='disk'> <driver name='qemu' type='raw'/> <source file='/var/lib/libvirt/images/test/disk1.raw'/> <target dev='sdb' bus='sata'/> <address type='drive' controller='0' bus='0' unit='1'/> </disk> <disk type='file' device='disk'> <driver name='qemu' type='raw'/> <source file='/var/lib/libvirt/images/test/disk2.raw'/> <target dev='sdc' bus='sata'/> <address type='drive' controller='1' bus='0' unit='0'/> </disk> <controller type='sata' index='0'> <address type='pci' domain='0x0000' bus='0x00' slot='0x05' function='0x0'/> </controller> <controller type='sata' index='1'> <address type='pci' domain='0x0000' bus='0x00' slot='0x06' function='0x0'/> </controller>
2011-09-28 03:46:08 +00:00
"ide", "scsi", "virtio", "xen", "usb" or "sata". If omitted, the bus
type is inferred from the style of the device name. eg, a device named
'sda' will typically be exported using a SCSI bus.
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
<span class="since">Since 0.0.3; <code>bus</code> attribute since 0.4.3;
Add AHCI support to qemu driver Tested with multiple AHCI controllers and multiple disks attached to a controller. E.g., <disk type='file' device='disk'> <driver name='qemu' type='raw'/> <source file='/var/lib/libvirt/images/test/disk0.raw'/> <target dev='sda' bus='sata'/> <address type='drive' controller='0' bus='0' unit='0'/> </disk> <disk type='file' device='disk'> <driver name='qemu' type='raw'/> <source file='/var/lib/libvirt/images/test/disk1.raw'/> <target dev='sdb' bus='sata'/> <address type='drive' controller='0' bus='0' unit='1'/> </disk> <disk type='file' device='disk'> <driver name='qemu' type='raw'/> <source file='/var/lib/libvirt/images/test/disk2.raw'/> <target dev='sdc' bus='sata'/> <address type='drive' controller='1' bus='0' unit='0'/> </disk> <controller type='sata' index='0'> <address type='pci' domain='0x0000' bus='0x00' slot='0x05' function='0x0'/> </controller> <controller type='sata' index='1'> <address type='pci' domain='0x0000' bus='0x00' slot='0x06' function='0x0'/> </controller>
2011-09-28 03:46:08 +00:00
"usb" attribute value since after 0.4.4; "sata" attribute value since
0.9.7</span></dd>
Support block I/O throttle in XML Enable block I/O throttle for per-disk in XML, as the first per-disk IO tuning parameter. Signed-off-by: Lei Li <lilei@linux.vnet.ibm.com> Signed-off-by: Zhi Yong Wu <wuzhy@linux.vnet.ibm.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-11-15 09:02:46 +00:00
<dt><code>iotune</code></dt>
<dd>The optional <code>iotune</code> element provides the
ability to provide additional per-device I/O tuning, with
values that can vary for each device (contrast this to
the <a href="#elementsBlockTuning"><code>&lt;blkiotune&gt;</code></a>
element, which applies globally to the domain). Currently,
the only tuning available is Block I/O throttling for qemu.
This element has optional sub-elements; any sub-element not
specified or given with a value of 0 implies no
limit. <span class="since">Since 0.9.8</span>
<dl>
<dt><code>total_bytes_sec</code></dt>
<dd>The optional <code>total_bytes_sec</code> element is the
total throughput limit in bytes per second. This cannot
appear with <code>read_bytes_sec</code>
or <code>write_bytes_sec</code>.</dd>
<dt><code>read_bytes_sec</code></dt>
<dd>The optional <code>read_bytes_sec</code> element is the
read throughput limit in bytes per second.</dd>
<dt><code>write_bytes_sec</code></dt>
<dd>The optional <code>write_bytes_sec</code> element is the
write throughput limit in bytes per second.</dd>
<dt><code>total_iops_sec</code></dt>
<dd>The optional <code>total_iops_sec</code> element is the
total I/O operations per second. This cannot
appear with <code>read_iops_sec</code>
or <code>write_iops_sec</code>.</dd>
<dt><code>read_iops_sec</code></dt>
<dd>The optional <code>read_iops_sec</code> element is the
read I/O operations per second.</dd>
<dt><code>write_iops_sec</code></dt>
<dd>The optional <code>write_iops_sec</code> element is the
write I/O operations per second.</dd>
</dl>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dt><code>driver</code></dt>
qemu aio: add XML parsing Allows io={threads|native} as an optional attribute to <driver>. Signed-off-by: Eric Blake <eblake@redhat.com>
2010-04-21 14:28:21 +00:00
<dd>
The optional driver element allows specifying further details
related to the hypervisor driver used to provide the disk.
docs/formatdomain: Add release info for disk <driver> attributes
2011-03-08 18:02:43 +00:00
<span class="since">Since 0.1.8</span>
qemu aio: add XML parsing Allows io={threads|native} as an optional attribute to <driver>. Signed-off-by: Eric Blake <eblake@redhat.com>
2010-04-21 14:28:21 +00:00
<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",
Add unsafe cache mode support for disk driver QEMU 0.13 introduced cache=unsafe for -drive, this patch exposes it in the libvirt layer. * Introduced a new QEMU capability flag ($prefix_CACHE_UNSAFE), as even if $prefix_CACHE_V2 is set, we can't know if unsafe is supported. * Improved the reliability of qemu cache type detection.
2011-09-22 19:33:47 +00:00
"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>
qemu aio: add XML parsing Allows io={threads|native} as an optional attribute to <driver>. Signed-off-by: Eric Blake <eblake@redhat.com>
2010-04-21 14:28:21 +00:00
</li>
<li>
The optional <code>error_policy</code> attribute controls
qemu: add separate rerror_policy for disk errors Previously libvirt's disk device XML only had a single attribute, error_policy, to control both read and write error policy, but qemu has separate options for controlling read and write. In one case (enospc) a policy is allowed for write errors but not read errors. This patch adds a separate attribute that sets only the read error policy. If just error_policy is set, it will apply to both read and write error policy (previous behavior), but if the new rerror_policy attribute is set, it will override error_policy for read errors only. Possible values for rerror_policy are "stop", "report", and "ignore" ("report" is the qemu-controlled default for rerror_policy when error_policy isn't specified). For consistency, the value "report" has been added to the possible values for error_policy as well.
2011-10-04 18:17:06 +00:00
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
docs: fix html bug </space> doesn't exist. Introduced in commit 4bb4109f. * docs/formatdomain.html.in: Use correct end tag.
2011-10-10 22:32:45 +00:00
0.9.7</span>. If no rerror_policy is given, error_policy
qemu: add separate rerror_policy for disk errors Previously libvirt's disk device XML only had a single attribute, error_policy, to control both read and write error policy, but qemu has separate options for controlling read and write. In one case (enospc) a policy is allowed for write errors but not read errors. This patch adds a separate attribute that sets only the read error policy. If just error_policy is set, it will apply to both read and write error policy (previous behavior), but if the new rerror_policy attribute is set, it will override error_policy for read errors only. Possible values for rerror_policy are "stop", "report", and "ignore" ("report" is the qemu-controlled default for rerror_policy when error_policy isn't specified). For consistency, the value "report" has been added to the possible values for error_policy as well.
2011-10-04 18:17:06 +00:00
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".
qemu aio: add XML parsing Allows io={threads|native} as an optional attribute to <driver>. Signed-off-by: Eric Blake <eblake@redhat.com>
2010-04-21 14:28:21 +00:00
</li>
<li>
The optional <code>io</code> attribute controls specific
policies on I/O; qemu guests support "threads" and
docs/formatdomain: Add release info for disk <driver> attributes
2011-03-08 18:02:43 +00:00
"native". <span class="since">Since 0.8.8</span>
qemu aio: add XML parsing Allows io={threads|native} as an optional attribute to <driver>. Signed-off-by: Eric Blake <eblake@redhat.com>
2010-04-21 14:28:21 +00:00
</li>
qemu: domain I/O asynchronous handling For virtio disks and interfaces, qemu allows users to enable or disable ioeventfd feature. This means, qemu can execute domain code, while another thread waits for I/O event. Basically, in some cases it is win, in some loss. This feature is available via 'ioeventfd' attribute in disk and interface <driver> element. It accepts 'on' and 'off'. Leaving this attribute out defaults to hypervisor decision.
2011-06-20 08:26:47 +00:00
<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>
qemu: support event_idx parameter for virtio disk and net devices In some versions of qemu, both virtio-blk-pci and virtio-net-pci devices can have an event_idx setting that determines some details of event processing. When it is enabled, it "reduces the number of interrupts and exits for the guest". qemu will automatically enable this feature when it is available, but there may be cases where this new feature could actually make performance worse (NB: no such case has been found so far). As a safety switch in case such a situation is encountered in the field, this patch adds a new attribute "event_idx" to the <driver> element of both disk and interface devices. event_idx can be set to "on" (to force event_idx on in case qemu has it disabled by default) or "off" (for force event_idx off). In the case that event_idx support isn't present in qemu, the attribute is ignored (this on the advice of the qemu developer). docs/formatdomain.html.in: document the new flag (marking it as "don't mess with this!" docs/schemas/domain.rng: add event_idx in appropriate places src/conf/domain_conf.[ch]: add event_idx to parser and formatter src/libvirt_private.syms: export virDomainVirtioEventIdx(From|To)String src/qemu/qemu_capabilities.[ch]: detect and report event_idx in disk/net src/qemu/qemu_command.c: add event_idx parameter to qemu commandline when appropriate. tests/qemuxml2argvdata/qemuxml2argv-event_idx.args, tests/qemuxml2argvdata/qemuxml2argv-event_idx.xml, tests/qemuxml2argvtest.c, tests/qemuxml2xmltest.c: test cases for event_idx.
2011-08-13 06:32:45 +00:00
<li>
The optional <code>event_idx</code> attribute controls
some aspects of device event processing. The value can be
either 'on' or 'off' - if it is on, it will reduce the
number of interupts and exits for the guest. The default
is determined by QEMU; usually if the feature is
supported, default is on. In case there is a situation
where this behavior is suboptimal, this attribute provides
a way to force the feature off.
<span class="since">Since 0.9.5 (QEMU and KVM only)</span>
<b>In general you should leave this option alone, unless you
are very certain you know what you are doing.</b>
</li>
qemu aio: add XML parsing Allows io={threads|native} as an optional attribute to <driver>. Signed-off-by: Eric Blake <eblake@redhat.com>
2010-04-21 14:28:21 +00:00
</ul>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dd>
Introduce per-device boot element Currently, boot order can be specified per device class but there is no way to specify exact disk/NIC device to boot from. This patch adds <boot order='N'/> element which can be used inside <disk/> and <interface/>. This is incompatible with the older os/boot element. Since not all hypervisors support per-device boot specification, new deviceboot flag is included in capabilities XML for hypervisors which understand the new boot element. Presence of the flag allows (but doesn't require) users to use the new style boot order specification.
2011-01-12 14:19:34 +00:00
<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>
Attach encryption information to virDomainDiskDef. The XML allows <encryption format='unencrypted'/>, this implementation canonicalizes the internal representation so that "disk->encryption" is non-NULL iff encryption information is available. A domain with partial encryption information can be defined, completeness of the information is not verified. The domain won't start until the remaining information is added, of course. * docs/formatdomain.html, docs/formatdomain.html.in: Document new encryption options for disks * docs/schemas/domain.rng: Pull in storage encryption schema rules * src/domain_conf.h, src/domain_conf.c: Wire up storage encryption XML parsing/formatting APIs
2009-07-21 05:23:03 +00:00
<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>
snapshot: additions to domain xml for disks As discussed here: https://www.redhat.com/archives/libvir-list/2011-August/msg00361.html https://www.redhat.com/archives/libvir-list/2011-August/msg00552.html Adds snapshot attribute and transient sub-element: <devices> <disk type=... snapshot='no|internal|external'> ... <transient/> </disk> </devices> * docs/schemas/domaincommon.rng (snapshot): New define. (disk): Add snapshot and persistent attributes. * docs/formatdomain.html.in: Document them. * src/conf/domain_conf.h (virDomainDiskSnapshot): New enum. (_virDomainDiskDef): New fields. * tests/qemuxml2argvdata/qemuxml2argv-disk-transient.xml: New test of rng, no args counterpart until qemu support is complete. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.args: New file, snapshot attribute does not affect args. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.xml: Likewise. * tests/qemuxml2argvtest.c (mymain): Run new test.
2011-08-13 19:20:21 +00:00
<dt><code>readonly</code></dt>
<dd>If present, this indicates the device cannot be modified by
the guest. For now, this is the default for disks with
attribute <code>type='cdrom'</code>.
</dd>
add missing doc for device <shareable/> option
2009-12-14 15:20:55 +00:00
<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>
snapshot: additions to domain xml for disks As discussed here: https://www.redhat.com/archives/libvir-list/2011-August/msg00361.html https://www.redhat.com/archives/libvir-list/2011-August/msg00552.html Adds snapshot attribute and transient sub-element: <devices> <disk type=... snapshot='no|internal|external'> ... <transient/> </disk> </devices> * docs/schemas/domaincommon.rng (snapshot): New define. (disk): Add snapshot and persistent attributes. * docs/formatdomain.html.in: Document them. * src/conf/domain_conf.h (virDomainDiskSnapshot): New enum. (_virDomainDiskDef): New fields. * tests/qemuxml2argvdata/qemuxml2argv-disk-transient.xml: New test of rng, no args counterpart until qemu support is complete. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.args: New file, snapshot attribute does not affect args. * tests/qemuxml2argvdata/qemuxml2argv-disk-snapshot.xml: Likewise. * tests/qemuxml2argvtest.c (mymain): Run new test.
2011-08-13 19:20:21 +00:00
<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 * docs/formatdomain.html.in: Document <serial> element within <disk> and fix typo on <driver/> element
2010-05-27 11:44:41 +00:00
<dt><code>serial</code></dt>
<dd>If present, this specify serial number of virtual hard drive.
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
For example, it may look
like <code>&lt;serial&gt;WD-WMAP9A966149&lt;/serial&gt;</code>.
Add docs on drive <serial> element * docs/formatdomain.html.in: Document <serial> element within <disk> and fix typo on <driver/> element
2010-05-27 11:44:41 +00:00
<span class="since">Since 0.7.1</span>
</dd>
update docs for network disks Signed-off-by: MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>
2010-12-24 11:41:47 +00:00
<dt><code>host</code></dt>
<dd>The <code>host</code> element has two attributes "name" and "port",
which specify the hostname and the port number. The meaning of this
element and the number of the elements depend on the protocol attribute.
<table class="top_table">
<tr>
<th> Protocol </th>
<th> Meaning </th>
<th> Number of hosts </th>
</tr>
<tr>
<td> nbd </td>
<td> a server running nbd-server </td>
<td> only one </td>
</tr>
<tr>
<td> rbd </td>
<td> monitor servers of RBD </td>
<td> one or more </td>
</tr>
<tr>
<td> sheepdog </td>
<td> one of the sheepdog servers (default is localhost:7000) </td>
<td> zero or one </td>
</tr>
</table>
</dd>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<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>,
qemu: make PCI multifunction support more manual When support for was added for PCI multifunction cards (in commit 9f8baf, first included in libvirt 0.9.3), it was done by always turning on the multifunction bit for all PCI devices. Since that time it has been realized that this is not an ideal solution, and that the multifunction bit must be selectively turned on. For example, see https://bugzilla.redhat.com/show_bug.cgi?id=728174 and the discussion before and after https://www.redhat.com/archives/libvir-list/2011-September/msg01036.html This patch modifies multifunction support so that the multifunction=on option is only added to the qemu commandline for a device if its PCI <address> definition has the attribute "multifunction='on'", e.g.: <address type='pci' domain='0x0000' bus='0x00' slot='0x04' function='0x0' multifunction='on'/> In practice, the multifunction bit should only be turned on if function='0' AND other functions will be used in the same slot - it usually isn't needed for functions 1-7 (although there are apparently some exceptions, e.g. the Intel X53 according to the QEMU source code), and should never be set if only function 0 will be used in the slot. The test cases have been changed accordingly to illustrate. With this patch in place, if a user attempts to assign multiple functions in a slot without setting the multifunction bit for function 0, libvirt will issue an error when the domain is defined, and the define operation will fail. In the future, we may decide to detect this situation and automatically add multifunction=on to avoid the error; even then it will still be useful to have a manual method of turning on multifunction since, as stated above, there are some devices that excpect it to be turned on for all functions in a slot. A side effect of this patch is that attempts to use the same PCI address for two different devices will now log an error (previously this would cause the domain define operation to fail, but there would be no log message generated). Because the function doing this log was almost completely rewritten, I didn't think it worthwhile to make a separate patch for that fix (the entire patch would immediately be obsoleted).
2011-09-29 17:00:32 +00:00
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
<code>controller</code>, <code>bus</code>,
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
and <code>unit</code> are available, each defaulting to 0.
storage: add auth to virDomainDiskDef Add additional fields to let you specify the how to authenticate with a disk. The secret to use may be referenced by a usage string or a UUID, i.e.: <auth username='myuser'> <secret type='ceph' usage='secretname'/> </auth> or <auth username='myuser'> <secret type='ceph' uuid='0a81f5b2-8403-7b23-c8d6-21ccc2f80d6f'/> </auth> Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2011-10-28 18:29:39 +00:00
</dd>
<dt><code>auth</code></dt>
<dd>If present, the <code>auth</code> element provides the
authentication credentials needed to access the source. It
includes a mandatory attribute <code>username</code>, which
identifies the username to use during authentication, as well
as a sub-element <code>secret</code> with mandatory
attribute <code>type</code>, to tie back to
a <a href="formatsecret.html">libvirt secret object</a> that
holds the actual password or other credentials (the domain XML
intentionally does not expose the password, only the reference
to the object that does manage the password). For now, the
only known secret <code>type</code> is "ceph", for Ceph RBD
network sources, and requires either an
attribute <code>uuid</code> with the UUID of the Ceph secret
object, or an attribute <code>usage</code> with the name
associated with the Ceph secret
object. <span class="since">libvirt 0.9.7</span>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
<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;
docs: <filesystem> attr is 'accessmode', not 'mode'
2011-05-05 18:56:59 +00:00
&lt;filesystem type='mount' accessmode='passthrough'&gt;
Introduce <driver> under <filesystem> to support open-by-handle VirtFS allows the user to choose between path/handle based fs driver. As of now, libvirt hardcoded path based driver only. This patch provides a solution to allow user to choose between path/handle based fs driver. Sample: <filesystem type='mount'> <driver type='handle'/> <source dir='/folder/to/share1'/> <target dir='mount_tag1'/> </filesystem> <filesystem type='mount'> <driver type='path'/> <source dir='/folder/to/share2'/> <target dir='mount_tag2'/> </filesystem> Signed-off-by: Harsh Prateek Bora <harsh@linux.vnet.ibm.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-10-11 11:30:40 +00:00
&lt;driver type='path'/&gt;
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
&lt;source dir='/export/to/guest'/&gt;
&lt;target dir='/import/from/host'/&gt;
&lt;readonly/&gt;
&lt;/filesystem&gt;
...
&lt;/devices&gt;
...</pre>
<dl>
<dt><code>filesystem</code></dt>
<dd>
The filesystem attribute <code>type</code> specifies the type of the
<code>source</code>. The possible values are:
<dl>
<dt><code>type='mount'</code></dt>
<dd>
A host directory to mount in the guest. Used by LXC,
OpenVZ <span class="since">(since 0.6.2)</span>
and QEMU/KVM <span class="since">(since 0.8.5)</span>.
docs: <filesystem> attr is 'accessmode', not 'mode'
2011-05-05 18:56:59 +00:00
This is the default <code>type</code> if one is not specified.
Introduce <driver> under <filesystem> to support open-by-handle VirtFS allows the user to choose between path/handle based fs driver. As of now, libvirt hardcoded path based driver only. This patch provides a solution to allow user to choose between path/handle based fs driver. Sample: <filesystem type='mount'> <driver type='handle'/> <source dir='/folder/to/share1'/> <target dir='mount_tag1'/> </filesystem> <filesystem type='mount'> <driver type='path'/> <source dir='/folder/to/share2'/> <target dir='mount_tag2'/> </filesystem> Signed-off-by: Harsh Prateek Bora <harsh@linux.vnet.ibm.com> Signed-off-by: Eric Blake <eblake@redhat.com>
2011-10-11 11:30:40 +00:00
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
0.9.7)</span>.
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
</dd>
<dt><code>type='template'</code></dt>
<dd>
OpenVZ filesystem template. Only used by OpenVZ driver.
</dd>
<dt><code>type='file'</code></dt>
<dd>
Currently unused.
</dd>
<dt><code>type='block'</code></dt>
<dd>
docs: Document filesystem type='block' for LXC Commit 77791dc0e allows LXC to use a host block device as a guest filesystem, but it isn't documented yet.
2011-10-21 14:26:29 +00:00
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>.
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
</dd>
</dl>
docs: <filesystem> attr is 'accessmode', not 'mode'
2011-05-05 18:56:59 +00:00
The filesystem block has an optional attribute <code>accessmode</code>
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
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>
docs: <filesystem> attr is 'accessmode', not 'mode'
2011-05-05 18:56:59 +00:00
<dt><code>accessmode='passthrough'</code></dt>
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
<dd>
The <code>source</code> is accessed with the permissions of the
docs: <filesystem> attr is 'accessmode', not 'mode'
2011-05-05 18:56:59 +00:00
user inside the guest. This is the default <code>accessmode</code> if
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
one is not specified.
<a href="http://lists.gnu.org/archive/html/qemu-devel/2010-05/msg02673.html">More info</a>
</dd>
docs: <filesystem> attr is 'accessmode', not 'mode'
2011-05-05 18:56:59 +00:00
<dt><code>accessmode='mapped'</code></dt>
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
<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>
docs: <filesystem> attr is 'accessmode', not 'mode'
2011-05-05 18:56:59 +00:00
<dt><code>accessmode='squash'</code></dt>
docs: Document <filesystem> device Tried to dredge through old changelogs and commits to come up with it, so may not be completely accurate. v2: Drop ambiguous 'containers' Use same mail archive for all links
2011-04-29 17:20:28 +00:00
<dd>
Similar to 'passthrough', the exception is that failure of
privileged operations like 'chown' are ignored. This makes a
passthrough-like mode usable for people who run the hypervisor
as non-root.
<a href="http://lists.gnu.org/archive/html/qemu-devel/2010-09/msg00121.html">More info</a>
</dd>
</dl>
</dd>
<dt><code>source</code></dt>
<dd>
The resource on the host that is being accessed in the guest. The
<code>name</code> attribute must be used with
<code>type='template'</code>, and the <code>dir</code> attribute must
be used with <code>type='mount'</code>
</dd>
<dt><code>target</code></dt>
<dd>
Where the <code>source</code> can be accessed in the guest. For
most drivers this is an automatic mount point, but for QEMU/KVM
this is merely an arbitrary string tag that is exported to the
guest as a hint for where to mount.
</dd>
<dt><code>readonly</code></dt>
<dd>
An optional <code>readonly</code> attribute is available but currently
unused.
</dd>
</dl>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<h4><a name="elementsControllers">Controllers</a></h4>
<p>
Many devices that have an <code>&lt;address&gt;</code>
sub-element are designed to work with a controller to manage
related devices. Normally, libvirt can automatically infer such
controllers without requiring explicit XML markup, but sometimes
it is necessary to provide an explicit controller element.
</p>
<pre>
...
&lt;devices&gt;
&lt;controller type='ide' index='0'/&gt;
&lt;controller type='virtio-serial' index='0' ports='16' vectors='4'/&gt;
&lt;controller type='virtio-serial' index='1'&gt;
&lt;address type='pci' domain='0x0000' bus='0x00' slot='0x0a' function='0x0'/&gt;
&lt;/controller&gt;
...
&lt;/devices&gt;
...</pre>
<p>
Each controller has a mandatory attribute <code>type</code>,
Add a new controller type 'usb' with optionnal 'model' The model by default is piix3-uchi. Example: <controller type='usb' index='0' model='ich9-ehci'/>
2011-09-02 13:21:23 +00:00
which must be one of "ide", "fdc", "scsi", "sata", "usb",
"ccid", or "virtio-serial", and a mandatory
attribute <code>index</code> which is the decimal integer
describing in which order the bus controller is encountered (for
use in <code>controller</code> attributes
of <code>&lt;address&gt;</code> elements). The "virtio-serial"
controller has two additional optional
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
attributes <code>ports</code> and <code>vectors</code>, which
control how many devices can be connected through the
controller. A "scsi" controller has an optional
attribute <code>model</code>, which is one of "auto",
"buslogic", "lsilogic", "lsias1068", or "vmpvscsi".
Add a new controller type 'usb' with optionnal 'model' The model by default is piix3-uchi. Example: <controller type='usb' index='0' model='ich9-ehci'/>
2011-09-02 13:21:23 +00:00
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" or "pci-ohci".
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
</p>
<p>
For controllers that are themselves devices on a PCI or USB bus,
an optional sub-element <code>&lt;address&gt;</code> can specify
the exact relationship of the controller to its master bus, with
semantics like any other device's <code>address</code>
sub-element.
</p>
Add USB companion controllers support Companion controllers take an extra 'master' attribute to associate them. Also add tests for this
2011-09-02 14:03:51 +00:00
<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;
qemu: make PCI multifunction support more manual When support for was added for PCI multifunction cards (in commit 9f8baf, first included in libvirt 0.9.3), it was done by always turning on the multifunction bit for all PCI devices. Since that time it has been realized that this is not an ideal solution, and that the multifunction bit must be selectively turned on. For example, see https://bugzilla.redhat.com/show_bug.cgi?id=728174 and the discussion before and after https://www.redhat.com/archives/libvir-list/2011-September/msg01036.html This patch modifies multifunction support so that the multifunction=on option is only added to the qemu commandline for a device if its PCI <address> definition has the attribute "multifunction='on'", e.g.: <address type='pci' domain='0x0000' bus='0x00' slot='0x04' function='0x0' multifunction='on'/> In practice, the multifunction bit should only be turned on if function='0' AND other functions will be used in the same slot - it usually isn't needed for functions 1-7 (although there are apparently some exceptions, e.g. the Intel X53 according to the QEMU source code), and should never be set if only function 0 will be used in the slot. The test cases have been changed accordingly to illustrate. With this patch in place, if a user attempts to assign multiple functions in a slot without setting the multifunction bit for function 0, libvirt will issue an error when the domain is defined, and the define operation will fail. In the future, we may decide to detect this situation and automatically add multifunction=on to avoid the error; even then it will still be useful to have a manual method of turning on multifunction since, as stated above, there are some devices that excpect it to be turned on for all functions in a slot. A side effect of this patch is that attempts to use the same PCI address for two different devices will now log an error (previously this would cause the domain define operation to fail, but there would be no log message generated). Because the function doing this log was almost completely rewritten, I didn't think it worthwhile to make a separate patch for that fix (the entire patch would immediately be obsoleted).
2011-09-29 17:00:32 +00:00
&lt;address type='pci' domain='0' bus='0' slot='4' function='0' multifunction='on'/&gt;
Add USB companion controllers support Companion controllers take an extra 'master' attribute to associate them. Also add tests for this
2011-09-02 14:03:51 +00:00
&lt;/controller&gt;
...
&lt;/devices&gt;
...</pre>
Support leases in guest XML and lock manager A lock manager may operate in various modes. The direct mode of operation is to obtain locks based on the resources associated with devices in the XML. The indirect mode is where the app creating the domain provides explicit leases for each resource that needs to be locked. This XML extension allows for listing resources in the XML <devices> ... <lease> <lockspace>somearea</lockspace> <key>thequickbrownfoxjumpsoverthelazydog</key> <target path='/some/lease/path' offset='23432'/> </lease> ... </devices> The 'lockspace' is a unique identifier for the lockspace which the lease is associated The 'key' is a unique identifier for the resource associated with the lease. The 'target' is the file on disk where the leases are held. * docs/schemas/domain.rng: Add lease schema * src/conf/domain_conf.c, src/conf/domain_conf.h: parsing and formatting for leases * tests/qemuxml2argvdata/qemuxml2argv-lease.args, tests/qemuxml2argvdata/qemuxml2argv-lease.xml, tests/qemuxml2xmltest.c: Test XML handling for leases
2010-12-09 18:25:11 +00:00
<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>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
Add tests and docs for the new PCI passthrough format * docs/formatdomain.html.in docs/libvirt.rng docs/formatdomain.html: document the new PCI passthrough format * tests/qemuxml2argvtest.c tests/qemuxml2xmltest.c tests/qemuxml2argvdata/qemuxml2argv-hostdev-pci-address.args tests/qemuxml2argvdata/qemuxml2argv-hostdev-pci-address.xml: and add a regression test for it. Daniel
2009-01-12 15:09:19 +00:00
<h4><a name="elementsUSB">USB and PCI devices</a></h4>
documentation for USB passthrough * docs/formatdomain.html docs/formatdomain.html.in: documentation for the USB format option by Guido Günther daniel
2008-08-12 07:28:28 +00:00
<p>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
USB and PCI devices attached to the host can be passed through
to the guest using
Add tests and docs for the new PCI passthrough format * docs/formatdomain.html.in docs/libvirt.rng docs/formatdomain.html: document the new PCI passthrough format * tests/qemuxml2argvtest.c tests/qemuxml2xmltest.c tests/qemuxml2argvdata/qemuxml2argv-hostdev-pci-address.args tests/qemuxml2argvdata/qemuxml2argv-hostdev-pci-address.xml: and add a regression test for it. Daniel
2009-01-12 15:09:19 +00:00
the <code>hostdev</code> element. <span class="since">since after
0.4.4 for USB and 0.6.0 for PCI (KVM only)</span>:
documentation for USB passthrough * docs/formatdomain.html docs/formatdomain.html.in: documentation for the USB format option by Guido Günther daniel
2008-08-12 07:28:28 +00:00
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;hostdev mode='subsystem' type='usb'&gt;
&lt;source&gt;
&lt;vendor id='0x1234'/&gt;
&lt;product id='0xbeef'/&gt;
&lt;/source&gt;
Support booting from hostdev devices
2011-02-03 12:06:21 +00:00
&lt;boot order='2'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/hostdev&gt;
&lt;/devices&gt;
...</pre>
Add tests and docs for the new PCI passthrough format * docs/formatdomain.html.in docs/libvirt.rng docs/formatdomain.html: document the new PCI passthrough format * tests/qemuxml2argvtest.c tests/qemuxml2xmltest.c tests/qemuxml2argvdata/qemuxml2argv-hostdev-pci-address.args tests/qemuxml2argvdata/qemuxml2argv-hostdev-pci-address.xml: and add a regression test for it. Daniel
2009-01-12 15:09:19 +00:00
<p>or:</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
domain.rng vs. formatdomain.html#elementsUSB The Relax-NG schema for domains regarding <hostdev> doesn't match what's implemented in src/conf/domain_conf.c#virDomainHostdevDefFormat(): The implementation only requires @type, but the schema currently either required none or all three attributes (@mode, @type, and @managed) to be defined together, because they are declared in the same <optional)-section. (@managed is currently even undocumented on <http://libvirt.org/formatdomain.html#elementsUSB>). Thus the following minimal <hostdev>-example fails to validate: <domain type='test'> <name>N</name> <memory>4096</memory> <bootloader>/bin/false</bootloader> <os> <type arch='x86_64' machine='xenpv'>linux</type> </os> <devices> <hostdev type='pci'> <source> <address bus='0x06' slot='0x00' function='0x0'/> </source> </hostdev> </devices> </domain> The schema is changed to match the current implementation: 1. @mode is optional (which defaults to 'subsystem') 2. @type is required 3. @managed is optional (which defaults to 'no') The documentation is updated to mention @managed. Signed-off-by: Philipp Hahn <hahn@univention.de>
2011-03-01 10:23:20 +00:00
&lt;hostdev mode='subsystem' type='pci' managed='yes'&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;source&gt;
&lt;address bus='0x06' slot='0x02' function='0x0'/&gt;
&lt;/source&gt;
Support booting from hostdev devices
2011-02-03 12:06:21 +00:00
&lt;boot order='1'/&gt;
qemu: add ability to set PCI device "rombar" on or off This patch was made in response to: https://bugzilla.redhat.com/show_bug.cgi?id=738095 In short, qemu's default for the rombar setting (which makes the firmware ROM of a PCI device visible/not on the guest) was previously 0 (not visible), but they recently changed the default to 1 (visible). Unfortunately, there are some PCI devices that fail in the guest when rombar is 1, so the setting must be exposed in libvirt to prevent a regression in behavior (it will still require explicitly setting <rom bar='off'/> in the guest XML). rombar is forced on/off by adding: <rom bar='on|off'/> inside a <hostdev> element that defines a PCI device. It is currently ignored for all other types of devices. At the moment there is no clean method to determine whether or not the rombar option is supported by QEMU - this patch uses the advice of a QEMU developer to assume support for qemu-0.12+. There is currently a patch in the works to put this information in the output of "qemu-kvm -device pci-assign,?", but of course if we switch to keying off that, we would lose support for setting rombar on all the versions of qemu between 0.12 and whatever version gets that patch.
2011-09-20 17:31:52 +00:00
&lt;rom bar='off'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/hostdev&gt;
&lt;/devices&gt;
...</pre>
documentation for USB passthrough * docs/formatdomain.html docs/formatdomain.html.in: documentation for the USB format option by Guido Günther daniel
2008-08-12 07:28:28 +00:00
<dl>
<dt><code>hostdev</code></dt>
<dd>The <code>hostdev</code> element is the main container for describing
domain.rng vs. formatdomain.html#elementsUSB The Relax-NG schema for domains regarding <hostdev> doesn't match what's implemented in src/conf/domain_conf.c#virDomainHostdevDefFormat(): The implementation only requires @type, but the schema currently either required none or all three attributes (@mode, @type, and @managed) to be defined together, because they are declared in the same <optional)-section. (@managed is currently even undocumented on <http://libvirt.org/formatdomain.html#elementsUSB>). Thus the following minimal <hostdev>-example fails to validate: <domain type='test'> <name>N</name> <memory>4096</memory> <bootloader>/bin/false</bootloader> <os> <type arch='x86_64' machine='xenpv'>linux</type> </os> <devices> <hostdev type='pci'> <source> <address bus='0x06' slot='0x00' function='0x0'/> </source> </hostdev> </devices> </domain> The schema is changed to match the current implementation: 1. @mode is optional (which defaults to 'subsystem') 2. @type is required 3. @managed is optional (which defaults to 'no') The documentation is updated to mention @managed. Signed-off-by: Philipp Hahn <hahn@univention.de>
2011-03-01 10:23:20 +00:00
host devices. For usb device passthrough <code>mode</code> is always
"subsystem" and <code>type</code> is "usb" for a USB device and "pci"
docs/formatdomain.html.in: Fix spelling PIC->PCI Not "Programmable Interrupt Controller" but "Peripheral Component Interconnect". Signed-off-by: Philipp Hahn <hahn@univention.de>
2011-03-14 07:52:14 +00:00
for a PCI device. When <code>managed</code> is "yes" for a PCI
domain.rng vs. formatdomain.html#elementsUSB The Relax-NG schema for domains regarding <hostdev> doesn't match what's implemented in src/conf/domain_conf.c#virDomainHostdevDefFormat(): The implementation only requires @type, but the schema currently either required none or all three attributes (@mode, @type, and @managed) to be defined together, because they are declared in the same <optional)-section. (@managed is currently even undocumented on <http://libvirt.org/formatdomain.html#elementsUSB>). Thus the following minimal <hostdev>-example fails to validate: <domain type='test'> <name>N</name> <memory>4096</memory> <bootloader>/bin/false</bootloader> <os> <type arch='x86_64' machine='xenpv'>linux</type> </os> <devices> <hostdev type='pci'> <source> <address bus='0x06' slot='0x00' function='0x0'/> </source> </hostdev> </devices> </domain> The schema is changed to match the current implementation: 1. @mode is optional (which defaults to 'subsystem') 2. @type is required 3. @managed is optional (which defaults to 'no') The documentation is updated to mention @managed. Signed-off-by: Philipp Hahn <hahn@univention.de>
2011-03-01 10:23:20 +00:00
device, it is detached from the host before being passed on to
docs: document managed=yes of hostdev passthrough Clarify some of the effects of managed passthrough <hostdev> devices; with recent changes (commit d093547), a nodedev-reattach is only needed to pair up to an explicit nodedev-dettach (but beware that older virt-manager has a bug where it uses explicit nodedev-dettach under the hood when using the gui to hotplug a hostdev device). * docs/formatdomain.html.in: Mention reattach. * tools/virsh.pod (nodedev): Mention managed mode.
2011-10-14 22:59:16 +00:00
the guest, and reattached to the host after the guest exits.
If <code>managed</code> is omitted or "no", and for USB
devices, the user is responsible to
call <code>virNodeDeviceDettach</code> (or <code>virsh
nodedev-dettach</code>) before starting the guest or
hot-plugging the device,
and <code>virNodeDeviceReAttach</code> (or <code>virsh
nodedev-reattach</code>) after hot-unplug or stopping the
guest.</dd>
documentation for USB passthrough * docs/formatdomain.html docs/formatdomain.html.in: documentation for the USB format option by Guido Günther daniel
2008-08-12 07:28:28 +00:00
<dt><code>source</code></dt>
<dd>The source element describes the device as seen from the host.
The USB device can either be addressed by vendor / product id using the
<code>vendor</code> and <code>product</code> elements or by the device's
Add tests and docs for the new PCI passthrough format * docs/formatdomain.html.in docs/libvirt.rng docs/formatdomain.html: document the new PCI passthrough format * tests/qemuxml2argvtest.c tests/qemuxml2xmltest.c tests/qemuxml2argvdata/qemuxml2argv-hostdev-pci-address.args tests/qemuxml2argvdata/qemuxml2argv-hostdev-pci-address.xml: and add a regression test for it. Daniel
2009-01-12 15:09:19 +00:00
address on the hosts using the <code>address</code> element.
PCI devices on the other hand can only be described by their
<code>address</code></dd>
documentation for USB passthrough * docs/formatdomain.html docs/formatdomain.html.in: documentation for the USB format option by Guido Günther daniel
2008-08-12 07:28:28 +00:00
<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>
Support booting from hostdev devices
2011-02-03 12:06:21 +00:00
<dt><code>boot</code></dt>
<dd>Specifies that the device is bootable. The <code>order</code>
attribute determines the order in which devices will be tried during
boot sequence. The per-device <code>boot</code> elements cannot be
used together with general boot elements in
<a href="#elementsOSBIOS">BIOS bootloader</a> section.
<span class="since">Since 0.8.8</span></dd>
qemu: add ability to set PCI device "rombar" on or off This patch was made in response to: https://bugzilla.redhat.com/show_bug.cgi?id=738095 In short, qemu's default for the rombar setting (which makes the firmware ROM of a PCI device visible/not on the guest) was previously 0 (not visible), but they recently changed the default to 1 (visible). Unfortunately, there are some PCI devices that fail in the guest when rombar is 1, so the setting must be exposed in libvirt to prevent a regression in behavior (it will still require explicitly setting <rom bar='off'/> in the guest XML). rombar is forced on/off by adding: <rom bar='on|off'/> inside a <hostdev> element that defines a PCI device. It is currently ignored for all other types of devices. At the moment there is no clean method to determine whether or not the rombar option is supported by QEMU - this patch uses the advice of a QEMU developer to assume support for qemu-0.12+. There is currently a patch in the works to put this information in the output of "qemu-kvm -device pci-assign,?", but of course if we switch to keying off that, we would lose support for setting rombar on all the versions of qemu between 0.12 and whatever version gets that patch.
2011-09-20 17:31:52 +00:00
<dt><code>rom</code></dt>
<dd>The <code>rom</code> element is used to change how a PCI
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
have a default of "on"). <span class="since">Since
0.9.7</span>
</dd>
documentation for USB passthrough * docs/formatdomain.html docs/formatdomain.html.in: documentation for the USB format option by Guido Günther daniel
2008-08-12 07:28:28 +00:00
<dt><code>address</code></dt>
Add tests and docs for the new PCI passthrough format * docs/formatdomain.html.in docs/libvirt.rng docs/formatdomain.html: document the new PCI passthrough format * tests/qemuxml2argvtest.c tests/qemuxml2xmltest.c tests/qemuxml2argvdata/qemuxml2argv-hostdev-pci-address.args tests/qemuxml2argvdata/qemuxml2argv-hostdev-pci-address.xml: and add a regression test for it. Daniel
2009-01-12 15:09:19 +00:00
<dd>The <code>address</code> element for USB devices has a
<code>bus</code> and <code>device</code> attribute to specify the
USB bus and device number the device appears at on the host.
The values of these attributes can be given in decimal, hexadecimal
(starting with 0x) or octal (starting with 0) form.
For PCI devices the element carries 3 attributes allowing to designate
the device as can be found with the <code>lspci</code> or
with <code>virsh nodedev-list</code>. The
<code>bus</code> attribute allows the hexadecimal values 0 to ff, the
<code>slot</code> attribute allows the hexadecimal values 0 to 1f, and
qemu: make PCI multifunction support more manual When support for was added for PCI multifunction cards (in commit 9f8baf, first included in libvirt 0.9.3), it was done by always turning on the multifunction bit for all PCI devices. Since that time it has been realized that this is not an ideal solution, and that the multifunction bit must be selectively turned on. For example, see https://bugzilla.redhat.com/show_bug.cgi?id=728174 and the discussion before and after https://www.redhat.com/archives/libvir-list/2011-September/msg01036.html This patch modifies multifunction support so that the multifunction=on option is only added to the qemu commandline for a device if its PCI <address> definition has the attribute "multifunction='on'", e.g.: <address type='pci' domain='0x0000' bus='0x00' slot='0x04' function='0x0' multifunction='on'/> In practice, the multifunction bit should only be turned on if function='0' AND other functions will be used in the same slot - it usually isn't needed for functions 1-7 (although there are apparently some exceptions, e.g. the Intel X53 according to the QEMU source code), and should never be set if only function 0 will be used in the slot. The test cases have been changed accordingly to illustrate. With this patch in place, if a user attempts to assign multiple functions in a slot without setting the multifunction bit for function 0, libvirt will issue an error when the domain is defined, and the define operation will fail. In the future, we may decide to detect this situation and automatically add multifunction=on to avoid the error; even then it will still be useful to have a manual method of turning on multifunction since, as stated above, there are some devices that excpect it to be turned on for all functions in a slot. A side effect of this patch is that attempts to use the same PCI address for two different devices will now log an error (previously this would cause the domain define operation to fail, but there would be no log message generated). Because the function doing this log was almost completely rewritten, I didn't think it worthwhile to make a separate patch for that fix (the entire patch would immediately be obsoleted).
2011-09-29 17:00:32 +00:00
the <code>function</code> attribute allows the hexadecimal values 0 to 7.
The <code>multifunction</code> attribute 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.
There is also an optional <code>domain</code> attribute for
the PCI domain, with hexadecimal values 0 to ffff, but it is
currently not used by qemu.</dd>
documentation for USB passthrough * docs/formatdomain.html docs/formatdomain.html.in: documentation for the USB format option by Guido Günther daniel
2008-08-12 07:28:28 +00:00
</dl>
Add "redirdev" redirection device - create a new "redirdev" element for this purpose
2011-09-02 15:09:14 +00:00
<h4><a name="elementsRedir">Redirected devices</a></h4>
<p>
USB device redirection through a character device is
supported <span class="since">since after 0.9.5 (KVM
only)</span>:
</p>
<pre>
...
&lt;devices&gt;
&lt;redirdev bus='usb' type='tcp'&gt;
&lt;source mode='connect' host='localhost' service='4000'/&gt;
&lt;/redirdev&gt;
&lt;/devices&gt;
...</pre>
<dl>
<dt><code>redirdev</code></dt>
<dd>The <code>redirdev</code> element is the main container for
describing redirected devices. <code>bus</code> must be "usb"
for a USB device.
An additional attribute <code>type</code> is required,
matching one of the
supported <a href="#elementsConsole">serial device</a> types,
to describe the host side of the
tunnel; <code>type='tcp'</code>
or <code>type='spicevmc'</code> (which uses the usbredir
channel of a <a href="#elementsGraphics">SPICE graphics
redirdev: allows to specify device address It is important to be able to attach USB redirected devices to a particular controller (one that supports USB2 for instance). Without this patch, only the default bus was used. <redirdev bus='usb' type='spicevmc'> <address type='usb' bus='0' port='4'/> </redirdev>
2011-09-06 07:06:59 +00:00
device</a>) are typical.</dd>
Add "redirdev" redirection device - create a new "redirdev" element for this purpose
2011-09-02 15:09:14 +00:00
</dl>
redirdev: allows to specify device address It is important to be able to attach USB redirected devices to a particular controller (one that supports USB2 for instance). Without this patch, only the default bus was used. <redirdev bus='usb' type='spicevmc'> <address type='usb' bus='0' port='4'/> </redirdev>
2011-09-06 07:06:59 +00:00
<p>
The redirdev element has an optional sub-element
<code>&lt;address&gt;</code> which can tie the device to a
particular controller.
</p>
<p>
Further sub-elements, such as <code>&lt;source&gt;</code>, may
be required according to the given type, although
a <code>&lt;target&gt;</code> sub-element is not required (since
the consumer of the character device is the hypervisor itself,
rather than a device visible in the guest).
</p>
Add "redirdev" redirection device - create a new "redirdev" element for this purpose
2011-09-02 15:09:14 +00:00
smartcard: add XML support for <smartcard> device Assuming a hypervisor that supports multiple smartcard devices in the guest, this would be a valid XML description: <devices> <smartcard mode='host'/> <smartcard mode='host-certificates'> <certificate>/path/to/cert1</certificate> <certificate>/path/to/cert2</certificate> <certificate>/path/to/cert3</certificate> </smartcard> <smartcard mode='passthrough' type='tcp'> <source mode='bind' host='127.0.0.1' service='2001'/> <protocol type='raw'/> </smartcard> </devices> (As of this commit, the qemu hypervisor will be the first implementation, but it only supports one smartcard.) * docs/formatdomain.html.in (Smartcard devices): New section. * docs/schemas/domain.rng (smartcard): New define, used in devices. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-host.xml: New file to test schema. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-host-certificates.xml: Likewise. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-passthrough-tcp.xml: Likewise. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-controller.xml: Likewise.
2011-01-06 01:02:20 +00:00
<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;
smartcard: add spicevmc support Adds <smartcard mode='passthrough' type='spicevmc'/>, which uses the new <channel name='smartcard'/> of <graphics type='spice'>. * docs/schemas/domain.rng: Support new XML. * docs/formatdomain.html.in: Document it. * src/conf/domain_conf.h (virDomainGraphicsSpiceChannelName): New enum value. (virDomainChrSpicevmcName): New enum. (virDomainChrSourceDef): Distinguish spicevmc types. * src/conf/domain_conf.c (virDomainGraphicsSpiceChannelName): Add smartcard. (virDomainSmartcardDefParseXML): Parse it. (virDomainChrDefParseXML, virDomainSmartcardDefParseXML): Set spicevmc name. (virDomainChrSpicevmc): New enum conversion functions. * src/libvirt_private.syms: Export new functions. * src/qemu/qemu_command.c (qemuBuildChrChardevStr): Conditionalize name. * tests/qemuxml2argvtest.c (domain): New test. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-passthrough-spicevmc.args: New file. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-passthrough-spicevmc.xml: Likewise.
2011-02-04 02:23:31 +00:00
&lt;smartcard mode='passthrough' type='spicevmc'/&gt;
smartcard: add XML support for <smartcard> device Assuming a hypervisor that supports multiple smartcard devices in the guest, this would be a valid XML description: <devices> <smartcard mode='host'/> <smartcard mode='host-certificates'> <certificate>/path/to/cert1</certificate> <certificate>/path/to/cert2</certificate> <certificate>/path/to/cert3</certificate> </smartcard> <smartcard mode='passthrough' type='tcp'> <source mode='bind' host='127.0.0.1' service='2001'/> <protocol type='raw'/> </smartcard> </devices> (As of this commit, the qemu hypervisor will be the first implementation, but it only supports one smartcard.) * docs/formatdomain.html.in (Smartcard devices): New section. * docs/schemas/domain.rng (smartcard): New define, used in devices. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-host.xml: New file to test schema. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-host-certificates.xml: Likewise. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-passthrough-tcp.xml: Likewise. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-controller.xml: Likewise.
2011-01-06 01:02:20 +00:00
&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
smartcard: add spicevmc support Adds <smartcard mode='passthrough' type='spicevmc'/>, which uses the new <channel name='smartcard'/> of <graphics type='spice'>. * docs/schemas/domain.rng: Support new XML. * docs/formatdomain.html.in: Document it. * src/conf/domain_conf.h (virDomainGraphicsSpiceChannelName): New enum value. (virDomainChrSpicevmcName): New enum. (virDomainChrSourceDef): Distinguish spicevmc types. * src/conf/domain_conf.c (virDomainGraphicsSpiceChannelName): Add smartcard. (virDomainSmartcardDefParseXML): Parse it. (virDomainChrDefParseXML, virDomainSmartcardDefParseXML): Set spicevmc name. (virDomainChrSpicevmc): New enum conversion functions. * src/libvirt_private.syms: Export new functions. * src/qemu/qemu_command.c (qemuBuildChrChardevStr): Conditionalize name. * tests/qemuxml2argvtest.c (domain): New test. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-passthrough-spicevmc.args: New file. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-passthrough-spicevmc.xml: Likewise.
2011-02-04 02:23:31 +00:00
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
smartcard: add XML support for <smartcard> device Assuming a hypervisor that supports multiple smartcard devices in the guest, this would be a valid XML description: <devices> <smartcard mode='host'/> <smartcard mode='host-certificates'> <certificate>/path/to/cert1</certificate> <certificate>/path/to/cert2</certificate> <certificate>/path/to/cert3</certificate> </smartcard> <smartcard mode='passthrough' type='tcp'> <source mode='bind' host='127.0.0.1' service='2001'/> <protocol type='raw'/> </smartcard> </devices> (As of this commit, the qemu hypervisor will be the first implementation, but it only supports one smartcard.) * docs/formatdomain.html.in (Smartcard devices): New section. * docs/schemas/domain.rng (smartcard): New define, used in devices. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-host.xml: New file to test schema. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-host-certificates.xml: Likewise. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-passthrough-tcp.xml: Likewise. * tests/qemuxml2argvdata/qemuxml2argv-smartcard-controller.xml: Likewise.
2011-01-06 01:02:20 +00:00
given type, although a <code>&lt;target&gt;</code> sub-element
is not required (since the consumer of the character device is
the hypervisor itself, rather than a device visible in the
guest).</dd>
</dl>
<p>
Each mode supports an optional
sub-element <code>&lt;address&gt;</code>, which fine-tunes the
correlation between the smartcard and a ccid bus controller.
If present, the element must have an attribute
of <code>type='ccid'</code> as well as a <code>bus</code>
attribute listing the index of the bus that the smartcard
utilizes. An optional <code>slot</code> attribute lists which
slot within the bus. For now, qemu only supports at most one
smartcard, with an address of bus=0 slot=0.
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h4><a name="elementsNICS">Network interfaces</a></h4>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='bridge'&gt;
&lt;source bridge='xenbr0'/&gt;
&lt;mac address='00:16:3e:5d:c7:9e'/&gt;
&lt;script path='vif-bridge'/&gt;
Introduce per-device boot element Currently, boot order can be specified per device class but there is no way to specify exact disk/NIC device to boot from. This patch adds <boot order='N'/> element which can be used inside <disk/> and <interface/>. This is incompatible with the older os/boot element. Since not all hypervisors support per-device boot specification, new deviceboot flag is included in capabilities XML for hypervisors which understand the new boot element. Presence of the flag allows (but doesn't require) users to use the new style boot order specification.
2011-01-12 14:19:34 +00:00
&lt;boot order='1'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<p>
There are several possibilities for specifying a network
interface visible to the guest. Each subsection below provides
more details about common setup options. Additionally,
each <code>&lt;interface&gt;</code> element has an
optional <code>&lt;address&gt;</code> sub-element that can tie
the interface to a particular pci slot, with
attribute <code>type='pci'</code> and additional
attributes <code>domain</code>, <code>bus</code>, <code>slot</code>,
qemu: make PCI multifunction support more manual When support for was added for PCI multifunction cards (in commit 9f8baf, first included in libvirt 0.9.3), it was done by always turning on the multifunction bit for all PCI devices. Since that time it has been realized that this is not an ideal solution, and that the multifunction bit must be selectively turned on. For example, see https://bugzilla.redhat.com/show_bug.cgi?id=728174 and the discussion before and after https://www.redhat.com/archives/libvir-list/2011-September/msg01036.html This patch modifies multifunction support so that the multifunction=on option is only added to the qemu commandline for a device if its PCI <address> definition has the attribute "multifunction='on'", e.g.: <address type='pci' domain='0x0000' bus='0x00' slot='0x04' function='0x0' multifunction='on'/> In practice, the multifunction bit should only be turned on if function='0' AND other functions will be used in the same slot - it usually isn't needed for functions 1-7 (although there are apparently some exceptions, e.g. the Intel X53 according to the QEMU source code), and should never be set if only function 0 will be used in the slot. The test cases have been changed accordingly to illustrate. With this patch in place, if a user attempts to assign multiple functions in a slot without setting the multifunction bit for function 0, libvirt will issue an error when the domain is defined, and the define operation will fail. In the future, we may decide to detect this situation and automatically add multifunction=on to avoid the error; even then it will still be useful to have a manual method of turning on multifunction since, as stated above, there are some devices that excpect it to be turned on for all functions in a slot. A side effect of this patch is that attempts to use the same PCI address for two different devices will now log an error (previously this would cause the domain define operation to fail, but there would be no log message generated). Because the function doing this log was almost completely rewritten, I didn't think it worthwhile to make a separate patch for that fix (the entire patch would immediately be obsoleted).
2011-09-29 17:00:32 +00:00
<code>function</code>, and <code>multifunction</code>
<span class="since">since 0.9.7, requires QEMU 0.13</span> as appropriate.
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h5><a name="elementsNICSVirtual">Virtual network</a></h5>
<p>
<strong><em>
This is the recommended config for general guest connectivity on
conf: support abstracted interface info in domain interface XML the domain XML <interface> element is updated in the following ways: 1) <virtualportprofile> can be specified when source type='network' (previously it was only valid for source type='direct') 2) A new attribute "portgroup" has been added to the <source> element. When source type='network' (the only time portgroup is recognized), extra configuration information will be taken from the <portgroup> element of the given name in the network definition. 3) Each virDomainNetDef now also potentially has a virDomainActualNetDef which is a private object (never exported/imported via the public API, and not defined in the RNG) that is used to maintain information about the physical device that was actually used for a NetDef of type VIR_DOMAIN_NET_TYPE_NETWORK. The virDomainActualNetDef will only be parsed/formatted if the parse/format function is called with the VIR_DOMAIN_XML_INTERNAL_ACTUAL_NET flag set (which is only needed when saving/loading a running domain's state info to the stateDir).
2011-06-26 08:09:00 +00:00
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>).
Update domain XML docs
2008-05-08 14:20:07 +00:00
</em></strong>
</p>
<p>
conf: support abstracted interface info in domain interface XML the domain XML <interface> element is updated in the following ways: 1) <virtualportprofile> can be specified when source type='network' (previously it was only valid for source type='direct') 2) A new attribute "portgroup" has been added to the <source> element. When source type='network' (the only time portgroup is recognized), extra configuration information will be taken from the <portgroup> element of the given name in the network definition. 3) Each virDomainNetDef now also potentially has a virDomainActualNetDef which is a private object (never exported/imported via the public API, and not defined in the RNG) that is used to maintain information about the physical device that was actually used for a NetDef of type VIR_DOMAIN_NET_TYPE_NETWORK. The virDomainActualNetDef will only be parsed/formatted if the parse/format function is called with the VIR_DOMAIN_XML_INTERNAL_ACTUAL_NET flag set (which is only needed when saving/loading a running domain's state info to the stateDir).
2011-06-26 08:09:00 +00:00
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
Document overriding domain interface target * docs/formatdomain.html.in: document that vnet and vif are reserved names and will be ignored if manually specified.
2009-11-20 15:25:58 +00:00
<a href="#elementsNICSTargetOverride">overriding the target element</a>).
Update domain XML docs
2008-05-08 14:20:07 +00:00
</p>
conf: support abstracted interface info in domain interface XML the domain XML <interface> element is updated in the following ways: 1) <virtualportprofile> can be specified when source type='network' (previously it was only valid for source type='direct') 2) A new attribute "portgroup" has been added to the <source> element. When source type='network' (the only time portgroup is recognized), extra configuration information will be taken from the <portgroup> element of the given name in the network definition. 3) Each virDomainNetDef now also potentially has a virDomainActualNetDef which is a private object (never exported/imported via the public API, and not defined in the RNG) that is used to maintain information about the physical device that was actually used for a NetDef of type VIR_DOMAIN_NET_TYPE_NETWORK. The virDomainActualNetDef will only be parsed/formatted if the parse/format function is called with the VIR_DOMAIN_XML_INTERNAL_ACTUAL_NET flag set (which is only needed when saving/loading a running domain's state info to the stateDir).
2011-06-26 08:09:00 +00:00
<p>
When the source of an interface is a network,
a <code>portgroup</code> can be specified along with the name of
the network; one network may have multiple portgroups defined,
with each portgroup containing slightly different configuration
information for different classes of network
connections. <span class="since">Since 0.9.4</span>). Also,
similar to <code>direct</code> network connections (described
below), a connection of type <code>network</code> may specify
a <code>virtportprofile</code> element, with configuration data
to be forwarded to a vepa or 802.1Qbh compliant switch.
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='network'&gt;
&lt;source network='default'/&gt;
&lt;/interface&gt;
...
&lt;interface type='network'&gt;
conf: support abstracted interface info in domain interface XML the domain XML <interface> element is updated in the following ways: 1) <virtualportprofile> can be specified when source type='network' (previously it was only valid for source type='direct') 2) A new attribute "portgroup" has been added to the <source> element. When source type='network' (the only time portgroup is recognized), extra configuration information will be taken from the <portgroup> element of the given name in the network definition. 3) Each virDomainNetDef now also potentially has a virDomainActualNetDef which is a private object (never exported/imported via the public API, and not defined in the RNG) that is used to maintain information about the physical device that was actually used for a NetDef of type VIR_DOMAIN_NET_TYPE_NETWORK. The virDomainActualNetDef will only be parsed/formatted if the parse/format function is called with the VIR_DOMAIN_XML_INTERNAL_ACTUAL_NET flag set (which is only needed when saving/loading a running domain's state info to the stateDir).
2011-06-26 08:09:00 +00:00
&lt;source network='default' portgroup='engineering'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;target dev='vnet7'/&gt;
Avoid using multicast addresses for Ethernet MAC examples * docs/formatdomain.html.in: use '00:11:22:33:44:55' instead of '11:22:33:44:55:66'
2010-04-09 12:38:12 +00:00
&lt;mac address="00:11:22:33:44:55"/&gt;
conf: support abstracted interface info in domain interface XML the domain XML <interface> element is updated in the following ways: 1) <virtualportprofile> can be specified when source type='network' (previously it was only valid for source type='direct') 2) A new attribute "portgroup" has been added to the <source> element. When source type='network' (the only time portgroup is recognized), extra configuration information will be taken from the <portgroup> element of the given name in the network definition. 3) Each virDomainNetDef now also potentially has a virDomainActualNetDef which is a private object (never exported/imported via the public API, and not defined in the RNG) that is used to maintain information about the physical device that was actually used for a NetDef of type VIR_DOMAIN_NET_TYPE_NETWORK. The virDomainActualNetDef will only be parsed/formatted if the parse/format function is called with the VIR_DOMAIN_XML_INTERNAL_ACTUAL_NET flag set (which is only needed when saving/loading a running domain's state info to the stateDir).
2011-06-26 08:09:00 +00:00
&lt;virtualport type='802.1Qbg'&gt;
&lt;parameters managerid='11' typeid='1193047' typeidversion='2' instanceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f'/&gt;
&lt;/virtualport&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Fix a number of small typos
2009-09-22 10:54:57 +00:00
<h5><a name="elementsNICSBridge">Bridge to LAN</a></h5>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
<strong><em>
This is the recommended config for general guest connectivity on
hosts with static wired networking configs
</em></strong>
</p>
<p>
Provides a bridge from the VM directly onto the LAN. This assumes
there is a bridge device on the host which has one or more of the hosts
physical NICs enslaved. The guest VM will have an associated tun device
created with a name of vnetN, which can also be overridden with the
Document overriding domain interface target * docs/formatdomain.html.in: document that vnet and vif are reserved names and will be ignored if manually specified.
2009-11-20 15:25:58 +00:00
&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.
Update domain XML docs
2008-05-08 14:20:07 +00:00
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='bridge'&gt;
&lt;source bridge='br0'/&gt;
&lt;/interface&gt;
...
&lt;interface type='bridge'&gt;
&lt;source bridge='br0'/&gt;
&lt;target dev='vnet7'/&gt;
Avoid using multicast addresses for Ethernet MAC examples * docs/formatdomain.html.in: use '00:11:22:33:44:55' instead of '11:22:33:44:55:66'
2010-04-09 12:38:12 +00:00
&lt;mac address="00:11:22:33:44:55"/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='user'/&gt;
...
&lt;interface type='user'&gt;
Avoid using multicast addresses for Ethernet MAC examples * docs/formatdomain.html.in: use '00:11:22:33:44:55' instead of '11:22:33:44:55:66'
2010-04-09 12:38:12 +00:00
&lt;mac address="00:11:22:33:44:55"/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<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>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Add descriptions for macvtap direct type interfaces This adds a description about the 'direct' type of interface recently added for macvtap device type support on the host.
2010-02-24 09:29:23 +00:00
<h5><a name="elementsNICSDirect">Direct attachment to physical interface</a></h5>
<p>
Provides direct attachment of the virtual machine's NIC to the given
Mention direct device support since 0.7.7 in docs In the documentation mention that the direct device support is there since libvirt 0.7.7. A Linux kernel 2.6.34 is required for macvtap to be available as standard device.
2010-03-26 15:53:32 +00:00
physial interface of the host.
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-01 22:02:10 +00:00
<span class="since">Since 0.7.7 (QEMU and KVM only)</span><br/>
Mention direct device support since 0.7.7 in docs In the documentation mention that the direct device support is there since libvirt 0.7.7. A Linux kernel 2.6.34 is required for macvtap to be available as standard device.
2010-03-26 15:53:32 +00:00
This setup requires the Linux macvtap
driver to be available. <span class="since">(Since Linux 2.6.34.)</span>
One of the modes 'vepa'
web docs -- macvtap mode explanation This adds more information about the different macvtap device modes, spells out VEPA and adds a link to a pdf at the ieee site.
2010-03-05 14:41:38 +00:00
( <a href="http://www.ieee802.org/1/files/public/docs2009/new-evb-congdon-vepa-modular-0709-v01.pdf">
docs: correct range of default NAT subnet * docs/formatdomain.html.in: Fix typo.
2011-03-08 23:15:47 +00:00
'Virtual Ethernet Port Aggregator'</a>), 'bridge' or 'private'
Add descriptions for macvtap direct type interfaces This adds a description about the 'direct' type of interface recently added for macvtap device type support on the host.
2010-02-24 09:29:23 +00:00
can be chosen for the operation mode of the macvtap device, 'vepa'
web docs -- macvtap mode explanation This adds more information about the different macvtap device modes, spells out VEPA and adds a link to a pdf at the ieee site.
2010-03-05 14:41:38 +00:00
being the default mode. The individual modes cause the delivery of
packets to behave as follows:
Add descriptions for macvtap direct type interfaces This adds a description about the 'direct' type of interface recently added for macvtap device type support on the host.
2010-02-24 09:29:23 +00:00
</p>
web docs -- macvtap mode explanation This adds more information about the different macvtap device modes, spells out VEPA and adds a link to a pdf at the ieee site.
2010-03-05 14:41:38 +00:00
<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,
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-01 22:02:10 +00:00
a VEPA capable bridge is required.</dd>
web docs -- macvtap mode explanation This adds more information about the different macvtap device modes, spells out VEPA and adds a link to a pdf at the ieee site.
2010-03-05 14:41:38 +00:00
<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>
Add support for 'passthru' mode for direct network interfaces starting with kernel 2.6.38 macvtap supports a 'passthru' mode for attaching virtual functions of a SRIOV capable network card directly to a VM. This patch adds the capability to configure such a device. Signed-off-by: Dirk Herrendoerfer <d.herrendoerfer@herrendoerfer.name>
2011-05-17 11:26:09 +00:00
<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>
web docs -- macvtap mode explanation This adds more information about the different macvtap device modes, spells out VEPA and adds a link to a pdf at the ieee site.
2010-03-05 14:41:38 +00:00
</dl>
Add descriptions for macvtap direct type interfaces This adds a description about the 'direct' type of interface recently added for macvtap device type support on the host.
2010-02-24 09:29:23 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='direct'/&gt;
...
&lt;interface type='direct'&gt;
&lt;source dev='eth0' mode='vepa'/&gt;
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
documenting the 802.1Qbg parameters of a 'direct' interface This patchs adds documentation about the 802.1Qbg related parameters of the virtualport element in a 'direct' interface definition. Signed-off-by: Gerhard Stenzel <gerhard.stenzel@de.ibm.com>
2011-03-11 09:47:57 +00:00
<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.
docs: fix missing </p> * docs/formatdomain.html.in: Fix typo in last patch. Reported by Matthias Bolte.
2011-03-11 17:08:24 +00:00
</p>
documenting the 802.1Qbg parameters of a 'direct' interface This patchs adds documentation about the 802.1Qbg related parameters of the virtualport element in a 'direct' interface definition. Signed-off-by: Gerhard Stenzel <gerhard.stenzel@de.ibm.com>
2011-03-11 09:47:57 +00:00
<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
documenting the 802.1Qbh parameters of a 'direct' interface This patch adds documentation about the 802.1Qbh related parameters of the virtualport element for 'direct' interfaces. Signed-off-by: David S. Wang <dwang2@cisco.com> Signed-off-by: Roopa Prabhu <roprabhu@cisco.com> Signed-off-by: Christian Benvenuti <benve@cisco.com> Signed-off-by: Vasanthy Kolluri <vkolluri@cisco.com>
2011-06-23 16:35:30 +00:00
of a virtual machine. <span class="since">Since 0.8.2</span>
documenting the 802.1Qbg parameters of a 'direct' interface This patchs adds documentation about the 802.1Qbg related parameters of the virtualport element in a 'direct' interface definition. Signed-off-by: Gerhard Stenzel <gerhard.stenzel@de.ibm.com>
2011-03-11 09:47:57 +00:00
</p>
fix missing VLAN id for Qbg example For IEEE 802.1Qbg, it is necessary to use a VLAN interface. vepa itself does not require a VLAN interface. Signed-off-by: Gerhard Stenzel <stenzel at de.ibm.com>
2011-05-02 14:49:03 +00:00
<p>
Please note that IEEE 802.1Qbg requires a non-zero value for the
VLAN ID.
</p>
documenting the 802.1Qbg parameters of a 'direct' interface This patchs adds documentation about the 802.1Qbg related parameters of the virtualport element in a 'direct' interface definition. Signed-off-by: Gerhard Stenzel <gerhard.stenzel@de.ibm.com>
2011-03-11 09:47:57 +00:00
<dl>
<dt><code>managerid</code></dt>
<dd>The VSI Manager ID identifies the database containing the VSI type
and instance definitions. This is an integer value and the
value 0 is reserved.</dd>
<dt><code>typeid</code></dt>
<dd>The VSI Type ID identifies a VSI type characterizing the network
access. VSI types are typically managed by network administrator.
This is an integer value.
</dd>
<dt><code>typeidversion</code></dt>
<dd>The VSI Type Version allows multiple versions of a VSI Type.
This is an integer value.
</dd>
<dt><code>instanceid</code></dt>
<dd>The VSI Instance ID Identifier is generated when a VSI instance
(i.e. a virtual interface of a virtual machine) is created.
This is a globally unique identifier.
</dd>
</dl>
<pre>
...
&lt;devices&gt;
&lt;interface type='direct'/&gt;
...
&lt;interface type='direct'&gt;
fix missing VLAN id for Qbg example For IEEE 802.1Qbg, it is necessary to use a VLAN interface. vepa itself does not require a VLAN interface. Signed-off-by: Gerhard Stenzel <stenzel at de.ibm.com>
2011-05-02 14:49:03 +00:00
&lt;source dev='eth0.2' mode='vepa'/&gt;
documenting the 802.1Qbg parameters of a 'direct' interface This patchs adds documentation about the 802.1Qbg related parameters of the virtualport element in a 'direct' interface definition. Signed-off-by: Gerhard Stenzel <gerhard.stenzel@de.ibm.com>
2011-03-11 09:47:57 +00:00
&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>
Add descriptions for macvtap direct type interfaces This adds a description about the 'direct' type of interface recently added for macvtap device type support on the host.
2010-02-24 09:29:23 +00:00
documenting the 802.1Qbh parameters of a 'direct' interface This patch adds documentation about the 802.1Qbh related parameters of the virtualport element for 'direct' interfaces. Signed-off-by: David S. Wang <dwang2@cisco.com> Signed-off-by: Roopa Prabhu <roprabhu@cisco.com> Signed-off-by: Christian Benvenuti <benve@cisco.com> Signed-off-by: Vasanthy Kolluri <vkolluri@cisco.com>
2011-06-23 16:35:30 +00:00
<p>
The interface can have additional parameters as shown below
if the switch is conforming to the IEEE 802.1Qbh standard.
The values are network specific and should be provided by the
network administrator. <span class="since">Since 0.8.2</span>
</p>
<dl>
<dt><code>profileid</code></dt>
<dd>The profile ID contains the name of the port profile that is to
be applied onto this interface. This name is resolved by the port
profile database into the network parameters from the port profile,
and those network parameters will be applied to this interface.
</dd>
</dl>
<pre>
...
&lt;devices&gt;
&lt;interface type='direct'/&gt;
...
&lt;interface type='direct'&gt;
&lt;source dev='eth0' mode='private'/&gt;
&lt;virtualport type='802.1Qbh'&gt;
&lt;parameters profileid='finance'/&gt;
&lt;/virtualport&gt;
&lt;/interface&gt;
&lt;/devices&gt;
...
</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='mcast'&gt;
&lt;source address='230.0.0.1' port='5558'/&gt;
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;interface type='server'&gt;
Update domain XML docs
2008-05-08 14:20:07 +00:00
&lt;source address='192.168.0.1' port='5558'/&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/interface&gt;
...
&lt;interface type='client'&gt;
&lt;source address='192.168.0.1' port='5558'/&gt;
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Documentation for NIC model selection. * docs/formatdomain.html.in, docs/formatdomain.html: Add the documentation for NIC model selection.
2008-10-13 15:25:38 +00:00
<h5><a name="elementsNICSModel">Setting the NIC model</a></h5>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<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>
Documentation for NIC model selection. * docs/formatdomain.html.in, docs/formatdomain.html: Add the documentation for NIC model selection.
2008-10-13 15:25:38 +00:00
<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>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that 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 fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) 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 cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
<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;
qemu: support event_idx parameter for virtio disk and net devices In some versions of qemu, both virtio-blk-pci and virtio-net-pci devices can have an event_idx setting that determines some details of event processing. When it is enabled, it "reduces the number of interrupts and exits for the guest". qemu will automatically enable this feature when it is available, but there may be cases where this new feature could actually make performance worse (NB: no such case has been found so far). As a safety switch in case such a situation is encountered in the field, this patch adds a new attribute "event_idx" to the <driver> element of both disk and interface devices. event_idx can be set to "on" (to force event_idx on in case qemu has it disabled by default) or "off" (for force event_idx off). In the case that event_idx support isn't present in qemu, the attribute is ignored (this on the advice of the qemu developer). docs/formatdomain.html.in: document the new flag (marking it as "don't mess with this!" docs/schemas/domain.rng: add event_idx in appropriate places src/conf/domain_conf.[ch]: add event_idx to parser and formatter src/libvirt_private.syms: export virDomainVirtioEventIdx(From|To)String src/qemu/qemu_capabilities.[ch]: detect and report event_idx in disk/net src/qemu/qemu_command.c: add event_idx parameter to qemu commandline when appropriate. tests/qemuxml2argvdata/qemuxml2argv-event_idx.args, tests/qemuxml2argvdata/qemuxml2argv-event_idx.xml, tests/qemuxml2argvtest.c, tests/qemuxml2xmltest.c: test cases for event_idx.
2011-08-13 06:32:45 +00:00
<b>&lt;driver name='vhost' txmode='iothread' ioeventfd='on' event_idx='off'/&gt;</b>
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that 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 fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) 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 cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
&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>
docs: document <driver name='vhost'/> for interfaces * docs/formatdomain.html.in: Document virtio backend selection.
2011-03-08 23:35:17 +00:00
<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>
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that 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 fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) 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 cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
<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'.
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-01 22:02:10 +00:00
<span class="since">Since 0.8.8 (QEMU and KVM only)</span><br/><br/>
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that 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 fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) 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 cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
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
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-01 22:02:10 +00:00
option).<br/><br/>
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that 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 fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) 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 cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
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
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-01 22:02:10 +00:00
fires, another attempt is made to send more data.<br/><br/>
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that 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 fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) 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 cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
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
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-01 22:02:10 +00:00
cpu where the guest generated the packets."<br/><br/>
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that 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 fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) 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 cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
qemu: domain I/O asynchronous handling For virtio disks and interfaces, qemu allows users to enable or disable ioeventfd feature. This means, qemu can execute domain code, while another thread waits for I/O event. Basically, in some cases it is win, in some loss. This feature is available via 'ioeventfd' attribute in disk and interface <driver> element. It accepts 'on' and 'off'. Leaving this attribute out defaults to hypervisor decision.
2011-06-20 08:26:47 +00:00
<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/>
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that 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 fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) 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 cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
<b>In general you should leave this option alone, unless you
qemu: support event_idx parameter for virtio disk and net devices In some versions of qemu, both virtio-blk-pci and virtio-net-pci devices can have an event_idx setting that determines some details of event processing. When it is enabled, it "reduces the number of interrupts and exits for the guest". qemu will automatically enable this feature when it is available, but there may be cases where this new feature could actually make performance worse (NB: no such case has been found so far). As a safety switch in case such a situation is encountered in the field, this patch adds a new attribute "event_idx" to the <driver> element of both disk and interface devices. event_idx can be set to "on" (to force event_idx on in case qemu has it disabled by default) or "off" (for force event_idx off). In the case that event_idx support isn't present in qemu, the attribute is ignored (this on the advice of the qemu developer). docs/formatdomain.html.in: document the new flag (marking it as "don't mess with this!" docs/schemas/domain.rng: add event_idx in appropriate places src/conf/domain_conf.[ch]: add event_idx to parser and formatter src/libvirt_private.syms: export virDomainVirtioEventIdx(From|To)String src/qemu/qemu_capabilities.[ch]: detect and report event_idx in disk/net src/qemu/qemu_command.c: add event_idx parameter to qemu commandline when appropriate. tests/qemuxml2argvdata/qemuxml2argv-event_idx.args, tests/qemuxml2argvdata/qemuxml2argv-event_idx.xml, tests/qemuxml2argvtest.c, tests/qemuxml2xmltest.c: test cases for event_idx.
2011-08-13 06:32:45 +00:00
are very certain you know what you are doing.</b>
</dd>
<dt><code>event_idx</code></dt>
<dd>
The <code>event_idx</code> attribute controls some aspects of
device event processing. The value can be either 'on' or 'off'
- if it is on, it will reduce the number of interupts and
exits for the guest. The default is determined by QEMU;
usually if the feature is supported, default is on. In case
there is a situation where this behavior is suboptimal, this
attribute provides a way to force the feature off.
<span class="since">Since 0.9.5 (QEMU and KVM only)</span><br/><br/>
<b>In general you should leave this option alone, unless you
Add txmode attribute to interface XML for virtio backend This is in response to: https://bugzilla.redhat.com/show_bug.cgi?id=629662 Explanation qemu's virtio-net-pci driver allows setting the algorithm used for tx packets to either "bh" or "timer". This is done by adding ",tx=bh" or ",tx=timer" to the "-device virtio-net-pci" commandline option. 'bh' stands for 'bottom half'; when this is set, packet tx is all done in an iothread in the bottom half of the driver. (In libvirt, this option is called the more descriptive "iothread".) 'timer' means that 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 fires, another attempt is made to send more data. (libvirt retains the name "timer" for this option.) 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 cpu where the guest generated the packets. Solution This patch provides a libvirt domain xml knob to change the option on the qemu commandline, by adding a new attribute "txmode" to the <driver> element that can be placed inside any <interface> element in a domain definition. It's use would be something like this: <interface ...> ... <model type='virtio'/> <driver txmode='iothread'/> ... </interface> I chose to put this setting as an attribute to <driver> rather than as a sub-element to <tune> because it is specific to the virtio-net driver, not something that is generally usable by all network drivers. (note that this is the same placement as the "driver name=..." attribute used to choose kernel vs. userland backend for the virtio-net driver.) Actually adding the tx=xxx option to the qemu commandline is only done if the version of qemu being used advertises it in the output of qemu -device virtio-net-pci,? If a particular txmode is requested in the XML, and the option isn't listed in that help output, an UNSUPPORTED_CONFIG error is logged, and the domain fails to start.
2011-02-03 20:20:01 +00:00
are very certain you know what you are doing.</b>
</dd>
</dl>
Document overriding domain interface target * docs/formatdomain.html.in: document that vnet and vif are reserved names and will be ignored if manually specified.
2009-11-20 15:25:58 +00:00
<h5><a name="elementsNICSTargetOverride">Overriding the target element</a></h5>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<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>
Document overriding domain interface target * docs/formatdomain.html.in: document that vnet and vif are reserved names and will be ignored if manually specified.
2009-11-20 15:25:58 +00:00
<p>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
If no target is specified, certain hypervisors will
automatically generate a name for the created tun device. This
name can be manually specifed, however the name <i>must not
start with either 'vnet' or 'vif'</i>, which are prefixes
reserved by libvirt and certain hypervisors. Manually specified
targets using these prefixes will be ignored.
Document overriding domain interface target * docs/formatdomain.html.in: document that vnet and vif are reserved names and will be ignored if manually specified.
2009-11-20 15:25:58 +00:00
</p>
Introduce per-device boot element Currently, boot order can be specified per device class but there is no way to specify exact disk/NIC device to boot from. This patch adds <boot order='N'/> element which can be used inside <disk/> and <interface/>. This is incompatible with the older os/boot element. Since not all hypervisors support per-device boot specification, new deviceboot flag is included in capabilities XML for hypervisors which understand the new boot element. Presence of the flag allows (but doesn't require) users to use the new style boot order specification.
2011-01-12 14:19:34 +00:00
<h5><a name="elementsNICSBoot">Specifying boot order</a></h5>
<pre>
...
&lt;devices&gt;
&lt;interface type='network'&gt;
&lt;source network='default'/&gt;
&lt;target dev='vnet1'/&gt;
<b>&lt;boot order='1'/&gt;</b>
&lt;/interface&gt;
&lt;/devices&gt;
...</pre>
<p>
For hypervisors which support this, you can set exact NIC which should
be used for network boot. The <code>order</code> attribute determines
the order in which devices will be tried during boot sequence. The
per-device <code>boot</code> elements cannot be used together with
general boot elements in
<a href="#elementsOSBIOS">BIOS bootloader</a> section.
<span class="since">Since 0.8.8</span>
</p>
bandwidth: Define schema and create documentation Define new 'bandwidth' element with possible child element 'inbound' and 'outbound' addressing incoming and outgoing traffic respectively: <bandwidth> <inbound average='1000' peak='2000' burst='5120'/> <outbound average='500'/> </bandwidth> Leaving any element out means not to shape traffic in that direction. The units for average and peak (rate) are in kilobytes per second, for burst (size) are just in kilobytes. This element can be inserted into domain's 'interface' and 'network'.
2011-07-22 14:07:23 +00:00
<h5><a name="elementQoS">Quality of service</a></h5>
<pre>
...
&lt;devices&gt;
&lt;interface type='network'&gt;
&lt;source network='default'/&gt;
&lt;target dev='vnet0'/&gt;
<b>&lt;bandwidth&gt;
&lt;inbound average='1000' peak='5000' burst='1024'/&gt;
&lt;outbound average='128' peak='256' burst='256'/&gt;
&lt;/bandwidth&gt;</b>
&lt;/interface&gt;
&lt;devices&gt;
...</pre>
<p>
This part of interface XML provides setting quality of service. Incoming
and outgoing traffic can be shaped independently. The
<code>bandwidth</code> element can have at most one <code>inbound</code>
and at most one <code>outbound</code> child elements. Leaving any of these
children element out result in no QoS applied on that traffic direction.
So, when you want to shape only domain's incoming traffic, use
<code>inbound</code> only, and vice versa. Each of these elements have one
mandatory attribute <code>average</code>. It specifies average bit rate on
interface being shaped. Then there are two optional attributes:
<code>peak</code>, which specifies maximum rate at which interface can send
data, and <code>burst</code>, amount of bytes that can be burst at
<code>peak</code> speed. Accepted values for attributes are integer
numbers. The units for <code>average</code> and <code>peak</code> attributes
are kilobytes per second, and for the <code>burst</code> just kilobytes.
<span class="since">Since 0.9.4</span>
</p>
link-state: conf: Add element to XML for controling link state A new element is introduced to XML that allows to control state of virtual network interfaces in hypervisors. Live modification of the link state allows networking tools propagate topology changes to guest OS or testing of scenarios in complex (virtual) networks. This patch adds elements to XML grammars and parsing and generating code.
2011-09-06 08:08:15 +00:00
<h5><a name="elementLink">Modyfing virtual link state</a></h5>
<pre>
...
&lt;devices&gt;
&lt;interface type='network'&gt;
&lt;source network='default'/&gt;
&lt;target dev='vnet0'/&gt;
<b>&lt;link state='down'/&gt;</b>
&lt;/interface&gt;
&lt;devices&gt;
...</pre>
<p>
This element provides means of setting state of the virtual network link.
Possible values for attribute <code>state</code> are <code>up</code> and
<code>down</code>. If <code>down</code> is specified as the value, the interface
behaves as if it had the network cable disconnected. Default behavior if this
element is unspecified is to have the link state <code>up</code>.
<span class="since">Since 0.9.5</span>
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h4><a name="elementsInput">Input devices</a></h4>
<p>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
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,
Update domain XML docs
2008-05-08 14:20:07 +00:00
to provide a graphics tablet for absolute cursor movement.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;input type='mouse' bus='usb'/&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>input</code></dt>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
<dd>The <code>input</code> element has one mandatory attribute,
the <code>type</code> whose value can be either 'mouse' or
'tablet'. The latter provides absolute
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
cursor movement, while the former uses relative movement. The optional
<code>bus</code> attribute can be used to refine the exact device type.
It takes values "xen" (paravirtualized), "ps2" and "usb".</dd>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<p>
The <code>input</code> element has an optional
sub-element <code>&lt;address&gt;</code> which can tie the
device to a particular PCI slot.
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Add USB hub device domain parsing and serialization code, qemu driver backend and a couple of test
2011-09-02 14:20:40 +00:00
<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
sub-element <code>&lt;address&gt;</code> which can tie the
device to a particular controller.
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;graphics type='sdl' display=':0.0'/&gt;
conf: add <listen> subelement to domain <graphics> element Once it's plugged in, the <listen> element will be an optional replacement for the "listen" attribute that graphics elements already have. If the <listen> element is type='address', it will have an attribute called 'address' which will contain an IP address or dns name that the guest's display server should listen on. If, however, type='network', the <listen> element should have an attribute called 'network' that will be set to the name of a network configuration to get the IP address from. * docs/schemas/domain.rng: updated to allow the <listen> element * docs/formatdomain.html.in: document the <listen> element and its attributes. * src/conf/domain_conf.[hc]: 1) The domain parser, formatter, and data structure are modified to support 0 or more <listen> subelements to each <graphics> element. The old style "legacy" listen attribute is also still accepted, and will be stored internally just as if it were a separate <listen> element. On output (i.e. format), the address attribute of the first <listen> element of type 'address' will be duplicated in the legacy "listen" attribute of the <graphic> element. 2) The "listenAddr" attribute has been removed from the unions in virDomainGRaphicsDef for graphics types vnc, rdp, and spice. This attribute is now in the <listen> subelement (aka virDomainGraphicsListenDef) 3) Helper functions were written to provide simple access (both Get and Set) to the listen elements and their attributes. * src/libvirt_private.syms: export the listen helper functions * src/qemu/qemu_command.c, src/qemu/qemu_hotplug.c, src/qemu/qemu_migration.c, src/vbox/vbox_tmpl.c, src/vmx/vmx.c, src/xenxs/xen_sxpr.c, src/xenxs/xen_xm.c Modify all these files to use the listen helper functions rather than directly referencing the (now missing) listenAddr attribute. There can be multiple <listen> elements to a single <graphics>, but the drivers all currently only support one, so all replacements of direct access with a helper function indicate index "0". * tests/* - only 3 of these are new files added explicitly to test the new <listen> element. All the others have been modified to reflect the fact that any legacy "listen" attributes passed in to the domain parse will be saved in a <listen> element (i.e. one of the virDomainGraphicsListenDefs), and during the domain format function, both the <listen> element as well as the legacy attributes will be output.
2011-07-07 04:20:28 +00:00
&lt;graphics type='vnc' port='5904'&gt;
&lt;listen type='address' address='1.2.3.4'/&gt;
&lt;/graphics&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;graphics type='rdp' autoport='yes' multiUser='yes' /&gt;
&lt;graphics type='desktop' fullscreen='yes'/&gt;
conf: add <listen> subelement to domain <graphics> element Once it's plugged in, the <listen> element will be an optional replacement for the "listen" attribute that graphics elements already have. If the <listen> element is type='address', it will have an attribute called 'address' which will contain an IP address or dns name that the guest's display server should listen on. If, however, type='network', the <listen> element should have an attribute called 'network' that will be set to the name of a network configuration to get the IP address from. * docs/schemas/domain.rng: updated to allow the <listen> element * docs/formatdomain.html.in: document the <listen> element and its attributes. * src/conf/domain_conf.[hc]: 1) The domain parser, formatter, and data structure are modified to support 0 or more <listen> subelements to each <graphics> element. The old style "legacy" listen attribute is also still accepted, and will be stored internally just as if it were a separate <listen> element. On output (i.e. format), the address attribute of the first <listen> element of type 'address' will be duplicated in the legacy "listen" attribute of the <graphic> element. 2) The "listenAddr" attribute has been removed from the unions in virDomainGRaphicsDef for graphics types vnc, rdp, and spice. This attribute is now in the <listen> subelement (aka virDomainGraphicsListenDef) 3) Helper functions were written to provide simple access (both Get and Set) to the listen elements and their attributes. * src/libvirt_private.syms: export the listen helper functions * src/qemu/qemu_command.c, src/qemu/qemu_hotplug.c, src/qemu/qemu_migration.c, src/vbox/vbox_tmpl.c, src/vmx/vmx.c, src/xenxs/xen_sxpr.c, src/xenxs/xen_xm.c Modify all these files to use the listen helper functions rather than directly referencing the (now missing) listenAddr attribute. There can be multiple <listen> elements to a single <graphics>, but the drivers all currently only support one, so all replacements of direct access with a helper function indicate index "0". * tests/* - only 3 of these are new files added explicitly to test the new <listen> element. All the others have been modified to reflect the fact that any legacy "listen" attributes passed in to the domain parse will be saved in a <listen> element (i.e. one of the virDomainGraphicsListenDefs), and during the domain format function, both the <listen> element as well as the legacy attributes will be output.
2011-07-07 04:20:28 +00:00
&lt;graphics type='spice'&gt;
&lt;listen type='network' network='rednet'/&gt;
&lt;/graphics&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<dl>
<dt><code>graphics</code></dt>
<dd>The <code>graphics</code> element has a mandatory <code>type</code>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
attribute which takes the value "sdl", "vnc", "rdp" or "desktop":
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
<dl>
<dt><code>"sdl"</code></dt>
<dd>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
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'.
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
</dd>
<dt><code>"vnc"</code></dt>
<dd>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
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>
graphics: add support for action_if_connected in qemu This option accepts 3 values: -keep, to keep current client connected (Spice+VNC) -disconnect, to disconnect client (Spice) -fail, to fail setting password if there is a client connected (Spice)
2011-05-26 14:15:54 +00:00
assumed to be in UTC. The <code>connected</code> attribute
allows control of connected client during password changes.
VNC accepts <code>keep</code> value only.
<span class="since">since 0.9.3</span>
NB, this may not be supported by all hypervisors.<br/> <br/>
Rather than using listen/port, QEMU supports a
<code>socket</code> attribute for listening on a unix
domain socket path.<span class="since">Since 0.8.8</span>
Add a <graphics> type for SPICE protocol This adds an element <graphics type='spice' port='5903' tlsPort='5904' autoport='yes' listen='127.0.0.1'/> This is the bare minimum that should be exposed in the guest config for SPICE. Other parameters are better handled as per host level configuration tunables * docs/schemas/domain.rng: Define the SPICE <graphics> schema * src/domain_conf.h, src/domain_conf.c: Add parsing and formatting for SPICE graphics config * src/qemu_conf.c: Complain about unsupported graphics types
2009-08-14 09:54:14 +00:00
</dd>
<dt><code>"spice"</code></dt>
<dd>
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
<p>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
Starts a SPICE server. The <code>port</code> attribute
specifies the TCP port number (with -1 as legacy syntax
indicating that it should be auto-allocated),
while <code>tlsPort</code> gives an alternative secure
port number. The <code>autoport</code> attribute is the
new preferred syntax for indicating autoallocation of
both port numbers. The <code>listen</code> attribute is
an IP address for the server to listen
on. The <code>passwd</code> attribute provides a SPICE
password in clear text. The <code>keymap</code>
attribute specifies the keymap to use. It is possible to
set a limit on the validity of the password be giving an
timestamp <code>passwdValidTo='2010-04-09T15:51:00'</code>
graphics: add support for action_if_connected in qemu This option accepts 3 values: -keep, to keep current client connected (Spice+VNC) -disconnect, to disconnect client (Spice) -fail, to fail setting password if there is a client connected (Spice)
2011-05-26 14:15:54 +00:00
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>.
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
</p>
<p>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
When SPICE has both a normal and TLS secured TCP port
configured, it can be desirable to restrict what
channels can be run on each port. This is achieved by
adding one or more &lt;channel&gt; elements inside the
main &lt;graphics&gt; element. Valid channel names
include <code>main</code>, <code>display</code>,
<code>inputs</code>, <code>cursor</code>,
<code>playback</code>, <code>record</code>;
and <span class="since">since
0.8.8</span>: <code>smartcard</code>.
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
</p>
<pre>
Support SPICE channel security options This extends the SPICE XML to allow channel security options <graphics type='spice' port='-1' tlsPort='-1' autoport='yes'> <channel name='main' mode='secure'/> <channel name='record' mode='insecure'/> </graphics> Any non-specified channel uses the default, which allows both secure & insecure usage * src/conf/domain_conf.c, src/conf/domain_conf.h, src/libvirt_private.syms: Add XML syntax for specifying per channel security options for spice. * src/qemu/qemu_conf.c: Configure channel security with spice
2010-04-09 16:56:00 +00:00
&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;
Spice: support audio, images and stream compression This extends the SPICE XML to allow variable compression settings for audio, images and streaming: <graphics type='spice' port='5901' tlsPort='-1' autoport='yes'> <image compression='auto_glz'/> <jpeg compression='auto'/> <zlib compression='auto'/> <playback compression='on'/> </graphics> All new elements are optional.
2011-04-14 08:44:20 +00:00
&lt;image compression='auto_glz'/&gt;
spice: support streaming-video parameter This adds a streaming-video=filter|all|off attribute. It is used to change the behavior of video stream detection in spice, the default is filter (the default for libvirt is not to specify it - the actual default is defined in libspice-server.so). Usage: <graphics type='spice' autoport='yes'> <streaming mode='off'/> </graphics> Tested with the above and with tests/qemuxml2argvtest. Signed-off-by: Alon Levy <alevy@redhat.com>
2011-05-23 15:16:42 +00:00
&lt;streaming mode='filter'/&gt;
spice: add <clipboard copypaste='yes|no'> option From a security pov copy and paste between the guest and the client is not always desirable. So we need to be able to enable/disable this. The best place to do this from an administration pov is on the hypervisor, so the qemu cmdline is getting a spice disable-copy-paste option, see bug 693645. Example qemu invocation: qemu -spice port=5932,disable-ticketing,disable-copy-paste https://bugzilla.redhat.com/show_bug.cgi?id=693661
2011-06-14 11:35:48 +00:00
&lt;clipboard copypaste='no'/&gt;
Support SPICE channel security options This extends the SPICE XML to allow channel security options <graphics type='spice' port='-1' tlsPort='-1' autoport='yes'> <channel name='main' mode='secure'/> <channel name='record' mode='insecure'/> </graphics> Any non-specified channel uses the default, which allows both secure & insecure usage * src/conf/domain_conf.c, src/conf/domain_conf.h, src/libvirt_private.syms: Add XML syntax for specifying per channel security options for spice. * src/qemu/qemu_conf.c: Configure channel security with spice
2010-04-09 16:56:00 +00:00
&lt;/graphics&gt;</pre>
Spice: support audio, images and stream compression This extends the SPICE XML to allow variable compression settings for audio, images and streaming: <graphics type='spice' port='5901' tlsPort='-1' autoport='yes'> <image compression='auto_glz'/> <jpeg compression='auto'/> <zlib compression='auto'/> <playback compression='on'/> </graphics> All new elements are optional.
2011-04-14 08:44:20 +00:00
<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>
spice: support streaming-video parameter This adds a streaming-video=filter|all|off attribute. It is used to change the behavior of video stream detection in spice, the default is filter (the default for libvirt is not to specify it - the actual default is defined in libspice-server.so). Usage: <graphics type='spice' autoport='yes'> <streaming mode='off'/> </graphics> Tested with the above and with tests/qemuxml2argvtest. Signed-off-by: Alon Levy <alevy@redhat.com>
2011-05-23 15:16:42 +00:00
<p>
Streaming mode is set by the <code>streaming</code>
element, settings it's <code>mode</code> attribute to one
of <code>filter</code>, <code>all</code>
or <code>off</code>, <span class="since">since 0.9.2</span>.
</p>
spice: add <clipboard copypaste='yes|no'> option From a security pov copy and paste between the guest and the client is not always desirable. So we need to be able to enable/disable this. The best place to do this from an administration pov is on the hypervisor, so the qemu cmdline is getting a spice disable-copy-paste option, see bug 693645. Example qemu invocation: qemu -spice port=5932,disable-ticketing,disable-copy-paste https://bugzilla.redhat.com/show_bug.cgi?id=693661
2011-06-14 11:35:48 +00:00
<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>.
docs: Fix spice documentation typo We missed ending tag for paragraph element
2011-07-18 09:28:54 +00:00
</p>
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
</dd>
<dt><code>"rdp"</code></dt>
<dd>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
Starts a RDP server. The <code>port</code> attribute
specifies the TCP port number (with -1 as legacy syntax
indicating that it should be
auto-allocated). The <code>autoport</code> attribute is
the new preferred syntax for indicating autoallocation of
the TCP port to use. The <code>replaceUser</code>
attribute is a boolean deciding whether multiple
simultaneous connections to the VM are permitted.
The <code>multiUser</code> whether the existing connection
must be dropped and a new connection must be established
by the VRDP server, when a new client connects in single
connection mode.
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
</dd>
<dt><code>"desktop"</code></dt>
<dd>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
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>.
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
</dd>
</dl>
</dd>
</dl>
conf: add <listen> subelement to domain <graphics> element Once it's plugged in, the <listen> element will be an optional replacement for the "listen" attribute that graphics elements already have. If the <listen> element is type='address', it will have an attribute called 'address' which will contain an IP address or dns name that the guest's display server should listen on. If, however, type='network', the <listen> element should have an attribute called 'network' that will be set to the name of a network configuration to get the IP address from. * docs/schemas/domain.rng: updated to allow the <listen> element * docs/formatdomain.html.in: document the <listen> element and its attributes. * src/conf/domain_conf.[hc]: 1) The domain parser, formatter, and data structure are modified to support 0 or more <listen> subelements to each <graphics> element. The old style "legacy" listen attribute is also still accepted, and will be stored internally just as if it were a separate <listen> element. On output (i.e. format), the address attribute of the first <listen> element of type 'address' will be duplicated in the legacy "listen" attribute of the <graphic> element. 2) The "listenAddr" attribute has been removed from the unions in virDomainGRaphicsDef for graphics types vnc, rdp, and spice. This attribute is now in the <listen> subelement (aka virDomainGraphicsListenDef) 3) Helper functions were written to provide simple access (both Get and Set) to the listen elements and their attributes. * src/libvirt_private.syms: export the listen helper functions * src/qemu/qemu_command.c, src/qemu/qemu_hotplug.c, src/qemu/qemu_migration.c, src/vbox/vbox_tmpl.c, src/vmx/vmx.c, src/xenxs/xen_sxpr.c, src/xenxs/xen_xm.c Modify all these files to use the listen helper functions rather than directly referencing the (now missing) listenAddr attribute. There can be multiple <listen> elements to a single <graphics>, but the drivers all currently only support one, so all replacements of direct access with a helper function indicate index "0". * tests/* - only 3 of these are new files added explicitly to test the new <listen> element. All the others have been modified to reflect the fact that any legacy "listen" attributes passed in to the domain parse will be saved in a <listen> element (i.e. one of the virDomainGraphicsListenDefs), and during the domain format function, both the <listen> element as well as the legacy attributes will be output.
2011-07-07 04:20:28 +00:00
<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>
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
<h4><a name="elementsVideo">Video devices</a></h4>
<p>
A video device.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;video&gt;
&lt;model type='vga' vram='8192' heads='1'&gt;
&lt;acceleration accel3d='yes' accel3d='yes'/&gt;
&lt;/model&gt;
&lt;/video&gt;
&lt;/devices&gt;
...</pre>
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
<dl>
<dt><code>video</code></dt>
Fix and improve domain xml video element description The description mismatched the actual structure since the video element was introduced. The nvram attribute is actually called vram. Specify the unit of the vram attribute.
2009-12-13 17:25:17 +00:00
<dd>
The <code>video</code> element is the a container for describing
docs: Add doc for video element For backwards compatibility, if no <video> is set but there is a <graphics> tag, then we add a default <video> according to the guest type. Add docs to tell the user about this to not make them confused. Especially if they remove the video (such as via "virsh edit"), it will be surprised for them to see the video element is still in domain XML.
2011-06-07 08:56:06 +00:00
video devices. For backwards compatability, if no <code>video</code>
is set but there is a <code>graphics</code> in domain xml, then libvirt
will add a default <code>video</code> according to the guest type.
For a guest of type "kvm", the default <code>video</code> for it is:
<code>type</code> with value "cirrus", <code>vram</code> with value
"9216", and <code>heads</code> with value "1".
Fix and improve domain xml video element description The description mismatched the actual structure since the video element was introduced. The nvram attribute is actually called vram. Specify the unit of the vram attribute.
2009-12-13 17:25:17 +00:00
</dd>
add doc for graphic and video elements * docs/formatdomain.html.in: explain the new syntax of the video and graphic elements in the domain XML
2009-09-22 08:32:14 +00:00
Fix and improve domain xml video element description The description mismatched the actual structure since the video element was introduced. The nvram attribute is actually called vram. Specify the unit of the vram attribute.
2009-12-13 17:25:17 +00:00
<dt><code>model</code></dt>
<dd>
The <code>model</code> element has a mandatory <code>type</code>
docs: Document first release with spice and qxl
2011-03-17 16:04:35 +00:00
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.
Fix and improve domain xml video element description The description mismatched the actual structure since the video element was introduced. The nvram attribute is actually called vram. Specify the unit of the vram attribute.
2009-12-13 17:25:17 +00:00
You can also provide the amount of video memory in kilobytes using
<code>vram</code> and the number of screen with <code>heads</code>.
</dd>
<dt><code>acceleration</code></dt>
<dd>
If acceleration should be enabled (if supported) using the
<code>accel3d</code> and <code>accel2d</code> attributes in the
<code>acceleration</code> element.
</dd>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<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>
Update domain XML docs
2008-05-08 14:20:07 +00:00
</dl>
Add documentation for <channel> domain element * src/formatdomain.html.in: Add <channel> element documentation
2009-11-09 14:38:20 +00:00
<h4><a name="elementsConsole">Consoles, serial, parallel &amp; channel devices</a></h4>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
A character device provides a way to interact with the virtual machine.
Add documentation for <channel> domain element * src/formatdomain.html.in: Add <channel> element documentation
2009-11-09 14:38:20 +00:00
Paravirtualized consoles, serial ports, parallel ports and channels are
all classed as character devices and so represented using the same syntax.
Update domain XML docs
2008-05-08 14:20:07 +00:00
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;parallel type='pty'&gt;
&lt;source path='/dev/pts/2'/&gt;
&lt;target port='0'/&gt;
&lt;/parallel&gt;
&lt;serial type='pty'&gt;
&lt;source path='/dev/pts/3'/&gt;
&lt;target port='0'/&gt;
&lt;/serial&gt;
&lt;console type='pty'&gt;
&lt;source path='/dev/pts/4'/&gt;
&lt;target port='0'/&gt;
&lt;/console&gt;
&lt;channel type='unix'&gt;
&lt;source mode='bind' path='/tmp/guestfwd'/&gt;
&lt;target type='guestfwd' address='10.0.2.1' port='4600'/&gt;
&lt;/channel&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<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>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<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>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<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>
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<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>
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<p>
<code>target</code> can have a <code>port</code> attribute, which
docs: Serial and parallel device target ports actually start from 0 Reported by Igor Galić
2011-04-10 13:03:42 +00:00
specifies the port number. Ports are numbered starting from 0. There are
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
usually 0, 1 or 2 parallel ports.
</p>
<h6><a name="elementCharSerial">Serial port</a></h6>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<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>
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<p>
<code>target</code> can have a <code>port</code> attribute, which
docs: Serial and parallel device target ports actually start from 0 Reported by Igor Galić
2011-04-10 13:03:42 +00:00
specifies the port number. Ports are numbered starting from 0. There are
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
usually 0, 1 or 2 serial ports.
</p>
<h6><a name="elementCharConsole">Console</a></h6>
<p>
Allow multiple consoles per virtual guest While Xen only has a single paravirt console, UML, and QEMU both support multiple paravirt consoles. The LXC driver can also be trivially made to support multiple consoles. This patch extends the XML to allow multiple <console> elements in the XML. It also makes the UML and QEMU drivers support this config. * src/conf/domain_conf.c, src/conf/domain_conf.h: Allow multiple <console> devices * src/lxc/lxc_driver.c, src/xen/xen_driver.c, src/xenxs/xen_sxpr.c, src/xenxs/xen_xm.c: Update for internal API changes * src/security/security_selinux.c, src/security/virt-aa-helper.c: Only label consoles that aren't a copy of the serial device * src/qemu/qemu_command.c, src/qemu/qemu_driver.c, src/qemu/qemu_process.c, src/uml/uml_conf.c, src/uml/uml_driver.c: Support multiple console devices * tests/qemuxml2xmltest.c, tests/qemuxml2argvtest.c: Extra tests for multiple virtio consoles. Set QEMU_CAPS_CHARDEV for all console /channel tests * tests/qemuxml2argvdata/qemuxml2argv-channel-virtio-auto.args, tests/qemuxml2argvdata/qemuxml2argv-channel-virtio.args tests/qemuxml2argvdata/qemuxml2argv-console-virtio.args: Update for correct chardev syntax * tests/qemuxml2argvdata/qemuxml2argv-console-virtio-many.args, tests/qemuxml2argvdata/qemuxml2argv-console-virtio-many.xml: New test file
2011-02-23 18:27:23 +00:00
The console element is used to represent interactive consoles. Depending
on the type of guest in use, the consoles might be paravirtualized devices,
or they might be a clone of a serial device, according to the following
rules:
</p>
<ul>
<li>If no <code>targetType</code> attribue is set, then the default
device type is according to the hypervisor's rules. The default
type will be added when re-querying the XML fed into libvirt.
For fully virtualized guests, the default device type will usually
be a serial port.</li>
<li>If the <code>targetType</code> attribute is <code>serial</code>,
then if no <code>&lt;serial&gt;</code> element exists, the console
element will be copied to the serial element. If a <code>&lt;serial&gt;</code>
element does already exist, the console element will be ignored.</li>
<li>If the <code>targetType</code> attribute is not <code>serial</code>,
it will be treated normally.</li>
<li>Only the first <code>console</code> element may use a <code>targetType</code>
of <code>serial</code>. Secondary consoles must all be paravirtualized.
</li>
</ul>
qemu: virtio console support Enable specifying a virtio console device with: <console type='pty'> <target type='virtio'/> </console>
2010-07-14 17:02:04 +00:00
<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>
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;console type='pty'&gt;
&lt;source path='/dev/pts/4'/&gt;
&lt;target port='0'/&gt;
&lt;/console&gt;
qemu: virtio console support Enable specifying a virtio console device with: <console type='pty'> <target type='virtio'/> </console>
2010-07-14 17:02:04 +00:00
&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;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/devices&gt;
...</pre>
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<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>
Add documentation for <channel> domain element * src/formatdomain.html.in: Add <channel> element documentation
2009-11-09 14:38:20 +00:00
<h6><a name="elementCharChannel">Channel</a></h6>
<p>
This represents a private communication channel between the host and the
guest.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<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;
docs: domain: Document virtio <channel> Signed-off-by: Cole Robinson <crobinso@redhat.com>
2010-07-14 19:07:59 +00:00
&lt;!-- KVM virtio channel --&gt;
&lt;channel type='pty'&gt;
&lt;target type='virtio' name='arbitrary.virtio.serial.port.name'/&gt;
&lt;/channel&gt;
spicevmc: support new qemu chardev Inspired by https://bugzilla.redhat.com/show_bug.cgi?id=615757 Add a new character device backend for virtio serial channels that activates the QEMU spice agent on the main channel using the vdagent spicevmc connection. The <target> must be type='virtio', and supports an optional name that specifies how the guest will see the channel (for now, name must be com.redhat.spice.0). <channel type='spicevmc'> <target type='virtio'/> <address type='virtio-serial' controller='1' bus='0' port='3'/> </channel> * docs/schemas/domain.rng: Support new XML. * docs/formatdomain.html.in: Document it. * src/conf/domain_conf.h (virDomainChrType): New enum value. * src/conf/domain_conf.c (virDomainChr): Add spicevmc. (virDomainChrDefParseXML, virDomainChrSourceDefParseXML) (virDomainChrDefParseTargetXML): Parse and enforce proper use. (virDomainChrSourceDefFormat, virDomainChrDefFormat): Format. * src/qemu/qemu_command.c (qemuBuildChrChardevStr) (qemuBuildCommandLine): Add qemu support. * tests/qemuxml2argvtest.c (domain): New test. * tests/qemuxml2argvdata/qemuxml2argv-channel-spicevmc.xml: New file. * tests/qemuxml2argvdata/qemuxml2argv-channel-spicevmc.args: Likewise. Signed-off-by: Eric Blake <eblake@redhat.com>
2011-02-03 04:09:44 +00:00
&lt;channel type='spicevmc'&gt;
&lt;target type='virtio' name='com.redhat.spice.0'/&gt;
&lt;/channel&gt;
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
&lt;/devices&gt;
...</pre>
Add documentation for <channel> domain element * src/formatdomain.html.in: Add <channel> element documentation
2009-11-09 14:38:20 +00:00
<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>
docs: domain: Document virtio <channel> Signed-off-by: Cole Robinson <crobinso@redhat.com>
2010-07-14 19:07:59 +00:00
<dt><code>virtio</code></dt>
<dd>Paravirtualized virtio channel. Channel is exposed in the guest under
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
/dev/vport*, and if the optional element <code>name</code> is specified,
docs: domain: Document virtio <channel> Signed-off-by: Cole Robinson <crobinso@redhat.com>
2010-07-14 19:07:59 +00:00
/dev/virtio-ports/$name (for more info, please see
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<a href="http://fedoraproject.org/wiki/Features/VirtioSerial">http://fedoraproject.org/wiki/Features/VirtioSerial</a>). The
optional element <code>address</code> can tie the channel to a
particular <code>type='virtio-serial'</code> controller.
docs: domain: Document virtio <channel> Signed-off-by: Cole Robinson <crobinso@redhat.com>
2010-07-14 19:07:59 +00:00
<span class="since">Since 0.7.7</span></dd>
spicevmc: support new qemu chardev Inspired by https://bugzilla.redhat.com/show_bug.cgi?id=615757 Add a new character device backend for virtio serial channels that activates the QEMU spice agent on the main channel using the vdagent spicevmc connection. The <target> must be type='virtio', and supports an optional name that specifies how the guest will see the channel (for now, name must be com.redhat.spice.0). <channel type='spicevmc'> <target type='virtio'/> <address type='virtio-serial' controller='1' bus='0' port='3'/> </channel> * docs/schemas/domain.rng: Support new XML. * docs/formatdomain.html.in: Document it. * src/conf/domain_conf.h (virDomainChrType): New enum value. * src/conf/domain_conf.c (virDomainChr): Add spicevmc. (virDomainChrDefParseXML, virDomainChrSourceDefParseXML) (virDomainChrDefParseTargetXML): Parse and enforce proper use. (virDomainChrSourceDefFormat, virDomainChrDefFormat): Format. * src/qemu/qemu_command.c (qemuBuildChrChardevStr) (qemuBuildCommandLine): Add qemu support. * tests/qemuxml2argvtest.c (domain): New test. * tests/qemuxml2argvdata/qemuxml2argv-channel-spicevmc.xml: New file. * tests/qemuxml2argvdata/qemuxml2argv-channel-spicevmc.args: Likewise. Signed-off-by: Eric Blake <eblake@redhat.com>
2011-02-03 04:09:44 +00:00
<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>
Add documentation for <channel> domain element * src/formatdomain.html.in: Add <channel> element documentation
2009-11-09 14:38:20 +00:00
</dl>
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h5><a name="elementsCharHostInterface">Host interface</a></h5>
<p>
A character device presents itself to the host as one of the following
types.
</p>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharSTDIO">Domain logfile</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
This disables all input on the character device, and sends output
into the virtual machine's logfile
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;console type='stdio'&gt;
&lt;target port='1'&gt;
&lt;/console&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharFle">Device logfile</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
A file is opened and all data sent to the character
device is written to the file.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<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>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharVC">Virtual console</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;serial type='vc'&gt;
&lt;target port="1"/&gt;
&lt;/serial&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharNull">Null device</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
Connects the character device to the void. No data is ever
provided to the input. All data written is discarded.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;serial type='null'&gt;
&lt;target port="1"/&gt;
&lt;/serial&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharPTY">Pseudo TTY</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<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>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
NB special case if &lt;console type='pty'&gt;, then the TTY
fix typos in docs docs/formatdomain.html docs/formatdomain.html.in docs/java.html docs/java.html.in
2008-08-08 10:24:14 +00:00
path is also duplicated as an attribute tty='/dev/pts/3'
Update domain XML docs
2008-05-08 14:20:07 +00:00
on the top level &lt;console&gt; tag. This provides compat
with existing syntax for &lt;console&gt; tags.
</p>
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharHost">Host device proxy</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<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
fix typos in docs docs/formatdomain.html docs/formatdomain.html.in docs/java.html docs/java.html.in
2008-08-08 10:24:14 +00:00
a host serial port - don't connect a serial port to a parallel
Update domain XML docs
2008-05-08 14:20:07 +00:00
port.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;serial type="dev"&gt;
&lt;source path="/dev/ttyS0"/&gt;
&lt;target port="1"/&gt;
&lt;/serial&gt;
&lt;/devices&gt;
...</pre>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharPipe">Named pipe</a></h6>
Fix docs and code disagreements for character devices. The 'pipe' character type wasn't documented. TCP uses a <protocol> element, not <wire> We weren't doing strict validation for protocol and source mode values.
2009-07-08 21:59:23 +00:00
<p>
The character device writes output to a named pipe. See pipe(7) for
more info.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<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>
Fix docs and code disagreements for character devices. The 'pipe' character type wasn't documented. TCP uses a <protocol> element, not <wire> We weren't doing strict validation for protocol and source mode values.
2009-07-08 21:59:23 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharTCP">TCP client/server</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
The character device acts as a TCP client connecting to a
document tcp listen and raw wire option
2009-07-24 20:16:51 +00:00
remote server.
Update domain XML docs
2008-05-08 14:20:07 +00:00
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<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>
document tcp listen and raw wire option
2009-07-24 20:16:51 +00:00
<p>
Or as a TCP server waiting for a client connection.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<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>
document tcp listen and raw wire option
2009-07-24 20:16:51 +00:00
<p>
docs: minor whitespace cleanups No change in wording. One spacing change in a <pre>, noticed because of odd XML formatting online; the rest is in free-flowing text to make it easier to see nesting levels in the document. * docs/formatdomain.html.in: Adjust spacing. Break long lines.
2011-07-06 19:49:28 +00:00
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>
esx: Add support for virtual serial device network backing Since version 4.1 ESX(i) can expose virtual serial devices over TCP. Add support in the VMX handling code for this, add test cases to cover it and add links to some documentation. ESX supports two additional protocols: TELNETS and TLS. Add them to the list of serial-over-TCP protocols.
2010-09-29 21:04:19 +00:00
(secure telnet) and <code>tls</code>.
docs: correct invalid xml * docs/internals.html.in: Fix xml errors. * docs/formatstorageencryption.html.in: Likewise. * docs/drvesx.html.in: Likewise. * docs/archnetwork.html.in: Likewise. * docs/logging.html.in: Likewise. * docs/drvvmware.html.in: Likewise. * docs/api.html.in: Likewise. * docs/formatnwfilter.html.in: Likewise. * docs/formatdomain.html.in: Likewise. * docs/windows.html.in: Likewise.
2011-04-01 22:02:10 +00:00
</p>
document tcp listen and raw wire option
2009-07-24 20:16:51 +00:00
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<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>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharUDP">UDP network console</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
The character device acts as a UDP netconsole service,
sending and receiving packets. This is a lossy service.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<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>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Separate character device doc guest and host parts * docs/formatdomain.html.in: refactors the existing character device documentation to make it explicit which directives configure the guest interface, and which configure the host interface.
2009-11-09 14:35:21 +00:00
<h6><a name="elementsCharUNIX">UNIX domain socket client/server</a></h6>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<p>
The character device acts as a UNIX domain socket server,
accepting connections from local clients.
</p>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<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>
Update domain XML docs
2008-05-08 14:20:07 +00:00
Add documentation for <sound> device XML format.
2009-05-19 13:18:00 +00:00
<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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;sound model='es1370'/&gt;
&lt;/devices&gt;
...</pre>
Add documentation for <sound> device XML format.
2009-05-19 13:18:00 +00:00
<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
qemu: sound: Support intel 'ich6' model In QEMU, the card itself is a PCI device, but it requires a codec (either -device hda-output or -device hda-duplex) to actually output sound. Specifying <sound model='ich6'/> gives us -device intel-hda -device hda-duplex I think it's important that a simple <sound model='ich6'/> sets up a useful codec, to have consistent behavior with all other sound cards. This is basically Dan's proposal of <sound model='ich6'> <codec type='output' slot='0'/> <codec type='duplex' slot='3'/> </sound> without the codec bits implemented. The important thing is to keep a consistent API here, we don't want some <sound> devs require tweaking codecs but not others. Steps I see to accomplishing this: - every <sound> device has a <codec type='default'/> (unless codecs are manually specified) - <codec type='none'/> is required to specify 'no codecs' - new audio settings like mic=on|off could then be exposed in <sound> or <codec> in a consistent manner for all sound models v2: Use model='ich6' v3: Use feature detection, from eblake Set codec id, bus, and cad values v4: intel-hda isn't supported if -device isn't available v5: Comment spelling fixes
2011-01-13 14:15:11 +00:00
choices are 'es1370', 'sb16', 'ac97', and 'ich6'
(<span class="since">
'ac97' only since 0.6.0, 'ich6' only since 0.8.8</span>)
Add documentation for <sound> device XML format.
2009-05-19 13:18:00 +00:00
</dd>
</dl>
docs: document <controller> element * docs/formatdomain.html.in: Talk about <controller> and <address> throughout.
2011-01-17 21:33:00 +00:00
<p>
Each <code>sound</code> element has an optional
sub-element <code>&lt;address&gt;</code> which can tie the
device to a particular PCI slot.
</p>
Support QEMU watchdog device. This adds simple support for configuring a guest with a QEMU/KVM virtual hardware watchdog device.
2009-10-21 12:26:38 +00:00
<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>
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;watchdog model='i6300esb'/&gt;
&lt;/devices&gt;
...</pre>
Support QEMU watchdog device. This adds simple support for configuring a guest with a QEMU/KVM virtual hardware watchdog device.
2009-10-21 12:26:38 +00:00
docs: Emphasize that devices have to be inside the <devices> element Also cleanup indentation of domain XML examples.
2010-02-04 14:27:52 +00:00
<pre>
...
&lt;devices&gt;
&lt;watchdog model='i6300esb' action='poweroff'/&gt;
&lt;/devices&gt;
&lt;/domain&gt;</pre>
Support QEMU watchdog device. This adds simple support for configuring a guest with a QEMU/KVM virtual hardware watchdog device.
2009-10-21 12:26:38 +00:00
<dl>
<dt><code>model</code></dt>
<dd>
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
<p>
Support QEMU watchdog device. This adds simple support for configuring a guest with a QEMU/KVM virtual hardware watchdog device.
2009-10-21 12:26:38 +00:00
The required <code>model</code> attribute specifies what real
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
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>
Support QEMU watchdog device. This adds simple support for configuring a guest with a QEMU/KVM virtual hardware watchdog device.
2009-10-21 12:26:38 +00:00
</dd>
<dt><code>action</code></dt>
<dd>
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
<p>
Support QEMU watchdog device. This adds simple support for configuring a guest with a QEMU/KVM virtual hardware watchdog device.
2009-10-21 12:26:38 +00:00
The optional <code>action</code> attribute describes what
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
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>
Update documentation of watchdog dump option and add test data for it The xml watchdog dump option is converted to qemu watchdog pause arg but it is not reasonable to convert it back from qemu watchdog pause arg since there already is a xml watchdog pause option, so a test for the dump option to convert it from arg to xml is not added.
2010-12-10 05:52:11 +00:00
<li>'dump' &mdash; automatically dump the guest
<span class="since">Since 0.8.7</span></li>
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
</ul>
<p>
Update documentation of watchdog dump option and add test data for it The xml watchdog dump option is converted to qemu watchdog pause arg but it is not reasonable to convert it back from qemu watchdog pause arg since there already is a xml watchdog pause option, so a test for the dump option to convert it from arg to xml is not added.
2010-12-10 05:52:11 +00:00
Note 1: the 'shutdown' action requires that the guest
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 15:04:19 +00:00
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>
Update documentation of watchdog dump option and add test data for it The xml watchdog dump option is converted to qemu watchdog pause arg but it is not reasonable to convert it back from qemu watchdog pause arg since there already is a xml watchdog pause option, so a test for the dump option to convert it from arg to xml is not added.
2010-12-10 05:52:11 +00:00
<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>
Support QEMU watchdog device. This adds simple support for configuring a guest with a QEMU/KVM virtual hardware watchdog device.
2009-10-21 12:26:38 +00:00
</dd>
</dl>
Document the memory balloon device * formatdomain.html.in: Document <memballoon> element
2010-07-21 10:53:56 +00:00
<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>
docs: document how to disable memballoon https://bugzilla.redhat.com/show_bug.cgi?id=623903 documents a qemu bug that causes libvirt to hang if virt-manager happens to be querying balloon info when a guest is paused. Until the qemu bug is fixed, people need to know how to avoid the issue. * docs/formatdomain.html.in (Memory balloon device): Mention model='none'.
2010-10-15 19:34:24 +00:00
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.
Document the memory balloon device * formatdomain.html.in: Document <memballoon> element
2010-07-21 10:53:56 +00:00
</p>
<p>
Example automatically added device with KVM
</p>
<pre>
...
&lt;devices&gt;
&lt;memballoon model='virtio'/&gt;
&lt;/devices&gt;
...</pre>
<p>
Example manually added device with static PCI slot 2 requested
</p>
<pre>
...
&lt;devices&gt;
&lt;watchdog model='virtio'/&gt;
&lt;address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x0'/&gt;
&lt;/devices&gt;
&lt;/domain&gt;</pre>
<dl>
<dt><code>model</code></dt>
<dd>
<p>
The required <code>model</code> attribute specifies what type
maint: whitespace cleanup * .dir-locals.el (html-mode): Let emacs help out. * cfg.mk (sc_TAB_in_indentation): Check more files. * docs/internals/command.html.in: Fix offenders. * docs/formatdomain.html.in: Likewise. * docs/internals.html.in: Likewise. Reported by Jiri Denemark.
2011-02-04 18:16:35 +00:00
of balloon device is provided. Valid values are specific to
the virtualization platform
Document the memory balloon device * formatdomain.html.in: Document <memballoon> element
2010-07-21 10:53:56 +00:00
</p>
<ul>
<li>'virtio' &mdash; default with QEMU/KVM</li>
<li>'xen' &mdash; default with Xen</li>
</ul>
</dd>
</dl>
Add documentation for the seclabel XML element The domain XML documentation is missing information about the <seclabel> element used by security drivers * formatdomain.html.in: Document <seclabel>
2011-06-27 11:31:36 +00:00
<h3><a name="seclabel">Security label</a></h3>
<p>
The <code>seclabel</code> element allows control over the
operation of the security drivers. There are two basic
modes of operation, dynamic where libvirt automatically
generates a unique security label, or static where the
application/administrator chooses the labels. With dynamic
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
if desired
</p>
<p>
Valid input XML configurations for the security label
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;
</pre>
<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>
<dd>Either <code>static</code> or <code>dynamic</code> to determine
whether libvirt automatically generates a unique security label
or not.
</dd>
<dt><code>model</code></dt>
<dd>A valid security model name, matching the currently
activated security model
</dd>
<dt><code>relabel</code></dt>
<dd>Either <code>yes</code> or <code>no</code>. This must always
be <code>yes</code> if dynamic label assignment is used. With
static label assignment it will default to <code>no</code>.
</dd>
<dt><code>label</code></dt>
<dd>If static labelling is used, this must specify the full
security label to assign to the virtual domain. The format
of the content depends on the security driver in use
</dd>
<dt><code>baselabel</code></dt>
<dd>If dynamic labelling is used, this can optionally be
used to specify the base security label. The format
of the content depends on the security driver in use
</dd>
<dt><code>imagelabel</code></dt>
<dd>This is an output only element, which shows the
security label used on resources associated with the virtual domain.
The format of the content depends on the security driver in use
</dd>
</dl>
Update domain XML docs
2008-05-08 14:20:07 +00:00
<h2><a name="examples">Example configs</a></h2>
Split website out into one file per page. APply new layout and styling
2008-04-23 17:08:31 +00:00
<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>
Reference in New Issue Copy Permalink