README.rst
1.. _virtual_network_interface-sample:
2
3Virtual Network Interface Application
4#####################################
5
6Overview
7********
8
9This sample application creates a sample virtual network interface for
10demostrative purposes, it does not do anything useful here.
11There are total 4 network interfaces.
12Ethernet network interface is providing the real network interface and
13all the virtual interfaces are running on top of it.
14On top of Ethernet interface there are two virtual network interfaces,
15one provides only IPv6 tunnel, and the other only IPv4. These two tunnels
16are provided by IPIP tunnel.
17The sample provides tunnel interface which runs on top of the IPv6 tunnel.
18
19The source code for this sample application can be found at:
20:zephyr_file:`samples/net/virtual`.
21
22Requirements
23************
24
25- :ref:`networking_with_host`
26
27Building and Running
28********************
29
30The `net-tools`_ project provides a configuration that can be used
31to create a sample tunnels in host side.
32
33.. code-block:: console
34
35 net-setup.sh -c zeth-tunnel.conf
36
37Note that the sample application expects that the board provides
38an Ethernet network interface. Build the sample application like this:
39
40.. zephyr-app-commands::
41 :zephyr-app: samples/net/virtual
42 :board: <board to use>
43 :goals: build
44 :compact:
45
46.. _`net-tools`: https://github.com/zephyrproject-rtos/net-tools
47
