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 1481935 - Update the help description for "--sync-date" option in hammer.
Summary: Update the help description for "--sync-date" option in hammer.
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Sync Plans
Version: 6.2.9
Hardware: x86_64
OS: Linux
unspecified
low
Target Milestone: Unspecified
Assignee: satellite6-bugs
QA Contact: Nikhil Kathole
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-08-16 06:07 UTC by Prakash Ghadge
Modified: 2020-09-10 11:15 UTC (History)
8 users (show)

Fixed In Version: tfm-rubygem-hammer-cli-katello-0.11.0
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-02-21 17:08:02 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Foreman Issue Tracker 20613 0 None None None 2017-08-16 13:15:55 UTC

Description Prakash Ghadge 2017-08-16 06:07:33 UTC 
Description of problem:

Update the help description for "--sync-date" option in hammer.

Version-Release number of selected component (if applicable):

6.2.10

How reproducible:

Always

Steps to Reproduce:
1. hammer sync-plan create --help

2. Check the help summary of '--sync-date'
~~~
start date and time of the synchronization defaults to now                                              Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
~~~

The customer thinks this description is confusing. Prior to opening the case, the customer tried the following command to create sync plan thinking that the --sync-date option is not required as help says "--sync-date will default to now."

# hammer --password mypass sync-plan create --organization test --name "RedHat Software collections synch" --description "A synch plan for RHSC" --enabled True --interval "weekly"

It returns:
      Could not create the sync plan:
        Missing arguments for 'sync_date'

Expected result -

Can we change this help with some simple summary? I think the follwining line in help will be enough.
~~~
Provide Date and time in YYYY-MM-DD HH:MM:SS or in ISO 8601 format
~~~
Comment 1 Satellite Program 2017-08-17 18:03:34 UTC 
Moving this bug to POST for triage into Satellite 6 since the upstream issue http://projects.theforeman.org/issues/20613 has been resolved.
Comment 2 Nikhil Kathole 2017-09-24 09:08:25 UTC 
VERIFIED

Version Tested:
Satellite-6.3 Snap 17

steps:

# hammer sync-plan create --help
Usage:
    hammer sync-plan create [OPTIONS]

Options:
 --description DESCRIPTION               sync plan description
 --enabled ENABLED                       enables or disables synchronization
                                         One of true/false, yes/no, 1/0.
 --interval INTERVAL                     how often synchronization should run
                                         Possible value(s): 'hourly', 'daily', 'weekly'
 --name NAME                             sync plan name
 --organization ORGANIZATION_NAME        Organization name to search by
 --organization-id ORGANIZATION_ID       organization ID
 --organization-label ORGANIZATION_LABEL Organization label to search by
 --sync-date SYNC_DATE                   Start date and time for the sync plan.Time is optional, if kept blank current system time will be considered
                                         Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
 -h, --help                              print help

Found description changed from 
" start date and time of the synchronization defaults to now
  Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format"
to
"Start date and time for the sync plan.Time is optional, if kept blank current system time will be considered
 Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format".
Comment 3 Bryan Kearney 2018-02-21 17:08:02 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/RHSA-2018:0336
Note You need to log in before you can comment on or make changes to this bug.