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