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 1667992 - Better describe optional arguments in manpage for listing records
Summary: Better describe optional arguments in manpage for listing records
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: libstoragemgmt
Version: 7.6
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: rc
: ---
Assignee: Tony Asleson
QA Contact: Jakub Krysl
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-01-21 16:06 UTC by Jakub Krysl
Modified: 2021-09-03 14:14 UTC (History)
0 users

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-08-06 12:40:28 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:34 UTC

Description Jakub Krysl 2019-01-21 16:06:11 UTC 
This is a follow up for BZ 1584243 to better describe optional arguments in manpage for listing records. This comment from the original BZ describe the issue:

--- Additional comment from Tony Asleson on 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 2 Tony Asleson 2019-02-11 21:48:10 UTC 
Updating command line help to include the following

...

cmd optional arguments:
  --sys <SYS_ID>        Search by System ID. Only supported for: 
                        (VOLUMES, POOLS, FS, DISKS, ACCESS_GROUPS,
                        TARGET_PORTS, BATTERIES)
  --pool <POOL_ID>      Search by Pool ID. Only supported for:
                        (VOLUMES, POOLS, FS)
  --vol <VOL_ID>        Search by Volume ID. Only supported for:
                        (VOLUMES, ACCESS_GROUPS)
  --disk <DISK_ID>      Search by Disk ID. Only supported for:
                        (DISKS)
  --ag <AG_ID>          Search by Access Group ID. Only supported for:
                        (ACCESS_GROUPS, VOLUMES)
  --fs <FS_ID>          Search by FS ID. Only supported for:
                        (FS, SNAPSHOTS, EXPORTS)
  --nfs-export <NFS_EXPORT_ID>
                        Search by NFS Export ID. Only supported for:
                        (EXPORTS)
  --tgt <TGT_ID>        Search by target port ID.  Only supported for:
                        (TARGET_PORTS)
Comment 4 Jakub Krysl 2019-03-28 11:48:20 UTC 
libstoragemgmt-1.7.3-2.el7.x86_64

# lsmcli list --help
usage: lsmcli list [-h] [-v] [-u <URI>] [-P] [-H] [-t <SEP>] [-e] [-f]
                   [-w CHILD_WAIT] [--header] [-b] [-s] --type <TYPE>
                   [--sys <SYS_ID>] [--pool <POOL_ID>] [--vol <VOL_ID>]
                   [--disk <DISK_ID>] [--ag <AG_ID>] [--fs <FS_ID>]
                   [--nfs-export <NFS_EXPORT_ID>] [--tgt <TGT_ID>]

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  -u <URI>, --uri <URI>
                        Uniform resource identifier (env LSMCLI_URI)
  -P, --prompt          Prompt for password (env LSMCLI_PASSWORD)
  -H, --human           Print sizes in human readable format
                        (e.g., MiB, GiB, TiB)
  -t <SEP>, --terse <SEP>
                        Print output in terse form with "SEP" as a record separator
  -e, --enum            Display enumerated types as numbers instead of text
  -f, --force           Bypass confirmation prompt for data loss operations
  -w CHILD_WAIT, --wait CHILD_WAIT
                        Command timeout value in ms (default = 30s)
  --header              Include the header with terse
  -b                    Run the command async. Instead of waiting for completion.
                         Command will exit(7) and job id written to stdout.
  -s, --script          Displaying data in script friendly way with additional information(if exists)

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. Only supported for:
                        (VOLUMES, POOLS, FS, DISKS, ACCESS_GROUPS,
                        TARGET_PORTS, BATTERIES)
  --pool <POOL_ID>      Search by Pool ID. Only supported for:
                        (VOLUMES, POOLS, FS)
  --vol <VOL_ID>        Search by Volume ID. Only supported for:
                        (VOLUMES, ACCESS_GROUPS)
  --disk <DISK_ID>      Search by Disk ID. Only supported for:
                        (DISKS)
  --ag <AG_ID>          Search by Access Group ID. Only supported for:
                        (ACCESS_GROUPS, VOLUMES)
  --fs <FS_ID>          Search by FS ID. Only supported for:
                        (FS, SNAPSHOTS, EXPORTS)
  --nfs-export <NFS_EXPORT_ID>
                        Search by NFS Export ID. Only supported for:
                        (EXPORTS)
  --tgt <TGT_ID>        Search by target port ID.  Only supported for:
                        (TARGET_PORTS)

The "only supported for" list for each command is complete and exact.
Comment 6 errata-xmlrpc 2019-08-06 12:40:28 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.