diff options
Diffstat (limited to 'upstream/opensuse-tumbleweed/man5/systemd.network.5')
| -rw-r--r-- | upstream/opensuse-tumbleweed/man5/systemd.network.5 | 1428 |
1 files changed, 1363 insertions, 65 deletions
diff --git a/upstream/opensuse-tumbleweed/man5/systemd.network.5 b/upstream/opensuse-tumbleweed/man5/systemd.network.5 index f7cae0db..3a1b53f8 100644 --- a/upstream/opensuse-tumbleweed/man5/systemd.network.5 +++ b/upstream/opensuse-tumbleweed/man5/systemd.network.5 @@ -1,5 +1,5 @@ '\" t -.TH "SYSTEMD\&.NETWORK" "5" "" "systemd 254" "systemd.network" +.TH "SYSTEMD\&.NETWORK" "5" "" "systemd 255" "systemd.network" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -42,7 +42,9 @@ and /usr/local/lib/systemd/network, the volatile runtime network directory /run/systemd/network and the local administration network directory -/etc/systemd/network\&. All configuration files are collectively sorted and processed in alphanumeric order, regardless of the directories in which they live\&. However, files with identical filenames replace each other\&. It is recommended that each filename is prefixed with a number (e\&.g\&. +/etc/systemd/network\&. All configuration files are collectively sorted and processed in alphanumeric order, regardless of the directories in which they live\&. However, files with identical filenames replace each other\&. It is recommended that each filename is prefixed with a number smaller than +"70" +(e\&.g\&. 10\-eth0\&.network)\&. Otherwise, the default \&.network files or those generated by @@ -80,6 +82,17 @@ which in turn take precedence over those in .PP The network file contains a [Match] section, which determines if a given network file may be applied to a given interface; and a [Network] section specifying how the interface should be configured\&. The first (in alphanumeric order) of the network files that matches a given interface is applied, all later files are ignored, even if they match as well\&. .PP +Note that any network interfaces that have the +\fIID_NET_MANAGED_BY=\fR +udev property set will never be matched by any \&.network files \(en unless the property\*(Aqs value is the string +"io\&.systemd\&.Network" +\(en even if the [Match] section would otherwise match\&. This may be used to exclude specific network interfaces from +\fBsystemd\-networkd\fR\*(Aqs management, while keeping the [Match] section generic\&. The +\fIID_NET_MANAGED_BY=\fR +property thus declares intended +\fIownership\fR +of the device, and permits ensuring that concurrent network management implementations do not compete for management of specific devices\&. +.PP 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 \fBsystemd\-networkd\fR warns about that\&. Hint: to avoid the warning and to make it clear that all interfaces shall be matched, add the following: @@ -106,6 +119,8 @@ Each field must be one byte\&. E\&.g\&. "12:34:56:78:90:ab" or "AA:BB:CC:DD:EE:FF"\&. +.sp +Added in version 250\&. .RE .PP \fBhyphen\-delimited hexadecimal\fR @@ -114,6 +129,8 @@ Each field must be one byte\&. E\&.g\&. "12\-34\-56\-78\-90\-ab" or "AA\-BB\-CC\-DD\-EE\-FF"\&. +.sp +Added in version 250\&. .RE .PP \fBdot\-delimited hexadecimal\fR @@ -122,6 +139,8 @@ Each field must be two bytes\&. E\&.g\&. "1234\&.5678\&.90ab" or "AABB\&.CCDD\&.EEFF"\&. +.sp +Added in version 250\&. .RE .PP \fBIPv4 address format\fR @@ -130,6 +149,8 @@ E\&.g\&. "127\&.0\&.0\&.1" or "192\&.168\&.0\&.1"\&. +.sp +Added in version 250\&. .RE .PP \fBIPv6 address format\fR @@ -138,9 +159,13 @@ E\&.g\&. "2001:0db8:85a3::8a2e:0370:7334" or "::1"\&. +.sp +Added in version 250\&. .RE .sp The total length of each MAC address must be 4 (for IPv4 tunnel), 6 (for Ethernet), 16 (for IPv6 tunnel), or 20 (for InfiniBand)\&. 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 of hardware addresses defined prior to this is reset\&. Defaults to unset\&. +.sp +Added in version 211\&. .RE .PP \fIPermanentMACAddress=\fR @@ -148,12 +173,16 @@ The total length of each MAC address must be 4 (for IPv4 tunnel), 6 (for Etherne A whitespace\-separated list of hardware\*(Aqs permanent addresses\&. While \fIMACAddress=\fR matches the device\*(Aqs current MAC address, this matches the device\*(Aqs permanent MAC address, which may be different from the current one\&. Use full colon\-, hyphen\- or dot\-delimited hexadecimal, or IPv4 or IPv6 address format\&. 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 of hardware addresses defined prior to this is reset\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fIPath=\fR .RS 4 A whitespace\-separated list of shell\-style globs matching the persistent path, as exposed by the udev property \fIID_PATH\fR\&. +.sp +Added in version 211\&. .RE .PP \fIDriver=\fR @@ -163,6 +192,8 @@ A whitespace\-separated list of shell\-style globs matching the driver currently of its parent device, or if that is not set, the driver as exposed by \fBethtool \-i\fR of the device itself\&. If the list is prefixed with a "!", the test is inverted\&. +.sp +Added in version 211\&. .RE .PP \fIType=\fR @@ -178,6 +209,8 @@ attribute, or "ARPHRD_" macros in linux/if_arp\&.h, so this is not comprehensive\&. +.sp +Added in version 211\&. .RE .PP \fIKind=\fR @@ -193,6 +226,8 @@ or "veth"\&. Valid kinds are given by netlink\*(Aqs "IFLA_INFO_KIND" attribute, so this is not comprehensive\&. +.sp +Added in version 251\&. .RE .PP \fIProperty=\fR @@ -213,12 +248,16 @@ Property=ID_MODEL_ID=9999 "ID_VENDOR_FROM_DATABASE=vendor name" "KEY=with \e"quo .\} .sp then, the \&.link file matches only when an interface has all the above three properties\&. +.sp +Added in version 243\&. .RE .PP \fIName=\fR .RS 4 A whitespace\-separated list of shell\-style globs matching the device name, as exposed by the udev property "INTERFACE", or device\*(Aqs alternative names\&. If the list is prefixed with a "!", the test is inverted\&. +.sp +Added in version 211\&. .RE .PP \fIWLANInterfaceType=\fR @@ -236,17 +275,23 @@ A whitespace\-separated list of wireless network type\&. Supported values are "p2p\-device", "ocb", and "nan"\&. If the list is prefixed with a "!", the test is inverted\&. +.sp +Added in version 244\&. .RE .PP \fISSID=\fR .RS 4 A whitespace\-separated list of shell\-style globs matching the SSID of the currently connected wireless LAN\&. If the list is prefixed with a "!", the test is inverted\&. +.sp +Added in version 244\&. .RE .PP \fIBSSID=\fR .RS 4 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 \fIMACAddress=\fR\&. 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\&. +.sp +Added in version 244\&. .RE .PP \fIHost=\fR @@ -256,6 +301,8 @@ Matches against the hostname or machine ID of the host\&. See in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIVirtualization=\fR @@ -265,6 +312,8 @@ Checks whether the system is executed in a virtualized environment and optionall in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIKernelCommandLine=\fR @@ -274,6 +323,8 @@ Checks whether a specific kernel command line option is set\&. See in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIKernelVersion=\fR @@ -284,6 +335,8 @@ Checks whether the kernel version (as reported by in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 237\&. .RE .PP \fICredential=\fR @@ -293,6 +346,8 @@ systemd\-udevd\&.service service\&. See \m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[1]\d\s+2 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 252\&. .RE .PP \fIArchitecture=\fR @@ -302,6 +357,8 @@ Checks whether the system is running on a specific architecture\&. See in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 211\&. .RE .PP \fIFirmware=\fR @@ -311,6 +368,8 @@ Checks whether the system is running on a machine with the specified firmware\&. in \fBsystemd.unit\fR(5) for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&. +.sp +Added in version 249\&. .RE .SH "[LINK] SECTION OPTIONS" .PP @@ -319,6 +378,8 @@ The [Link] section accepts the following keys: \fIMACAddress=\fR .RS 4 The hardware address to set for the device\&. +.sp +Added in version 218\&. .RE .PP \fIMTUBytes=\fR @@ -326,6 +387,8 @@ The hardware address to set for the device\&. 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\&. .sp Note that if IPv6 is enabled on the interface, and the MTU is chosen below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value\&. +.sp +Added in version 218\&. .RE .PP \fIARP=\fR @@ -333,16 +396,22 @@ Note that if IPv6 is enabled on the interface, and the MTU is chosen below 1280 Takes a boolean\&. If set to true, the ARP (low\-level Address Resolution Protocol) for this interface is enabled\&. When unset, the kernel\*(Aqs default will be used\&. .sp For example, disabling ARP is useful when creating multiple MACVLAN or VLAN virtual interfaces atop a single lower\-level physical interface, which will then only serve as a link/"bridge" device aggregating traffic to the same physical link and not participate in the network otherwise\&. Defaults to unset\&. +.sp +Added in version 232\&. .RE .PP \fIMulticast=\fR .RS 4 Takes a boolean\&. If set to true, the multicast flag on the device is enabled\&. Defaults to unset\&. +.sp +Added in version 239\&. .RE .PP \fIAllMulticast=\fR .RS 4 Takes a boolean\&. If set to true, the driver retrieves all multicast packets from the network\&. This happens when multicast routing is enabled\&. Defaults to unset\&. +.sp +Added in version 239\&. .RE .PP \fIPromiscuous=\fR @@ -354,6 +423,8 @@ If this is set to false for the underlying link of a mode MACVLAN/MACVTAP, the virtual interface will be created with the "nopromisc" flag set\&. +.sp +Added in version 248\&. .RE .PP \fIUnmanaged=\fR @@ -363,11 +434,15 @@ Takes a boolean\&. When "no"\&. .sp This is useful for preventing later matching network files from interfering with certain interfaces that are fully controlled by other applications\&. +.sp +Added in version 233\&. .RE .PP \fIGroup=\fR .RS 4 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\&. Takes an unsigned integer in the range 0\&...2147483647\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIRequiredForOnline=\fR @@ -407,6 +482,8 @@ The network will be brought up normally (as configured by \fBsystemd\-networkd\-wait\-online\fR if "RequiredForOnline=no"\&. +.sp +Added in version 236\&. .RE .PP \fIRequiredFamilyForOnline=\fR @@ -417,11 +494,10 @@ Takes an address family\&. When specified, an IP address in the given family is "ipv6", "both", or "any"\&. Defaults to -"any"\&. Note that this option has no effect if -"RequiredForOnline=no", or if -"RequiredForOnline=" -specifies a minimum operational state below -"degraded"\&. +"no"\&. Note that this option has no effect if +"RequiredForOnline=no"\&. +.sp +Added in version 249\&. .RE .PP \fIActivationPolicy=\fR @@ -488,6 +564,8 @@ does not mean the link will never lose carrier\&. The link carrier depends on bo "always\-up", \fIIgnoreCarrierLoss=\fR is forced to true\&. +.sp +Added in version 248\&. .RE .SH "[SR\-IOV] SECTION OPTIONS" .PP @@ -496,16 +574,22 @@ The [SR\-IOV] section accepts the following keys\&. Specify several [SR\-IOV] se \fIVirtualFunction=\fR .RS 4 Specifies a Virtual Function (VF), lightweight PCIe function designed solely to move data in and out\&. Takes an integer in the range 0\&...2147483646\&. This option is compulsory\&. +.sp +Added in version 251\&. .RE .PP \fIVLANId=\fR .RS 4 Specifies VLAN ID of the virtual function\&. Takes an integer in the range 1\&...4095\&. +.sp +Added in version 251\&. .RE .PP \fIQualityOfService=\fR .RS 4 Specifies quality of service of the virtual function\&. Takes an integer in the range 1\&...4294967294\&. +.sp +Added in version 251\&. .RE .PP \fIVLANProtocol=\fR @@ -514,21 +598,29 @@ Specifies VLAN protocol of the virtual function\&. Takes "802\&.1Q" or "802\&.1ad"\&. +.sp +Added in version 251\&. .RE .PP \fIMACSpoofCheck=\fR .RS 4 Takes a boolean\&. Controls the MAC spoof checking\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .PP \fIQueryReceiveSideScaling=\fR .RS 4 Takes a boolean\&. Toggle the ability of querying the receive side scaling (RSS) configuration of the virtual function (VF)\&. The VF RSS information like RSS hash key may be considered sensitive on some devices where this information is shared between VF and the physical function (PF)\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .PP \fITrust=\fR .RS 4 Takes a boolean\&. Allows one to set trust mode of the virtual function (VF)\&. When set, VF users can set a specific feature which may impact security and/or performance\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .PP \fILinkState=\fR @@ -541,11 +633,15 @@ means a reflection of the physical function (PF) link state, lets the VF to communicate with other VFs on this host even if the PF link state is down, "no" causes the hardware to drop any packets sent by the VF\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .PP \fIMACAddress=\fR .RS 4 Specifies the MAC address for the virtual function\&. +.sp +Added in version 251\&. .RE .SH "[NETWORK] SECTION OPTIONS" .PP @@ -554,6 +650,8 @@ The [Network] section accepts the following keys: \fIDescription=\fR .RS 4 A description of the device\&. This is only used for presentation purposes\&. +.sp +Added in version 211\&. .RE .PP \fIDHCP=\fR @@ -575,6 +673,8 @@ Furthermore, note that by default the domain name specified through DHCP is not below\&. .sp See the [DHCPv4] or [DHCPv6] sections below for further configuration options for the DHCP client support\&. +.sp +Added in version 211\&. .RE .PP \fIDHCPServer=\fR @@ -582,13 +682,13 @@ See the [DHCPv4] or [DHCPv6] sections below for further configuration options fo Takes a boolean\&. If set to "yes", DHCPv4 server will be started\&. Defaults to "no"\&. Further settings for the DHCP server may be set in the [DHCPServer] section described below\&. +.sp +Added in version 215\&. .RE .PP \fILinkLocalAddressing=\fR .RS 4 -Enables link\-local address autoconfiguration\&. Accepts -\fByes\fR, -\fBno\fR, +Enables link\-local address autoconfiguration\&. Accepts a boolean, \fBipv4\fR, and \fBipv6\fR\&. An IPv6 link\-local address is configured when \fByes\fR @@ -611,6 +711,8 @@ has \fIMode=passthru\fR, or \fBipv6\fR otherwise\&. +.sp +Added in version 219\&. .RE .PP \fIIPv6LinkLocalAddressGenerationMode=\fR @@ -641,6 +743,8 @@ or "ipv6", setting \fIIPv6LinkLocalAddressGenerationMode=none\fR disables to configure an IPv6 link\-local address\&. +.sp +Added in version 246\&. .RE .PP \fIIPv6StableSecretAddress=\fR @@ -653,16 +757,22 @@ is implied\&. If this setting is not specified, and "stable\-privacy" is set to \fIIPv6LinkLocalAddressGenerationMode=\fR, then a stable secret address will be generated from the local machine ID and the interface name\&. +.sp +Added in version 249\&. .RE .PP \fIIPv4LLStartAddress=\fR .RS 4 Specifies the first IPv4 link\-local address to try\&. Takes an IPv4 address for example 169\&.254\&.1\&.2, from the link\-local address range: 169\&.254\&.0\&.0/16 except for 169\&.254\&.0\&.0/24 and 169\&.254\&.255\&.0/24\&. This setting may be useful if the device should always have the same address as long as there is no address conflict\&. When unset, a random address will be automatically selected\&. Defaults to unset\&. +.sp +Added in version 252\&. .RE .PP \fIIPv4LLRoute=\fR .RS 4 Takes a boolean\&. If set to true, sets up the route needed for non\-IPv4LL hosts to communicate with IPv4LL\-only hosts\&. Defaults to false\&. +.sp +Added in version 216\&. .RE .PP \fIDefaultRouteOnDevice=\fR @@ -719,6 +829,8 @@ Table=1234 .if n \{\ .RE .\} +.sp +Added in version 243\&. .RE .PP \fILLMNR=\fR @@ -729,6 +841,8 @@ Takes a boolean or on the link\&. When set to "resolve", only resolution is enabled, but not host registration and announcement\&. Defaults to true\&. This setting is read by \fBsystemd-resolved.service\fR(8)\&. +.sp +Added in version 216\&. .RE .PP \fIMulticastDNS=\fR @@ -739,6 +853,8 @@ Takes a boolean or support on the link\&. When set to "resolve", only resolution is enabled, but not host or service registration and announcement\&. Defaults to false\&. This setting is read by \fBsystemd-resolved.service\fR(8)\&. +.sp +Added in version 229\&. .RE .PP \fIDNSOverTLS=\fR @@ -752,6 +868,8 @@ support on the link\&. When set to \fIDNSOverTLS=\fR option\&. Defaults to unset, and the global setting will be used\&. This setting is read by \fBsystemd-resolved.service\fR(8)\&. +.sp +Added in version 239\&. .RE .PP \fIDNSSEC=\fR @@ -765,12 +883,16 @@ DNS validation support on the link\&. When set to \fIDNSSEC=\fR option\&. Defaults to unset, and the global setting will be used\&. This setting is read by \fBsystemd-resolved.service\fR(8)\&. +.sp +Added in version 229\&. .RE .PP \fIDNSSECNegativeTrustAnchors=\fR .RS 4 A space\-separated list of DNSSEC negative trust anchor domains\&. If specified and DNSSEC is enabled, look\-ups done via the interface\*(Aqs DNS server will be subject to the list of negative trust anchors, and not require authentication for the specified domains, or anything below it\&. Use this to disable DNSSEC authentication for specific private domains, that cannot be proven valid using the Internet DNS hierarchy\&. Defaults to the empty list\&. This setting is read by \fBsystemd-resolved.service\fR(8)\&. +.sp +Added in version 229\&. .RE .PP \fILLDP=\fR @@ -784,6 +906,8 @@ is set only LLDP data of various types of routers is collected and LLDP data abo to query the collected neighbor data\&. LLDP is only available on Ethernet links\&. See \fIEmitLLDP=\fR below for enabling LLDP packet emission from the local system\&. +.sp +Added in version 219\&. .RE .PP \fIEmitLLDP=\fR @@ -805,6 +929,8 @@ permits propagation until a customer bridge is reached\&. For details about thes "nearest\-bridge", the recommended and most restricted level of propagation\&. See \fILLDP=\fR above for an option to enable LLDP reception\&. +.sp +Added in version 230\&. .RE .PP \fIBindCarrier=\fR @@ -815,6 +941,8 @@ This forces \fIActivationPolicy=\fR to be set to "bound"\&. +.sp +Added in version 220\&. .RE .PP \fIAddress=\fR @@ -829,6 +957,8 @@ If the specified address is (for IPv4) or "::" (for IPv6), a new address range of the requested size is automatically allocated from a system\-wide pool of unused ranges\&. Note that the prefix length must be equal or larger than 8 for IPv4, and 64 for IPv6\&. The allocated range is checked against all current network interfaces and all known network configuration files to avoid address range conflicts\&. The default system\-wide pool consists of 192\&.168\&.0\&.0/16, 172\&.16\&.0\&.0/12 and 10\&.0\&.0\&.0/8 for IPv4, and fd00::/8 for IPv6\&. This functionality is useful to manage a large number of dynamically created network interfaces with the same network configuration and automatic address range assignment\&. +.sp +Added in version 211\&. .RE .PP \fIGateway=\fR @@ -837,6 +967,8 @@ The gateway address, which must be in the format described in \fBinet_pton\fR(3)\&. This is a short\-hand for a [Route] section only containing a \fIGateway=\fR key\&. This option may be specified more than once\&. +.sp +Added in version 211\&. .RE .PP \fIDNS=\fR @@ -851,6 +983,8 @@ for IPv4 and "[1111:2222::3333]:9953%ifname#example\&.com" for IPv6\&. If an empty string is assigned, then the all previous assignments are cleared\&. This setting is read by \fBsystemd-resolved.service\fR(8)\&. +.sp +Added in version 211\&. .RE .PP \fIDomains=\fR @@ -870,6 +1004,8 @@ and \fIsearch\fR entries in \fBresolv.conf\fR(5)\&. Domain name routing has no equivalent in the traditional glibc API, which has no concept of domain name servers limited to a specific link\&. +.sp +Added in version 216\&. .RE .PP \fIDNSDefaultRoute=\fR @@ -877,12 +1013,16 @@ entries in Takes a boolean argument\&. If true, this link\*(Aqs configured DNS servers are used for resolving domain names that do not match any link\*(Aqs configured \fIDomains=\fR setting\&. If false, this link\*(Aqs configured DNS servers are never used for such domains, and are exclusively used for resolving names that match at least one of the domains configured on this link\&. If not specified defaults to an automatic mode: queries not matching any link\*(Aqs configured domains will be routed to this link if it has no routing\-only domains configured\&. +.sp +Added in version 240\&. .RE .PP \fINTP=\fR .RS 4 An NTP server address (either an IP address, or a hostname)\&. This option may be specified more than once\&. This setting is read by \fBsystemd-timesyncd.service\fR(8)\&. +.sp +Added in version 216\&. .RE .PP \fIIPForward=\fR @@ -902,6 +1042,8 @@ for details about sysctl options)\&. Defaults to Note: this setting controls a global kernel option, and does so one way only: if a network that has this setting enabled is set up the global setting is turned on\&. However, it is never turned off again, even after all networks with this setting enabled are shut down again\&. .sp To allow IP packet forwarding only between specific network interfaces use a firewall\&. +.sp +Added in version 219\&. .RE .PP \fIIPMasquerade=\fR @@ -923,7 +1065,9 @@ Note\&. Any positive boolean values such as "yes" or "true" -are now deprecated\&. Please use one of the values in the above\&. +are now deprecated\&. Please use one of the values above\&. +.sp +Added in version 219\&. .RE .PP \fIIPv6PrivacyExtensions=\fR @@ -937,6 +1081,8 @@ and "kernel", the kernel\*(Aqs default setting will be left in place\&. When unspecified, the value specified in the same setting in \fBnetworkd.conf\fR(5), which defaults to "no", will be used\&. +.sp +Added in version 222\&. .RE .PP \fIIPv6AcceptRA=\fR @@ -956,38 +1102,68 @@ in the kernel documentation regarding Note that kernel\*(Aqs implementation of the IPv6 RA protocol is always disabled, regardless of this setting\&. If this option is enabled, a userspace implementation of the IPv6 RA protocol is used, and the kernel\*(Aqs own implementation remains disabled, since \fBsystemd\-networkd\fR needs to know all details supplied in the advertisements, and these are not available from the kernel if the kernel\*(Aqs own implementation is used\&. +.sp +Added in version 231\&. .RE .PP \fIIPv6DuplicateAddressDetection=\fR .RS 4 Configures the amount of IPv6 Duplicate Address Detection (DAD) probes to send\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 228\&. .RE .PP \fIIPv6HopLimit=\fR .RS 4 -Configures IPv6 Hop Limit\&. For each router that forwards the packet, the hop limit is decremented by 1\&. When the hop limit field reaches zero, the packet is discarded\&. When unset, the kernel\*(Aqs default will be used\&. +Configures IPv6 Hop Limit\&. Takes an integer in the range 1\&...255\&. For each router that forwards the packet, the hop limit is decremented by 1\&. When the hop limit field reaches zero, the packet is discarded\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 228\&. +.RE +.PP +\fIIPv4ReversePathFilter=\fR +.RS 4 +Configure IPv4 Reverse Path Filtering\&. If enabled, when an IPv4 packet is received, the machine will first check whether the +\fIsource\fR +of the packet would be routed through the interface it came in\&. If there is no route to the source on that interface, the machine will drop the packet\&. Takes one of +"no", +"strict", or +"loose"\&. When +"no", no source validation will be done\&. When +"strict", mode each incoming packet is tested against the FIB and if the incoming interface is not the best reverse path, the packet check will fail\&. By default failed packets are discarded\&. When +"loose", mode each incoming packet\*(Aqs source address is tested against the FIB\&. The packet is dropped only if the source address is not reachable via any interface on that router\&. See +\m[blue]\fBRFC 3704\fR\m[]\&\s-2\u[9]\d\s+2\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 255\&. .RE .PP \fIIPv4AcceptLocal=\fR .RS 4 Takes a boolean\&. Accept packets with local source addresses\&. In combination with suitable routing, this can be used to direct packets between two local interfaces over the wire and have them accepted properly\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 246\&. .RE .PP \fIIPv4RouteLocalnet=\fR .RS 4 Takes a boolean\&. When true, the kernel does not consider loopback addresses as martian source or destination while routing\&. This enables the use of 127\&.0\&.0\&.0/8 for local routing purposes\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 248\&. .RE .PP \fIIPv4ProxyARP=\fR .RS 4 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 \m[blue]\fBRFC 1027\fR\m[]\&\s-2\u[9]\d\s+2\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 233\&. .RE .PP \fIIPv6ProxyNDP=\fR .RS 4 Takes a boolean\&. Configures proxy NDP for IPv6\&. Proxy NDP (Neighbor Discovery Protocol) is a technique for IPv6 to allow routing of addresses to a different destination when peers expect them to be present on a certain physical link\&. In this case a router answers Neighbour Advertisement messages intended for another machine by offering its own MAC address as destination\&. Unlike proxy ARP for IPv4, it is not enabled globally, but will only send Neighbour Advertisement messages for addresses in the IPv6 neighbor proxy table, which can also be shown by \fBip \-6 neighbour show proxy\fR\&. systemd\-networkd will control the per\-interface `proxy_ndp` switch for each configured interface depending on this option\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 234\&. .RE .PP \fIIPv6ProxyNDPAddress=\fR @@ -999,6 +1175,8 @@ entries to the kernel\*(Aqs IPv6 neighbor proxy table\&. This setting implies but has no effect if \fIIPv6ProxyNDP=\fR has been set to false\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 233\&. .RE .PP \fIIPv6SendRA=\fR @@ -1008,6 +1186,8 @@ Whether to enable or disable Router Advertisement sending on a link\&. Takes a b is enabled, then the delegated prefixes are also distributed\&. See \fIDHCPPrefixDelegation=\fR setting and the [IPv6SendRA], [IPv6Prefix], [IPv6RoutePrefix], and [DHCPPrefixDelegation] sections for more configuration options\&. +.sp +Added in version 247\&. .RE .PP \fIDHCPPrefixDelegation=\fR @@ -1015,11 +1195,15 @@ setting and the [IPv6SendRA], [IPv6Prefix], [IPv6RoutePrefix], and [DHCPPrefixDe Takes a boolean value\&. When enabled, requests subnet prefixes on another link via the DHCPv6 protocol or via the 6RD option in the DHCPv4 protocol\&. An address within each delegated prefix will be assigned, and the prefixes will be announced through IPv6 Router Advertisement if \fIIPv6SendRA=\fR is enabled\&. This behaviour can be configured in the [DHCPPrefixDelegation] section\&. Defaults to disabled\&. +.sp +Added in version 250\&. .RE .PP \fIIPv6MTUBytes=\fR .RS 4 Configures IPv6 maximum transmission unit (MTU)\&. An integer greater than or equal to 1280 bytes\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 239\&. .RE .PP \fIKeepMaster=\fR @@ -1031,18 +1215,24 @@ Takes a boolean value\&. When enabled, the current master interface index will n \fIVRF=\fR settings are ignored\&. This may be useful when a netdev with a master interface is created by another program, e\&.g\&. \fBsystemd-nspawn\fR(1)\&. Defaults to false\&. +.sp +Added in version 250\&. .RE .PP \fIBatmanAdvanced=\fR, \fIBond=\fR, \fIBridge=\fR, \fIVRF=\fR .RS 4 The name of the B\&.A\&.T\&.M\&.A\&.N\&. Advanced, bond, bridge, or VRF interface to add the link to\&. See \fBsystemd.netdev\fR(5)\&. +.sp +Added in version 211\&. .RE .PP \fIIPoIB=\fR, \fIIPVLAN=\fR, \fIIPVTAP=\fR, \fIMACsec=\fR, \fIMACVLAN=\fR, \fIMACVTAP=\fR, \fITunnel=\fR, \fIVLAN=\fR, \fIVXLAN=\fR, \fIXfrm=\fR .RS 4 The name of an IPoIB, IPVLAN, IPVTAP, MACsec, MACVLAN, MACVTAP, tunnel, VLAN, VXLAN, or Xfrm to be created on the link\&. See \fBsystemd.netdev\fR(5)\&. This option may be specified more than once\&. +.sp +Added in version 211\&. .RE .PP \fIActiveSlave=\fR @@ -1053,6 +1243,8 @@ option is only valid for following modes: "active\-backup", "balance\-alb", and "balance\-tlb"\&. Defaults to false\&. +.sp +Added in version 235\&. .RE .PP \fIPrimarySlave=\fR @@ -1063,6 +1255,8 @@ option is only valid for following modes: "active\-backup", "balance\-alb", and "balance\-tlb"\&. Defaults to false\&. +.sp +Added in version 235\&. .RE .PP \fIConfigureWithoutCarrier=\fR @@ -1070,6 +1264,8 @@ option is only valid for following modes: Takes a boolean\&. Allows networkd to configure a specific link even if it has no carrier\&. Defaults to false\&. If enabled, and the \fIIgnoreCarrierLoss=\fR setting is not explicitly set, then it is enabled as well\&. +.sp +Added in version 235\&. .RE .PP \fIIgnoreCarrierLoss=\fR @@ -1131,6 +1327,8 @@ in the [DHCPv4] section enabled, defaults to 5 seconds\&. Otherwise, defaults to is set to "always\-up", this is forced to "yes", and ignored any user specified values\&. +.sp +Added in version 242\&. .RE .PP \fIKeepConfiguration=\fR @@ -1162,6 +1360,8 @@ is running in initrd, when the root filesystem is a network filesystem, and "no" otherwise\&. +.sp +Added in version 243\&. .RE .SH "[ADDRESS] SECTION OPTIONS" .PP @@ -1172,6 +1372,8 @@ An [Address] section accepts the following keys\&. Specify several [Address] sec As in the [Network] section\&. This setting is mandatory\&. Each [Address] section can contain one \fIAddress=\fR setting\&. +.sp +Added in version 211\&. .RE .PP \fIPeer=\fR @@ -1179,6 +1381,8 @@ setting\&. The peer address in a point\-to\-point connection\&. Accepts the same format as the \fIAddress=\fR setting\&. +.sp +Added in version 216\&. .RE .PP \fIBroadcast=\fR @@ -1187,11 +1391,15 @@ Takes an IPv4 address or boolean value\&. The address must be in the format desc \fBinet_pton\fR(3)\&. If set to true, then the IPv4 broadcast address will be derived from the \fIAddress=\fR setting\&. If set to false, then the broadcast address will not be set\&. Defaults to true, except for wireguard interfaces, where it default to false\&. +.sp +Added in version 211\&. .RE .PP \fILabel=\fR .RS 4 Specifies the label for the IPv4 address\&. The label must be a 7\-bit ASCII string with a length of 1\&...15 characters\&. Defaults to unset\&. +.sp +Added in version 211\&. .RE .PP \fIPreferredLifetime=\fR @@ -1202,6 +1410,8 @@ Allows the default "preferred lifetime" of the address to be overridden\&. Only "0", which means that the address is considered immediately "expired" and will not be used, unless explicitly requested\&. A setting of \fBPreferredLifetime=0\fR is useful for addresses which are added to be used only by a specific application, which is then configured to use them explicitly\&. +.sp +Added in version 230\&. .RE .PP \fIScope=\fR @@ -1213,7 +1423,9 @@ The scope of the address, which can be (only valid on this device, will not traverse a gateway) or "host" (only valid within the device itself, e\&.g\&. 127\&.0\&.0\&.1) or an integer in the range 0\&...255\&. Defaults to -"global"\&. +"global"\&. IPv4 only \- IPv6 scope is automatically assigned by the kernel and cannot be set manually\&. +.sp +Added in version 235\&. .RE .PP \fIRouteMetric=\fR @@ -1221,12 +1433,16 @@ The scope of the address, which can be The metric of the prefix route, which is pointing to the subnet of the configured IP address, taking the configured prefix length into account\&. Takes an unsigned integer in the range 0\&...4294967295\&. When unset or set to 0, the kernel\*(Aqs default value is used\&. This setting will be ignored when \fIAddPrefixRoute=\fR is false\&. +.sp +Added in version 246\&. .RE .PP \fIHomeAddress=\fR .RS 4 Takes a boolean\&. Designates this address the "home address" as defined in \m[blue]\fBRFC 6275\fR\m[]\&\s-2\u[10]\d\s+2\&. Supported only on IPv6\&. Defaults to false\&. +.sp +Added in version 232\&. .RE .PP \fIDuplicateAddressDetection=\fR @@ -1246,17 +1462,23 @@ for IPv4 link\-local addresses, for IPv6 addresses, and "none" otherwise\&. +.sp +Added in version 232\&. .RE .PP \fIManageTemporaryAddress=\fR .RS 4 Takes a boolean\&. If true the kernel manage temporary addresses created from this one as template on behalf of Privacy Extensions \m[blue]\fBRFC 3041\fR\m[]\&\s-2\u[13]\d\s+2\&. For this to become active, the use_tempaddr sysctl setting has to be set to a value greater than zero\&. The given address needs to have a prefix length of 64\&. This flag allows using privacy extensions in a manually configured network, just like if stateless auto\-configuration was active\&. Defaults to false\&. +.sp +Added in version 232\&. .RE .PP \fIAddPrefixRoute=\fR .RS 4 Takes a boolean\&. When true, the prefix route for the address is automatically added\&. Defaults to true\&. +.sp +Added in version 245\&. .RE .PP \fIAutoJoin=\fR @@ -1271,6 +1493,8 @@ command with option "autojoin" we can get similar functionality for openvswitch (OVS) vxlan interfaces as well as other tunneling mechanisms that need to receive multicast traffic\&. Defaults to "no"\&. +.sp +Added in version 232\&. .RE .PP \fINetLabel=\fR\fIlabel\fR @@ -1341,6 +1565,113 @@ The effect of the above configuration and rules (in absence of other rules as ma "my_server_t" (and nothing else) to receive data from local subnet 10\&.0\&.0\&.0/8 of interface "eth0"\&. +.sp +Added in version 252\&. +.RE +.PP +\fINFTSet=\fR\fIsource\fR:\fIfamily\fR:\fItable\fR:\fIset\fR +.RS 4 +This setting provides a method for integrating network configuration into firewall rules with +\m[blue]\fBNFT\fR\m[]\&\s-2\u[17]\d\s+2 +sets\&. The benefit of using the setting is that static network configuration (or dynamically obtained network addresses, see similar directives in other sections) can be used in firewall rules with the indirection of NFT set types\&. For example, access could be granted for hosts in the local subnetwork only\&. Firewall rules using IP address of an interface are also instantly updated when the network configuration changes, for example via DHCP\&. +.sp +This option expects a whitespace separated list of NFT set definitions\&. Each definition consists of a colon\-separated tuple of source type (one of +"address", +"prefix" +or +"ifindex"), NFT address family (one of +"arp", +"bridge", +"inet", +"ip", +"ip6", or +"netdev"), table name and set name\&. The names of tables and sets must conform to lexical restrictions of NFT table names\&. The type of the element used in the NFT filter must match the type implied by the directive ("address", +"prefix" +or +"ifindex") and address type (IPv4 or IPv6) as shown in the table below\&. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&1.\ \&Defined \fIsource type\fR values +.TS +allbox tab(:); +lB lB lB. +T{ +Source type +T}:T{ +Description +T}:T{ +Corresponding NFT type name +T} +.T& +l l l +l l l +l l l. +T{ +"address" +T}:T{ +host IP address +T}:T{ +"ipv4_addr" or "ipv6_addr" +T} +T{ +"prefix" +T}:T{ +network prefix +T}:T{ +"ipv4_addr" or "ipv6_addr", with "flags interval" +T} +T{ +"ifindex" +T}:T{ +interface index +T}:T{ +"iface_index" +T} +.TE +.sp 1 +When an interface is configured with IP addresses, the addresses, subnetwork masks or interface index will be appended to the NFT sets\&. The information will be removed when the interface is deconfigured\&. +\fBsystemd\-networkd\fR +only inserts elements to (or removes from) the sets, so the related NFT rules, tables and sets must be prepared elsewhere in advance\&. Failures to manage the sets will be ignored\&. +.sp +Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +[Address] +NFTSet=prefix:netdev:filter:eth_ipv4_prefix +.fi +.if n \{\ +.RE +.\} +.sp +Corresponding NFT rules: +.sp +.if n \{\ +.RS 4 +.\} +.nf +table netdev filter { + set eth_ipv4_prefix { + type ipv4_addr + flags interval + } + chain eth_ingress { + type filter hook ingress device "eth0" priority filter; policy drop; + ip daddr != @eth_ipv4_prefix drop + accept + } +} +.fi +.if n \{\ +.RE +.\} +.sp +Added in version 255\&. .RE .SH "[NEIGHBOR] SECTION OPTIONS" .PP @@ -1349,20 +1680,26 @@ A [Neighbor] section accepts the following keys\&. The neighbor section adds a p \fIAddress=\fR .RS 4 The IP address of the neighbor\&. +.sp +Added in version 240\&. .RE .PP \fILinkLayerAddress=\fR .RS 4 The link layer address (MAC address or IP address) of the neighbor\&. +.sp +Added in version 243\&. .RE .SH "[IPV6ADDRESSLABEL] SECTION OPTIONS" .PP 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 -\m[blue]\fBRFC 3484\fR\m[]\&\s-2\u[17]\d\s+2\&. Precedence is managed by userspace, and only the label itself is stored in the kernel\&. +\m[blue]\fBRFC 3484\fR\m[]\&\s-2\u[18]\d\s+2\&. Precedence is managed by userspace, and only the label itself is stored in the kernel\&. .PP \fILabel=\fR .RS 4 The label for the prefix, an unsigned integer in the range 0\&...4294967294\&. 0xffffffff is reserved\&. This setting is mandatory\&. +.sp +Added in version 234\&. .RE .PP \fIPrefix=\fR @@ -1370,6 +1707,8 @@ The label for the prefix, an unsigned integer in the range 0\&...4294967294\&. 0 IPv6 prefix is an address with a prefix length, separated by a slash "/" character\&. This setting is mandatory\&. +.sp +Added in version 234\&. .RE .SH "[ROUTINGPOLICYRULE] SECTION OPTIONS" .PP @@ -1378,26 +1717,34 @@ An [RoutingPolicyRule] section accepts the following settings\&. Specify several \fITypeOfService=\fR .RS 4 This specifies the Type of Service (ToS) field of packets to match; it takes an unsigned integer in the range 0\&...255\&. The field can be used to specify precedence (the first 3 bits) and ToS (the next 3 bits)\&. The field can be also used to specify Differentiated Services Code Point (DSCP) (the first 6 bits) and Explicit Congestion Notification (ECN) (the last 2 bits)\&. See -\m[blue]\fBType of Service\fR\m[]\&\s-2\u[18]\d\s+2 +\m[blue]\fBType of Service\fR\m[]\&\s-2\u[19]\d\s+2 and -\m[blue]\fBDifferentiated services\fR\m[]\&\s-2\u[19]\d\s+2 +\m[blue]\fBDifferentiated services\fR\m[]\&\s-2\u[20]\d\s+2 for more details\&. +.sp +Added in version 235\&. .RE .PP \fIFrom=\fR .RS 4 Specifies the source address prefix to match\&. Possibly followed by a slash and the prefix length\&. +.sp +Added in version 235\&. .RE .PP \fITo=\fR .RS 4 Specifies the destination address prefix to match\&. Possibly followed by a slash and the prefix length\&. +.sp +Added in version 235\&. .RE .PP \fIFirewallMark=\fR .RS 4 Specifies the iptables firewall mark value to match (a number in the range 1\&...4294967295)\&. Optionally, the firewall mask (also a number between 1\&...4294967295) can be suffixed with a slash ("/"), e\&.g\&., "7/255"\&. +.sp +Added in version 235\&. .RE .PP \fITable=\fR @@ -1410,6 +1757,8 @@ Specifies the routing table identifier to look up if the rule selector matches\& in \fBnetworkd.conf\fR(5), or a number between 1 and 4294967295\&. Defaults to "main"\&. +.sp +Added in version 235\&. .RE .PP \fIPriority=\fR @@ -1417,26 +1766,36 @@ in Specifies the priority of this rule\&. \fIPriority=\fR is an integer in the range 0\&...4294967295\&. Higher number means lower priority, and rules get processed in order of increasing number\&. Defaults to unset, and the kernel will pick a value dynamically\&. +.sp +Added in version 235\&. .RE .PP \fIIncomingInterface=\fR .RS 4 Specifies incoming device to match\&. If the interface is loopback, the rule only matches packets originating from this host\&. +.sp +Added in version 236\&. .RE .PP \fIOutgoingInterface=\fR .RS 4 Specifies the outgoing device to match\&. The outgoing interface is only available for packets originating from local sockets that are bound to a device\&. +.sp +Added in version 236\&. .RE .PP \fISourcePort=\fR .RS 4 Specifies the source IP port or IP port range match in forwarding information base (FIB) rules\&. A port range is specified by the lower and upper port separated by a dash\&. Defaults to unset\&. +.sp +Added in version 240\&. .RE .PP \fIDestinationPort=\fR .RS 4 Specifies the destination IP port or IP port range match in forwarding information base (FIB) rules\&. A port range is specified by the lower and upper port separated by a dash\&. Defaults to unset\&. +.sp +Added in version 240\&. .RE .PP \fIIPProtocol=\fR @@ -1453,11 +1812,15 @@ or "17" for "udp"\&. Defaults to unset\&. +.sp +Added in version 240\&. .RE .PP \fIInvertRule=\fR .RS 4 A boolean\&. Specifies whether the rule is to be inverted\&. Defaults to false\&. +.sp +Added in version 240\&. .RE .PP \fIFamily=\fR @@ -1474,11 +1837,15 @@ nor \fIFrom=\fR are specified, then defaults to "ipv4"\&. +.sp +Added in version 243\&. .RE .PP \fIUser=\fR .RS 4 Takes a username, a user ID, or a range of user IDs separated by a dash\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fISuppressPrefixLength=\fR @@ -1488,6 +1855,8 @@ Takes a number in the range 0\&...128 and rejects routing decisions that have a prefix length of \fIN\fR or less\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fISuppressInterfaceGroup=\fR @@ -1496,6 +1865,8 @@ Takes an integer in the range 0\&...2147483647 and rejects routing decisions tha \fBsuppress_ifgroup\fR in \fBip rule\fR\&. Defaults to unset\&. +.sp +Added in version 250\&. .RE .PP \fIType=\fR @@ -1505,6 +1876,8 @@ Specifies Routing Policy Database (RPDB) rule type\&. Takes one of "unreachable" or "prohibit"\&. +.sp +Added in version 248\&. .RE .SH "[NEXTHOP] SECTION OPTIONS" .PP @@ -1513,11 +1886,15 @@ The [NextHop] section is used to manipulate entries in the kernel\*(Aqs "nexthop \fIId=\fR .RS 4 The id of the next hop\&. Takes an integer in the range 1\&...4294967295\&. If unspecified, then automatically chosen by kernel\&. +.sp +Added in version 244\&. .RE .PP \fIGateway=\fR .RS 4 As in the [Network] section\&. +.sp +Added in version 244\&. .RE .PP \fIFamily=\fR @@ -1530,12 +1907,16 @@ or \fIGateway=\fR is not specified, then defaults to "ipv4"\&. +.sp +Added in version 248\&. .RE .PP \fIOnLink=\fR .RS 4 Takes a boolean\&. If set to true, the kernel does not have to check if the gateway is reachable directly by the current machine (i\&.e\&., attached to the local network), so that we can insert the nexthop in the kernel table without it being complained about\&. Defaults to "no"\&. +.sp +Added in version 248\&. .RE .PP \fIBlackhole=\fR @@ -1544,6 +1925,8 @@ Takes a boolean\&. If enabled, packets to the corresponding routes are discarded \fIGateway=\fR cannot be specified\&. Defaults to "no"\&. +.sp +Added in version 248\&. .RE .PP \fIGroup=\fR @@ -1552,6 +1935,8 @@ Takes a whitespace separated list of nexthop IDs\&. Each ID must be in the range \fIGateway=\fR, \fIFamily=\fR, \fIBlackhole=\fR\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&. Defaults to unset\&. +.sp +Added in version 249\&. .RE .SH "[ROUTE] SECTION OPTIONS" .PP @@ -1567,33 +1952,43 @@ and or "_ipv6ra" is set, then the gateway address provided by DHCPv4 or IPv6 RA is used\&. +.sp +Added in version 211\&. .RE .PP \fIGatewayOnLink=\fR .RS 4 Takes a boolean\&. If set to true, the kernel does not have to check if the gateway is reachable directly by the current machine (i\&.e\&., attached to the local network), so that we can insert the route in the kernel table without it being complained about\&. Defaults to "no"\&. +.sp +Added in version 234\&. .RE .PP \fIDestination=\fR .RS 4 The destination prefix of the route\&. Possibly followed by a slash and the prefix length\&. If omitted, a full\-length host route is assumed\&. +.sp +Added in version 211\&. .RE .PP \fISource=\fR .RS 4 The source prefix of the route\&. Possibly followed by a slash and the prefix length\&. If omitted, a full\-length host route is assumed\&. +.sp +Added in version 218\&. .RE .PP \fIMetric=\fR .RS 4 The metric of the route\&. Takes an unsigned integer in the range 0\&...4294967295\&. Defaults to unset, and the kernel\*(Aqs default will be used\&. +.sp +Added in version 216\&. .RE .PP \fIIPv6Preference=\fR .RS 4 Specifies the route preference as defined in -\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[20]\d\s+2 +\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[21]\d\s+2 for Router Discovery messages\&. Which can be one of "low" the route has a lowest priority, @@ -1601,6 +1996,8 @@ the route has a lowest priority, the route has a default priority or "high" the route has a highest priority\&. +.sp +Added in version 234\&. .RE .PP \fIScope=\fR @@ -1689,12 +2086,16 @@ is "anycast", or "unicast"\&. In other cases, defaults to "global"\&. The value is not used for IPv6\&. +.sp +Added in version 219\&. .RE .PP \fIPreferredSource=\fR .RS 4 The preferred source address of the route\&. The address must be in the format described in \fBinet_pton\fR(3)\&. +.sp +Added in version 227\&. .RE .PP \fITable=\fR @@ -1716,6 +2117,16 @@ is "local" is used\&. In other cases, defaults to "main"\&. +.sp +Added in version 230\&. +.RE +.PP +\fIHopLimit=\fR +.RS 4 +Configures per route hop limit\&. Takes an integer in the range 1\&...255\&. See also +\fIIPv6HopLimit=\fR\&. +.sp +Added in version 255\&. .RE .PP \fIProtocol=\fR @@ -1728,6 +2139,8 @@ The protocol identifier for the route\&. Takes a number between 0 and 255 or the and "dhcp"\&. Defaults to "static"\&. +.sp +Added in version 234\&. .RE .PP \fIType=\fR @@ -1750,41 +2163,57 @@ Specifies the type for the route\&. Takes one of "prohibit", packets to the defined route are discarded and the ICMP message "Communication Administratively Prohibited" is generated\&. If "throw", route lookup in the current routing table will fail and the route selection process will return to Routing Policy Database (RPDB)\&. Defaults to "unicast"\&. +.sp +Added in version 235\&. .RE .PP \fIInitialCongestionWindow=\fR .RS 4 The TCP initial congestion window is used during the start of a TCP connection\&. During the start of a TCP session, when a client requests a resource, the server\*(Aqs initial congestion window determines how many packets will be sent during the initial burst of data without waiting for acknowledgement\&. Takes a number between 1 and 1023\&. Note that 100 is considered an extremely large value for this option\&. When unset, the kernel\*(Aqs default (typically 10) will be used\&. +.sp +Added in version 237\&. .RE .PP \fIInitialAdvertisedReceiveWindow=\fR .RS 4 The TCP initial advertised receive window is the amount of receive data (in bytes) that can initially be buffered at one time on a connection\&. The sending host can send only that amount of data before waiting for an acknowledgment and window update from the receiving host\&. Takes a number between 1 and 1023\&. Note that 100 is considered an extremely large value for this option\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 237\&. .RE .PP \fIQuickAck=\fR .RS 4 Takes a boolean\&. When true, the TCP quick ACK mode for the route is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 237\&. .RE .PP \fIFastOpenNoCookie=\fR .RS 4 Takes a boolean\&. When true enables TCP fastopen without a cookie on a per\-route basis\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 243\&. .RE .PP \fITTLPropagate=\fR .RS 4 Takes a boolean\&. When true enables TTL propagation at Label Switched Path (LSP) egress\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 243\&. .RE .PP \fIMTUBytes=\fR .RS 4 The maximum transmission unit in bytes to set for the route\&. The usual suffixes K, M, G, are supported and are understood to the base of 1024\&. +.sp +Added in version 239\&. .RE .PP \fITCPAdvertisedMaximumSegmentSize=\fR .RS 4 Specifies the Path MSS (in bytes) hints given on TCP layer\&. The usual suffixes K, M, G, are supported and are understood to the base of 1024\&. An unsigned integer in the range 1\&...4294967294\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 248\&. .RE .PP \fITCPCongestionControlAlgorithm=\fR @@ -1793,17 +2222,30 @@ Specifies the TCP congestion control algorithm for the route\&. Takes a name of "bbr", "dctcp", or "vegas"\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 252\&. +.RE +.PP +\fITCPRetransmissionTimeoutSec=\fR +.RS 4 +Specifies the TCP Retransmission Timeout (RTO) for the route\&. Takes time values in seconds\&. This value specifies the timeout of an alive TCP connection, when retransmissions remain unacknowledged\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 255\&. .RE .PP \fIMultiPathRoute=\fR\fI\fIaddress\fR\fR\fI[@\fR\fI\fIname\fR\fR\fI] [\fR\fI\fIweight\fR\fR\fI]\fR .RS 4 Configures multipath route\&. Multipath routing is the technique of using multiple alternative paths through a network\&. Takes gateway address\&. Optionally, takes a network interface name or index separated with "@", and a weight in 1\&.\&.256 for this multipath route separated with whitespace\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&. +.sp +Added in version 245\&. .RE .PP \fINextHop=\fR .RS 4 Specifies the nexthop id\&. Takes an unsigned integer in the range 1\&...4294967295\&. If set, the corresponding [NextHop] section must be configured\&. Defaults to unset\&. +.sp +Added in version 248\&. .RE .SH "[DHCPV4] SECTION OPTIONS" .PP @@ -1811,46 +2253,67 @@ The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the \fIDHCP=\fR setting described above: .PP +\fIRequestAddress=\fR +.RS 4 +Takes an IPv4 address\&. When specified, the Requested IP Address option (option code 50) is added with it to the initial DHCPDISCOVER message sent by the DHCP client\&. Defaults to unset, and an already assigned dynamic address to the interface is automatically picked\&. +.sp +Added in version 255\&. +.RE +.PP \fISendHostname=\fR .RS 4 When true (the default), the machine\*(Aqs hostname (or the value specified with \fIHostname=\fR, described below) will be sent to the DHCP server\&. Note that the hostname must consist only of 7\-bit ASCII lower\-case characters and no spaces or dots, and be formatted as a valid DNS domain name\&. Otherwise, the hostname is not sent even if this option is true\&. +.sp +Added in version 215\&. .RE .PP \fIHostname=\fR .RS 4 Use this value for the hostname which is sent to the DHCP server, instead of machine\*(Aqs hostname\&. Note that the specified hostname must consist only of 7\-bit ASCII lower\-case characters and no spaces or dots, and be formatted as a valid DNS domain name\&. +.sp +Added in version 223\&. .RE .PP \fIMUDURL=\fR .RS 4 When configured, the specified Manufacturer Usage Description (MUD) URL will be sent to the DHCPv4 server\&. Takes a URL of length up to 255 characters\&. A superficial verification that the string is a valid URL will be performed\&. DHCPv4 clients are intended to have at most one MUD URL associated with them\&. See -\m[blue]\fBRFC 8520\fR\m[]\&\s-2\u[21]\d\s+2\&. +\m[blue]\fBRFC 8520\fR\m[]\&\s-2\u[22]\d\s+2\&. .sp MUD is an embedded software standard defined by the IETF that allows IoT device makers to advertise device specifications, including the intended communication patterns for their device when it connects to the network\&. The network can then use this to author a context\-specific access policy, so the device functions only within those parameters\&. +.sp +Added in version 246\&. .RE .PP \fIClientIdentifier=\fR .RS 4 The DHCPv4 client identifier to use\&. Takes one of -\fBmac\fR, -\fBduid\fR +\fBmac\fR or -\fBduid\-only\fR\&. If set to +\fBduid\fR\&. If set to \fBmac\fR, the MAC address of the link is used\&. If set to -\fBduid\fR, an RFC4361\-compliant Client ID, which is the combination of IAID and DUID (see below), is used\&. If set to -\fBduid\-only\fR, only DUID is used, this may not be RFC compliant, but some setups may require to use this\&. Defaults to +\fBduid\fR, an RFC4361\-compliant Client ID, which is the combination of IAID and DUID, is used\&. IAID can be configured by +\fIIAID=\fR\&. DUID can be configured by +\fIDUIDType=\fR +and +\fIDUIDRawData=\fR\&. Defaults to \fBduid\fR\&. +.sp +Added in version 220\&. .RE .PP \fIVendorClassIdentifier=\fR .RS 4 The vendor class identifier used to identify vendor type and configuration\&. +.sp +Added in version 216\&. .RE .PP \fIUserClass=\fR .RS 4 A DHCPv4 client can use UserClass option to identify the type or category of user or applications it represents\&. The information contained in this option is a string that represents the user class of which the client is a member\&. Each class sets an identifying string of information to be used by the DHCP service to classify clients\&. Takes a whitespace\-separated list of strings\&. +.sp +Added in version 239\&. .RE .PP \fIDUIDType=\fR @@ -1860,6 +2323,8 @@ Override the global setting for this network\&. See \fBnetworkd.conf\fR(5) for a description of possible values\&. +.sp +Added in version 230\&. .RE .PP \fIDUIDRawData=\fR @@ -1869,17 +2334,36 @@ Override the global setting for this network\&. See \fBnetworkd.conf\fR(5) for a description of possible values\&. +.sp +Added in version 230\&. .RE .PP \fIIAID=\fR .RS 4 The DHCP Identity Association Identifier (IAID) for the interface, a 32\-bit unsigned integer\&. +.sp +Added in version 230\&. +.RE +.PP +\fIRapidCommit=\fR +.RS 4 +Takes a boolean\&. The DHCPv4 client can obtain configuration parameters from a DHCPv4 server through a rapid two\-message exchange (discover and ack)\&. When the rapid commit option is set by both the DHCPv4 client and the DHCPv4 server, the two\-message exchange is used\&. Otherwise, the four\-message exchange (discover, offer, request, and ack) is used\&. The two\-message exchange provides faster client configuration\&. See +\m[blue]\fBRFC 4039\fR\m[]\&\s-2\u[23]\d\s+2 +for details\&. Defaults to true when +\fIAnonymize=no\fR +and neither +\fIAllowList=\fR +nor +\fIDenyList=\fR +is specified, and false otherwise\&. +.sp +Added in version 255\&. .RE .PP \fIAnonymize=\fR .RS 4 Takes a boolean\&. When true, the options sent to the DHCP server will follow the -\m[blue]\fBRFC 7844\fR\m[]\&\s-2\u[22]\d\s+2 +\m[blue]\fBRFC 7844\fR\m[]\&\s-2\u[24]\d\s+2 (Anonymity Profiles for DHCP Clients) to minimize disclosure of identifying information\&. Defaults to false\&. .sp This option should only be set to true when @@ -1891,6 +2375,7 @@ is set to .sp When true, \fIClientIdentifier=mac\fR, +\fIRapidCommit=no\fR, \fISendHostname=no\fR, \fIUse6RD=no\fR, \fIUseCaptivePortal=no\fR, @@ -1901,6 +2386,7 @@ When true, are implied and these settings in the \&.network file are silently ignored\&. Also, \fIHostname=\fR, \fIMUDURL=\fR, +\fIRequestAddress\fR, \fIRequestOptions=\fR, \fISendOption=\fR, \fISendVendorOption=\fR, @@ -1909,11 +2395,15 @@ are implied and these settings in the \&.network file are silently ignored\&. Al are silently ignored\&. .sp With this option enabled DHCP requests will mimic those generated by Microsoft Windows, in order to reduce the ability to fingerprint and recognize installations\&. This means DHCP request sizes will grow and lease data will be more comprehensive than normally, though most of the requested data is not actually used\&. +.sp +Added in version 235\&. .RE .PP \fIRequestOptions=\fR .RS 4 Sets request options to be sent to the server in the DHCPv4 request options list\&. A whitespace\-separated list of integers in the range 1\&...254\&. Defaults to unset\&. +.sp +Added in version 244\&. .RE .PP \fISendOption=\fR @@ -1924,7 +2414,9 @@ Send an arbitrary raw option in the DHCPv4 request\&. Takes a DHCP option number "uint32", "ipv4address", or "string"\&. Special characters in the data string may be escaped using -\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[23]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[25]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +.sp +Added in version 244\&. .RE .PP \fISendVendorOption=\fR @@ -1935,7 +2427,9 @@ Send an arbitrary vendor option in the DHCPv4 request\&. Takes a DHCP option num "uint32", "ipv4address", or "string"\&. Special characters in the data string may be escaped using -\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[23]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[25]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIIPServiceType=\fR @@ -1951,6 +2445,8 @@ no IP service type is set to the packet sent from the DHCPv4 client\&. When "CS4" (realtime), the corresponding service type will be set\&. Defaults to "CS6"\&. +.sp +Added in version 244\&. .RE .PP \fISocketPriority=\fR @@ -1964,11 +2460,15 @@ socket option in \fIEgressQOSMaps=\fR setting of \&.netdev file to set the 802\&.1Q VLAN ethernet tagged header priority, see \fBsystemd.netdev\fR(5)\&. +.sp +Added in version 253\&. .RE .PP \fILabel=\fR .RS 4 Specifies the label for the IPv4 address received from the DHCP server\&. The label must be a 7\-bit ASCII string with a length of 1\&...15 characters\&. Defaults to unset\&. +.sp +Added in version 250\&. .RE .PP \fIUseDNS=\fR @@ -1979,6 +2479,8 @@ This corresponds to the \fBnameserver\fR option in \fBresolv.conf\fR(5)\&. +.sp +Added in version 211\&. .RE .PP \fIRoutesToDNS=\fR @@ -1986,12 +2488,16 @@ option in When true, the routes to the DNS servers received from the DHCP server will be configured\&. When \fIUseDNS=\fR is disabled, this setting is ignored\&. Defaults to true\&. +.sp +Added in version 243\&. .RE .PP \fIUseNTP=\fR .RS 4 When true (the default), the NTP servers received from the DHCP server will be used by systemd\-timesyncd\&.service\&. +.sp +Added in version 220\&. .RE .PP \fIRoutesToNTP=\fR @@ -1999,16 +2505,24 @@ systemd\-timesyncd\&.service\&. When true, the routes to the NTP servers received from the DHCP server will be configured\&. When \fIUseNTP=\fR is disabled, this setting is ignored\&. Defaults to true\&. +.sp +Added in version 249\&. .RE .PP \fIUseSIP=\fR .RS 4 When true (the default), the SIP servers received from the DHCP server will be collected and made available to client programs\&. +.sp +Added in version 244\&. .RE .PP \fIUseCaptivePortal=\fR .RS 4 -When true (the default), the captive portal advertised by the DHCP server will be recorded and made available to client programs and displayed in the networkctl status output per\-link\&. +When true (the default), the captive portal advertised by the DHCP server will be recorded and made available to client programs and displayed in the +\fBnetworkctl\fR(1) +status output per\-link\&. +.sp +Added in version 254\&. .RE .PP \fIUseMTU=\fR @@ -2021,11 +2535,15 @@ Note, some drivers will reset the interfaces if the MTU is changed\&. For such i \fIIgnoreCarrierLoss=\fR with a short timespan, e\&.g\&. "3 seconds"\&. +.sp +Added in version 211\&. .RE .PP \fIUseHostname=\fR .RS 4 When true (the default), the hostname received from the DHCP server will be set as the transient hostname of the system\&. +.sp +Added in version 211\&. .RE .PP \fIUseDomains=\fR @@ -2045,6 +2563,8 @@ When set to true, this setting corresponds to the \fBdomain\fR option in \fBresolv.conf\fR(5)\&. +.sp +Added in version 216\&. .RE .PP \fIUseRoutes=\fR @@ -2058,11 +2578,15 @@ or \fBlink\fR scope will be used\&. For anything else, scope defaults to \fBglobal\fR\&. +.sp +Added in version 215\&. .RE .PP \fIRouteMetric=\fR .RS 4 Set the routing metric for routes specified by the DHCP server (including the prefix route added for the specified prefix)\&. Takes an unsigned integer in the range 0\&...4294967295\&. Defaults to 1024\&. +.sp +Added in version 217\&. .RE .PP \fIRouteTable=\fR\fI\fInum\fR\fR @@ -2077,29 +2601,57 @@ in .sp When used in combination with \fIVRF=\fR, the VRF\*(Aqs routing table is used when this parameter is not specified\&. +.sp +Added in version 232\&. .RE .PP \fIRouteMTUBytes=\fR .RS 4 Specifies the MTU for the DHCP routes\&. Please see the [Route] section for further details\&. +.sp +Added in version 245\&. .RE .PP \fIQuickAck=\fR .RS 4 Takes a boolean\&. When true, the TCP quick ACK mode is enabled for the routes configured by the acquired DHCPv4 lease\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 253\&. +.RE +.PP +\fIInitialCongestionWindow=\fR +.RS 4 +As in the [Route] section\&. +.sp +Added in version 255\&. +.RE +.PP +\fIInitialAdvertisedReceiveWindow=\fR +.RS 4 +As in the [Route] section\&. +.sp +Added in version 255\&. .RE .PP \fIUseGateway=\fR .RS 4 -When true, the gateway will be requested from the DHCP server and added to the routing table with a metric of 1024, and a scope of -\fBlink\fR\&. When unset, the value specified with +When true, and the DHCP server provides a Router option, the default gateway based on the router address will be configured\&. Defaults to unset, and the value specified with \fIUseRoutes=\fR -is used\&. +will be used\&. +.sp +Note, when the server provides both the Router and Classless Static Routes option, and +\fIUseRoutes=\fR +is enabled, the Router option is always ignored regardless of this setting\&. See +\m[blue]\fBRFC 3442\fR\m[]\&\s-2\u[26]\d\s+2\&. +.sp +Added in version 246\&. .RE .PP \fIUseTimezone=\fR .RS 4 When true, the timezone received from the DHCP server will be set as timezone of the local system\&. Defaults to false\&. +.sp +Added in version 226\&. .RE .PP \fIUse6RD=\fR @@ -2108,7 +2660,17 @@ When true, subnets of the received IPv6 prefix are assigned to downstream interf \fIDHCPPrefixDelegation=\fR\&. See also \fIDHCPPrefixDelegation=\fR in the [Network] section, the [DHCPPrefixDelegation] section, and -\m[blue]\fBRFC 5969\fR\m[]\&\s-2\u[24]\d\s+2\&. Defaults to false\&. +\m[blue]\fBRFC 5969\fR\m[]\&\s-2\u[27]\d\s+2\&. Defaults to false\&. +.sp +Added in version 250\&. +.RE +.PP +\fIIPv6OnlyMode=\fR +.RS 4 +When true, the DHCPv4 configuration will be delayed by the timespan provided by the DHCP server and skip to configure dynamic IPv4 network connectivity if IPv6 connectivity is provided within the timespan\&. See +\m[blue]\fBRFC 8925\fR\m[]\&\s-2\u[28]\d\s+2\&. Defaults to false\&. +.sp +Added in version 255\&. .RE .PP \fIFallbackLeaseLifetimeSec=\fR @@ -2117,11 +2679,15 @@ Allows one to set DHCPv4 lease lifetime when DHCPv4 server does not send the lea "forever" or "infinity"\&. If specified, the acquired address never expires\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIRequestBroadcast=\fR .RS 4 Request the server to use broadcast messages before the IP address has been configured\&. This is necessary for devices that cannot receive RAW packets, or that cannot receive packets at all before an IP address has been configured\&. On the other hand, this must not be enabled on networks where broadcasts are filtered out\&. +.sp +Added in version 216\&. .RE .PP \fIMaxAttempts=\fR @@ -2129,11 +2695,15 @@ Request the server to use broadcast messages before the IP address has been conf Specifies how many times the DHCPv4 client configuration should be attempted\&. Takes a number or "infinity"\&. Defaults to "infinity"\&. Note that the time between retries is increased exponentially, up to approximately one per minute, so the network will not be overloaded even if this number is high\&. The default is suitable in most circumstances\&. +.sp +Added in version 243\&. .RE .PP \fIListenPort=\fR .RS 4 Set the port from which the DHCP client packets originate\&. +.sp +Added in version 233\&. .RE .PP \fIDenyList=\fR @@ -2144,17 +2714,35 @@ A whitespace\-separated list of IPv4 addresses\&. Each address can optionally ta is configured then \fIDenyList=\fR is ignored\&. +.sp +Note that this filters only DHCP offers, so the filtering may not work when +\fIRapidCommit=\fR +is enabled\&. See also +\fIRapidCommit=\fR +in the above\&. +.sp +Added in version 246\&. .RE .PP \fIAllowList=\fR .RS 4 A whitespace\-separated list of IPv4 addresses\&. Each address can optionally take a prefix length after "/"\&. DHCP offers from servers in the list are accepted\&. +.sp +Note that this filters only DHCP offers, so the filtering may not work when +\fIRapidCommit=\fR +is enabled\&. See also +\fIRapidCommit=\fR +in the above\&. +.sp +Added in version 246\&. .RE .PP \fISendRelease=\fR .RS 4 When true, the DHCPv4 client sends a DHCP release packet when it stops\&. Defaults to true\&. +.sp +Added in version 243\&. .RE .PP \fISendDecline=\fR @@ -2165,6 +2753,8 @@ performs IPv4 Duplicate Address Detection to the acquired address by the DHCPv4 \fBDHCPDECLINE\fR packet to the DHCP server, and tries to obtain an IP address again\&. See \m[blue]\fBRFC 5227\fR\m[]\&\s-2\u[11]\d\s+2\&. Defaults to false\&. +.sp +Added in version 245\&. .RE .PP \fINetLabel=\fR @@ -2174,6 +2764,24 @@ This applies the NetLabel for the addresses received with DHCP, like in [Address] section applies it to statically configured addresses\&. See \fINetLabel=\fR in [Address] section for more details\&. +.sp +Added in version 252\&. +.RE +.PP +\fINFTSet=\fR +.RS 4 +This applies the NFT set for the network configuration received with DHCP, like +\fINFTSet=\fR +in [Address] section applies it to static configuration\&. See +\fINFTSet=\fR +in [Address] section for more details\&. For +"address" +or +"prefix" +source types, the type of the element used in the NFT filter must be +"ipv4_addr"\&. +.sp +Added in version 255\&. .RE .SH "[DHCPV6] SECTION OPTIONS" .PP @@ -2184,11 +2792,15 @@ setting described above, or invoked by the IPv6 Router Advertisement: \fIMUDURL=\fR, \fIIAID=\fR, \fIDUIDType=\fR, \fIDUIDRawData=\fR, \fIRequestOptions=\fR .RS 4 As in the [DHCPv4] section\&. +.sp +Added in version 246\&. .RE .PP \fISendOption=\fR .RS 4 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\&. +.sp +Added in version 246\&. .RE .PP \fISendVendorOption=\fR @@ -2200,20 +2812,26 @@ Send an arbitrary vendor option in the DHCPv6 request\&. Takes an enterprise ide "ipv4address", "ipv6address", or "string"\&. Special characters in the data string may be escaped using -\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[23]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[25]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIUserClass=\fR .RS 4 A DHCPv6 client can use User Class option to identify the type or category of user or applications it represents\&. The information contained in this option is a string that represents the user class of which the client is a member\&. Each class sets an identifying string of information to be used by the DHCP service to classify clients\&. Special characters in the data string may be escaped using -\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[23]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Takes a whitespace\-separated list of strings\&. Note that currently +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[25]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Takes a whitespace\-separated list of strings\&. Note that currently \fBNUL\fR bytes are not allowed\&. +.sp +Added in version 246\&. .RE .PP \fIVendorClass=\fR .RS 4 A DHCPv6 client can use VendorClass option to identify the vendor that manufactured the hardware on which the client is running\&. The information contained in the data area of this option is contained in one or more opaque fields that identify details of the hardware configuration\&. Takes a whitespace\-separated list of strings\&. +.sp +Added in version 246\&. .RE .PP \fIPrefixDelegationHint=\fR @@ -2221,23 +2839,48 @@ A DHCPv6 client can use VendorClass option to identify the vendor that manufactu Takes an IPv6 address with prefix length in the same format as the \fIAddress=\fR 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\&. +.sp +Added in version 244\&. .RE .PP \fIRapidCommit=\fR .RS 4 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 set by both the DHCPv6 client and the DHCPv6 server, the two\-message exchange is used\&. Otherwise, the four\-message exchange (solicit, advertise, request, and reply) is used\&. The two\-message exchange provides faster client configuration\&. See -\m[blue]\fBRFC 3315\fR\m[]\&\s-2\u[25]\d\s+2 +\m[blue]\fBRFC 3315\fR\m[]\&\s-2\u[29]\d\s+2 for details\&. Defaults to true, and the two\-message exchange will be used if the server support it\&. +.sp +Added in version 252\&. +.RE +.PP +\fISendHostname=\fR +.RS 4 +When true (the default), the machine\*(Aqs hostname (or the value specified with +\fIHostname=\fR, described below) will be sent to the DHCPv6 server\&. Note that the hostname must consist only of 7\-bit ASCII lower\-case characters and no spaces or dots, and be formatted as a valid DNS domain name\&. Otherwise, the hostname is not sent even if this option is true\&. +.sp +Added in version 255\&. +.RE +.PP +\fIHostname=\fR +.RS 4 +Use this value for the hostname which is sent to the DHCPv6 server, instead of machine\*(Aqs hostname\&. Note that the specified hostname must consist only of 7\-bit ASCII lower\-case characters and no spaces or dots, and be formatted as a valid DNS domain name\&. +.sp +Added in version 255\&. .RE .PP \fIUseAddress=\fR .RS 4 When true (the default), the IP addresses provided by the DHCPv6 server will be assigned\&. +.sp +Added in version 248\&. .RE .PP \fIUseCaptivePortal=\fR .RS 4 -When true (the default), the captive portal advertised by the DHCPv6 server will be recorded and made available to client programs and displayed in the networkctl status output per\-link\&. +When true (the default), the captive portal advertised by the DHCPv6 server will be recorded and made available to client programs and displayed in the +\fBnetworkctl\fR(1) +status output per\-link\&. +.sp +Added in version 254\&. .RE .PP \fIUseDelegatedPrefix=\fR @@ -2246,12 +2889,32 @@ When true (the default), the client will request the DHCPv6 server to delegate p \fIDHCPPrefixDelegation=yes\fR\&. See also the \fIDHCPPrefixDelegation=\fR setting in the [Network] section, settings in the [DHCPPrefixDelegation] section, and -\m[blue]\fBRFC 8415\fR\m[]\&\s-2\u[26]\d\s+2\&. +\m[blue]\fBRFC 8415\fR\m[]\&\s-2\u[30]\d\s+2\&. +.sp +Added in version 250\&. .RE .PP \fIUseDNS=\fR, \fIUseNTP=\fR, \fIUseHostname=\fR, \fIUseDomains=\fR, \fINetLabel=\fR, \fISendRelease=\fR .RS 4 As in the [DHCPv4] section\&. +.sp +Added in version 243\&. +.RE +.PP +\fINFTSet=\fR +.RS 4 +This applies the NFT set for the network configuration received with DHCP, like +\fINFTSet=\fR +in [Address] section applies it to static configuration\&. See +\fINFTSet=\fR +in [Address] section for more details\&. For +"address" +or +"prefix" +source types, the type of the element used in the NFT filter must be +"ipv6_addr"\&. +.sp +Added in version 255\&. .RE .PP \fIWithoutRA=\fR @@ -2273,6 +2936,8 @@ is specified in the [DHCPPrefixDelegation] section\&. Otherwise, defaults to "no", and the DHCPv6 client will be started when an RA is received\&. See also the \fIDHCPv6Client=\fR setting in the [IPv6AcceptRA] section\&. +.sp +Added in version 246\&. .RE .SH "[DHCPPREFIXDELEGATION] SECTION OPTIONS" .PP @@ -2291,12 +2956,16 @@ and is implied if the setting is not explicitly specified\&. When ":auto", the first link which acquired prefixes to be delegated from the DHCPv6 or DHCPv4 server is selected\&. Defaults to ":auto"\&. +.sp +Added in version 250\&. .RE .PP \fISubnetId=\fR .RS 4 Configure a specific subnet ID on the interface from a (previously) received prefix delegation\&. You can either set "auto" (the default) or a specific subnet ID (as defined in -\m[blue]\fBRFC 4291\fR\m[]\&\s-2\u[27]\d\s+2, section 2\&.5\&.4), in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff inclusive\&. +\m[blue]\fBRFC 4291\fR\m[]\&\s-2\u[31]\d\s+2, section 2\&.5\&.4), in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff inclusive\&. +.sp +Added in version 246\&. .RE .PP \fIAnnounce=\fR @@ -2306,6 +2975,8 @@ Takes a boolean\&. When enabled, and in [Network] section is enabled, the delegated prefixes are distributed through the IPv6 Router Advertisement\&. This setting will be ignored when the \fIDHCPPrefixDelegation=\fR setting is enabled on the upstream interface\&. Defaults to yes\&. +.sp +Added in version 247\&. .RE .PP \fIAssign=\fR @@ -2313,6 +2984,8 @@ setting is enabled on the upstream interface\&. Defaults to yes\&. Takes a boolean\&. Specifies whether to add an address from the delegated prefixes which are received from the WAN interface by the DHCPv6 Prefix Delegation\&. When true (on LAN interface), the EUI\-64 algorithm will be used by default to form an interface identifier from the delegated prefixes\&. See also \fIToken=\fR setting below\&. Defaults to yes\&. +.sp +Added in version 246\&. .RE .PP \fIToken=\fR @@ -2322,16 +2995,22 @@ Specifies an optional address generation mode for assigning an address in each d in the [IPv6AcceptRA] section\&. If \fIAssign=\fR is set to false, then this setting will be ignored\&. Defaults to unset, which means the EUI\-64 algorithm will be used\&. +.sp +Added in version 246\&. .RE .PP \fIManageTemporaryAddress=\fR .RS 4 As in the [Address] section, but defaults to true\&. +.sp +Added in version 248\&. .RE .PP \fIRouteMetric=\fR .RS 4 The metric of the route to the delegated prefix subnet\&. Takes an unsigned integer in the range 0\&...4294967295\&. When set to 0, the kernel\*(Aqs default value is used\&. Defaults to 256\&. +.sp +Added in version 249\&. .RE .PP \fINetLabel=\fR @@ -2341,6 +3020,24 @@ This applies the NetLabel for the addresses received with DHCP, like in [Address] section applies it to statically configured addresses\&. See \fINetLabel=\fR in [Address] section for more details\&. +.sp +Added in version 252\&. +.RE +.PP +\fINFTSet=\fR +.RS 4 +This applies the NFT set for the network configuration received with DHCP, like +\fINFTSet=\fR +in [Address] section applies it to static configuration\&. See +\fINFTSet=\fR +in [Address] section for more details\&. For +"address" +or +"prefix" +source types, the type of the element used in the NFT filter must be +"ipv6_addr"\&. +.sp +Added in version 255\&. .RE .SH "[IPV6ACCEPTRA] SECTION OPTIONS" .PP @@ -2355,6 +3052,8 @@ Specifies an optional address generation mode for the Stateless Address Autoconf \fBeui64\fR .RS 4 The EUI\-64 algorithm will be used to generate an address for that prefix\&. Only supported by Ethernet or InfiniBand interfaces\&. +.sp +Added in version 250\&. .RE .PP \fBstatic:\fR\fB\fIADDRESS\fR\fR @@ -2362,12 +3061,14 @@ The EUI\-64 algorithm will be used to generate an address for that prefix\&. Onl An IPv6 address must be specified after a colon (":"), and the lower bits of the supplied address are combined with the upper bits of a prefix received in a Router Advertisement (RA) message to form a complete address\&. Note that if multiple prefixes are received in an RA message, or in multiple RA messages, addresses will be formed from each of them using the supplied address\&. This mode implements SLAAC but uses a static interface identifier instead of an identifier generated by using the EUI\-64 algorithm\&. Because the interface identifier is static, if Duplicate Address Detection detects that the computed address is a duplicate (in use by another node on the link), then this mode will fail to provide an address for that prefix\&. If an IPv6 address without mode is specified, then "static" mode is assumed\&. +.sp +Added in version 250\&. .RE .PP \fBprefixstable[:\fR\fB\fIADDRESS\fR\fR\fB][,\fR\fB\fIUUID\fR\fR\fB]\fR .RS 4 The algorithm specified in -\m[blue]\fBRFC 7217\fR\m[]\&\s-2\u[28]\d\s+2 +\m[blue]\fBRFC 7217\fR\m[]\&\s-2\u[32]\d\s+2 will be used to generate interface identifiers\&. This mode can optionally take an IPv6 address separated with a colon (":")\&. If an IPv6 address is specified, then an interface identifier is generated only when a prefix received in an RA message matches the supplied address\&. .sp This mode can also optionally take a non\-null UUID in the format which @@ -2383,6 +3084,8 @@ or Note that the "prefixstable" algorithm uses both the interface name and MAC address as input to the hash to compute the interface identifier, so if either of those are changed the resulting interface identifier (and address) will be changed, even if the prefix received in the RA message has not been changed\&. +.sp +Added in version 250\&. .RE .sp If no address generation mode is specified (which is the default), or a received prefix does not match any of the addresses provided in @@ -2408,6 +3111,8 @@ Token=prefixstable:2002:da8:1:: .if n \{\ .RE .\} +.sp +Added in version 250\&. .RE .PP \fIUseDNS=\fR @@ -2418,6 +3123,8 @@ This corresponds to the \fBnameserver\fR option in \fBresolv.conf\fR(5)\&. +.sp +Added in version 231\&. .RE .PP \fIUseDomains=\fR @@ -2437,6 +3144,8 @@ When set to true, this setting corresponds to the \fBdomain\fR option in \fBresolv.conf\fR(5)\&. +.sp +Added in version 231\&. .RE .PP \fIRouteTable=\fR\fI\fInum\fR\fR @@ -2451,6 +3160,8 @@ in .sp When used in combination with \fIVRF=\fR, the VRF\*(Aqs routing table is used when this parameter is not specified\&. +.sp +Added in version 232\&. .RE .PP \fIRouteMetric=\fR @@ -2458,47 +3169,92 @@ When used in combination with Set the routing metric for the routes received in the Router Advertisement\&. Takes an unsigned integer in the range 0\&...4294967295, or three unsigned integer separated with ":", in that case the first one is used when the router preference is high, the second is for medium preference, and the last is for low preference ("\fIhigh\fR:\fImedium\fR:\fIlow\fR")\&. Defaults to "512:1024:2048"\&. +.sp +Added in version 249\&. .RE .PP \fIQuickAck=\fR .RS 4 Takes a boolean\&. When true, the TCP quick ACK mode is enabled for the routes configured by the received RAs\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 253\&. .RE .PP \fIUseMTU=\fR .RS 4 Takes a boolean\&. When true, the MTU received in the Router Advertisement will be used\&. Defaults to true\&. +.sp +Added in version 250\&. +.RE +.PP +\fIUseHopLimit=\fR +.RS 4 +Takes a boolean\&. When true, the hop limit received in the Router Advertisement will be set to routes configured based on the advertisement\&. See also +\fIIPv6HopLimit=\fR\&. Defaults to true\&. +.sp +Added in version 255\&. +.RE +.PP +\fIUseICMP6RateLimit=\fR +.RS 4 +Takes a boolean\&. When true, the ICMP6 rate limit received in the Router Advertisement will be set to ICMP6 rate limit based on the advertisement\&. Defaults to true\&. +.sp +Added in version 255\&. .RE .PP \fIUseGateway=\fR .RS 4 When true (the default), the router address will be configured as the default gateway\&. +.sp +Added in version 250\&. .RE .PP \fIUseRoutePrefix=\fR .RS 4 When true (the default), the routes corresponding to the route prefixes received in the Router Advertisement will be configured\&. +.sp +Added in version 250\&. .RE .PP \fIUseCaptivePortal=\fR .RS 4 -When true (the default), the captive portal received in the Router Advertisement will be recorded and made available to client programs and displayed in the networkctl status output per\-link\&. +When true (the default), the captive portal received in the Router Advertisement will be recorded and made available to client programs and displayed in the +\fBnetworkctl\fR(1) +status output per\-link\&. +.sp +Added in version 254\&. +.RE +.PP +\fIUsePREF64=\fR +.RS 4 +When true, the IPv6 PREF64 (or NAT64) prefixes received in the Router Advertisement will be recorded and made available to client programs and displayed in the +\fBnetworkctl\fR(1) +status output per\-link\&. See +\m[blue]\fBRFC 8781\fR\m[]\&\s-2\u[33]\d\s+2\&. Defaults to false\&. +.sp +Added in version 255\&. .RE .PP \fIUseAutonomousPrefix=\fR .RS 4 When true (the default), the autonomous prefix received in the Router Advertisement will be used and take precedence over any statically configured ones\&. +.sp +Added in version 242\&. .RE .PP \fIUseOnLinkPrefix=\fR .RS 4 When true (the default), the onlink prefix received in the Router Advertisement will be used and takes precedence over any statically configured ones\&. +.sp +Added in version 242\&. .RE .PP \fIRouterDenyList=\fR .RS 4 A whitespace\-separated list of IPv6 router addresses\&. Each address can optionally take a prefix length after "/"\&. Any information advertised by the listed router is ignored\&. +.sp +Added in version 248\&. .RE .PP \fIRouterAllowList=\fR @@ -2509,12 +3265,16 @@ A whitespace\-separated list of IPv6 router addresses\&. Each address can option is configured then \fIRouterDenyList=\fR is ignored\&. +.sp +Added in version 248\&. .RE .PP \fIPrefixDenyList=\fR .RS 4 A whitespace\-separated list of IPv6 prefixes\&. Each prefix can optionally take its prefix length after "/"\&. IPv6 prefixes supplied via router advertisements in the list are ignored\&. +.sp +Added in version 248\&. .RE .PP \fIPrefixAllowList=\fR @@ -2525,12 +3285,16 @@ A whitespace\-separated list of IPv6 prefixes\&. Each prefix can optionally take is configured then \fIPrefixDenyList=\fR is ignored\&. +.sp +Added in version 248\&. .RE .PP \fIRouteDenyList=\fR .RS 4 A whitespace\-separated list of IPv6 route prefixes\&. Each prefix can optionally take its prefix length after "/"\&. IPv6 route prefixes supplied via router advertisements in the list are ignored\&. +.sp +Added in version 248\&. .RE .PP \fIRouteAllowList=\fR @@ -2541,6 +3305,8 @@ A whitespace\-separated list of IPv6 route prefixes\&. Each prefix can optionall is configured then \fIRouteDenyList=\fR is ignored\&. +.sp +Added in version 248\&. .RE .PP \fIDHCPv6Client=\fR @@ -2568,6 +3334,8 @@ flag is set in the RA\&. This will be ignored when in the [DHCPv6] section is enabled, or \fIUplinkInterface=:self\fR in the [DHCPPrefixDelegation] section is specified\&. Defaults to true\&. +.sp +Added in version 246\&. .RE .PP \fINetLabel=\fR @@ -2577,6 +3345,24 @@ This applies the NetLabel for the addresses received with RA, like in [Address] section applies it to statically configured addresses\&. See \fINetLabel=\fR in [Address] section for more details\&. +.sp +Added in version 252\&. +.RE +.PP +\fINFTSet=\fR +.RS 4 +This applies the NFT set for the network configuration received with RA, like +\fINFTSet=\fR +in [Address] section applies it to static configuration\&. See +\fINFTSet=\fR +in [Address] section for more details\&. For +"address" +or +"prefix" +source types, the type of the element used in the NFT filter must be +"ipv6_addr"\&. +.sp +Added in version 255\&. .RE .SH "[DHCPSERVER] SECTION OPTIONS" .PP @@ -2586,7 +3372,71 @@ option described above: .PP \fIServerAddress=\fR .RS 4 -Specifies server address for the DHCP server\&. Takes an IPv4 address with prefix length, for example 192\&.168\&.0\&.1/24\&. This setting may be useful when the link on which the DHCP server is running has multiple static addresses\&. When unset, one of static addresses in the link will be automatically selected\&. Defaults to unset\&. +Specifies the server address for the DHCP server\&. Takes an IPv4 address with prefix length separated with a slash, e\&.g\&. +"192\&.168\&.0\&.1/24"\&. Defaults to unset, and one of static IPv4 addresses configured in [Network] or [Address] section will be automatically selected\&. This setting may be useful when the interface on which the DHCP server is running has multiple static IPv4 addresses\&. +.sp +This implies +\fIAddress=\fR +in [Network] or [Address] section with the same address and prefix length\&. That is, +.sp +.if n \{\ +.RS 4 +.\} +.nf +[Network] +DHCPServer=yes +Address=192\&.168\&.0\&.1/24 +Address=192\&.168\&.0\&.2/24 +[DHCPServer] +ServerAddress=192\&.168\&.0\&.1/24 +.fi +.if n \{\ +.RE +.\} +.sp +or +.sp +.if n \{\ +.RS 4 +.\} +.nf +[Network] +DHCPServer=yes +[Address] +Address=192\&.168\&.0\&.1/24 +[Address] +Address=192\&.168\&.0\&.2/24 +[DHCPServer] +ServerAddress=192\&.168\&.0\&.1/24 +.fi +.if n \{\ +.RE +.\} +.sp +are equivalent to the following: +.sp +.if n \{\ +.RS 4 +.\} +.nf +[Network] +DHCPServer=yes +Address=192\&.168\&.0\&.2/24 +[DHCPServer] +ServerAddress=192\&.168\&.0\&.1/24 +.fi +.if n \{\ +.RE +.\} +.sp +Since version 255, like the +\fIAddress=\fR +setting in [Network] or [Address] section, this also supports a null address, e\&.g\&. +"0\&.0\&.0\&.0/24", and an unused address will be automatically selected\&. For more details about the automatic address selection, see +\fIAddress=\fR +setting in [Network] section in the above\&. +.sp +Added in version 249\&. .RE .PP \fIPoolOffset=\fR, \fIPoolSize=\fR @@ -2596,11 +3446,15 @@ Configures the pool of addresses to hand out\&. The pool is a contiguous sequenc takes the offset of the pool from the start of subnet, or zero to use the default value\&. \fIPoolSize=\fR takes the number of IP addresses in the pool or zero to use the default value\&. By default, the pool starts at the first address after the subnet address and takes up the rest of the subnet, excluding the broadcast address\&. If the pool includes the server address (the default), this is reserved and not handed out to clients\&. +.sp +Added in version 226\&. .RE .PP \fIDefaultLeaseTimeSec=\fR, \fIMaxLeaseTimeSec=\fR .RS 4 Control the default and maximum DHCP lease time to pass to clients\&. These settings take time values in seconds or another common time unit, depending on the suffix\&. The default lease time is used for clients that did not ask for a specific lease time\&. If a client asks for a lease time longer than the maximum lease time, it is automatically shortened to the specified time\&. The default lease time defaults to 1h, the maximum lease time to 12h\&. Shorter lease times are beneficial if the configuration data in DHCP leases changes frequently and clients shall learn the new settings with shorter latencies\&. Longer lease times reduce the generated DHCP network traffic\&. +.sp +Added in version 226\&. .RE .PP \fIUplinkInterface=\fR @@ -2612,6 +3466,8 @@ and ":auto", the link which has a default gateway with the highest priority will be automatically selected\&. When ":none", no uplink interface will be selected\&. Defaults to ":auto"\&. +.sp +Added in version 249\&. .RE .PP \fIEmitDNS=\fR, \fIDNS=\fR @@ -2633,6 +3489,8 @@ is used\&. Also, note that the leases are not refreshed if the uplink network co described above\&. .sp This setting can be specified multiple times\&. If an empty string is specified, then all DNS servers specified earlier are cleared\&. +.sp +Added in version 226\&. .RE .PP \fIEmitNTP=\fR, \fINTP=\fR, \fIEmitSIP=\fR, \fISIP=\fR, \fIEmitPOP3=\fR, \fIPOP3=\fR, \fIEmitSMTP=\fR, \fISMTP=\fR, \fIEmitLPR=\fR, \fILPR=\fR @@ -2645,6 +3503,8 @@ settings described above, these settings configure whether and what server infor \fIEmitDNS=\fR and \fIDNS=\fR\&. +.sp +Added in version 226\&. .RE .PP \fIEmitRouter=\fR, \fIRouter=\fR @@ -2664,6 +3524,8 @@ setting will be ignored\&. The setting defaults to true, and the \fIRouter=\fR setting defaults to unset\&. +.sp +Added in version 230\&. .RE .PP \fIEmitTimezone=\fR, \fITimezone=\fR @@ -2677,6 +3539,8 @@ or "UTC") to pass to clients\&. If no explicit timezone is set, the system timezone of the local host is propagated, as determined by the /etc/localtime symlink\&. +.sp +Added in version 226\&. .RE .PP \fIBootServerAddress=\fR @@ -2684,14 +3548,16 @@ symlink\&. Takes an IPv4 address of the boot server used by e\&.g\&. PXE boot systems\&. When specified, this address is sent in the \fBsiaddr\fR field of the DHCP message header\&. See -\m[blue]\fBRFC 2131\fR\m[]\&\s-2\u[29]\d\s+2 +\m[blue]\fBRFC 2131\fR\m[]\&\s-2\u[34]\d\s+2 for more details\&. Defaults to unset\&. +.sp +Added in version 251\&. .RE .PP \fIBootServerName=\fR .RS 4 Takes a name of the boot server used by e\&.g\&. PXE boot systems\&. When specified, this name is sent in the DHCP option 66 ("TFTP server name")\&. See -\m[blue]\fBRFC 2132\fR\m[]\&\s-2\u[30]\d\s+2 +\m[blue]\fBRFC 2132\fR\m[]\&\s-2\u[35]\d\s+2 for more details\&. Defaults to unset\&. .sp Note that typically setting one of @@ -2699,13 +3565,26 @@ Note that typically setting one of or \fIBootServerAddress=\fR is sufficient, but both can be set too, if desired\&. +.sp +Added in version 251\&. .RE .PP \fIBootFilename=\fR .RS 4 Takes a path or URL to a file loaded by e\&.g\&. a PXE boot loader\&. When specified, this path is sent in the DHCP option 67 ("Bootfile name")\&. See -\m[blue]\fBRFC 2132\fR\m[]\&\s-2\u[30]\d\s+2 +\m[blue]\fBRFC 2132\fR\m[]\&\s-2\u[35]\d\s+2 for more details\&. Defaults to unset\&. +.sp +Added in version 251\&. +.RE +.PP +\fIIPv6OnlyPreferredSec=\fR +.RS 4 +Takes a timespan\&. Controls the +\m[blue]\fBRFC 8925\fR\m[]\&\s-2\u[28]\d\s+2 +IPv6\-Only Preferred option\&. Specifies the DHCPv4 option to indicate that a host supports an IPv6\-only mode and is willing to forgo obtaining an IPv4 address if the network provides IPv6 connectivity\&. Defaults to unset, and not send the option\&. The minimum allowed value is 300 seconds\&. +.sp +Added in version 255\&. .RE .PP \fISendOption=\fR @@ -2717,7 +3596,9 @@ Send a raw option with value via DHCPv4 server\&. Takes a DHCP option number, da "ipv4address", "ipv6address", or "string"\&. Special characters in the data string may be escaped using -\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[23]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[25]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +.sp +Added in version 244\&. .RE .PP \fISendVendorOption=\fR @@ -2728,7 +3609,9 @@ Send a vendor option with value via DHCPv4 server\&. Takes a DHCP option number, "uint32", "ipv4address", or "string"\&. Special characters in the data string may be escaped using -\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[23]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +\m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[25]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIBindToInterface=\fR @@ -2739,13 +3622,17 @@ Takes a boolean value\&. When \fIRelayTarget=\fR is used (see below), in which case it defaults to "no"\&. +.sp +Added in version 249\&. .RE .PP \fIRelayTarget=\fR .RS 4 Takes an IPv4 address, which must be in the format described in \fBinet_pton\fR(3)\&. Turns this DHCP server into a DHCP relay agent\&. See -\m[blue]\fBRFC 1542\fR\m[]\&\s-2\u[31]\d\s+2\&. The address is the address of DHCP server or another relay agent to forward DHCP messages to and from\&. +\m[blue]\fBRFC 1542\fR\m[]\&\s-2\u[36]\d\s+2\&. The address is the address of DHCP server or another relay agent to forward DHCP messages to and from\&. +.sp +Added in version 249\&. .RE .PP \fIRelayAgentCircuitId=\fR @@ -2756,6 +3643,8 @@ Specifies value for Agent Circuit ID suboption of Relay Agent Information option should be replaced with the value of the suboption\&. Defaults to unset (means no Agent Circuit ID suboption is generated)\&. Ignored if \fIRelayTarget=\fR is not specified\&. +.sp +Added in version 249\&. .RE .PP \fIRelayAgentRemoteId=\fR @@ -2766,6 +3655,16 @@ Specifies value for Agent Remote ID suboption of Relay Agent Information option\ should be replaced with the value of the suboption\&. Defaults to unset (means no Agent Remote ID suboption is generated)\&. Ignored if \fIRelayTarget=\fR is not specified\&. +.sp +Added in version 249\&. +.RE +.PP +\fIRapidCommit=\fR +.RS 4 +Takes a boolean\&. When true, the server supports +\m[blue]\fBRFC 4039\fR\m[]\&\s-2\u[37]\d\s+2\&. When a client sends a DHCPDISCOVER message with the Rapid Commit option to the server, then the server will reply with a DHCPACK message to the client, instead of DHCPOFFER\&. Defaults to true\&. +.sp +Added in version 255\&. .RE .SH "[DHCPSERVERSTATICLEASE] SECTION OPTIONS" .PP @@ -2776,12 +3675,16 @@ section configures a static DHCP lease to assign a fixed IPv4 address to a speci \fIMACAddress=\fR .RS 4 The hardware address of a device to match\&. This key is mandatory\&. +.sp +Added in version 249\&. .RE .PP \fIAddress=\fR .RS 4 The IPv4 address that should be assigned to the device that was matched with \fIMACAddress=\fR\&. This key is mandatory\&. +.sp +Added in version 249\&. .RE .SH "[IPV6SENDRA] SECTION OPTIONS" .PP @@ -2800,11 +3703,22 @@ or if only additional network information can be obtained via DHCPv6 for the net is set to "true"\&. Both settings default to "false", which means that a DHCPv6 server is not being used\&. +.sp +Added in version 235\&. .RE .PP \fIRouterLifetimeSec=\fR .RS 4 Takes a timespan\&. Configures the IPv6 router lifetime in seconds\&. The value must be 0 seconds, or between 4 seconds and 9000 seconds\&. When set to 0, the host is not acting as a router\&. Defaults to 1800 seconds (30 minutes)\&. +.sp +Added in version 235\&. +.RE +.PP +\fIRetransmitSec=\fR +.RS 4 +Takes a timespan\&. Configures the retransmit time, used by clients to retransmit Neighbor Solicitation messages on address resolution and the Neighbor Unreachability Detection algorithm\&. An integer, the default unit is seconds, in the range 0\&...4294967295 msec\&. Defaults to 0\&. +.sp +Added in version 255\&. .RE .PP \fIRouterPreference=\fR @@ -2822,9 +3736,19 @@ and added as synonyms for "medium" just to make configuration easier\&. See -\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[20]\d\s+2 +\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[21]\d\s+2 for details\&. Defaults to "medium"\&. +.sp +Added in version 235\&. +.RE +.PP +\fIHopLimit=\fR +.RS 4 +Configures hop limit\&. Takes an integer in the range 0\&...255\&. See also +\fIIPv6HopLimit=\fR\&. +.sp +Added in version 255\&. .RE .PP \fIUplinkInterface=\fR @@ -2838,6 +3762,8 @@ and is enabled, otherwise the link which has a default gateway with the highest priority will be automatically selected\&. When ":none", no uplink interface will be selected\&. Defaults to ":auto"\&. +.sp +Added in version 250\&. .RE .PP \fIEmitDNS=\fR, \fIDNS=\fR @@ -2857,6 +3783,8 @@ will be used\&. When is false, no DNS server information is sent in Router Advertisement messages\&. \fIEmitDNS=\fR defaults to true\&. +.sp +Added in version 235\&. .RE .PP \fIEmitDomains=\fR, \fIDomains=\fR @@ -2872,6 +3800,8 @@ will be used\&. When is false, no DNS search domain information is sent in Router Advertisement messages\&. \fIEmitDomains=\fR defaults to true\&. +.sp +Added in version 235\&. .RE .PP \fIDNSLifetimeSec=\fR @@ -2880,11 +3810,37 @@ Lifetime in seconds for the DNS server addresses listed in \fIDNS=\fR and search domains listed in \fIDomains=\fR\&. Defaults to 3600 seconds (one hour)\&. +.sp +Added in version 235\&. +.RE +.PP +\fIHomeAgent=\fR +.RS 4 +Takes a boolean\&. Specifies that IPv6 router advertisements which indicate to hosts that the router acts as a Home Agent and includes a Home Agent option\&. Defaults to false\&. See +\m[blue]\fBRFC 6275\fR\m[]\&\s-2\u[10]\d\s+2 +for further details\&. +.sp +Added in version 255\&. +.RE +.PP +\fIHomeAgentLifetimeSec=\fR +.RS 4 +Takes a timespan\&. Specifies the lifetime of the Home Agent\&. An integer, the default unit is seconds, in the range 1\&...65535\&. Defaults to the value set to +\fIRouterLifetimeSec=\fR\&. +.sp +Added in version 255\&. +.RE +.PP +\fIHomeAgentPreference=\fR +.RS 4 +Configures IPv6 Home Agent preference\&. Takes an integer in the range 0\&...65535\&. Defaults to 0\&. +.sp +Added in version 255\&. .RE .SH "[IPV6PREFIX] SECTION OPTIONS" .PP One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router Advertisements\&. See -\m[blue]\fBRFC 4861\fR\m[]\&\s-2\u[32]\d\s+2 +\m[blue]\fBRFC 4861\fR\m[]\&\s-2\u[38]\d\s+2 for further details\&. .PP \fIAddressAutoconfiguration=\fR, \fIOnLink=\fR @@ -2892,6 +3848,8 @@ for further details\&. Takes a boolean to specify whether IPv6 addresses can be autoconfigured with this prefix and whether the prefix can be used for onlink determination\&. Both settings default to "true" in order to ease configuration\&. +.sp +Added in version 235\&. .RE .PP \fIPrefix=\fR @@ -2899,6 +3857,8 @@ in order to ease configuration\&. 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 "/" 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\&. +.sp +Added in version 235\&. .RE .PP \fIPreferredLifetimeSec=\fR, \fIValidLifetimeSec=\fR @@ -2908,11 +3868,15 @@ Preferred and valid lifetimes for the prefix measured in seconds\&. defaults to 1800 seconds (30 minutes) and \fIValidLifetimeSec=\fR defaults to 3600 seconds (one hour)\&. +.sp +Added in version 235\&. .RE .PP \fIAssign=\fR .RS 4 Takes a boolean\&. When true, adds an address from the prefix\&. Default to false\&. +.sp +Added in version 246\&. .RE .PP \fIToken=\fR @@ -2922,6 +3886,8 @@ Specifies an optional address generation mode for assigning an address in each p in the [IPv6AcceptRA] section\&. If \fIAssign=\fR is set to false, then this setting will be ignored\&. Defaults to unset, which means the EUI\-64 algorithm will be used\&. +.sp +Added in version 250\&. .RE .PP \fIRouteMetric=\fR @@ -2929,11 +3895,13 @@ is set to false, then this setting will be ignored\&. Defaults to unset, which m The metric of the prefix route\&. Takes an unsigned integer in the range 0\&...4294967295\&. When unset or set to 0, the kernel\*(Aqs default value is used\&. This setting is ignored when \fIAssign=\fR is false\&. +.sp +Added in version 249\&. .RE .SH "[IPV6ROUTEPREFIX] SECTION OPTIONS" .PP One or more [IPv6RoutePrefix] sections contain the IPv6 prefix routes that are announced via Router Advertisements\&. See -\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[20]\d\s+2 +\m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[21]\d\s+2 for further details\&. .PP \fIRoute=\fR @@ -2941,6 +3909,8 @@ for further details\&. 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 "/" character\&. Use multiple [IPv6RoutePrefix] sections to configure multiple IPv6 prefix routes\&. +.sp +Added in version 244\&. .RE .PP \fILifetimeSec=\fR @@ -2948,6 +3918,32 @@ character\&. Use multiple [IPv6RoutePrefix] sections to configure multiple IPv6 Lifetime for the route prefix measured in seconds\&. \fILifetimeSec=\fR defaults to 3600 seconds (one hour)\&. +.sp +Added in version 244\&. +.RE +.SH "[IPV6PREF64PREFIX] SECTION OPTIONS" +.PP +One or more [IPv6PREF64Prefix] sections contain the IPv6 PREF64 (or NAT64) prefixes that are announced via Router Advertisements\&. See +\m[blue]\fBRFC 8781\fR\m[]\&\s-2\u[33]\d\s+2 +for further details\&. +.PP +\fIPrefix=\fR +.RS 4 +The IPv6 PREF64 (or NAT64) prefix that is to be distributed to hosts\&. The setting holds an IPv6 prefix that should be set up for NAT64 translation (PLAT) to allow 464XLAT on the network segment\&. Use multiple [IPv6PREF64Prefix] sections to configure multiple IPv6 prefixes since prefix lifetime may differ from one prefix to another\&. The prefix is an address with a prefix length, separated by a slash +"/" +character\&. Valid NAT64 prefix length are 96, 64, 56, 48, 40, and 32 bits\&. +.sp +Added in version 255\&. +.RE +.PP +\fILifetimeSec=\fR +.RS 4 +Lifetime for the prefix measured in seconds\&. Should be greater than or equal to +\fIRouterLifetimeSec=\fR\&. +\fILifetimeSec=\fR +defaults to 1800 seconds\&. +.sp +Added in version 255\&. .RE .SH "[BRIDGE] SECTION OPTIONS" .PP @@ -2956,61 +3952,85 @@ The [Bridge] section accepts the following keys: \fIUnicastFlood=\fR .RS 4 Takes a boolean\&. Controls whether the bridge should flood traffic for which an FDB entry is missing and the destination is unknown through this port\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 223\&. .RE .PP \fIMulticastFlood=\fR .RS 4 Takes a boolean\&. Controls whether the bridge should flood traffic for which an MDB entry is missing and the destination is unknown through this port\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 242\&. .RE .PP \fIMulticastToUnicast=\fR .RS 4 Takes a boolean\&. Multicast to unicast works on top of the multicast snooping feature of the bridge\&. Which means unicast copies are only delivered to hosts which are interested in it\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 240\&. .RE .PP \fINeighborSuppression=\fR .RS 4 Takes a boolean\&. Configures whether ARP and ND neighbor suppression is enabled for this port\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 242\&. .RE .PP \fILearning=\fR .RS 4 Takes a boolean\&. Configures whether MAC address learning is enabled for this port\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 242\&. .RE .PP \fIHairPin=\fR .RS 4 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\*(Aqs default will be used\&. +.sp +Added in version 223\&. .RE .PP \fIIsolated=\fR .RS 4 Takes a boolean\&. Configures whether this port is isolated or not\&. Within a bridge, isolated ports can only communicate with non\-isolated ports\&. When set to true, this port can only communicate with other ports whose Isolated setting is false\&. When set to false, this port can communicate with any other ports\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 251\&. .RE .PP \fIUseBPDU=\fR .RS 4 Takes a boolean\&. Configures whether STP Bridge Protocol Data Units will be processed by the bridge port\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 223\&. .RE .PP \fIFastLeave=\fR .RS 4 Takes a boolean\&. This flag allows the bridge to immediately stop multicast traffic on a port that receives an IGMP Leave message\&. It is only used with IGMP snooping if enabled on the bridge\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 223\&. .RE .PP \fIAllowPortToBeRoot=\fR .RS 4 Takes a boolean\&. Configures whether a given port is allowed to become a root port\&. Only used when STP is enabled on the bridge\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 223\&. .RE .PP \fIProxyARP=\fR .RS 4 Takes a boolean\&. Configures whether proxy ARP to be enabled on this port\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 243\&. .RE .PP \fIProxyARPWiFi=\fR .RS 4 Takes a boolean\&. Configures whether proxy ARP to be enabled on this port which meets extended requirements by IEEE 802\&.11 and Hotspot 2\&.0 specifications\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 243\&. .RE .PP \fIMulticastRouter=\fR @@ -3024,16 +4044,22 @@ to let the system detect the presence of routers, to permanently enable multicast traffic forwarding on this port, or "temporary" to enable multicast routers temporarily on this port, not depending on incoming queries\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 243\&. .RE .PP \fICost=\fR .RS 4 Sets the "cost" of sending packets of this interface\&. Each port in a bridge may have a different speed and the cost is used to decide which link to use\&. Faster interfaces should have lower costs\&. It is an integer value between 1 and 65535\&. +.sp +Added in version 218\&. .RE .PP \fIPriority=\fR .RS 4 Sets the "priority" of sending packets on this interface\&. Each port in a bridge may have a different priority which is used to decide which link to use\&. Lower value means higher priority\&. It is an integer value between 0 to 63\&. Networkd does not set any default, meaning the kernel default value of 32 is used\&. +.sp +Added in version 234\&. .RE .SH "[BRIDGEFDB] SECTION OPTIONS" .PP @@ -3042,21 +4068,29 @@ The [BridgeFDB] section manages the forwarding database table of a port and acce \fIMACAddress=\fR .RS 4 As in the [Network] section\&. This key is mandatory\&. +.sp +Added in version 219\&. .RE .PP \fIDestination=\fR .RS 4 Takes an IP address of the destination VXLAN tunnel endpoint\&. +.sp +Added in version 243\&. .RE .PP \fIVLANId=\fR .RS 4 The VLAN ID for the new static MAC table entry\&. If omitted, no VLAN ID information is appended to the new static MAC table entry\&. +.sp +Added in version 219\&. .RE .PP \fIVNI=\fR .RS 4 The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to the remote VXLAN tunnel endpoint\&. Takes a number in the range 1\&...16777215\&. Defaults to unset\&. +.sp +Added in version 243\&. .RE .PP \fIAssociatedWith=\fR @@ -3076,11 +4110,15 @@ means the address is associated with master devices fdb\&. "router" means the destination address is associated with a router\&. Note that it\*(Aqs valid if the referenced device is a VXLAN type device and has route shortcircuit enabled\&. Defaults to "self"\&. +.sp +Added in version 243\&. .RE .PP \fIOutgoingInterface=\fR .RS 4 Specifies the name or index of the outgoing interface for the VXLAN device driver to reach the remote VXLAN tunnel endpoint\&. Defaults to unset\&. +.sp +Added in version 249\&. .RE .SH "[BRIDGEMDB] SECTION OPTIONS" .PP @@ -3089,11 +4127,15 @@ The [BridgeMDB] section manages the multicast membership entries forwarding data \fIMulticastGroupAddress=\fR .RS 4 Specifies the IPv4 or IPv6 multicast group address to add\&. This setting is mandatory\&. +.sp +Added in version 247\&. .RE .PP \fIVLANId=\fR .RS 4 The VLAN ID for the new entry\&. Valid ranges are 0 (no VLAN) to 4094\&. Optional, defaults to 0\&. +.sp +Added in version 247\&. .RE .SH "[LLDP] SECTION OPTIONS" .PP @@ -3108,6 +4150,8 @@ in the [DHCPv4] section described above\&. The MUD URLs received via LLDP packets are saved and can be read using the \fBsd_lldp_neighbor_get_mud_url()\fR function\&. +.sp +Added in version 246\&. .RE .SH "[CAN] SECTION OPTIONS" .PP @@ -3116,6 +4160,8 @@ The [CAN] section manages the Controller Area Network (CAN bus) and accepts the \fIBitRate=\fR .RS 4 The bitrate of CAN device in bits per second\&. The usual SI prefixes (K, M) with the base of 1000 can be used here\&. Takes a number in the range 1\&...4294967295\&. +.sp +Added in version 239\&. .RE .PP \fISamplePoint=\fR @@ -3126,6 +4172,8 @@ Optional sample point in percent with one decimal (e\&.g\&. "875‰")\&. This will be ignored when \fIBitRate=\fR is unspecified\&. +.sp +Added in version 239\&. .RE .PP \fITimeQuantaNSec=\fR, \fIPropagationSegment=\fR, \fIPhaseBufferSegment1=\fR, \fIPhaseBufferSegment2=\fR, \fISyncJumpWidth=\fR @@ -3144,6 +4192,8 @@ and must be an unsigned integer in the range 0\&...4294967295\&. These settings will be ignored when \fIBitRate=\fR is specified\&. +.sp +Added in version 250\&. .RE .PP \fIDataBitRate=\fR, \fIDataSamplePoint=\fR @@ -3153,6 +4203,8 @@ The bitrate and sample point for the data phase, if CAN\-FD is used\&. These set and \fISamplePoint=\fR keys\&. +.sp +Added in version 246\&. .RE .PP \fIDataTimeQuantaNSec=\fR, \fIDataPropagationSegment=\fR, \fIDataPhaseBufferSegment1=\fR, \fIDataPhaseBufferSegment2=\fR, \fIDataSyncJumpWidth=\fR @@ -3160,6 +4212,8 @@ keys\&. Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the synchronization jump width for the data phase, if CAN\-FD is used\&. These settings are analogous to the \fITimeQuantaNSec=\fR or related settings\&. +.sp +Added in version 250\&. .RE .PP \fIFDMode=\fR @@ -3172,12 +4226,16 @@ and keys, or \fIDataTimeQuanta=\fR and related settings\&. +.sp +Added in version 246\&. .RE .PP \fIFDNonISO=\fR .RS 4 Takes a boolean\&. When "yes", non\-ISO CAN\-FD mode is enabled for the interface\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 246\&. .RE .PP \fIRestartSec=\fR @@ -3192,6 +4250,8 @@ postfix\&. Using or "0" will turn the automatic restart off\&. By default automatic restart is disabled\&. +.sp +Added in version 239\&. .RE .PP \fITermination=\fR @@ -3202,48 +4262,64 @@ Takes a boolean or a termination resistor value in ohm in the range 0\&...65535\ or "0" is set, the termination resistor is disabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 246\&. .RE .PP \fITripleSampling=\fR .RS 4 Takes a boolean\&. When "yes", three samples (instead of one) are used to determine the value of a received bit by majority rule\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 242\&. .RE .PP \fIBusErrorReporting=\fR .RS 4 Takes a boolean\&. When "yes", reporting of CAN bus errors is activated (those include single bit, frame format, and bit stuffing errors, unable to send dominant bit, unable to send recessive bit, bus overload, active error announcement, error occurred on transmission)\&. When unset, the kernel\*(Aqs default will be used\&. Note: in case of a CAN bus with a single CAN device, sending a CAN frame may result in a huge number of CAN bus errors\&. +.sp +Added in version 248\&. .RE .PP \fIListenOnly=\fR .RS 4 Takes a boolean\&. When "yes", listen\-only mode is enabled\&. When the interface is in listen\-only mode, the interface neither transmit CAN frames nor send ACK bit\&. Listen\-only mode is important to debug CAN networks without interfering with the communication or acknowledge the CAN frame\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 246\&. .RE .PP \fILoopback=\fR .RS 4 Takes a boolean\&. When "yes", loopback mode is enabled\&. When the loopback mode is enabled, the interface treats messages transmitted by itself as received messages\&. The loopback mode is important to debug CAN networks\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .PP \fIOneShot=\fR .RS 4 Takes a boolean\&. When "yes", one\-shot mode is enabled\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .PP \fIPresumeAck=\fR .RS 4 Takes a boolean\&. When "yes", the interface will ignore missing CAN ACKs\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .PP \fIClassicDataLengthCode=\fR .RS 4 Takes a boolean\&. When "yes", the interface will handle the 4bit data length code (DLC)\&. When unset, the kernel\*(Aqs default will be used\&. +.sp +Added in version 250\&. .RE .SH "[IPOIB] SECTION OPTIONS" .PP @@ -3261,11 +4337,15 @@ When .sp When "connected", the Infiniband reliable connected (RC) transport is used\&. Connected mode takes advantage of the connected nature of the IB transport and allows an MTU up to the maximal IP packet size of 64K, which reduces the number of IP packets needed for handling large UDP datagrams, TCP segments, etc and increases the performance for large messages\&. +.sp +Added in version 250\&. .RE .PP \fIIgnoreUserspaceMulticastGroup=\fR .RS 4 Takes an boolean value\&. When true, the kernel ignores multicast groups handled by userspace\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .SH "[QDISC] SECTION OPTIONS" .PP @@ -3277,6 +4357,8 @@ Specifies the parent Queueing Discipline (qdisc)\&. Takes one of "clsact" or "ingress"\&. This is mandatory\&. +.sp +Added in version 244\&. .RE .PP \fIHandle=\fR @@ -3305,26 +4387,36 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIDelaySec=\fR .RS 4 Specifies the fixed amount of delay to be added to all packets going out of the interface\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fIDelayJitterSec=\fR .RS 4 Specifies the chosen delay to be added to the packets outgoing to the network interface\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fIPacketLimit=\fR .RS 4 Specifies the maximum number of packets the qdisc may hold queued at a time\&. An unsigned integer in the range 0\&...4294967294\&. Defaults to 1000\&. +.sp +Added in version 245\&. .RE .PP \fILossRate=\fR .RS 4 Specifies an independent loss probability to be added to the packets outgoing from the network interface\&. Takes a percentage value, suffixed with "%"\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fIDuplicateRate=\fR .RS 4 Specifies that the chosen percent of packets is duplicated before queuing them\&. Takes a percentage value, suffixed with "%"\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .SH "[TOKENBUCKETFILTER] SECTION OPTIONS" .PP @@ -3348,36 +4440,50 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fILatencySec=\fR .RS 4 Specifies the latency parameter, which specifies the maximum amount of time a packet can sit in the Token Bucket Filter (TBF)\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fILimitBytes=\fR .RS 4 Takes the number of bytes that can be queued waiting for tokens to become available\&. When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIBurstBytes=\fR .RS 4 Specifies the size of the bucket\&. This is the maximum amount of bytes that tokens can be available for instantaneous transfer\&. When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIRate=\fR .RS 4 Specifies the device specific bandwidth\&. When suffixed with K, M, or G, the specified bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fIMPUBytes=\fR .RS 4 The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes) for a packet\&. 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 zero\&. +.sp +Added in version 245\&. .RE .PP \fIPeakRate=\fR .RS 4 Takes the maximum depletion rate of the bucket\&. When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .PP \fIMTUBytes=\fR .RS 4 Specifies the size of the peakrate bucket\&. 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\&. +.sp +Added in version 245\&. .RE .SH "[PIE] SECTION OPTIONS" .PP @@ -3401,6 +4507,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 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 1\&...4294967294\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .SH "[FLOWQUEUEPIE] SECTION OPTIONS" .PP @@ -3426,6 +4534,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 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\*(Aqs default is used\&. +.sp +Added in version 247\&. .RE .SH "[STOCHASTICFAIRBLUE] SECTION OPTIONS" .PP @@ -3449,6 +4559,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 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\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .SH "[STOCHASTICFAIRNESSQUEUEING] SECTION OPTIONS" .PP @@ -3472,6 +4584,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPerturbPeriodSec=\fR .RS 4 Specifies the interval in seconds for queue algorithm perturbation\&. Defaults to unset\&. +.sp +Added in version 245\&. .RE .SH "[BFIFO] SECTION OPTIONS" .PP @@ -3495,6 +4609,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fILimitBytes=\fR .RS 4 Specifies the hard limit in bytes on the FIFO buffer size\&. The size limit prevents overflow in case the kernel 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 default is used\&. +.sp +Added in version 246\&. .RE .SH "[PFIFO] SECTION OPTIONS" .PP @@ -3518,6 +4634,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 Specifies the hard limit on the number of packets in the FIFO queue\&. The size limit prevents overflow in case the kernel 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\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .SH "[PFIFOHEADDROP] SECTION OPTIONS" .PP @@ -3541,6 +4659,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 As in [PFIFO] section\&. +.sp +Added in version 246\&. .RE .SH "[PFIFOFAST] SECTION OPTIONS" .PP @@ -3582,6 +4702,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIBandwidth=\fR .RS 4 Specifies the shaper bandwidth\&. When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .PP \fIAutoRateIngress=\fR @@ -3589,16 +4711,22 @@ Specifies the shaper bandwidth\&. When suffixed with K, M, or G, the specified s Takes a boolean value\&. Enables automatic capacity estimation based on traffic arriving at this qdisc\&. This is most likely to be useful with cellular links, which tend to change quality randomly\&. If this setting is enabled, the \fIBandwidth=\fR setting is used as an initial estimate\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fIOverheadBytes=\fR .RS 4 Specifies that bytes to be addeded to the size of each packet\&. Bytes may be negative\&. Takes an integer in the range \-64\&...256\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .PP \fIMPUBytes=\fR .RS 4 Rounds each packet (including overhead) up to the specified bytes\&. Takes an integer in the range 1\&...256\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fICompensationMode=\fR @@ -3610,11 +4738,15 @@ Takes one of "none", no compensation is taken into account\&. When "atm", enables the compensation for ATM cell framing, which is normally found on ADSL links\&. When "ptm", enables the compensation for PTM encoding, which is normally found on VDSL2 links and uses a 64b/65b encoding scheme\&. Defaults to unset and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fIUseRawPacketSize=\fR .RS 4 Takes a boolean value\&. When true, the packet size reported by the Linux kernel will be used, instead of the underlying IP packet size\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fIFlowIsolationMode=\fR @@ -3624,6 +4756,8 @@ CAKE places packets from different flows into different queues, then packets fro \fBnone\fR .RS 4 The flow isolation is disabled, and all traffic passes through a single queue\&. +.sp +Added in version 250\&. .RE .PP \fBsrc\-host\fR @@ -3634,6 +4768,8 @@ option for \fBtc qdisc\fR command\&. See also \fBtc-cake\fR(8)\&. +.sp +Added in version 250\&. .RE .PP \fBdst\-host\fR @@ -3644,6 +4780,8 @@ option for \fBtc qdisc\fR command\&. See also \fBtc-cake\fR(8)\&. +.sp +Added in version 250\&. .RE .PP \fBhosts\fR @@ -3652,6 +4790,8 @@ Flows are defined by source\-destination host pairs\&. Equivalent to the same op \fBtc qdisc\fR command\&. See also \fBtc-cake\fR(8)\&. +.sp +Added in version 250\&. .RE .PP \fBflows\fR @@ -3660,6 +4800,8 @@ Flows are defined by the entire 5\-tuple of source address, destination address, \fBtc qdisc\fR command\&. See also \fBtc-cake\fR(8)\&. +.sp +Added in version 250\&. .RE .PP \fBdual\-src\-host\fR @@ -3672,6 +4814,8 @@ option for \fBtc qdisc\fR command\&. See also \fBtc-cake\fR(8)\&. +.sp +Added in version 250\&. .RE .PP \fBdual\-dst\-host\fR @@ -3684,6 +4828,8 @@ option for \fBtc qdisc\fR command\&. See also \fBtc-cake\fR(8)\&. +.sp +Added in version 250\&. .RE .PP \fBtriple\fR @@ -3695,9 +4841,13 @@ option for \fBtc qdisc\fR command\&. See also \fBtc-cake\fR(8)\&. +.sp +Added in version 250\&. .RE .sp Defaults to unset and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fINAT=\fR @@ -3708,6 +4858,8 @@ is "none" or "flows", or if NAT is performed on a different host\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fIPriorityQueueingPreset=\fR @@ -3718,6 +4870,8 @@ CAKE divides traffic into \fBbesteffort\fR .RS 4 Disables priority queueing by placing all traffic in one tin\&. +.sp +Added in version 250\&. .RE .PP \fBprecedence\fR @@ -3725,44 +4879,62 @@ Disables priority queueing by placing all traffic in one tin\&. Enables priority queueing based on the legacy interpretation of TOS "Precedence" field\&. Use of this preset on the modern Internet is firmly discouraged\&. +.sp +Added in version 250\&. .RE .PP \fBdiffserv8\fR .RS 4 Enables priority queueing based on the Differentiated Service ("DiffServ") field with eight tins: Background Traffic, High Throughput, Best Effort, Video Streaming, Low Latency Transactions, Interactive Shell, Minimum Latency, and Network Control\&. +.sp +Added in version 250\&. .RE .PP \fBdiffserv4\fR .RS 4 Enables priority queueing based on the Differentiated Service ("DiffServ") field with four tins: Background Traffic, Best Effort, Streaming Media, and Latency Sensitive\&. +.sp +Added in version 250\&. .RE .PP \fBdiffserv3\fR .RS 4 Enables priority queueing based on the Differentiated Service ("DiffServ") field with three tins: Background Traffic, Best Effort, and Latency Sensitive\&. +.sp +Added in version 250\&. .RE .sp Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fIFirewallMark=\fR .RS 4 Takes an integer in the range 1\&...4294967295\&. When specified, firewall\-mark\-based overriding of CAKE\*(Aqs tin selection is enabled\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fIWash=\fR .RS 4 Takes a boolean value\&. When true, CAKE clears the DSCP fields, except for ECN bits, of any packet passing through CAKE\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fISplitGSO=\fR .RS 4 Takes a boolean value\&. When true, CAKE will split General Segmentation Offload (GSO) super\-packets into their on\-the\-wire components and dequeue them individually\&. Defaults to unset, and the kernel\*(Aqs default is used\&. +.sp +Added in version 250\&. .RE .PP \fIRTTSec=\fR .RS 4 Specifies the RTT for the filter\&. Takes a timespan\&. Typical values are e\&.g\&. 100us for extremely high\-performance 10GigE+ networks like datacentre, 1ms for non\-WiFi LAN connections, 100ms for typical internet connections\&. Defaults to unset, and the kernel\*(Aqs default will be used\&. +.sp +Added in version 253\&. .RE .PP \fIAckFilter=\fR @@ -3771,6 +4943,8 @@ Takes a boolean value, or special value "aggressive"\&. If enabled, ACKs in each flow are queued and redundant ACKs to the upstream are dropped\&. If yes, the filter will always keep at least two redundant ACKs in the queue, while in "aggressive" mode, it will filter down to a single ACK\&. This may improve download throughput on links with very asymmetrical rate limits\&. Defaults to unset, and the kernel\*(Aqs default will be used\&. +.sp +Added in version 253\&. .RE .SH "[CONTROLLEDDELAY] SECTION OPTIONS" .PP @@ -3794,26 +4968,36 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 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\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fITargetSec=\fR .RS 4 Takes a timespan\&. Specifies the acceptable minimum standing/persistent queue delay\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIIntervalSec=\fR .RS 4 Takes a timespan\&. This is used to ensure that the measured minimum delay does not become too stale\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIECN=\fR .RS 4 Takes a boolean\&. This can be used to mark packets instead of dropping them\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fICEThresholdSec=\fR .RS 4 Takes a timespan\&. This sets a threshold above which all packets are marked with ECN Congestion Experienced (CE)\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .SH "[DEFICITROUNDROBINSCHEDULER] SECTION OPTIONS" .PP @@ -3852,6 +5036,8 @@ Configures the unique identifier of the class\&. It is specified as the major an \fIQuantumBytes=\fR .RS 4 Specifies the amount of bytes a flow is allowed to dequeue before the scheduler moves to the next class\&. 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 the MTU of the interface\&. +.sp +Added in version 246\&. .RE .SH "[ENHANCEDTRANSMISSIONSELECTION] SECTION OPTIONS" .PP @@ -3878,21 +5064,29 @@ Specifies the number of bands\&. An unsigned integer in the range 1\&...16\&. Th \fIStrictBands=\fR and bandwidth\-sharing bands specified in \fIQuantumBytes=\fR\&. +.sp +Added in version 246\&. .RE .PP \fIStrictBands=\fR .RS 4 Specifies the number of bands that should be created in strict mode\&. An unsigned integer in the range 1\&...16\&. +.sp +Added in version 246\&. .RE .PP \fIQuantumBytes=\fR .RS 4 Specifies the white\-space separated list of quantum used in band\-sharing bands\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&. +.sp +Added in version 246\&. .RE .PP \fIPriorityMap=\fR .RS 4 The priority map maps the priority of a packet to a band\&. The argument is a whitespace separated list of numbers\&. The first number indicates which band the packets with priority 0 should be put to, the second is for priority 1, and so on\&. There can be up to 16 numbers in the list\&. If there are fewer, the default band that traffic with one of the unmentioned priorities goes to is the last one\&. Each band number must be in the range 0\&...255\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&. +.sp +Added in version 246\&. .RE .SH "[GENERICRANDOMEARLYDETECTION] SECTION OPTIONS" .PP @@ -3916,17 +5110,23 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIVirtualQueues=\fR .RS 4 Specifies the number of virtual queues\&. Takes an integer in the range 1\&...16\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .PP \fIDefaultVirtualQueue=\fR .RS 4 Specifies the number of default virtual queue\&. This must be less than \fIVirtualQueue=\fR\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .PP \fIGenericRIO=\fR .RS 4 Takes a boolean\&. It turns on the RIO\-like buffering scheme\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .SH "[FAIRQUEUEINGCONTROLLEDDELAY] SECTION OPTIONS" .PP @@ -3950,41 +5150,57 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 Specifies the hard limit on the real queue size\&. When this limit is reached, incoming packets are dropped\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIMemoryLimitBytes=\fR .RS 4 Specifies the limit on the total number of bytes that can be queued in this FQ\-CoDel instance\&. 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\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .PP \fIFlows=\fR .RS 4 Specifies the number of flows into which the incoming packets are classified\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fITargetSec=\fR .RS 4 Takes a timespan\&. Specifies the acceptable minimum standing/persistent queue delay\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIIntervalSec=\fR .RS 4 Takes a timespan\&. This is used to ensure that the measured minimum delay does not become too stale\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIQuantumBytes=\fR .RS 4 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\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .PP \fIECN=\fR .RS 4 Takes a boolean\&. This can be used to mark packets instead of dropping them\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fICEThresholdSec=\fR .RS 4 Takes a timespan\&. This sets a threshold above which all packets are marked with ECN Congestion Experienced (CE)\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .SH "[FAIRQUEUEING] SECTION OPTIONS" .PP @@ -4008,46 +5224,64 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 Specifies the hard limit on the real queue size\&. When this limit is reached, incoming packets are dropped\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIFlowLimit=\fR .RS 4 Specifies the hard limit on the maximum number of packets queued per flow\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIQuantumBytes=\fR .RS 4 Specifies the credit per dequeue RR round, i\&.e\&. the amount of bytes a flow is allowed to dequeue at once\&. 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\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .PP \fIInitialQuantumBytes=\fR .RS 4 Specifies the initial sending rate credit, i\&.e\&. the amount of bytes a new flow is allowed to dequeue initially\&. 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\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIMaximumRate=\fR .RS 4 Specifies the maximum sending rate of a flow\&. When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIBuckets=\fR .RS 4 Specifies the size of the hash table used for flow lookups\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIOrphanMask=\fR .RS 4 Takes an unsigned integer\&. For packets not owned by a socket, fq is able to mask a part of hash and reduce number of buckets associated with the traffic\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fIPacing=\fR .RS 4 Takes a boolean, and enables or disables flow pacing\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .PP \fICEThresholdSec=\fR .RS 4 Takes a timespan\&. This sets a threshold above which all packets are marked with ECN Congestion Experienced (CE)\&. Defaults to unset and kernel\*(Aqs default is used\&. +.sp +Added in version 245\&. .RE .SH "[TRIVIALLINKEQUALIZER] SECTION OPTIONS" .PP @@ -4080,6 +5314,8 @@ with option must be loaded before \fBsystemd\-networkd\fR is started\&. +.sp +Added in version 245\&. .RE .SH "[HIERARCHYTOKENBUCKET] SECTION OPTIONS" .PP @@ -4103,6 +5339,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIDefaultClass=\fR .RS 4 Takes the minor id in hexadecimal of the default class\&. Unclassified traffic gets sent to the class\&. Defaults to unset\&. +.sp +Added in version 246\&. .RE .PP \fIRateToQuantum=\fR @@ -4111,6 +5349,8 @@ Takes an unsigned integer\&. The DRR quantums are calculated by dividing the val \fIRate=\fR by \fIRateToQuantum=\fR\&. +.sp +Added in version 246\&. .RE .SH "[HIERARCHYTOKENBUCKETCLASS] SECTION OPTIONS" .PP @@ -4131,26 +5371,36 @@ Configures the unique identifier of the class\&. It is specified as the major an \fIPriority=\fR .RS 4 Specifies the priority of the class\&. In the round\-robin process, classes with the lowest priority field are tried for packets first\&. +.sp +Added in version 246\&. .RE .PP \fIQuantumBytes=\fR .RS 4 Specifies how many bytes to serve from leaf at once\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. +.sp +Added in version 246\&. .RE .PP \fIMTUBytes=\fR .RS 4 Specifies the maximum packet size we create\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. +.sp +Added in version 246\&. .RE .PP \fIOverheadBytes=\fR .RS 4 Takes an unsigned integer which specifies per\-packet size overhead used in rate computations\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. +.sp +Added in version 246\&. .RE .PP \fIRate=\fR .RS 4 Specifies the maximum rate this class and all its children are guaranteed\&. When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. This setting is mandatory\&. +.sp +Added in version 246\&. .RE .PP \fICeilRate=\fR @@ -4158,16 +5408,22 @@ Specifies the maximum rate this class and all its children are guaranteed\&. Whe Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare\&. When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. When unset, the value specified with \fIRate=\fR is used\&. +.sp +Added in version 246\&. .RE .PP \fIBufferBytes=\fR .RS 4 Specifies the maximum bytes burst which can be accumulated during idle period\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. +.sp +Added in version 246\&. .RE .PP \fICeilBufferBytes=\fR .RS 4 Specifies the maximum bytes burst for ceil which can be accumulated during idle period\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. +.sp +Added in version 246\&. .RE .SH "[HEAVYHITTERFILTER] SECTION OPTIONS" .PP @@ -4191,6 +5447,8 @@ Configures the major number of unique identifier of the qdisc, known as the hand \fIPacketLimit=\fR .RS 4 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\*(Aqs default is used\&. +.sp +Added in version 246\&. .RE .SH "[QUICKFAIRQUEUEING] SECTION OPTIONS" .PP @@ -4229,11 +5487,15 @@ Configures the unique identifier of the class\&. It is specified as the major an \fIWeight=\fR .RS 4 Specifies the weight of the class\&. Takes an integer in the range 1\&...1023\&. Defaults to unset in which case the kernel default is used\&. +.sp +Added in version 246\&. .RE .PP \fIMaxPacketBytes=\fR .RS 4 Specifies the maximum packet size in bytes for the class\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. When unset, the kernel default is used\&. +.sp +Added in version 246\&. .RE .SH "[BRIDGEVLAN] SECTION OPTIONS" .PP @@ -4245,6 +5507,8 @@ option has to be enabled, see the [Bridge] section in \fIVLAN=\fR .RS 4 The VLAN ID allowed on the port\&. This can be either a single ID or a range M\-N\&. Takes an integer in the range 1\&...4094\&. +.sp +Added in version 231\&. .RE .PP \fIEgressUntagged=\fR @@ -4254,6 +5518,8 @@ The VLAN ID specified here will be used to untag frames on egress\&. Configuring implicates the use of \fIVLAN=\fR above and will enable the VLAN ID for ingress as well\&. This can be either a single ID or a range M\-N\&. +.sp +Added in version 231\&. .RE .PP \fIPVID=\fR @@ -4265,6 +5531,8 @@ can be used only once\&. Configuring implicates the use of \fIVLAN=\fR above and will enable the VLAN ID for ingress as well\&. +.sp +Added in version 231\&. .RE .SH "EXAMPLES" .PP @@ -4803,7 +6071,7 @@ RFC 4941 \%https://tools.ietf.org/html/rfc4941 .RE .IP " 9." 4 -RFC 1027 +RFC 3704 .RS 4 \%https://tools.ietf.org/html/rfc1027 .RE @@ -4843,81 +6111,111 @@ NetLabel Fallback Peer Labeling \%https://github.com/SELinuxProject/selinux-notebook/blob/main/src/network_support.md .RE .IP "17." 4 +NFT +.RS 4 +\%https://netfilter.org/projects/nftables/index.html +.RE +.IP "18." 4 RFC 3484 .RS 4 \%https://tools.ietf.org/html/rfc3484 .RE -.IP "18." 4 +.IP "19." 4 Type of Service .RS 4 \%https://en.wikipedia.org/wiki/Type_of_service .RE -.IP "19." 4 +.IP "20." 4 Differentiated services .RS 4 \%https://en.wikipedia.org/wiki/Differentiated_services .RE -.IP "20." 4 +.IP "21." 4 RFC 4191 .RS 4 \%https://tools.ietf.org/html/rfc4191 .RE -.IP "21." 4 +.IP "22." 4 RFC 8520 .RS 4 \%https://tools.ietf.org/html/rfc8520 .RE -.IP "22." 4 +.IP "23." 4 +RFC 4039 +.RS 4 +\%https://tools.ietf.org/html/rfc4039 +.RE +.IP "24." 4 RFC 7844 .RS 4 \%https://tools.ietf.org/html/rfc7844 .RE -.IP "23." 4 +.IP "25." 4 C-style escapes .RS 4 \%https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences .RE -.IP "24." 4 +.IP "26." 4 +RFC 3442 +.RS 4 +\%https://datatracker.ietf.org/doc/html/rfc3442 +.RE +.IP "27." 4 RFC 5969 .RS 4 \%https://tools.ietf.org/html/rfc5969 .RE -.IP "25." 4 +.IP "28." 4 +RFC 8925 +.RS 4 +\%https://tools.ietf.org/html/rfc8925 +.RE +.IP "29." 4 RFC 3315 .RS 4 \%https://tools.ietf.org/html/rfc3315#section-17.2.1 .RE -.IP "26." 4 +.IP "30." 4 RFC 8415 .RS 4 \%https://www.rfc-editor.org/rfc/rfc8415.html#section-6.3 .RE -.IP "27." 4 +.IP "31." 4 RFC 4291 .RS 4 \%https://tools.ietf.org/html/rfc4291#section-2.5.4 .RE -.IP "28." 4 +.IP "32." 4 RFC 7217 .RS 4 \%https://tools.ietf.org/html/rfc7217 .RE -.IP "29." 4 +.IP "33." 4 +RFC 8781 +.RS 4 +\%https://tools.ietf.org/html/rfc8781 +.RE +.IP "34." 4 RFC 2131 .RS 4 \%https://www.rfc-editor.org/rfc/rfc2131.html .RE -.IP "30." 4 +.IP "35." 4 RFC 2132 .RS 4 \%https://www.rfc-editor.org/rfc/rfc2132.html .RE -.IP "31." 4 +.IP "36." 4 RFC 1542 .RS 4 \%https://tools.ietf.org/html/rfc1542 .RE -.IP "32." 4 +.IP "37." 4 +RFC 4039 +.RS 4 +\%https://datatracker.ietf.org/doc/html/rfc4039 +.RE +.IP "38." 4 RFC 4861 .RS 4 \%https://tools.ietf.org/html/rfc4861 |