man/man1/vde_plug.1.html

Content-type: text/html; charset=UTF-8

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of VDE_PLUG</TITLE>
</HEAD><BODY>
<H1>VDE_PLUG</H1>
Section: User Commands  (1)<BR>Updated: August 23, 2016<BR><A HREF="#index">Index</A>
<A HREF="/#/man/index">Return to Main Contents</A><HR>

<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

vde_plug - Virtual Distributed Ethernet plug (two plugs creates a vde cable)
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

<B>vde_plug</B>

[
<I>OPTIONS</I>

]
[
<I>VNL</I>

]
<BR>

<B>vde_plug</B>

[
<I>OPTIONS</I>

]
<I>VNL</I>

<I>VNL</I>

<BR>

<B>vde_plug</B>

[
<I>OPTIONS</I>

]
<B>=</B>

<I>command</I>

[
<I>args</I>

]
<BR>

<B>vde_plug</B>

[
<I>OPTIONS</I>

]
<I>VNL</I>

<B>=</B>

<I>command</I>

[
<I>args</I>

]
<BR>

<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>

A
<B>vde_plug</B>
is a plug to be connected into a VDE network.
<P>
VDE network sockets are named using the Virtual Network Locator (VNL)
syntax, i.e.  <I>module</I><B>://</B><I>specific_address</I>.
e.g. <B><A HREF="vde:///home/user/myswitch">vde:///home/user/myswitch</A></B> or <B><A HREF="vxvde://239.0.0.1">vxvde://239.0.0.1</A></B>.
The default module is <B><A HREF="/#/man/man1/libvdeplug_vde.1.html">libvdeplug_vde</A>(1)</B> (connection to a <B><A HREF="/#/man/man1/vde_switch.1.html">vde_switch</A>(1)</B>)
and can be omitted. e.g. <B>/home/user/myswitch</B> means
<B><A HREF="vde:///home/user/myswitch">vde:///home/user/myswitch</A></B>
<P>
<B>vde_plug</B> can have zero, one or two VNL arguments.
In case of zero or one argument the network communication is converted in
a byte stream. Packets from the VDE network are sent to stdout and bytes
from stdin are converted into packets and injected in the VDE network.
When a VNL is omitted or it is an empty argument
(<B>''</B>) <B>vde_plug</B> tries to connect to a
default network (defined by the user in <B>$HOME/.vde2/default.switch</B>
otherwise <B><A HREF="vde:///run/vde.ctl">vde:///run/vde.ctl</A></B> or <B><A HREF="vde:///tmp/vde.ctl">vde:///tmp/vde.ctl</A></B>).
<P>
This tool has been designed to be used together with
<B>dpipe (1)</B>

to interconnect a second vde_plug to another switch, working as a
virtual ethernet crossed cable between the two switches.
<P>
The command
<DL COMPACT><DT><DD>
<BR>

<B>dpipe vde_plug = vde_plug <A HREF="vde:///tmp/vde2.ctl">vde:///tmp/vde2.ctl</A></B>

</DL>

connects two local switches: the former is using the standard control socket /tmp/vde.ctl
(or /var/run/vde.ctl) while the latter is using /tmp/vde2.ctl.
<P>
<B>vde_plug</B> creates a virtual cable between to VDE networks
when two VNL arguments are present in the command line.
The previous command is equivalent to:
<DL COMPACT><DT><DD>
<BR>

<B>vde_plug /tmp/vde.ctl /tmp/vde2.ctl</B>

</DL>

<P>
The following example connects a vxvde network to a tap interfave
<DL COMPACT><DT><DD>
<BR>

<B>vde_plug <A HREF="vxvde://239.1.2.3">vxvde://239.1.2.3</A> <A HREF="tap://mytap">tap://mytap</A></B>

</DL>

<P>
The command
<DL COMPACT><DT><DD>
<BR>

<B>dpipe vde_plug = ssh remote.machine.org vde_plug</B>

</DL>

connects two remote switches.
If for example the two vde_switches run as daemon and they are connected to tap interfaces
a level 2 encrypted tunnel is established.
<P>
While <B>dpipe</B> supports more complex vitrual network structures (e.g. including <B><A HREF="/#/man/man1/wirefilter.1.html">wirefilter</A>(1)</B> to
emulate network conditions) <B>vde_plug</B> has been designed to provide simple syntax options
to implement the most common virtual network scenarios.
It is possible to use an equal sign (<B>=</B>) followed by a command and its optional
arguments in place of the second VNL.
In this case the packets from/to the network are converted into a bidirectional byte stream
provided as stdin and stdout to the command.
The previous command have the same effect of:
<DL COMPACT><DT><DD>
<BR>

<B>vde_plug = ssh remote.machine.org vde_plug</B>

</DL>

(the first VNL is omitted).
<P>
This example:
<DL COMPACT><DT><DD>
<BR>

<B>vde_plug <A HREF="vxvde://239.1.2.3">vxvde://239.1.2.3</A> = ssh vde_plug <A HREF="tap://remotetap">tap://remotetap</A></B>

</DL>

connects a vxvde network to a tap interface of a remote host.
<P>
vde_plug can also be established as a login shell for users.
The following command works as in the previous example
<DL COMPACT><DT><DD>
<BR>

<B>vde_plug = ssh <A HREF="mailto:vdeuser@remote.machine.org">vdeuser@remote.machine.org</A> vde_plug</B>

</DL>

where vdeuser is the user with vde_plug as standard shell.
All the remote accesses are logged by syslog at the beginning and at the
end of each session and the IP address used are logged if <B>vdeuser</B> belongs
to the <B>vdeplug_iplog</B> group.
Attempts to login without the command vde_plug at the end or to
run on the remote host other commands but vde_plug
are blocked and the violation is logged by syslog.
<P>
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>

<DL COMPACT>
<DT><B>-d<DD>

--daemon
run as a daemon.
<DT>-p</B> <I>PIDFILE<DD>

</I><B>--pidfile</B> <I>PIDFILE
write the process id to the file PIDFILE</I>
<DT><B>-l<DD>

--log
log START/STOP of vde_plug on syslog
<DT>-L<DD>

--iplog
log START/STOP of vde_plug and the IP addresses of hosts seen on the stream
(or on the second VNL) on syslog.
<DT>--port &quot;</B><I>portnum</I>&quot;<DD>
Obsolete option, use the syntax of the libvdeplug_vde module instead,
add the port number in square brackets suffix (e.g. <B><A HREF="vde://tmp/myswitch[10]">vde://tmp/myswitch[10]</A></B>).
It is possible to decide which port of the switch to use.
When this option is not specified the switch assigns the first
available unused port (if any).
It is possible to connect several cables in the same switch port:
in this way all this cables work concurrently.
It means that packet can result as duplicate but no ARP table loops are
generated.
Is useful when vde is used for mobility. Several physical interfaces can
be used at a time during handoffs to prevent hichups in connectivity.
log START/STOP of vde_plug on syslog
<DT><B>-g </B><I>group<DD>

</I><B>--group </B><I>group
group ownership of the communication socket. For security when more
want to share a switch it is better to use a unix group to own the comm sockets
so that the network traffic cannot be sniffed.
<DT></I><B>-m </B><I>octal-mode</I><DD>

<B>--mod </B><I>octal-mode</I>
octal chmod like permissions for the comm sockets
<DT><B>-G -M<DD>

--port2 --group2 --mod2
These options, valid in the syntax with two VNLs, have the the same meaning of -p -g -m.
The uppercase options or the long options with a trailing 2 refer to the second VNL.
<DT>-D</B> <I>DESCR<DD>

</I><B>--descr</B> <I>DESCR
set the description of this connection to DESCR</I> (e.g. port/print command on a
vde_switch shows this description).
<P>
<P>
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>NOTICE</H2>

Virtual Distributed Ethernet is not related in any way with
<A HREF="http://www.vde.com">www.vde.com</A> (&quot;Verband der Elektrotechnik, Elektronik und Informationstechnik&quot;
i.e. the German &quot;Association for Electrical, Electronic &amp; Information
Technologies&quot;).
<P>
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>

<B><A HREF="/#/man/man1/vde_switch.1.html">vde_switch</A></B>(1),
<B><A HREF="/#/man/man1/vdeq.1.html">vdeq</A></B>(1),
<B><A HREF="/#/man/man1/dpipe.1.html">dpipe</A></B>(1),
<B>libvdeplug_p2p.1</B>,
<B>libvdeplug_udp.1</B>,
<B>libvdeplug_vxlan.1</B>,
<B>libvdeplug_tap.1</B>,
<B>libvdeplug_vde.1</B>,
<B>libvdeplug_vxvde.1</B>.
<BR>

<A NAME="lbAH">&nbsp;</A>
<H2>AUTHOR</H2>

VDE is a project by Renzo Davoli &lt;<A HREF="mailto:renzo@cs.unibo.it">renzo@cs.unibo.it</A>&gt;
<P>

<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">OPTIONS</A><DD>
<DT><A HREF="#lbAF">NOTICE</A><DD>
<DT><A HREF="#lbAG">SEE ALSO</A><DD>
<DT><A HREF="#lbAH">AUTHOR</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 15:22:07 GMT, November 27, 2023
</BODY>
</HTML>