[libvirt] [PATCH 13/13] Update documentation: Controller
From: Wolfgang Mauerer <wolfgang.mauerer(a)siemens.com>
Document the controller specification, that is, the <controller> element
within <domain>
---
docs/formatdomain.html.in | 38 ++++++++++++++++++++++++++++++++++++++
1 files changed, 38 insertions(+), 0 deletions(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 52889af..aada7d9 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -345,6 +345,7 @@
<disk type='file'>
<driver name="tap" type="aio">
<source file='/var/lib/xen/images/fv0'/>
+ <controller name='controller0' bus='0'
unit='5'>
<target dev='hda' bus='ide'/>
<encryption type='...'>
...
@@ -366,6 +367,13 @@
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 the disk. <span
class="since">Since 0.0.3</span></dd>
+ <dt><code>controller</code></dt>
+ <dd>If present, specifies the controller to which the disk is
+ connected. This is useful for disk hotplug as it allows to add
+ disks to specific controlers. This is currently only possible
+ for scsi drivers. <code>bus</code> and
<code>unit</unit> are
+ facultative and specify the drive position on the controller.
+ </dd>
<dt><code>target</code></dt>
<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
@@ -675,6 +683,36 @@ qemu-kvm -net nic,model=? /dev/null
It takes values "xen" (paravirtualized), "ps2" and
"usb".</dd>
</dl>
+ <h4><a name="elementsController">Disk
controllers</a></h4>
+
+ <p>
+ Disk controllers are hosts for hard disks.
+ </p>
+
+ <pre>
+ ...
+ <controller type='scsi' name='controller0'>
+ <address type='pci' bus='0x00' domain='0x00'
slot='0x0a'/>
+ </controller>
+ ...</pre>
+
+ <dl>
+ <dt><code>controller</code></dt>
+ <dd>The <code>controller</code> element has a mandatory
<code>type</code>
+ attribute which takes the type of the controller,
+ e.g., <code>"scsi"</code>. <br/>
+ <code>name</code> specifies a symbolic identifier for the
+ controller by which it can be addressed.
+
+ The address of the controller on the underlying bus is given
+ by the <code>address</code> subelement. The mandatory
+ element <code>type</code> specified the bus type for which
+ the address holds and must be the same as for the controller.
+ Currently, only pci is supported, which requires three
+ parameters to denote address: <code>bus</code>,
<code>domain</code>,
+ and <code>device</code>. All must be given as hexadecimal numbers.
+ </dd>
+ </dl>
<h4><a name="elementsGraphics">Graphical
framebuffers</a></h4>
--
1.6.4