mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-12-23 14:15:28 +00:00
06cf86e94b
Our documentation for features was rather sparse; this fleshes out more of the details for other existing capabilities (and cost me some time trawling git history). * docs/formatcaps.html.in: Document it feature bits. Signed-off-by: Eric Blake <eblake@redhat.com>
200 lines
7.7 KiB
XML
200 lines
7.7 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<body>
|
|
<h1>Driver capabilities XML format</h1>
|
|
|
|
<ul id="toc"></ul>
|
|
|
|
<h2><a name="elements">Element and attribute overview</a></h2>
|
|
|
|
<p>As new virtualization engine support gets added to libvirt, and to
|
|
handle cases like QEMU supporting a variety of emulations, a query
|
|
interface has been added in 0.2.1 allowing to list the set of supported
|
|
virtualization capabilities on the host:</p>
|
|
|
|
<pre> char * virConnectGetCapabilities (virConnectPtr conn);</pre>
|
|
|
|
<p>The value returned is an XML document listing the virtualization
|
|
capabilities of the host and virtualization engine to which
|
|
<code>@conn</code> is connected. One can test it using <code>virsh</code>
|
|
command line tool command '<code>capabilities</code>', it dumps the XML
|
|
associated to the current connection. </p>
|
|
|
|
<p>As can be seen seen in the <a href="#elementExamples">example</a>, the
|
|
capabilities XML consists of the <code>capabilities</code> element which
|
|
have exactly one <code>host</code> child element to report information on
|
|
host capabilities, and zero or more <code>guest</code> element to express
|
|
the set of architectures the host can run at the moment.</p>
|
|
|
|
|
|
<h3><a name="elementHost">Host capabilities</a></h3>
|
|
|
|
<p>The <code><host/></code> element consists of the following child
|
|
elements:</p>
|
|
<dl>
|
|
<dt><code>uuid</code></dt>
|
|
<dd>The host UUID.</dd>
|
|
|
|
<dt><code>cpu</code></dt>
|
|
<dd>The host CPU architecture and features.</dd>
|
|
|
|
<dt><code>power_management</code></dt>
|
|
<dd>whether host is capable of memory suspend, disk hibernation, or
|
|
hybrid suspend.</dd>
|
|
|
|
<dt><code>migration</code></dt>
|
|
<dd>This element exposes information on the hypervisor's migration
|
|
capabilities, like live migration, supported URI transports, and so
|
|
on.</dd>
|
|
|
|
<dt><code>topology</code></dt>
|
|
<dd>This element embodies the host internal topology. Management
|
|
applications may want to learn this information when orchestrating new
|
|
guests - e.g. due to reduce inter-NUMA node transfers.</dd>
|
|
|
|
<dt><code>secmodel</code></dt>
|
|
<dd>To find out default security labels for different security models you
|
|
need to parse this element. In contrast with the former elements, this is
|
|
repeated for each security model the libvirt daemon currently supports.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h3><a name="elementGuest">Guest capabilities</a></h3>
|
|
|
|
<p>While the <a href="#elementHost">previous section</a> aims at host
|
|
capabilities, this one focuses on capabilities available to a guest
|
|
using a given hypervisor. The <code><guest/></code> element will
|
|
typically wrap up the following elements:</p>
|
|
|
|
<dl>
|
|
<dt><code>os_type</code></dt>
|
|
<dd>This expresses what kind of operating system the hypervisor
|
|
is able to run. Possible values are:
|
|
<dl>
|
|
<dt>xen</dt>
|
|
<dd>for XEN</dd>
|
|
|
|
<dt>linux</dt>
|
|
<dd>legacy alias for <code>xen</code></dd>
|
|
|
|
<dt>hvm</dt>
|
|
<dd>Unmodified operating system</dd>
|
|
|
|
<dt>exe</dt>
|
|
<dd>Container based virtualization</dd>
|
|
|
|
<dt>uml</dt>
|
|
<dd>User Mode Linux</dd>
|
|
</dl>
|
|
</dd>
|
|
|
|
<dt><code>arch</code></dt>
|
|
<dd>This element brings some information on supported guest architecture.</dd>
|
|
|
|
<dt><code>features</code></dt>
|
|
<dd>This optional element encases possible features that can be used
|
|
with a guest of described type. Possible subelements are:
|
|
<dl>
|
|
<dt>pae</dt><dd>If present, 32-bit guests can use PAE
|
|
address space extensions, <span class="since">since
|
|
0.4.1</span></dd>
|
|
<dt>nonpae</dt><dd>If present, 32-bit guests can be run
|
|
without requiring PAE, <span class="since">since
|
|
0.4.1</span></dd>
|
|
<dt>ia64_be</dt><dd>If present, IA64 guests can be run in
|
|
big-endian mode, <span class="since">since 0.4.1</span></dd>
|
|
<dt>acpi</dt><dd>If this element is present,
|
|
the <code>default</code> attribute describes whether the
|
|
hypervisor exposes ACPI to the guest by default, and
|
|
the <code>toggle</code> attribute describes whether the
|
|
user can override this
|
|
default. <span class="since">Since 0.4.1</span></dd>
|
|
<dt>apic</dt><dd>If this element is present,
|
|
the <code>default</code> attribute describes whether the
|
|
hypervisor exposes APIC to the guest by default, and
|
|
the <code>toggle</code> attribute describes whether the
|
|
user can override this
|
|
default. <span class="since">Since 0.4.1</span></dd>
|
|
<dt>cpuselection</dt><dd>If this element is present, the
|
|
hypervisor supports the <code><cpu></code> element
|
|
within a domain definition for fine-grained control over
|
|
the CPU presented to the
|
|
guest. <span class="since">Since 0.7.5</span></dd>
|
|
<dt>deviceboot</dt><dd>If this element is present,
|
|
the <code><boot order='...'/></code> element can
|
|
be used inside devices, rather than the older boot
|
|
specification by category. <span class="since">Since
|
|
0.8.8</span></dd>
|
|
<dt>disksnapshot</dt><dd>If this element is present,
|
|
the <code>default</code> attribute describes whether
|
|
external disk snapshots are supported. If absent,
|
|
external snapshots may still be supported, but it
|
|
requires attempting the API and checking for an error to
|
|
find out for sure. <span class="since">Since
|
|
1.2.3</span></dd>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h3><a name="elementExamples">Examples</a></h3>
|
|
|
|
<p>For example, in the case of a 64-bit machine with hardware
|
|
virtualization capabilities enabled in the chip and
|
|
BIOS you will see:</p>
|
|
|
|
<pre><capabilities>
|
|
<span style="color: #E50000"><host>
|
|
<cpu>
|
|
<arch>x86_64</arch>
|
|
<features>
|
|
<vmx/>
|
|
</features>
|
|
<model>core2duo</model>
|
|
<vendor>Intel</vendor>
|
|
<topology sockets="1" cores="2" threads="1"/>
|
|
<feature name="lahf_lm"/>
|
|
<feature name='xtpr'/>
|
|
...
|
|
</cpu>
|
|
<power_management>
|
|
<suspend_mem/>
|
|
<suspend_disk/>
|
|
<suspend_hybrid/>
|
|
<power_management/>
|
|
</host></span>
|
|
|
|
<!-- xen-3.0-x86_64 -->
|
|
<span style="color: #0000E5"><guest>
|
|
<os_type>xen</os_type>
|
|
<arch name="x86_64">
|
|
<wordsize>64</wordsize>
|
|
<domain type="xen"></domain>
|
|
<emulator>/usr/lib64/xen/bin/qemu-dm</emulator>
|
|
</arch>
|
|
<features>
|
|
</features>
|
|
</guest></span>
|
|
|
|
<!-- hvm-3.0-x86_32 -->
|
|
<span style="color: #00B200"><guest>
|
|
<os_type>hvm</os_type>
|
|
<arch name="i686">
|
|
<wordsize>32</wordsize>
|
|
<domain type="xen"></domain>
|
|
<emulator>/usr/lib/xen/bin/qemu-dm</emulator>
|
|
<machine>pc</machine>
|
|
<machine>isapc</machine>
|
|
<loader>/usr/lib/xen/boot/hvmloader</loader>
|
|
</arch>
|
|
<features>
|
|
<cpuselection/>
|
|
<deviceboot/>
|
|
</features>
|
|
</guest></span>
|
|
...
|
|
</capabilities></pre>
|
|
</body>
|
|
</html>
|