2.3.2/man/vde_switch.1

   1 .TH VDE_SWITCH 1 "December 6, 2006" "Virtual Distributed Ethernet"
   2 .SH NAME
   3 vde_switch \- Virtual Distributed Ethernet switch
   4 .SH SYNOPSIS
   5 .B vde_switch
   6 [
   7 .B \-hub
   8 ]
   9 [
  10 .BI \-sock
  11 .I commdirpath
  12 ]
  13 [
  14 .BI \-mod
  15 .I octal-mode
  16 ]
  17 [
  18 .BI \-group
  19 .I NAME
  20 ]
  21 [
  22 .BI \-tap
  23 .I interface
  24 ]
  25 [
  26 .BI \-daemon
  27 ]
  28 .br
  29 .SH DESCRIPTION
  30 A
  31 \fBvde_switch\fP
  32 is a virtual switch for the vde architecture.
  33 .br
  34 A vde network can include several vde_switches running on different
  35 (real) computers.
  36 vde_switches can be connected by vde cables (see
  37 \fBvde_plug (1)\fP
  38 ).
  39 .br
  40 Supported architecture for VDE end nodes include:
  41 real linux boxes (through the tuntap interface),
  42 bochs, qemu and MPS virtual machines.
  43 .br
  44 VDE is useful to create networks of heterogeneous virtual machines as
  45 well as as a general tunneling tool -- all the ethernet based protocols work
  46 by this kind of tunnel -- and also as a tool for mobility.
  47 In fact VDE creates an overlay network where users can keep their IP
  48 addresses despite of the change of IP addresses on the interfaces.
  49
  50 vde_switch needs root privileges to open a tap interface, can be run by
  51 users when no -tap option is specified.
  52
  53 vde-2 has several features: VLAN, Fast Spanning Tree Protocol, command line management
  54 (on console for foreground switches, on a terminal for daemonized switches).
  55 If a vde_switch run in foreground mode simply type return to have the prompt.
  56 For daemons there is the -M option to specify the management socket. Unixterm is the tool
  57 to start a terminal for the management.
  58 Type "help" at the prompt for a list of possible options.
  59
  60 .SH OPTIONS
  61 .TP
  62 .B \-hub
  63 turn off the switch engine. It operates as a hub.
  64 .TP
  65 .B \-sock "\fIcommdirpath\fP"
  66 specify the directory when comm socket are created.
  67 The default value is "/tmp/vde.ctl"
  68 .TP
  69 .B \-mod "\fIoctalmode\fP"
  70 specify the octal permissions for the comm sockets.
  71 .TP
  72 .B \-group "\fINAME\fP"
  73 specify the group owner for the comm socket.
  74 The default value is the current user's primary group
  75 .TP
  76 .B \-tap "\fIinterface\fP"
  77 connect the specified tuntap interface to this vde_switch (needs root privileges)
  78 It is possible to specify several tap interfaces, comma separated.
  79 .TP
  80 .B \-daemon
  81 Run as a daemon. Use syslog for logging.
  82 .TP
  83 .B \-f rcfile
  84 rc file to set the initial switch configuration. This rc file has the same syntax of
  85 the command line interface.
  86 .TP
  87 .B \-h
  88 help. Please use it for a more complete list of options.
  89 vde_switch is a modular program, options vary depending of the compiled-in modules.
  90 .SH NOTICE
  91 Virtual Distributed Ethernet is not related in any way with
  92 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
  93 i.e. the German "Association for Electrical, Electronic & Information
  94 Technologies").
  95
  96 .SH SEE ALSO
  97 \fBvde_plug\fP(1),
  98 \fBvde_plug2tap\fP(1),
  99 \fBvdeq\fP(1),
 100 \fBdpipe\fP(1),
 101 \fBunixterm\fP(1).
 102 .br
 103 .SH AUTHOR
 104 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>
 105 .br
 106 VDE started as an enhancement of uml_switch by Jeff Dike and others.
 107 VDE-2 has been almost completely rewritten but maybe some statements
 108 come from the historical source. So, some copyright and thanks also for Dike&Co.