[libvirt] [libvirt-virshcmdref 04/14] update documentation for command blkiotune
---
common.sh | 2 +-
source/blkiotune.xml | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 86 insertions(+), 1 deletions(-)
create mode 100644 source/blkiotune.xml
diff --git a/common.sh b/common.sh
index f48ea40..13e8995 100755
--- a/common.sh
+++ b/common.sh
@@ -6,7 +6,7 @@ DOMAIN_COMMANDS="attach-device attach-disk attach-interface
autostart
hostname managedsave managedsave-remove maxvcpus memtune migrate
migrate-setmaxdowntime reboot restore resume save schedinfo setmaxmem
setmem setvcpus shutdown start suspend ttyconsole undefine update-device
- vcpucount vcpuinfo vcpupin version vncdisplay"
+ vcpucount vcpuinfo vcpupin version vncdisplay blkiotune"
MONITOR_COMMANDS="domblkinfo domblkstat domifstat dominfo dommemstat
domstate list"
diff --git a/source/blkiotune.xml b/source/blkiotune.xml
new file mode 100644
index 0000000..6354b99
--- /dev/null
+++ b/source/blkiotune.xml
@@ -0,0 +1,85 @@
+<?xml version='1.0' encoding='utf-8' ?>
+
+<command>
+ <name>blkiotune</name>
+
+ <description>
+ <text>
+ Get or set blkio parameters
+ </text>
+ </description>
+
+ <options>
+ <parameter requirement="required">
+ <keyword requirement="optional">--domain</keyword>
+ <value type="string"
requirement="required">domain</value>
+ <description>
+ <text>
+ domain name, id or uuid
+ </text>
+ <text>
+ "--domain" itself is optional
+ </text>
+ </description>
+ </parameter>
+ <parameter requirement="optional">
+ <keyword requirement="optional">--weight</keyword>
+ <value type="number"
requirement="required">weight</value>
+ <description>
+ <text>
+ IO weight in range [100, 1000]
+ </text>
+ </description>
+ </parameter>
+ <parameter requirement="optional">
+ <keyword requirement="required">--config</keyword>
+ <description>
+ <text>
+ affect next boot
+ </text>
+ </description>
+ </parameter>
+ <parameter requirement="optional">
+ <keyword requirement="required">--live</keyword>
+ <description>
+ <text>
+ affect running domain
+ </text>
+ </description>
+ </parameter>
+ <parameter requirement="optional">
+ <keyword requirement="required">--current</keyword>
+ <description>
+ <text>
+ affect current domain
+ </text>
+ </description>
+ </parameter>
+ </options>
+
+ <availability from="0.8.9" />
+
+ <notes />
+
+ <examples type="usage">
+ <example>
+ <terminal>
+virsh # <bold>blkiotune</bold>
<value>example-domain</value></terminal>
+ <text>
+ Shows the values of blkio parameters of domain
<value>example-domain</value>.
+ </text>
+ </example>
+ <example>
+ <terminal>
+virsh # <bold>blkiotune</bold> <value>example-domain</value>
<italic>--weight</italic> <value>500</value></terminal>
+ <text>
+ Sets IO weight of domain <value>example-domain</value> to
<value>500</value>.
+ </text>
+ </example>
+ </examples>
+
+ <examples type="fullcontext" />
+
+ <reference type="seealso" />
+
+</command>
--
1.7.3.1