Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.
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 1303770

Summary: Document new options of multipath command that add machine-readable/parseable output
Product: Red Hat Enterprise Linux 6 Reporter: Steven J. Levine <slevine>
Component: doc-DM_MultipathAssignee: Steven J. Levine <slevine>
Status: CLOSED CURRENTRELEASE QA Contact: ecs-bugs
Severity: medium Docs Contact:
Priority: unspecified    
Version: 6.8CC: adstrong, agk, bdonahue, bmarzins, dwysocha, heinzm, lilin, msnitzer, prajnoha, prockai, rbalakri, rhel-docs, scott.rochford, zkabelac
Target Milestone: rcKeywords: Documentation
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: 1145442
: 1310185 1376206 (view as bug list) Environment:
Last Closed: 2016-09-15 17:19:59 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:
Bug Depends On: 1145442    
Bug Blocks: 1299651, 1310185, 1376206    

Comment 2 Steven J. Levine 2016-02-02 16:44:18 UTC
Ben:

It looks as though I don't document the "multipathd show" command at all in the current DM-Multipath manual. Do you think we should add a table similar to this one for multipath:

http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/DM_Multipath/multipath_options.html

If so, do you have suggestions for what we might include in that table?

Also:

For RHEL 7, we added a statement at the end of that table about using multipathd with wildcards -- which is odd because we don't otherwise talk about multipathd display commands, just multipath commands so I think I may have been confused when I added that. In any case, do we now add a similar sentence to the 6.8 version:

http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/DM_Multipath/multipath_options.html

Steven

Comment 3 Ben Marzinski 2016-02-12 19:23:41 UTC
I don't know if we need to do anything like comprehensive documentation on the multipathd commands, but we should mention that there are a number of them, and they aren't just for troubleshooting. Most of the functionality of the multipath command also exists in multipathd commands. The document does point the reader to the help command, which is good. It would also be good to mention that you don't need to enter the interactive mode to issue these commands, simply running

# multipathd <command> <arguments>

will issue the command and print the results. We might want to call special attention to the format commands (and starting in RHEL-6.8 and RHEL-7.3, the raw format commands).

They are

list|show maps|multipaths format $format
list|show paths format $format
list|show maps|multipaths raw format $format
list|show paths raw format $format

The difference between the raw and the regular versions is that with the raw versions, no headers are printed, and the fields are not padded to appear in nice columns. Instead they print out exactly as specified in the format string.
This is helpful for scripting.

The wildcards that are used in the format string can be shown with the wildcard command.

Also, starting in RHEL-7.3 and RHEL-6.9 (not the upcoming RHEL6 release, the one after it), there will be two additional commands

list|show pathgroups format $format
list|show pathgroups raw format $format

To display pathgroup information.