Skip to main content

Tun

Creates and configures a TUN (network TUNnel) interface on the host system. A TUN interface operates at the network layer (Layer 3) of the OSI model and emulates a point-to-point network device. It provides a virtual IP interface that allows the pipeline to send and receive raw IP packets as if they were arriving from or destined to a physical network interface. TUN interfaces are commonly used for implementing virtual private networks (VPNs), IP tunneling, and other Layer 3 routing or forwarding mechanisms, where packet-level manipulation is required. Note, see also the TAP component for Layer 2 Ethernet frame handling.

Tags: NETWORKING, IO, INGRESS

FieldTypeLabelDescriptionDefault Value
InputString
OutputString
Interface NameStringName of the TUN interface to be created (e.g., tun0).tun0
IpStringIP address to assign to the TUN interface.10.0.0.1
NetmaskStringOptionalSubnet mask to configure for the TUN interface.255.255.255.0
Is Default RouteBoolOptionalWhether to set the TUN interface as the system's default network route.false
Generic OffloadBoolOptionalExchange TCP and UDP super packets of up to 64 KB with the kernel (GSO when reading, GRO when writing) instead of one packet per read or write, which greatly reduces the CPU cost of the TUN interface. The packets sent through the pipeline are unchanged. Defaults to true on Linux; set it to false to read and write one packet at a time. The interface uses virtio-net headers and checksum offload either way, so applications sending with UDP_SEGMENT over it work on every kernel. Not supported on other platforms.true
MtuUint32OptionalMaximum Transmission Unit (MTU) to configure for the TUN interface.1280