Bug 1351455

Summary:	heketi-cli should display help, when invoked
Product:	[Red Hat Storage] Red Hat Gluster Storage	Reporter:	Anoop <annair>
Component:	heketi	Assignee:	Michael Adam <madam>
Status:	CLOSED ERRATA	QA Contact:	Prasanth <pprakash>
Severity:	high	Docs Contact:
Priority:	unspecified
Version:	rhgs-3.1	CC:	amainkar, hchiramm, madam, mliyazud, mzywusko, pprakash, rcyriac
Target Milestone:	---	Keywords:	ZStream
Target Release:	CNS 3.4
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2017-01-18 21:55:38 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:
Bug Depends On:
Bug Blocks:	1385246

Description Anoop 2016-06-30 06:39:12 UTC

heketi-cli should at least display help, when invoked.

Presently, you get nothing in the o/p, should give usage/help.

[root@dhcp42-41 ~]# heketi-cli 
[root@dhcp42-41 ~]#

Comment 2 Humble Chirammal 2016-07-04 11:26:04 UTC

Yes, by default it can list the the commands and options, in short '--help' o/p.

Comment 3 Luis Pabón 2016-07-06 16:25:35 UTC

Good catch: https://github.com/heketi/heketi/issues/415

Comment 4 Mohamed Ashiq 2016-07-07 02:49:43 UTC

PR : https://github.com/heketi/heketi/pull/410

Comment 11 Prasanth 2016-10-28 07:22:27 UTC

Verified as Fixed.


#########
# rpm -qa |grep heketi-client
heketi-client-3.0.0-1.el7rhgs.x86_64


# heketi-cli
Usage:
  heketi-cli [flags]
  heketi-cli [command]

Examples:
  $ export HEKETI_CLI_SERVER=http://localhost:8080
  $ heketi-cli volume list

Available Commands:
  cluster                        Heketi cluster management
  device                         Heketi device management
  node                           Heketi Node Management
  setup-openshift-heketi-storage Setup OpenShift/Kubernetes persistent storage for Heketi
  topology                       Heketi Topology Management
  volume                         Heketi Volume Management

Flags:
  -h, --help                           help for heketi-cli
      --json                           
        Print response as JSON
      --log-flush-frequency duration   Maximum number of seconds between log flushes (default 5s)
      --secret string                  
        Secret key for specified user.  Can also be
        set using the environment variable HEKETI_CLI_KEY
  -s, --server string                  
        Heketi server. Can also be set using the
        environment variable HEKETI_CLI_SERVER
      --user string                    
        Heketi user.  Can also be set using the
        environment variable HEKETI_CLI_USER
  -v, --version                        
        Print version

Use "heketi-cli [command] --help" for more information about a command.
#########

Comment 13 errata-xmlrpc 2017-01-18 21:55:38 UTC

Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://rhn.redhat.com/errata/RHEA-2017-0148.html