2.3.2/man/vdeq.1

   1 .TH VDEQ 1 "December 6, 2006" "Virtual Distributed Ethernet"
   2 .SH NAME
   3 vdeq \- Virtual Distributed Ethernet wrapper for QEMU/KVM virtual machines
   4 .SH SYNOPSIS
   5 .B vdeq
   6 .B qemu
   7 [
   8 .B \-\-mod
   9 .I octalmode
  10 ]
  11 .I QEMU_OPTIONS
  12 .B -net vde[,vlan=n][,sock=socketpath][,port=n]
  13 .I QEMU_OPTIONS
  14 .br
  15 .B vdeq
  16 .B kvm
  17 [
  18 .B \-\-mod
  19 .I octalmode
  20 ]
  21 .I KVM_OPTIONS
  22 .B -net vde[,vlan=n][,sock=socketpath][,port=n]
  23 .I KVM_OPTIONS
  24 .br
  25 .B vde\fP{\fIqemu_name\fP}
  26 [
  27 .B \-\-mod
  28 .I octalmode
  29 ]
  30 .I QEMU_OPTIONS
  31 .B -net vde[,vlan=n][,sock=socketpath][,port=n]
  32 .I QEMU_OPTIONS
  33 .br
  34
  35 .SH OLD SYNOPSIS
  36 .B vdeq
  37 .B qemu
  38 [
  39 .B \-\-mod
  40 .I octalmode
  41 ]
  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/KVM virtual machine connected to a VDE network.
  71 It uses the qemu/kvm \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 The command
  83 .RS
  84 .br
  85 .B
  86 vdeq kvm -b c -hda=sampledisk
  87 .RE
  88 starts a kvm machine which boots from the sampledisk image and
  89 has a ne2000 ethernet interface connected to the standard vde_switch.
  90 .br
  91
  92 It is also possible to create symbolic links to the vdeq executable to have
  93 a simpler command. If the link has a name that begins with vde the remaining part
  94 of the name is taken as the qemu command. For example if vdeq is linked to
  95 vdeqemu:
  96 .RS
  97 .br
  98 .B
  99 vdeqemu -b c -hda=sampledisk
 100 .RE
 101 starts qemu as above. If vdeq is linked to vdekvm:
 102 .RS
 103 .br
 104 .B
 105 vdekvm -b c -hda=sampledisk
 106 .RE
 107 starts kvm with the same parameters.
 108
 109 The new syntax is consistent with the new Qemu 0.8.0 network parameters.
 110 Using vdeq is possible to specify a vde interface in the same way as
 111 user,tap or socket interfaces.
 112 The \fBsock=\fP parameter can be used to use a specific socket.
 113 Please note that what qemu names as vlan is not related to the
 114 802.1q VLAN managed by the vde_switch.
 115 \fBport=\fP can be used to specify the port of the switch,
 116 otherwise the first allocatable port is assigned.
 117 The following command run a qemu VM with two ethernet interface
 118 connected to the standard switch and
 119 to the switch with local socket "/tmp/my.ctl", port 10, respectively
 120 .RS
 121 .br
 122 .B
 123 vde qemu -net nic,vlan=0 -net nic,vlan=1 -net vde,vlan=0 -net vde,vlan=1,sock=/tmp/my.ctl,port=10
 124 .RE
 125 .RS
 126 .br
 127 .B
 128 vdeqemu -net nic,vlan=0 -net nic,vlan=1 -net vde,vlan=0 -net vde,vlan=1,sock=/tmp/my.ctl,port=10
 129 .RE
 130 The following command run a kvm VM with two ethernet interface
 131 connected to the standard switch and
 132 to the switch with local socket "/tmp/my.ctl", port 10, respectively
 133 .RS
 134 .br
 135 .B
 136 vde kvm -net nic,vlan=0 -net nic,vlan=1 -net vde,vlan=0 -net vde,vlan=1,sock=/tmp/my.ctl,port=10
 137 .RE
 138 .RS
 139 .br
 140 .B
 141 vdekvm -net nic,vlan=0 -net nic,vlan=1 -net vde,vlan=0 -net vde,vlan=1,sock=/tmp/my.ctl,port=10
 142 .RE
 143
 144 The old syntax can be used with Qemu 0.8.0 but all the vde interfaces are assigned to
 145 vlan 0.
 146 .RS
 147 .br
 148 .B
 149 vdeq qemu -sock /tmp/vde.ctl,/tmp/my.ctl -b c -hda=sampledisk
 150 .RE
 151 .RS
 152 .br
 153 .B
 154 vdeqemu -sock /tmp/vde.ctl,/tmp/my.ctl -b c -hda=sampledisk
 155 .RE
 156 both start qemu with \fBone\fP ethernet interface connected both to the standard switch and
 157 to the switch with local socket "/tmp/my.ctl".
 158
 159 .SH OPTIONS
 160 .TP
 161 .B --mod
 162 .I octalmode,
 163 specify the mode for comm socket.
 164 .br
 165 .TP
 166 .B \-sock
 167 .I socketpath,
 168 specify the UNIX socket to be used by local programs for joining the VDE.
 169 The default value is "/tmp/vde.ctl"
 170 It is also possible to indicate several socketpath (comma separated, no blanks):
 171 in this case several interfaces are defined. The first socketpath is connected
 172 to the first ne2k interface and so on.
 173 .br
 174 .TP
 175 .B -h, -help, --help
 176 print a Usage help.
 177 .SH NOTE
 178 Qemu has changed its syntax for networking (cvs Nov.15 2005).
 179 As a temporary solution use vdeoq and vdeoqemu instead of vdeq and vdeqemu
 180 if you are running a qemu with the old syntax.
 181 .br
 182 By default qemu uses the same MAC address for every virtual machine, so if
 183 you plan to use several instances of qemu be sure to explicitly set a different
 184 MAC address for each virtual machine. While generating your address beware to
 185 not use broadcast/multicast reserved MACs, ethernet rules say: the multicast
 186 bit is the low-order bit of the first byte, which is "the first bit on the wire".
 187 For example \fI34:12:de:ad:be:ef\fP is an unicast address, \fI35:12:de:ad:be:ef\fP
 188 is a multicast address (see ETHERNET MULTICAST ADDRESSES section in
 189 http://www.iana.org/assignments/ethernet-numbers for more informations).
 190 .br
 191 .SH NOTICE
 192 Virtual Distributed Ethernet is not related in any way with
 193 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
 194 i.e. the German "Association for Electrical, Electronic & Information
 195 Technologies").
 196
 197 .SH SEE ALSO
 198 \fBvde_switch\fP(1),
 199 \fBvde_plug\fP(1),
 200 \fBvde_plug2tap\fP(1),
 201 \fBdpipe\fP(1).
 202 .br
 203 .SH AUTHOR
 204 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>