From: John Ferlan Date: Thu, 7 Feb 2019 20:26:00 +0000 (-0500) Subject: docs: Add description for Storage Pool Capabilities X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=784cd46fb8cd6c5208490ca2c4e0dd94437961a8;p=libvirt.git docs: Add description for Storage Pool Capabilities Signed-off-by: John Ferlan ACKed-by: Michal Privoznik --- diff --git a/docs/docs.html.in b/docs/docs.html.in index 40e0e3b82e..d0ff844d0c 100644 --- a/docs/docs.html.in +++ b/docs/docs.html.in @@ -77,6 +77,7 @@ storage encryption, capabilities, domain capabilities, + storage pool capabilities, node devices, secrets, snapshots diff --git a/docs/format.html.in b/docs/format.html.in index 22b23e3fc7..640a9957ee 100644 --- a/docs/format.html.in +++ b/docs/format.html.in @@ -21,6 +21,7 @@
  • Storage encryption
  • Capabilities
  • Domain capabilities
    • +
  • Storage Pool capabilities
  • Node devices
  • Secrets
  • Snapshots
    • diff --git a/docs/formatstoragecaps.html.in b/docs/formatstoragecaps.html.in new file mode 100644 index 0000000000..2813d061b0 --- /dev/null +++ b/docs/formatstoragecaps.html.in @@ -0,0 +1,108 @@ + + + + +

    Storage Pool Capabilities XML format

    + +
      + +

      Overview

      + +

      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.

      + +

      The Storage Pool Capabilities XML provides more information than the + + virConnectGetCapabilities + + which only provides an enumerated list of supported pool types.

      + +

      Element and attribute overview

      + +

      A query interface was added to the virConnect API's to retrieve the + XML listing of the set of Storage Pool Capabilities + (Since 5.2.0):

      + +
      +virConnectGetStoragePoolCapabilities
+
      + +

      The root element that emulator capability XML document starts with is + named storagepoolCapabilities. There will be any number of + pool child elements with two attributes type + and supported. Each pool element may have + a poolOptions or volOptions subelements to + describe the available features. Sample XML output is:

      + +
      +<storagepoolCapabilities>
+  <pool type='dir' supported='yes'>
+    <volOptions>
+      <defaultFormat type='raw'</>
+      <enum name='targetFormatType'>
+        <value>none</value>
+        <value>raw</value>
+        ...
+      </enum>
+    </volOptions>
+  </pool>
+  <pool type='fs' supported='yes'>
+    <poolOptions>
+      <defaultFormat type='auto'</>
+      <enum name='sourceFormatType'>
+        <value>auto</value>
+        <value>ext2</value>
+        ...
+      </enum>
+      <enum name='requiredSourceElements'>
+        <value>device</value>
+      </enum>
+    </poolOptions>
+    <volOptions>
+      <defaultFormat type='raw'</>
+      <enum name='targetFormatType'>
+        <value>none</value>
+        <value>raw</value>
+        ...
+      </enum>
+    </volOptions>
+  </pool>
+  ...
+</storagepoolCapabilities>
+
      + +

      The following section decribes subelements of the + poolOptions and volOptions subelements

      : + +
      +
      defaultFormat
      +
      For the poolOptions, the type attribute + describes the default format name used for the pool source. For the + volOptions, the type attribute describes + the default volume name used for each volume. +
      +
      +
      enum
      +
      Each enum uses a name from the list below with any number of + value value subelements describing the valid values. +
      +
      sourceFormatType
      +
      Lists all the possible poolOptions source + pool format types. +
      +
      requiredSourceElements
      +
      Lists all the required poolOptions source + subelements required for a valid source pool element. +
      +
      targetFormatType
      +
      Lists all the possible volOptions target volume + format types. +
      +
      +
      +
      +
      + + diff --git a/docs/index.html.in b/docs/index.html.in index 1f9f448399..f593445d06 100644 --- a/docs/index.html.in +++ b/docs/index.html.in @@ -66,6 +66,7 @@ storage encryption, capabilities, domain capabilities, + storage pool capabilities, node devices, secrets, snapshots