vde-2/doc/vdeq.1

   1 .\" Copyright (c) 2004-2005 Renzo Davoli
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" The GNU General Public License's references to "object code"
   9 .\" and "executables" are to be interpreted as the output of any
  10 .\" document formatting or typesetting system, including
  11 .\" intermediate and printed output.
  12 .\"
  13 .\" This manual is distributed in the hope that it will be useful,
  14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 .\" GNU General Public License for more details.
  17 .\"
  18 .\" You should have received a copy of the GNU General Public
  19 .\" License along with this manual; if not, write to the Free
  20 .\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
  21 .\" USA.
  22
  23 .TH VDEQ 1 "November 18, 2005" "Virtual Distributed Ethernet"
  24 .SH NAME
  25 vdeq \- Virtual Distributed Ethernet wrapper for QEMU virtual machines
  26 .SH SYNOPSIS
  27 .B vdeq
  28 .B qemu
  29 .I ... qemu options ...
  30 .B -net vde[,vlan=n][,sock=socketpath][,port=n]
  31 .I ... other qemu options ...
  32 .br
  33 .B vde\fP{\fIqemu_name\fP}
  34 .I ... qemu options ...
  35 .B -net vde[,vlan=n][,sock=socketpath][,port=n]
  36 .I ... other qemu options ...
  37 .br
  38
  39 .SH OLD SYNOPSIS
  40 .B vdeq
  41 .B qemu
  42 [
  43 .B \-sock
  44 .I socketpath
  45 [
  46 .I ,socketpath
  47 [
  48 .I ,...
  49 ]
  50 ]
  51 ]
  52 [ qemu_args ]
  53 .br
  54 .B vde\fP{\fIqemu_name\fP}
  55 [
  56 .B \-sock
  57 .I socketpath
  58 [
  59 .I ,socketpath
  60 [
  61 .I ,...
  62 ]
  63 ]
  64 ]
  65 [ qemu_args ]
  66
  67 .br
  68 .SH DESCRIPTION
  69 \fBvdeq\fP
  70 is a wrapper to start a QEMU virtual machine connected to a VDE network.
  71 It uses the qemu \fB \-tun-fd \fP parameter to set up the connection with
  72 a vde_switch.
  73
  74 The command
  75 .RS
  76 .br
  77 .B
  78 vdeq qemu -b c -hda=sampledisk
  79 .RE
  80 starts a qemu machine which boots from the sampledisk image and
  81 has a ne2000 ethernet interface connected to the standard vde_switch.
  82 .br
  83
  84 It is also possible to create symbolic links to the vdeq executable to have
  85 a simpler command. If the link has a name that begins with vde the remaning part
  86 of the name is taken as the qemu command. For example if vdeq is linked to
  87 vdeqemu:
  88 .RS
  89 .br
  90 .B
  91 vdeqemu -b c -hda=sampledisk
  92 .RE
  93 starts qemu as above.
  94
  95 The new syntax is consistent with the new Qemu 0.8.0 network parameters.
  96 Using vdeq is possible to specify a vde interface in the same way as
  97 user,tap or socket interfaces.
  98 The \fBsock=\fP parameter can be used to use a specific socket.
  99 Please note that what qemu names as vlan is not related to the
 100 802.1q VLAN managed by the vde_switch.
 101 \fBport=\fP can be used to specify the port of the switch,
 102 otherwise the first allocatable port is assigned.
 103 The following command run a qemu VM with two ethernet interface
 104 connected to the standard switch and
 105 to the switch with local socket "/tmp/my.ctl", port 10, respectively
 106 .RS
 107 .br
 108 .B
 109 vde qemu -net nic,vlan=0 -net nic,vlan=1 -net vde,vlan=0 -net vde,vlan=1,sock=/tmp/my.ctl,port=10
 110 .RE
 111 .RS
 112 .br
 113 .B
 114 vdeqemu -net nic,vlan=0 -net nic,vlan=1 -net vde,vlan=0 -net vde,vlan=1,sock=/tmp/my.ctl,port=10
 115 .RE
 116
 117 The old syntax can be used with Qemu 0.8.0 but all the vde interfaces are assigned to
 118 vlan 0.
 119 .RS
 120 .br
 121 .B
 122 vdeq qemu -sock /tmp/vde.ctl,/tmp/my.ctl -b c -hda=sampledisk
 123 .RE
 124 .RS
 125 .br
 126 .B
 127 vdeqemu -sock /tmp/vde.ctl,/tmp/my.ctl -b c -hda=sampledisk
 128 .RE
 129 both start qemu with \fBone\fP ethernet interface connected both to the standard switch and
 130 to the switch with local socket "/tmp/my.ctl".
 131
 132 .SH OPTIONS
 133 .TP
 134 .B \-sock
 135 .I socketpath,
 136 specify the UNIX socket to be used by local programs for joining the VDE.
 137 The default value is "/tmp/vde.ctl"
 138 It is also possible to indicate several socketpath (comma separated, no blanks):
 139 in this case several interfaces are defined. The first socketpath is connected
 140 to the first ne2k interface and so on.
 141 .br
 142 .TP
 143 .B -h, -help, --help
 144 print a Usage help.
 145 .SH NOTE
 146 Qemu has changed its syntax for networking (cvs Nov.15 2005).
 147 As a temporary solution use vdeoq and vdeoqemu instead of vdeq and vdeqemu
 148 if you are running a qemu with the old syntax.
 149 .br
 150 .SH NOTICE
 151 Virtual Distributed Ethernet is not related in any way with
 152 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
 153 i.e. the German "Association for Electrical, Electronic & Information
 154 Technologies").
 155
 156 .SH SEE ALSO
 157 .BR vde_switch (1),
 158 .BR vde_plug (1),
 159 .BR dpipe (1).
 160 .br
 161 .SH AUTHOR
 162 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>