[libvirt] [PATCH 05/10] docs: storage: Document <auth> element

[Cole Robinson <crobinso@xxxxxxxxxx>]

Signed-off-by: Cole Robinson <crobinso@xxxxxxxxxx>
---
 docs/formatstorage.html.in |    8 ++++++++
 docs/storage.html.in       |    1 +
 2 files changed, 9 insertions(+), 0 deletions(-)

diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in
index 7ececed..855d475 100644
--- a/docs/formatstorage.html.in
+++ b/docs/formatstorage.html.in
@@ -70,6 +70,7 @@
         &lt;source&gt;
           &lt;host name="iscsi.example.com"/&gt;
           &lt;device path="demo-target"/&gt;
+          &lt;auth type="chap" login="foobar" passwd="foo-passwd"/&gt;
         &lt;/source&gt;
         ...</pre>
 
@@ -103,6 +104,13 @@
         type, or network filesystem type, or partition table type, or
         LVM metadata type. All drivers are required to have a default
         value for this, so it is optional. <span class="since">Since 0.4.1</span></dd>
+      <dt><code>auth</code></dt>
+      <dd>Provides login information for an iSCSI pools server.
+      <code>type</code> is a required attribute which specifies the
+      authentication method. Currently only <code>chap</code>
+      (challenge-handshake) is supported. <code>login</code> and
+      <code>passwd</code> specify the login and password respectively.
+        <span class="since">Since 0.4.1</span></dd>
     </dl>
 
     <h3><a name="StoragePoolTarget">Target elements</a></h3>
diff --git a/docs/storage.html.in b/docs/storage.html.in
index 904fc7c..a3399c6 100644
--- a/docs/storage.html.in
+++ b/docs/storage.html.in
@@ -329,6 +329,7 @@ libvirt.
         &lt;source&gt;
           &lt;host name="iscsi.example.com"/&gt;
           &lt;device path="demo-target"/&gt;
+          &lt;auth type="chap" login="foobar" passwd="foo-passwd"/&gt;
         &lt;/source&gt;
         &lt;target&gt;
           &lt;path&gt;/dev/disk/by-path&lt;/path&gt;
-- 
1.6.6

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list