~ubuntu-branches/ubuntu/maverick/libvirt/maverick

« back to all changes in this revision

Viewing changes to docs/formatstorage.html

  • Committer: Bazaar Package Importer
  • Author(s): Soren Hansen
  • Date: 2009-02-11 01:01:42 UTC
  • mto: (3.4.1 sid) (1.2.1 upstream) (0.2.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 34.
  • Revision ID: james.westby@ubuntu.com-20090211010142-wk9mgtbw8bmp3zcb
Tags: upstream-0.6.0
ImportĀ upstreamĀ versionĀ 0.6.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
131
131
                <a href="#StorageVolFirst">General metadata</a>
132
132
              </li><li>
133
133
                <a href="#StorageVolTarget">Target elements</a>
 
134
              </li><li>
 
135
                <a href="#StorageVolBacking">Backing store elements</a>
134
136
              </li></ul>
135
137
          </li><li>
136
138
            <a href="#examples">Example configuration</a>
328
330
        ...
329
331
        &lt;target&gt;
330
332
          &lt;path&gt;/var/lib/virt/images/sparse.img&lt;/path&gt;
 
333
          &lt;format&gt;qcow2&lt;/format&gt;
331
334
          &lt;permissions&gt;
332
335
            &lt;owner&gt;0744&lt;/owner&gt;
333
336
            &lt;group&gt;0744&lt;/group&gt;
334
337
            &lt;mode&gt;0744&lt;/mode&gt;
335
338
            &lt;label&gt;virt_image_t&lt;/label&gt;
336
339
          &lt;/permissions&gt;
337
 
        &lt;/target&gt;
338
 
      &lt;/volume&gt;</pre>
 
340
        &lt;/target&gt;</pre>
339
341
        <dl><dt><code>path</code></dt><dd>Provides the location at which the volume can be accessed on
340
342
        the local filesystem, as an absolute path. This is a readonly
341
343
        attribute, so shouldn't be specified when creating a volume.
356
358
        contains the MAC (eg SELinux) label string.
357
359
        <span class="since">Since 0.4.1</span>
358
360
      </dd></dl>
 
361
        <h3>
 
362
          <a name="StorageVolBacking" id="StorageVolBacking">Backing store elements</a>
 
363
        </h3>
 
364
        <p>
 
365
      A single <code>backingStore</code> element is contained within the top level
 
366
      <code>volume</code> element. This tag is used to describe the optional copy
 
367
      on write, backing store for the storage volume. It can contain the following
 
368
      child elements:
 
369
    </p>
 
370
        <pre>
 
371
        ...
 
372
        &lt;backingStore&gt;
 
373
          &lt;path&gt;/var/lib/virt/images/master.img&lt;/path&gt;
 
374
          &lt;format&gt;raw&lt;/format&gt;
 
375
          &lt;permissions&gt;
 
376
            &lt;owner&gt;0744&lt;/owner&gt;
 
377
            &lt;group&gt;0744&lt;/group&gt;
 
378
            &lt;mode&gt;0744&lt;/mode&gt;
 
379
            &lt;label&gt;virt_image_t&lt;/label&gt;
 
380
          &lt;/permissions&gt;
 
381
        &lt;/backingStore&gt;
 
382
      &lt;/volume&gt;</pre>
 
383
        <dl><dt><code>path</code></dt><dd>Provides the location at which the backing store can be accessed on
 
384
        the local filesystem, as an absolute path. If omitted, there is no
 
385
        backing store for this volume.
 
386
        <span class="since">Since 0.6.0</span></dd><dt><code>format</code></dt><dd>Provides information about the pool specific backing store format.
 
387
        For disk pools it will provide the partition type. For filesystem
 
388
        or directory pools it will provide the file format type, eg cow,
 
389
        qcow, vmdk, raw. Consult the pool-specific docs for the list of valid
 
390
        values. Most file formats require a backing store of the same format,
 
391
        however, the qcow2 format allows a different backing store format.
 
392
        <span class="since">Since 0.6.0</span></dd><dt><code>permissions</code></dt><dd>Provides information about the permissions of the backing file.
 
393
        It contains 4 child elements. The
 
394
        <code>mode</code> element contains the octal permission set. The
 
395
        <code>owner</code> element contains the numeric user ID. The <code>group</code>
 
396
        element contains the numeric group ID. The <code>label</code> element
 
397
        contains the MAC (eg SELinux) label string.
 
398
        <span class="since">Since 0.6.0</span>
 
399
      </dd></dl>
359
400
        <h2>
360
401
          <a name="examples" id="examples">Example configuration</a>
361
402
        </h2>