Bug 689747

Summary: virt-install: --serial udp docs mention nonexistent option 'bind_port'
Product: Red Hat Enterprise Linux 6 Reporter: Nan Zhang <nzhang>
Component: python-virtinstAssignee: Cole Robinson <crobinso>
Status: CLOSED ERRATA QA Contact: Virtualization Bugs <virt-bugs>
Severity: medium Docs Contact:
Priority: medium    
Version: 6.1CC: dyuan, hjiang, llim
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
No description necessary
 Story Points: ---
Clone Of: Environment:
Last Closed: 2011-12-06 16:16:07 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Nan Zhang 2011-03-22 11:06:55 UTC 
Description of problem:
As virt-install man page described, using 'bind_port' with udp serial, but failure was occurred.

--serial udp,host=CONNECT_HOST:PORT,bind_port=BIND_HOST:BIND_PORT

Version-Release number of selected component (if applicable):
libvirt-0.8.7-13.el6.x86_64
python-virtinst-0.500.5-2.el6.noarch

How reproducible:
Always

Steps to Reproduce:
# virt-install -n test1 -r 512 -f /var/lib/libvirt/images/test1.img -s 6 -c /var/lib/libvirt/boot/Fedora-14-i686-Live-Desktop.iso --vnc --serial udp,host=127.0.0.1:4555,bind_port=127.0.0.1:4556
  
Actual results:
ERROR    Error in serial device parameters: Unknown options ['bind_port']

Expected results:
no error.

Additional info:
Comment 1 Cole Robinson 2011-03-22 20:43:27 UTC 
The man page was just wrong in this case, the correct parameter name is 'bind_host'. I've fixed the docs upstream:

http://git.fedorahosted.org/git?p=python-virtinst.git;a=commit;h=4b53899460e04dcc64fde40cb2fec7791fdd9b90
Comment 2 RHEL Program Management 2011-04-04 02:14:59 UTC 
Since RHEL 6.1 External Beta has begun, and this bug remains
unresolved, it has been rejected as it is not proposed as
exception or blocker.

Red Hat invites you to ask your support representative to
propose this request, if appropriate and relevant, in the
next release of Red Hat Enterprise Linux.
Comment 3 Cole Robinson 2011-04-07 15:47:23 UTC 
Deferring to 6.2
Comment 4 Cole Robinson 2011-07-28 15:34:13 UTC 
Fixed in python-virtinst-0.600.0-1.el6
Comment 6 Huming Jiang 2011-08-02 06:02:38 UTC 
Could still reproduce this bug in the following componets:
python-virtinst-0.600.0-1.el6.
libvirt-0.9.4-0rc1.el6.x86_64
kernel-2.6.32-171.el6.x86_64
qemu-kvm-0.12.1.2-2.174.el6.x86_64

How reproducible:
Always

Steps to Reproduce:
# virt-install -n demo -r 512 -f /var/lib/libvirt/images/demo.img -s 5 -c /dev/cdrom --vnc --serial udp,host=127.0.0.1:4555,bind_port=127.0.0.1:4556

Actual results:
ERROR    Error in serial device parameters: Unknown options ['bind_port']
Expected results:
no error.
Comment 7 Cole Robinson 2011-08-02 16:15:09 UTC 
Regenerated man pages in python-virtinst-0.600.0-2.el6
Comment 8 Huming Jiang 2011-08-03 08:10:57 UTC 
Verified with the following components:
libvirt-0.9.4-0rc1.2.el6.x86_64
kernel-2.6.32-171.el6.x86_64
python-virtinst-0.600.0-2.el6.noarch
qemu-kvm-0.12.1.2-2.175.el6.x86_64

Steps:
# virt-install -n test -r 512 -f /var/lib/libvirt/images/test.img -s 5 -c /dev/cdrom --vnc --serial udp,host=127.0.0.1:4555,bind_port=127.0.0.1:4556

Starting install...
Allocating 'test.img'                                    | 5.0 GB     00:00     
Creating domain...                                       |    0 B     00:00     
Guest installation complete... restarting guest
...
# virsh dumpxml test
...
    <serial type='udp'>
      <source mode='bind' host='127.0.0.1' service='4556'/>
      <source mode='connect' host='127.0.0.1' service='4555'/>
      <target port='0'/>
      <alias name='serial0'/>
    </serial>
...
Comment 9 Huming Jiang 2011-08-03 08:15:29 UTC 
(In reply to comment #8)
> Verified with the following components:
> libvirt-0.9.4-0rc1.2.el6.x86_64
> kernel-2.6.32-171.el6.x86_64
> python-virtinst-0.600.0-2.el6.noarch
> qemu-kvm-0.12.1.2-2.175.el6.x86_64
> 
> Steps:
> # virt-install -n test -r 512 -f /var/lib/libvirt/images/test.img -s 5 -c
> /dev/cdrom --vnc --serial udp,host=127.0.0.1:4555,bind_port=127.0.0.1:4556

Sorry, i have copied the wrong command. The correct is as shown belown:
# virt-install -n test -r 512 -f /var/lib/libvirt/images/test.img -s 5 -c /dev/cdrom --vnc --serial udp,host=127.0.0.1:4555,bind_host=127.0.0.1:4556

and we could see the following content in the man page:
#man virt-install
...
 --serial udp,host=CONNECT_HOST:PORT,bind_host=BIND_HOST:BIND_PORT
...


> Starting install...
> Allocating 'test.img'                                    | 5.0 GB     00:00     
> Creating domain...                                       |    0 B     00:00     
> Guest installation complete... restarting guest
> ...
> # virsh dumpxml test
> ...
>     <serial type='udp'>
>       <source mode='bind' host='127.0.0.1' service='4556'/>
>       <source mode='connect' host='127.0.0.1' service='4555'/>
>       <target port='0'/>
>       <alias name='serial0'/>
>     </serial>
> ...
Comment 10 Huming Jiang 2011-08-04 02:38:30 UTC 
According to comment 9, move the status to verified.
Comment 11 Cole Robinson 2011-11-07 16:50:54 UTC 
    Technical note added. If any revisions are required, please edit the "Technical Notes" field
    accordingly. All revisions will be proofread by the Engineering Content Services team.
    
    New Contents:
No description necessary
Comment 12 errata-xmlrpc 2011-12-06 16:16:07 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.

http://rhn.redhat.com/errata/RHBA-2011-1643.html