X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.netdev.xml;h=275ee528a039af2db6baaae3c887d938d1b279a4;hp=a57ba7ad8cf1ecf9cd00d5e2da21d93c100efd7b;hb=23bbb0de4e3f85d9704a5c12a5afa2dfa0159e41;hpb=30ae9dfda3788cdfaf1b84d124dbc7feb638c77b
diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml
index a57ba7ad8..275ee528a 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,
@@ -163,7 +166,8 @@
macvlan, vxlan,
ipip, gre,
sit, vti,
- veth, and dummy
+ veth, tun,
+ tap and dummy
are supported. This option is compulsory.
@@ -173,7 +177,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 +189,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.
@@ -340,51 +347,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 +394,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