[libvirt-virshcmdref 10/10] update documentation for command vcpucount

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



---
 source/vcpucount.xml |   67 ++++++++++++++++++++++++++++++++++++++++++++++++-
 1 files changed, 65 insertions(+), 2 deletions(-)

diff --git a/source/vcpucount.xml b/source/vcpucount.xml
index d556a75..2e70c07 100644
--- a/source/vcpucount.xml
+++ b/source/vcpucount.xml
@@ -9,7 +9,60 @@
     </text>
   </description>
 
-  <options />
+  <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">--maximum</keyword>
+      <description>
+        <text>
+          get maximum cap on vcpus
+        </text>
+      </description>
+    </parameter>
+    <parameter requirement="optional">
+      <keyword requirement="optional">--active</keyword>
+      <description>
+        <text>
+          get number of currently active vcpus
+        </text>
+      </description>
+    </parameter>
+    <parameter requirement="optional">
+      <keyword requirement="optional">--config</keyword>
+      <description>
+        <text>
+          get value to be used on next boot
+        </text>
+      </description>
+    </parameter>
+    <parameter requirement="optional">
+      <keyword requirement="optional">--live</keyword>
+      <description>
+        <text>
+          get value from running domain
+        </text>
+      </description>
+    </parameter>
+    <parameter requirement="optional">
+      <keyword requirement="optional">--current</keyword>
+      <description>
+        <text>
+          get value according to curent domain state
+        </text>
+      </description>
+    </parameter>
+  </options>
 
   <availability from="0.8.5" />
  
@@ -19,6 +72,16 @@
 
   <examples type="fullcontext" />
 
-  <reference type="seealso" />
+  <reference type="seealso">
+    <item>
+      <link type="internal" href="setvcpus" />
+      <name>
+        setvcpus
+      </name>
+      <description>
+        change the number of vurtual CPUs in the guest domain
+      </description>
+    </item>
+  </reference>
 
 </command>
-- 
1.7.3.1

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list


[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]