LIBVDEPLUG_SLIRP(1)

NAME
libvdeplug_slirp - slirp vdeplug module

SYNOPSIS
libvdeplug_slirp.so

DESCRIPTION
This is the libvdeplug module to join TCP-IP networks using the slirp emulator.

This module of libvdeplug4 can be used in any program supporting vde like vde_plug, vdens, kvm, qemu, user-mode-linux and virtualbox.

The vde_plug_url syntax of this module is the following: ``` slirp://[/OPTION][/OPTION]

OPTIONS

v4 v6
    provide IPv4 or IPv6 service only. Both family of protocols are enabled if both v4 and v6 options are present of if neither of them have been specified.

addr=IPv4Addr/prefix or host=IPv4addr/prefix
    Set the IPv4 address of slirp (default value 10.0.2.2/24).

addr6=IPv6Addr/prefix or host6=IPv6addr/prefix
    Set the IPv6 address of slirp (default value fd00::2/64).

hostname=name
    define the hostname (default value: slirp)

tftp_server_name=name
    define the hostname of the dhcp server

tftp_path=path
    define the path of the directory whose contents are available by the tftp service

bootfile=path
    define the path of the bootfile (for bootp)

dhcp=dhcpIPv4addr
    set the lowest IP address assigned by dhcp

vnameserver=IPv4Addr
    set the address of the IPv4 DNS proxy

vnameserver6=IPv6Addr
    set the address of the IPv6 DNS proxy

vdnssearch=list of domains
    set the default domains for the neame resolution e.g. vdnssearch=foo.com,bar.org

vdomainname=name
    set the domain name

mtu=int_value
    define the MTU

mru==int_value
    define the MRU

disable_host_loopback
    disable loopback

tcpfwd=[hostIP:]hostport:guestIP:guestport[,[hostIP:]hostport:guestIP:guestport]...]
    forward TCP port(s).

udpfwd=[hostIP:]hostport:guestIP:guestport[,[hostIP:]hostport:guestIP:guestport]...]
    forward UDP port(s).

unixfwd=[slirpIP:]slirpport:path[,[slirpIP:]slirpport:path...]
    forward TCP port(s) (from the virtual network) to PF_UNIX socket(s) (commonly used to forward ports to a X server) still unsupported by libslirp.

cmdfwd=[slirpIP:]slirpport:cmd[,[slirpIP:]slirpport:path...]
    forward TCP port(s) (from the virtual network) to external command(s).

verbose
    print a table of slirp service configuration.

EXAMPLES
This vde_plug_url enables both IPv4 and IPv6 (using the default configuration)

slirp://

Like the previous example but it prints the table of the configuration options

slirp:///verbose

When a program uses the following vde_plug_url:

slirp:///tcpfwd=8080:10.0.2.15:80

tcp connections to the host computer port 8080 (any interface) are forwarded to 10.0.2.15 port 80

slirp:///tcpfwd=8080:10.0.2.15:80/cmdfwd=10.0.2.5:6000:'socat STDIO UNIX:"/tmp/.X11-unix/X0"'

like the previous one plus this uses socat to forward all X-windows requests to 10.0.2.5:0 (port 6000) to the local server of the display :0.

NOTICE
Virtual Distributed Ethernet is not related in any way with www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik" i.e. the German "Association for Electrical, Electronic & Information Technologies").

SEE ALSO
vde_plug(1)

AUTHOR
VirtualSquare. Project leader: Renzo Davoli