From 7e29a1a2496a922457bdeb02332e9b78c97b4d81 Mon Sep 17 00:00:00 2001
From: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
Date: Wed, 22 Mar 2017 12:43:20 +0530
Subject: gluster-block: support json response

This is how cli response looks like, on supplying '--json*' flag to cmd-args:

$ gluster-block create block-test/sample-block1 ha 1 localhost.localdomain 1GiB --json
                                (or)
$ gluster-block create block-test/sample-block2 ha 1 localhost.localdomain 1GiB --json-spaced
{ "IQN": "iqn.2016-12.org.gluster-block:681af106-85f1-4a02-a122-57c80903458c", \
  "PORTAL(S)": [ "localhost.localdomain:3260" ], "RESULT": "SUCCESS" }

$ gluster-block create block-test/sample-block3 ha 1 localhost.localdomain 1GiB --json-plain
{"IQN":"iqn.2016-12.org.gluster-block:0fdf6647-57f2-477f-8dd4-54a3de06e410",\
  "PORTAL(S)":["localhost.localdomain:3260"],"RESULT":"SUCCESS"}

$ gluster-block create block-test/sample-block4 ha 1 localhost.localdomain 1GiB --json-pretty
{
  "IQN":"iqn.2016-12.org.gluster-block:e92ca4a0-5325-4c4b-a407-9e75790e4c7f",
  "PORTAL(S)":[
    "localhost.localdomain:3260"
  ],
  "RESULT":"SUCCESS"
}

Change-Id: Ie51039e3dee0b3357d2347b4087e0fbe299aa29e
Fixes: #3
Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
---
 docs/gluster-block.8 | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'docs')

diff --git a/docs/gluster-block.8 b/docs/gluster-block.8
index f50e95c..66d29e7 100644
--- a/docs/gluster-block.8
+++ b/docs/gluster-block.8
@@ -12,6 +12,7 @@ gluster-block - Gluster Block Storage Console Manager (command line utility)
 <\fBcreate|list|info|delete\fR>
 <\fBvolname\fR[\fB/blockname\fR]>
 [\fB<args>\fR]
+[\fB--json*\fR]
 .PP
 
 
@@ -62,6 +63,8 @@ show this message and exit.
 show version info and exit.
 .PP
 
+.SH SUPPORTED JSON-FORMATS
+--json | --json-plain | --json-spaced | --json-pretty
 
 .SH EXAMPLES
 .nf
@@ -71,6 +74,9 @@ To create a block device of size 1GiB
 To create a block device of size 1GiB with multi-path(replica) 3
 .B # gluster-block create blockVol/sampleBlock ha 3 ${HOST1},${HOST2},${HOST3} 1GiB
 
+To create a block device of size 1GiB and expect response in json format
+.B # gluster-block create blockVol/sampleBlock ${HOST} 1GiB --json
+
 You can pass more no. of nodes than ha count, this will actually help create in recovering from
 failures, incase creation of block fails on any of scheduled(always first in list) ha count nodes.
 .B # gluster-block create blockVol/sampleBlock ha 3 ${HOST1},${HOST2},${HOST3},${HOST4},${HOST5} 1GiB
-- 
cgit