[Kimchi-devel] [PATCH 2/8] Storage Pools: Update docs/API.md

Aline Manera alinefm at linux.vnet.ibm.com
Tue Jan 13 19:16:41 UTC 2015


'adapter_name' is a required parameter for a SCSI FC pool.
Also add 'persistent' parameter to storage pool information.

Signed-off-by: Aline Manera <alinefm at linux.vnet.ibm.com>
---
 docs/API.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/docs/API.md b/docs/API.md
index 67997ea..8c01c2f 100644
--- a/docs/API.md
+++ b/docs/API.md
@@ -417,7 +417,7 @@ A interface represents available network interface on VM.
                              Pool types: 'iscsi'.
             * username: Login username of the iSCSI target.
             * password: Login password of the iSCSI target.
-        * adapter_name *(optional)*: Scsi host name.
+        * adapter_name: Scsi host name.
 
 ### Resource: Storage Pool
 
@@ -444,9 +444,12 @@ A interface represents available network interface on VM.
     * nr_volumes: The number of storage volumes for active pools, 0 for inactive pools
     * autostart: Whether the storage pool will be enabled
                  automatically when the system boots
+    * persistent: True, when pool persist after a system reboot or be stopped.
+                  All storage pools created by Kimchi are persistent.
     * source: Source of the storage pool,
         * addr: mount address of this storage pool(for 'netfs' pool)
         * path: export path of this storage pool(for 'netfs' pool)
+
 * **PUT**: Set whether the Storage Pool should be enabled automatically when the
            system boots
     * autostart: Toggle the autostart flag of the VM. This flag sets whether
-- 
2.1.0




More information about the Kimchi-devel mailing list