]> xenbits.xensource.com Git - libvirt.git/commitdiff
projects / libvirt.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 73426c5)
docs: Add description for Storage Pool Capabilities
authorJohn Ferlan <jferlan@redhat.com>
Thu, 7 Feb 2019 20:26:00 +0000 (15:26 -0500)
committerJohn Ferlan <jferlan@redhat.com>
Wed, 6 Mar 2019 16:12:48 +0000 (11:12 -0500)
Signed-off-by: John Ferlan <jferlan@redhat.com>
ACKed-by: Michal Privoznik <mprivozn@redhat.com>
docs/docs.html.in patch | blob | blame | history
docs/format.html.in patch | blob | blame | history
docs/formatstoragecaps.html.in [new file with mode: 0644] patch | blob
docs/index.html.in patch | blob | blame | history

diff --git a/docs/docs.html.in b/docs/docs.html.in
index 40e0e3b82e704066e30250e41907417892b8a71e..d0ff844d0cbeb2799eff81cbb682ab61a5c46ee6 100644 (file)
--- a/docs/docs.html.in
+++ b/docs/docs.html.in
@@ -77,6 +77,7 @@
           <a href="formatstorageencryption.html">storage encryption</a>,
           <a href="formatcaps.html">capabilities</a>,
           <a href="formatdomaincaps.html">domain capabilities</a>,
+          <a href="formatstoragecaps.html">storage pool capabilities</a>,
           <a href="formatnode.html">node devices</a>,
           <a href="formatsecret.html">secrets</a>,
           <a href="formatsnapshot.html">snapshots</a></dd>
diff --git a/docs/format.html.in b/docs/format.html.in
index 22b23e3fc720a934e85ffed2c0742d0e051ac912..640a9957ee94044813685ff84e7e2fefa0b8e15b 100644 (file)
--- a/docs/format.html.in
+++ b/docs/format.html.in
@@ -21,6 +21,7 @@
       <li><a href="formatstorageencryption.html">Storage encryption</a></li>
       <li><a href="formatcaps.html">Capabilities</a></li>
       <li><a href="formatdomaincaps.html">Domain capabilities</a></li>
+      <li><a href="formatstoragecaps.html">Storage Pool capabilities</a></li>
       <li><a href="formatnode.html">Node devices</a></li>
       <li><a href="formatsecret.html">Secrets</a></li>
       <li><a href="formatsnapshot.html">Snapshots</a></li>
