diff options
Diffstat (limited to 'man/systemd.netdev.xml')
| -rw-r--r-- | man/systemd.netdev.xml | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml index a18d9aba07..aeb03ee030 100644 --- a/man/systemd.netdev.xml +++ b/man/systemd.netdev.xml @@ -185,6 +185,9 @@ <row><entry><varname>bareudp</varname></entry> <entry> Bare UDP tunnels provide a generic L3 encapsulation support for tunnelling different L3 protocols like MPLS, IP etc. inside of an UDP tunnel.</entry></row> + + <row><entry><varname>batadv</varname></entry> + <entry> (<ulink url="https://www.open-mesh.org/projects/open-mesh/wiki">B.A.T.M.A.N. Advanced</ulink>) is a routing protocol for multi-hop mobile ad hoc networks which operates on layer2.</entry></row> </tbody> </tgroup> </table> @@ -2021,6 +2024,107 @@ </refsect1> <refsect1> + <title>[BatmanAdvanced] Section Options</title> + <para>The [BatmanAdvanced] section only applies for + netdevs of kind <literal>batadv</literal> and accepts the + following keys:</para> + + <variablelist class='network-directives'> + <varlistentry> + <term><varname>GatewayMode=</varname></term> + <listitem> + <para>Takes one of <literal>off</literal>, <literal>server</literal>, or <literal>client</literal>. + A batman-adv node can either run in server mode (sharing its internet + connection with the mesh) or in client mode (searching for the most suitable internet connection + in the mesh) or having the gateway support turned off entirely (which is the default setting). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>Aggregation=</varname></term> + <listitem> + <para>Takes a boolean value. Enables or disables aggregation of originator messages. Defaults to + true. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>BridgeLoopAvoidance=</varname></term> + <listitem> + <para>Takes a boolean value. Enables or disables avoidance of loops on bridges. Defaults to true. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>DistributedArpTable=</varname></term> + <listitem> + <para>Takes a boolean value. Enables or disables the distributed ARP table. Defaults to true.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>Fragmentation=</varname></term> + <listitem> + <para>Takes a boolean value. Enables or disables fragmentation. Defaults to true.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>HopPenalty=</varname></term> + <listitem> + <para>The hop penalty setting allows to modify + <citerefentry><refentrytitle>batctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> + preference for multihop routes vs. short routes. This interger value is applied to the + TQ (Transmit Quality) of each forwarded OGM (Originator Message), thereby propagating the + cost of an extra hop (the packet has to be received and retransmitted which costs airtime). + A higher hop penalty will make it more unlikely that other nodes will choose this node as + intermediate hop towards any given destination. The default hop penalty of '15' is a reasonable + value for most setups and probably does not need to be changed. However, mobile nodes could + choose a value of 255 (maximum value) to avoid being chosen as a router by other nodes. + The minimum value is 0. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>OriginatorIntervalSec=</varname></term> + <listitem> + <para>The value specifies the interval in seconds, unless another time unit is specified in which + batman-adv floods the network with its protocol information. + See <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> + for more information.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>GatewayBandwidthDown=</varname></term> + <listitem> + <para>If the node is a server, this + parameter is used to inform other nodes in the network about + this node's internet connection download bandwidth in bits per second. Just enter any number + suffixed with K, M, G or T (base 1000) and the batman-adv + module will propagate the entered value in the mesh.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>GatewayBandwidthUp=</varname></term> + <listitem> + <para>If the node is a server, this + parameter is used to inform other nodes in the network about + this node's internet connection upload bandwidth in bits per second. Just enter any number + suffixed with K, M, G or T (base 1000) and the batman-adv + module will propagate the entered value in the mesh.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>RoutingAlgorithm=</varname></term> + <listitem> + <para>This can be either <literal>batman-v</literal> or <literal>batman-iv</literal> and describes which routing_algo + of <citerefentry><refentrytitle>batctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> to use. The algorithm + cannot be changed after interface creation. Defaults to <literal>batman-v</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> <title>Examples</title> <example> <title>/etc/systemd/network/25-bridge.netdev</title> |