Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1081010

Summary: RHEVM-CLI: branding issue in help message
Product: Red Hat Enterprise Virtualization Manager Reporter: Ilia Meerovich <iliam>
Component: ovirt-engine-cliAssignee: Martin Perina <mperina>
Status: CLOSED CURRENTRELEASE QA Contact: Ondra Machacek <omachace>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 3.4.0CC: aberezin, acathrow, gklein, iheim, juan.hernandez, ncredi, omachace, oramraz, pstehlik, Rhev-m-bugs, yeylon
Target Milestone: ---   
Target Release: 3.4.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard: infra
Fixed In Version: rhevm-cli-3.4.0.6-3.el6ev Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2014-06-12 14:06:14 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:
Attachments:
Description Flags
Path to fix branding in help text none

Description Ilia Meerovich 2014-03-26 13:33:41 UTC
please search for ovirt in help message:

imeerovi@imeerovi ~/git/ART (regression-mixed-unittest) $ rhevm-shell 


  =========================================================================================================================================================================================================================================
                                                                                                    >>> connected to RHEVM manager 3.4.0.0 <<<
  =========================================================================================================================================================================================================================================

  +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

                                                                                                           Welcome to RHEVM shell

  +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++


[RHEVM shell (connected)]# help

INTRODUCTION
  
  Welcome to RHEVM-shell. This program is an interactive command-line
  interface into RHEVM Virtualization. You can type any command in 
  the interface below.
  
AVAILABLE COMMANDS
  
    * action           execute an action on an object
    * add              creates a new object or adds existent
    * capabilities     displaying system capabilities
    * clear            clear the screen
    * connect          connect to a oVirt manager
    * console          open a console to a VM
    * disconnect       disconnect from oVirt manager
    * exit             quit this interactive terminal
    * help             show help
    * history          displaying commands history
    * info             shows environment and application components info
    * list             list or search objects
    * ping             test the connection
    * remove           removes an object
    * show             show one object
    * status           shows last command status
    * summary          displaying the system status
    * update           update an object
  
  Type 'help <command>' for any of these commands to show detailed help.
  The first command you probably want to issue is 'help connect' to
  learn how to connect to a oVirt manager.
  
COMMAND SYNTAX
  
  The general format for each command is:
  
    help <command> <command attributes> [command options]
  
  If arguments contain spaces or other reserved characters, you need to
  quote them. You can use single (') and double (") quotes for this. The
  difference between single and double quotes is that within single
  quotes you can't use any single quotes, while in double quotes you can
  use a double quote provided that you escape it with backslash ('\').
  
  Options are always in the long form: --option [value]. The value can
  be optional or mandatory, depending on the command, see command help
  for details.
  
  In addition to the basic command form, the following functionality is
  available:
  
    * You can use the '<', '<<', '>' and '>>' characters to perform
      shell-like redirections to files in the file system.
    * The output of any command can be piped to a shell command with
      the '|' character.
    * Shell commands can be executed by typing a '!' or 'shell' at the 
      beginning of a line.
    * Comments start with '#' and end at the end of a line.
      
EXAMPLES
  
  See 'SUPPORTED HELP FORMATS' section under each command help.
  
CONFIGURATION FILE
  
  oVirt-Shell can be configured with configuration file, configuration file
  ( ~/.ovirtshellrc) automatically created under your home directory (if not exist)
  at first ovirt-shell execution.
  
[RHEVM shell (connected)]# exit


  =========================================================================================================================================================================================================================================
                                                                                                   >>> disconnected from RHEVM manager <<<
  =========================================================================================================================================================================================================================================

imeerovi@imeerovi ~/git/ART (regression-mixed-unittest) $ rpm -q rhevm-cli
rhevm-cli-3.4.0.6-2.el6ev.noarch
imeerovi@imeerovi ~/git/ART (regression-mixed-unittest) $

Comment 1 Ilia Meerovich 2014-03-26 13:49:30 UTC
Juan,

By the way:

In rhevmshellrc exists [ovirt-shell] and not [rhevm-shell]:

imeerovi@imeerovi ~/git/ART (regression-mixed-unittest) $ cat ~/.rhevmshellrc 
[cli]
autoconnect = True
autopage = False
[ovirt-shell]
username = admin@internal
timeout = None
extended_prompt = False
url = https://ilia-rhevm.qa.lab.tlv.redhat.com:443/api
insecure = True
renew_session = False
filter = False
session_timeout = None
ca_file = None
dont_validate_cert_chain = False
key_file = None
password = ********
cert_file = None

Comment 2 Juan Hernández 2014-03-26 14:08:01 UTC
We will fix the branding issue in the help text, but we can't change the name of the section of the .rhevmshellrc file, as it has always being named "ovirt-shell" and changing it would break backwards compatibility.

Comment 3 Juan Hernández 2014-03-26 14:10:57 UTC
Created attachment 879013 [details]
Path to fix branding in help text

Comment 4 Ondra Machacek 2014-04-30 09:04:47 UTC
Ok in av7.

[RHEVM shell (connected)]# help

INTRODUCTION
  
  Welcome to rhevm-shell. This program is an interactive command-line
  interface into Red Hat Enterprise Virtualization. You can type any
  command in the interface below.
  
AVAILABLE COMMANDS
  
    * action           execute an action on an object
    * add              creates a new object or adds existent
    * capabilities     displaying system capabilities
    * clear            clear the screen
    * connect          connect to a RHEV manager
    * console          open a console to a VM
    * disconnect       disconnect from RHEV manager
    * exit             quit this interactive terminal
    * help             show help
    * history          displaying commands history
    * info             shows environment and application components info
    * list             list or search objects
    * ping             test the connection
    * remove           removes an object
    * show             show one object
    * status           shows last command status
    * summary          displaying the system status
    * update           update an object
  
  Type 'help <command>' for any of these commands to show detailed help.
  The first command you probably want to issue is 'help connect' to
  learn how to connect to a RHEV manager.
  
COMMAND SYNTAX
  
  The general format for each command is:
  
    help <command> <command attributes> [command options]
  
  If arguments contain spaces or other reserved characters, you need to
  quote them. You can use single (') and double (") quotes for this. The
  difference between single and double quotes is that within single
  quotes you can't use any single quotes, while in double quotes you can
  use a double quote provided that you escape it with backslash ('\').
  
  Options are always in the long form: --option [value]. The value can
  be optional or mandatory, depending on the command, see command help
  for details.
  
  In addition to the basic command form, the following functionality is
  available:
  
    * You can use the '<', '<<', '>' and '>>' characters to perform
      shell-like redirections to files in the file system.
    * The output of any command can be piped to a shell command with
      the '|' character.
    * Shell commands can be executed by typing a '!' or 'shell' at the 
      beginning of a line.
    * Comments start with '#' and end at the end of a line.
      
EXAMPLES
  
  See 'SUPPORTED HELP FORMATS' section under each command help.
  
CONFIGURATION FILE
  
  rhevm-shell can be configured with configuration file, configuration file
  ( ~/.rhevmshellrc) automatically created under your home directory (if not exist)
  at first rhevm-shell execution.

Comment 5 Itamar Heim 2014-06-12 14:06:14 UTC
Closing as part of 3.4.0