From nobody Sun Feb 8 16:30:50 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1549985344797683.0017753292518; Tue, 12 Feb 2019 07:29:04 -0800 (PST) Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 6C98989AD5; Tue, 12 Feb 2019 15:29:01 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id F20D05E81C; Tue, 12 Feb 2019 15:29:00 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id AF07B3F60A; Tue, 12 Feb 2019 15:29:00 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id x1CFSt6L024167 for ; Tue, 12 Feb 2019 10:28:55 -0500 Received: by smtp.corp.redhat.com (Postfix) id 946DF17997; Tue, 12 Feb 2019 15:28:55 +0000 (UTC) Received: from unknown0050b6a41c42.attlocal.net.com (ovpn-117-20.phx2.redhat.com [10.3.117.20]) by smtp.corp.redhat.com (Postfix) with ESMTP id 4C3BF2CFAA for ; Tue, 12 Feb 2019 15:28:55 +0000 (UTC) From: John Ferlan To: libvir-list@redhat.com Date: Tue, 12 Feb 2019 10:28:12 -0500 Message-Id: <20190212152816.3454-14-jferlan@redhat.com> In-Reply-To: <20190212152816.3454-1-jferlan@redhat.com> References: <20190212152816.3454-1-jferlan@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH v2 13/17] docs: Add description for Storage Pool Capabilities X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.26]); Tue, 12 Feb 2019 15:29:03 +0000 (UTC) Content-Type: text/plain; charset="utf-8" Signed-off-by: John Ferlan --- docs/docs.html.in | 1 + docs/format.html.in | 1 + docs/formatstoragecaps.html.in | 108 +++++++++++++++++++++++++++++++++ docs/index.html.in | 1 + 4 files changed, 111 insertions(+) create mode 100644 docs/formatstoragecaps.html.in 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<= /li>

diff --git a/docs/formatstoragecaps.html.in b/docs/formatstoragecaps.html.in new file mode 100644 index 0000000000..7f0641a3a8 --- /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.1.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=3D'dir' supported=3D'yes'>
+    <volOptions>
+      <defaultFormat type=3D'raw'</>
+      <enum name=3D'targetFormatType'>
+        <value>none</value>
+        <value>raw</value>
+        ...
+      </enum>
+    </volOptions>
+  </pool>
+  <pool type=3D'fs' supported=3D'yes'>
+    <poolOptions>
+      <defaultFormat type=3D'auto'</>
+      <enum name=3D'sourceFormatType'>
+        <value>auto</value>
+        <value>ext2</value>
+        ...
+      </enum>
+      <enum name=3D'requiredSourceElements'>
+        <value>device</value>
+      </enum>
+    </poolOptions>
+    <volOptions>
+      <defaultFormat type=3D'raw'</>
+      <enum name=3D'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. +

+ + 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 --=20 2.20.1 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list