File: formatstoragecaps.html

package info (click to toggle)
libvirt 5.6.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 240,844 kB
  • sloc: ansic: 584,521; xml: 176,725; sh: 9,912; python: 4,731; perl: 4,343; makefile: 3,321; ml: 465
file content (201 lines) | stat: -rw-r--r-- 7,654 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
  <!--
        This file is autogenerated from formatstoragecaps.html.in
        Do not edit this file. Changes will be lost.
      -->
  <!--
        This page was generated at Tue Jul 30 02:04:27 UTC 2019.
      -->
  <head>
    <meta charset="UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1"/>
    <link rel="stylesheet" type="text/css" href="main.css"/>
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"/>
    <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/>
    <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/>
    <link rel="manifest" href="/manifest.json"/>
    <meta name="theme-color" content="#ffffff"/>
    <title>libvirt: Storage Pool Capabilities XML format</title>
    <meta name="description" content="libvirt, virtualization, virtualization API"/>
    <script type="text/javascript" src="js/main.js">
      <!--// forces non-empty element-->
    </script>
  </head>
  <body onload="pageload()">
    <div id="body">
      <div id="content">
        <h1>Storage Pool Capabilities XML format</h1>
        <ul>
          <li>
            <a href="#Overview">Overview</a>
          </li>
          <li>
            <a href="#elements">Element and attribute overview</a>
          </li>
        </ul>
        <h2>
          <a id="Overview">Overview</a>
          <a class="headerlink" href="#Overview" title="Permalink to this headline">¶</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>
          <a class="headerlink" href="#elements" title="Permalink to this headline">¶</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;/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>targetFormatType</code></dt><dd>Lists all the possible <code>volOptions</code> target volume
            format types.
            </dd></dl>
        </dd>
          </dl>
        </dl>
      </div>
    </div>
    <div id="nav">
      <div id="home">
        <a href="index.html">Home</a>
      </div>
      <div id="jumplinks">
        <ul>
          <li>
            <a href="downloads.html">Download</a>
          </li>
          <li>
            <a href="contribute.html">Contribute</a>
          </li>
          <li>
            <a href="docs.html">Docs</a>
          </li>
        </ul>
      </div>
      <div id="search">
        <form id="simplesearch" action="https://www.google.com/search" enctype="application/x-www-form-urlencoded" method="get">
          <div>
            <input id="searchsite" name="sitesearch" type="hidden" value="libvirt.org"/>
            <input id="searchq" name="q" type="text" size="12" value=""/>
            <input name="submit" type="submit" value="Go"/>
          </div>
        </form>
        <div id="advancedsearch">
          <span>
            <input type="radio" name="what" id="whatwebsite" checked="checked" value="website"/>
            <label for="whatwebsite">Website</label>
          </span>
          <span>
            <input type="radio" name="what" id="whatwiki" value="wiki"/>
            <label for="whatwiki">Wiki</label>
          </span>
          <span>
            <input type="radio" name="what" id="whatdevs" value="devs"/>
            <label for="whatdevs">Developers list</label>
          </span>
          <span>
            <input type="radio" name="what" id="whatusers" value="users"/>
            <label for="whatusers">Users list</label>
          </span>
        </div>
      </div>
    </div>
    <div id="footer">
      <div id="contact">
        <h3>Contact</h3>
        <ul>
          <li>
            <a href="contact.html#email">email</a>
          </li>
          <li>
            <a href="contact.html#irc">irc</a>
          </li>
        </ul>
      </div>
      <div id="community">
        <h3>Community</h3>
        <ul>
          <li>
            <a href="https://twitter.com/hashtag/libvirt">twitter</a>
          </li>
          <li>
            <a href="http://stackoverflow.com/questions/tagged/libvirt">stackoverflow</a>
          </li>
          <li>
            <a href="http://serverfault.com/questions/tagged/libvirt">serverfault</a>
          </li>
        </ul>
      </div>
      <div id="conduct">
            Participants in the libvirt project agree to abide by <a href="governance.html#codeofconduct">the project code of conduct</a></div>
      <br class="clear"/>
    </div>
  </body>
</html>