Multiple tap/grab support for kvde_switch
[vde.git] / vde-2 / man / vde_plug2tap.1
blob360094ad0369ffedc75624b19fb9bd4b6abd420b
1 .TH VDE_PLUG2TAP 1 "December 5, 2006" "Virtual Distributed Ethernet"
2 .SH NAME
3 vde_plug2tap \- Virtual Distributed Ethernet plug-to-tap
4 .SH SYNOPSIS
5 .B vde_plug2tap 
6 [OPTION]... \fItap_name\fP
7 .br
8 .SH DESCRIPTION
9 .B vde_plug2tap 
10 is a plug to be connected into a VDE switch.
11 All the data that is catched by the plug is sent to the tap interface 
12 .I tap_name 
13 and everything from that interface is injected in the switch.
14 .br
15 Example:
16 .in +2
17 .B vde_plug2tap tap4
18 .in -2
19 .br
20 connects the default switch (/var/run/vde.ctl) to the tap4 interface.
22 .SH OPTIONS
23 .TP
24 \fB\-p\fP, \fB\-\-port\fP=\fIportnum\fP
25 It is possible to decide which port of the switch to use.
26 When this option is not specified the switch assigns the first
27 available unused port (if any).
28 It is possible to connect several cables in the same switch port:
29 in this way all this cables work concurrently.
30 It means that packet can result as duplicate but no ARP table loops are
31 generated.
32 Is useful when vde is used for mobility. Several physical interfaces can
33 be used at a time during handoffs to prevent hichups in connectivity.
34 .TP
35 \fB\-g\fP, \fB\-\-group\fP=\fIgroup\fP
36 group ownership of the communication socket. For security when more
37 want to share a switch it is better to use a unix group to own the comm sockets
38 so that the network traffic cannot be sniffed.
39 .TP
40 \fB\-m\fP, \fB\-\-mod\fP=\fIoctal-mode\fP
41 octal chmod like permissions for the comm sockets
42 .TP
43 \fB\-s\fP, \fB\-\-sock\fP=\fIsocket\fP
44 specify the UNIX socket to be used by local programs for joining the VDE.
45 The default value is "/var/run/vde.ctl".
46 When '-' is used in place of the VDE switch directory, \fBvde_plug2tap\fP
47 works as a plug (see vde_plug(1)).
48 The command:
49 .br
50 .in +2
51 .B dpipe vde_plug = ssh remote.machine.org vde_plug2tap -s - tapx
52 .in -2
53 .br
54 connects the default local switch to a remote tapx interface.
55 .TP
56 \fB\-d\fP, \fB\-\-daemon\fP
57 start vde_plug2tap as a background process
58 .TP
59 \fB\-P\fP, \fB\-\-pidfile\fP=\fIpidfile\fP
60 put the process ID of vde_plug2tap in \fIpidfile\fP. Can be used with
61 \fB\-\-daemon\fP to store the PID for future killing.
62 .TP
63 \fB\-h\fP, \fB\-\-help\fP
64 show a brief help
66 .SH NOTICE
67 Virtual Distributed Ethernet is not related in any way with
68 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
69 i.e. the German "Association for Electrical, Electronic & Information
70 Technologies").
72 .SH SEE ALSO
73 \fBvde_switch\fP(1),
74 \fBvde_plug\fP(1),
75 \fBvdeq\fP(1),
76 \fBdpipe\fP(1).
77 .br
78 .SH AUTHOR
79 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>