Bug 907943
| Summary: | [RHEVM-SHELL][TEXT] misleading help for command "connect" | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Virtualization Manager | Reporter: | Petr Spacek <pspacek> |
| Component: | ovirt-engine-cli | Assignee: | Ravi Nori <rnori> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Ilia Meerovich <iliam> |
| Severity: | unspecified | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 3.1.2 | CC: | acathrow, bazulay, iheim, jkt, oramraz, pspacek, Rhev-m-bugs |
| Target Milestone: | --- | Keywords: | Reopened |
| Target Release: | 3.3.0 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | infra | ||
| Fixed In Version: | is3 | Doc Type: | Bug Fix |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2013-02-05 16:16:23 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | Infra | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
|
Description
Petr Spacek
2013-02-05 15:07:36 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. (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? (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. [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)]# Closing - RHEV 3.3 Released Closing - RHEV 3.3 Released Closing - RHEV 3.3 Released |