Bug 1615680

Summary:	Improve --adapter-parent-wwnn,--adapter-parent-wwpn and --adapter-parent-fabric-wwn info for pool-define-as in man page
Product:	Red Hat Enterprise Linux 7	Reporter:	Meina Li <meili>
Component:	libvirt	Assignee:	John Ferlan <jferlan>
Status:	CLOSED ERRATA	QA Contact:	gaojianan <jgao>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	7.6	CC:	dyuan, hhan, jdenemar, jferlan, lmen, tburke, xuzhang, yisun
Target Milestone:	rc
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:	libvirt-4.5.0-12.el7	Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2019-08-06 13:13:56 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 Meina Li 2018-08-14 03:11:25 UTC

Description of problem:
Perfect --adapter-parent-wwnn,--adapter-parent-wwpn and --adapter-parent-fabric-wwn for pool-define-as in man page

Version-Release number of selected component (if applicable):
libvirt-4.5.0-6.el7.x86_64

How reproducible:
100%

Steps to Reproduce:
# man virsh
...
pool-define-as name type [--source-host hostname] [--source-path path] [--source-dev path] [--source-name name] [--target path] [--source-format format] [--auth-type authtype --auth-username username [--secret-usage usage | --secret-uuid uuid]] [[--adapter-name name] | [--adapter-wwnn --adapter-wwpn] [--adapter-parent parent]][--print-xml]
...

Actual results:
no relevant explanation for --adapter-parent-wwnn,--adapter-parent-wwpn and --adapter-parent-fabric-wwn in pool-define-as command

Expected results:
Supplement related information

Additional info:
Related patch:
https://bugzilla.redhat.com/show_bug.cgi?id=1601377#c8

John Ferlan 2018-08-13 08:26:22 EDT
Hmmm, strange. Neglected to update the pool-create-as item list, but I did add the descriptions for each later in the description section:

See the series:
https://www.redhat.com/archives/libvir-list/2018-March/msg00458.html

and in particular patch 3:
https://www.redhat.com/archives/libvir-list/2018-March/msg00461.html

This was committed upstream here:

$ git show d45bee449c52c25a80dc61cb5af8fab7d77446e9
commit d45bee449c52c25a80dc61cb5af8fab7d77446e9
Author: John Ferlan <jferlan>
Date:   Thu Mar 8 18:17:10 2018 -0500

    tools: Add support for additional adapter parent options
    
    Add the ability to provide the adapter parent_wwnn and parent_wwpn
    or the parent_fabric_wwn on the virsh command line for the pool
    define/create as commands.  Update the virsh.pod description.
    
    Signed-off-by: John Ferlan <jferlan>
...

I just posted a patch upstream to add the strings to the virsh.pod item list:

https://www.redhat.com/archives/libvir-list/2018-August/msg00661.html

Comment 5 John Ferlan 2018-08-14 11:34:02 UTC

Patch posted upstream:

https://www.redhat.com/archives/libvir-list/2018-August/msg00661.html

and pushed:

$ git show
commit b0451117b399df8107340dee8b653cb48e8da1c8
Author: John Ferlan <jferlan>
Date:   Mon Aug 13 08:19:30 2018 -0400

    virsh: Add missed fields to pool-define-as item entry
    
...
    
    Commit id d45bee449 updated the pool-define-as qualifier descriptions
    to add some new fields, but neglected to modify the command item list
    in order to add those fields as well.
    
    Signed-off-by: John Ferlan <jferlan>

$ git describe b0451117b399df8107340dee8b653cb48e8da1c8
v4.6.0-163-gb0451117b3
$

Comment 9 gaojianan 2019-04-16 06:54:27 UTC

Verified on version:
libvirt-4.5.0-12.virtcov.el7.x86_64

Step:
# man virsh 
....
       pool-create-as name type [--source-host hostname] [--source-path path] [--source-dev path]
       [--source-name name] [--target path] [--source-format format] [--auth-type authtype --auth-username
       username [--secret-usage usage | --secret-uuid uuid]] [[--adapter-name name] | [--adapter-wwnn wwnn
       --adapter-wwpn wwpn] [--adapter-parent parent | --adapter-parent-wwnn parent_wwnn adapter-parent-
       wwpn parent_wwpn | --adapter-parent-fabric-wwn parent_fabric_wwn]] [--build] [[--overwrite] |
       [--no-overwrite]] [--print-xml]
....
           [--adapter-wwnn wwnn --adapter-wwpn wwpn [--adapter-parent parent | --adapter-parent-wwnn
           parent_wwnn adapter-parent-wwpn parent_wwpn | --adapter-parent-fabric-wwn parent_fabric_wwn]]
           defines the wwnn and wwpn to be used for the fc_host adapter type pool.  Optionally provide the
           parent scsi_hostN node device to be used for the vHBA either by parent name, parent_wwnn and
           parent_wwpn, or parent_fabric_wwn.  The parent name could change between reboots if the
           hardware environment changes, so providing the parent_wwnn and parent_wwpn ensure usage of the
           same physical HBA even if the scsi_hostN node device changes. Usage of the parent_fabric_wwn
           allows a bit more flexibility to choose an HBA on the same storage fabric in order to define
           the pool.

Show as expected

Comment 11 errata-xmlrpc 2019-08-06 13:13:56 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-2019:2294