Bug 1584243
| Summary: | some lsmcli list types allows more optional arguments than allowed in manpage | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 7 | Reporter: | Jakub Krysl <jkrysl> |
| Component: | libstoragemgmt | Assignee: | Tony Asleson <tasleson> |
| Status: | CLOSED ERRATA | QA Contact: | Jakub Krysl <jkrysl> |
| Severity: | unspecified | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 7.5 | CC: | tasleson |
| Target Milestone: | rc | ||
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | If docs needed, set a value | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2019-08-06 12:40:24 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
Jakub Krysl
2018-05-30 14:30:26 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. 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. (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. (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. 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 |