RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 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 "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". 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 "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-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 1584243 - some lsmcli list types allows more optional arguments than allowed in manpage
Summary: some lsmcli list types allows more optional arguments than allowed in manpage
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: libstoragemgmt
Version: 7.5
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: rc
: ---
Assignee: Tony Asleson
QA Contact: Jakub Krysl
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2018-05-30 14:30 UTC by Jakub Krysl
Modified: 2021-09-03 14:14 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-08-06 12:40:24 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHBA-2019:2064 0 None None None 2019-08-06 12:40:29 UTC

Description Jakub Krysl 2018-05-30 14:30:26 UTC 
Description of problem:
According to manpage these should not work but they do:
lsmcli list --type FS --fs FS_ID
lsmcli list --type SNAPSHOTS --pool ID
lsmcli list --type SNAPSHOTS --vol ID
lsmcli list --type SNAPSHOTS --disk ID
lsmcli list --type SNAPSHOTS --ag ID
lsmcli list --type SNAPSHOTS --nsf_export ID
lsmcli list --type SNAPSHOTS --tgt ID
Other commands are restricted as expected.

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

How reproducible:
100%

Steps to Reproduce:
lsmcli list --type FS --fs FS_ID
lsmcli list --type SNAPSHOTS --pool ID
lsmcli list --type SNAPSHOTS --vol ID
lsmcli list --type SNAPSHOTS --disk ID
lsmcli list --type SNAPSHOTS --ag ID
lsmcli list --type SNAPSHOTS --nsf_export ID
lsmcli list --type SNAPSHOTS --tgt ID

Actual results:
pass

Expected results:
lsmcli: error: Search key 'XXXXX' is not supported by XXXXX listing.

Additional info:
Comment 2 Tony Asleson 2018-12-07 22:46:37 UTC 
This command should work
$ lsmcli list --type FS --fs FS_ID

The other with snapshot queries examples should be failing for:

$ lsmcli -u sim:// list --type snapshots --pool POOL_ID_00004
sim_lsmplugin: error: --fs <file system id> required


However, there is indeed an issue where you can do this:

$ lsmcli -u sim:// list --type snapshots --fs FS_ID_00001 --pool what_the_what --disk blahblah
ID               | Name       | Time Stamp         
---------------------------------------------------
FS_SNAP_ID_00001 | awesome_ss | 2018-12-07 16:36:40

We only support one filter argument when doing listings and that needs to be
enforced too.
Comment 5 Jakub Krysl 2019-01-18 12:53:49 UTC 
Hi Tony,
I was testing with libstoragemgmt-1.7.2-1.el7.x86_64 and still found one issue in manpage, details inline.

> This command should work
> $ lsmcli list --type FS --fs FS_ID
> 

Can you please add it to the manpage? I would expect to find it listed somewhere at the --fs, similar way --type VOLUMES is listed at --vol for example.
# man lsmcli:
--fs <FS_ID>   Required for --type=SNAPSHOTS, list the snapshots of certain filesystem.  Optional for type EXPORTS, list the NFS export for certain filesystem.

> The other with snapshot queries examples should be failing for:
> 
> $ lsmcli -u sim:// list --type snapshots --pool POOL_ID_00004
> sim_lsmplugin: error: --fs <file system id> required
> 

I am seeing this now, thanks. 

> However, there is indeed an issue where you can do this:
> 
> $ lsmcli -u sim:// list --type snapshots --fs FS_ID_00001 --pool
> what_the_what --disk blahblah
> ID               | Name       | Time Stamp         
> ---------------------------------------------------
> FS_SNAP_ID_00001 | awesome_ss | 2018-12-07 16:36:40
> 
> We only support one filter argument when doing listings and that needs to be
> enforced too.

This seems to be enforced now, thanks.


As this BZ is comparing manpage to actual behaviour, returning to fix the manpage.
Comment 6 Tony Asleson 2019-01-21 15:51:07 UTC 
(In reply to Jakub Krysl from comment #5)
> > This command should work
> > $ lsmcli list --type FS --fs FS_ID
> > 
> 
> Can you please add it to the manpage? I would expect to find it listed
> somewhere at the --fs, similar way --type VOLUMES is listed at --vol for
> example.
> # man lsmcli:
> --fs <FS_ID>   Required for --type=SNAPSHOTS, list the snapshots of certain
> filesystem.  Optional for type EXPORTS, list the NFS export for certain
> filesystem.

After reviewing the man page I don't think we are doing a good job at describing the cmd optional arguments for listing records.  For example if I run lsmcli list --help

cmd required arguments:
  --type <TYPE>         List records of type:
                            VOLUMES
                            POOLS
                            FS
                            SNAPSHOTS
                            EXPORTS
                            NFS_CLIENT_AUTH
                            ACCESS_GROUPS
                            SYSTEMS
                            DISKS
                            PLUGINS
                            TARGET_PORTS
                            BATTERIES
                        
                        When listing SNAPSHOTS, it requires --fs <FS_ID>.

cmd optional arguments:
  --sys <SYS_ID>        Search by System ID
  --pool <POOL_ID>      Search by Pool ID
  --vol <VOL_ID>        Search by Volume ID
  --disk <DISK_ID>      Search by Disk ID
  --ag <AG_ID>          Search by Access Group ID
  --fs <FS_ID>          File System ID
  --nfs-export <NFS_EXPORT_ID>
                        Search by NFS Export ID
  --tgt <TGT_ID>        Search by target port ID

Please write up a separate bug for this specific addition to the man page, thanks.
Comment 7 Jakub Krysl 2019-01-21 16:07:14 UTC 
(In reply to Tony Asleson from comment #6)
> Please write up a separate bug for this specific addition to the man page,
> thanks.

BZ 1667992 created.
As the rest of this BZ is verified, setting the state accordingly.
Comment 9 errata-xmlrpc 2019-08-06 12:40:24 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-2019:2064
Note You need to log in before you can comment on or make changes to this bug.