Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.
Red Hat Satellite engineering is moving the tracking of its product development work on Satellite to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "Satellite project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs will be migrated starting at the end of May. If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "Satellite project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/SAT-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.

Bug 1666687

Summary: output format for hammer help command is inconsistent
Product: Red Hat Satellite Reporter: Jameer Pathan <jpathan>
Component: HammerAssignee: satellite6-bugs <satellite6-bugs>
Status: CLOSED ERRATA QA Contact: Jameer Pathan <jpathan>
Severity: low Docs Contact:
Priority: low    
Version: 6.5.0CC: apatel, dhlavacd, egolov, kgaikwad, mbacovsk, mhulan, mshira, ofedoren, rabajaj, ymakias
Target Milestone: 6.7.0Keywords: AutomationBlocker, Triaged
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: tfm-rubygem-hammer_cli_foreman-0.19.0,tfm-rubygem-hammer_cli_foreman_virt_who_configure-0.0.5 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2020-04-14 15:54:08 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:

Description Jameer Pathan 2019-01-16 11:20:16 UTC
Description of problem:
output format of help for some hammer command is inconsistent

Version-Release number of selected component (if applicable):
@satellite 6.5.0 snap 11

How reproducible:
always

Steps to Reproduce:
1. output format of help for some hammer command is inconsistent
2. It should be like <shortname>, <name>, <value>, <description>
3. commands are:
- hammer virt-who-config fetch 
- hammer report-template create
- hammer report-template update
 
Actual results:
hammer > virt-who-config > fetch
--------------------------------
Renders a deploy script for the specified virt-who configuration

Usage:
    hammer > virt-who-config > fetch [OPTIONS]

Options:
 --id ID                                  
 --location LOCATION_NAME                Location name
 --location-id LOCATION_ID                
 --location-title LOCATION_TITLE         Location title
 --name NAME                             Name to search by
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 --output, -o FILE                       File where the script will be written.
 -h, --help                              Print help

Expected results:
Usage:
    hammer > virt-who-config > fetch [OPTIONS]

Options:
 --id ID                                  
 --location LOCATION_NAME                Location name
 --location-id LOCATION_ID                
 --location-title LOCATION_TITLE         Location title
 --name NAME                             Name to search by
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 -o, --output FILE                       File where the script will be written.
 -h, --help                              Print help

Additional info:

Comment 3 Oleh Fedorenko 2019-08-12 17:54:03 UTC
Created redmine issue https://projects.theforeman.org/issues/27597 from this bug

Comment 4 Bryan Kearney 2019-09-10 14:07:09 UTC
Moving this bug to POST for triage into Satellite 6 since the upstream issue https://projects.theforeman.org/issues/27597 has been resolved.

Comment 5 Jameer Pathan 2019-12-23 06:08:58 UTC
Verified

Verified with:
- Satellite 6.7.0 snap 6
- tfm-rubygem-hammer_cli_foreman_virt_who_configure-0.0.5-1.el7sat.noarch
- tfm-rubygem-hammer_cli_foreman-0.19.3-1.el7sat.noarch

Test steps:

Observation:
- Output format of hammer commands is consistent,
 <shortname>, <name>, <value>, <description>

hammer> virt-who-config fetch --help
Usage:
     virt-who-config fetch [OPTIONS]

Options:
 --id ID                                  
 --location LOCATION_NAME                Location name
 --location-id LOCATION_ID                
 --location-title LOCATION_TITLE         Location title
 --name NAME                             Name to search by
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 -h, --help                              Print help
 -o, --output FILE                       File where the script will be written

Comment 8 errata-xmlrpc 2020-04-14 15:54:08 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://access.redhat.com/errata/RHBA-2020:1455