X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.netdev.xml;h=751dd00fd83e6c852df52c0e843c6d3135947ac8;hp=a57ba7ad8cf1ecf9cd00d5e2da21d93c100efd7b;hb=fc07d5d3a982e59d984d6be54342a18028faf7be;hpb=30ae9dfda3788cdfaf1b84d124dbc7feb638c77b
diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml
index a57ba7ad8..751dd00fd 100644
--- a/man/systemd.netdev.xml
+++ b/man/systemd.netdev.xml
@@ -60,7 +60,10 @@
Virtual Network Device files must have the extension
.netdev; other extensions are ignored. Virtual
- network devices are created as soon as networkd is started.
+ network devices are created as soon as networkd is started. If a netdev
+ with the specified name already exists, networkd will use that as-is
+ rather than create its own. Note that the settings of the pre-existing
+ netdev will not be changed by networkd.
The .netdev files are read from the files located in the
system network directory /usr/lib/systemd/network,
@@ -80,6 +83,184 @@
+
+ Supported netdev kinds
+
+ The following kinds of virtual network devices may be configured in .netdev files:
+
+
+
+ bond
+
+ A bond device is an aggregation of all its slave devices. See
+
+ Linux Ethernet Bonding Driver HOWTO for details.
+
+
+
+
+
+
+ bridge
+
+ A bridge devcie is a software switch, each of its slave devices and the bridge itself are ports of the switch.
+
+
+
+
+
+
+ dummy
+
+ A dummy device drops all packets sent to it.
+
+
+
+
+
+
+ gre
+
+ A Level 3 GRE tunnel over IPv4. See
+
+ RFC 2784 for details.
+
+
+
+
+
+
+ gretap
+
+ A Level 2 GRE tunnel over IPv4.
+
+
+
+
+
+
+ ip6gre
+
+ A Level 3 GRE tunnel over IPv6.
+
+
+
+
+
+
+ ip6tnl
+
+ An IPv4 or IPv6 tunnel over IPv6
+
+
+
+
+
+
+ ip6gretap
+
+ An Level 2 GRE tunnel over IPv6.
+
+
+
+
+
+
+ ipip
+
+ An IPv4 over IPv4 tunnel.
+
+
+
+
+
+
+ ipvlan
+
+ An ipvlan device is a stacked device which receives packets from its
+ underlying device based on IP address filtering.
+
+
+
+
+
+
+ macvlan
+
+ A macvlan device is a stacked device which receives packets from its
+ underlying device based on MAC address filtering.
+
+
+
+
+
+
+ sit
+
+ An IPv6 over IPv4 tunnel.
+
+
+
+
+
+
+ tap
+
+ A persistent Level 2 tunnel between a network device and a device node.
+
+
+
+
+
+
+ tun
+
+ A persistent Level 3 tunnel between a network device and a device node.
+
+
+
+
+
+
+ veth
+
+ An ethernet tunnel between a pair of network devices.
+
+
+
+
+
+
+ vlan
+
+ A vlan is a stacked device which receives packets from its underlying
+ device based on VLAN tagging. See
+
+ IEEE 802.1Q for details.
+
+
+
+
+
+
+ vti
+
+ An IPv4 over IPSec tunnel.
+
+
+
+
+
+
+ vxlan
+
+
+
+
+
+
+
+
[Match] Section Options
@@ -158,13 +339,8 @@
Kind=
- The netdev kind. Currently, bridge,
- bond, vlan,
- macvlan, vxlan,
- ipip, gre,
- sit, vti,
- veth, and dummy
- are supported. This option is compulsory.
+ The netdev kind. This option is compulsory. See the Supported netdev kinds section
+ for the valid keys.
@@ -173,7 +349,9 @@
The maximum transmission unit in bytes to
set for the device. The usual suffixes K, M, G,
are supported and are understood to the base of
- 1024.
+ 1024. This key is not currently suported for
+ tun or tap devices.
+
@@ -183,6 +361,7 @@
If none is given, one is generated based on
the interface name and the
machine-id5.
+ This key is not currently suported for tun or tap devices.
@@ -226,6 +405,26 @@
+
+
+ [IPVLAN] Section Options
+
+ The [IPVLAN] section only applies for netdevs of kind
+ ipvlan, and accepts the following key:
+
+
+
+ Mode=
+
+ The IPVLAN mode to use. The supported options are
+ L2 and L3.
+
+
+
+
+
+
+
[VXLAN] Section Options
The [VXLAN] section only applies for netdevs of kind
@@ -265,14 +464,45 @@
to discover remote MAC addresses.
+
+ FDBAgeingSec=
+
+ The lifetime of Forwarding Database entry learnt by the kernel in seconds.
+
+
+
+ ARPProxy=
+
+ A boolean. When true, enables ARP proxy.
+
+
+
+ L2MissNotification=
+
+ A boolean. When true, enables netlink LLADDR miss notifications.
+
+
+
+ L3MissNotification=
+
+ A boolean. When true, enables netlink IP ADDR miss notifications.
+
+
+
+ RouteShortCircuit=
+
+ A boolean. When true route short circuit is turned on.
+
+
[Tunnel] Section Options
The [Tunnel] section only applies for netdevs of kind
- ipip, sit, gre and
- vti and accepts the following keys:
+ ipip, sit, gre, gretap,
+ ip6gre, ip6gretap, vti and ip6tnl
+ and accepts the following keys:
@@ -314,6 +544,16 @@
A boolean. When true, enables Path MTU Discovery on the tunnel.
+
+ Mode=
+
+ An ip6tnl tunnels can have three modes
+ ip6ip6 for IPv6 over IPv6,
+ ipip6 for IPv4 over IPv6 or
+ any for either.
+
+
+
@@ -340,51 +580,45 @@
- [TUN] Section Options
+ [Tun] Section Options
- The [TUN] section only applies for netdevs of kind
+ The [Tun] section only applies for netdevs of kind
tun, and accepts the following keys:
OneQueue=
Takes a boolean argument. Configures whether
- to enable disable one queue . it determines whether all packets
- queue at the device (enabled), or a fixed number queue at the device and
- the rest at the "qdisc". Defaults to no.
+ all packets are queued at the device (enabled), or a fixed number
+ of packets are queued at the device and the rest at the
+ qdisc. Defaults to no.
MultiQueue=
- Takes a boolean argument. Configures whether the
- to disable or disable . Linux supports multiqueue tuntap which can
- uses multiple file descriptors (queues) to parallelize
- packets sending or receiving. The device allocation is the same as before,
- and if user wants to create multiple queues. Defaults to
- no.
+ Takes a boolean argument. Configures whether to
+ use multiple file descriptors (queues) to parallelize packets
+ sending and receiving. Defaults to no.
PacketInfo=
- Takes a boolean argument. Configures whether the
- to enable or disable . PacketInfo tells the kernel to not provide packet
- information. The purpose of PacketInfo is to tell the kernel that packets
- will be "pure" IP packets, with no added bytes. Otherwise (if PacketInfo is unset),
- 4 extra bytes are added to the beginning of the packet (2 flag bytes and 2 protocol bytes).
- Defaults to no.
+ Takes a boolean argument. Configures whether packets
+ should be prepened with four extra bytes (two flag bytes and two
+ protocol bytes). If disabled it indicates that the packets will be
+ pure IP packets. Defaults to no.
User=
- User to be allowed to access this device. Give ownership to unprivileged users,
- so that /dev/net/tun device to be usable by this user.
-
+ User to grant access to the /dev/net/tun
+ device.
Group=
- Group to be allowed to access this device. Give ownership to unprivileged group,
- so that /dev/net/tun device to be usable by this group.
+ Group to grant access to the /dev/net/tun
+ device.
@@ -393,57 +627,93 @@
- [TAP] Section Options
+ [Tap] Section Options
- The [TAP] section only applies for netdevs of kind
- tap, and accepts the following keys:
+ The [Tap] section only applies for netdevs of kind
+ tap, and accepts the same keys as the
+ [Tun] section.
+
+ [Bond] Section Options
+
+ The [Bond] section accepts the following
+ key:
+
- OneQueue=
- Takes a boolean argument. Configures whether
- to enable disable one queue . it determines whether all packets
- queue at the device (enabled), or a fixed number queue at the device and
- the rest at the "qdisc". Defaults to no.
+ Mode=
+
+ Specifies one of the bonding policies. The default is
+ balance-rr (round robin). Possible values are
+ balance-rr,
+ active-backup,
+ balance-xor,
+ broadcast,
+ 802.3ad,
+ balance-tlb, and
+ balance-alb.
+
+
- MultiQueue=
- Takes a boolean argument. Configures whether the
- to disable or disable . From version 3.8, Linux supports multiqueue
- tuntap which can uses multiple file descriptors (queues) to parallelize
- packets sending or receiving. The device allocation is the same as before,
- and if user wants to create multiple queues. Defaults to
- no.
-
+ TransmitHashPolicy=
+
+ Selects the transmit hash policy to use for slave selection in
+ balance-xor, 802.3ad, and tlb modes. Possible values are
+ layer2,
+ layer3+4,
+ layer2+3,
+ encap2+3,
+ 802.3ad, and
+ encap3+4.
+
+
+
- PacketInfo=
- Takes a boolean argument. Configures whether the
- to enable or disable . PacketInfo tells the kernel to not provide packet
- information. The purpose of PacketInfo is to tell the kernel that packets
- will be "pure" IP packets, with no added bytes. Otherwise (if PacketInfo is unset),
- 4 extra bytes are added to the beginning of the packet (2 flag bytes and 2 protocol bytes).
- Defaults to no.
-
+ LACPTransmitRate=
+
+ Specifies the rate with which link partner
+ transmits Link Aggregation Control Protocol Data Unit packets
+ in 802.3ad mode. Possible values are
+ slow, which requests partner to transmit LACPDUs every 30 seconds, and
+ fast, which requests partner to transmit LACPDUs every second.
+ The default value is slow.
+
+
- User=
- User to be allowed to access this device. Give ownership to unprivileged users,
- so that /dev/net/tun device to be usable by this user.
-
-
+ MIIMonitorSec=
+
+ Specifies the frequency that Media Independent Interface link
+ monitoring will occur. A value of zero disables MII link monitoring.
+ This values is rounded down to the nearest millisecond. The default
+ value is 0.
+
+
- Group=
- Group to be allowed to access this device. Give ownership to unprivileged group,
- so that /dev/net/tun device to be usable by this group.
-
+ UpDelaySec=
+
+ Specifies the delay before a link is enabled after a link up
+ status has been detected. This value is rounded down to a multiple of
+ MIIMonitorSec. The default value is 0.
+
-
+
+ DownDelaySec=
+
+ Specifies the delay before a link is disabled after a link down
+ status has been detected. This value is rounded down to a multiple of
+ MIIMonitorSec. The default value is 0.
+
+
+
+
Example
@@ -551,6 +821,7 @@ MACAddress=12:34:56:78:9a:bc
systemd1,
systemd-networkd8,
+ systemd.link5,
systemd.network5