vde-2/man/vde_plug.1

   1 .TH VDE_PLUG 1 "December 6, 2006" "Virtual Distributed Ethernet"
   2 .SH NAME
   3 vde_plug \- Virtual Distributed Ethernet plug (two plugs creates a vde cable)
   4 .SH SYNOPSIS
   5 .B vde_plug
   6 [
   7 .B \-p
   8 .I portnum
   9 ]
  10 [
  11 .B \-g
  12 .I group
  13 ]
  14 [
  15 .B \-m
  16 .I octal-mode
  17 ]
  18 [
  19 .I socketdir
  20 ]
  21 .br
  22 .SH DESCRIPTION
  23 A
  24 \fBvde_plug\fP
  25 is a plug to be connected into a VDE switch.
  26 All the data that is catched by the plug is written in its stdout and
  27 everything from stdin is injected in the switch.
  28
  29 This tool has been designed to be used together with
  30 .B dpipe (1)
  31 to interconnect a second vde_plug to another switch, working as a
  32 virtual ethernet crossed cable between the two switches.
  33
  34 The command
  35 .RS
  36 .br
  37 .B dpipe vde_plug = vde_plug /tmp/vde2.ctl
  38 .RE
  39 connects two local switches: the former is using the standard control socket /tmp/vde.ctl
  40 while the latter is using /tmp/vde2.ctl.
  41
  42
  43 The command
  44 .RS
  45 .br
  46 .B dpipe vde_plug = ssh remote.machine.org vde_plug
  47 .RE
  48 connects two remote switches.
  49 If the two vde_switches run as daemon and they are connected to tap interfaces
  50 a level 2 encrypted tunnel is established.
  51
  52 vde_plug can also be established as a login shell for users.
  53 The following command works as in the previous example
  54 .RS
  55 .br
  56 .B dpipe vde_plug = ssh vdeuser@remote.machine.org vde_plug
  57 .RE
  58 where vdeuser is the user with vde_plug as standard shell.
  59 All the remote accesses are logged by syslog at the beginning and at the
  60 end of each session.
  61 Attempt to login without the command vde_plug at the end or trying to
  62 execute something else are blocked and the attempt is logged into syslog.
  63
  64 .SH OPTIONS
  65 .TP
  66 .B \-p "\fIportnum\fP"
  67 It is possible to decide which port of the switch to use.
  68 When this option is not specified the switch assigns the first
  69 available unused port (if any).
  70 It is possible to connect several cables in the same switch port:
  71 in this way all this cables work concurrently.
  72 It means that packet can result as duplicate but no ARP table loops are
  73 generated.
  74 Is useful when vde is used for mobility. Several physical interfaces can
  75 be used at a time during handoffs to prevent hichups in connectivity.
  76 .TP
  77 .B \-g "\fIgroup\fP"
  78 group ownership of the communication socket. For security when more
  79 want to share a switch it is better to use a unix group to own the comm sockets
  80 so that the network traffic cannot be sniffed.
  81 .TP
  82 .B \-m "\fIoctal-mode\fP"
  83 octal chmod like permissions for the comm sockets
  84 .TP
  85 .B "\fIsocketdir\fP"
  86 (This option can be also set as:
  87 .B -sock "\fIsocketdir\fP"
  88 ) specify the directory which contains the UNIX socket to be used by local programs for joining the VDE.
  89 The default value is "/tmp/vde.ctl", which corresponds to the socket
  90 "/tmp/vde.ctl/ctl".
  91 .SH NOTICE
  92 Virtual Distributed Ethernet is not related in any way with
  93 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
  94 i.e. the German "Association for Electrical, Electronic & Information
  95 Technologies").
  96
  97 .SH SEE ALSO
  98 \fBvde_switch\fP(1),
  99 \fBvde_plug2tap\fP(1),
 100 \fBvdeq\fP(1),
 101 \fBdpipe\fP(1).
 102 .br
 103 .SH AUTHOR
 104 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>