aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOsier Yang <jyang@redhat.com>2012-03-14 23:26:46 +0800
committerOsier Yang <jyang@redhat.com>2012-03-23 23:10:30 +0800
commitab49b392cc8ea1edbdacc80706de6fd9f14007ac (patch)
tree89bfaa4a2f7edc52b875c5f26852627dc699cb69 /docs/formatdomain.html.in
parentAdd support for event tray moved of removable disks (diff)
downloadlibvirt-ab49b392cc8ea1edbdacc80706de6fd9f14007ac.tar.gz
libvirt-ab49b392cc8ea1edbdacc80706de6fd9f14007ac.tar.bz2
libvirt-ab49b392cc8ea1edbdacc80706de6fd9f14007ac.zip
docs: Add documentation for new attribute tray of disk target
Example XML: <disk type='file' device='cdrom'> <driver name='qemu' type='raw'/> <source file='/tmp/cdrom.img'/> <target dev='hdd' bus='ide' tray='open'/> </disk>
Diffstat (limited to 'docs/formatdomain.html.in')
-rw-r--r--docs/formatdomain.html.in13
1 files changed, 9 insertions, 4 deletions
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 21372b7cd..814e270fd 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -1134,7 +1134,7 @@
&lt;/disk&gt;
&lt;disk type='block' device='cdrom'&gt;
&lt;driver name='qemu' type='raw'/&gt;
- &lt;target dev='hdc' bus='ide'/&gt;
+ &lt;target dev='hdc' bus='ide' tray='open'/&gt;
&lt;readonly/&gt;
&lt;/disk&gt;
&lt;disk type='block' device='lun'&gt;
@@ -1245,10 +1245,15 @@
possible values are driver specific, with typical values being
"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.
+ 'sda' will typically be exported using a SCSI bus. The optional
+ attribute <code>tray</code> indicates the tray status of the
+ removable disks (i.e. CDROM or Floppy disk), the value can be either
+ "open" or "closed", defaults to "closed". NB, the value of
+ <code>tray</code> could be updated while the domain is running.
<span class="since">Since 0.0.3; <code>bus</code> attribute since 0.4.3;
- "usb" attribute value since after 0.4.4; "sata" attribute value since
- 0.9.7</span></dd>
+ <code>tray</code> attribute since 0.9.11; "usb" attribute value since
+ after 0.4.4; "sata" attribute value since 0.9.7</span>
+ </dd>
<dt><code>iotune</code></dt>
<dd>The optional <code>iotune</code> element provides the
ability to provide additional per-device I/O tuning, with