diff --git a/docs/formatstoragecaps.html.in b/docs/formatstoragecaps.html.in
new file mode 100644 (file)
index 0000000..2813d06
--- /dev/null
+++ b/docs/formatstoragecaps.html.in
@@ -0,0 +1,108 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <body>
+    <h1>Storage Pool Capabilities XML format</h1>
+
+    <ul id="toc"></ul>
+
+    <h2><a id="Overview">Overview</a></h2>
+
+    <p>The Storage Pool Capabilities XML will provide the information
+    to determine what types of Storage Pools exist, whether the pool is
+    supported, and if relevant the source format types, the required
+    source elements, and the target volume format types. </p>
+
+    <p>The Storage Pool Capabilities XML provides more information than the
+      <a href="/html/libvirt-libvirt-host.html#virConnectGetCapabilities">
+        <code>virConnectGetCapabilities</code>
+      </a>
+    which only provides an enumerated list of supported pool types.</p>
+
+    <h2><a id="elements">Element and attribute overview</a></h2>
+
+    <p>A query interface was added to the virConnect API's to retrieve the
+    XML listing of the set of Storage Pool Capabilities
+    (<span class="since">Since 5.2.0</span>):</p>
+
+<pre>
+<a href="/html/libvirt-libvirt-domain.html#virConnectGetStoragePoolCapabilities">virConnectGetStoragePoolCapabilities</a>
+</pre>
+
+    <p>The root element that emulator capability XML document starts with is
+    named <code>storagepoolCapabilities</code>. There will be any number of
+    <code>pool</code> child elements with two attributes <code>type</code>
+    and <code>supported</code>. Each <code>pool</code> element may have
+    a <code>poolOptions</code> or <code>volOptions</code> subelements to
+    describe the available features. Sample XML output is:</p>
+
+<pre>
+&lt;storagepoolCapabilities&gt;
+  &lt;pool type='dir' supported='yes'&gt;
+    &lt;volOptions&gt;
+      &lt;defaultFormat type='raw'&lt;/&gt;
+      &lt;enum name='targetFormatType'&gt;
+        &lt;value&gt;none&lt;/value&gt;
+        &lt;value&gt;raw&lt;/value&gt;
+        ...
+      &lt;/enum&gt;
+    &lt;/volOptions&gt;
+  &lt;/pool&gt;
+  &lt;pool type='fs' supported='yes'&gt;
+    &lt;poolOptions&gt;
+      &lt;defaultFormat type='auto'&lt;/&gt;
+      &lt;enum name='sourceFormatType'&gt;
+        &lt;value&gt;auto&lt;/value&gt;
+        &lt;value&gt;ext2&lt;/value&gt;
+        ...
+      &lt;/enum&gt;
+      &lt;enum name='requiredSourceElements'&gt;
+        &lt;value&gt;device&lt;/value&gt;
+      &lt;/enum&gt;
+    &lt;/poolOptions&gt;
+    &lt;volOptions&gt;
+      &lt;defaultFormat type='raw'&lt;/&gt;
+      &lt;enum name='targetFormatType'&gt;
+        &lt;value&gt;none&lt;/value&gt;
+        &lt;value&gt;raw&lt;/value&gt;
+        ...
+      &lt;/enum&gt;
+    &lt;/volOptions&gt;
+  &lt;/pool&gt;
+  ...
+&lt;/storagepoolCapabilities&gt;
+</pre>
+
+    <p>The following section decribes subelements of the
+    <code>poolOptions</code> and <code>volOptions</code> subelements </p>:
+
+    <dl>
+      <dt><code>defaultFormat</code></dt>
+      <dd>For the <code>poolOptions</code>, the <code>type</code> attribute
+      describes the default format name used for the pool source. For the
+      <code>volOptions</code>, the <code>type</code> attribute describes
+      the default volume name used for each volume.
+      </dd>
+      <dl>
+        <dt><code>enum</code></dt>
+        <dd>Each enum uses a name from the list below with any number of
+        <code>value</code> value subelements describing the valid values.
+          <dl>
+            <dt><code>sourceFormatType</code></dt>
+            <dd>Lists all the possible <code>poolOptions</code> source
+            pool format types.
+            </dd>
+            <dt><code>requiredSourceElements</code></dt>
+            <dd>Lists all the required <code>poolOptions</code> source
+            subelements required for a valid source pool element.
+            </dd>
+            <dt><code>targetFormatType</code></dt>
+            <dd>Lists all the possible <code>volOptions</code> target volume
+            format types.
+            </dd>
+          </dl>
+        </dd>
+      </dl>
+    </dl>
+  </body>
+</html>
diff --git a/docs/index.html.in b/docs/index.html.in
index 1f9f4483992edd35900a32bfcd9fd41d1b97a16a..f593445d061d1c7bc1c1eeab3303ffaf46d4e0e9 100644 (file)
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -66,6 +66,7 @@
           <a href="formatstorageencryption.html">storage encryption</a>,
           <a href="formatcaps.html">capabilities</a>,
           <a href="formatdomaincaps.html">domain capabilities</a>,
+          <a href="formatstoragecaps.html">storage pool capabilities</a>,
           <a href="formatnode.html">node devices</a>,
           <a href="formatsecret.html">secrets</a>,
           <a href="formatsnapshot.html">snapshots</a></dd>
Unnamed repository; edit this file 'description' to name the repository.