Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1 | .. SPDX-License-Identifier: GPL-2.0 |
| 2 | |
| 3 | ========= |
| 4 | IP Sysctl |
| 5 | ========= |
| 6 | |
| 7 | /proc/sys/net/ipv4/* Variables |
| 8 | ============================== |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 9 | |
| 10 | ip_forward - BOOLEAN |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 11 | - 0 - disabled (default) |
| 12 | - not 0 - enabled |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 13 | |
| 14 | Forward Packets between interfaces. |
| 15 | |
| 16 | This variable is special, its change resets all configuration |
| 17 | parameters to their default state (RFC1122 for hosts, RFC1812 |
| 18 | for routers) |
| 19 | |
| 20 | ip_default_ttl - INTEGER |
Eric Dumazet | cc6f02d | 2010-12-13 12:50:49 -0800 | [diff] [blame] | 21 | Default value of TTL field (Time To Live) for outgoing (but not |
| 22 | forwarded) IP packets. Should be between 1 and 255 inclusive. |
| 23 | Default: 64 (as recommended by RFC1700) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 24 | |
Hannes Frederic Sowa | cd174e6 | 2013-12-14 05:13:45 +0100 | [diff] [blame] | 25 | ip_no_pmtu_disc - INTEGER |
| 26 | Disable Path MTU Discovery. If enabled in mode 1 and a |
Hannes Frederic Sowa | 188b04d | 2013-12-14 04:42:13 +0100 | [diff] [blame] | 27 | fragmentation-required ICMP is received, the PMTU to this |
| 28 | destination will be set to min_pmtu (see below). You will need |
| 29 | to raise min_pmtu to the smallest interface MTU on your system |
| 30 | manually if you want to avoid locally generated fragments. |
Hannes Frederic Sowa | cd174e6 | 2013-12-14 05:13:45 +0100 | [diff] [blame] | 31 | |
| 32 | In mode 2 incoming Path MTU Discovery messages will be |
| 33 | discarded. Outgoing frames are handled the same as in mode 1, |
| 34 | implicitly setting IP_PMTUDISC_DONT on every created socket. |
| 35 | |
Olivier Gayot | bb38ccc | 2018-06-04 12:07:37 +0200 | [diff] [blame] | 36 | Mode 3 is a hardened pmtu discover mode. The kernel will only |
Hannes Frederic Sowa | 8ed1dc4 | 2014-01-09 10:01:17 +0100 | [diff] [blame] | 37 | accept fragmentation-needed errors if the underlying protocol |
| 38 | can verify them besides a plain socket lookup. Current |
| 39 | protocols for which pmtu events will be honored are TCP, SCTP |
| 40 | and DCCP as they verify e.g. the sequence number or the |
| 41 | association. This mode should not be enabled globally but is |
| 42 | only intended to secure e.g. name servers in namespaces where |
| 43 | TCP path mtu must still work but path MTU information of other |
| 44 | protocols should be discarded. If enabled globally this mode |
| 45 | could break other protocols. |
| 46 | |
| 47 | Possible values: 0-3 |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 48 | |
Hannes Frederic Sowa | 188b04d | 2013-12-14 04:42:13 +0100 | [diff] [blame] | 49 | Default: FALSE |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | |
| 51 | min_pmtu - INTEGER |
Eric Dumazet | 20db93c | 2011-11-08 14:21:44 -0500 | [diff] [blame] | 52 | default 552 - minimum discovered Path MTU |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 53 | |
Hannes Frederic Sowa | f87c10a | 2014-01-09 10:01:15 +0100 | [diff] [blame] | 54 | ip_forward_use_pmtu - BOOLEAN |
| 55 | By default we don't trust protocol path MTUs while forwarding |
| 56 | because they could be easily forged and can lead to unwanted |
| 57 | fragmentation by the router. |
| 58 | You only need to enable this if you have user-space software |
| 59 | which tries to discover path mtus by itself and depends on the |
| 60 | kernel honoring this information. This is normally not the |
| 61 | case. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 62 | |
Hannes Frederic Sowa | f87c10a | 2014-01-09 10:01:15 +0100 | [diff] [blame] | 63 | Default: 0 (disabled) |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 64 | |
Hannes Frederic Sowa | f87c10a | 2014-01-09 10:01:15 +0100 | [diff] [blame] | 65 | Possible values: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 66 | |
| 67 | - 0 - disabled |
| 68 | - 1 - enabled |
Hannes Frederic Sowa | f87c10a | 2014-01-09 10:01:15 +0100 | [diff] [blame] | 69 | |
Loganaden Velvindron | 219b5f2 | 2014-11-04 03:02:49 -0800 | [diff] [blame] | 70 | fwmark_reflect - BOOLEAN |
| 71 | Controls the fwmark of kernel-generated IPv4 reply packets that are not |
| 72 | associated with a socket for example, TCP RSTs or ICMP echo replies). |
| 73 | If unset, these packets have a fwmark of zero. If set, they have the |
| 74 | fwmark of the packet they are replying to. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 75 | |
Loganaden Velvindron | 219b5f2 | 2014-11-04 03:02:49 -0800 | [diff] [blame] | 76 | Default: 0 |
| 77 | |
David Ahern | a6db449 | 2016-04-07 07:21:00 -0700 | [diff] [blame] | 78 | fib_multipath_use_neigh - BOOLEAN |
| 79 | Use status of existing neighbor entry when determining nexthop for |
| 80 | multipath routes. If disabled, neighbor information is not used and |
| 81 | packets could be directed to a failed nexthop. Only valid for kernels |
| 82 | built with CONFIG_IP_ROUTE_MULTIPATH enabled. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 83 | |
David Ahern | a6db449 | 2016-04-07 07:21:00 -0700 | [diff] [blame] | 84 | Default: 0 (disabled) |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 85 | |
David Ahern | a6db449 | 2016-04-07 07:21:00 -0700 | [diff] [blame] | 86 | Possible values: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 87 | |
| 88 | - 0 - disabled |
| 89 | - 1 - enabled |
David Ahern | a6db449 | 2016-04-07 07:21:00 -0700 | [diff] [blame] | 90 | |
Nikolay Aleksandrov | bf4e0a3 | 2017-03-16 15:28:00 +0200 | [diff] [blame] | 91 | fib_multipath_hash_policy - INTEGER |
| 92 | Controls which hash policy to use for multipath routes. Only valid |
| 93 | for kernels built with CONFIG_IP_ROUTE_MULTIPATH enabled. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 94 | |
Nikolay Aleksandrov | bf4e0a3 | 2017-03-16 15:28:00 +0200 | [diff] [blame] | 95 | Default: 0 (Layer 3) |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 96 | |
Nikolay Aleksandrov | bf4e0a3 | 2017-03-16 15:28:00 +0200 | [diff] [blame] | 97 | Possible values: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 98 | |
| 99 | - 0 - Layer 3 |
| 100 | - 1 - Layer 4 |
| 101 | - 2 - Layer 3 or inner Layer 3 if present |
Ido Schimmel | 4253b49 | 2021-05-17 21:15:19 +0300 | [diff] [blame] | 102 | - 3 - Custom multipath hash. Fields used for multipath hash calculation |
| 103 | are determined by fib_multipath_hash_fields sysctl |
Nikolay Aleksandrov | bf4e0a3 | 2017-03-16 15:28:00 +0200 | [diff] [blame] | 104 | |
Ido Schimmel | ce5c9c2 | 2021-05-17 21:15:18 +0300 | [diff] [blame] | 105 | fib_multipath_hash_fields - UNSIGNED INTEGER |
| 106 | When fib_multipath_hash_policy is set to 3 (custom multipath hash), the |
| 107 | fields used for multipath hash calculation are determined by this |
| 108 | sysctl. |
| 109 | |
| 110 | This value is a bitmask which enables various fields for multipath hash |
| 111 | calculation. |
| 112 | |
| 113 | Possible fields are: |
| 114 | |
| 115 | ====== ============================ |
| 116 | 0x0001 Source IP address |
| 117 | 0x0002 Destination IP address |
| 118 | 0x0004 IP protocol |
| 119 | 0x0008 Unused (Flow Label) |
| 120 | 0x0010 Source port |
| 121 | 0x0020 Destination port |
| 122 | 0x0040 Inner source IP address |
| 123 | 0x0080 Inner destination IP address |
| 124 | 0x0100 Inner IP protocol |
| 125 | 0x0200 Inner Flow Label |
| 126 | 0x0400 Inner source port |
| 127 | 0x0800 Inner destination port |
| 128 | ====== ============================ |
| 129 | |
| 130 | Default: 0x0007 (source IP, destination IP and IP protocol) |
| 131 | |
David Ahern | 9ab948a | 2019-03-20 09:18:59 -0700 | [diff] [blame] | 132 | fib_sync_mem - UNSIGNED INTEGER |
| 133 | Amount of dirty memory from fib entries that can be backlogged before |
| 134 | synchronize_rcu is forced. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 135 | |
| 136 | Default: 512kB Minimum: 64kB Maximum: 64MB |
David Ahern | 9ab948a | 2019-03-20 09:18:59 -0700 | [diff] [blame] | 137 | |
Petr Machata | 432e05d | 2018-08-01 00:36:03 +0200 | [diff] [blame] | 138 | ip_forward_update_priority - INTEGER |
| 139 | Whether to update SKB priority from "TOS" field in IPv4 header after it |
| 140 | is forwarded. The new SKB priority is mapped from TOS field value |
| 141 | according to an rt_tos2priority table (see e.g. man tc-prio). |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 142 | |
Petr Machata | 432e05d | 2018-08-01 00:36:03 +0200 | [diff] [blame] | 143 | Default: 1 (Update priority.) |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 144 | |
Petr Machata | 432e05d | 2018-08-01 00:36:03 +0200 | [diff] [blame] | 145 | Possible values: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 146 | |
| 147 | - 0 - Do not update priority. |
| 148 | - 1 - Update priority. |
Petr Machata | 432e05d | 2018-08-01 00:36:03 +0200 | [diff] [blame] | 149 | |
Ben Greear | cbaf087 | 2010-11-08 09:13:48 +0000 | [diff] [blame] | 150 | route/max_size - INTEGER |
| 151 | Maximum number of routes allowed in the kernel. Increase |
| 152 | this when using large numbers of interfaces and/or routes. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 153 | |
Ani Sinha | 25050c6 | 2015-01-07 15:45:56 -0800 | [diff] [blame] | 154 | From linux kernel 3.6 onwards, this is deprecated for ipv4 |
| 155 | as route cache is no longer used. |
Ben Greear | cbaf087 | 2010-11-08 09:13:48 +0000 | [diff] [blame] | 156 | |
YOSHIFUJI Hideaki / 吉藤英明 | 2724680 | 2013-01-22 05:20:05 +0000 | [diff] [blame] | 157 | neigh/default/gc_thresh1 - INTEGER |
| 158 | Minimum number of entries to keep. Garbage collector will not |
| 159 | purge entries if there are fewer than this number. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 160 | |
Li RongQing | b66c66d | 2013-03-14 22:49:47 +0000 | [diff] [blame] | 161 | Default: 128 |
YOSHIFUJI Hideaki / 吉藤英明 | 2724680 | 2013-01-22 05:20:05 +0000 | [diff] [blame] | 162 | |
stephen hemminger | a3d1214 | 2014-08-25 15:05:30 -0700 | [diff] [blame] | 163 | neigh/default/gc_thresh2 - INTEGER |
| 164 | Threshold when garbage collector becomes more aggressive about |
| 165 | purging entries. Entries older than 5 seconds will be cleared |
| 166 | when over this number. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 167 | |
stephen hemminger | a3d1214 | 2014-08-25 15:05:30 -0700 | [diff] [blame] | 168 | Default: 512 |
| 169 | |
Ben Greear | cbaf087 | 2010-11-08 09:13:48 +0000 | [diff] [blame] | 170 | neigh/default/gc_thresh3 - INTEGER |
David Ahern | 5895631 | 2018-12-07 12:24:57 -0800 | [diff] [blame] | 171 | Maximum number of non-PERMANENT neighbor entries allowed. Increase |
| 172 | this when using large numbers of interfaces and when communicating |
Ben Greear | cbaf087 | 2010-11-08 09:13:48 +0000 | [diff] [blame] | 173 | with large numbers of directly-connected peers. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 174 | |
Shan Wei | cc86802 | 2012-12-04 18:50:35 +0000 | [diff] [blame] | 175 | Default: 1024 |
Ben Greear | cbaf087 | 2010-11-08 09:13:48 +0000 | [diff] [blame] | 176 | |
Eric Dumazet | 8b5c171 | 2011-11-09 12:07:14 +0000 | [diff] [blame] | 177 | neigh/default/unres_qlen_bytes - INTEGER |
| 178 | The maximum number of bytes which may be used by packets |
| 179 | queued for each unresolved address by other network layers. |
| 180 | (added in linux 3.3) |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 181 | |
stephen hemminger | 3b09adc | 2013-01-03 07:50:29 +0000 | [diff] [blame] | 182 | Setting negative value is meaningless and will return error. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 183 | |
Eric Dumazet | eaa72dc | 2017-08-29 15:16:01 -0700 | [diff] [blame] | 184 | Default: SK_WMEM_MAX, (same as net.core.wmem_default). |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 185 | |
Eric Dumazet | eaa72dc | 2017-08-29 15:16:01 -0700 | [diff] [blame] | 186 | Exact value depends on architecture and kernel options, |
| 187 | but should be enough to allow queuing 256 packets |
| 188 | of medium size. |
Eric Dumazet | 8b5c171 | 2011-11-09 12:07:14 +0000 | [diff] [blame] | 189 | |
| 190 | neigh/default/unres_qlen - INTEGER |
| 191 | The maximum number of packets which may be queued for each |
| 192 | unresolved address by other network layers. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 193 | |
Eric Dumazet | 8b5c171 | 2011-11-09 12:07:14 +0000 | [diff] [blame] | 194 | (deprecated in linux 3.3) : use unres_qlen_bytes instead. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 195 | |
Shan Wei | cc86802 | 2012-12-04 18:50:35 +0000 | [diff] [blame] | 196 | Prior to linux 3.3, the default value is 3 which may cause |
Shan Wei | 5d248c4 | 2012-12-06 16:27:51 +0000 | [diff] [blame] | 197 | unexpected packet loss. The current default value is calculated |
Shan Wei | cc86802 | 2012-12-04 18:50:35 +0000 | [diff] [blame] | 198 | according to default value of unres_qlen_bytes and true size of |
| 199 | packet. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 200 | |
Eric Dumazet | eaa72dc | 2017-08-29 15:16:01 -0700 | [diff] [blame] | 201 | Default: 101 |
Eric Dumazet | 8b5c171 | 2011-11-09 12:07:14 +0000 | [diff] [blame] | 202 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 203 | mtu_expires - INTEGER |
| 204 | Time, in seconds, that cached PMTU information is kept. |
| 205 | |
| 206 | min_adv_mss - INTEGER |
| 207 | The advertised MSS depends on the first hop route MTU, but will |
| 208 | never be lower than this setting. |
| 209 | |
Amit Cohen | 680aea0 | 2021-02-01 21:47:52 +0200 | [diff] [blame] | 210 | fib_notify_on_flag_change - INTEGER |
| 211 | Whether to emit RTM_NEWROUTE notifications whenever RTM_F_OFFLOAD/ |
Amit Cohen | 648106c | 2021-02-07 10:22:51 +0200 | [diff] [blame] | 212 | RTM_F_TRAP/RTM_F_OFFLOAD_FAILED flags are changed. |
Amit Cohen | 680aea0 | 2021-02-01 21:47:52 +0200 | [diff] [blame] | 213 | |
| 214 | After installing a route to the kernel, user space receives an |
| 215 | acknowledgment, which means the route was installed in the kernel, |
| 216 | but not necessarily in hardware. |
| 217 | It is also possible for a route already installed in hardware to change |
| 218 | its action and therefore its flags. For example, a host route that is |
| 219 | trapping packets can be "promoted" to perform decapsulation following |
| 220 | the installation of an IPinIP/VXLAN tunnel. |
| 221 | The notifications will indicate to user-space the state of the route. |
| 222 | |
| 223 | Default: 0 (Do not emit notifications.) |
| 224 | |
| 225 | Possible values: |
| 226 | |
| 227 | - 0 - Do not emit notifications. |
| 228 | - 1 - Emit notifications. |
Amit Cohen | 648106c | 2021-02-07 10:22:51 +0200 | [diff] [blame] | 229 | - 2 - Emit notifications only for RTM_F_OFFLOAD_FAILED flag change. |
Amit Cohen | 680aea0 | 2021-02-01 21:47:52 +0200 | [diff] [blame] | 230 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 231 | IP Fragmentation: |
| 232 | |
Eric Dumazet | 3e67f10 | 2018-03-31 12:58:53 -0700 | [diff] [blame] | 233 | ipfrag_high_thresh - LONG INTEGER |
Eric Dumazet | 648700f | 2018-03-31 12:58:49 -0700 | [diff] [blame] | 234 | Maximum memory used to reassemble IP fragments. |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 235 | |
Eric Dumazet | 3e67f10 | 2018-03-31 12:58:53 -0700 | [diff] [blame] | 236 | ipfrag_low_thresh - LONG INTEGER |
Eric Dumazet | 648700f | 2018-03-31 12:58:49 -0700 | [diff] [blame] | 237 | (Obsolete since linux-4.17) |
Florian Westphal | b13d3cb | 2014-07-24 16:50:32 +0200 | [diff] [blame] | 238 | Maximum memory used to reassemble IP fragments before the kernel |
| 239 | begins to remove incomplete fragment queues to free up resources. |
| 240 | The kernel still accepts new fragments for defragmentation. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 241 | |
| 242 | ipfrag_time - INTEGER |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 243 | Time in seconds to keep an IP fragment in memory. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 244 | |
Herbert Xu | 89cee8b | 2005-12-13 23:14:27 -0800 | [diff] [blame] | 245 | ipfrag_max_dist - INTEGER |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 246 | ipfrag_max_dist is a non-negative integer value which defines the |
| 247 | maximum "disorder" which is allowed among fragments which share a |
| 248 | common IP source address. Note that reordering of packets is |
| 249 | not unusual, but if a large number of fragments arrive from a source |
| 250 | IP address while a particular fragment queue remains incomplete, it |
| 251 | probably indicates that one or more fragments belonging to that queue |
| 252 | have been lost. When ipfrag_max_dist is positive, an additional check |
| 253 | is done on fragments before they are added to a reassembly queue - if |
| 254 | ipfrag_max_dist (or more) fragments have arrived from a particular IP |
| 255 | address between additions to any IP fragment queue using that source |
| 256 | address, it's presumed that one or more fragments in the queue are |
| 257 | lost. The existing fragment queue will be dropped, and a new one |
Herbert Xu | 89cee8b | 2005-12-13 23:14:27 -0800 | [diff] [blame] | 258 | started. An ipfrag_max_dist value of zero disables this check. |
| 259 | |
| 260 | Using a very small value, e.g. 1 or 2, for ipfrag_max_dist can |
| 261 | result in unnecessarily dropping fragment queues when normal |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 262 | reordering of packets occurs, which could lead to poor application |
| 263 | performance. Using a very large value, e.g. 50000, increases the |
| 264 | likelihood of incorrectly reassembling IP fragments that originate |
Herbert Xu | 89cee8b | 2005-12-13 23:14:27 -0800 | [diff] [blame] | 265 | from different IP datagrams, which could result in data corruption. |
| 266 | Default: 64 |
| 267 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 268 | INET peer storage |
| 269 | ================= |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 270 | |
| 271 | inet_peer_threshold - INTEGER |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 272 | The approximate size of the storage. Starting from this threshold |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 273 | entries will be thrown aggressively. This threshold also determines |
| 274 | entries' time-to-live and time intervals between garbage collection |
| 275 | passes. More entries, less time-to-live, less GC interval. |
| 276 | |
| 277 | inet_peer_minttl - INTEGER |
| 278 | Minimum time-to-live of entries. Should be enough to cover fragment |
| 279 | time-to-live on the reassembling side. This minimum time-to-live is |
| 280 | guaranteed if the pool size is less than inet_peer_threshold. |
Stephen Hemminger | 77a538d | 2008-07-01 17:22:48 -0700 | [diff] [blame] | 281 | Measured in seconds. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 282 | |
| 283 | inet_peer_maxttl - INTEGER |
| 284 | Maximum time-to-live of entries. Unused entries will expire after |
| 285 | this period of time if there is no memory pressure on the pool (i.e. |
| 286 | when the number of entries in the pool is very small). |
Stephen Hemminger | 77a538d | 2008-07-01 17:22:48 -0700 | [diff] [blame] | 287 | Measured in seconds. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 288 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 289 | TCP variables |
| 290 | ============= |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 291 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 292 | somaxconn - INTEGER |
| 293 | Limit of socket listen() backlog, known in userspace as SOMAXCONN. |
Eric Dumazet | 19f92a0 | 2019-10-30 09:36:20 -0700 | [diff] [blame] | 294 | Defaults to 4096. (Was 128 before linux-5.4) |
| 295 | See also tcp_max_syn_backlog for additional tuning for TCP sockets. |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 296 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 297 | tcp_abort_on_overflow - BOOLEAN |
| 298 | If listening service is too slow to accept new connections, |
| 299 | reset them. Default state is FALSE. It means that if overflow |
| 300 | occurred due to a burst, connection will recover. Enable this |
| 301 | option _only_ if you are really sure that listening daemon |
| 302 | cannot be tuned to accept connections faster. Enabling this |
| 303 | option can harm clients of your server. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 304 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 305 | tcp_adv_win_scale - INTEGER |
| 306 | Count buffering overhead as bytes/2^tcp_adv_win_scale |
| 307 | (if tcp_adv_win_scale > 0) or bytes-bytes/2^(-tcp_adv_win_scale), |
| 308 | if it is <= 0. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 309 | |
Alexey Dobriyan | 0147fc0 | 2010-11-22 12:54:21 +0000 | [diff] [blame] | 310 | Possible values are [-31, 31], inclusive. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 311 | |
Eric Dumazet | b49960a | 2012-05-02 02:28:41 +0000 | [diff] [blame] | 312 | Default: 1 |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 313 | |
| 314 | tcp_allowed_congestion_control - STRING |
| 315 | Show/set the congestion control choices available to non-privileged |
| 316 | processes. The list is a subset of those listed in |
| 317 | tcp_available_congestion_control. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 318 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 319 | Default is "reno" and the default setting (tcp_congestion_control). |
| 320 | |
| 321 | tcp_app_win - INTEGER |
| 322 | Reserve max(window/2^tcp_app_win, mss) of window for application |
| 323 | buffer. Value 0 is special, it means that nothing is reserved. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 324 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 325 | Default: 31 |
| 326 | |
Eric Dumazet | f54b311 | 2013-12-05 22:36:05 -0800 | [diff] [blame] | 327 | tcp_autocorking - BOOLEAN |
| 328 | Enable TCP auto corking : |
| 329 | When applications do consecutive small write()/sendmsg() system calls, |
| 330 | we try to coalesce these small writes as much as possible, to lower |
| 331 | total amount of sent packets. This is done if at least one prior |
| 332 | packet for the flow is waiting in Qdisc queues or device transmit |
| 333 | queue. Applications can still use TCP_CORK for optimal behavior |
| 334 | when they know how/when to uncork their sockets. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 335 | |
Eric Dumazet | f54b311 | 2013-12-05 22:36:05 -0800 | [diff] [blame] | 336 | Default : 1 |
| 337 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 338 | tcp_available_congestion_control - STRING |
| 339 | Shows the available congestion control choices that are registered. |
| 340 | More congestion control algorithms may be available as modules, |
| 341 | but not loaded. |
| 342 | |
John Heffner | 71599cd | 2007-02-27 10:03:56 -0800 | [diff] [blame] | 343 | tcp_base_mss - INTEGER |
Stephen Hemminger | 4edc2f3 | 2008-07-10 16:50:26 -0700 | [diff] [blame] | 344 | The initial value of search_low to be used by the packetization layer |
| 345 | Path MTU discovery (MTU probing). If MTU probing is enabled, |
| 346 | this is the initial MSS used by the connection. |
John Heffner | 71599cd | 2007-02-27 10:03:56 -0800 | [diff] [blame] | 347 | |
Josh Hunt | c04b79b | 2019-08-07 19:52:29 -0400 | [diff] [blame] | 348 | tcp_mtu_probe_floor - INTEGER |
| 349 | If MTU probing is enabled this caps the minimum MSS used for search_low |
| 350 | for the connection. |
| 351 | |
| 352 | Default : 48 |
| 353 | |
Eric Dumazet | 5f3e2bf00 | 2019-06-06 09:15:31 -0700 | [diff] [blame] | 354 | tcp_min_snd_mss - INTEGER |
| 355 | TCP SYN and SYNACK messages usually advertise an ADVMSS option, |
| 356 | as described in RFC 1122 and RFC 6691. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 357 | |
Eric Dumazet | 5f3e2bf00 | 2019-06-06 09:15:31 -0700 | [diff] [blame] | 358 | If this ADVMSS option is smaller than tcp_min_snd_mss, |
| 359 | it is silently capped to tcp_min_snd_mss. |
| 360 | |
| 361 | Default : 48 (at least 8 bytes of payload per segment) |
| 362 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 363 | tcp_congestion_control - STRING |
| 364 | Set the congestion control algorithm to be used for new |
| 365 | connections. The algorithm "reno" is always available, but |
| 366 | additional choices may be available based on kernel configuration. |
| 367 | Default is set as part of kernel configuration. |
Eric Dumazet | d8a6e65 | 2011-11-30 01:02:41 +0000 | [diff] [blame] | 368 | For passive connections, the listener congestion control choice |
| 369 | is inherited. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 370 | |
Eric Dumazet | d8a6e65 | 2011-11-30 01:02:41 +0000 | [diff] [blame] | 371 | [see setsockopt(listenfd, SOL_TCP, TCP_CONGESTION, "name" ...) ] |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 372 | |
| 373 | tcp_dsack - BOOLEAN |
| 374 | Allows TCP to send "duplicate" SACKs. |
| 375 | |
Yuchung Cheng | eed530b | 2012-05-02 13:30:03 +0000 | [diff] [blame] | 376 | tcp_early_retrans - INTEGER |
Yuchung Cheng | bec41a1 | 2017-01-12 22:11:39 -0800 | [diff] [blame] | 377 | Tail loss probe (TLP) converts RTOs occurring due to tail |
| 378 | losses into fast recovery (draft-ietf-tcpm-rack). Note that |
| 379 | TLP requires RACK to function properly (see tcp_recovery below) |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 380 | |
Yuchung Cheng | eed530b | 2012-05-02 13:30:03 +0000 | [diff] [blame] | 381 | Possible values: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 382 | |
| 383 | - 0 disables TLP |
| 384 | - 3 or 4 enables TLP |
| 385 | |
Nandita Dukkipati | 6ba8a3b | 2013-03-11 10:00:43 +0000 | [diff] [blame] | 386 | Default: 3 |
Yuchung Cheng | eed530b | 2012-05-02 13:30:03 +0000 | [diff] [blame] | 387 | |
Peter Chubb | 34a6ef3 | 2011-02-02 15:39:58 -0800 | [diff] [blame] | 388 | tcp_ecn - INTEGER |
Rick Jones | 7e3a2dc | 2012-11-28 09:53:10 +0000 | [diff] [blame] | 389 | Control use of Explicit Congestion Notification (ECN) by TCP. |
| 390 | ECN is used only when both ends of the TCP connection indicate |
| 391 | support for it. This feature is useful in avoiding losses due |
| 392 | to congestion by allowing supporting routers to signal |
| 393 | congestion before having to drop packets. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 394 | |
Ilpo Järvinen | 255cac9 | 2009-05-04 11:07:36 -0700 | [diff] [blame] | 395 | Possible values are: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 396 | |
| 397 | = ===================================================== |
| 398 | 0 Disable ECN. Neither initiate nor accept ECN. |
| 399 | 1 Enable ECN when requested by incoming connections and |
| 400 | also request ECN on outgoing connection attempts. |
| 401 | 2 Enable ECN when requested by incoming connections |
| 402 | but do not request ECN on outgoing connections. |
| 403 | = ===================================================== |
| 404 | |
Ilpo Järvinen | 255cac9 | 2009-05-04 11:07:36 -0700 | [diff] [blame] | 405 | Default: 2 |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 406 | |
Daniel Borkmann | 4921355 | 2015-05-19 21:04:22 +0200 | [diff] [blame] | 407 | tcp_ecn_fallback - BOOLEAN |
| 408 | If the kernel detects that ECN connection misbehaves, enable fall |
| 409 | back to non-ECN. Currently, this knob implements the fallback |
| 410 | from RFC3168, section 6.1.1.1., but we reserve that in future, |
| 411 | additional detection mechanisms could be implemented under this |
| 412 | knob. The value is not used, if tcp_ecn or per route (or congestion |
| 413 | control) ECN settings are disabled. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 414 | |
Daniel Borkmann | 4921355 | 2015-05-19 21:04:22 +0200 | [diff] [blame] | 415 | Default: 1 (fallback enabled) |
| 416 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 417 | tcp_fack - BOOLEAN |
Yuchung Cheng | 713bafe | 2017-11-08 13:01:26 -0800 | [diff] [blame] | 418 | This is a legacy option, it has no effect anymore. |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 419 | |
| 420 | tcp_fin_timeout - INTEGER |
Rick Jones | d825da2 | 2012-12-10 11:33:00 +0000 | [diff] [blame] | 421 | The length of time an orphaned (no longer referenced by any |
| 422 | application) connection will remain in the FIN_WAIT_2 state |
| 423 | before it is aborted at the local end. While a perfectly |
| 424 | valid "receive only" state for an un-orphaned connection, an |
| 425 | orphaned connection in FIN_WAIT_2 state could otherwise wait |
| 426 | forever for the remote to close its end of the connection. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 427 | |
Rick Jones | d825da2 | 2012-12-10 11:33:00 +0000 | [diff] [blame] | 428 | Cf. tcp_max_orphans |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 429 | |
Rick Jones | d825da2 | 2012-12-10 11:33:00 +0000 | [diff] [blame] | 430 | Default: 60 seconds |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 431 | |
Ilpo Järvinen | 8980806 | 2007-02-27 10:10:55 -0800 | [diff] [blame] | 432 | tcp_frto - INTEGER |
Yuchung Cheng | e33099f | 2013-03-20 13:33:00 +0000 | [diff] [blame] | 433 | Enables Forward RTO-Recovery (F-RTO) defined in RFC5682. |
Ilpo Järvinen | cd99889 | 2007-09-20 11:35:26 -0700 | [diff] [blame] | 434 | F-RTO is an enhanced recovery algorithm for TCP retransmission |
Yuchung Cheng | e33099f | 2013-03-20 13:33:00 +0000 | [diff] [blame] | 435 | timeouts. It is particularly beneficial in networks where the |
| 436 | RTT fluctuates (e.g., wireless). F-RTO is sender-side only |
| 437 | modification. It does not require any support from the peer. |
Stephen Hemminger | 4edc2f3 | 2008-07-10 16:50:26 -0700 | [diff] [blame] | 438 | |
Yuchung Cheng | e33099f | 2013-03-20 13:33:00 +0000 | [diff] [blame] | 439 | By default it's enabled with a non-zero value. 0 disables F-RTO. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 440 | |
Lorenzo Colitti | e2d00e6 | 2018-10-29 09:30:29 +0900 | [diff] [blame] | 441 | tcp_fwmark_accept - BOOLEAN |
| 442 | If set, incoming connections to listening sockets that do not have a |
| 443 | socket mark will set the mark of the accepting socket to the fwmark of |
| 444 | the incoming SYN packet. This will cause all packets on that connection |
| 445 | (starting from the first SYNACK) to be sent with that fwmark. The |
| 446 | listening socket's mark is unchanged. Listening sockets that already |
| 447 | have a fwmark set via setsockopt(SOL_SOCKET, SO_MARK, ...) are |
| 448 | unaffected. |
| 449 | |
| 450 | Default: 0 |
| 451 | |
Neal Cardwell | 032ee42 | 2015-02-06 16:04:38 -0500 | [diff] [blame] | 452 | tcp_invalid_ratelimit - INTEGER |
| 453 | Limit the maximal rate for sending duplicate acknowledgments |
| 454 | in response to incoming TCP packets that are for an existing |
| 455 | connection but that are invalid due to any of these reasons: |
| 456 | |
| 457 | (a) out-of-window sequence number, |
| 458 | (b) out-of-window acknowledgment number, or |
| 459 | (c) PAWS (Protection Against Wrapped Sequence numbers) check failure |
| 460 | |
| 461 | This can help mitigate simple "ack loop" DoS attacks, wherein |
| 462 | a buggy or malicious middlebox or man-in-the-middle can |
| 463 | rewrite TCP header fields in manner that causes each endpoint |
| 464 | to think that the other is sending invalid TCP segments, thus |
| 465 | causing each side to send an unterminating stream of duplicate |
| 466 | acknowledgments for invalid segments. |
| 467 | |
| 468 | Using 0 disables rate-limiting of dupacks in response to |
| 469 | invalid segments; otherwise this value specifies the minimal |
| 470 | space between sending such dupacks, in milliseconds. |
| 471 | |
| 472 | Default: 500 (milliseconds). |
| 473 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 474 | tcp_keepalive_time - INTEGER |
| 475 | How often TCP sends out keepalive messages when keepalive is enabled. |
| 476 | Default: 2hours. |
| 477 | |
| 478 | tcp_keepalive_probes - INTEGER |
| 479 | How many keepalive probes TCP sends out, until it decides that the |
| 480 | connection is broken. Default value: 9. |
| 481 | |
| 482 | tcp_keepalive_intvl - INTEGER |
| 483 | How frequently the probes are send out. Multiplied by |
| 484 | tcp_keepalive_probes it is time to kill not responding connection, |
| 485 | after probes started. Default value: 75sec i.e. connection |
| 486 | will be aborted after ~11 minutes of retries. |
| 487 | |
David Ahern | 6dd9a14 | 2015-12-16 13:20:44 -0800 | [diff] [blame] | 488 | tcp_l3mdev_accept - BOOLEAN |
| 489 | Enables child sockets to inherit the L3 master device index. |
| 490 | Enabling this option allows a "global" listen socket to work |
| 491 | across L3 master domains (e.g., VRFs) with connected sockets |
| 492 | derived from the listen socket to be bound to the L3 domain in |
| 493 | which the packets originated. Only valid when the kernel was |
| 494 | compiled with CONFIG_NET_L3_MASTER_DEV. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 495 | |
| 496 | Default: 0 (disabled) |
David Ahern | 6dd9a14 | 2015-12-16 13:20:44 -0800 | [diff] [blame] | 497 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 498 | tcp_low_latency - BOOLEAN |
Florian Westphal | b6690b1 | 2017-07-30 03:57:20 +0200 | [diff] [blame] | 499 | This is a legacy option, it has no effect anymore. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 500 | |
| 501 | tcp_max_orphans - INTEGER |
| 502 | Maximal number of TCP sockets not attached to any user file handle, |
| 503 | held by system. If this number is exceeded orphaned connections are |
| 504 | reset immediately and warning is printed. This limit exists |
| 505 | only to prevent simple DoS attacks, you _must_ not rely on this |
| 506 | or lower the limit artificially, but rather increase it |
| 507 | (probably, after increasing installed memory), |
| 508 | if network conditions require more than default value, |
| 509 | and tune network services to linger and kill such states |
| 510 | more aggressively. Let me to remind again: each orphan eats |
| 511 | up to ~64K of unswappable memory. |
| 512 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 513 | tcp_max_syn_backlog - INTEGER |
Eric Dumazet | 623d0c2 | 2019-10-30 10:05:46 -0700 | [diff] [blame] | 514 | Maximal number of remembered connection requests (SYN_RECV), |
| 515 | which have not received an acknowledgment from connecting client. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 516 | |
Eric Dumazet | 623d0c2 | 2019-10-30 10:05:46 -0700 | [diff] [blame] | 517 | This is a per-listener limit. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 518 | |
Peter Pan(潘卫平) | 99b53bd | 2011-12-05 21:39:41 +0000 | [diff] [blame] | 519 | The minimal value is 128 for low memory machines, and it will |
| 520 | increase in proportion to the memory of machine. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 521 | |
Peter Pan(潘卫平) | 99b53bd | 2011-12-05 21:39:41 +0000 | [diff] [blame] | 522 | If server suffers from overload, try increasing this number. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 523 | |
Eric Dumazet | 623d0c2 | 2019-10-30 10:05:46 -0700 | [diff] [blame] | 524 | Remember to also check /proc/sys/net/core/somaxconn |
| 525 | A SYN_RECV request socket consumes about 304 bytes of memory. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 526 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 527 | tcp_max_tw_buckets - INTEGER |
| 528 | Maximal number of timewait sockets held by system simultaneously. |
| 529 | If this number is exceeded time-wait socket is immediately destroyed |
| 530 | and warning is printed. This limit exists only to prevent |
| 531 | simple DoS attacks, you _must_ not lower the limit artificially, |
| 532 | but rather increase it (probably, after increasing installed memory), |
| 533 | if network conditions require more than default value. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 534 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 535 | tcp_mem - vector of 3 INTEGERs: min, pressure, max |
| 536 | min: below this number of pages TCP is not bothered about its |
| 537 | memory appetite. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 538 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 539 | pressure: when amount of memory allocated by TCP exceeds this number |
| 540 | of pages, TCP moderates its memory consumption and enters memory |
| 541 | pressure mode, which is exited when memory consumption falls |
| 542 | under "min". |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 543 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 544 | max: number of pages allowed for queueing by all TCP sockets. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 545 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 546 | Defaults are calculated at boot time from amount of available |
| 547 | memory. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 548 | |
Yuchung Cheng | f672258 | 2015-10-16 21:57:42 -0700 | [diff] [blame] | 549 | tcp_min_rtt_wlen - INTEGER |
| 550 | The window length of the windowed min filter to track the minimum RTT. |
| 551 | A shorter window lets a flow more quickly pick up new (higher) |
| 552 | minimum RTT when it is moved to a longer path (e.g., due to traffic |
| 553 | engineering). A longer window makes the filter more resistant to RTT |
| 554 | inflations such as transient congestion. The unit is seconds. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 555 | |
ZhangXiaoxu | 19fad20 | 2019-04-16 09:47:24 +0800 | [diff] [blame] | 556 | Possible values: 0 - 86400 (1 day) |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 557 | |
Yuchung Cheng | f672258 | 2015-10-16 21:57:42 -0700 | [diff] [blame] | 558 | Default: 300 |
| 559 | |
John Heffner | 71599cd | 2007-02-27 10:03:56 -0800 | [diff] [blame] | 560 | tcp_moderate_rcvbuf - BOOLEAN |
Stephen Hemminger | 4edc2f3 | 2008-07-10 16:50:26 -0700 | [diff] [blame] | 561 | If set, TCP performs receive buffer auto-tuning, attempting to |
John Heffner | 71599cd | 2007-02-27 10:03:56 -0800 | [diff] [blame] | 562 | automatically size the buffer (no greater than tcp_rmem[2]) to |
| 563 | match the size required by the path for full throughput. Enabled by |
| 564 | default. |
| 565 | |
| 566 | tcp_mtu_probing - INTEGER |
| 567 | Controls TCP Packetization-Layer Path MTU Discovery. Takes three |
| 568 | values: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 569 | |
| 570 | - 0 - Disabled |
| 571 | - 1 - Disabled by default, enabled when an ICMP black hole detected |
| 572 | - 2 - Always enabled, use initial MSS of tcp_base_mss. |
John Heffner | 71599cd | 2007-02-27 10:03:56 -0800 | [diff] [blame] | 573 | |
Maciej Żenczykowski | d4ce580 | 2018-09-25 21:59:28 -0700 | [diff] [blame] | 574 | tcp_probe_interval - UNSIGNED INTEGER |
Fan Du | fab4276 | 2015-03-06 11:18:25 +0800 | [diff] [blame] | 575 | Controls how often to start TCP Packetization-Layer Path MTU |
| 576 | Discovery reprobe. The default is reprobing every 10 minutes as |
| 577 | per RFC4821. |
| 578 | |
| 579 | tcp_probe_threshold - INTEGER |
| 580 | Controls when TCP Packetization-Layer Path MTU Discovery probing |
| 581 | will stop in respect to the width of search range in bytes. Default |
| 582 | is 8 bytes. |
| 583 | |
John Heffner | 71599cd | 2007-02-27 10:03:56 -0800 | [diff] [blame] | 584 | tcp_no_metrics_save - BOOLEAN |
| 585 | By default, TCP saves various connection metrics in the route cache |
| 586 | when the connection closes, so that connections established in the |
| 587 | near future can use these to set initial conditions. Usually, this |
| 588 | increases overall performance, but may sometimes cause performance |
Simon Arlott | 0f035b8 | 2007-10-20 01:30:25 +0200 | [diff] [blame] | 589 | degradation. If set, TCP will not cache metrics on closing |
John Heffner | 71599cd | 2007-02-27 10:03:56 -0800 | [diff] [blame] | 590 | connections. |
| 591 | |
Kevin(Yudong) Yang | 65e6d90 | 2019-12-09 14:19:59 -0500 | [diff] [blame] | 592 | tcp_no_ssthresh_metrics_save - BOOLEAN |
| 593 | Controls whether TCP saves ssthresh metrics in the route cache. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 594 | |
Kevin(Yudong) Yang | 65e6d90 | 2019-12-09 14:19:59 -0500 | [diff] [blame] | 595 | Default is 1, which disables ssthresh metrics. |
| 596 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 597 | tcp_orphan_retries - INTEGER |
Damian Lukowski | 5d78922 | 2009-09-01 10:24:04 +0000 | [diff] [blame] | 598 | This value influences the timeout of a locally closed TCP connection, |
| 599 | when RTO retransmissions remain unacknowledged. |
| 600 | See tcp_retries2 for more details. |
| 601 | |
David S. Miller | 06b8fc5 | 2011-07-08 09:31:31 -0700 | [diff] [blame] | 602 | The default value is 8. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 603 | |
Damian Lukowski | 5d78922 | 2009-09-01 10:24:04 +0000 | [diff] [blame] | 604 | If your machine is a loaded WEB server, |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 605 | you should think about lowering this value, such sockets |
| 606 | may consume significant resources. Cf. tcp_max_orphans. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 607 | |
Yuchung Cheng | 4f41b1c | 2015-10-16 21:57:47 -0700 | [diff] [blame] | 608 | tcp_recovery - INTEGER |
| 609 | This value is a bitmap to enable various experimental loss recovery |
| 610 | features. |
| 611 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 612 | ========= ============================================================= |
| 613 | RACK: 0x1 enables the RACK loss detection for fast detection of lost |
| 614 | retransmissions and tail drops. It also subsumes and disables |
| 615 | RFC6675 recovery for SACK connections. |
| 616 | |
| 617 | RACK: 0x2 makes RACK's reordering window static (min_rtt/4). |
| 618 | |
| 619 | RACK: 0x4 disables RACK's DUPACK threshold heuristic |
| 620 | ========= ============================================================= |
Yuchung Cheng | 4f41b1c | 2015-10-16 21:57:47 -0700 | [diff] [blame] | 621 | |
| 622 | Default: 0x1 |
| 623 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 624 | tcp_reordering - INTEGER |
Eric Dumazet | dca145f | 2014-10-27 21:45:24 -0700 | [diff] [blame] | 625 | Initial reordering level of packets in a TCP stream. |
| 626 | TCP stack can then dynamically adjust flow reordering level |
| 627 | between this initial value and tcp_max_reordering |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 628 | |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 629 | Default: 3 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 630 | |
Eric Dumazet | dca145f | 2014-10-27 21:45:24 -0700 | [diff] [blame] | 631 | tcp_max_reordering - INTEGER |
| 632 | Maximal reordering level of packets in a TCP stream. |
| 633 | 300 is a fairly conservative value, but you might increase it |
| 634 | if paths are using per packet load balancing (like bonding rr mode) |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 635 | |
Eric Dumazet | dca145f | 2014-10-27 21:45:24 -0700 | [diff] [blame] | 636 | Default: 300 |
| 637 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 638 | tcp_retrans_collapse - BOOLEAN |
| 639 | Bug-to-bug compatibility with some broken printers. |
| 640 | On retransmit try to send bigger packets to work around bugs in |
| 641 | certain TCP stacks. |
| 642 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 643 | tcp_retries1 - INTEGER |
Damian Lukowski | 5d78922 | 2009-09-01 10:24:04 +0000 | [diff] [blame] | 644 | This value influences the time, after which TCP decides, that |
| 645 | something is wrong due to unacknowledged RTO retransmissions, |
| 646 | and reports this suspicion to the network layer. |
| 647 | See tcp_retries2 for more details. |
| 648 | |
| 649 | RFC 1122 recommends at least 3 retransmissions, which is the |
| 650 | default. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 651 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 652 | tcp_retries2 - INTEGER |
Damian Lukowski | 5d78922 | 2009-09-01 10:24:04 +0000 | [diff] [blame] | 653 | This value influences the timeout of an alive TCP connection, |
| 654 | when RTO retransmissions remain unacknowledged. |
| 655 | Given a value of N, a hypothetical TCP connection following |
| 656 | exponential backoff with an initial RTO of TCP_RTO_MIN would |
| 657 | retransmit N times before killing the connection at the (N+1)th RTO. |
| 658 | |
| 659 | The default value of 15 yields a hypothetical timeout of 924.6 |
| 660 | seconds and is a lower bound for the effective timeout. |
| 661 | TCP will effectively time out at the first RTO which exceeds the |
| 662 | hypothetical timeout. |
| 663 | |
| 664 | RFC 1122 recommends at least 100 seconds for the timeout, |
| 665 | which corresponds to a value of at least 8. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 666 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 667 | tcp_rfc1337 - BOOLEAN |
| 668 | If set, the TCP stack behaves conforming to RFC1337. If unset, |
| 669 | we are not conforming to RFC, but prevent TCP TIME_WAIT |
| 670 | assassination. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 671 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 672 | Default: 0 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 673 | |
| 674 | tcp_rmem - vector of 3 INTEGERs: min, default, max |
| 675 | min: Minimal size of receive buffer used by TCP sockets. |
| 676 | It is guaranteed to each TCP socket, even under moderate memory |
| 677 | pressure. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 678 | |
Tonghao Zhang | a61a86f | 2018-02-04 18:07:10 -0800 | [diff] [blame] | 679 | Default: 4K |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 680 | |
J. Bruce Fields | 53025f5 | 2008-07-10 16:47:41 -0700 | [diff] [blame] | 681 | default: initial size of receive buffer used by TCP sockets. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 682 | This value overrides net.core.rmem_default used by other protocols. |
Eric Dumazet | 1d1be91 | 2021-02-10 09:13:33 -0800 | [diff] [blame] | 683 | Default: 131072 bytes. |
| 684 | This value results in initial window of 65535. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 685 | |
| 686 | max: maximal size of receive buffer allowed for automatically |
| 687 | selected receiver buffers for TCP socket. This value does not override |
J. Bruce Fields | 53025f5 | 2008-07-10 16:47:41 -0700 | [diff] [blame] | 688 | net.core.rmem_max. Calling setsockopt() with SO_RCVBUF disables |
| 689 | automatic tuning of that socket's receive buffer size, in which |
| 690 | case this value is ignored. |
Eric Dumazet | 1d1be91 | 2021-02-10 09:13:33 -0800 | [diff] [blame] | 691 | Default: between 131072 and 6MB, depending on RAM size. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 692 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 693 | tcp_sack - BOOLEAN |
| 694 | Enable select acknowledgments (SACKS). |
Rick Jones | 15d99e0 | 2006-03-20 22:40:29 -0800 | [diff] [blame] | 695 | |
Eric Dumazet | 6d82aa2 | 2018-05-17 14:47:28 -0700 | [diff] [blame] | 696 | tcp_comp_sack_delay_ns - LONG INTEGER |
| 697 | TCP tries to reduce number of SACK sent, using a timer |
| 698 | based on 5% of SRTT, capped by this sysctl, in nano seconds. |
| 699 | The default is 1ms, based on TSO autosizing period. |
| 700 | |
| 701 | Default : 1,000,000 ns (1 ms) |
| 702 | |
Eric Dumazet | a70437c | 2020-04-30 10:35:43 -0700 | [diff] [blame] | 703 | tcp_comp_sack_slack_ns - LONG INTEGER |
| 704 | This sysctl control the slack used when arming the |
| 705 | timer used by SACK compression. This gives extra time |
| 706 | for small RTT flows, and reduces system overhead by allowing |
| 707 | opportunistic reduction of timer interrupts. |
| 708 | |
| 709 | Default : 100,000 ns (100 us) |
| 710 | |
Eric Dumazet | 9c21d2f | 2018-05-17 14:47:29 -0700 | [diff] [blame] | 711 | tcp_comp_sack_nr - INTEGER |
Masanari Iida | 2bcd9d8 | 2019-05-21 12:41:15 +0900 | [diff] [blame] | 712 | Max number of SACK that can be compressed. |
Eric Dumazet | 9c21d2f | 2018-05-17 14:47:29 -0700 | [diff] [blame] | 713 | Using 0 disables SACK compression. |
| 714 | |
Masanari Iida | 2bcd9d8 | 2019-05-21 12:41:15 +0900 | [diff] [blame] | 715 | Default : 44 |
Eric Dumazet | 9c21d2f | 2018-05-17 14:47:29 -0700 | [diff] [blame] | 716 | |
David S. Miller | 35089bb | 2006-06-13 22:33:04 -0700 | [diff] [blame] | 717 | tcp_slow_start_after_idle - BOOLEAN |
| 718 | If set, provide RFC2861 behavior and time out the congestion |
| 719 | window after an idle period. An idle period is defined at |
| 720 | the current RTO. If unset, the congestion window will not |
| 721 | be timed out after an idle period. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 722 | |
David S. Miller | 35089bb | 2006-06-13 22:33:04 -0700 | [diff] [blame] | 723 | Default: 1 |
| 724 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 725 | tcp_stdurg - BOOLEAN |
Stephen Hemminger | 4edc2f3 | 2008-07-10 16:50:26 -0700 | [diff] [blame] | 726 | Use the Host requirements interpretation of the TCP urgent pointer field. |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 727 | Most hosts use the older BSD interpretation, so if you turn this on |
| 728 | Linux might not communicate correctly with them. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 729 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 730 | Default: FALSE |
| 731 | |
| 732 | tcp_synack_retries - INTEGER |
| 733 | Number of times SYNACKs for a passive TCP connection attempt will |
| 734 | be retransmitted. Should not be higher than 255. Default value |
Alex Bergmann | 6c9ff97 | 2012-08-31 02:48:31 +0000 | [diff] [blame] | 735 | is 5, which corresponds to 31seconds till the last retransmission |
| 736 | with the current initial RTO of 1second. With this the final timeout |
| 737 | for a passive TCP connection will happen after 63seconds. |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 738 | |
David S. Miller | d8513df | 2020-01-02 16:07:38 -0800 | [diff] [blame] | 739 | tcp_syncookies - INTEGER |
Shan Wei | a3c910d | 2013-06-21 15:18:32 +0800 | [diff] [blame] | 740 | Only valid when the kernel was compiled with CONFIG_SYN_COOKIES |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 741 | Send out syncookies when the syn backlog queue of a socket |
Stephen Hemminger | 4edc2f3 | 2008-07-10 16:50:26 -0700 | [diff] [blame] | 742 | overflows. This is to prevent against the common 'SYN flood attack' |
Shan Wei | a3c910d | 2013-06-21 15:18:32 +0800 | [diff] [blame] | 743 | Default: 1 |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 744 | |
| 745 | Note, that syncookies is fallback facility. |
| 746 | It MUST NOT be used to help highly loaded servers to stand |
Stephen Hemminger | 4edc2f3 | 2008-07-10 16:50:26 -0700 | [diff] [blame] | 747 | against legal connection rate. If you see SYN flood warnings |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 748 | in your logs, but investigation shows that they occur |
| 749 | because of overload with legal connections, you should tune |
| 750 | another parameters until this warning disappear. |
| 751 | See: tcp_max_syn_backlog, tcp_synack_retries, tcp_abort_on_overflow. |
| 752 | |
| 753 | syncookies seriously violate TCP protocol, do not allow |
| 754 | to use TCP extensions, can result in serious degradation |
| 755 | of some services (f.e. SMTP relaying), visible not by you, |
| 756 | but your clients and relays, contacting you. While you see |
Stephen Hemminger | 4edc2f3 | 2008-07-10 16:50:26 -0700 | [diff] [blame] | 757 | SYN flood warnings in logs not being really flooded, your server |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 758 | is seriously misconfigured. |
| 759 | |
Hannes Frederic Sowa | 5ad37d5 | 2013-07-26 17:43:23 +0200 | [diff] [blame] | 760 | If you want to test which effects syncookies have to your |
| 761 | network connections you can set this knob to 2 to enable |
| 762 | unconditionally generation of syncookies. |
| 763 | |
Kuniyuki Iwashima | f9ac779 | 2021-06-12 21:32:14 +0900 | [diff] [blame^] | 764 | tcp_migrate_req - BOOLEAN |
| 765 | The incoming connection is tied to a specific listening socket when |
| 766 | the initial SYN packet is received during the three-way handshake. |
| 767 | When a listener is closed, in-flight request sockets during the |
| 768 | handshake and established sockets in the accept queue are aborted. |
| 769 | |
| 770 | If the listener has SO_REUSEPORT enabled, other listeners on the |
| 771 | same port should have been able to accept such connections. This |
| 772 | option makes it possible to migrate such child sockets to another |
| 773 | listener after close() or shutdown(). |
| 774 | |
| 775 | The BPF_SK_REUSEPORT_SELECT_OR_MIGRATE type of eBPF program should |
| 776 | usually be used to define the policy to pick an alive listener. |
| 777 | Otherwise, the kernel will randomly pick an alive listener only if |
| 778 | this option is enabled. |
| 779 | |
| 780 | Note that migration between listeners with different settings may |
| 781 | crash applications. Let's say migration happens from listener A to |
| 782 | B, and only B has TCP_SAVE_SYN enabled. B cannot read SYN data from |
| 783 | the requests migrated from A. To avoid such a situation, cancel |
| 784 | migration by returning SK_DROP in the type of eBPF program, or |
| 785 | disable this option. |
| 786 | |
| 787 | Default: 0 |
| 788 | |
Yuchung Cheng | cf60af0 | 2012-07-19 06:43:09 +0000 | [diff] [blame] | 789 | tcp_fastopen - INTEGER |
Yuchung Cheng | cebc5cb | 2016-08-22 17:17:54 -0700 | [diff] [blame] | 790 | Enable TCP Fast Open (RFC7413) to send and accept data in the opening |
| 791 | SYN packet. |
| 792 | |
| 793 | The client support is enabled by flag 0x1 (on by default). The client |
| 794 | then must use sendmsg() or sendto() with the MSG_FASTOPEN flag, |
| 795 | rather than connect() to send data in SYN. |
| 796 | |
| 797 | The server support is enabled by flag 0x2 (off by default). Then |
| 798 | either enable for all listeners with another flag (0x400) or |
| 799 | enable individual listeners via TCP_FASTOPEN socket option with |
| 800 | the option value being the length of the syn-data backlog. |
Yuchung Cheng | cf60af0 | 2012-07-19 06:43:09 +0000 | [diff] [blame] | 801 | |
Jerry Chu | 1046716 | 2012-08-31 12:29:11 +0000 | [diff] [blame] | 802 | The values (bitmap) are |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 803 | |
| 804 | ===== ======== ====================================================== |
| 805 | 0x1 (client) enables sending data in the opening SYN on the client. |
| 806 | 0x2 (server) enables the server support, i.e., allowing data in |
Yuchung Cheng | cebc5cb | 2016-08-22 17:17:54 -0700 | [diff] [blame] | 807 | a SYN packet to be accepted and passed to the |
| 808 | application before 3-way handshake finishes. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 809 | 0x4 (client) send data in the opening SYN regardless of cookie |
Yuchung Cheng | cebc5cb | 2016-08-22 17:17:54 -0700 | [diff] [blame] | 810 | availability and without a cookie option. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 811 | 0x200 (server) accept data-in-SYN w/o any cookie option present. |
| 812 | 0x400 (server) enable all listeners to support Fast Open by |
Yuchung Cheng | cebc5cb | 2016-08-22 17:17:54 -0700 | [diff] [blame] | 813 | default without explicit TCP_FASTOPEN socket option. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 814 | ===== ======== ====================================================== |
Yuchung Cheng | cf60af0 | 2012-07-19 06:43:09 +0000 | [diff] [blame] | 815 | |
Yuchung Cheng | cebc5cb | 2016-08-22 17:17:54 -0700 | [diff] [blame] | 816 | Default: 0x1 |
Yuchung Cheng | cf60af0 | 2012-07-19 06:43:09 +0000 | [diff] [blame] | 817 | |
Randy Dunlap | a7db3c7 | 2020-07-03 15:41:13 -0700 | [diff] [blame] | 818 | Note that additional client or server features are only |
Yuchung Cheng | cebc5cb | 2016-08-22 17:17:54 -0700 | [diff] [blame] | 819 | effective if the basic support (0x1 and 0x2) are enabled respectively. |
Jerry Chu | 1046716 | 2012-08-31 12:29:11 +0000 | [diff] [blame] | 820 | |
Wei Wang | cf1ef3f | 2017-04-20 14:45:46 -0700 | [diff] [blame] | 821 | tcp_fastopen_blackhole_timeout_sec - INTEGER |
| 822 | Initial time period in second to disable Fastopen on active TCP sockets |
| 823 | when a TFO firewall blackhole issue happens. |
| 824 | This time period will grow exponentially when more blackhole issues |
| 825 | get detected right after Fastopen is re-enabled and will reset to |
| 826 | initial value when the blackhole issue goes away. |
Yuchung Cheng | 7268586 | 2017-12-12 13:10:40 -0800 | [diff] [blame] | 827 | 0 to disable the blackhole detection. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 828 | |
Wei Wang | cf1ef3f | 2017-04-20 14:45:46 -0700 | [diff] [blame] | 829 | By default, it is set to 1hr. |
| 830 | |
Jason Baron | 2dc7e48 | 2019-05-29 12:34:00 -0400 | [diff] [blame] | 831 | tcp_fastopen_key - list of comma separated 32-digit hexadecimal INTEGERs |
| 832 | The list consists of a primary key and an optional backup key. The |
| 833 | primary key is used for both creating and validating cookies, while the |
| 834 | optional backup key is only used for validating cookies. The purpose of |
| 835 | the backup key is to maximize TFO validation when keys are rotated. |
| 836 | |
| 837 | A randomly chosen primary key may be configured by the kernel if |
| 838 | the tcp_fastopen sysctl is set to 0x400 (see above), or if the |
| 839 | TCP_FASTOPEN setsockopt() optname is set and a key has not been |
| 840 | previously configured via sysctl. If keys are configured via |
| 841 | setsockopt() by using the TCP_FASTOPEN_KEY optname, then those |
| 842 | per-socket keys will be used instead of any keys that are specified via |
| 843 | sysctl. |
| 844 | |
| 845 | A key is specified as 4 8-digit hexadecimal integers which are separated |
| 846 | by a '-' as: xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx. Leading zeros may be |
| 847 | omitted. A primary and a backup key may be specified by separating them |
| 848 | by a comma. If only one key is specified, it becomes the primary key and |
| 849 | any previously configured backup keys are removed. |
| 850 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 851 | tcp_syn_retries - INTEGER |
| 852 | Number of times initial SYNs for an active TCP connection attempt |
Xin Long | bffae69 | 2016-01-20 16:12:33 +0800 | [diff] [blame] | 853 | will be retransmitted. Should not be higher than 127. Default value |
stephen hemminger | 3b09adc | 2013-01-03 07:50:29 +0000 | [diff] [blame] | 854 | is 6, which corresponds to 63seconds till the last retransmission |
Alex Bergmann | 6c9ff97 | 2012-08-31 02:48:31 +0000 | [diff] [blame] | 855 | with the current initial RTO of 1second. With this the final timeout |
| 856 | for an active TCP connection attempt will happen after 127seconds. |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 857 | |
Florian Westphal | 25429d7 | 2016-12-01 11:32:07 +0100 | [diff] [blame] | 858 | tcp_timestamps - INTEGER |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 859 | Enable timestamps as defined in RFC1323. |
| 860 | |
| 861 | - 0: Disabled. |
| 862 | - 1: Enable timestamps as defined in RFC1323 and use random offset for |
| 863 | each connection rather than only using the current time. |
| 864 | - 2: Like 1, but without random offsets. |
| 865 | |
Florian Westphal | 25429d7 | 2016-12-01 11:32:07 +0100 | [diff] [blame] | 866 | Default: 1 |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 867 | |
Eric Dumazet | 95bd09e | 2013-08-27 05:46:32 -0700 | [diff] [blame] | 868 | tcp_min_tso_segs - INTEGER |
| 869 | Minimal number of segments per TSO frame. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 870 | |
Eric Dumazet | 95bd09e | 2013-08-27 05:46:32 -0700 | [diff] [blame] | 871 | Since linux-3.12, TCP does an automatic sizing of TSO frames, |
| 872 | depending on flow rate, instead of filling 64Kbytes packets. |
| 873 | For specific usages, it's possible to force TCP to build big |
| 874 | TSO frames. Note that TCP stack might split too big TSO packets |
| 875 | if available window is too small. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 876 | |
Eric Dumazet | 95bd09e | 2013-08-27 05:46:32 -0700 | [diff] [blame] | 877 | Default: 2 |
| 878 | |
Eric Dumazet | 43e122b | 2015-08-21 17:38:02 -0700 | [diff] [blame] | 879 | tcp_pacing_ss_ratio - INTEGER |
| 880 | sk->sk_pacing_rate is set by TCP stack using a ratio applied |
| 881 | to current rate. (current_rate = cwnd * mss / srtt) |
| 882 | If TCP is in slow start, tcp_pacing_ss_ratio is applied |
| 883 | to let TCP probe for bigger speeds, assuming cwnd can be |
| 884 | doubled every other RTT. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 885 | |
Eric Dumazet | 43e122b | 2015-08-21 17:38:02 -0700 | [diff] [blame] | 886 | Default: 200 |
| 887 | |
| 888 | tcp_pacing_ca_ratio - INTEGER |
| 889 | sk->sk_pacing_rate is set by TCP stack using a ratio applied |
| 890 | to current rate. (current_rate = cwnd * mss / srtt) |
| 891 | If TCP is in congestion avoidance phase, tcp_pacing_ca_ratio |
| 892 | is applied to conservatively probe for bigger throughput. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 893 | |
Eric Dumazet | 43e122b | 2015-08-21 17:38:02 -0700 | [diff] [blame] | 894 | Default: 120 |
| 895 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 896 | tcp_tso_win_divisor - INTEGER |
| 897 | This allows control over what percentage of the congestion window |
| 898 | can be consumed by a single TSO frame. |
| 899 | The setting of this parameter is a choice between burstiness and |
| 900 | building larger TSO frames. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 901 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 902 | Default: 3 |
| 903 | |
Maciej Żenczykowski | 79e9fed | 2018-06-03 10:41:17 -0700 | [diff] [blame] | 904 | tcp_tw_reuse - INTEGER |
| 905 | Enable reuse of TIME-WAIT sockets for new connections when it is |
| 906 | safe from protocol viewpoint. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 907 | |
| 908 | - 0 - disable |
| 909 | - 1 - global enable |
| 910 | - 2 - enable for loopback traffic only |
| 911 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 912 | It should not be changed without advice/request of technical |
| 913 | experts. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 914 | |
Maciej Żenczykowski | 79e9fed | 2018-06-03 10:41:17 -0700 | [diff] [blame] | 915 | Default: 2 |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 916 | |
| 917 | tcp_window_scaling - BOOLEAN |
| 918 | Enable window scaling as defined in RFC1323. |
| 919 | |
| 920 | tcp_wmem - vector of 3 INTEGERs: min, default, max |
J. Bruce Fields | 53025f5 | 2008-07-10 16:47:41 -0700 | [diff] [blame] | 921 | min: Amount of memory reserved for send buffers for TCP sockets. |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 922 | Each TCP socket has rights to use it due to fact of its birth. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 923 | |
Tonghao Zhang | a61a86f | 2018-02-04 18:07:10 -0800 | [diff] [blame] | 924 | Default: 4K |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 925 | |
J. Bruce Fields | 53025f5 | 2008-07-10 16:47:41 -0700 | [diff] [blame] | 926 | default: initial size of send buffer used by TCP sockets. This |
| 927 | value overrides net.core.wmem_default used by other protocols. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 928 | |
J. Bruce Fields | 53025f5 | 2008-07-10 16:47:41 -0700 | [diff] [blame] | 929 | It is usually lower than net.core.wmem_default. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 930 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 931 | Default: 16K |
| 932 | |
J. Bruce Fields | 53025f5 | 2008-07-10 16:47:41 -0700 | [diff] [blame] | 933 | max: Maximal amount of memory allowed for automatically tuned |
| 934 | send buffers for TCP sockets. This value does not override |
| 935 | net.core.wmem_max. Calling setsockopt() with SO_SNDBUF disables |
| 936 | automatic tuning of that socket's send buffer size, in which case |
| 937 | this value is ignored. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 938 | |
J. Bruce Fields | 53025f5 | 2008-07-10 16:47:41 -0700 | [diff] [blame] | 939 | Default: between 64K and 4MB, depending on RAM size. |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 940 | |
Eric Dumazet | c9bee3b7 | 2013-07-22 20:27:07 -0700 | [diff] [blame] | 941 | tcp_notsent_lowat - UNSIGNED INTEGER |
| 942 | A TCP socket can control the amount of unsent bytes in its write queue, |
| 943 | thanks to TCP_NOTSENT_LOWAT socket option. poll()/select()/epoll() |
| 944 | reports POLLOUT events if the amount of unsent bytes is below a per |
| 945 | socket value, and if the write queue is not full. sendmsg() will |
| 946 | also not add new buffers if the limit is hit. |
| 947 | |
| 948 | This global variable controls the amount of unsent data for |
| 949 | sockets not using TCP_NOTSENT_LOWAT. For these sockets, a change |
| 950 | to the global variable has immediate effect. |
| 951 | |
| 952 | Default: UINT_MAX (0xFFFFFFFF) |
| 953 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 954 | tcp_workaround_signed_windows - BOOLEAN |
| 955 | If set, assume no receipt of a window scaling option means the |
| 956 | remote TCP is broken and treats the window as a signed quantity. |
| 957 | If unset, assume the remote TCP is not broken even if we do |
| 958 | not receive a window scaling option from them. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 959 | |
Stephen Hemminger | ef56e62 | 2006-11-09 16:37:26 -0800 | [diff] [blame] | 960 | Default: 0 |
| 961 | |
Andreas Petlund | 36e31b0a | 2010-02-18 02:47:01 +0000 | [diff] [blame] | 962 | tcp_thin_linear_timeouts - BOOLEAN |
| 963 | Enable dynamic triggering of linear timeouts for thin streams. |
| 964 | If set, a check is performed upon retransmission by timeout to |
| 965 | determine if the stream is thin (less than 4 packets in flight). |
| 966 | As long as the stream is found to be thin, up to 6 linear |
| 967 | timeouts may be performed before exponential backoff mode is |
| 968 | initiated. This improves retransmission latency for |
| 969 | non-aggressive thin streams, often found to be time-dependent. |
| 970 | For more information on thin streams, see |
Mauro Carvalho Chehab | ff159f4 | 2020-04-30 18:04:29 +0200 | [diff] [blame] | 971 | Documentation/networking/tcp-thin.rst |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 972 | |
Andreas Petlund | 36e31b0a | 2010-02-18 02:47:01 +0000 | [diff] [blame] | 973 | Default: 0 |
| 974 | |
Eric Dumazet | 46d3cea | 2012-07-11 05:50:31 +0000 | [diff] [blame] | 975 | tcp_limit_output_bytes - INTEGER |
| 976 | Controls TCP Small Queue limit per tcp socket. |
| 977 | TCP bulk sender tends to increase packets in flight until it |
| 978 | gets losses notifications. With SNDBUF autotuning, this can |
Flavio Leitner | 9c4c325 | 2018-06-27 10:34:26 -0300 | [diff] [blame] | 979 | result in a large amount of packets queued on the local machine |
| 980 | (e.g.: qdiscs, CPU backlog, or device) hurting latency of other |
| 981 | flows, for typical pfifo_fast qdiscs. tcp_limit_output_bytes |
| 982 | limits the number of bytes on qdisc or device to reduce artificial |
| 983 | RTT/cwnd and reduce bufferbloat. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 984 | |
Eric Dumazet | c73e580 | 2018-11-11 07:34:28 -0800 | [diff] [blame] | 985 | Default: 1048576 (16 * 65536) |
Eric Dumazet | 46d3cea | 2012-07-11 05:50:31 +0000 | [diff] [blame] | 986 | |
Eric Dumazet | 282f23c | 2012-07-17 10:13:05 +0200 | [diff] [blame] | 987 | tcp_challenge_ack_limit - INTEGER |
| 988 | Limits number of Challenge ACK sent per second, as recommended |
| 989 | in RFC 5961 (Improving TCP's Robustness to Blind In-Window Attacks) |
Cambda Zhu | 5309960 | 2020-04-15 17:54:04 +0800 | [diff] [blame] | 990 | Default: 1000 |
Eric Dumazet | 282f23c | 2012-07-17 10:13:05 +0200 | [diff] [blame] | 991 | |
Eric Dumazet | ede61ca | 2019-06-14 16:22:19 -0700 | [diff] [blame] | 992 | tcp_rx_skb_cache - BOOLEAN |
| 993 | Controls a per TCP socket cache of one skb, that might help |
| 994 | performance of some workloads. This might be dangerous |
| 995 | on systems with a lot of TCP sockets, since it increases |
| 996 | memory usage. |
| 997 | |
| 998 | Default: 0 (disabled) |
| 999 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1000 | UDP variables |
| 1001 | ============= |
Hideo Aoki | 95766ff | 2007-12-31 00:29:24 -0800 | [diff] [blame] | 1002 | |
Robert Shearman | 63a6fff | 2017-01-26 18:02:24 +0000 | [diff] [blame] | 1003 | udp_l3mdev_accept - BOOLEAN |
| 1004 | Enabling this option allows a "global" bound socket to work |
| 1005 | across L3 master domains (e.g., VRFs) with packets capable of |
| 1006 | being received regardless of the L3 domain in which they |
| 1007 | originated. Only valid when the kernel was compiled with |
| 1008 | CONFIG_NET_L3_MASTER_DEV. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1009 | |
| 1010 | Default: 0 (disabled) |
Robert Shearman | 63a6fff | 2017-01-26 18:02:24 +0000 | [diff] [blame] | 1011 | |
Hideo Aoki | 95766ff | 2007-12-31 00:29:24 -0800 | [diff] [blame] | 1012 | udp_mem - vector of 3 INTEGERs: min, pressure, max |
| 1013 | Number of pages allowed for queueing by all UDP sockets. |
| 1014 | |
| 1015 | min: Below this number of pages UDP is not bothered about its |
| 1016 | memory appetite. When amount of memory allocated by UDP exceeds |
| 1017 | this number, UDP starts to moderate memory usage. |
| 1018 | |
| 1019 | pressure: This value was introduced to follow format of tcp_mem. |
| 1020 | |
| 1021 | max: Number of pages allowed for queueing by all UDP sockets. |
| 1022 | |
| 1023 | Default is calculated at boot time from amount of available memory. |
| 1024 | |
| 1025 | udp_rmem_min - INTEGER |
| 1026 | Minimal size of receive buffer used by UDP sockets in moderation. |
| 1027 | Each UDP socket is able to use the size for receiving data, even if |
| 1028 | total pages of UDP sockets exceed udp_mem pressure. The unit is byte. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1029 | |
Tonghao Zhang | 320bd6d | 2018-03-13 21:57:17 -0700 | [diff] [blame] | 1030 | Default: 4K |
Hideo Aoki | 95766ff | 2007-12-31 00:29:24 -0800 | [diff] [blame] | 1031 | |
| 1032 | udp_wmem_min - INTEGER |
| 1033 | Minimal size of send buffer used by UDP sockets in moderation. |
| 1034 | Each UDP socket is able to use the size for sending data, even if |
| 1035 | total pages of UDP sockets exceed udp_mem pressure. The unit is byte. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1036 | |
Tonghao Zhang | 320bd6d | 2018-03-13 21:57:17 -0700 | [diff] [blame] | 1037 | Default: 4K |
Hideo Aoki | 95766ff | 2007-12-31 00:29:24 -0800 | [diff] [blame] | 1038 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1039 | RAW variables |
| 1040 | ============= |
Mike Manning | 6897445 | 2018-11-07 15:36:05 +0000 | [diff] [blame] | 1041 | |
| 1042 | raw_l3mdev_accept - BOOLEAN |
| 1043 | Enabling this option allows a "global" bound socket to work |
| 1044 | across L3 master domains (e.g., VRFs) with packets capable of |
| 1045 | being received regardless of the L3 domain in which they |
| 1046 | originated. Only valid when the kernel was compiled with |
| 1047 | CONFIG_NET_L3_MASTER_DEV. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1048 | |
Mike Manning | 6897445 | 2018-11-07 15:36:05 +0000 | [diff] [blame] | 1049 | Default: 1 (enabled) |
| 1050 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1051 | CIPSOv4 Variables |
| 1052 | ================= |
Paul Moore | 8802f61 | 2006-08-03 16:45:49 -0700 | [diff] [blame] | 1053 | |
| 1054 | cipso_cache_enable - BOOLEAN |
| 1055 | If set, enable additions to and lookups from the CIPSO label mapping |
| 1056 | cache. If unset, additions are ignored and lookups always result in a |
| 1057 | miss. However, regardless of the setting the cache is still |
| 1058 | invalidated when required when means you can safely toggle this on and |
| 1059 | off and the cache will always be "safe". |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1060 | |
Paul Moore | 8802f61 | 2006-08-03 16:45:49 -0700 | [diff] [blame] | 1061 | Default: 1 |
| 1062 | |
| 1063 | cipso_cache_bucket_size - INTEGER |
| 1064 | The CIPSO label cache consists of a fixed size hash table with each |
| 1065 | hash bucket containing a number of cache entries. This variable limits |
| 1066 | the number of entries in each hash bucket; the larger the value the |
| 1067 | more CIPSO label mappings that can be cached. When the number of |
| 1068 | entries in a given hash bucket reaches this limit adding new entries |
| 1069 | causes the oldest entry in the bucket to be removed to make room. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1070 | |
Paul Moore | 8802f61 | 2006-08-03 16:45:49 -0700 | [diff] [blame] | 1071 | Default: 10 |
| 1072 | |
| 1073 | cipso_rbm_optfmt - BOOLEAN |
| 1074 | Enable the "Optimized Tag 1 Format" as defined in section 3.4.2.6 of |
| 1075 | the CIPSO draft specification (see Documentation/netlabel for details). |
| 1076 | This means that when set the CIPSO tag will be padded with empty |
| 1077 | categories in order to make the packet data 32-bit aligned. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1078 | |
Paul Moore | 8802f61 | 2006-08-03 16:45:49 -0700 | [diff] [blame] | 1079 | Default: 0 |
| 1080 | |
| 1081 | cipso_rbm_structvalid - BOOLEAN |
| 1082 | If set, do a very strict check of the CIPSO option when |
| 1083 | ip_options_compile() is called. If unset, relax the checks done during |
| 1084 | ip_options_compile(). Either way is "safe" as errors are caught else |
| 1085 | where in the CIPSO processing code but setting this to 0 (False) should |
| 1086 | result in less work (i.e. it should be faster) but could cause problems |
| 1087 | with other implementations that require strict checking. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1088 | |
Paul Moore | 8802f61 | 2006-08-03 16:45:49 -0700 | [diff] [blame] | 1089 | Default: 0 |
| 1090 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1091 | IP Variables |
| 1092 | ============ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1093 | |
| 1094 | ip_local_port_range - 2 INTEGERS |
| 1095 | Defines the local port range that is used by TCP and UDP to |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1096 | choose the local port. The first number is the first, the |
Eric Dumazet | 07f4c90 | 2015-05-24 14:49:35 -0700 | [diff] [blame] | 1097 | second the last local port number. |
Maciej Żenczykowski | ac71676 | 2019-11-25 14:48:00 -0800 | [diff] [blame] | 1098 | If possible, it is better these numbers have different parity |
| 1099 | (one even and one odd value). |
| 1100 | Must be greater than or equal to ip_unprivileged_port_start. |
Eric Dumazet | 07f4c90 | 2015-05-24 14:49:35 -0700 | [diff] [blame] | 1101 | The default values are 32768 and 60999 respectively. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1102 | |
Amerigo Wang | e3826f1 | 2010-05-05 00:27:06 +0000 | [diff] [blame] | 1103 | ip_local_reserved_ports - list of comma separated ranges |
| 1104 | Specify the ports which are reserved for known third-party |
| 1105 | applications. These ports will not be used by automatic port |
| 1106 | assignments (e.g. when calling connect() or bind() with port |
| 1107 | number 0). Explicit port allocation behavior is unchanged. |
| 1108 | |
| 1109 | The format used for both input and output is a comma separated |
| 1110 | list of ranges (e.g. "1,2-4,10-10" for ports 1, 2, 3, 4 and |
| 1111 | 10). Writing to the file will clear all previously reserved |
| 1112 | ports and update the current list with the one given in the |
| 1113 | input. |
| 1114 | |
| 1115 | Note that ip_local_port_range and ip_local_reserved_ports |
| 1116 | settings are independent and both are considered by the kernel |
| 1117 | when determining which ports are available for automatic port |
| 1118 | assignments. |
| 1119 | |
| 1120 | You can reserve ports which are not in the current |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1121 | ip_local_port_range, e.g.:: |
Amerigo Wang | e3826f1 | 2010-05-05 00:27:06 +0000 | [diff] [blame] | 1122 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1123 | $ cat /proc/sys/net/ipv4/ip_local_port_range |
| 1124 | 32000 60999 |
| 1125 | $ cat /proc/sys/net/ipv4/ip_local_reserved_ports |
| 1126 | 8080,9148 |
Amerigo Wang | e3826f1 | 2010-05-05 00:27:06 +0000 | [diff] [blame] | 1127 | |
| 1128 | although this is redundant. However such a setting is useful |
| 1129 | if later the port range is changed to a value that will |
Otto Hollmann | a7a80b1 | 2021-04-01 17:57:05 +0200 | [diff] [blame] | 1130 | include the reserved ports. Also keep in mind, that overlapping |
| 1131 | of these ranges may affect probability of selecting ephemeral |
| 1132 | ports which are right after block of reserved ports. |
Amerigo Wang | e3826f1 | 2010-05-05 00:27:06 +0000 | [diff] [blame] | 1133 | |
| 1134 | Default: Empty |
| 1135 | |
Krister Johansen | 4548b68 | 2017-01-20 17:49:11 -0800 | [diff] [blame] | 1136 | ip_unprivileged_port_start - INTEGER |
| 1137 | This is a per-namespace sysctl. It defines the first |
| 1138 | unprivileged port in the network namespace. Privileged ports |
| 1139 | require root or CAP_NET_BIND_SERVICE in order to bind to them. |
Maciej Żenczykowski | ac71676 | 2019-11-25 14:48:00 -0800 | [diff] [blame] | 1140 | To disable all privileged ports, set this to 0. They must not |
| 1141 | overlap with the ip_local_port_range. |
Krister Johansen | 4548b68 | 2017-01-20 17:49:11 -0800 | [diff] [blame] | 1142 | |
| 1143 | Default: 1024 |
| 1144 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1145 | ip_nonlocal_bind - BOOLEAN |
| 1146 | If set, allows processes to bind() to non-local IP addresses, |
| 1147 | which can be quite useful - but may break some applications. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1148 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1149 | Default: 0 |
| 1150 | |
Kuniyuki Iwashima | 4b01a96 | 2020-03-10 17:05:25 +0900 | [diff] [blame] | 1151 | ip_autobind_reuse - BOOLEAN |
| 1152 | By default, bind() does not select the ports automatically even if |
| 1153 | the new socket and all sockets bound to the port have SO_REUSEADDR. |
| 1154 | ip_autobind_reuse allows bind() to reuse the port and this is useful |
| 1155 | when you use bind()+connect(), but may break some applications. |
| 1156 | The preferred solution is to use IP_BIND_ADDRESS_NO_PORT and this |
| 1157 | option should only be set by experts. |
| 1158 | Default: 0 |
| 1159 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1160 | ip_dynaddr - BOOLEAN |
| 1161 | If set non-zero, enables support for dynamic addresses. |
| 1162 | If set to a non-zero value larger than 1, a kernel log |
| 1163 | message will be printed when dynamic address rewriting |
| 1164 | occurs. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1165 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1166 | Default: 0 |
| 1167 | |
Cong Wang | e3d73bc | 2013-06-11 18:54:39 +0800 | [diff] [blame] | 1168 | ip_early_demux - BOOLEAN |
| 1169 | Optimize input packet processing down to one demux for |
| 1170 | certain kinds of local sockets. Currently we only do this |
subashab@codeaurora.org | dddb64b | 2017-03-23 13:34:16 -0600 | [diff] [blame] | 1171 | for established TCP and connected UDP sockets. |
Cong Wang | e3d73bc | 2013-06-11 18:54:39 +0800 | [diff] [blame] | 1172 | |
| 1173 | It may add an additional cost for pure routing workloads that |
| 1174 | reduces overall throughput, in such case you should disable it. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1175 | |
Cong Wang | e3d73bc | 2013-06-11 18:54:39 +0800 | [diff] [blame] | 1176 | Default: 1 |
| 1177 | |
Stephen Hemminger | 5cc4adb | 2020-04-21 13:34:48 -0700 | [diff] [blame] | 1178 | ping_group_range - 2 INTEGERS |
| 1179 | Restrict ICMP_PROTO datagram sockets to users in the group range. |
| 1180 | The default is "1 0", meaning, that nobody (not even root) may |
| 1181 | create ping sockets. Setting it to "100 100" would grant permissions |
| 1182 | to the single group. "0 4294967295" would enable it for the world, "100 |
| 1183 | 4294967295" would enable it for the users, but not daemons. |
| 1184 | |
subashab@codeaurora.org | dddb64b | 2017-03-23 13:34:16 -0600 | [diff] [blame] | 1185 | tcp_early_demux - BOOLEAN |
| 1186 | Enable early demux for established TCP sockets. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1187 | |
subashab@codeaurora.org | dddb64b | 2017-03-23 13:34:16 -0600 | [diff] [blame] | 1188 | Default: 1 |
| 1189 | |
| 1190 | udp_early_demux - BOOLEAN |
| 1191 | Enable early demux for connected UDP sockets. Disable this if |
| 1192 | your system could experience more unconnected load. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1193 | |
subashab@codeaurora.org | dddb64b | 2017-03-23 13:34:16 -0600 | [diff] [blame] | 1194 | Default: 1 |
| 1195 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1196 | icmp_echo_ignore_all - BOOLEAN |
David S. Miller | 7ce31246 | 2005-10-03 16:07:30 -0700 | [diff] [blame] | 1197 | If set non-zero, then the kernel will ignore all ICMP ECHO |
| 1198 | requests sent to it. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1199 | |
David S. Miller | 7ce31246 | 2005-10-03 16:07:30 -0700 | [diff] [blame] | 1200 | Default: 0 |
| 1201 | |
Andreas Roeseler | f1b8fa9 | 2021-03-29 18:45:29 -0700 | [diff] [blame] | 1202 | icmp_echo_enable_probe - BOOLEAN |
| 1203 | If set to one, then the kernel will respond to RFC 8335 PROBE |
| 1204 | requests sent to it. |
| 1205 | |
| 1206 | Default: 0 |
| 1207 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1208 | icmp_echo_ignore_broadcasts - BOOLEAN |
David S. Miller | 7ce31246 | 2005-10-03 16:07:30 -0700 | [diff] [blame] | 1209 | If set non-zero, then the kernel will ignore all ICMP ECHO and |
| 1210 | TIMESTAMP requests sent to it via broadcast/multicast. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1211 | |
David S. Miller | 7ce31246 | 2005-10-03 16:07:30 -0700 | [diff] [blame] | 1212 | Default: 1 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1213 | |
| 1214 | icmp_ratelimit - INTEGER |
| 1215 | Limit the maximal rates for sending ICMP packets whose type matches |
| 1216 | icmp_ratemask (see below) to specific targets. |
Stephen Hemminger | 6dbf4bc | 2008-07-01 19:29:07 -0700 | [diff] [blame] | 1217 | 0 to disable any limiting, |
| 1218 | otherwise the minimal space between responses in milliseconds. |
Eric Dumazet | 4cdf507 | 2014-09-19 07:38:40 -0700 | [diff] [blame] | 1219 | Note that another sysctl, icmp_msgs_per_sec limits the number |
| 1220 | of ICMP packets sent on all targets. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1221 | |
Stephen Hemminger | 6dbf4bc | 2008-07-01 19:29:07 -0700 | [diff] [blame] | 1222 | Default: 1000 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1223 | |
Eric Dumazet | 4cdf507 | 2014-09-19 07:38:40 -0700 | [diff] [blame] | 1224 | icmp_msgs_per_sec - INTEGER |
| 1225 | Limit maximal number of ICMP packets sent per second from this host. |
| 1226 | Only messages whose type matches icmp_ratemask (see below) are |
Eric Dumazet | b38e781 | 2020-10-15 11:42:00 -0700 | [diff] [blame] | 1227 | controlled by this limit. For security reasons, the precise count |
| 1228 | of messages per second is randomized. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1229 | |
Eric Dumazet | 4cdf507 | 2014-09-19 07:38:40 -0700 | [diff] [blame] | 1230 | Default: 1000 |
| 1231 | |
| 1232 | icmp_msgs_burst - INTEGER |
| 1233 | icmp_msgs_per_sec controls number of ICMP packets sent per second, |
| 1234 | while icmp_msgs_burst controls the burst size of these packets. |
Eric Dumazet | b38e781 | 2020-10-15 11:42:00 -0700 | [diff] [blame] | 1235 | For security reasons, the precise burst size is randomized. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1236 | |
Eric Dumazet | 4cdf507 | 2014-09-19 07:38:40 -0700 | [diff] [blame] | 1237 | Default: 50 |
| 1238 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1239 | icmp_ratemask - INTEGER |
| 1240 | Mask made of ICMP types for which rates are being limited. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1241 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1242 | Significant bits: IHGFEDCBA9876543210 |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1243 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1244 | Default mask: 0000001100000011000 (6168) |
| 1245 | |
| 1246 | Bit definitions (see include/linux/icmp.h): |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1247 | |
| 1248 | = ========================= |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1249 | 0 Echo Reply |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1250 | 3 Destination Unreachable [1]_ |
| 1251 | 4 Source Quench [1]_ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1252 | 5 Redirect |
| 1253 | 8 Echo Request |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1254 | B Time Exceeded [1]_ |
| 1255 | C Parameter Problem [1]_ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1256 | D Timestamp Request |
| 1257 | E Timestamp Reply |
| 1258 | F Info Request |
| 1259 | G Info Reply |
| 1260 | H Address Mask Request |
| 1261 | I Address Mask Reply |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1262 | = ========================= |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1263 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1264 | .. [1] These are rate limited by default (see default mask above) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1265 | |
| 1266 | icmp_ignore_bogus_error_responses - BOOLEAN |
| 1267 | Some routers violate RFC1122 by sending bogus responses to broadcast |
| 1268 | frames. Such violations are normally logged via a kernel warning. |
| 1269 | If this is set to TRUE, the kernel will not give such warnings, which |
| 1270 | will avoid log file clutter. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1271 | |
Rami Rosen | e8b265e | 2013-06-07 20:16:19 +0000 | [diff] [blame] | 1272 | Default: 1 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1273 | |
Horms | 95f7daf | 2006-02-02 17:02:25 -0800 | [diff] [blame] | 1274 | icmp_errors_use_inbound_ifaddr - BOOLEAN |
| 1275 | |
Paolo Abeni | 02a6d61 | 2015-10-14 14:25:53 +0200 | [diff] [blame] | 1276 | If zero, icmp error messages are sent with the primary address of |
| 1277 | the exiting interface. |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1278 | |
Horms | 95f7daf | 2006-02-02 17:02:25 -0800 | [diff] [blame] | 1279 | If non-zero, the message will be sent with the primary address of |
| 1280 | the interface that received the packet that caused the icmp error. |
Vincent Bernat | 3162820 | 2021-01-30 20:05:18 +0100 | [diff] [blame] | 1281 | This is the behaviour many network administrators will expect from |
Horms | 95f7daf | 2006-02-02 17:02:25 -0800 | [diff] [blame] | 1282 | a router. And it can make debugging complicated network layouts |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1283 | much easier. |
Horms | 95f7daf | 2006-02-02 17:02:25 -0800 | [diff] [blame] | 1284 | |
| 1285 | Note that if no primary address exists for the interface selected, |
| 1286 | then the primary address of the first non-loopback interface that |
Matt LaPlante | d6bc8ac | 2006-10-03 22:54:15 +0200 | [diff] [blame] | 1287 | has one will be used regardless of this setting. |
Horms | 95f7daf | 2006-02-02 17:02:25 -0800 | [diff] [blame] | 1288 | |
| 1289 | Default: 0 |
| 1290 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1291 | igmp_max_memberships - INTEGER |
| 1292 | Change the maximum number of multicast groups we can subscribe to. |
| 1293 | Default: 20 |
| 1294 | |
Jeremy Eder | d67ef35 | 2010-11-15 05:41:31 +0000 | [diff] [blame] | 1295 | Theoretical maximum value is bounded by having to send a membership |
| 1296 | report in a single datagram (i.e. the report can't span multiple |
| 1297 | datagrams, or risk confusing the switch and leaving groups you don't |
| 1298 | intend to). |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1299 | |
Jeremy Eder | d67ef35 | 2010-11-15 05:41:31 +0000 | [diff] [blame] | 1300 | The number of supported groups 'M' is bounded by the number of group |
| 1301 | report entries you can fit into a single datagram of 65535 bytes. |
| 1302 | |
| 1303 | M = 65536-sizeof (ip header)/(sizeof(Group record)) |
| 1304 | |
| 1305 | Group records are variable length, with a minimum of 12 bytes. |
| 1306 | So net.ipv4.igmp_max_memberships should not be set higher than: |
| 1307 | |
| 1308 | (65536-24) / 12 = 5459 |
| 1309 | |
| 1310 | The value 5459 assumes no IP header options, so in practice |
| 1311 | this number may be lower. |
| 1312 | |
Benjamin Poirier | 537377d | 2016-03-21 13:21:40 -0700 | [diff] [blame] | 1313 | igmp_max_msf - INTEGER |
| 1314 | Maximum number of addresses allowed in the source filter list for a |
| 1315 | multicast group. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1316 | |
Benjamin Poirier | 537377d | 2016-03-21 13:21:40 -0700 | [diff] [blame] | 1317 | Default: 10 |
| 1318 | |
Hannes Frederic Sowa | a9fe8e2 | 2014-09-02 15:49:26 +0200 | [diff] [blame] | 1319 | igmp_qrv - INTEGER |
Benjamin Poirier | 537377d | 2016-03-21 13:21:40 -0700 | [diff] [blame] | 1320 | Controls the IGMP query robustness variable (see RFC2236 8.1). |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1321 | |
Benjamin Poirier | 537377d | 2016-03-21 13:21:40 -0700 | [diff] [blame] | 1322 | Default: 2 (as specified by RFC2236 8.1) |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1323 | |
Benjamin Poirier | 537377d | 2016-03-21 13:21:40 -0700 | [diff] [blame] | 1324 | Minimum: 1 (as specified by RFC6636 4.5) |
Hannes Frederic Sowa | a9fe8e2 | 2014-09-02 15:49:26 +0200 | [diff] [blame] | 1325 | |
Hangbin Liu | 1af9283 | 2016-11-07 14:51:23 +0800 | [diff] [blame] | 1326 | force_igmp_version - INTEGER |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1327 | - 0 - (default) No enforcement of a IGMP version, IGMPv1/v2 fallback |
| 1328 | allowed. Will back to IGMPv3 mode again if all IGMPv1/v2 Querier |
| 1329 | Present timer expires. |
| 1330 | - 1 - Enforce to use IGMP version 1. Will also reply IGMPv1 report if |
| 1331 | receive IGMPv2/v3 query. |
| 1332 | - 2 - Enforce to use IGMP version 2. Will fallback to IGMPv1 if receive |
| 1333 | IGMPv1 query message. Will reply report if receive IGMPv3 query. |
| 1334 | - 3 - Enforce to use IGMP version 3. The same react with default 0. |
Hangbin Liu | 1af9283 | 2016-11-07 14:51:23 +0800 | [diff] [blame] | 1335 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1336 | .. note:: |
Hangbin Liu | 1af9283 | 2016-11-07 14:51:23 +0800 | [diff] [blame] | 1337 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1338 | this is not the same with force_mld_version because IGMPv3 RFC3376 |
| 1339 | Security Considerations does not have clear description that we could |
| 1340 | ignore other version messages completely as MLDv2 RFC3810. So make |
| 1341 | this value as default 0 is recommended. |
Benjamin Poirier | 6b226e2 | 2016-03-21 13:21:39 -0700 | [diff] [blame] | 1342 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1343 | ``conf/interface/*`` |
| 1344 | changes special settings per interface (where |
| 1345 | interface" is the name of your network interface) |
| 1346 | |
| 1347 | ``conf/all/*`` |
| 1348 | is special, changes the settings for all interfaces |
Benjamin Poirier | 6b226e2 | 2016-03-21 13:21:39 -0700 | [diff] [blame] | 1349 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1350 | log_martians - BOOLEAN |
| 1351 | Log packets with impossible addresses to kernel log. |
| 1352 | log_martians for the interface will be enabled if at least one of |
| 1353 | conf/{all,interface}/log_martians is set to TRUE, |
| 1354 | it will be disabled otherwise |
| 1355 | |
| 1356 | accept_redirects - BOOLEAN |
| 1357 | Accept ICMP redirect messages. |
| 1358 | accept_redirects for the interface will be enabled if: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1359 | |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1360 | - both conf/{all,interface}/accept_redirects are TRUE in the case |
| 1361 | forwarding for the interface is enabled |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1362 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1363 | or |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1364 | |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1365 | - at least one of conf/{all,interface}/accept_redirects is TRUE in the |
| 1366 | case forwarding for the interface is disabled |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1367 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1368 | accept_redirects for the interface will be disabled otherwise |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1369 | |
| 1370 | default: |
| 1371 | |
| 1372 | - TRUE (host) |
| 1373 | - FALSE (router) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1374 | |
| 1375 | forwarding - BOOLEAN |
Neil Jerram | 88a7cdd | 2017-03-10 12:24:57 +0000 | [diff] [blame] | 1376 | Enable IP forwarding on this interface. This controls whether packets |
| 1377 | received _on_ this interface can be forwarded. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1378 | |
| 1379 | mc_forwarding - BOOLEAN |
| 1380 | Do multicast routing. The kernel needs to be compiled with CONFIG_MROUTE |
| 1381 | and a multicast routing daemon is required. |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1382 | conf/all/mc_forwarding must also be set to TRUE to enable multicast |
| 1383 | routing for the interface |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1384 | |
| 1385 | medium_id - INTEGER |
| 1386 | Integer value used to differentiate the devices by the medium they |
| 1387 | are attached to. Two devices can have different id values when |
| 1388 | the broadcast packets are received only on one of them. |
| 1389 | The default value 0 means that the device is the only interface |
| 1390 | to its medium, value of -1 means that medium is not known. |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1391 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1392 | Currently, it is used to change the proxy_arp behavior: |
| 1393 | the proxy_arp feature is enabled for packets forwarded between |
| 1394 | two devices attached to different media. |
| 1395 | |
| 1396 | proxy_arp - BOOLEAN |
| 1397 | Do proxy arp. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1398 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1399 | proxy_arp for the interface will be enabled if at least one of |
| 1400 | conf/{all,interface}/proxy_arp is set to TRUE, |
| 1401 | it will be disabled otherwise |
| 1402 | |
Jesper Dangaard Brouer | 6532414 | 2010-01-05 05:50:47 +0000 | [diff] [blame] | 1403 | proxy_arp_pvlan - BOOLEAN |
| 1404 | Private VLAN proxy arp. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1405 | |
Jesper Dangaard Brouer | 6532414 | 2010-01-05 05:50:47 +0000 | [diff] [blame] | 1406 | Basically allow proxy arp replies back to the same interface |
| 1407 | (from which the ARP request/solicitation was received). |
| 1408 | |
| 1409 | This is done to support (ethernet) switch features, like RFC |
| 1410 | 3069, where the individual ports are NOT allowed to |
| 1411 | communicate with each other, but they are allowed to talk to |
| 1412 | the upstream router. As described in RFC 3069, it is possible |
| 1413 | to allow these hosts to communicate through the upstream |
| 1414 | router by proxy_arp'ing. Don't need to be used together with |
| 1415 | proxy_arp. |
| 1416 | |
| 1417 | This technology is known by different names: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1418 | |
Jesper Dangaard Brouer | 6532414 | 2010-01-05 05:50:47 +0000 | [diff] [blame] | 1419 | In RFC 3069 it is called VLAN Aggregation. |
| 1420 | Cisco and Allied Telesyn call it Private VLAN. |
| 1421 | Hewlett-Packard call it Source-Port filtering or port-isolation. |
| 1422 | Ericsson call it MAC-Forced Forwarding (RFC Draft). |
| 1423 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1424 | shared_media - BOOLEAN |
| 1425 | Send(router) or accept(host) RFC1620 shared media redirects. |
Eric Garver | 176b346 | 2016-05-26 12:28:05 -0400 | [diff] [blame] | 1426 | Overrides secure_redirects. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1427 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1428 | shared_media for the interface will be enabled if at least one of |
| 1429 | conf/{all,interface}/shared_media is set to TRUE, |
| 1430 | it will be disabled otherwise |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1431 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1432 | default TRUE |
| 1433 | |
| 1434 | secure_redirects - BOOLEAN |
Eric Garver | 176b346 | 2016-05-26 12:28:05 -0400 | [diff] [blame] | 1435 | Accept ICMP redirect messages only to gateways listed in the |
| 1436 | interface's current gateway list. Even if disabled, RFC1122 redirect |
| 1437 | rules still apply. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1438 | |
Eric Garver | 176b346 | 2016-05-26 12:28:05 -0400 | [diff] [blame] | 1439 | Overridden by shared_media. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1440 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1441 | secure_redirects for the interface will be enabled if at least one of |
| 1442 | conf/{all,interface}/secure_redirects is set to TRUE, |
| 1443 | it will be disabled otherwise |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1444 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1445 | default TRUE |
| 1446 | |
| 1447 | send_redirects - BOOLEAN |
| 1448 | Send redirects, if router. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1449 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1450 | send_redirects for the interface will be enabled if at least one of |
| 1451 | conf/{all,interface}/send_redirects is set to TRUE, |
| 1452 | it will be disabled otherwise |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1453 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1454 | Default: TRUE |
| 1455 | |
| 1456 | bootp_relay - BOOLEAN |
| 1457 | Accept packets with source address 0.b.c.d destined |
| 1458 | not to this host as local ones. It is supposed, that |
| 1459 | BOOTP relay daemon will catch and forward such packets. |
| 1460 | conf/all/bootp_relay must also be set to TRUE to enable BOOTP relay |
| 1461 | for the interface |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1462 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1463 | default FALSE |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1464 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1465 | Not Implemented Yet. |
| 1466 | |
| 1467 | accept_source_route - BOOLEAN |
| 1468 | Accept packets with SRR option. |
| 1469 | conf/all/accept_source_route must also be set to TRUE to accept packets |
| 1470 | with SRR option on the interface |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1471 | |
| 1472 | default |
| 1473 | |
| 1474 | - TRUE (router) |
| 1475 | - FALSE (host) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1476 | |
Patrick McHardy | 8153a10 | 2009-12-03 01:25:58 +0000 | [diff] [blame] | 1477 | accept_local - BOOLEAN |
Sébastien Barré | 72b126a | 2014-09-10 18:20:23 +0200 | [diff] [blame] | 1478 | Accept packets with local source addresses. In combination with |
| 1479 | suitable routing, this can be used to direct packets between two |
| 1480 | local interfaces over the wire and have them accepted properly. |
Patrick McHardy | 8153a10 | 2009-12-03 01:25:58 +0000 | [diff] [blame] | 1481 | default FALSE |
| 1482 | |
Thomas Graf | d0daebc3 | 2012-06-12 00:44:01 +0000 | [diff] [blame] | 1483 | route_localnet - BOOLEAN |
| 1484 | Do not consider loopback addresses as martian source or destination |
| 1485 | while routing. This enables the use of 127/8 for local routing purposes. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1486 | |
Thomas Graf | d0daebc3 | 2012-06-12 00:44:01 +0000 | [diff] [blame] | 1487 | default FALSE |
| 1488 | |
Stephen Hemminger | c1cf842 | 2009-02-20 08:25:36 +0000 | [diff] [blame] | 1489 | rp_filter - INTEGER |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1490 | - 0 - No source validation. |
| 1491 | - 1 - Strict mode as defined in RFC3704 Strict Reverse Path |
| 1492 | Each incoming packet is tested against the FIB and if the interface |
| 1493 | is not the best reverse path the packet check will fail. |
| 1494 | By default failed packets are discarded. |
| 1495 | - 2 - Loose mode as defined in RFC3704 Loose Reverse Path |
| 1496 | Each incoming packet's source address is also tested against the FIB |
| 1497 | and if the source address is not reachable via any interface |
| 1498 | the packet check will fail. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1499 | |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1500 | Current recommended practice in RFC3704 is to enable strict mode |
Jesper Dangaard Brouer | bf869c3 | 2009-02-23 04:37:55 +0000 | [diff] [blame] | 1501 | to prevent IP spoofing from DDos attacks. If using asymmetric routing |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1502 | or other complicated routing, then loose mode is recommended. |
Stephen Hemminger | c1cf842 | 2009-02-20 08:25:36 +0000 | [diff] [blame] | 1503 | |
Shan Wei | 1f5865e | 2009-12-02 15:39:04 -0800 | [diff] [blame] | 1504 | The max value from conf/{all,interface}/rp_filter is used |
| 1505 | when doing source validation on the {interface}. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1506 | |
| 1507 | Default value is 0. Note that some distributions enable it |
| 1508 | in startup scripts. |
| 1509 | |
Jay Vosburgh | 8cf5d8c | 2021-02-08 17:37:01 -0800 | [diff] [blame] | 1510 | src_valid_mark - BOOLEAN |
| 1511 | - 0 - The fwmark of the packet is not included in reverse path |
| 1512 | route lookup. This allows for asymmetric routing configurations |
| 1513 | utilizing the fwmark in only one direction, e.g., transparent |
| 1514 | proxying. |
| 1515 | |
| 1516 | - 1 - The fwmark of the packet is included in reverse path route |
| 1517 | lookup. This permits rp_filter to function when the fwmark is |
| 1518 | used for routing traffic in both directions. |
| 1519 | |
| 1520 | This setting also affects the utilization of fmwark when |
| 1521 | performing source address selection for ICMP replies, or |
| 1522 | determining addresses stored for the IPOPT_TS_TSANDADDR and |
| 1523 | IPOPT_RR IP options. |
| 1524 | |
| 1525 | The max value from conf/{all,interface}/src_valid_mark is used. |
| 1526 | |
| 1527 | Default value is 0. |
| 1528 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1529 | arp_filter - BOOLEAN |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1530 | - 1 - Allows you to have multiple network interfaces on the same |
| 1531 | subnet, and have the ARPs for each interface be answered |
| 1532 | based on whether or not the kernel would route a packet from |
| 1533 | the ARP'd IP out that interface (therefore you must use source |
| 1534 | based routing for this to work). In other words it allows control |
| 1535 | of which cards (usually 1) will respond to an arp request. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1536 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1537 | - 0 - (default) The kernel can respond to arp requests with addresses |
| 1538 | from other interfaces. This may seem wrong but it usually makes |
| 1539 | sense, because it increases the chance of successful communication. |
| 1540 | IP addresses are owned by the complete host on Linux, not by |
| 1541 | particular interfaces. Only for more complex setups like load- |
| 1542 | balancing, does this behaviour cause problems. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1543 | |
| 1544 | arp_filter for the interface will be enabled if at least one of |
| 1545 | conf/{all,interface}/arp_filter is set to TRUE, |
| 1546 | it will be disabled otherwise |
| 1547 | |
| 1548 | arp_announce - INTEGER |
| 1549 | Define different restriction levels for announcing the local |
| 1550 | source IP address from IP packets in ARP requests sent on |
| 1551 | interface: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1552 | |
| 1553 | - 0 - (default) Use any local address, configured on any interface |
| 1554 | - 1 - Try to avoid local addresses that are not in the target's |
| 1555 | subnet for this interface. This mode is useful when target |
| 1556 | hosts reachable via this interface require the source IP |
| 1557 | address in ARP requests to be part of their logical network |
| 1558 | configured on the receiving interface. When we generate the |
| 1559 | request we will check all our subnets that include the |
| 1560 | target IP and will preserve the source address if it is from |
| 1561 | such subnet. If there is no such subnet we select source |
| 1562 | address according to the rules for level 2. |
| 1563 | - 2 - Always use the best local address for this target. |
| 1564 | In this mode we ignore the source address in the IP packet |
| 1565 | and try to select local address that we prefer for talks with |
| 1566 | the target host. Such local address is selected by looking |
| 1567 | for primary IP addresses on all our subnets on the outgoing |
| 1568 | interface that include the target IP address. If no suitable |
| 1569 | local address is found we select the first local address |
| 1570 | we have on the outgoing interface or on all other interfaces, |
| 1571 | with the hope we will receive reply for our request and |
| 1572 | even sometimes no matter the source IP address we announce. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1573 | |
| 1574 | The max value from conf/{all,interface}/arp_announce is used. |
| 1575 | |
| 1576 | Increasing the restriction level gives more chance for |
| 1577 | receiving answer from the resolved target while decreasing |
| 1578 | the level announces more valid sender's information. |
| 1579 | |
| 1580 | arp_ignore - INTEGER |
| 1581 | Define different modes for sending replies in response to |
| 1582 | received ARP requests that resolve local target IP addresses: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1583 | |
| 1584 | - 0 - (default): reply for any local target IP address, configured |
| 1585 | on any interface |
| 1586 | - 1 - reply only if the target IP address is local address |
| 1587 | configured on the incoming interface |
| 1588 | - 2 - reply only if the target IP address is local address |
| 1589 | configured on the incoming interface and both with the |
| 1590 | sender's IP address are part from same subnet on this interface |
| 1591 | - 3 - do not reply for local addresses configured with scope host, |
| 1592 | only resolutions for global and link addresses are replied |
| 1593 | - 4-7 - reserved |
| 1594 | - 8 - do not reply for all local addresses |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1595 | |
| 1596 | The max value from conf/{all,interface}/arp_ignore is used |
| 1597 | when ARP request is received on the {interface} |
| 1598 | |
Stephen Hemminger | eefef1c | 2009-02-01 01:04:33 -0800 | [diff] [blame] | 1599 | arp_notify - BOOLEAN |
| 1600 | Define mode for notification of address and device changes. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1601 | |
| 1602 | == ========================================================== |
| 1603 | 0 (default): do nothing |
| 1604 | 1 Generate gratuitous arp requests when device is brought up |
| 1605 | or hardware address changes. |
| 1606 | == ========================================================== |
Stephen Hemminger | eefef1c | 2009-02-01 01:04:33 -0800 | [diff] [blame] | 1607 | |
Neil Horman | c1b1bce | 2006-03-20 22:40:03 -0800 | [diff] [blame] | 1608 | arp_accept - BOOLEAN |
Octavian Purdila | 6d95518 | 2010-01-18 12:58:44 +0000 | [diff] [blame] | 1609 | Define behavior for gratuitous ARP frames who's IP is not |
| 1610 | already present in the ARP table: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1611 | |
| 1612 | - 0 - don't create new entries in the ARP table |
| 1613 | - 1 - create new entries in the ARP table |
Octavian Purdila | 6d95518 | 2010-01-18 12:58:44 +0000 | [diff] [blame] | 1614 | |
| 1615 | Both replies and requests type gratuitous arp will trigger the |
| 1616 | ARP table to be updated, if this setting is on. |
| 1617 | |
| 1618 | If the ARP table already contains the IP address of the |
| 1619 | gratuitous arp frame, the arp table will be updated regardless |
| 1620 | if this setting is on or off. |
| 1621 | |
YOSHIFUJI Hideaki/吉藤英明 | 89c69d3 | 2015-03-19 22:42:04 +0900 | [diff] [blame] | 1622 | mcast_solicit - INTEGER |
| 1623 | The maximum number of multicast probes in INCOMPLETE state, |
| 1624 | when the associated hardware address is unknown. Defaults |
| 1625 | to 3. |
| 1626 | |
| 1627 | ucast_solicit - INTEGER |
| 1628 | The maximum number of unicast probes in PROBE state, when |
| 1629 | the hardware address is being reconfirmed. Defaults to 3. |
Neil Horman | c1b1bce | 2006-03-20 22:40:03 -0800 | [diff] [blame] | 1630 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1631 | app_solicit - INTEGER |
| 1632 | The maximum number of probes to send to the user space ARP daemon |
| 1633 | via netlink before dropping back to multicast probes (see |
YOSHIFUJI Hideaki/吉藤英明 | 89c69d3 | 2015-03-19 22:42:04 +0900 | [diff] [blame] | 1634 | mcast_resolicit). Defaults to 0. |
| 1635 | |
| 1636 | mcast_resolicit - INTEGER |
| 1637 | The maximum number of multicast probes after unicast and |
| 1638 | app probes in PROBE state. Defaults to 0. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1639 | |
| 1640 | disable_policy - BOOLEAN |
| 1641 | Disable IPSEC policy (SPD) for this interface |
| 1642 | |
| 1643 | disable_xfrm - BOOLEAN |
| 1644 | Disable IPSEC encryption on this interface, whatever the policy |
| 1645 | |
Hannes Frederic Sowa | fc4eba5 | 2013-08-14 01:03:46 +0200 | [diff] [blame] | 1646 | igmpv2_unsolicited_report_interval - INTEGER |
| 1647 | The interval in milliseconds in which the next unsolicited |
| 1648 | IGMPv1 or IGMPv2 report retransmit will take place. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1649 | |
Hannes Frederic Sowa | fc4eba5 | 2013-08-14 01:03:46 +0200 | [diff] [blame] | 1650 | Default: 10000 (10 seconds) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1651 | |
Hannes Frederic Sowa | fc4eba5 | 2013-08-14 01:03:46 +0200 | [diff] [blame] | 1652 | igmpv3_unsolicited_report_interval - INTEGER |
| 1653 | The interval in milliseconds in which the next unsolicited |
| 1654 | IGMPv3 report retransmit will take place. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1655 | |
Hannes Frederic Sowa | fc4eba5 | 2013-08-14 01:03:46 +0200 | [diff] [blame] | 1656 | Default: 1000 (1 seconds) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1657 | |
Vincent Bernat | c0c5a60 | 2020-11-07 20:35:13 +0100 | [diff] [blame] | 1658 | ignore_routes_with_linkdown - BOOLEAN |
| 1659 | Ignore routes whose link is down when performing a FIB lookup. |
| 1660 | |
Martin Schwenke | d922e1c | 2014-01-28 15:26:42 +1100 | [diff] [blame] | 1661 | promote_secondaries - BOOLEAN |
| 1662 | When a primary IP address is removed from this interface |
| 1663 | promote a corresponding secondary IP address instead of |
| 1664 | removing all the corresponding secondary IP addresses. |
| 1665 | |
Johannes Berg | 12b74df | 2016-02-04 13:31:17 +0100 | [diff] [blame] | 1666 | drop_unicast_in_l2_multicast - BOOLEAN |
| 1667 | Drop any unicast IP packets that are received in link-layer |
| 1668 | multicast (or broadcast) frames. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1669 | |
Johannes Berg | 12b74df | 2016-02-04 13:31:17 +0100 | [diff] [blame] | 1670 | This behavior (for multicast) is actually a SHOULD in RFC |
| 1671 | 1122, but is disabled by default for compatibility reasons. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1672 | |
Johannes Berg | 12b74df | 2016-02-04 13:31:17 +0100 | [diff] [blame] | 1673 | Default: off (0) |
| 1674 | |
Johannes Berg | 97daf33 | 2016-02-04 13:31:18 +0100 | [diff] [blame] | 1675 | drop_gratuitous_arp - BOOLEAN |
| 1676 | Drop all gratuitous ARP frames, for example if there's a known |
| 1677 | good ARP proxy on the network and such frames need not be used |
| 1678 | (or in the case of 802.11, must not be used to prevent attacks.) |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1679 | |
Johannes Berg | 97daf33 | 2016-02-04 13:31:18 +0100 | [diff] [blame] | 1680 | Default: off (0) |
| 1681 | |
Martin Schwenke | d922e1c | 2014-01-28 15:26:42 +1100 | [diff] [blame] | 1682 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1683 | tag - INTEGER |
| 1684 | Allows you to write a number, which can be used as required. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1685 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1686 | Default value is 0. |
| 1687 | |
Alexander Duyck | e69948a | 2015-08-11 13:35:01 -0700 | [diff] [blame] | 1688 | xfrm4_gc_thresh - INTEGER |
Nicolas Dichtel | 837f741 | 2019-04-09 17:16:59 +0200 | [diff] [blame] | 1689 | (Obsolete since linux-4.14) |
Alexander Duyck | e69948a | 2015-08-11 13:35:01 -0700 | [diff] [blame] | 1690 | The threshold at which we will start garbage collecting for IPv4 |
| 1691 | destination cache entries. At twice this value the system will |
Florian Westphal | 3c2a89d | 2017-07-17 13:57:20 +0200 | [diff] [blame] | 1692 | refuse new allocations. |
Alexander Duyck | e69948a | 2015-08-11 13:35:01 -0700 | [diff] [blame] | 1693 | |
Philip Downey | 87583eb | 2015-08-31 11:30:38 +0100 | [diff] [blame] | 1694 | igmp_link_local_mcast_reports - BOOLEAN |
| 1695 | Enable IGMP reports for link local multicast groups in the |
| 1696 | 224.0.0.X range. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1697 | |
Philip Downey | 87583eb | 2015-08-31 11:30:38 +0100 | [diff] [blame] | 1698 | Default TRUE |
| 1699 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1700 | Alexey Kuznetsov. |
| 1701 | kuznet@ms2.inr.ac.ru |
| 1702 | |
| 1703 | Updated by: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1704 | |
| 1705 | - Andi Kleen |
| 1706 | ak@muc.de |
| 1707 | - Nicolas Delon |
| 1708 | delon.nicolas@wanadoo.fr |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1709 | |
| 1710 | |
| 1711 | |
| 1712 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1713 | /proc/sys/net/ipv6/* Variables |
| 1714 | ============================== |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1715 | |
| 1716 | IPv6 has no global variables such as tcp_*. tcp_* settings under ipv4/ also |
| 1717 | apply to IPv6 [XXX?]. |
| 1718 | |
| 1719 | bindv6only - BOOLEAN |
| 1720 | Default value for IPV6_V6ONLY socket option, |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1721 | which restricts use of the IPv6 socket to IPv6 communication |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1722 | only. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1723 | |
| 1724 | - TRUE: disable IPv4-mapped address feature |
| 1725 | - FALSE: enable IPv4-mapped address feature |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1726 | |
Geoffrey Thomas | d5c073ca | 2011-08-22 11:28:57 -0700 | [diff] [blame] | 1727 | Default: FALSE (as specified in RFC3493) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1728 | |
Florent Fourcot | 6444f72 | 2014-01-17 17:15:05 +0100 | [diff] [blame] | 1729 | flowlabel_consistency - BOOLEAN |
| 1730 | Protect the consistency (and unicity) of flow label. |
| 1731 | You have to disable it to use IPV6_FL_F_REFLECT flag on the |
| 1732 | flow label manager. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1733 | |
| 1734 | - TRUE: enabled |
| 1735 | - FALSE: disabled |
| 1736 | |
Florent Fourcot | 6444f72 | 2014-01-17 17:15:05 +0100 | [diff] [blame] | 1737 | Default: TRUE |
| 1738 | |
Tom Herbert | 4224090 | 2015-07-31 16:52:12 -0700 | [diff] [blame] | 1739 | auto_flowlabels - INTEGER |
| 1740 | Automatically generate flow labels based on a flow hash of the |
| 1741 | packet. This allows intermediate devices, such as routers, to |
| 1742 | identify packet flows for mechanisms like Equal Cost Multipath |
Tom Herbert | cb1ce2e | 2014-07-01 21:33:10 -0700 | [diff] [blame] | 1743 | Routing (see RFC 6438). |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1744 | |
| 1745 | = =========================================================== |
| 1746 | 0 automatic flow labels are completely disabled |
| 1747 | 1 automatic flow labels are enabled by default, they can be |
Tom Herbert | 4224090 | 2015-07-31 16:52:12 -0700 | [diff] [blame] | 1748 | disabled on a per socket basis using the IPV6_AUTOFLOWLABEL |
| 1749 | socket option |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1750 | 2 automatic flow labels are allowed, they may be enabled on a |
Tom Herbert | 4224090 | 2015-07-31 16:52:12 -0700 | [diff] [blame] | 1751 | per socket basis using the IPV6_AUTOFLOWLABEL socket option |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1752 | 3 automatic flow labels are enabled and enforced, they cannot |
Tom Herbert | 4224090 | 2015-07-31 16:52:12 -0700 | [diff] [blame] | 1753 | be disabled by the socket option |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1754 | = =========================================================== |
| 1755 | |
Tom Herbert | b567741 | 2015-07-31 16:52:14 -0700 | [diff] [blame] | 1756 | Default: 1 |
Tom Herbert | cb1ce2e | 2014-07-01 21:33:10 -0700 | [diff] [blame] | 1757 | |
Tom Herbert | 82a584b | 2015-04-29 15:33:21 -0700 | [diff] [blame] | 1758 | flowlabel_state_ranges - BOOLEAN |
| 1759 | Split the flow label number space into two ranges. 0-0x7FFFF is |
| 1760 | reserved for the IPv6 flow manager facility, 0x80000-0xFFFFF |
| 1761 | is reserved for stateless flow labels as described in RFC6437. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1762 | |
| 1763 | - TRUE: enabled |
| 1764 | - FALSE: disabled |
| 1765 | |
Tom Herbert | 82a584b | 2015-04-29 15:33:21 -0700 | [diff] [blame] | 1766 | Default: true |
| 1767 | |
Eric Dumazet | 323a53c | 2019-06-05 07:55:09 -0700 | [diff] [blame] | 1768 | flowlabel_reflect - INTEGER |
| 1769 | Control flow label reflection. Needed for Path MTU |
Jakub Sitnicki | 22b6722 | 2017-08-23 09:55:41 +0200 | [diff] [blame] | 1770 | Discovery to work with Equal Cost Multipath Routing in anycast |
| 1771 | environments. See RFC 7690 and: |
| 1772 | https://tools.ietf.org/html/draft-wang-6man-flow-label-reflection-01 |
Eric Dumazet | 323a53c | 2019-06-05 07:55:09 -0700 | [diff] [blame] | 1773 | |
Eric Dumazet | a346abe | 2019-07-01 06:39:36 -0700 | [diff] [blame] | 1774 | This is a bitmask. |
Eric Dumazet | 323a53c | 2019-06-05 07:55:09 -0700 | [diff] [blame] | 1775 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1776 | - 1: enabled for established flows |
Eric Dumazet | 323a53c | 2019-06-05 07:55:09 -0700 | [diff] [blame] | 1777 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1778 | Note that this prevents automatic flowlabel changes, as done |
| 1779 | in "tcp: change IPv6 flow-label upon receiving spurious retransmission" |
| 1780 | and "tcp: Change txhash on every SYN and RTO retransmit" |
Eric Dumazet | 323a53c | 2019-06-05 07:55:09 -0700 | [diff] [blame] | 1781 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1782 | - 2: enabled for TCP RESET packets (no active listener) |
| 1783 | If set, a RST packet sent in response to a SYN packet on a closed |
| 1784 | port will reflect the incoming flow label. |
| 1785 | |
| 1786 | - 4: enabled for ICMPv6 echo reply messages. |
Eric Dumazet | a346abe | 2019-07-01 06:39:36 -0700 | [diff] [blame] | 1787 | |
Eric Dumazet | 323a53c | 2019-06-05 07:55:09 -0700 | [diff] [blame] | 1788 | Default: 0 |
Jakub Sitnicki | 22b6722 | 2017-08-23 09:55:41 +0200 | [diff] [blame] | 1789 | |
David Ahern | b4bac17 | 2018-03-02 08:32:18 -0800 | [diff] [blame] | 1790 | fib_multipath_hash_policy - INTEGER |
| 1791 | Controls which hash policy to use for multipath routes. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1792 | |
David Ahern | b4bac17 | 2018-03-02 08:32:18 -0800 | [diff] [blame] | 1793 | Default: 0 (Layer 3) |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1794 | |
David Ahern | b4bac17 | 2018-03-02 08:32:18 -0800 | [diff] [blame] | 1795 | Possible values: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1796 | |
| 1797 | - 0 - Layer 3 (source and destination addresses plus flow label) |
| 1798 | - 1 - Layer 4 (standard 5-tuple) |
| 1799 | - 2 - Layer 3 or inner Layer 3 if present |
Ido Schimmel | 73c2c5c | 2021-05-17 21:15:23 +0300 | [diff] [blame] | 1800 | - 3 - Custom multipath hash. Fields used for multipath hash calculation |
| 1801 | are determined by fib_multipath_hash_fields sysctl |
David Ahern | b4bac17 | 2018-03-02 08:32:18 -0800 | [diff] [blame] | 1802 | |
Ido Schimmel | ed13923 | 2021-05-17 21:15:22 +0300 | [diff] [blame] | 1803 | fib_multipath_hash_fields - UNSIGNED INTEGER |
| 1804 | When fib_multipath_hash_policy is set to 3 (custom multipath hash), the |
| 1805 | fields used for multipath hash calculation are determined by this |
| 1806 | sysctl. |
| 1807 | |
| 1808 | This value is a bitmask which enables various fields for multipath hash |
| 1809 | calculation. |
| 1810 | |
| 1811 | Possible fields are: |
| 1812 | |
| 1813 | ====== ============================ |
| 1814 | 0x0001 Source IP address |
| 1815 | 0x0002 Destination IP address |
| 1816 | 0x0004 IP protocol |
| 1817 | 0x0008 Flow Label |
| 1818 | 0x0010 Source port |
| 1819 | 0x0020 Destination port |
| 1820 | 0x0040 Inner source IP address |
| 1821 | 0x0080 Inner destination IP address |
| 1822 | 0x0100 Inner IP protocol |
| 1823 | 0x0200 Inner Flow Label |
| 1824 | 0x0400 Inner source port |
| 1825 | 0x0800 Inner destination port |
| 1826 | ====== ============================ |
| 1827 | |
| 1828 | Default: 0x0007 (source IP, destination IP and IP protocol) |
| 1829 | |
FX Le Bail | 509aba3 | 2014-01-07 14:57:27 +0100 | [diff] [blame] | 1830 | anycast_src_echo_reply - BOOLEAN |
| 1831 | Controls the use of anycast addresses as source addresses for ICMPv6 |
| 1832 | echo reply |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1833 | |
| 1834 | - TRUE: enabled |
| 1835 | - FALSE: disabled |
| 1836 | |
FX Le Bail | 509aba3 | 2014-01-07 14:57:27 +0100 | [diff] [blame] | 1837 | Default: FALSE |
| 1838 | |
Hannes Frederic Sowa | 9f0761c | 2015-03-23 23:36:06 +0100 | [diff] [blame] | 1839 | idgen_delay - INTEGER |
| 1840 | Controls the delay in seconds after which time to retry |
| 1841 | privacy stable address generation if a DAD conflict is |
| 1842 | detected. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1843 | |
Hannes Frederic Sowa | 9f0761c | 2015-03-23 23:36:06 +0100 | [diff] [blame] | 1844 | Default: 1 (as specified in RFC7217) |
| 1845 | |
| 1846 | idgen_retries - INTEGER |
| 1847 | Controls the number of retries to generate a stable privacy |
| 1848 | address if a DAD conflict is detected. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1849 | |
Hannes Frederic Sowa | 9f0761c | 2015-03-23 23:36:06 +0100 | [diff] [blame] | 1850 | Default: 3 (as specified in RFC7217) |
| 1851 | |
Hannes Frederic Sowa | 2f71193 | 2014-09-02 15:49:25 +0200 | [diff] [blame] | 1852 | mld_qrv - INTEGER |
| 1853 | Controls the MLD query robustness variable (see RFC3810 9.1). |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1854 | |
Hannes Frederic Sowa | 2f71193 | 2014-09-02 15:49:25 +0200 | [diff] [blame] | 1855 | Default: 2 (as specified by RFC3810 9.1) |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1856 | |
Hannes Frederic Sowa | 2f71193 | 2014-09-02 15:49:25 +0200 | [diff] [blame] | 1857 | Minimum: 1 (as specified by RFC6636 4.5) |
| 1858 | |
Olivier Gayot | ab91345 | 2018-04-18 22:03:06 +0200 | [diff] [blame] | 1859 | max_dst_opts_number - INTEGER |
Tom Herbert | 47d3d7a | 2017-10-30 14:16:00 -0700 | [diff] [blame] | 1860 | Maximum number of non-padding TLVs allowed in a Destination |
| 1861 | options extension header. If this value is less than zero |
| 1862 | then unknown options are disallowed and the number of known |
| 1863 | TLVs allowed is the absolute value of this number. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1864 | |
Tom Herbert | 47d3d7a | 2017-10-30 14:16:00 -0700 | [diff] [blame] | 1865 | Default: 8 |
| 1866 | |
Olivier Gayot | ab91345 | 2018-04-18 22:03:06 +0200 | [diff] [blame] | 1867 | max_hbh_opts_number - INTEGER |
Tom Herbert | 47d3d7a | 2017-10-30 14:16:00 -0700 | [diff] [blame] | 1868 | Maximum number of non-padding TLVs allowed in a Hop-by-Hop |
| 1869 | options extension header. If this value is less than zero |
| 1870 | then unknown options are disallowed and the number of known |
| 1871 | TLVs allowed is the absolute value of this number. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1872 | |
Tom Herbert | 47d3d7a | 2017-10-30 14:16:00 -0700 | [diff] [blame] | 1873 | Default: 8 |
| 1874 | |
Olivier Gayot | ab91345 | 2018-04-18 22:03:06 +0200 | [diff] [blame] | 1875 | max_dst_opts_length - INTEGER |
Tom Herbert | 47d3d7a | 2017-10-30 14:16:00 -0700 | [diff] [blame] | 1876 | Maximum length allowed for a Destination options extension |
| 1877 | header. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1878 | |
Tom Herbert | 47d3d7a | 2017-10-30 14:16:00 -0700 | [diff] [blame] | 1879 | Default: INT_MAX (unlimited) |
| 1880 | |
Olivier Gayot | ab91345 | 2018-04-18 22:03:06 +0200 | [diff] [blame] | 1881 | max_hbh_length - INTEGER |
Tom Herbert | 47d3d7a | 2017-10-30 14:16:00 -0700 | [diff] [blame] | 1882 | Maximum length allowed for a Hop-by-Hop options extension |
| 1883 | header. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1884 | |
Tom Herbert | 47d3d7a | 2017-10-30 14:16:00 -0700 | [diff] [blame] | 1885 | Default: INT_MAX (unlimited) |
| 1886 | |
David Ahern | 7c6bb7d | 2018-10-11 20:17:21 -0700 | [diff] [blame] | 1887 | skip_notify_on_dev_down - BOOLEAN |
| 1888 | Controls whether an RTM_DELROUTE message is generated for routes |
| 1889 | removed when a device is taken down or deleted. IPv4 does not |
| 1890 | generate this message; IPv6 does by default. Setting this sysctl |
| 1891 | to true skips the message, making IPv4 and IPv6 on par in relying |
| 1892 | on userspace caches to track link events and evict routes. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1893 | |
David Ahern | 7c6bb7d | 2018-10-11 20:17:21 -0700 | [diff] [blame] | 1894 | Default: false (generate message) |
| 1895 | |
Roopa Prabhu | 4f80116 | 2020-04-27 13:56:46 -0700 | [diff] [blame] | 1896 | nexthop_compat_mode - BOOLEAN |
| 1897 | New nexthop API provides a means for managing nexthops independent of |
| 1898 | prefixes. Backwards compatibilty with old route format is enabled by |
| 1899 | default which means route dumps and notifications contain the new |
| 1900 | nexthop attribute but also the full, expanded nexthop definition. |
| 1901 | Further, updates or deletes of a nexthop configuration generate route |
| 1902 | notifications for each fib entry using the nexthop. Once a system |
| 1903 | understands the new API, this sysctl can be disabled to achieve full |
| 1904 | performance benefits of the new API by disabling the nexthop expansion |
| 1905 | and extraneous notifications. |
| 1906 | Default: true (backward compat mode) |
| 1907 | |
Amit Cohen | 907eea4 | 2021-02-01 21:47:55 +0200 | [diff] [blame] | 1908 | fib_notify_on_flag_change - INTEGER |
| 1909 | Whether to emit RTM_NEWROUTE notifications whenever RTM_F_OFFLOAD/ |
Amit Cohen | 6fad361 | 2021-02-07 10:22:53 +0200 | [diff] [blame] | 1910 | RTM_F_TRAP/RTM_F_OFFLOAD_FAILED flags are changed. |
Amit Cohen | 907eea4 | 2021-02-01 21:47:55 +0200 | [diff] [blame] | 1911 | |
| 1912 | After installing a route to the kernel, user space receives an |
| 1913 | acknowledgment, which means the route was installed in the kernel, |
| 1914 | but not necessarily in hardware. |
| 1915 | It is also possible for a route already installed in hardware to change |
| 1916 | its action and therefore its flags. For example, a host route that is |
| 1917 | trapping packets can be "promoted" to perform decapsulation following |
| 1918 | the installation of an IPinIP/VXLAN tunnel. |
| 1919 | The notifications will indicate to user-space the state of the route. |
| 1920 | |
| 1921 | Default: 0 (Do not emit notifications.) |
| 1922 | |
| 1923 | Possible values: |
| 1924 | |
| 1925 | - 0 - Do not emit notifications. |
| 1926 | - 1 - Emit notifications. |
Amit Cohen | 6fad361 | 2021-02-07 10:22:53 +0200 | [diff] [blame] | 1927 | - 2 - Emit notifications only for RTM_F_OFFLOAD_FAILED flag change. |
Amit Cohen | 907eea4 | 2021-02-01 21:47:55 +0200 | [diff] [blame] | 1928 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1929 | IPv6 Fragmentation: |
| 1930 | |
| 1931 | ip6frag_high_thresh - INTEGER |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1932 | Maximum memory used to reassemble IPv6 fragments. When |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1933 | ip6frag_high_thresh bytes of memory is allocated for this purpose, |
| 1934 | the fragment handler will toss packets until ip6frag_low_thresh |
| 1935 | is reached. |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1936 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1937 | ip6frag_low_thresh - INTEGER |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1938 | See ip6frag_high_thresh |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1939 | |
| 1940 | ip6frag_time - INTEGER |
| 1941 | Time in seconds to keep an IPv6 fragment in memory. |
| 1942 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1943 | ``conf/default/*``: |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1944 | Change the interface-specific default settings. |
| 1945 | |
Pali Rohár | fc024c5 | 2021-01-21 16:02:44 +0100 | [diff] [blame] | 1946 | These settings would be used during creating new interfaces. |
| 1947 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1948 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1949 | ``conf/all/*``: |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1950 | Change all the interface-specific settings. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1951 | |
| 1952 | [XXX: Other special features than forwarding?] |
| 1953 | |
Pali Rohár | fc024c5 | 2021-01-21 16:02:44 +0100 | [diff] [blame] | 1954 | conf/all/disable_ipv6 - BOOLEAN |
| 1955 | Changing this value is same as changing ``conf/default/disable_ipv6`` |
| 1956 | setting and also all per-interface ``disable_ipv6`` settings to the same |
| 1957 | value. |
| 1958 | |
| 1959 | Reading this value does not have any particular meaning. It does not say |
| 1960 | whether IPv6 support is enabled or disabled. Returned value can be 1 |
| 1961 | also in the case when some interface has ``disable_ipv6`` set to 0 and |
| 1962 | has configured IPv6 addresses. |
| 1963 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1964 | conf/all/forwarding - BOOLEAN |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1965 | Enable global IPv6 forwarding between all interfaces. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1966 | |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1967 | IPv4 and IPv6 work differently here; e.g. netfilter must be used |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1968 | to control which interfaces may forward packets and which not. |
| 1969 | |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1970 | This also sets all interfaces' Host/Router setting |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1971 | 'forwarding' to the specified value. See below for details. |
| 1972 | |
| 1973 | This referred to as global forwarding. |
| 1974 | |
YOSHIFUJI Hideaki | fbea49e | 2006-09-22 14:43:49 -0700 | [diff] [blame] | 1975 | proxy_ndp - BOOLEAN |
| 1976 | Do proxy ndp. |
| 1977 | |
Loganaden Velvindron | 219b5f2 | 2014-11-04 03:02:49 -0800 | [diff] [blame] | 1978 | fwmark_reflect - BOOLEAN |
| 1979 | Controls the fwmark of kernel-generated IPv6 reply packets that are not |
| 1980 | associated with a socket for example, TCP RSTs or ICMPv6 echo replies). |
| 1981 | If unset, these packets have a fwmark of zero. If set, they have the |
| 1982 | fwmark of the packet they are replying to. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1983 | |
Loganaden Velvindron | 219b5f2 | 2014-11-04 03:02:49 -0800 | [diff] [blame] | 1984 | Default: 0 |
| 1985 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 1986 | ``conf/interface/*``: |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1987 | Change special settings per interface. |
| 1988 | |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1989 | The functional behaviour for certain settings is different |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1990 | depending on whether local forwarding is enabled or not. |
| 1991 | |
Roy.Li | 605b91c | 2011-09-28 19:51:54 +0000 | [diff] [blame] | 1992 | accept_ra - INTEGER |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1993 | Accept Router Advertisements; autoconfigure using them. |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 1994 | |
Tore Anderson | 026359b | 2011-08-28 23:47:33 +0000 | [diff] [blame] | 1995 | It also determines whether or not to transmit Router |
| 1996 | Solicitations. If and only if the functional setting is to |
| 1997 | accept Router Advertisements, Router Solicitations will be |
| 1998 | transmitted. |
| 1999 | |
Thomas Graf | ae8abfa | 2010-09-03 05:47:30 +0000 | [diff] [blame] | 2000 | Possible values are: |
Thomas Graf | ae8abfa | 2010-09-03 05:47:30 +0000 | [diff] [blame] | 2001 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2002 | == =========================================================== |
| 2003 | 0 Do not accept Router Advertisements. |
| 2004 | 1 Accept Router Advertisements if forwarding is disabled. |
| 2005 | 2 Overrule forwarding behaviour. Accept Router Advertisements |
| 2006 | even if forwarding is enabled. |
| 2007 | == =========================================================== |
| 2008 | |
| 2009 | Functional default: |
| 2010 | |
| 2011 | - enabled if local forwarding is disabled. |
| 2012 | - disabled if local forwarding is enabled. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2013 | |
YOSHIFUJI Hideaki | 65f5c7c | 2006-03-20 16:55:08 -0800 | [diff] [blame] | 2014 | accept_ra_defrtr - BOOLEAN |
| 2015 | Learn default router in Router Advertisement. |
| 2016 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2017 | Functional default: |
| 2018 | |
| 2019 | - enabled if accept_ra is enabled. |
| 2020 | - disabled if accept_ra is disabled. |
YOSHIFUJI Hideaki | 65f5c7c | 2006-03-20 16:55:08 -0800 | [diff] [blame] | 2021 | |
Praveen Chaudhary | 6b2e04b | 2021-01-25 13:44:30 -0800 | [diff] [blame] | 2022 | ra_defrtr_metric - UNSIGNED INTEGER |
| 2023 | Route metric for default route learned in Router Advertisement. This value |
| 2024 | will be assigned as metric for the default route learned via IPv6 Router |
| 2025 | Advertisement. Takes affect only if accept_ra_defrtr is enabled. |
| 2026 | |
| 2027 | Possible values: |
| 2028 | 1 to 0xFFFFFFFF |
| 2029 | |
| 2030 | Default: IP6_RT_PRIO_USER i.e. 1024. |
| 2031 | |
Ben Greear | d933319 | 2014-06-25 14:44:53 -0700 | [diff] [blame] | 2032 | accept_ra_from_local - BOOLEAN |
| 2033 | Accept RA with source-address that is found on local machine |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2034 | if the RA is otherwise proper and able to be accepted. |
| 2035 | |
| 2036 | Default is to NOT accept these as it may be an un-intended |
| 2037 | network loop. |
Ben Greear | d933319 | 2014-06-25 14:44:53 -0700 | [diff] [blame] | 2038 | |
| 2039 | Functional default: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2040 | |
| 2041 | - enabled if accept_ra_from_local is enabled |
| 2042 | on a specific interface. |
| 2043 | - disabled if accept_ra_from_local is disabled |
| 2044 | on a specific interface. |
Ben Greear | d933319 | 2014-06-25 14:44:53 -0700 | [diff] [blame] | 2045 | |
Hangbin Liu | 8013d1d | 2015-07-30 14:28:42 +0800 | [diff] [blame] | 2046 | accept_ra_min_hop_limit - INTEGER |
| 2047 | Minimum hop limit Information in Router Advertisement. |
| 2048 | |
| 2049 | Hop limit Information in Router Advertisement less than this |
| 2050 | variable shall be ignored. |
| 2051 | |
| 2052 | Default: 1 |
| 2053 | |
YOSHIFUJI Hideaki | c4fd30e | 2006-03-20 16:55:26 -0800 | [diff] [blame] | 2054 | accept_ra_pinfo - BOOLEAN |
Matt LaPlante | 2fe0ae7 | 2006-10-03 22:50:39 +0200 | [diff] [blame] | 2055 | Learn Prefix Information in Router Advertisement. |
YOSHIFUJI Hideaki | c4fd30e | 2006-03-20 16:55:26 -0800 | [diff] [blame] | 2056 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2057 | Functional default: |
| 2058 | |
| 2059 | - enabled if accept_ra is enabled. |
| 2060 | - disabled if accept_ra is disabled. |
YOSHIFUJI Hideaki | c4fd30e | 2006-03-20 16:55:26 -0800 | [diff] [blame] | 2061 | |
Joel Scherpelz | bbea124 | 2017-03-22 18:19:04 +0900 | [diff] [blame] | 2062 | accept_ra_rt_info_min_plen - INTEGER |
| 2063 | Minimum prefix length of Route Information in RA. |
| 2064 | |
| 2065 | Route Information w/ prefix smaller than this variable shall |
| 2066 | be ignored. |
| 2067 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2068 | Functional default: |
| 2069 | |
| 2070 | * 0 if accept_ra_rtr_pref is enabled. |
| 2071 | * -1 if accept_ra_rtr_pref is disabled. |
Joel Scherpelz | bbea124 | 2017-03-22 18:19:04 +0900 | [diff] [blame] | 2072 | |
YOSHIFUJI Hideaki | 09c884d | 2006-03-20 17:07:03 -0800 | [diff] [blame] | 2073 | accept_ra_rt_info_max_plen - INTEGER |
| 2074 | Maximum prefix length of Route Information in RA. |
| 2075 | |
Joel Scherpelz | bbea124 | 2017-03-22 18:19:04 +0900 | [diff] [blame] | 2076 | Route Information w/ prefix larger than this variable shall |
| 2077 | be ignored. |
YOSHIFUJI Hideaki | 09c884d | 2006-03-20 17:07:03 -0800 | [diff] [blame] | 2078 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2079 | Functional default: |
| 2080 | |
| 2081 | * 0 if accept_ra_rtr_pref is enabled. |
| 2082 | * -1 if accept_ra_rtr_pref is disabled. |
YOSHIFUJI Hideaki | 09c884d | 2006-03-20 17:07:03 -0800 | [diff] [blame] | 2083 | |
YOSHIFUJI Hideaki | 930d6ff | 2006-03-20 17:05:30 -0800 | [diff] [blame] | 2084 | accept_ra_rtr_pref - BOOLEAN |
| 2085 | Accept Router Preference in RA. |
| 2086 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2087 | Functional default: |
| 2088 | |
| 2089 | - enabled if accept_ra is enabled. |
| 2090 | - disabled if accept_ra is disabled. |
YOSHIFUJI Hideaki | 930d6ff | 2006-03-20 17:05:30 -0800 | [diff] [blame] | 2091 | |
Harout Hedeshian | c2943f1 | 2015-01-20 10:06:05 -0700 | [diff] [blame] | 2092 | accept_ra_mtu - BOOLEAN |
| 2093 | Apply the MTU value specified in RA option 5 (RFC4861). If |
| 2094 | disabled, the MTU specified in the RA will be ignored. |
| 2095 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2096 | Functional default: |
| 2097 | |
| 2098 | - enabled if accept_ra is enabled. |
| 2099 | - disabled if accept_ra is disabled. |
Harout Hedeshian | c2943f1 | 2015-01-20 10:06:05 -0700 | [diff] [blame] | 2100 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2101 | accept_redirects - BOOLEAN |
| 2102 | Accept Redirects. |
| 2103 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2104 | Functional default: |
| 2105 | |
| 2106 | - enabled if local forwarding is disabled. |
| 2107 | - disabled if local forwarding is enabled. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2108 | |
YOSHIFUJI Hideaki | 0bcbc92 | 2007-04-24 14:58:30 -0700 | [diff] [blame] | 2109 | accept_source_route - INTEGER |
| 2110 | Accept source routing (routing extension header). |
| 2111 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2112 | - >= 0: Accept only routing header type 2. |
| 2113 | - < 0: Do not accept routing header. |
YOSHIFUJI Hideaki | 0bcbc92 | 2007-04-24 14:58:30 -0700 | [diff] [blame] | 2114 | |
| 2115 | Default: 0 |
| 2116 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2117 | autoconf - BOOLEAN |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 2118 | Autoconfigure addresses using Prefix Information in Router |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2119 | Advertisements. |
| 2120 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2121 | Functional default: |
| 2122 | |
| 2123 | - enabled if accept_ra_pinfo is enabled. |
| 2124 | - disabled if accept_ra_pinfo is disabled. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2125 | |
| 2126 | dad_transmits - INTEGER |
| 2127 | The amount of Duplicate Address Detection probes to send. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2128 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2129 | Default: 1 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2130 | |
Roy.Li | 605b91c | 2011-09-28 19:51:54 +0000 | [diff] [blame] | 2131 | forwarding - INTEGER |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 2132 | Configure interface-specific Host/Router behaviour. |
| 2133 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2134 | .. note:: |
| 2135 | |
| 2136 | It is recommended to have the same setting on all |
| 2137 | interfaces; mixed router/host scenarios are rather uncommon. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2138 | |
Thomas Graf | ae8abfa | 2010-09-03 05:47:30 +0000 | [diff] [blame] | 2139 | Possible values are: |
Thomas Graf | ae8abfa | 2010-09-03 05:47:30 +0000 | [diff] [blame] | 2140 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2141 | - 0 Forwarding disabled |
| 2142 | - 1 Forwarding enabled |
| 2143 | |
| 2144 | **FALSE (0)**: |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2145 | |
| 2146 | By default, Host behaviour is assumed. This means: |
| 2147 | |
| 2148 | 1. IsRouter flag is not set in Neighbour Advertisements. |
Tore Anderson | 026359b | 2011-08-28 23:47:33 +0000 | [diff] [blame] | 2149 | 2. If accept_ra is TRUE (default), transmit Router |
| 2150 | Solicitations. |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 2151 | 3. If accept_ra is TRUE (default), accept Router |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2152 | Advertisements (and do autoconfiguration). |
| 2153 | 4. If accept_redirects is TRUE (default), accept Redirects. |
| 2154 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2155 | **TRUE (1)**: |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2156 | |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 2157 | If local forwarding is enabled, Router behaviour is assumed. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2158 | This means exactly the reverse from the above: |
| 2159 | |
| 2160 | 1. IsRouter flag is set in Neighbour Advertisements. |
Tore Anderson | 026359b | 2011-08-28 23:47:33 +0000 | [diff] [blame] | 2161 | 2. Router Solicitations are not sent unless accept_ra is 2. |
Thomas Graf | ae8abfa | 2010-09-03 05:47:30 +0000 | [diff] [blame] | 2162 | 3. Router Advertisements are ignored unless accept_ra is 2. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2163 | 4. Redirects are ignored. |
| 2164 | |
Thomas Graf | ae8abfa | 2010-09-03 05:47:30 +0000 | [diff] [blame] | 2165 | Default: 0 (disabled) if global forwarding is disabled (default), |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2166 | otherwise 1 (enabled). |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2167 | |
| 2168 | hop_limit - INTEGER |
| 2169 | Default Hop Limit to set. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2170 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2171 | Default: 64 |
| 2172 | |
| 2173 | mtu - INTEGER |
| 2174 | Default Maximum Transfer Unit |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2175 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2176 | Default: 1280 (IPv6 required minimum) |
| 2177 | |
Tom Herbert | 35a256f | 2015-07-08 16:58:22 -0700 | [diff] [blame] | 2178 | ip_nonlocal_bind - BOOLEAN |
| 2179 | If set, allows processes to bind() to non-local IPv6 addresses, |
| 2180 | which can be quite useful - but may break some applications. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2181 | |
Tom Herbert | 35a256f | 2015-07-08 16:58:22 -0700 | [diff] [blame] | 2182 | Default: 0 |
| 2183 | |
YOSHIFUJI Hideaki | 52e16356 | 2006-03-20 17:05:47 -0800 | [diff] [blame] | 2184 | router_probe_interval - INTEGER |
| 2185 | Minimum interval (in seconds) between Router Probing described |
| 2186 | in RFC4191. |
| 2187 | |
| 2188 | Default: 60 |
| 2189 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2190 | router_solicitation_delay - INTEGER |
| 2191 | Number of seconds to wait after interface is brought up |
| 2192 | before sending Router Solicitations. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2193 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2194 | Default: 1 |
| 2195 | |
| 2196 | router_solicitation_interval - INTEGER |
| 2197 | Number of seconds to wait between Router Solicitations. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2198 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2199 | Default: 4 |
| 2200 | |
| 2201 | router_solicitations - INTEGER |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 2202 | Number of Router Solicitations to send until assuming no |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2203 | routers are present. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2204 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2205 | Default: 3 |
| 2206 | |
Erik Kline | 3985e8a | 2015-07-22 16:38:25 +0900 | [diff] [blame] | 2207 | use_oif_addrs_only - BOOLEAN |
| 2208 | When enabled, the candidate source addresses for destinations |
| 2209 | routed via this interface are restricted to the set of addresses |
| 2210 | configured on this interface (vis. RFC 6724, section 4). |
| 2211 | |
| 2212 | Default: false |
| 2213 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2214 | use_tempaddr - INTEGER |
| 2215 | Preference for Privacy Extensions (RFC3041). |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2216 | |
| 2217 | * <= 0 : disable Privacy Extensions |
| 2218 | * == 1 : enable Privacy Extensions, but prefer public |
| 2219 | addresses over temporary addresses. |
| 2220 | * > 1 : enable Privacy Extensions and prefer temporary |
| 2221 | addresses over public addresses. |
| 2222 | |
| 2223 | Default: |
| 2224 | |
| 2225 | * 0 (for most devices) |
| 2226 | * -1 (for point-to-point devices and loopback devices) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2227 | |
| 2228 | temp_valid_lft - INTEGER |
| 2229 | valid lifetime (in seconds) for temporary addresses. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2230 | |
Fernando Gont | 969c546 | 2020-05-01 00:51:47 -0300 | [diff] [blame] | 2231 | Default: 172800 (2 days) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2232 | |
| 2233 | temp_prefered_lft - INTEGER |
| 2234 | Preferred lifetime (in seconds) for temporary addresses. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2235 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2236 | Default: 86400 (1 day) |
| 2237 | |
David Ahern | f1705ec | 2016-02-24 09:25:37 -0800 | [diff] [blame] | 2238 | keep_addr_on_down - INTEGER |
| 2239 | Keep all IPv6 addresses on an interface down event. If set static |
| 2240 | global addresses with no expiration time are not flushed. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2241 | |
| 2242 | * >0 : enabled |
| 2243 | * 0 : system default |
| 2244 | * <0 : disabled |
David Ahern | f1705ec | 2016-02-24 09:25:37 -0800 | [diff] [blame] | 2245 | |
| 2246 | Default: 0 (addresses are removed) |
| 2247 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2248 | max_desync_factor - INTEGER |
| 2249 | Maximum value for DESYNC_FACTOR, which is a random value |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 2250 | that ensures that clients don't synchronize with each |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2251 | other and generate new addresses at exactly the same time. |
| 2252 | value is in seconds. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2253 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2254 | Default: 600 |
Jesper Dangaard Brouer | e18f5fe | 2009-02-23 04:39:04 +0000 | [diff] [blame] | 2255 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2256 | regen_max_retry - INTEGER |
| 2257 | Number of attempts before give up attempting to generate |
| 2258 | valid temporary addresses. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2259 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2260 | Default: 5 |
| 2261 | |
| 2262 | max_addresses - INTEGER |
Brian Haley | e79dc48 | 2010-02-22 12:27:21 +0000 | [diff] [blame] | 2263 | Maximum number of autoconfigured addresses per interface. Setting |
| 2264 | to zero disables the limitation. It is not recommended to set this |
| 2265 | value too large (or to zero) because it would be an easy way to |
| 2266 | crash the kernel by allowing too many addresses to be created. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2267 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2268 | Default: 16 |
| 2269 | |
YOSHIFUJI Hideaki | 778d80b | 2008-06-28 14:17:11 +0900 | [diff] [blame] | 2270 | disable_ipv6 - BOOLEAN |
Brian Haley | 9bdd8d4 | 2009-03-18 18:22:48 -0700 | [diff] [blame] | 2271 | Disable IPv6 operation. If accept_dad is set to 2, this value |
| 2272 | will be dynamically set to TRUE if DAD fails for the link-local |
| 2273 | address. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2274 | |
YOSHIFUJI Hideaki | 778d80b | 2008-06-28 14:17:11 +0900 | [diff] [blame] | 2275 | Default: FALSE (enable IPv6 operation) |
| 2276 | |
Brian Haley | 56d417b | 2009-06-01 03:07:33 -0700 | [diff] [blame] | 2277 | When this value is changed from 1 to 0 (IPv6 is being enabled), |
| 2278 | it will dynamically create a link-local address on the given |
| 2279 | interface and start Duplicate Address Detection, if necessary. |
| 2280 | |
| 2281 | When this value is changed from 0 to 1 (IPv6 is being disabled), |
Lorenzo Bianconi | 2f0aaf7 | 2018-03-29 11:02:25 +0200 | [diff] [blame] | 2282 | it will dynamically delete all addresses and routes on the given |
| 2283 | interface. From now on it will not possible to add addresses/routes |
| 2284 | to the selected interface. |
Brian Haley | 56d417b | 2009-06-01 03:07:33 -0700 | [diff] [blame] | 2285 | |
YOSHIFUJI Hideaki | 1b34be7 | 2008-06-28 14:18:38 +0900 | [diff] [blame] | 2286 | accept_dad - INTEGER |
| 2287 | Whether to accept DAD (Duplicate Address Detection). |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2288 | |
| 2289 | == ============================================================== |
| 2290 | 0 Disable DAD |
| 2291 | 1 Enable DAD (default) |
| 2292 | 2 Enable DAD, and disable IPv6 operation if MAC-based duplicate |
| 2293 | link-local address has been found. |
| 2294 | == ============================================================== |
YOSHIFUJI Hideaki | 1b34be7 | 2008-06-28 14:18:38 +0900 | [diff] [blame] | 2295 | |
Matteo Croce | 35e015e | 2017-09-12 17:46:37 +0200 | [diff] [blame] | 2296 | DAD operation and mode on a given interface will be selected according |
| 2297 | to the maximum value of conf/{all,interface}/accept_dad. |
| 2298 | |
Octavian Purdila | f7734fd | 2009-10-02 11:39:15 +0000 | [diff] [blame] | 2299 | force_tllao - BOOLEAN |
| 2300 | Enable sending the target link-layer address option even when |
| 2301 | responding to a unicast neighbor solicitation. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2302 | |
Octavian Purdila | f7734fd | 2009-10-02 11:39:15 +0000 | [diff] [blame] | 2303 | Default: FALSE |
| 2304 | |
| 2305 | Quoting from RFC 2461, section 4.4, Target link-layer address: |
| 2306 | |
| 2307 | "The option MUST be included for multicast solicitations in order to |
| 2308 | avoid infinite Neighbor Solicitation "recursion" when the peer node |
| 2309 | does not have a cache entry to return a Neighbor Advertisements |
| 2310 | message. When responding to unicast solicitations, the option can be |
| 2311 | omitted since the sender of the solicitation has the correct link- |
| 2312 | layer address; otherwise it would not have be able to send the unicast |
| 2313 | solicitation in the first place. However, including the link-layer |
| 2314 | address in this case adds little overhead and eliminates a potential |
| 2315 | race condition where the sender deletes the cached link-layer address |
| 2316 | prior to receiving a response to a previous solicitation." |
| 2317 | |
Hannes Frederic Sowa | db2b620 | 2013-01-01 00:35:31 +0000 | [diff] [blame] | 2318 | ndisc_notify - BOOLEAN |
| 2319 | Define mode for notification of address and device changes. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2320 | |
| 2321 | * 0 - (default): do nothing |
| 2322 | * 1 - Generate unsolicited neighbour advertisements when device is brought |
| 2323 | up or hardware address changes. |
Hannes Frederic Sowa | db2b620 | 2013-01-01 00:35:31 +0000 | [diff] [blame] | 2324 | |
Maciej Żenczykowski | 2210d6b | 2017-11-07 21:52:09 -0800 | [diff] [blame] | 2325 | ndisc_tclass - INTEGER |
| 2326 | The IPv6 Traffic Class to use by default when sending IPv6 Neighbor |
| 2327 | Discovery (Router Solicitation, Router Advertisement, Neighbor |
| 2328 | Solicitation, Neighbor Advertisement, Redirect) messages. |
| 2329 | These 8 bits can be interpreted as 6 high order bits holding the DSCP |
| 2330 | value and 2 low order bits representing ECN (which you probably want |
| 2331 | to leave cleared). |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2332 | |
| 2333 | * 0 - (default) |
Maciej Żenczykowski | 2210d6b | 2017-11-07 21:52:09 -0800 | [diff] [blame] | 2334 | |
Hannes Frederic Sowa | fc4eba5 | 2013-08-14 01:03:46 +0200 | [diff] [blame] | 2335 | mldv1_unsolicited_report_interval - INTEGER |
| 2336 | The interval in milliseconds in which the next unsolicited |
| 2337 | MLDv1 report retransmit will take place. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2338 | |
Hannes Frederic Sowa | fc4eba5 | 2013-08-14 01:03:46 +0200 | [diff] [blame] | 2339 | Default: 10000 (10 seconds) |
| 2340 | |
| 2341 | mldv2_unsolicited_report_interval - INTEGER |
| 2342 | The interval in milliseconds in which the next unsolicited |
| 2343 | MLDv2 report retransmit will take place. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2344 | |
Hannes Frederic Sowa | fc4eba5 | 2013-08-14 01:03:46 +0200 | [diff] [blame] | 2345 | Default: 1000 (1 second) |
| 2346 | |
Daniel Borkmann | f212781 | 2013-09-04 00:19:44 +0200 | [diff] [blame] | 2347 | force_mld_version - INTEGER |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2348 | * 0 - (default) No enforcement of a MLD version, MLDv1 fallback allowed |
| 2349 | * 1 - Enforce to use MLD version 1 |
| 2350 | * 2 - Enforce to use MLD version 2 |
Daniel Borkmann | f212781 | 2013-09-04 00:19:44 +0200 | [diff] [blame] | 2351 | |
Hannes Frederic Sowa | b800c3b | 2013-08-27 01:36:51 +0200 | [diff] [blame] | 2352 | suppress_frag_ndisc - INTEGER |
| 2353 | Control RFC 6980 (Security Implications of IPv6 Fragmentation |
| 2354 | with IPv6 Neighbor Discovery) behavior: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2355 | |
| 2356 | * 1 - (default) discard fragmented neighbor discovery packets |
| 2357 | * 0 - allow fragmented neighbor discovery packets |
Hannes Frederic Sowa | b800c3b | 2013-08-27 01:36:51 +0200 | [diff] [blame] | 2358 | |
Erik Kline | 7fd2561 | 2014-10-28 18:11:14 +0900 | [diff] [blame] | 2359 | optimistic_dad - BOOLEAN |
| 2360 | Whether to perform Optimistic Duplicate Address Detection (RFC 4429). |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2361 | |
| 2362 | * 0: disabled (default) |
| 2363 | * 1: enabled |
Matteo Croce | 35e015e | 2017-09-12 17:46:37 +0200 | [diff] [blame] | 2364 | |
| 2365 | Optimistic Duplicate Address Detection for the interface will be enabled |
| 2366 | if at least one of conf/{all,interface}/optimistic_dad is set to 1, |
| 2367 | it will be disabled otherwise. |
Erik Kline | 7fd2561 | 2014-10-28 18:11:14 +0900 | [diff] [blame] | 2368 | |
| 2369 | use_optimistic - BOOLEAN |
| 2370 | If enabled, do not classify optimistic addresses as deprecated during |
| 2371 | source address selection. Preferred addresses will still be chosen |
| 2372 | before optimistic addresses, subject to other ranking in the source |
| 2373 | address selection algorithm. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2374 | |
| 2375 | * 0: disabled (default) |
| 2376 | * 1: enabled |
Matteo Croce | 35e015e | 2017-09-12 17:46:37 +0200 | [diff] [blame] | 2377 | |
| 2378 | This will be enabled if at least one of |
| 2379 | conf/{all,interface}/use_optimistic is set to 1, disabled otherwise. |
Erik Kline | 7fd2561 | 2014-10-28 18:11:14 +0900 | [diff] [blame] | 2380 | |
Hannes Frederic Sowa | 9f0761c | 2015-03-23 23:36:06 +0100 | [diff] [blame] | 2381 | stable_secret - IPv6 address |
| 2382 | This IPv6 address will be used as a secret to generate IPv6 |
| 2383 | addresses for link-local addresses and autoconfigured |
| 2384 | ones. All addresses generated after setting this secret will |
| 2385 | be stable privacy ones by default. This can be changed via the |
| 2386 | addrgenmode ip-link. conf/default/stable_secret is used as the |
| 2387 | secret for the namespace, the interface specific ones can |
| 2388 | overwrite that. Writes to conf/all/stable_secret are refused. |
| 2389 | |
| 2390 | It is recommended to generate this secret during installation |
| 2391 | of a system and keep it stable after that. |
| 2392 | |
| 2393 | By default the stable secret is unset. |
| 2394 | |
Sabrina Dubroca | f168db5 | 2018-07-09 12:25:18 +0200 | [diff] [blame] | 2395 | addr_gen_mode - INTEGER |
| 2396 | Defines how link-local and autoconf addresses are generated. |
| 2397 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2398 | = ================================================================= |
| 2399 | 0 generate address based on EUI64 (default) |
| 2400 | 1 do no generate a link-local address, use EUI64 for addresses |
| 2401 | generated from autoconf |
| 2402 | 2 generate stable privacy addresses, using the secret from |
Sabrina Dubroca | f168db5 | 2018-07-09 12:25:18 +0200 | [diff] [blame] | 2403 | stable_secret (RFC7217) |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2404 | 3 generate stable privacy addresses, using a random secret if unset |
| 2405 | = ================================================================= |
Sabrina Dubroca | f168db5 | 2018-07-09 12:25:18 +0200 | [diff] [blame] | 2406 | |
Johannes Berg | abbc304 | 2016-02-04 13:31:19 +0100 | [diff] [blame] | 2407 | drop_unicast_in_l2_multicast - BOOLEAN |
| 2408 | Drop any unicast IPv6 packets that are received in link-layer |
| 2409 | multicast (or broadcast) frames. |
| 2410 | |
| 2411 | By default this is turned off. |
| 2412 | |
Johannes Berg | 7a02bf8 | 2016-02-04 13:31:20 +0100 | [diff] [blame] | 2413 | drop_unsolicited_na - BOOLEAN |
| 2414 | Drop all unsolicited neighbor advertisements, for example if there's |
| 2415 | a known good NA proxy on the network and such frames need not be used |
| 2416 | (or in the case of 802.11, must not be used to prevent attacks.) |
| 2417 | |
| 2418 | By default this is turned off. |
| 2419 | |
Erik Nordmark | adc176c | 2016-12-02 14:00:08 -0800 | [diff] [blame] | 2420 | enhanced_dad - BOOLEAN |
| 2421 | Include a nonce option in the IPv6 neighbor solicitation messages used for |
| 2422 | duplicate address detection per RFC7527. A received DAD NS will only signal |
| 2423 | a duplicate address if the nonce is different. This avoids any false |
| 2424 | detection of duplicates due to loopback of the NS messages that we send. |
| 2425 | The nonce option will be sent on an interface unless both of |
| 2426 | conf/{all,interface}/enhanced_dad are set to FALSE. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2427 | |
Erik Nordmark | adc176c | 2016-12-02 14:00:08 -0800 | [diff] [blame] | 2428 | Default: TRUE |
| 2429 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2430 | ``icmp/*``: |
| 2431 | =========== |
| 2432 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2433 | ratelimit - INTEGER |
Stephen Suryaputra | 0bc1998 | 2019-04-17 16:35:49 -0400 | [diff] [blame] | 2434 | Limit the maximal rates for sending ICMPv6 messages. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2435 | |
Stephen Hemminger | 6dbf4bc | 2008-07-01 19:29:07 -0700 | [diff] [blame] | 2436 | 0 to disable any limiting, |
| 2437 | otherwise the minimal space between responses in milliseconds. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2438 | |
Stephen Hemminger | 6dbf4bc | 2008-07-01 19:29:07 -0700 | [diff] [blame] | 2439 | Default: 1000 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2440 | |
Stephen Suryaputra | 0bc1998 | 2019-04-17 16:35:49 -0400 | [diff] [blame] | 2441 | ratemask - list of comma separated ranges |
| 2442 | For ICMPv6 message types matching the ranges in the ratemask, limit |
| 2443 | the sending of the message according to ratelimit parameter. |
| 2444 | |
| 2445 | The format used for both input and output is a comma separated |
| 2446 | list of ranges (e.g. "0-127,129" for ICMPv6 message type 0 to 127 and |
| 2447 | 129). Writing to the file will clear all previous ranges of ICMPv6 |
| 2448 | message types and update the current list with the input. |
| 2449 | |
| 2450 | Refer to: https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml |
| 2451 | for numerical values of ICMPv6 message types, e.g. echo request is 128 |
| 2452 | and echo reply is 129. |
| 2453 | |
| 2454 | Default: 0-1,3-127 (rate limit ICMPv6 errors except Packet Too Big) |
| 2455 | |
Virgile Jarry | e6f86b0 | 2018-08-10 17:48:15 +0200 | [diff] [blame] | 2456 | echo_ignore_all - BOOLEAN |
| 2457 | If set non-zero, then the kernel will ignore all ICMP ECHO |
| 2458 | requests sent to it over the IPv6 protocol. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2459 | |
Virgile Jarry | e6f86b0 | 2018-08-10 17:48:15 +0200 | [diff] [blame] | 2460 | Default: 0 |
| 2461 | |
Stephen Suryaputra | 03f1ecc | 2019-03-19 12:37:12 -0400 | [diff] [blame] | 2462 | echo_ignore_multicast - BOOLEAN |
| 2463 | If set non-zero, then the kernel will ignore all ICMP ECHO |
| 2464 | requests sent to it over the IPv6 protocol via multicast. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2465 | |
Stephen Suryaputra | 03f1ecc | 2019-03-19 12:37:12 -0400 | [diff] [blame] | 2466 | Default: 0 |
| 2467 | |
Stephen Suryaputra | 0b03a5c | 2019-03-20 10:29:27 -0400 | [diff] [blame] | 2468 | echo_ignore_anycast - BOOLEAN |
| 2469 | If set non-zero, then the kernel will ignore all ICMP ECHO |
| 2470 | requests sent to it over the IPv6 protocol destined to anycast address. |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2471 | |
Stephen Suryaputra | 0b03a5c | 2019-03-20 10:29:27 -0400 | [diff] [blame] | 2472 | Default: 0 |
| 2473 | |
Alexander Duyck | e69948a | 2015-08-11 13:35:01 -0700 | [diff] [blame] | 2474 | xfrm6_gc_thresh - INTEGER |
Nicolas Dichtel | 837f741 | 2019-04-09 17:16:59 +0200 | [diff] [blame] | 2475 | (Obsolete since linux-4.14) |
Alexander Duyck | e69948a | 2015-08-11 13:35:01 -0700 | [diff] [blame] | 2476 | The threshold at which we will start garbage collecting for IPv6 |
| 2477 | destination cache entries. At twice this value the system will |
Florian Westphal | 3c2a89d | 2017-07-17 13:57:20 +0200 | [diff] [blame] | 2478 | refuse new allocations. |
Alexander Duyck | e69948a | 2015-08-11 13:35:01 -0700 | [diff] [blame] | 2479 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2480 | |
| 2481 | IPv6 Update by: |
| 2482 | Pekka Savola <pekkas@netcore.fi> |
| 2483 | YOSHIFUJI Hideaki / USAGI Project <yoshfuji@linux-ipv6.org> |
| 2484 | |
| 2485 | |
| 2486 | /proc/sys/net/bridge/* Variables: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2487 | ================================= |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2488 | |
| 2489 | bridge-nf-call-arptables - BOOLEAN |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2490 | - 1 : pass bridged ARP traffic to arptables' FORWARD chain. |
| 2491 | - 0 : disable this. |
| 2492 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2493 | Default: 1 |
| 2494 | |
| 2495 | bridge-nf-call-iptables - BOOLEAN |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2496 | - 1 : pass bridged IPv4 traffic to iptables' chains. |
| 2497 | - 0 : disable this. |
| 2498 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2499 | Default: 1 |
| 2500 | |
| 2501 | bridge-nf-call-ip6tables - BOOLEAN |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2502 | - 1 : pass bridged IPv6 traffic to ip6tables' chains. |
| 2503 | - 0 : disable this. |
| 2504 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2505 | Default: 1 |
| 2506 | |
| 2507 | bridge-nf-filter-vlan-tagged - BOOLEAN |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2508 | - 1 : pass bridged vlan-tagged ARP/IP/IPv6 traffic to {arp,ip,ip6}tables. |
| 2509 | - 0 : disable this. |
| 2510 | |
Pablo Neira Ayuso | 4981682 | 2012-05-08 19:36:44 +0200 | [diff] [blame] | 2511 | Default: 0 |
Michael Milner | 516299d | 2007-04-12 22:14:23 -0700 | [diff] [blame] | 2512 | |
| 2513 | bridge-nf-filter-pppoe-tagged - BOOLEAN |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2514 | - 1 : pass bridged pppoe-tagged IP/IPv6 traffic to {ip,ip6}tables. |
| 2515 | - 0 : disable this. |
| 2516 | |
Pablo Neira Ayuso | 4981682 | 2012-05-08 19:36:44 +0200 | [diff] [blame] | 2517 | Default: 0 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2518 | |
Pablo Neira Ayuso | 4981682 | 2012-05-08 19:36:44 +0200 | [diff] [blame] | 2519 | bridge-nf-pass-vlan-input-dev - BOOLEAN |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2520 | - 1: if bridge-nf-filter-vlan-tagged is enabled, try to find a vlan |
| 2521 | interface on the bridge and set the netfilter input device to the |
| 2522 | vlan. This allows use of e.g. "iptables -i br0.1" and makes the |
| 2523 | REDIRECT target work with vlan-on-top-of-bridge interfaces. When no |
| 2524 | matching vlan interface is found, or this switch is off, the input |
| 2525 | device is set to the bridge interface. |
| 2526 | |
| 2527 | - 0: disable bridge netfilter vlan interface lookup. |
| 2528 | |
Pablo Neira Ayuso | 4981682 | 2012-05-08 19:36:44 +0200 | [diff] [blame] | 2529 | Default: 0 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2530 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2531 | ``proc/sys/net/sctp/*`` Variables: |
| 2532 | ================================== |
Vlad Yasevich | 32e8d49 | 2008-07-08 16:43:29 -0700 | [diff] [blame] | 2533 | |
| 2534 | addip_enable - BOOLEAN |
| 2535 | Enable or disable extension of Dynamic Address Reconfiguration |
| 2536 | (ADD-IP) functionality specified in RFC5061. This extension provides |
| 2537 | the ability to dynamically add and remove new addresses for the SCTP |
| 2538 | associations. |
| 2539 | |
| 2540 | 1: Enable extension. |
| 2541 | |
| 2542 | 0: Disable extension. |
| 2543 | |
| 2544 | Default: 0 |
| 2545 | |
Zhu Yanjun | 566178f | 2015-12-16 13:55:04 +0800 | [diff] [blame] | 2546 | pf_enable - INTEGER |
| 2547 | Enable or disable pf (pf is short for potentially failed) state. A value |
| 2548 | of pf_retrans > path_max_retrans also disables pf state. That is, one of |
| 2549 | both pf_enable and pf_retrans > path_max_retrans can disable pf state. |
| 2550 | Since pf_retrans and path_max_retrans can be changed by userspace |
| 2551 | application, sometimes user expects to disable pf state by the value of |
| 2552 | pf_retrans > path_max_retrans, but occasionally the value of pf_retrans |
| 2553 | or path_max_retrans is changed by the user application, this pf state is |
| 2554 | enabled. As such, it is necessary to add this to dynamically enable |
| 2555 | and disable pf state. See: |
| 2556 | https://datatracker.ietf.org/doc/draft-ietf-tsvwg-sctp-failover for |
| 2557 | details. |
| 2558 | |
| 2559 | 1: Enable pf. |
| 2560 | |
| 2561 | 0: Disable pf. |
| 2562 | |
| 2563 | Default: 1 |
| 2564 | |
Xin Long | aef587b | 2019-11-08 13:20:32 +0800 | [diff] [blame] | 2565 | pf_expose - INTEGER |
| 2566 | Unset or enable/disable pf (pf is short for potentially failed) state |
| 2567 | exposure. Applications can control the exposure of the PF path state |
| 2568 | in the SCTP_PEER_ADDR_CHANGE event and the SCTP_GET_PEER_ADDR_INFO |
| 2569 | sockopt. When it's unset, no SCTP_PEER_ADDR_CHANGE event with |
| 2570 | SCTP_ADDR_PF state will be sent and a SCTP_PF-state transport info |
| 2571 | can be got via SCTP_GET_PEER_ADDR_INFO sockopt; When it's enabled, |
| 2572 | a SCTP_PEER_ADDR_CHANGE event will be sent for a transport becoming |
| 2573 | SCTP_PF state and a SCTP_PF-state transport info can be got via |
| 2574 | SCTP_GET_PEER_ADDR_INFO sockopt; When it's diabled, no |
| 2575 | SCTP_PEER_ADDR_CHANGE event will be sent and it returns -EACCES when |
| 2576 | trying to get a SCTP_PF-state transport info via SCTP_GET_PEER_ADDR_INFO |
| 2577 | sockopt. |
| 2578 | |
| 2579 | 0: Unset pf state exposure, Compatible with old applications. |
| 2580 | |
| 2581 | 1: Disable pf state exposure. |
| 2582 | |
| 2583 | 2: Enable pf state exposure. |
| 2584 | |
| 2585 | Default: 0 |
| 2586 | |
Vlad Yasevich | 32e8d49 | 2008-07-08 16:43:29 -0700 | [diff] [blame] | 2587 | addip_noauth_enable - BOOLEAN |
| 2588 | Dynamic Address Reconfiguration (ADD-IP) requires the use of |
| 2589 | authentication to protect the operations of adding or removing new |
| 2590 | addresses. This requirement is mandated so that unauthorized hosts |
| 2591 | would not be able to hijack associations. However, older |
| 2592 | implementations may not have implemented this requirement while |
| 2593 | allowing the ADD-IP extension. For reasons of interoperability, |
| 2594 | we provide this variable to control the enforcement of the |
| 2595 | authentication requirement. |
| 2596 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2597 | == =============================================================== |
| 2598 | 1 Allow ADD-IP extension to be used without authentication. This |
Vlad Yasevich | 32e8d49 | 2008-07-08 16:43:29 -0700 | [diff] [blame] | 2599 | should only be set in a closed environment for interoperability |
| 2600 | with older implementations. |
| 2601 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2602 | 0 Enforce the authentication requirement |
| 2603 | == =============================================================== |
Vlad Yasevich | 32e8d49 | 2008-07-08 16:43:29 -0700 | [diff] [blame] | 2604 | |
| 2605 | Default: 0 |
| 2606 | |
| 2607 | auth_enable - BOOLEAN |
| 2608 | Enable or disable Authenticated Chunks extension. This extension |
| 2609 | provides the ability to send and receive authenticated chunks and is |
| 2610 | required for secure operation of Dynamic Address Reconfiguration |
| 2611 | (ADD-IP) extension. |
| 2612 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2613 | - 1: Enable this extension. |
| 2614 | - 0: Disable this extension. |
Vlad Yasevich | 32e8d49 | 2008-07-08 16:43:29 -0700 | [diff] [blame] | 2615 | |
| 2616 | Default: 0 |
| 2617 | |
| 2618 | prsctp_enable - BOOLEAN |
| 2619 | Enable or disable the Partial Reliability extension (RFC3758) which |
| 2620 | is used to notify peers that a given DATA should no longer be expected. |
| 2621 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2622 | - 1: Enable extension |
| 2623 | - 0: Disable |
Vlad Yasevich | 32e8d49 | 2008-07-08 16:43:29 -0700 | [diff] [blame] | 2624 | |
| 2625 | Default: 1 |
| 2626 | |
| 2627 | max_burst - INTEGER |
| 2628 | The limit of the number of new packets that can be initially sent. It |
| 2629 | controls how bursty the generated traffic can be. |
| 2630 | |
| 2631 | Default: 4 |
| 2632 | |
| 2633 | association_max_retrans - INTEGER |
| 2634 | Set the maximum number for retransmissions that an association can |
| 2635 | attempt deciding that the remote end is unreachable. If this value |
| 2636 | is exceeded, the association is terminated. |
| 2637 | |
| 2638 | Default: 10 |
| 2639 | |
| 2640 | max_init_retransmits - INTEGER |
| 2641 | The maximum number of retransmissions of INIT and COOKIE-ECHO chunks |
| 2642 | that an association will attempt before declaring the destination |
| 2643 | unreachable and terminating. |
| 2644 | |
| 2645 | Default: 8 |
| 2646 | |
| 2647 | path_max_retrans - INTEGER |
| 2648 | The maximum number of retransmissions that will be attempted on a given |
| 2649 | path. Once this threshold is exceeded, the path is considered |
| 2650 | unreachable, and new traffic will use a different path when the |
| 2651 | association is multihomed. |
| 2652 | |
| 2653 | Default: 5 |
| 2654 | |
Neil Horman | 5aa93bc | 2012-07-21 07:56:07 +0000 | [diff] [blame] | 2655 | pf_retrans - INTEGER |
| 2656 | The number of retransmissions that will be attempted on a given path |
| 2657 | before traffic is redirected to an alternate transport (should one |
| 2658 | exist). Note this is distinct from path_max_retrans, as a path that |
| 2659 | passes the pf_retrans threshold can still be used. Its only |
| 2660 | deprioritized when a transmission path is selected by the stack. This |
| 2661 | setting is primarily used to enable fast failover mechanisms without |
| 2662 | having to reduce path_max_retrans to a very low value. See: |
| 2663 | http://www.ietf.org/id/draft-nishida-tsvwg-sctp-failover-05.txt |
| 2664 | for details. Note also that a value of pf_retrans > path_max_retrans |
Zhu Yanjun | 566178f | 2015-12-16 13:55:04 +0800 | [diff] [blame] | 2665 | disables this feature. Since both pf_retrans and path_max_retrans can |
| 2666 | be changed by userspace application, a variable pf_enable is used to |
| 2667 | disable pf state. |
Neil Horman | 5aa93bc | 2012-07-21 07:56:07 +0000 | [diff] [blame] | 2668 | |
| 2669 | Default: 0 |
| 2670 | |
Xin Long | 34515e9 | 2019-11-08 13:20:35 +0800 | [diff] [blame] | 2671 | ps_retrans - INTEGER |
| 2672 | Primary.Switchover.Max.Retrans (PSMR), it's a tunable parameter coming |
| 2673 | from section-5 "Primary Path Switchover" in rfc7829. The primary path |
| 2674 | will be changed to another active path when the path error counter on |
| 2675 | the old primary path exceeds PSMR, so that "the SCTP sender is allowed |
| 2676 | to continue data transmission on a new working path even when the old |
| 2677 | primary destination address becomes active again". Note this feature |
| 2678 | is disabled by initializing 'ps_retrans' per netns as 0xffff by default, |
| 2679 | and its value can't be less than 'pf_retrans' when changing by sysctl. |
| 2680 | |
| 2681 | Default: 0xffff |
| 2682 | |
Vlad Yasevich | 32e8d49 | 2008-07-08 16:43:29 -0700 | [diff] [blame] | 2683 | rto_initial - INTEGER |
| 2684 | The initial round trip timeout value in milliseconds that will be used |
| 2685 | in calculating round trip times. This is the initial time interval |
| 2686 | for retransmissions. |
| 2687 | |
| 2688 | Default: 3000 |
| 2689 | |
| 2690 | rto_max - INTEGER |
| 2691 | The maximum value (in milliseconds) of the round trip timeout. This |
| 2692 | is the largest time interval that can elapse between retransmissions. |
| 2693 | |
| 2694 | Default: 60000 |
| 2695 | |
| 2696 | rto_min - INTEGER |
| 2697 | The minimum value (in milliseconds) of the round trip timeout. This |
| 2698 | is the smallest time interval the can elapse between retransmissions. |
| 2699 | |
| 2700 | Default: 1000 |
| 2701 | |
| 2702 | hb_interval - INTEGER |
| 2703 | The interval (in milliseconds) between HEARTBEAT chunks. These chunks |
| 2704 | are sent at the specified interval on idle paths to probe the state of |
| 2705 | a given path between 2 associations. |
| 2706 | |
| 2707 | Default: 30000 |
| 2708 | |
| 2709 | sack_timeout - INTEGER |
| 2710 | The amount of time (in milliseconds) that the implementation will wait |
| 2711 | to send a SACK. |
| 2712 | |
| 2713 | Default: 200 |
| 2714 | |
| 2715 | valid_cookie_life - INTEGER |
| 2716 | The default lifetime of the SCTP cookie (in milliseconds). The cookie |
| 2717 | is used during association establishment. |
| 2718 | |
| 2719 | Default: 60000 |
| 2720 | |
| 2721 | cookie_preserve_enable - BOOLEAN |
| 2722 | Enable or disable the ability to extend the lifetime of the SCTP cookie |
| 2723 | that is used during the establishment phase of SCTP association |
| 2724 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2725 | - 1: Enable cookie lifetime extension. |
| 2726 | - 0: Disable |
Vlad Yasevich | 32e8d49 | 2008-07-08 16:43:29 -0700 | [diff] [blame] | 2727 | |
| 2728 | Default: 1 |
| 2729 | |
Neil Horman | 3c68198 | 2012-10-24 09:20:03 +0000 | [diff] [blame] | 2730 | cookie_hmac_alg - STRING |
| 2731 | Select the hmac algorithm used when generating the cookie value sent by |
| 2732 | a listening sctp socket to a connecting client in the INIT-ACK chunk. |
| 2733 | Valid values are: |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2734 | |
Neil Horman | 3c68198 | 2012-10-24 09:20:03 +0000 | [diff] [blame] | 2735 | * md5 |
| 2736 | * sha1 |
| 2737 | * none |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2738 | |
Neil Horman | 3c68198 | 2012-10-24 09:20:03 +0000 | [diff] [blame] | 2739 | Ability to assign md5 or sha1 as the selected alg is predicated on the |
stephen hemminger | 3b09adc | 2013-01-03 07:50:29 +0000 | [diff] [blame] | 2740 | configuration of those algorithms at build time (CONFIG_CRYPTO_MD5 and |
Neil Horman | 3c68198 | 2012-10-24 09:20:03 +0000 | [diff] [blame] | 2741 | CONFIG_CRYPTO_SHA1). |
| 2742 | |
| 2743 | Default: Dependent on configuration. MD5 if available, else SHA1 if |
| 2744 | available, else none. |
| 2745 | |
Vlad Yasevich | 32e8d49 | 2008-07-08 16:43:29 -0700 | [diff] [blame] | 2746 | rcvbuf_policy - INTEGER |
| 2747 | Determines if the receive buffer is attributed to the socket or to |
| 2748 | association. SCTP supports the capability to create multiple |
| 2749 | associations on a single socket. When using this capability, it is |
| 2750 | possible that a single stalled association that's buffering a lot |
| 2751 | of data may block other associations from delivering their data by |
| 2752 | consuming all of the receive buffer space. To work around this, |
| 2753 | the rcvbuf_policy could be set to attribute the receiver buffer space |
| 2754 | to each association instead of the socket. This prevents the described |
| 2755 | blocking. |
| 2756 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2757 | - 1: rcvbuf space is per association |
| 2758 | - 0: rcvbuf space is per socket |
Vlad Yasevich | 32e8d49 | 2008-07-08 16:43:29 -0700 | [diff] [blame] | 2759 | |
| 2760 | Default: 0 |
| 2761 | |
| 2762 | sndbuf_policy - INTEGER |
| 2763 | Similar to rcvbuf_policy above, this applies to send buffer space. |
| 2764 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2765 | - 1: Send buffer is tracked per association |
| 2766 | - 0: Send buffer is tracked per socket. |
Vlad Yasevich | 32e8d49 | 2008-07-08 16:43:29 -0700 | [diff] [blame] | 2767 | |
| 2768 | Default: 0 |
| 2769 | |
| 2770 | sctp_mem - vector of 3 INTEGERs: min, pressure, max |
| 2771 | Number of pages allowed for queueing by all SCTP sockets. |
| 2772 | |
| 2773 | min: Below this number of pages SCTP is not bothered about its |
| 2774 | memory appetite. When amount of memory allocated by SCTP exceeds |
| 2775 | this number, SCTP starts to moderate memory usage. |
| 2776 | |
| 2777 | pressure: This value was introduced to follow format of tcp_mem. |
| 2778 | |
| 2779 | max: Number of pages allowed for queueing by all SCTP sockets. |
| 2780 | |
| 2781 | Default is calculated at boot time from amount of available memory. |
| 2782 | |
| 2783 | sctp_rmem - vector of 3 INTEGERs: min, default, max |
Max Matveev | a6e1204 | 2011-06-19 22:08:10 +0000 | [diff] [blame] | 2784 | Only the first value ("min") is used, "default" and "max" are |
| 2785 | ignored. |
| 2786 | |
| 2787 | min: Minimal size of receive buffer used by SCTP socket. |
| 2788 | It is guaranteed to each SCTP socket (but not association) even |
| 2789 | under moderate memory pressure. |
| 2790 | |
Tonghao Zhang | 320bd6d | 2018-03-13 21:57:17 -0700 | [diff] [blame] | 2791 | Default: 4K |
Vlad Yasevich | 32e8d49 | 2008-07-08 16:43:29 -0700 | [diff] [blame] | 2792 | |
| 2793 | sctp_wmem - vector of 3 INTEGERs: min, default, max |
Max Matveev | a6e1204 | 2011-06-19 22:08:10 +0000 | [diff] [blame] | 2794 | Currently this tunable has no effect. |
Vlad Yasevich | 32e8d49 | 2008-07-08 16:43:29 -0700 | [diff] [blame] | 2795 | |
Bhaskar Dutta | 7238843 | 2009-09-03 17:25:47 +0530 | [diff] [blame] | 2796 | addr_scope_policy - INTEGER |
| 2797 | Control IPv4 address scoping - draft-stewart-tsvwg-sctp-ipv4-00 |
| 2798 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2799 | - 0 - Disable IPv4 address scoping |
| 2800 | - 1 - Enable IPv4 address scoping |
| 2801 | - 2 - Follow draft but allow IPv4 private addresses |
| 2802 | - 3 - Follow draft but allow IPv4 link local addresses |
Bhaskar Dutta | 7238843 | 2009-09-03 17:25:47 +0530 | [diff] [blame] | 2803 | |
| 2804 | Default: 1 |
| 2805 | |
Xin Long | 046c052 | 2020-10-29 15:05:10 +0800 | [diff] [blame] | 2806 | udp_port - INTEGER |
| 2807 | The listening port for the local UDP tunneling sock. Normally it's |
| 2808 | using the IANA-assigned UDP port number 9899 (sctp-tunneling). |
| 2809 | |
| 2810 | This UDP sock is used for processing the incoming UDP-encapsulated |
| 2811 | SCTP packets (from RFC6951), and shared by all applications in the |
| 2812 | same net namespace. This UDP sock will be closed when the value is |
| 2813 | set to 0. |
| 2814 | |
| 2815 | The value will also be used to set the src port of the UDP header |
| 2816 | for the outgoing UDP-encapsulated SCTP packets. For the dest port, |
| 2817 | please refer to 'encap_port' below. |
| 2818 | |
| 2819 | Default: 0 |
| 2820 | |
Xin Long | e8a3001 | 2020-10-29 15:05:01 +0800 | [diff] [blame] | 2821 | encap_port - INTEGER |
| 2822 | The default remote UDP encapsulation port. |
| 2823 | |
| 2824 | This value is used to set the dest port of the UDP header for the |
| 2825 | outgoing UDP-encapsulated SCTP packets by default. Users can also |
| 2826 | change the value for each sock/asoc/transport by using setsockopt. |
| 2827 | For further information, please refer to RFC6951. |
| 2828 | |
| 2829 | Note that when connecting to a remote server, the client should set |
| 2830 | this to the port that the UDP tunneling sock on the peer server is |
| 2831 | listening to and the local UDP tunneling sock on the client also |
| 2832 | must be started. On the server, it would get the encap_port from |
| 2833 | the incoming packet's source port. |
| 2834 | |
| 2835 | Default: 0 |
| 2836 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2837 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2838 | ``/proc/sys/net/core/*`` |
| 2839 | ======================== |
| 2840 | |
Mauro Carvalho Chehab | 5704324 | 2019-04-22 16:48:00 -0300 | [diff] [blame] | 2841 | Please see: Documentation/admin-guide/sysctl/net.rst for descriptions of these entries. |
Wang Tinggong | 705efc3 | 2009-05-14 22:49:36 +0000 | [diff] [blame] | 2842 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2843 | |
Mauro Carvalho Chehab | 1cec2ca | 2020-04-28 00:01:49 +0200 | [diff] [blame] | 2844 | ``/proc/sys/net/unix/*`` |
| 2845 | ======================== |
| 2846 | |
Wang Tinggong | 705efc3 | 2009-05-14 22:49:36 +0000 | [diff] [blame] | 2847 | max_dgram_qlen - INTEGER |
| 2848 | The maximum length of dgram socket receive queue |
| 2849 | |
| 2850 | Default: 10 |
| 2851 | |