docs/formatstoragecaps.html.in

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html>
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4   <body>
   5     <h1>Storage Pool Capabilities XML format</h1>
   6
   7     <ul id="toc"></ul>
   8
   9     <h2><a id="Overview">Overview</a></h2>
  10
  11     <p>The Storage Pool Capabilities XML will provide the information
  12     to determine what types of Storage Pools exist, whether the pool is
  13     supported, and if relevant the source format types, the required
  14     source elements, and the target volume format types. </p>
  15
  16     <p>The Storage Pool Capabilities XML provides more information than the
  17       <a href="/html/libvirt-libvirt-host.html#virConnectGetCapabilities">
  18         <code>virConnectGetCapabilities</code>
  19       </a>
  20     which only provides an enumerated list of supported pool types.</p>
  21
  22     <h2><a id="elements">Element and attribute overview</a></h2>
  23
  24     <p>A query interface was added to the virConnect API's to retrieve the
  25     XML listing of the set of Storage Pool Capabilities
  26     (<span class="since">Since 5.2.0</span>):</p>
  27
  28 <pre>
  29 <a href="/html/libvirt-libvirt-domain.html#virConnectGetStoragePoolCapabilities">virConnectGetStoragePoolCapabilities</a>
  30 </pre>
  31
  32     <p>The root element that emulator capability XML document starts with is
  33     named <code>storagepoolCapabilities</code>. There will be any number of
  34     <code>pool</code> child elements with two attributes <code>type</code>
  35     and <code>supported</code>. Each <code>pool</code> element may have
  36     a <code>poolOptions</code> or <code>volOptions</code> subelements to
  37     describe the available features. Sample XML output is:</p>
  38
  39 <pre>
  40 &lt;storagepoolCapabilities&gt;
  41   &lt;pool type='dir' supported='yes'&gt;
  42     &lt;volOptions&gt;
  43       &lt;defaultFormat type='raw'&lt;/&gt;
  44       &lt;enum name='targetFormatType'&gt;
  45         &lt;value&gt;none&lt;/value&gt;
  46         &lt;value&gt;raw&lt;/value&gt;
  47         ...
  48       &lt;/enum&gt;
  49     &lt;/volOptions&gt;
  50   &lt;/pool&gt;
  51   &lt;pool type='fs' supported='yes'&gt;
  52     &lt;poolOptions&gt;
  53       &lt;defaultFormat type='auto'&lt;/&gt;
  54       &lt;enum name='sourceFormatType'&gt;
  55         &lt;value&gt;auto&lt;/value&gt;
  56         &lt;value&gt;ext2&lt;/value&gt;
  57         ...
  58       &lt;/enum&gt;
  59     &lt;/poolOptions&gt;
  60     &lt;volOptions&gt;
  61       &lt;defaultFormat type='raw'&lt;/&gt;
  62       &lt;enum name='targetFormatType'&gt;
  63         &lt;value&gt;none&lt;/value&gt;
  64         &lt;value&gt;raw&lt;/value&gt;
  65         ...
  66       &lt;/enum&gt;
  67     &lt;/volOptions&gt;
  68   &lt;/pool&gt;
  69   ...
  70 &lt;/storagepoolCapabilities&gt;
  71 </pre>
  72
  73     <p>The following section decribes subelements of the
  74     <code>poolOptions</code> and <code>volOptions</code> subelements </p>:
  75
  76     <dl>
  77       <dt><code>defaultFormat</code></dt>
  78       <dd>For the <code>poolOptions</code>, the <code>type</code> attribute
  79       describes the default format name used for the pool source. For the
  80       <code>volOptions</code>, the <code>type</code> attribute describes
  81       the default volume name used for each volume.
  82       </dd>
  83       <dl>
  84         <dt><code>enum</code></dt>
  85         <dd>Each enum uses a name from the list below with any number of
  86         <code>value</code> value subelements describing the valid values.
  87           <dl>
  88             <dt><code>sourceFormatType</code></dt>
  89             <dd>Lists all the possible <code>poolOptions</code> source
  90             pool format types.
  91             </dd>
  92             <dt><code>targetFormatType</code></dt>
  93             <dd>Lists all the possible <code>volOptions</code> target volume
  94             format types.
  95             </dd>
  96           </dl>
  97         </dd>
  98       </dl>
  99     </dl>
 100   </body>
 101 </html>