libvirt/docs/formatcaps.html.in

<html>
  <body>
    <h1>Driver capabilities XML format</h1>

        <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. For example in the case of a 64 bits
machine with hardware virtualization capabilities enabled in the chip and
BIOS you will see</p>
        <pre>&lt;capabilities&gt;
  <span style="color: #E50000">&lt;host&gt;
    &lt;cpu&gt;
      &lt;arch&gt;x86_64&lt;/arch&gt;
      &lt;features&gt;
        &lt;vmx/&gt;
      &lt;/features&gt;
      &lt;model&gt;core2duo&lt;/model&gt;
      &lt;vendor&gt;Intel&lt;/vendor&gt;
      &lt;topology sockets="1" cores="2" threads="1"/&gt;
      &lt;feature name="lahf_lm"/&gt;
      &lt;feature name='xtpr'/&gt;
      ...
    &lt;/cpu&gt;
  &lt;/host&gt;</span>

  &lt;!-- xen-3.0-x86_64 --&gt;
  <span style="color: #0000E5">&lt;guest&gt;
    &lt;os_type&gt;xen&lt;/os_type&gt;
    &lt;arch name="x86_64"&gt;
      &lt;wordsize&gt;64&lt;/wordsize&gt;
      &lt;domain type="xen"&gt;&lt;/domain&gt;
      &lt;emulator&gt;/usr/lib64/xen/bin/qemu-dm&lt;/emulator&gt;
    &lt;/arch&gt;
    &lt;features&gt;
    &lt;/features&gt;
  &lt;/guest&gt;</span>

  &lt;!-- hvm-3.0-x86_32 --&gt;
  <span style="color: #00B200">&lt;guest&gt;
    &lt;os_type&gt;hvm&lt;/os_type&gt;
    &lt;arch name="i686"&gt;
      &lt;wordsize&gt;32&lt;/wordsize&gt;
      &lt;domain type="xen"&gt;&lt;/domain&gt;
      &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
      &lt;machine&gt;pc&lt;/machine&gt;
      &lt;machine&gt;isapc&lt;/machine&gt;
      &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
    &lt;/arch&gt;
    &lt;features&gt;
      &lt;cpuselection/&gt;
      &lt;deviceboot/&gt;
    &lt;/features&gt;
  &lt;/guest&gt;</span>
  ...
&lt;/capabilities&gt;</pre>
        <p>The first block (in red) indicates the host hardware capabilities, currently
it is limited to the CPU properties but other information may be available,
it shows the CPU architecture, topology, model name, and additional features
which are not included in the model but the CPU provides them. Features of the
chip are shown within the feature block (the block is similar to what you will
find in a Xen fully virtualized domain description).</p>
        <p>The second block (in blue) indicates the paravirtualization support of the
Xen support, you will see the os_type of xen to indicate a paravirtual
kernel, then architecture information and potential features.</p>
        <p>The third block (in green) gives similar information but when running a
32 bit OS fully virtualized with Xen using the hvm support.</p>
        <p>This section is likely to be updated and augmented in the future, see <a href="https://www.redhat.com/archives/libvir-list/2007-March/msg00215.html">the
discussion</a> which led to the capabilities format in the mailing-list
archives.</p>

  </body>
</html>
Split website out into one file per page. APply new layout and styling 2008-04-23 17:08:31 +00:00			`<html>`
			`<body>`
			`<h1>Driver capabilities XML format</h1>`

			`<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. For example in the case of a 64 bits`
			`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>`
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com> 2010-01-19 18:22:45 +01:00			`<model>core2duo</model>`
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 17:51:59 +02:00			`<vendor>Intel</vendor>`
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com> 2010-01-19 18:22:45 +01:00			`<topology sockets="1" cores="2" threads="1"/>`
			`<feature name="lahf_lm"/>`
			`<feature name='xtpr'/>`
			`...`
Split website out into one file per page. APply new layout and styling 2008-04-23 17:08:31 +00:00			`</cpu>`
			`</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>`
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com> 2010-01-19 18:22:45 +01:00			`<cpuselection/>`
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 15:19:34 +01:00			`<deviceboot/>`
Split website out into one file per page. APply new layout and styling 2008-04-23 17:08:31 +00:00			`</features>`
			`</guest></span>`
			`...`
			`</capabilities></pre>`
			`<p>The first block (in red) indicates the host hardware capabilities, currently`
			`it is limited to the CPU properties but other information may be available,`
Document <cpu> elements in capabilities and domain XML Signed-off-by: Jiri Denemark <jdenemar@redhat.com> 2010-01-19 18:22:45 +01:00			`it shows the CPU architecture, topology, model name, and additional features`
			`which are not included in the model but the CPU provides them. Features of the`
			`chip are shown within the feature block (the block is similar to what you will`
			`find in a Xen fully virtualized domain description).</p>`
Split website out into one file per page. APply new layout and styling 2008-04-23 17:08:31 +00:00			`<p>The second block (in blue) indicates the paravirtualization support of the`
			`Xen support, you will see the os_type of xen to indicate a paravirtual`
			`kernel, then architecture information and potential features.</p>`
			`<p>The third block (in green) gives similar information but when running a`
			`32 bit OS fully virtualized with Xen using the hvm support.</p>`
			`<p>This section is likely to be updated and augmented in the future, see <a href="https://www.redhat.com/archives/libvir-list/2007-March/msg00215.html">the`
			`discussion</a> which led to the capabilities format in the mailing-list`
			`archives.</p>`

			`</body>`
			`</html>`