diff options
Diffstat (limited to 'man/systemd.network.xml')
| -rw-r--r-- | man/systemd.network.xml | 465 |
1 files changed, 216 insertions, 249 deletions
diff --git a/man/systemd.network.xml b/man/systemd.network.xml index ed08826389..88f00bdca6 100644 --- a/man/systemd.network.xml +++ b/man/systemd.network.xml @@ -72,21 +72,16 @@ <refsect1> <title>[Match] Section Options</title> - <para>The network file contains a <literal>[Match]</literal> - section, which determines if a given network file may be applied - to a given device; and a <literal>[Network]</literal> section - specifying how the device should be configured. The first (in - lexical order) of the network files that matches a given device - is applied, all later files are ignored, even if they match as - well.</para> - - <para>A network file is said to match a network interface if all matches specified by the - <literal>[Match]</literal> section are satisfied. When a network file does not contain valid - settings in <literal>[Match]</literal> section, then the file will match all interfaces and - <command>systemd-networkd</command> warns about that. Hint: to avoid the warning and to make it - clear that all interfaces shall be matched, add the following: - <programlisting>Name=*</programlisting> - The following keys are accepted:</para> + <para>The network file contains a [Match] section, which determines if a given network file may be + applied to a given device; and a [Network] section specifying how the device should be configured. The + first (in lexical order) of the network files that matches a given device is applied, all later files + are ignored, even if they match as well.</para> + + <para>A network file is said to match a network interface if all matches specified by the [Match] + section are satisfied. When a network file does not contain valid settings in [Match] section, then the + file will match all interfaces and <command>systemd-networkd</command> warns about that. Hint: to avoid + the warning and to make it clear that all interfaces shall be matched, add the following: + <programlisting>Name=*</programlisting> The following keys are accepted:</para> <variablelist class='network-directives'> <xi:include href="systemd.link.xml" xpointer="mac-address" /> @@ -132,9 +127,8 @@ <listitem> <para>A whitespace-separated list of hardware address of the currently connected wireless LAN. Use full colon-, hyphen- or dot-delimited hexadecimal. See the example in - <varname>MACAddress=</varname>. This option may appear more than one, in which case the - lists are merged. If the empty string is assigned to this option, the list of BSSID defined - prior to this is reset.</para> + <varname>MACAddress=</varname>. This option may appear more than once, in which case the + lists are merged. If the empty string is assigned to this option, the list is reset.</para> </listitem> </varlistentry> @@ -150,7 +144,7 @@ <refsect1> <title>[Link] Section Options</title> - <para> The <literal>[Link]</literal> section accepts the following keys:</para> + <para> The [Link] section accepts the following keys:</para> <variablelist class='network-directives'> <varlistentry> @@ -211,7 +205,7 @@ <para>Link groups are similar to port ranges found in managed switches. When network interfaces are added to a numbered group, operations on all the interfaces from that group can be performed at once. An unsigned - integer ranges 0 to 4294967294. Default to unset.</para> + integer in the range 0—4294967294. Defaults to unset.</para> </listitem> </varlistentry> <varlistentry> @@ -239,12 +233,11 @@ <refsect1> <title>[SR-IOV] Section Options</title> - <para>The <literal>[SR-IOV]</literal> section accepts the - following keys. Specify several <literal>[SR-IOV]</literal> - sections to configure several SR-IOVs. SR-IOV provides the ability to partition a single physical PCI resource - into virtual PCI functions which can then be injected into a VM. In the case of network VFs, SR-IOV improves - north-south network performance (that is, traffic with endpoints outside the host machine) by allowing traffic to - bypass the host machine’s network stack.</para> + <para>The [SR-IOV] section accepts the following keys. Specify several [SR-IOV] sections to configure + several SR-IOVs. SR-IOV provides the ability to partition a single physical PCI resource into virtual + PCI functions which can then be injected into a VM. In the case of network VFs, SR-IOV improves + north-south network performance (that is, traffic with endpoints outside the host machine) by allowing + traffic to bypass the host machine’s network stack.</para> <variablelist class='network-directives'> <varlistentry> @@ -327,7 +320,7 @@ <refsect1> <title>[Network] Section Options</title> - <para>The <literal>[Network]</literal> section accepts the following keys:</para> + <para>The [Network] section accepts the following keys:</para> <variablelist class='network-directives'> <varlistentry> @@ -356,16 +349,15 @@ specified through DHCP is not used for name resolution. See option <option>UseDomains=</option> below.</para> - <para>See the <literal>[DHCPv4]</literal> or <literal>[DHCPv6]</literal> section below for - further configuration options for the DHCP client support.</para> + <para>See the [DHCPv4] or [DHCPv6] sections below for further configuration options for the DHCP + client support.</para> </listitem> </varlistentry> <varlistentry> <term><varname>DHCPServer=</varname></term> <listitem> <para>Takes a boolean. If set to <literal>yes</literal>, DHCPv4 server will be started. Defaults - to <literal>no</literal>. Further settings for the DHCP - server may be set in the <literal>[DHCPServer]</literal> + to <literal>no</literal>. Further settings for the DHCP server may be set in the [DHCPServer] section described below.</para> </listitem> </varlistentry> @@ -495,10 +487,8 @@ <varlistentry> <term><varname>DNSSEC=</varname></term> <listitem> - <para>Takes a boolean. or - <literal>allow-downgrade</literal>. When true, enables - <ulink - url="https://tools.ietf.org/html/rfc4033">DNSSEC</ulink> + <para>Takes a boolean or <literal>allow-downgrade</literal>. When true, enables + <ulink url="https://tools.ietf.org/html/rfc4033">DNSSEC</ulink> DNS validation support on the link. When set to <literal>allow-downgrade</literal>, compatibility with non-DNSSEC capable networks is increased, by automatically @@ -730,8 +720,8 @@ forwarding is enabled, and to enable it otherwise. Cannot be enabled on bond devices and when link local addressing is disabled.</para> - <para>Further settings for the IPv6 RA support may be configured in the - <literal>[IPv6AcceptRA]</literal> section, see below.</para> + <para>Further settings for the IPv6 RA support may be configured in the [IPv6AcceptRA] section, see + below.</para> <para>Also see <ulink url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink> in the kernel @@ -770,7 +760,7 @@ <term><varname>IPv4ProxyARP=</varname></term> <listitem><para>Takes a boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one host, usually a router, answers ARP requests intended for another machine. By "faking" its identity, - the router accepts responsibility for routing packets to the "real" destination. (see <ulink + the router accepts responsibility for routing packets to the "real" destination. See <ulink url="https://tools.ietf.org/html/rfc1027">RFC 1027</ulink>. When unset, the kernel's default will be used. </para></listitem> @@ -801,18 +791,15 @@ </varlistentry> <varlistentry> <term><varname>IPv6PrefixDelegation=</varname></term> - <listitem><para>Whether to enable or disable Router Advertisement sending on a link. - Allowed values are <literal>static</literal> which distributes prefixes as defined in - the <literal>[IPv6PrefixDelegation]</literal> and any <literal>[IPv6Prefix]</literal> - sections, <literal>dhcpv6</literal> which requests prefixes using a DHCPv6 client - configured for another link and any values configured in the - <literal>[IPv6PrefixDelegation]</literal> section while ignoring all static prefix - configuration sections, <literal>yes</literal> which uses both static configuration - and DHCPv6, and <literal>false</literal> which turns off IPv6 prefix delegation - altogether. Defaults to <literal>false</literal>. See the - <literal>[IPv6PrefixDelegation]</literal> and the <literal>[IPv6Prefix]</literal> - sections for more configuration options. - </para></listitem> + <listitem><para>Whether to enable or disable Router Advertisement sending on a link. Allowed + values are <literal>static</literal> which distributes prefixes as defined in the + [IPv6PrefixDelegation] and any [IPv6Prefix] sections, <literal>dhcpv6</literal> which requests + prefixes using a DHCPv6 client configured for another link and any values configured in the + [IPv6PrefixDelegation] section while ignoring all static prefix configuration sections, + <literal>yes</literal> which uses both static configuration and DHCPv6, and + <literal>false</literal> which turns off IPv6 prefix delegation altogether. Defaults to + <literal>false</literal>. See the [IPv6PrefixDelegation] and the [IPv6Prefix] sections for more + configuration options.</para></listitem> </varlistentry> <varlistentry> <term><varname>IPv6PDSubnetId=</varname></term> @@ -978,16 +965,15 @@ <refsect1> <title>[Address] Section Options</title> - <para>An <literal>[Address]</literal> section accepts the - following keys. Specify several <literal>[Address]</literal> + <para>An [Address] section accepts the following keys. Specify several [Address] sections to configure several addresses.</para> <variablelist class='network-directives'> <varlistentry> <term><varname>Address=</varname></term> <listitem> - <para>As in the <literal>[Network]</literal> section. This key is mandatory. Each - <literal>[Address]</literal> section can contain one <varname>Address=</varname> setting.</para> + <para>As in the [Network] section. This key is mandatory. Each [Address] section can contain one + <varname>Address=</varname> setting.</para> </listitem> </varlistentry> <varlistentry> @@ -1031,7 +1017,7 @@ <term><varname>Scope=</varname></term> <listitem> <para>The scope of the address, which can be <literal>global</literal>, - <literal>link</literal> or <literal>host</literal> or an unsigned integer ranges 0 to 255. + <literal>link</literal> or <literal>host</literal> or an unsigned integer in the range 0—255. Defaults to <literal>global</literal>.</para> </listitem> </varlistentry> @@ -1093,12 +1079,10 @@ <refsect1> <title>[Neighbor] Section Options</title> - <para>A <literal>[Neighbor]</literal> section accepts the - following keys. The neighbor section adds a permanent, static - entry to the neighbor table (IPv6) or ARP table (IPv4) for - the given hardware address on the links matched for the network. - Specify several <literal>[Neighbor]</literal> sections to configure - several static neighbors.</para> + <para>A [Neighbor] section accepts the following keys. The neighbor section adds a permanent, static + entry to the neighbor table (IPv6) or ARP table (IPv4) for the given hardware address on the links + matched for the network. Specify several [Neighbor] sections to configure several static neighbors. + </para> <variablelist class='network-directives'> <varlistentry> @@ -1119,18 +1103,17 @@ <refsect1> <title>[IPv6AddressLabel] Section Options</title> - <para>An <literal>[IPv6AddressLabel]</literal> section accepts the - following keys. Specify several <literal>[IPv6AddressLabel]</literal> - sections to configure several address labels. IPv6 address labels are - used for address selection. See <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>. - Precedence is managed by userspace, and only the label itself is stored in the kernel</para> + <para>An [IPv6AddressLabel] section accepts the following keys. Specify several [IPv6AddressLabel] + sections to configure several address labels. IPv6 address labels are used for address selection. See + <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>. Precedence is managed by userspace, + and only the label itself is stored in the kernel</para> <variablelist class='network-directives'> <varlistentry> <term><varname>Label=</varname></term> <listitem> - <para> The label for the prefix (an unsigned integer) ranges 0 to 4294967294. - 0xffffffff is reserved. This key is mandatory.</para> + <para>The label for the prefix, an unsigned integer in the range 0–4294967294. + 0xffffffff is reserved. This setting is mandatory.</para> </listitem> </varlistentry> <varlistentry> @@ -1146,15 +1129,14 @@ <refsect1> <title>[RoutingPolicyRule] Section Options</title> - <para>An <literal>[RoutingPolicyRule]</literal> section accepts the - following keys. Specify several <literal>[RoutingPolicyRule]</literal> + <para>An [RoutingPolicyRule] section accepts the following keys. Specify several [RoutingPolicyRule] sections to configure several rules.</para> <variablelist class='network-directives'> <varlistentry> <term><varname>TypeOfService=</varname></term> <listitem> - <para>Specifies the type of service to match a number between 0 to 255.</para> + <para>Takes a number between 0 and 255 that specifies the type of service to match.</para> </listitem> </varlistentry> <varlistentry> @@ -1261,16 +1243,15 @@ <refsect1> <title>[NextHop] Section Options</title> - <para>The <literal>[NextHop]</literal> section accepts the - following keys. Specify several <literal>[NextHop]</literal> - sections to configure several nexthop. Nexthop is used to manipulate entries in the kernel's nexthop - tables.</para> + <para>The [NextHop] section is used to manipulate entries in the kernel's "nexthop" tables. The + [NextHop] section accepts the following keys. Specify several [NextHop] sections to configure several + hops.</para> <variablelist class='network-directives'> <varlistentry> <term><varname>Gateway=</varname></term> <listitem> - <para>As in the <literal>[Network]</literal> section. This is mandatory.</para> + <para>As in the [Network] section. This is mandatory.</para> </listitem> </varlistentry> <varlistentry> @@ -1284,9 +1265,8 @@ <refsect1> <title>[Route] Section Options</title> - <para>The <literal>[Route]</literal> section accepts the - following keys. Specify several <literal>[Route]</literal> - sections to configure several routes.</para> + <para>The [Route] section accepts the following keys. Specify several [Route] sections to configure + several routes.</para> <variablelist class='network-directives'> <varlistentry> @@ -1333,10 +1313,10 @@ <term><varname>IPv6Preference=</varname></term> <listitem> <para>Specifies the route preference as defined in <ulink - url="https://tools.ietf.org/html/rfc4191">RFC4191</ulink> for Router Discovery messages. - Which can be one of <literal>low</literal> the route has a lowest priority, - <literal>medium</literal> the route has a default priority or - <literal>high</literal> the route has a highest priority.</para> + url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink> for Router Discovery messages. Which + can be one of <literal>low</literal> the route has a lowest priority, <literal>medium</literal> + the route has a default priority or <literal>high</literal> the route has a highest priority. + </para> </listitem> </varlistentry> <varlistentry> @@ -1471,8 +1451,7 @@ <refsect1> <title>[DHCPv4] Section Options</title> - <para>The <literal>[DHCPv4]</literal> section configures the - DHCPv4 client, if it is enabled with the + <para>The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the <varname>DHCP=</varname> setting described above:</para> <variablelist class='network-directives'> @@ -1717,8 +1696,8 @@ <para>The table identifier for DHCP routes (a number between 1 and 4294967295, or 0 to unset). The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>. </para> - <para>When used in combination with <varname>VRF=</varname> the - VRF's routing table is used unless this parameter is specified. + <para>When used in combination with <varname>VRF=</varname>, the + VRF's routing table is used when this parameter is not specified. </para> </listitem> </varlistentry> @@ -1757,11 +1736,12 @@ <varlistentry> <term><varname>SendDecline=</varname></term> <listitem> - <para>A boolean. When <literal>true</literal>, DHCPv4 clients receives IP address from DHCP server. - After new IP is received, DHCPv4 performs IPv4 Duplicate Address Detection. If duplicate use of IP is detected - the DHCPv4 client rejects the IP by sending a DHCPDECLINE packet DHCP clients try to obtain an IP address again. - See <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5224</ulink>. - Defaults to <literal>unset</literal>.</para> + <para>A boolean. When <literal>true</literal>, the DHCPv4 client receives the IP address from the + DHCP server. After a new IP is received, the DHCPv4 client performs IPv4 Duplicate Address + Detection. If duplicate use is detected, the DHCPv4 client rejects the IP by sending a + DHCPDECLINE packet and tries to obtain an IP address again. See <ulink + url="https://tools.ietf.org/html/rfc5227">RFC 5224</ulink>. Defaults to + <literal>unset</literal>.</para> </listitem> </varlistentry> @@ -1814,7 +1794,7 @@ <refsect1> <title>[DHCPv6] Section Options</title> - <para>The <literal>[DHCPv6]</literal> section configures the DHCPv6 client, if it is enabled with the + <para>The [DHCPv6] section configures the DHCPv6 client, if it is enabled with the <varname>DHCP=</varname> setting described above, or invoked by the IPv6 Router Advertisement:</para> <variablelist class='network-directives'> @@ -1822,7 +1802,7 @@ <term><varname>UseDNS=</varname></term> <term><varname>UseNTP=</varname></term> <listitem> - <para>As in the <literal>[DHCPv4]</literal> section.</para> + <para>As in the [DHCPv4] section.</para> </listitem> </varlistentry> @@ -1839,7 +1819,7 @@ <para>Takes a boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server through a rapid two-message exchange (solicit and reply). When the rapid commit option is enabled by both the DHCPv6 client and the DHCPv6 server, the two-message exchange is used, rather than the default - four-method exchange (solicit, advertise, request, and reply). The two-message exchange provides + four-message exchange (solicit, advertise, request, and reply). The two-message exchange provides faster client configuration and is beneficial in environments in which networks are under a heavy load. See <ulink url="https://tools.ietf.org/html/rfc3315#section-17.2.1">RFC 3315</ulink> for details. Defaults to true.</para> @@ -1867,14 +1847,15 @@ <varlistentry> <term><varname>SendVendorOption=</varname></term> <listitem> - <para>Send an arbitrary vendor option in the DHCPv6 request. Takes an enterprise identifier, DHCP option number, - data type, and data separated with a colon - (<literal><replaceable>enterprise identifier</replaceable>:<replaceable>option</replaceable>:<replaceable>type</replaceable>: - <replaceable>value</replaceable></literal>). Enterprise identifier is an unsigned integer ranges 1..4294967294. - The option number must be an integer in the range 1..254. Data type takes one of <literal>uint8</literal>, - <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, <literal>ipv6address</literal>, or - <literal>string</literal>. Special characters in the data string may be escaped using - <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style + <para>Send an arbitrary vendor option in the DHCPv6 request. Takes an enterprise identifier, DHCP + option number, data type, and data separated with a colon (<literal><replaceable>enterprise + identifier</replaceable>:<replaceable>option</replaceable>:<replaceable>type</replaceable>: + <replaceable>value</replaceable></literal>). Enterprise identifier is an unsigned integer in the + range 1–4294967294. The option number must be an integer in the range 1–254. Data type takes one + of <literal>uint8</literal>, <literal>uint16</literal>, <literal>uint32</literal>, + <literal>ipv4address</literal>, <literal>ipv6address</literal>, or + <literal>string</literal>. Special characters in the data string may be escaped using <ulink + url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style escapes</ulink>. This setting can be specified multiple times. If an empty string is specified, then all options specified earlier are cleared. Defaults to unset.</para> </listitem> @@ -1918,24 +1899,26 @@ <varlistentry> <term><varname>PrefixDelegationHint=</varname></term> <listitem> - <para>Takes an IPv6 address with prefix length as <varname>Address=</varname> in - the "[Network]" section. Specifies the DHCPv6 client for the requesting router to include - a prefix-hint in the DHCPv6 solicitation. Prefix ranges 1..128. Defaults to unset.</para> + <para>Takes an IPv6 address with prefix length in the same format as the + <varname>Address=</varname> in the [Network] section. The DHCPv6 client will include a prefix + hint in the DHCPv6 solicitation sent to the server. The prefix length must be in the range + 1–128. Defaults to unset.</para> </listitem> </varlistentry> <varlistentry> <term><varname>WithoutRA=</varname></term> <listitem> - <para>Allows DHCPv6 client to start without router advertisements's managed or other address configuration flag. - Takes one of <literal>solicit</literal> or <literal>information-request</literal>. Defaults to unset.</para> + <para>Allows DHCPv6 client to start without router advertisements's managed or other address + configuration flag. Takes one of <literal>solicit</literal> or + <literal>information-request</literal>. Defaults to unset.</para> </listitem> </varlistentry> <varlistentry> <term><varname>SendOption=</varname></term> <listitem> - <para>As in the <literal>[DHCPv4]</literal> section, however because DHCPv6 uses 16-bit fields to store + <para>As in the [DHCPv4] section, however because DHCPv6 uses 16-bit fields to store option numbers, the option number is an integer in the range 1..65536.</para> </listitem> </varlistentry> @@ -1969,9 +1952,8 @@ <refsect1> <title>[IPv6AcceptRA] Section Options</title> - <para>The <literal>[IPv6AcceptRA]</literal> section configures the IPv6 Router Advertisement - (RA) client, if it is enabled with the <varname>IPv6AcceptRA=</varname> setting described - above:</para> + <para>The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, if it is enabled + with the <varname>IPv6AcceptRA=</varname> setting described above:</para> <variablelist class='network-directives'> <varlistentry> @@ -2051,8 +2033,7 @@ <refsect1> <title>[DHCPServer] Section Options</title> - <para>The <literal>[DHCPServer]</literal> section contains - settings for the DHCP server, if enabled via the + <para>The [DHCPServer] section contains settings for the DHCP server, if enabled via the <varname>DHCPServer=</varname> option described above:</para> <variablelist class='network-directives'> @@ -2186,11 +2167,9 @@ <refsect1> <title>[IPv6PrefixDelegation] Section Options</title> - <para>The <literal>[IPv6PrefixDelegation]</literal> section contains - settings for sending IPv6 Router Advertisements and whether to act as - a router, if enabled via the <varname>IPv6PrefixDelegation=</varname> - option described above. IPv6 network prefixes are defined with one or - more <literal>[IPv6Prefix]</literal> sections.</para> + <para>The [IPv6PrefixDelegation] section contains settings for sending IPv6 Router Advertisements and + whether to act as a router, if enabled via the <varname>IPv6PrefixDelegation=</varname> option described + above. IPv6 network prefixes are defined with one or more [IPv6Prefix] sections.</para> <variablelist class='network-directives'> @@ -2234,32 +2213,26 @@ <term><varname>EmitDNS=</varname></term> <term><varname>DNS=</varname></term> - <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses - that are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is - true. <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that - case the IPv6 link local address is distributed. If <varname>DNS=</varname> is empty, DNS - servers are read from the <literal>[Network]</literal> section. If the - <literal>[Network]</literal> section does not contain any DNS servers either, DNS servers from - the uplink with the highest priority default route are used. When <varname>EmitDNS=</varname> - is false, no DNS server information is sent in Router Advertisement messages. - <varname>EmitDNS=</varname> defaults to true. - </para></listitem> + <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses that + are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is + true. <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that case + the IPv6 link local address is distributed. If <varname>DNS=</varname> is empty, DNS servers are read + from the [Network] section. If the [Network] section does not contain any DNS servers either, DNS + servers from the uplink with the highest priority default route are used. When + <varname>EmitDNS=</varname> is false, no DNS server information is sent in Router Advertisement + messages. <varname>EmitDNS=</varname> defaults to true.</para></listitem> </varlistentry> <varlistentry> <term><varname>EmitDomains=</varname></term> <term><varname>Domains=</varname></term> - <listitem><para>A list of DNS search domains distributed via Router - Advertisement messages when <varname>EmitDomains=</varname> is true. If - <varname>Domains=</varname> is empty, DNS search domains are read from the - <literal>[Network]</literal> section. If the <literal>[Network]</literal> - section does not contain any DNS search domains either, DNS search - domains from the uplink with the highest priority default route are - used. When <varname>EmitDomains=</varname> is false, no DNS search domain - information is sent in Router Advertisement messages. - <varname>EmitDomains=</varname> defaults to true. - </para></listitem> + <listitem><para>A list of DNS search domains distributed via Router Advertisement messages when + <varname>EmitDomains=</varname> is true. If <varname>Domains=</varname> is empty, DNS search domains + are read from the [Network] section. If the [Network] section does not contain any DNS search domains + either, DNS search domains from the uplink with the highest priority default route are used. When + <varname>EmitDomains=</varname> is false, no DNS search domain information is sent in Router + Advertisement messages. <varname>EmitDomains=</varname> defaults to true.</para></listitem> </varlistentry> <varlistentry> @@ -2275,10 +2248,9 @@ <refsect1> <title>[IPv6Prefix] Section Options</title> - <para>One or more <literal>[IPv6Prefix]</literal> sections contain the IPv6 - prefixes that are announced via Router Advertisements. See - <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink> - for further details.</para> + <para>One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router + Advertisements. See <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink> for further + details.</para> <variablelist class='network-directives'> @@ -2296,13 +2268,11 @@ <varlistentry> <term><varname>Prefix=</varname></term> - <listitem><para>The IPv6 prefix that is to be distributed to hosts. - Similarly to configuring static IPv6 addresses, the setting is - configured as an IPv6 prefix and its prefix length, separated by a - <literal>/</literal> character. Use multiple - <literal>[IPv6Prefix]</literal> sections to configure multiple IPv6 - prefixes since prefix lifetimes, address autoconfiguration and onlink - status may differ from one prefix to another.</para></listitem> + <listitem><para>The IPv6 prefix that is to be distributed to hosts. Similarly to configuring static + IPv6 addresses, the setting is configured as an IPv6 prefix and its prefix length, separated by a + <literal>/</literal> character. Use multiple [IPv6Prefix] sections to configure multiple IPv6 + prefixes since prefix lifetimes, address autoconfiguration and onlink status may differ from one + prefix to another.</para></listitem> </varlistentry> <varlistentry> @@ -2325,7 +2295,7 @@ <refsect1> <title>[IPv6RoutePrefix] Section Options</title> - <para>One or more <literal>[IPv6RoutePrefix]</literal> sections contain the IPv6 + <para>One or more [IPv6RoutePrefix] sections contain the IPv6 prefix routes that are announced via Router Advertisements. See <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink> for further details.</para> @@ -2335,12 +2305,10 @@ <varlistentry> <term><varname>Route=</varname></term> - <listitem><para>The IPv6 route that is to be distributed to hosts. - Similarly to configuring static IPv6 routes, the setting is - configured as an IPv6 prefix routes and its prefix route length, - separated by a<literal>/</literal> character. Use multiple - <literal>[IPv6PrefixRoutes]</literal> sections to configure multiple IPv6 - prefix routes.</para></listitem> + <listitem><para>The IPv6 route that is to be distributed to hosts. Similarly to configuring static + IPv6 routes, the setting is configured as an IPv6 prefix routes and its prefix route length, + separated by a <literal>/</literal> character. Use multiple [IPv6PrefixRoutes] sections to configure + multiple IPv6 prefix routes.</para></listitem> </varlistentry> <varlistentry> @@ -2356,8 +2324,7 @@ <refsect1> <title>[Bridge] Section Options</title> - <para>The <literal>[Bridge]</literal> section accepts the - following keys.</para> + <para>The [Bridge] section accepts the following keys:</para> <variablelist class='network-directives'> <varlistentry> <term><varname>UnicastFlood=</varname></term> @@ -2405,10 +2372,9 @@ <varlistentry> <term><varname>HairPin=</varname></term> <listitem> - <para>Takes a boolean. Configures whether traffic may be sent back - out of the port on which it was received. When this flag is false, and the bridge - will not forward traffic back out of the receiving port. - When unset, the kernel's default will be used.</para> + <para>Takes a boolean. Configures whether traffic may be sent back out of the port on which it + was received. When this flag is false, then the bridge will not forward traffic back out of the + receiving port. When unset, the kernel's default will be used.</para> </listitem> </varlistentry> <varlistentry> @@ -2484,17 +2450,14 @@ </refsect1> <refsect1> <title>[BridgeFDB] Section Options</title> - <para>The <literal>[BridgeFDB]</literal> section manages the - forwarding database table of a port and accepts the following - keys. Specify several <literal>[BridgeFDB]</literal> sections to - configure several static MAC table entries.</para> + <para>The [BridgeFDB] section manages the forwarding database table of a port and accepts the following + keys. Specify several [BridgeFDB] sections to configure several static MAC table entries.</para> <variablelist class='network-directives'> <varlistentry> <term><varname>MACAddress=</varname></term> <listitem> - <para>As in the <literal>[Network]</literal> section. This - key is mandatory.</para> + <para>As in the [Network] section. This key is mandatory.</para> </listitem> </varlistentry> <varlistentry> @@ -2537,8 +2500,8 @@ <refsect1> <title>[LLDP] Section Options</title> - <para>The <literal>[LLDP]</literal> section manages the Link Layer Discovery Protocol (LLDP) and accepts the - following keys.</para> + <para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following + keys.</para> <variablelist class='network-directives'> <varlistentry> <term><varname>MUDURL=</varname></term> @@ -2559,8 +2522,8 @@ <refsect1> <title>[CAN] Section Options</title> - <para>The <literal>[CAN]</literal> section manages the Controller Area Network (CAN bus) and accepts the - following keys.</para> + <para>The [CAN] section manages the Controller Area Network (CAN bus) and accepts the + following keys:</para> <variablelist class='network-directives'> <varlistentry> <term><varname>BitRate=</varname></term> @@ -2638,7 +2601,7 @@ <refsect1> <title>[QDisc] Section Options</title> - <para>The <literal>[QDisc]</literal> section manages the traffic control queueing discipline (qdisc).</para> + <para>The [QDisc] section manages the traffic control queueing discipline (qdisc).</para> <variablelist class='network-directives'> <varlistentry> @@ -2655,10 +2618,10 @@ <refsect1> <title>[NetworkEmulator] Section Options</title> - <para>The <literal>[NetworkEmulator]</literal> section manages the queueing discipline (qdisc) of - the network emulator. It can be used to configure the kernel packet scheduler and simulate packet - delay and loss for UDP or TCP applications, or limit the bandwidth usage of a particular service to - simulate internet connections.</para> + <para>The [NetworkEmulator] section manages the queueing discipline (qdisc) of the network emulator. It + can be used to configure the kernel packet scheduler and simulate packet delay and loss for UDP or TCP + applications, or limit the bandwidth usage of a particular service to simulate internet connections. + </para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2684,7 +2647,7 @@ <term><varname>PacketLimit=</varname></term> <listitem> <para>Specifies the maximum number of packets the qdisc may hold queued at a time. - An unsigned integer ranges 0 to 4294967294. Defaults to 1000.</para> + An unsigned integer in the range 0–4294967294. Defaults to 1000.</para> </listitem> </varlistentry> @@ -2708,8 +2671,8 @@ <refsect1> <title>[TokenBucketFilter] Section Options</title> - <para>The <literal>[TokenBucketFilter]</literal> section manages the queueing discipline (qdisc) of - token bucket filter (tbf).</para> + <para>The [TokenBucketFilter] section manages the queueing discipline (qdisc) of token bucket filter + (tbf).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2782,8 +2745,8 @@ <refsect1> <title>[PIE] Section Options</title> - <para>The <literal>[PIE]</literal> section manages the queueing discipline - (qdisc) of Proportional Integral controller-Enhanced (PIE).</para> + <para>The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral + controller-Enhanced (PIE).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2793,7 +2756,7 @@ <term><varname>PacketLimit=</varname></term> <listitem> <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are - dropped. An unsigned integer ranges 1 to 4294967294. Defaults to unset and kernel's default is used.</para> + dropped. An unsigned integer in the range 1–4294967294. Defaults to unset and kernel's default is used.</para> </listitem> </varlistentry> </variablelist> @@ -2801,8 +2764,8 @@ <refsect1> <title>[StochasticFairBlue] Section Options</title> - <para>The <literal>[StochasticFairBlue]</literal> section manages the queueing discipline - (qdisc) of stochastic fair blue (sfb).</para> + <para>The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue + (sfb).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2811,8 +2774,9 @@ <varlistentry> <term><varname>PacketLimit=</varname></term> <listitem> - <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are - dropped. An unsigned integer ranges 0 to 4294967294. Defaults to unset and kernel's default is used.</para> + <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, + incoming packets are dropped. An unsigned integer in the range 0–4294967294. Defaults to unset and + kernel's default is used.</para> </listitem> </varlistentry> </variablelist> @@ -2820,8 +2784,8 @@ <refsect1> <title>[StochasticFairnessQueueing] Section Options</title> - <para>The <literal>[StochasticFairnessQueueing]</literal> section manages the queueing discipline - (qdisc) of stochastic fairness queueing (sfq).</para> + <para>The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic + fairness queueing (sfq).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2838,8 +2802,8 @@ <refsect1> <title>[BFIFO] Section Options</title> - <para>The <literal>[BFIFO]</literal> section manages the queueing discipline (qdisc) of - Byte limited Packet First In First Out (bfifo).</para> + <para>The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First + Out (bfifo).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2848,10 +2812,11 @@ <varlistentry> <term><varname>LimitBytes=</varname></term> <listitem> - <para>Specifies the hard limit on the FIFO size in bytes. The size limit (a buffer size) to prevent it - from overflowing in case it is unable to dequeue packets as quickly as it receives them. When this limit - is reached, incoming packets are dropped. When suffixed with K, M, or G, the specified size is parsed as - Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para> + <para>Specifies the hard limit on the FIFO size in bytes. The size limit (a buffer size) to prevent + it from overflowing in case it is unable to dequeue packets as quickly as it receives them. When + this limit is reached, incoming packets are dropped. When suffixed with K, M, or G, the specified + size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults + to unset and kernel's default is used.</para> </listitem> </varlistentry> </variablelist> @@ -2859,8 +2824,8 @@ <refsect1> <title>[PFIFO] Section Options</title> - <para>The <literal>[PFIFO]</literal> section manages the queueing discipline (qdisc) of - Packet First In First Out (pfifo).</para> + <para>The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out + (pfifo).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2869,9 +2834,10 @@ <varlistentry> <term><varname>PacketLimit=</varname></term> <listitem> - <para>Specifies the hard limit on the FIFO size in number of packets. The size limit (a buffer size) to prevent it - from overflowing in case it is unable to dequeue packets as quickly as it receives them. When this limit is reached, - incoming packets are dropped. An unsigned integer ranges 0 to 4294967294. Defaults to unset and kernel's default is used.</para> + <para>Specifies the hard limit on the FIFO size in number of packets. The size limit (a buffer + size) to prevent it from overflowing in case it is unable to dequeue packets as quickly as it + receives them. When this limit is reached, incoming packets are dropped. An unsigned integer in the + range 0–4294967294. Defaults to unset and kernel's default is used.</para> </listitem> </varlistentry> </variablelist> @@ -2879,8 +2845,8 @@ <refsect1> <title>[PFIFOHeadDrop] Section Options</title> - <para>The <literal>[PFIFOHeadDrop]</literal> section manages the queueing discipline (qdisc) of - Packet First In First Out Head Drop (pfifo_head_drop).</para> + <para>The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out + Head Drop (pfifo_head_drop).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2889,15 +2855,15 @@ <varlistentry> <term><varname>PacketLimit=</varname></term> <listitem> - <para>As in <literal>[PFIFO]</literal> section.</para></listitem> + <para>As in [PFIFO] section.</para></listitem> </varlistentry> </variablelist> </refsect1> <refsect1> <title>[PFIFOFast] Section Options</title> - <para>The <literal>[PFIFOFast]</literal> section manages the queueing discipline (qdisc) of - Packet First In First Out Fast (pfifo_fast).</para> + <para>The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast + (pfifo_fast).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2907,8 +2873,8 @@ <refsect1> <title>[CAKE] Section Options</title> - <para>The <literal>[CAKE]</literal> section manages the queueing discipline (qdisc) of - Common Applications Kept Enhanced (CAKE).</para> + <para>The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced + (CAKE).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2917,8 +2883,8 @@ <varlistentry> <term><varname>OverheadBytes=</varname></term> <listitem> - <para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative. - Takes an integer ranges -64 to 256. Defaults to unset and kernel's default is used.</para> + <para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative. Takes + an integer in the range from -64 to 256. Defaults to unset and kernel's default is used.</para> </listitem> </varlistentry> @@ -2935,7 +2901,7 @@ <refsect1> <title>[ControlledDelay] Section Options</title> - <para>The <literal>[ControlledDelay]</literal> section manages the queueing discipline (qdisc) of + <para>The [ControlledDelay] section manages the queueing discipline (qdisc) of controlled delay (CoDel).</para> <variablelist class='network-directives'> @@ -2945,8 +2911,9 @@ <varlistentry> <term><varname>PacketLimit=</varname></term> <listitem> - <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are - dropped. An unsigned integer ranges 0 to 4294967294. Defaults to unset and kernel's default is used.</para> + <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, + incoming packets are dropped. An unsigned integer in the range 0–4294967294. Defaults to unset and + kernel's default is used.</para> </listitem> </varlistentry> @@ -2986,8 +2953,8 @@ <refsect1> <title>[DeficitRoundRobinScheduler] Section Options</title> - <para>The <literal>[DeficitRoundRobinScheduler]</literal> section manages the queueing discipline (qdisc) of - Deficit Round Robin Scheduler (DRR).</para> + <para>The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round + Robin Scheduler (DRR).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2997,8 +2964,8 @@ <refsect1> <title>[DeficitRoundRobinSchedulerClass] Section Options</title> - <para>The <literal>[DeficitRoundRobinSchedulerClass]</literal> section manages the traffic control class of - Deficit Round Robin Scheduler (DRR).</para> + <para>The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round + Robin Scheduler (DRR).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="tclass-parent" /> @@ -3019,8 +2986,8 @@ <refsect1> <title>[EnhancedTransmissionSelection] Section Options</title> - <para>The <literal>[EnhancedTransmissionSelection]</literal> section manages the queueing discipline (qdisc) of - Enhanced Transmission Selection (ETS).</para> + <para>The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced + Transmission Selection (ETS).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3029,18 +2996,17 @@ <varlistentry> <term><varname>Bands=</varname></term> <listitem> - <para>Specifies the number of bands. An unsigned integer ranges 1 to 16. This value has to be - at least large enough to cover the strict bands specified through the - <varname>StrictBands=</varname> and bandwidth-sharing bands specified in - <varname>QuantumBytes=</varname>.</para> + <para>Specifies the number of bands. An unsigned integer in the range 1–16. This value has to be at + least large enough to cover the strict bands specified through the <varname>StrictBands=</varname> + and bandwidth-sharing bands specified in <varname>QuantumBytes=</varname>.</para> </listitem> </varlistentry> <varlistentry> <term><varname>StrictBands=</varname></term> <listitem> - <para>Specifies the number of bands that should be created in strict mode. An unsigned integer - ranges 1 to 16.</para> + <para>Specifies the number of bands that should be created in strict mode. An unsigned integer in + the range 1–16.</para> </listitem> </varlistentry> @@ -3071,8 +3037,8 @@ <refsect1> <title>[GenericRandomEarlyDetection] Section Options</title> - <para>The <literal>[GenericRandomEarlyDetection]</literal> section manages the queueing discipline - (qdisc) of Generic Random Early Detection (GRED).</para> + <para>The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random + Early Detection (GRED).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3105,8 +3071,8 @@ <refsect1> <title>[FairQueueingControlledDelay] Section Options</title> - <para>The <literal>[FairQueueingControlledDelay]</literal> section manages the queueing discipline - (qdisc) of fair queuing controlled delay (FQ-CoDel).</para> + <para>The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing + controlled delay (FQ-CoDel).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3156,7 +3122,7 @@ <varlistentry> <term><varname>QuantumBytes=</varname></term> <listitem> - <para>Specifies the number of bytes used as 'deficit' in the fair queuing algorithmtimespan. + <para>Specifies the number of bytes used as the "deficit" in the fair queuing algorithm timespan. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para> </listitem> @@ -3182,8 +3148,8 @@ <refsect1> <title>[FairQueueing] Section Options</title> - <para>The <literal>[FairQueueing]</literal> section manages the queueing discipline - (qdisc) of fair queue traffic policing (FQ).</para> + <para>The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing + (FQ).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3271,8 +3237,8 @@ <refsect1> <title>[TrivialLinkEqualizer] Section Options</title> - <para>The <literal>[TrivialLinkEqualizer]</literal> section manages the queueing discipline (qdisc) of - trivial link equalizer (teql).</para> + <para>The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link + equalizer (teql).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3292,8 +3258,8 @@ <refsect1> <title>[HierarchyTokenBucket] Section Options</title> - <para>The <literal>[HierarchyTokenBucket]</literal> section manages the queueing discipline (qdisc) of - hierarchy token bucket (htb).</para> + <para>The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token + bucket (htb).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3319,8 +3285,8 @@ <refsect1> <title>[HierarchyTokenBucketClass] Section Options</title> - <para>The <literal>[HierarchyTokenBucketClass]</literal> section manages the traffic control class of - hierarchy token bucket (htb).</para> + <para>The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket + (htb).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="tclass-parent" /> @@ -3401,8 +3367,8 @@ <refsect1> <title>[HeavyHitterFilter] Section Options</title> - <para>The <literal>[HeavyHitterFilter]</literal> section manages the queueing discipline - (qdisc) of Heavy Hitter Filter (hhf).</para> + <para>The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter + (hhf).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3411,8 +3377,9 @@ <varlistentry> <term><varname>PacketLimit=</varname></term> <listitem> - <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are - dropped. An unsigned integer ranges 0 to 4294967294. Defaults to unset and kernel's default is used.</para> + <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, + incoming packets are dropped. An unsigned integer in the range 0–4294967294. Defaults to unset and + kernel's default is used.</para> </listitem> </varlistentry> </variablelist> @@ -3420,8 +3387,8 @@ <refsect1> <title>[QuickFairQueueing] Section Options</title> - <para>The <literal>[QuickFairQueueing]</literal> section manages the queueing discipline - (qdisc) of Quick Fair Queueing (QFQ).</para> + <para>The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing + (QFQ).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3431,8 +3398,8 @@ <refsect1> <title>[QuickFairQueueingClass] Section Options</title> - <para>The <literal>[QuickFairQueueingClass]</literal> section manages the traffic control class of - Quick Fair Queueing (qfq).</para> + <para>The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing + (qfq).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="tclass-parent" /> @@ -3459,9 +3426,9 @@ <refsect1> <title>[BridgeVLAN] Section Options</title> - <para>The <literal>[BridgeVLAN]</literal> section manages the VLAN ID configuration of a bridge port and accepts - the following keys. Specify several <literal>[BridgeVLAN]</literal> sections to configure several VLAN entries. - The <varname>VLANFiltering=</varname> option has to be enabled, see <literal>[Bridge]</literal> section in + <para>The [BridgeVLAN] section manages the VLAN ID configuration of a bridge port and accepts the + following keys. Specify several [BridgeVLAN] sections to configure several VLAN entries. The + <varname>VLANFiltering=</varname> option has to be enabled, see the [Bridge] section in <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> <variablelist class='network-directives'> |