Bug 907943 - [RHEVM-SHELL][TEXT] misleading help for command "connect"
Summary: [RHEVM-SHELL][TEXT] misleading help for command "connect"
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: ovirt-engine-cli
Version: 3.1.2
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: 3.3.0
Assignee: Ravi Nori
QA Contact: Ilia Meerovich
URL:
Whiteboard: infra
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-02-05 15:07 UTC by Petr Spacek
Modified: 2016-02-10 19:22 UTC (History)
7 users (show)

Fixed In Version: is3
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-02-05 16:16:23 UTC
oVirt Team: Infra
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
oVirt gerrit 11939 0 None None None Never

Description Petr Spacek 2013-02-05 15:07:36 UTC
Description of problem:
rhevm-shell do not allow to use "show" command before connection.

Version-Release number of selected component (if applicable):
rhevm-cli-3.1.1.2-1.el6ev.noarch

How reproducible:
100 %

Steps to Reproduce:
1. $ rhevm-shell
2. [RHEVM shell (disconnected)]# show
  
Actual results:
error: command "show" not valid or not available while not connected.

Expected results:
Current content of variables is shown.

Additional info:
[RHEVM shell (disconnected)]# help connect
point to show command, which is unavailable:

[RHEVM shell (disconnected)]# help connect
<snip>  
DESCRIPTION
  
  Connect to a oVirt manager. This command has two forms. In the first
  form, no arguments are provided, and the connection details are read
  from their respective configuration variables (see 'show'). In
  the second form, the connection details are provided as arguments.

Comment 1 Michael Pasternak 2013-02-05 16:16:23 UTC
(In reply to comment #0)
> Description of problem:
> rhevm-shell do not allow to use "show" command before connection.
> 
> Version-Release number of selected component (if applicable):
> rhevm-cli-3.1.1.2-1.el6ev.noarch
> 
> How reproducible:
> 100 %
> 
> Steps to Reproduce:
> 1. $ rhevm-shell
> 2. [RHEVM shell (disconnected)]# show
>   
> Actual results:
> error: command "show" not valid or not available while not connected.

this is by-design, there is no point in any command while you're not connected/authenticated.

> 
> Expected results:
> Current content of variables is shown.

/show command not used to show the variables, but remote content which
is obviously not available while user not authenticated.

> 
> Additional info:
> [RHEVM shell (disconnected)]# help connect
> point to show command, which is unavailable:
> 
> [RHEVM shell (disconnected)]# help connect
> <snip>  
> DESCRIPTION
>   
>   Connect to a oVirt manager. This command has two forms. In the first
>   form, no arguments are provided, and the connection details are read
>   from their respective configuration variables (see 'show'). In
>   the second form, the connection details are provided as arguments.

Comment 2 Petr Spacek 2013-02-06 08:09:46 UTC
(In reply to comment #1)
> (In reply to comment #0)
> > Expected results:
> > Current content of variables is shown.
> 
> /show command not used to show the variables, but remote content which
> is obviously not available while user not authenticated.
> 
> > 
> > Additional info:
> > [RHEVM shell (disconnected)]# help connect
> > point to show command, which is unavailable:
> > 
> > [RHEVM shell (disconnected)]# help connect
> > <snip>  
> > DESCRIPTION
> >   
> >   Connect to a oVirt manager. This command has two forms. In the first
> >   form, no arguments are provided, and the connection details are read
> >   from their respective configuration variables (see 'show'). In
> >   the second form, the connection details are provided as arguments.

Ok, after this explanation I would morph this bug to "error in help text". Text above ^^^ is very confusing. I don't see a reason why "show" command is mentioned in help for "connect" if "show" can't show anything at the moment.

Do you agree?

Comment 3 Michael Pasternak 2013-02-06 10:55:28 UTC
(In reply to comment #2)
> (In reply to comment #1)
> > (In reply to comment #0)
> > > Expected results:
> > > Current content of variables is shown.
> > 
> > /show command not used to show the variables, but remote content which
> > is obviously not available while user not authenticated.
> > 
> > > 
> > > Additional info:
> > > [RHEVM shell (disconnected)]# help connect
> > > point to show command, which is unavailable:
> > > 
> > > [RHEVM shell (disconnected)]# help connect
> > > <snip>  
> > > DESCRIPTION
> > >   
> > >   Connect to a oVirt manager. This command has two forms. In the first
> > >   form, no arguments are provided, and the connection details are read
> > >   from their respective configuration variables (see 'show'). In
> > >   the second form, the connection details are provided as arguments.
> 
> Ok, after this explanation I would morph this bug to "error in help text".
> Text above ^^^ is very confusing. I don't see a reason why "show" command is
> mentioned in help for "connect" if "show" can't show anything at the moment.
> 
> Do you agree?

ok, now i got you, [1] is a typo in the /connect help indeed.

[1]

  Connect to a oVirt manager. This command has two forms. In the first
  form, no arguments are provided, and the connection details are read
  from their respective configuration variables (see 'show'). In
  the second form, the connection details are provided as arguments.

Comment 6 Ilia Meerovich 2013-07-03 11:05:16 UTC
[imeerovi@imeerovi storage_api]$ rpm -q rhevm-cli
rhevm-cli-3.3.0.3-1.el6ev.noarch
[imeerovi@imeerovi storage_api]$ 
[imeerovi@imeerovi storage_api]$ /usr/bin/rhevm-shell -c --url=https://ilia-rhevm.qa.lab.tlv.redhat.com:443/api/ -u admin@internal -I


 ==========================================
 >>> connected to RHEVM manager 3.3.0.0 <<<
 ==========================================


        
 ++++++++++++++++++++++++++++++++++++++++++
 
           Welcome to RHEVM shell
 
 ++++++++++++++++++++++++++++++++++++++++++
        
    
[RHEVM shell (connected)]# help connect

USAGE
  
  connect
  connect <url> <username> <password> [command options]
  
DESCRIPTION
  
  Connect to a oVirt manager. This command has two forms. In the first
  form, no arguments are provided, and the connection details are read
  from their respective configuration variables. In the second form,
  the connection details are provided as arguments.
  
  The arguments are:
  
   * url               - The URL to connect to (http[s]://server[:port]/api).
   * username          - The user to connect as. (user@domain).
   * password          - The password to use.
   * [key-file]        - The client PEM key file to use.
   * [cert-file]       - The client PEM certificate file to use.
   * [ca-file]         - The server CA certificate file to use.
   * [filter]          - Enables user permission based filtering.
   * [insecure]        - Allow connecting to SSL sites without certificates.
   * [port]            - The port to use (if not specified in url).
   * [timeout]         - The request timeout.
   * [session-timeout] - The authentication session timeout (0 disables session expiry).
  
[RHEVM shell (connected)]#

Comment 7 Itamar Heim 2014-01-21 22:27:06 UTC
Closing - RHEV 3.3 Released

Comment 8 Itamar Heim 2014-01-21 22:27:37 UTC
Closing - RHEV 3.3 Released

Comment 9 Itamar Heim 2014-01-21 22:30:17 UTC
Closing - RHEV 3.3 Released


Note You need to log in before you can comment on or make changes to this bug.