diff options
Diffstat (limited to 'man/systemd.netdev.xml')
| -rw-r--r-- | man/systemd.netdev.xml | 230 |
1 files changed, 211 insertions, 19 deletions
diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml index 4480e1999d..786c7d478a 100644 --- a/man/systemd.netdev.xml +++ b/man/systemd.netdev.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -68,20 +71,20 @@ <para>The <filename>.netdev</filename> files are read from the files located in the system network directory - <filename>/usr/lib/systemd/network</filename>, the volatile + <filename>&rootlibexecdir;/network</filename>, the volatile runtime network directory <filename>/run/systemd/network</filename> and the local administration network directory - <filename>/etc/systemd/network</filename>. All configuration files + <filename>&pkgsysconfdir;/network</filename>. All configuration files are collectively sorted and processed in lexical order, regardless of the directories in which they live. However, files with identical filenames replace each other. Files in <filename>/etc</filename> have the highest priority, files in <filename>/run</filename> take precedence over files with the same - name in <filename>/usr/lib</filename>. This can be used to + name in <filename>&rootprefix;/lib</filename>. This can be used to override a system-supplied configuration file with a local file if needed; a symlink in <filename>/etc</filename> with the same name - as a configuration file in <filename>/usr/lib</filename>, pointing + as a configuration file in <filename>&rootprefix;/lib</filename>, pointing to <filename>/dev/null</filename>, disables the configuration file entirely.</para> @@ -108,7 +111,7 @@ <entry>A bond device is an aggregation of all its slave devices. See <ulink url="https://www.kernel.org/doc/Documentation/networking/bonding.txt">Linux Ethernet Bonding Driver HOWTO</ulink> for details.Local configuration</entry></row> <row><entry><varname>bridge</varname></entry> - <entry>A bridge devcie is a software switch, each of its slave devices and the bridge itself are ports of the switch.</entry></row> + <entry>A bridge device is a software switch, each of its slave devices and the bridge itself are ports of the switch.</entry></row> <row><entry><varname>dummy</varname></entry> <entry>A dummy device drops all packets sent to it.</entry></row> @@ -155,6 +158,9 @@ <row><entry><varname>vti</varname></entry> <entry>An IPv4 over IPSec tunnel.</entry></row> + <row><entry><varname>vti6</varname></entry> + <entry>An IPv6 over IPSec tunnel.</entry></row> + <row><entry><varname>vxlan</varname></entry> <entry>A virtual extensible LAN (vxlan), for connecting Cloud computing deployments.</entry></row> </tbody> @@ -253,7 +259,7 @@ <para>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. This key is not - currently suported for <literal>tun</literal> or + currently supported for <literal>tun</literal> or <literal>tap</literal> devices. </para> </listitem> @@ -265,7 +271,7 @@ given, one is generated based on the interface name and the <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>. - This key is not currently suported for + This key is not currently supported for <literal>tun</literal> or <literal>tap</literal> devices. </para> </listitem> @@ -410,6 +416,24 @@ on.</para> </listitem> </varlistentry> + <varlistentry> + <term><varname>UDPCheckSum=</varname></term> + <listitem> + <para>A boolean. When true transmitting UDP checksums when doing VXLAN/IPv4 is turned on.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>UDP6ZeroChecksumTx=</varname></term> + <listitem> + <para>A boolean. When true sending zero checksums in VXLAN/IPv6 is turned on.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>UDP6ZeroCheckSumRx=</varname></term> + <listitem> + <para>A boolean. When true receiving zero checksums in VXLAN/IPv6 is turned on.</para> + </listitem> + </varlistentry> </variablelist> </refsect1> <refsect1> @@ -423,7 +447,8 @@ <literal>gretap</literal>, <literal>ip6gre</literal>, <literal>ip6gretap</literal>, - <literal>vti</literal>, and + <literal>vti</literal>, + <literal>vti6</literal>, and <literal>ip6tnl</literal> and accepts the following keys:</para> @@ -534,7 +559,7 @@ <varlistentry> <term><varname>PacketInfo=</varname></term> <listitem><para>Takes a boolean argument. Configures whether - packets should be prepened with four extra bytes (two flag + packets should be prepended 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 <literal>no</literal>.</para> @@ -647,13 +672,180 @@ </listitem> </varlistentry> + <varlistentry> + <term><varname>LearnPacketIntervalSec=</varname></term> + <listitem> + <para>Specifies the number of seconds between instances where the bonding + driver sends learning packets to each slaves peer switch. + The valid range is 1 - 0x7fffffff; the default value is 1. This Option + has effect only in balance-tlb and balance-alb modes.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>AdSelect=</varname></term> + <listitem> + <para>Specifies the 802.3ad aggregation selection logic to use. Possible values are + <literal>stable</literal>, + <literal>bandwidth</literal>, + <literal>count</literal> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>FailOverMACPolicy=</varname></term> + <listitem> + <para>Specifies whether active-backup mode should set all slaves to + the same MAC address at enslavement or, when enabled, perform special handling of the + bond's MAC address in accordance with the selected policy. The default policy is none. + Possible values are + <literal>none</literal>, + <literal>active</literal>, + <literal>follow</literal> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ARPValidate=</varname></term> + <listitem> + <para>Specifies whether or not ARP probes and replies should be + validated in any mode that supports ARP monitoring, or whether + non-ARP traffic should be filtered (disregarded) for link + monitoring purposes. Possible values are + <literal>none</literal>, + <literal>active</literal>, + <literal>backup</literal>, + <literal>all</literal> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ARPIntervalSec=</varname></term> + <listitem> + <para>Specifies the ARP link monitoring frequency in milliseconds. + A value of 0 disables ARP monitoring. The default value is 0. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ARPIPTargets=</varname></term> + <listitem> + <para>Specifies the IP addresses to use as ARP monitoring peers when + ARPIntervalSec is greater than 0. These are the targets of the ARP request + sent to determine the health of the link to the targets. + Specify these values in ipv4 dotted decimal format. At least one IP + address must be given for ARP monitoring to function. The + maximum number of targets that can be specified is 16. The + default value is no IP addresses. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ARPAllTargets=</varname></term> + <listitem> + <para>Specifies the quantity of ARPIPTargets that must be reachable + in order for the ARP monitor to consider a slave as being up. + This option affects only active-backup mode for slaves with + ARPValidate enabled. Possible values are + <literal>any</literal>, + <literal>all</literal> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>PrimaryReselectPolicy=</varname></term> + <listitem> + <para>Specifies the reselection policy for the primary slave. This + affects how the primary slave is chosen to become the active slave + when failure of the active slave or recovery of the primary slave + occurs. This option is designed to prevent flip-flopping between + the primary slave and other slaves. Possible values are + <literal>always</literal>, + <literal>better</literal>, + <literal>failure</literal> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ResendIGMP=</varname></term> + <listitem> + <para>Specifies the number of IGMP membership reports to be issued after + a failover event. One membership report is issued immediately after + the failover, subsequent packets are sent in each 200ms interval. + The valid range is (0 - 255). Defaults to 1. A value of 0 + prevents the IGMP membership report from being issued in response + to the failover event. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>PacketsPerSlave=</varname></term> + <listitem> + <para> Specify the number of packets to transmit through a slave before + moving to the next one. When set to 0 then a slave is chosen at + random.The valid range is (0 - 65535). Defaults to 1. This option + has effect only in balance-rr mode. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>GratuitousARP=</varname></term> + <listitem> + <para>Specify the number of peer notifications (gratuitous ARPs and + unsolicited IPv6 Neighbor Advertisements) to be issued after a + failover event. As soon as the link is up on the new slave + a peer notification is sent on the bonding device and each + VLAN sub-device. This is repeated at each link monitor interval + (ARPIntervalSec or MIIMonitorSec, whichever is active) if the number is + greater than 1. The valid range is (0 - 255). Default value is 1. + These options affect only the active-backup mode. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>AllSlavesActive=</varname></term> + <listitem> + <para> A boolean. Specifies that duplicate frames (received on inactive ports) + should be dropped false or delivered true. Normally, bonding will drop + duplicate frames (received on inactive ports), which is desirable for + most users. But there are some times it is nice to allow duplicate + frames to be delivered. The default value is false (drop duplicate frames + received on inactive ports). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>MinLinks=</varname></term> + <listitem> + <para>Specifies the minimum number of links that must be active before + asserting carrier. The default value is 0. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para>For more detail information see + <ulink url="https://www.kernel.org/doc/Documentation/networking/bonding.txt"> + Linux Ethernet Bonding Driver HOWTO</ulink></para> + </refsect1> <refsect1> <title>Example</title> <example> - <title>/etc/systemd/network/bridge.netdev</title> + <title>&pkgsysconfdir;/network/bridge.netdev</title> <programlisting>[NetDev] Name=bridge0 @@ -661,7 +853,7 @@ Kind=bridge</programlisting> </example> <example> - <title>/etc/systemd/network/vlan1.netdev</title> + <title>&pkgsysconfdir;/network/vlan1.netdev</title> <programlisting>[Match] Virtualization=no @@ -674,7 +866,7 @@ Kind=vlan Id=1</programlisting> </example> <example> - <title>/etc/systemd/network/ipip.netdev</title> + <title>&pkgsysconfdir;/network/ipip.netdev</title> <programlisting>[NetDev] Name=ipip-tun Kind=ipip @@ -686,7 +878,7 @@ Remote=192.169.224.239 TTL=64</programlisting> </example> <example> - <title>/etc/systemd/network/tap.netdev</title> + <title>&pkgsysconfdir;/network/tap.netdev</title> <programlisting>[NetDev] Name=tap-test Kind=tap @@ -696,7 +888,7 @@ MultiQueue=true PacketInfo=true</programlisting> </example> <example> - <title>/etc/systemd/network/sit.netdev</title> + <title>&pkgsysconfdir;/network/sit.netdev</title> <programlisting>[NetDev] Name=sit-tun Kind=sit @@ -708,7 +900,7 @@ Remote=10.65.223.239</programlisting> </example> <example> - <title>/etc/systemd/network/gre.netdev</title> + <title>&pkgsysconfdir;/network/gre.netdev</title> <programlisting>[NetDev] Name=gre-tun Kind=gre @@ -720,7 +912,7 @@ Remote=10.65.223.239</programlisting> </example> <example> - <title>/etc/systemd/network/vti.netdev</title> + <title>&pkgsysconfdir;/network/vti.netdev</title> <programlisting>[NetDev] Name=vti-tun @@ -733,7 +925,7 @@ Remote=10.65.223.239</programlisting> </example> <example> - <title>/etc/systemd/network/veth.netdev</title> + <title>&pkgsysconfdir;/network/veth.netdev</title> <programlisting>[NetDev] Name=veth-test Kind=veth @@ -743,7 +935,7 @@ Name=veth-peer</programlisting> </example> <example> - <title>/etc/systemd/network/dummy.netdev</title> + <title>&pkgsysconfdir;/network/dummy.netdev</title> <programlisting>[NetDev] Name=dummy-test Kind=dummy |