blob: b0e800e68366fa42109b03354aeac449461f9cdc [file] [log] [blame]
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001.. SPDX-License-Identifier: GPL-2.0
2
3=========
4IP Sysctl
5=========
6
7/proc/sys/net/ipv4/* Variables
8==============================
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
10ip_forward - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020011 - 0 - disabled (default)
12 - not 0 - enabled
Linus Torvalds1da177e2005-04-16 15:20:36 -070013
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
20ip_default_ttl - INTEGER
Eric Dumazetcc6f02d2010-12-13 12:50:49 -080021 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 Torvalds1da177e2005-04-16 15:20:36 -070024
Hannes Frederic Sowacd174e62013-12-14 05:13:45 +010025ip_no_pmtu_disc - INTEGER
26 Disable Path MTU Discovery. If enabled in mode 1 and a
Hannes Frederic Sowa188b04d2013-12-14 04:42:13 +010027 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 Sowacd174e62013-12-14 05:13:45 +010031
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 Gayotbb38ccc2018-06-04 12:07:37 +020036 Mode 3 is a hardened pmtu discover mode. The kernel will only
Hannes Frederic Sowa8ed1dc42014-01-09 10:01:17 +010037 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 Chehab1cec2ca2020-04-28 00:01:49 +020048
Hannes Frederic Sowa188b04d2013-12-14 04:42:13 +010049 Default: FALSE
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
51min_pmtu - INTEGER
Eric Dumazet20db93c2011-11-08 14:21:44 -050052 default 552 - minimum discovered Path MTU
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Hannes Frederic Sowaf87c10a2014-01-09 10:01:15 +010054ip_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 Chehab1cec2ca2020-04-28 00:01:49 +020062
Hannes Frederic Sowaf87c10a2014-01-09 10:01:15 +010063 Default: 0 (disabled)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020064
Hannes Frederic Sowaf87c10a2014-01-09 10:01:15 +010065 Possible values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020066
67 - 0 - disabled
68 - 1 - enabled
Hannes Frederic Sowaf87c10a2014-01-09 10:01:15 +010069
Loganaden Velvindron219b5f22014-11-04 03:02:49 -080070fwmark_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 Chehab1cec2ca2020-04-28 00:01:49 +020075
Loganaden Velvindron219b5f22014-11-04 03:02:49 -080076 Default: 0
77
David Aherna6db4492016-04-07 07:21:00 -070078fib_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 Chehab1cec2ca2020-04-28 00:01:49 +020083
David Aherna6db4492016-04-07 07:21:00 -070084 Default: 0 (disabled)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020085
David Aherna6db4492016-04-07 07:21:00 -070086 Possible values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020087
88 - 0 - disabled
89 - 1 - enabled
David Aherna6db4492016-04-07 07:21:00 -070090
Nikolay Aleksandrovbf4e0a32017-03-16 15:28:00 +020091fib_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 Chehab1cec2ca2020-04-28 00:01:49 +020094
Nikolay Aleksandrovbf4e0a32017-03-16 15:28:00 +020095 Default: 0 (Layer 3)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020096
Nikolay Aleksandrovbf4e0a32017-03-16 15:28:00 +020097 Possible values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020098
99 - 0 - Layer 3
100 - 1 - Layer 4
101 - 2 - Layer 3 or inner Layer 3 if present
Nikolay Aleksandrovbf4e0a32017-03-16 15:28:00 +0200102
David Ahern9ab948a2019-03-20 09:18:59 -0700103fib_sync_mem - UNSIGNED INTEGER
104 Amount of dirty memory from fib entries that can be backlogged before
105 synchronize_rcu is forced.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200106
107 Default: 512kB Minimum: 64kB Maximum: 64MB
David Ahern9ab948a2019-03-20 09:18:59 -0700108
Petr Machata432e05d2018-08-01 00:36:03 +0200109ip_forward_update_priority - INTEGER
110 Whether to update SKB priority from "TOS" field in IPv4 header after it
111 is forwarded. The new SKB priority is mapped from TOS field value
112 according to an rt_tos2priority table (see e.g. man tc-prio).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200113
Petr Machata432e05d2018-08-01 00:36:03 +0200114 Default: 1 (Update priority.)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200115
Petr Machata432e05d2018-08-01 00:36:03 +0200116 Possible values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200117
118 - 0 - Do not update priority.
119 - 1 - Update priority.
Petr Machata432e05d2018-08-01 00:36:03 +0200120
Ben Greearcbaf0872010-11-08 09:13:48 +0000121route/max_size - INTEGER
122 Maximum number of routes allowed in the kernel. Increase
123 this when using large numbers of interfaces and/or routes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200124
Ani Sinha25050c62015-01-07 15:45:56 -0800125 From linux kernel 3.6 onwards, this is deprecated for ipv4
126 as route cache is no longer used.
Ben Greearcbaf0872010-11-08 09:13:48 +0000127
YOSHIFUJI Hideaki / 吉藤英明27246802013-01-22 05:20:05 +0000128neigh/default/gc_thresh1 - INTEGER
129 Minimum number of entries to keep. Garbage collector will not
130 purge entries if there are fewer than this number.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200131
Li RongQingb66c66d2013-03-14 22:49:47 +0000132 Default: 128
YOSHIFUJI Hideaki / 吉藤英明27246802013-01-22 05:20:05 +0000133
stephen hemmingera3d12142014-08-25 15:05:30 -0700134neigh/default/gc_thresh2 - INTEGER
135 Threshold when garbage collector becomes more aggressive about
136 purging entries. Entries older than 5 seconds will be cleared
137 when over this number.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200138
stephen hemmingera3d12142014-08-25 15:05:30 -0700139 Default: 512
140
Ben Greearcbaf0872010-11-08 09:13:48 +0000141neigh/default/gc_thresh3 - INTEGER
David Ahern58956312018-12-07 12:24:57 -0800142 Maximum number of non-PERMANENT neighbor entries allowed. Increase
143 this when using large numbers of interfaces and when communicating
Ben Greearcbaf0872010-11-08 09:13:48 +0000144 with large numbers of directly-connected peers.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200145
Shan Weicc868022012-12-04 18:50:35 +0000146 Default: 1024
Ben Greearcbaf0872010-11-08 09:13:48 +0000147
Eric Dumazet8b5c1712011-11-09 12:07:14 +0000148neigh/default/unres_qlen_bytes - INTEGER
149 The maximum number of bytes which may be used by packets
150 queued for each unresolved address by other network layers.
151 (added in linux 3.3)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200152
stephen hemminger3b09adc2013-01-03 07:50:29 +0000153 Setting negative value is meaningless and will return error.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200154
Eric Dumazeteaa72dc2017-08-29 15:16:01 -0700155 Default: SK_WMEM_MAX, (same as net.core.wmem_default).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200156
Eric Dumazeteaa72dc2017-08-29 15:16:01 -0700157 Exact value depends on architecture and kernel options,
158 but should be enough to allow queuing 256 packets
159 of medium size.
Eric Dumazet8b5c1712011-11-09 12:07:14 +0000160
161neigh/default/unres_qlen - INTEGER
162 The maximum number of packets which may be queued for each
163 unresolved address by other network layers.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200164
Eric Dumazet8b5c1712011-11-09 12:07:14 +0000165 (deprecated in linux 3.3) : use unres_qlen_bytes instead.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200166
Shan Weicc868022012-12-04 18:50:35 +0000167 Prior to linux 3.3, the default value is 3 which may cause
Shan Wei5d248c42012-12-06 16:27:51 +0000168 unexpected packet loss. The current default value is calculated
Shan Weicc868022012-12-04 18:50:35 +0000169 according to default value of unres_qlen_bytes and true size of
170 packet.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200171
Eric Dumazeteaa72dc2017-08-29 15:16:01 -0700172 Default: 101
Eric Dumazet8b5c1712011-11-09 12:07:14 +0000173
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174mtu_expires - INTEGER
175 Time, in seconds, that cached PMTU information is kept.
176
177min_adv_mss - INTEGER
178 The advertised MSS depends on the first hop route MTU, but will
179 never be lower than this setting.
180
Amit Cohen680aea02021-02-01 21:47:52 +0200181fib_notify_on_flag_change - INTEGER
182 Whether to emit RTM_NEWROUTE notifications whenever RTM_F_OFFLOAD/
183 RTM_F_TRAP flags are changed.
184
185 After installing a route to the kernel, user space receives an
186 acknowledgment, which means the route was installed in the kernel,
187 but not necessarily in hardware.
188 It is also possible for a route already installed in hardware to change
189 its action and therefore its flags. For example, a host route that is
190 trapping packets can be "promoted" to perform decapsulation following
191 the installation of an IPinIP/VXLAN tunnel.
192 The notifications will indicate to user-space the state of the route.
193
194 Default: 0 (Do not emit notifications.)
195
196 Possible values:
197
198 - 0 - Do not emit notifications.
199 - 1 - Emit notifications.
200
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201IP Fragmentation:
202
Eric Dumazet3e67f102018-03-31 12:58:53 -0700203ipfrag_high_thresh - LONG INTEGER
Eric Dumazet648700f2018-03-31 12:58:49 -0700204 Maximum memory used to reassemble IP fragments.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000205
Eric Dumazet3e67f102018-03-31 12:58:53 -0700206ipfrag_low_thresh - LONG INTEGER
Eric Dumazet648700f2018-03-31 12:58:49 -0700207 (Obsolete since linux-4.17)
Florian Westphalb13d3cb2014-07-24 16:50:32 +0200208 Maximum memory used to reassemble IP fragments before the kernel
209 begins to remove incomplete fragment queues to free up resources.
210 The kernel still accepts new fragments for defragmentation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
212ipfrag_time - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000213 Time in seconds to keep an IP fragment in memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Herbert Xu89cee8b2005-12-13 23:14:27 -0800215ipfrag_max_dist - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000216 ipfrag_max_dist is a non-negative integer value which defines the
217 maximum "disorder" which is allowed among fragments which share a
218 common IP source address. Note that reordering of packets is
219 not unusual, but if a large number of fragments arrive from a source
220 IP address while a particular fragment queue remains incomplete, it
221 probably indicates that one or more fragments belonging to that queue
222 have been lost. When ipfrag_max_dist is positive, an additional check
223 is done on fragments before they are added to a reassembly queue - if
224 ipfrag_max_dist (or more) fragments have arrived from a particular IP
225 address between additions to any IP fragment queue using that source
226 address, it's presumed that one or more fragments in the queue are
227 lost. The existing fragment queue will be dropped, and a new one
Herbert Xu89cee8b2005-12-13 23:14:27 -0800228 started. An ipfrag_max_dist value of zero disables this check.
229
230 Using a very small value, e.g. 1 or 2, for ipfrag_max_dist can
231 result in unnecessarily dropping fragment queues when normal
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000232 reordering of packets occurs, which could lead to poor application
233 performance. Using a very large value, e.g. 50000, increases the
234 likelihood of incorrectly reassembling IP fragments that originate
Herbert Xu89cee8b2005-12-13 23:14:27 -0800235 from different IP datagrams, which could result in data corruption.
236 Default: 64
237
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200238INET peer storage
239=================
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
241inet_peer_threshold - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000242 The approximate size of the storage. Starting from this threshold
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 entries will be thrown aggressively. This threshold also determines
244 entries' time-to-live and time intervals between garbage collection
245 passes. More entries, less time-to-live, less GC interval.
246
247inet_peer_minttl - INTEGER
248 Minimum time-to-live of entries. Should be enough to cover fragment
249 time-to-live on the reassembling side. This minimum time-to-live is
250 guaranteed if the pool size is less than inet_peer_threshold.
Stephen Hemminger77a538d2008-07-01 17:22:48 -0700251 Measured in seconds.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
253inet_peer_maxttl - INTEGER
254 Maximum time-to-live of entries. Unused entries will expire after
255 this period of time if there is no memory pressure on the pool (i.e.
256 when the number of entries in the pool is very small).
Stephen Hemminger77a538d2008-07-01 17:22:48 -0700257 Measured in seconds.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200259TCP variables
260=============
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800262somaxconn - INTEGER
263 Limit of socket listen() backlog, known in userspace as SOMAXCONN.
Eric Dumazet19f92a02019-10-30 09:36:20 -0700264 Defaults to 4096. (Was 128 before linux-5.4)
265 See also tcp_max_syn_backlog for additional tuning for TCP sockets.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800266
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800267tcp_abort_on_overflow - BOOLEAN
268 If listening service is too slow to accept new connections,
269 reset them. Default state is FALSE. It means that if overflow
270 occurred due to a burst, connection will recover. Enable this
271 option _only_ if you are really sure that listening daemon
272 cannot be tuned to accept connections faster. Enabling this
273 option can harm clients of your server.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800275tcp_adv_win_scale - INTEGER
276 Count buffering overhead as bytes/2^tcp_adv_win_scale
277 (if tcp_adv_win_scale > 0) or bytes-bytes/2^(-tcp_adv_win_scale),
278 if it is <= 0.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200279
Alexey Dobriyan0147fc02010-11-22 12:54:21 +0000280 Possible values are [-31, 31], inclusive.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200281
Eric Dumazetb49960a2012-05-02 02:28:41 +0000282 Default: 1
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800283
284tcp_allowed_congestion_control - STRING
285 Show/set the congestion control choices available to non-privileged
286 processes. The list is a subset of those listed in
287 tcp_available_congestion_control.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200288
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800289 Default is "reno" and the default setting (tcp_congestion_control).
290
291tcp_app_win - INTEGER
292 Reserve max(window/2^tcp_app_win, mss) of window for application
293 buffer. Value 0 is special, it means that nothing is reserved.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200294
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800295 Default: 31
296
Eric Dumazetf54b3112013-12-05 22:36:05 -0800297tcp_autocorking - BOOLEAN
298 Enable TCP auto corking :
299 When applications do consecutive small write()/sendmsg() system calls,
300 we try to coalesce these small writes as much as possible, to lower
301 total amount of sent packets. This is done if at least one prior
302 packet for the flow is waiting in Qdisc queues or device transmit
303 queue. Applications can still use TCP_CORK for optimal behavior
304 when they know how/when to uncork their sockets.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200305
Eric Dumazetf54b3112013-12-05 22:36:05 -0800306 Default : 1
307
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800308tcp_available_congestion_control - STRING
309 Shows the available congestion control choices that are registered.
310 More congestion control algorithms may be available as modules,
311 but not loaded.
312
John Heffner71599cd2007-02-27 10:03:56 -0800313tcp_base_mss - INTEGER
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700314 The initial value of search_low to be used by the packetization layer
315 Path MTU discovery (MTU probing). If MTU probing is enabled,
316 this is the initial MSS used by the connection.
John Heffner71599cd2007-02-27 10:03:56 -0800317
Josh Huntc04b79b2019-08-07 19:52:29 -0400318tcp_mtu_probe_floor - INTEGER
319 If MTU probing is enabled this caps the minimum MSS used for search_low
320 for the connection.
321
322 Default : 48
323
Eric Dumazet5f3e2bf002019-06-06 09:15:31 -0700324tcp_min_snd_mss - INTEGER
325 TCP SYN and SYNACK messages usually advertise an ADVMSS option,
326 as described in RFC 1122 and RFC 6691.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200327
Eric Dumazet5f3e2bf002019-06-06 09:15:31 -0700328 If this ADVMSS option is smaller than tcp_min_snd_mss,
329 it is silently capped to tcp_min_snd_mss.
330
331 Default : 48 (at least 8 bytes of payload per segment)
332
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800333tcp_congestion_control - STRING
334 Set the congestion control algorithm to be used for new
335 connections. The algorithm "reno" is always available, but
336 additional choices may be available based on kernel configuration.
337 Default is set as part of kernel configuration.
Eric Dumazetd8a6e652011-11-30 01:02:41 +0000338 For passive connections, the listener congestion control choice
339 is inherited.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200340
Eric Dumazetd8a6e652011-11-30 01:02:41 +0000341 [see setsockopt(listenfd, SOL_TCP, TCP_CONGESTION, "name" ...) ]
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800342
343tcp_dsack - BOOLEAN
344 Allows TCP to send "duplicate" SACKs.
345
Yuchung Chengeed530b2012-05-02 13:30:03 +0000346tcp_early_retrans - INTEGER
Yuchung Chengbec41a12017-01-12 22:11:39 -0800347 Tail loss probe (TLP) converts RTOs occurring due to tail
348 losses into fast recovery (draft-ietf-tcpm-rack). Note that
349 TLP requires RACK to function properly (see tcp_recovery below)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200350
Yuchung Chengeed530b2012-05-02 13:30:03 +0000351 Possible values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200352
353 - 0 disables TLP
354 - 3 or 4 enables TLP
355
Nandita Dukkipati6ba8a3b2013-03-11 10:00:43 +0000356 Default: 3
Yuchung Chengeed530b2012-05-02 13:30:03 +0000357
Peter Chubb34a6ef32011-02-02 15:39:58 -0800358tcp_ecn - INTEGER
Rick Jones7e3a2dc2012-11-28 09:53:10 +0000359 Control use of Explicit Congestion Notification (ECN) by TCP.
360 ECN is used only when both ends of the TCP connection indicate
361 support for it. This feature is useful in avoiding losses due
362 to congestion by allowing supporting routers to signal
363 congestion before having to drop packets.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200364
Ilpo Järvinen255cac92009-05-04 11:07:36 -0700365 Possible values are:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200366
367 = =====================================================
368 0 Disable ECN. Neither initiate nor accept ECN.
369 1 Enable ECN when requested by incoming connections and
370 also request ECN on outgoing connection attempts.
371 2 Enable ECN when requested by incoming connections
372 but do not request ECN on outgoing connections.
373 = =====================================================
374
Ilpo Järvinen255cac92009-05-04 11:07:36 -0700375 Default: 2
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800376
Daniel Borkmann49213552015-05-19 21:04:22 +0200377tcp_ecn_fallback - BOOLEAN
378 If the kernel detects that ECN connection misbehaves, enable fall
379 back to non-ECN. Currently, this knob implements the fallback
380 from RFC3168, section 6.1.1.1., but we reserve that in future,
381 additional detection mechanisms could be implemented under this
382 knob. The value is not used, if tcp_ecn or per route (or congestion
383 control) ECN settings are disabled.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200384
Daniel Borkmann49213552015-05-19 21:04:22 +0200385 Default: 1 (fallback enabled)
386
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800387tcp_fack - BOOLEAN
Yuchung Cheng713bafe2017-11-08 13:01:26 -0800388 This is a legacy option, it has no effect anymore.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800389
390tcp_fin_timeout - INTEGER
Rick Jonesd825da22012-12-10 11:33:00 +0000391 The length of time an orphaned (no longer referenced by any
392 application) connection will remain in the FIN_WAIT_2 state
393 before it is aborted at the local end. While a perfectly
394 valid "receive only" state for an un-orphaned connection, an
395 orphaned connection in FIN_WAIT_2 state could otherwise wait
396 forever for the remote to close its end of the connection.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200397
Rick Jonesd825da22012-12-10 11:33:00 +0000398 Cf. tcp_max_orphans
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200399
Rick Jonesd825da22012-12-10 11:33:00 +0000400 Default: 60 seconds
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800401
Ilpo Järvinen89808062007-02-27 10:10:55 -0800402tcp_frto - INTEGER
Yuchung Chenge33099f2013-03-20 13:33:00 +0000403 Enables Forward RTO-Recovery (F-RTO) defined in RFC5682.
Ilpo Järvinencd998892007-09-20 11:35:26 -0700404 F-RTO is an enhanced recovery algorithm for TCP retransmission
Yuchung Chenge33099f2013-03-20 13:33:00 +0000405 timeouts. It is particularly beneficial in networks where the
406 RTT fluctuates (e.g., wireless). F-RTO is sender-side only
407 modification. It does not require any support from the peer.
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700408
Yuchung Chenge33099f2013-03-20 13:33:00 +0000409 By default it's enabled with a non-zero value. 0 disables F-RTO.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
Lorenzo Colittie2d00e62018-10-29 09:30:29 +0900411tcp_fwmark_accept - BOOLEAN
412 If set, incoming connections to listening sockets that do not have a
413 socket mark will set the mark of the accepting socket to the fwmark of
414 the incoming SYN packet. This will cause all packets on that connection
415 (starting from the first SYNACK) to be sent with that fwmark. The
416 listening socket's mark is unchanged. Listening sockets that already
417 have a fwmark set via setsockopt(SOL_SOCKET, SO_MARK, ...) are
418 unaffected.
419
420 Default: 0
421
Neal Cardwell032ee422015-02-06 16:04:38 -0500422tcp_invalid_ratelimit - INTEGER
423 Limit the maximal rate for sending duplicate acknowledgments
424 in response to incoming TCP packets that are for an existing
425 connection but that are invalid due to any of these reasons:
426
427 (a) out-of-window sequence number,
428 (b) out-of-window acknowledgment number, or
429 (c) PAWS (Protection Against Wrapped Sequence numbers) check failure
430
431 This can help mitigate simple "ack loop" DoS attacks, wherein
432 a buggy or malicious middlebox or man-in-the-middle can
433 rewrite TCP header fields in manner that causes each endpoint
434 to think that the other is sending invalid TCP segments, thus
435 causing each side to send an unterminating stream of duplicate
436 acknowledgments for invalid segments.
437
438 Using 0 disables rate-limiting of dupacks in response to
439 invalid segments; otherwise this value specifies the minimal
440 space between sending such dupacks, in milliseconds.
441
442 Default: 500 (milliseconds).
443
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444tcp_keepalive_time - INTEGER
445 How often TCP sends out keepalive messages when keepalive is enabled.
446 Default: 2hours.
447
448tcp_keepalive_probes - INTEGER
449 How many keepalive probes TCP sends out, until it decides that the
450 connection is broken. Default value: 9.
451
452tcp_keepalive_intvl - INTEGER
453 How frequently the probes are send out. Multiplied by
454 tcp_keepalive_probes it is time to kill not responding connection,
455 after probes started. Default value: 75sec i.e. connection
456 will be aborted after ~11 minutes of retries.
457
David Ahern6dd9a142015-12-16 13:20:44 -0800458tcp_l3mdev_accept - BOOLEAN
459 Enables child sockets to inherit the L3 master device index.
460 Enabling this option allows a "global" listen socket to work
461 across L3 master domains (e.g., VRFs) with connected sockets
462 derived from the listen socket to be bound to the L3 domain in
463 which the packets originated. Only valid when the kernel was
464 compiled with CONFIG_NET_L3_MASTER_DEV.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200465
466 Default: 0 (disabled)
David Ahern6dd9a142015-12-16 13:20:44 -0800467
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800468tcp_low_latency - BOOLEAN
Florian Westphalb6690b12017-07-30 03:57:20 +0200469 This is a legacy option, it has no effect anymore.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
471tcp_max_orphans - INTEGER
472 Maximal number of TCP sockets not attached to any user file handle,
473 held by system. If this number is exceeded orphaned connections are
474 reset immediately and warning is printed. This limit exists
475 only to prevent simple DoS attacks, you _must_ not rely on this
476 or lower the limit artificially, but rather increase it
477 (probably, after increasing installed memory),
478 if network conditions require more than default value,
479 and tune network services to linger and kill such states
480 more aggressively. Let me to remind again: each orphan eats
481 up to ~64K of unswappable memory.
482
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483tcp_max_syn_backlog - INTEGER
Eric Dumazet623d0c22019-10-30 10:05:46 -0700484 Maximal number of remembered connection requests (SYN_RECV),
485 which have not received an acknowledgment from connecting client.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200486
Eric Dumazet623d0c22019-10-30 10:05:46 -0700487 This is a per-listener limit.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200488
Peter Pan(潘卫平)99b53bd2011-12-05 21:39:41 +0000489 The minimal value is 128 for low memory machines, and it will
490 increase in proportion to the memory of machine.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200491
Peter Pan(潘卫平)99b53bd2011-12-05 21:39:41 +0000492 If server suffers from overload, try increasing this number.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200493
Eric Dumazet623d0c22019-10-30 10:05:46 -0700494 Remember to also check /proc/sys/net/core/somaxconn
495 A SYN_RECV request socket consumes about 304 bytes of memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800497tcp_max_tw_buckets - INTEGER
498 Maximal number of timewait sockets held by system simultaneously.
499 If this number is exceeded time-wait socket is immediately destroyed
500 and warning is printed. This limit exists only to prevent
501 simple DoS attacks, you _must_ not lower the limit artificially,
502 but rather increase it (probably, after increasing installed memory),
503 if network conditions require more than default value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800505tcp_mem - vector of 3 INTEGERs: min, pressure, max
506 min: below this number of pages TCP is not bothered about its
507 memory appetite.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800509 pressure: when amount of memory allocated by TCP exceeds this number
510 of pages, TCP moderates its memory consumption and enters memory
511 pressure mode, which is exited when memory consumption falls
512 under "min".
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800514 max: number of pages allowed for queueing by all TCP sockets.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800516 Defaults are calculated at boot time from amount of available
517 memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
Yuchung Chengf6722582015-10-16 21:57:42 -0700519tcp_min_rtt_wlen - INTEGER
520 The window length of the windowed min filter to track the minimum RTT.
521 A shorter window lets a flow more quickly pick up new (higher)
522 minimum RTT when it is moved to a longer path (e.g., due to traffic
523 engineering). A longer window makes the filter more resistant to RTT
524 inflations such as transient congestion. The unit is seconds.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200525
ZhangXiaoxu19fad202019-04-16 09:47:24 +0800526 Possible values: 0 - 86400 (1 day)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200527
Yuchung Chengf6722582015-10-16 21:57:42 -0700528 Default: 300
529
John Heffner71599cd2007-02-27 10:03:56 -0800530tcp_moderate_rcvbuf - BOOLEAN
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700531 If set, TCP performs receive buffer auto-tuning, attempting to
John Heffner71599cd2007-02-27 10:03:56 -0800532 automatically size the buffer (no greater than tcp_rmem[2]) to
533 match the size required by the path for full throughput. Enabled by
534 default.
535
536tcp_mtu_probing - INTEGER
537 Controls TCP Packetization-Layer Path MTU Discovery. Takes three
538 values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200539
540 - 0 - Disabled
541 - 1 - Disabled by default, enabled when an ICMP black hole detected
542 - 2 - Always enabled, use initial MSS of tcp_base_mss.
John Heffner71599cd2007-02-27 10:03:56 -0800543
Maciej Żenczykowskid4ce5802018-09-25 21:59:28 -0700544tcp_probe_interval - UNSIGNED INTEGER
Fan Dufab42762015-03-06 11:18:25 +0800545 Controls how often to start TCP Packetization-Layer Path MTU
546 Discovery reprobe. The default is reprobing every 10 minutes as
547 per RFC4821.
548
549tcp_probe_threshold - INTEGER
550 Controls when TCP Packetization-Layer Path MTU Discovery probing
551 will stop in respect to the width of search range in bytes. Default
552 is 8 bytes.
553
John Heffner71599cd2007-02-27 10:03:56 -0800554tcp_no_metrics_save - BOOLEAN
555 By default, TCP saves various connection metrics in the route cache
556 when the connection closes, so that connections established in the
557 near future can use these to set initial conditions. Usually, this
558 increases overall performance, but may sometimes cause performance
Simon Arlott0f035b82007-10-20 01:30:25 +0200559 degradation. If set, TCP will not cache metrics on closing
John Heffner71599cd2007-02-27 10:03:56 -0800560 connections.
561
Kevin(Yudong) Yang65e6d902019-12-09 14:19:59 -0500562tcp_no_ssthresh_metrics_save - BOOLEAN
563 Controls whether TCP saves ssthresh metrics in the route cache.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200564
Kevin(Yudong) Yang65e6d902019-12-09 14:19:59 -0500565 Default is 1, which disables ssthresh metrics.
566
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800567tcp_orphan_retries - INTEGER
Damian Lukowski5d789222009-09-01 10:24:04 +0000568 This value influences the timeout of a locally closed TCP connection,
569 when RTO retransmissions remain unacknowledged.
570 See tcp_retries2 for more details.
571
David S. Miller06b8fc52011-07-08 09:31:31 -0700572 The default value is 8.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200573
Damian Lukowski5d789222009-09-01 10:24:04 +0000574 If your machine is a loaded WEB server,
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800575 you should think about lowering this value, such sockets
576 may consume significant resources. Cf. tcp_max_orphans.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
Yuchung Cheng4f41b1c2015-10-16 21:57:47 -0700578tcp_recovery - INTEGER
579 This value is a bitmap to enable various experimental loss recovery
580 features.
581
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200582 ========= =============================================================
583 RACK: 0x1 enables the RACK loss detection for fast detection of lost
584 retransmissions and tail drops. It also subsumes and disables
585 RFC6675 recovery for SACK connections.
586
587 RACK: 0x2 makes RACK's reordering window static (min_rtt/4).
588
589 RACK: 0x4 disables RACK's DUPACK threshold heuristic
590 ========= =============================================================
Yuchung Cheng4f41b1c2015-10-16 21:57:47 -0700591
592 Default: 0x1
593
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594tcp_reordering - INTEGER
Eric Dumazetdca145f2014-10-27 21:45:24 -0700595 Initial reordering level of packets in a TCP stream.
596 TCP stack can then dynamically adjust flow reordering level
597 between this initial value and tcp_max_reordering
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200598
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000599 Default: 3
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
Eric Dumazetdca145f2014-10-27 21:45:24 -0700601tcp_max_reordering - INTEGER
602 Maximal reordering level of packets in a TCP stream.
603 300 is a fairly conservative value, but you might increase it
604 if paths are using per packet load balancing (like bonding rr mode)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200605
Eric Dumazetdca145f2014-10-27 21:45:24 -0700606 Default: 300
607
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608tcp_retrans_collapse - BOOLEAN
609 Bug-to-bug compatibility with some broken printers.
610 On retransmit try to send bigger packets to work around bugs in
611 certain TCP stacks.
612
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800613tcp_retries1 - INTEGER
Damian Lukowski5d789222009-09-01 10:24:04 +0000614 This value influences the time, after which TCP decides, that
615 something is wrong due to unacknowledged RTO retransmissions,
616 and reports this suspicion to the network layer.
617 See tcp_retries2 for more details.
618
619 RFC 1122 recommends at least 3 retransmissions, which is the
620 default.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800622tcp_retries2 - INTEGER
Damian Lukowski5d789222009-09-01 10:24:04 +0000623 This value influences the timeout of an alive TCP connection,
624 when RTO retransmissions remain unacknowledged.
625 Given a value of N, a hypothetical TCP connection following
626 exponential backoff with an initial RTO of TCP_RTO_MIN would
627 retransmit N times before killing the connection at the (N+1)th RTO.
628
629 The default value of 15 yields a hypothetical timeout of 924.6
630 seconds and is a lower bound for the effective timeout.
631 TCP will effectively time out at the first RTO which exceeds the
632 hypothetical timeout.
633
634 RFC 1122 recommends at least 100 seconds for the timeout,
635 which corresponds to a value of at least 8.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800637tcp_rfc1337 - BOOLEAN
638 If set, the TCP stack behaves conforming to RFC1337. If unset,
639 we are not conforming to RFC, but prevent TCP TIME_WAIT
640 assassination.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200641
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800642 Default: 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
644tcp_rmem - vector of 3 INTEGERs: min, default, max
645 min: Minimal size of receive buffer used by TCP sockets.
646 It is guaranteed to each TCP socket, even under moderate memory
647 pressure.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200648
Tonghao Zhanga61a86f2018-02-04 18:07:10 -0800649 Default: 4K
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
J. Bruce Fields53025f52008-07-10 16:47:41 -0700651 default: initial size of receive buffer used by TCP sockets.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 This value overrides net.core.rmem_default used by other protocols.
653 Default: 87380 bytes. This value results in window of 65535 with
654 default setting of tcp_adv_win_scale and tcp_app_win:0 and a bit
655 less for default tcp_app_win. See below about these variables.
656
657 max: maximal size of receive buffer allowed for automatically
658 selected receiver buffers for TCP socket. This value does not override
J. Bruce Fields53025f52008-07-10 16:47:41 -0700659 net.core.rmem_max. Calling setsockopt() with SO_RCVBUF disables
660 automatic tuning of that socket's receive buffer size, in which
661 case this value is ignored.
Eric Dumazetb49960a2012-05-02 02:28:41 +0000662 Default: between 87380B and 6MB, depending on RAM size.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800664tcp_sack - BOOLEAN
665 Enable select acknowledgments (SACKS).
Rick Jones15d99e02006-03-20 22:40:29 -0800666
Eric Dumazet6d82aa22018-05-17 14:47:28 -0700667tcp_comp_sack_delay_ns - LONG INTEGER
668 TCP tries to reduce number of SACK sent, using a timer
669 based on 5% of SRTT, capped by this sysctl, in nano seconds.
670 The default is 1ms, based on TSO autosizing period.
671
672 Default : 1,000,000 ns (1 ms)
673
Eric Dumazeta70437c2020-04-30 10:35:43 -0700674tcp_comp_sack_slack_ns - LONG INTEGER
675 This sysctl control the slack used when arming the
676 timer used by SACK compression. This gives extra time
677 for small RTT flows, and reduces system overhead by allowing
678 opportunistic reduction of timer interrupts.
679
680 Default : 100,000 ns (100 us)
681
Eric Dumazet9c21d2f2018-05-17 14:47:29 -0700682tcp_comp_sack_nr - INTEGER
Masanari Iida2bcd9d82019-05-21 12:41:15 +0900683 Max number of SACK that can be compressed.
Eric Dumazet9c21d2f2018-05-17 14:47:29 -0700684 Using 0 disables SACK compression.
685
Masanari Iida2bcd9d82019-05-21 12:41:15 +0900686 Default : 44
Eric Dumazet9c21d2f2018-05-17 14:47:29 -0700687
David S. Miller35089bb2006-06-13 22:33:04 -0700688tcp_slow_start_after_idle - BOOLEAN
689 If set, provide RFC2861 behavior and time out the congestion
690 window after an idle period. An idle period is defined at
691 the current RTO. If unset, the congestion window will not
692 be timed out after an idle period.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200693
David S. Miller35089bb2006-06-13 22:33:04 -0700694 Default: 1
695
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800696tcp_stdurg - BOOLEAN
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700697 Use the Host requirements interpretation of the TCP urgent pointer field.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800698 Most hosts use the older BSD interpretation, so if you turn this on
699 Linux might not communicate correctly with them.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200700
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800701 Default: FALSE
702
703tcp_synack_retries - INTEGER
704 Number of times SYNACKs for a passive TCP connection attempt will
705 be retransmitted. Should not be higher than 255. Default value
Alex Bergmann6c9ff972012-08-31 02:48:31 +0000706 is 5, which corresponds to 31seconds till the last retransmission
707 with the current initial RTO of 1second. With this the final timeout
708 for a passive TCP connection will happen after 63seconds.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800709
David S. Millerd8513df2020-01-02 16:07:38 -0800710tcp_syncookies - INTEGER
Shan Weia3c910d2013-06-21 15:18:32 +0800711 Only valid when the kernel was compiled with CONFIG_SYN_COOKIES
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800712 Send out syncookies when the syn backlog queue of a socket
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700713 overflows. This is to prevent against the common 'SYN flood attack'
Shan Weia3c910d2013-06-21 15:18:32 +0800714 Default: 1
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800715
716 Note, that syncookies is fallback facility.
717 It MUST NOT be used to help highly loaded servers to stand
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700718 against legal connection rate. If you see SYN flood warnings
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800719 in your logs, but investigation shows that they occur
720 because of overload with legal connections, you should tune
721 another parameters until this warning disappear.
722 See: tcp_max_syn_backlog, tcp_synack_retries, tcp_abort_on_overflow.
723
724 syncookies seriously violate TCP protocol, do not allow
725 to use TCP extensions, can result in serious degradation
726 of some services (f.e. SMTP relaying), visible not by you,
727 but your clients and relays, contacting you. While you see
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700728 SYN flood warnings in logs not being really flooded, your server
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800729 is seriously misconfigured.
730
Hannes Frederic Sowa5ad37d52013-07-26 17:43:23 +0200731 If you want to test which effects syncookies have to your
732 network connections you can set this knob to 2 to enable
733 unconditionally generation of syncookies.
734
Yuchung Chengcf60af02012-07-19 06:43:09 +0000735tcp_fastopen - INTEGER
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700736 Enable TCP Fast Open (RFC7413) to send and accept data in the opening
737 SYN packet.
738
739 The client support is enabled by flag 0x1 (on by default). The client
740 then must use sendmsg() or sendto() with the MSG_FASTOPEN flag,
741 rather than connect() to send data in SYN.
742
743 The server support is enabled by flag 0x2 (off by default). Then
744 either enable for all listeners with another flag (0x400) or
745 enable individual listeners via TCP_FASTOPEN socket option with
746 the option value being the length of the syn-data backlog.
Yuchung Chengcf60af02012-07-19 06:43:09 +0000747
Jerry Chu10467162012-08-31 12:29:11 +0000748 The values (bitmap) are
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200749
750 ===== ======== ======================================================
751 0x1 (client) enables sending data in the opening SYN on the client.
752 0x2 (server) enables the server support, i.e., allowing data in
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700753 a SYN packet to be accepted and passed to the
754 application before 3-way handshake finishes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200755 0x4 (client) send data in the opening SYN regardless of cookie
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700756 availability and without a cookie option.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200757 0x200 (server) accept data-in-SYN w/o any cookie option present.
758 0x400 (server) enable all listeners to support Fast Open by
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700759 default without explicit TCP_FASTOPEN socket option.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200760 ===== ======== ======================================================
Yuchung Chengcf60af02012-07-19 06:43:09 +0000761
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700762 Default: 0x1
Yuchung Chengcf60af02012-07-19 06:43:09 +0000763
Randy Dunlapa7db3c72020-07-03 15:41:13 -0700764 Note that additional client or server features are only
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700765 effective if the basic support (0x1 and 0x2) are enabled respectively.
Jerry Chu10467162012-08-31 12:29:11 +0000766
Wei Wangcf1ef3f2017-04-20 14:45:46 -0700767tcp_fastopen_blackhole_timeout_sec - INTEGER
768 Initial time period in second to disable Fastopen on active TCP sockets
769 when a TFO firewall blackhole issue happens.
770 This time period will grow exponentially when more blackhole issues
771 get detected right after Fastopen is re-enabled and will reset to
772 initial value when the blackhole issue goes away.
Yuchung Cheng72685862017-12-12 13:10:40 -0800773 0 to disable the blackhole detection.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200774
Wei Wangcf1ef3f2017-04-20 14:45:46 -0700775 By default, it is set to 1hr.
776
Jason Baron2dc7e482019-05-29 12:34:00 -0400777tcp_fastopen_key - list of comma separated 32-digit hexadecimal INTEGERs
778 The list consists of a primary key and an optional backup key. The
779 primary key is used for both creating and validating cookies, while the
780 optional backup key is only used for validating cookies. The purpose of
781 the backup key is to maximize TFO validation when keys are rotated.
782
783 A randomly chosen primary key may be configured by the kernel if
784 the tcp_fastopen sysctl is set to 0x400 (see above), or if the
785 TCP_FASTOPEN setsockopt() optname is set and a key has not been
786 previously configured via sysctl. If keys are configured via
787 setsockopt() by using the TCP_FASTOPEN_KEY optname, then those
788 per-socket keys will be used instead of any keys that are specified via
789 sysctl.
790
791 A key is specified as 4 8-digit hexadecimal integers which are separated
792 by a '-' as: xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx. Leading zeros may be
793 omitted. A primary and a backup key may be specified by separating them
794 by a comma. If only one key is specified, it becomes the primary key and
795 any previously configured backup keys are removed.
796
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800797tcp_syn_retries - INTEGER
798 Number of times initial SYNs for an active TCP connection attempt
Xin Longbffae692016-01-20 16:12:33 +0800799 will be retransmitted. Should not be higher than 127. Default value
stephen hemminger3b09adc2013-01-03 07:50:29 +0000800 is 6, which corresponds to 63seconds till the last retransmission
Alex Bergmann6c9ff972012-08-31 02:48:31 +0000801 with the current initial RTO of 1second. With this the final timeout
802 for an active TCP connection attempt will happen after 127seconds.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800803
Florian Westphal25429d72016-12-01 11:32:07 +0100804tcp_timestamps - INTEGER
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200805 Enable timestamps as defined in RFC1323.
806
807 - 0: Disabled.
808 - 1: Enable timestamps as defined in RFC1323 and use random offset for
809 each connection rather than only using the current time.
810 - 2: Like 1, but without random offsets.
811
Florian Westphal25429d72016-12-01 11:32:07 +0100812 Default: 1
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800813
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700814tcp_min_tso_segs - INTEGER
815 Minimal number of segments per TSO frame.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200816
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700817 Since linux-3.12, TCP does an automatic sizing of TSO frames,
818 depending on flow rate, instead of filling 64Kbytes packets.
819 For specific usages, it's possible to force TCP to build big
820 TSO frames. Note that TCP stack might split too big TSO packets
821 if available window is too small.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200822
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700823 Default: 2
824
Eric Dumazet43e122b2015-08-21 17:38:02 -0700825tcp_pacing_ss_ratio - INTEGER
826 sk->sk_pacing_rate is set by TCP stack using a ratio applied
827 to current rate. (current_rate = cwnd * mss / srtt)
828 If TCP is in slow start, tcp_pacing_ss_ratio is applied
829 to let TCP probe for bigger speeds, assuming cwnd can be
830 doubled every other RTT.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200831
Eric Dumazet43e122b2015-08-21 17:38:02 -0700832 Default: 200
833
834tcp_pacing_ca_ratio - INTEGER
835 sk->sk_pacing_rate is set by TCP stack using a ratio applied
836 to current rate. (current_rate = cwnd * mss / srtt)
837 If TCP is in congestion avoidance phase, tcp_pacing_ca_ratio
838 is applied to conservatively probe for bigger throughput.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200839
Eric Dumazet43e122b2015-08-21 17:38:02 -0700840 Default: 120
841
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800842tcp_tso_win_divisor - INTEGER
843 This allows control over what percentage of the congestion window
844 can be consumed by a single TSO frame.
845 The setting of this parameter is a choice between burstiness and
846 building larger TSO frames.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200847
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800848 Default: 3
849
Maciej Żenczykowski79e9fed2018-06-03 10:41:17 -0700850tcp_tw_reuse - INTEGER
851 Enable reuse of TIME-WAIT sockets for new connections when it is
852 safe from protocol viewpoint.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200853
854 - 0 - disable
855 - 1 - global enable
856 - 2 - enable for loopback traffic only
857
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800858 It should not be changed without advice/request of technical
859 experts.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200860
Maciej Żenczykowski79e9fed2018-06-03 10:41:17 -0700861 Default: 2
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800862
863tcp_window_scaling - BOOLEAN
864 Enable window scaling as defined in RFC1323.
865
866tcp_wmem - vector of 3 INTEGERs: min, default, max
J. Bruce Fields53025f52008-07-10 16:47:41 -0700867 min: Amount of memory reserved for send buffers for TCP sockets.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800868 Each TCP socket has rights to use it due to fact of its birth.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200869
Tonghao Zhanga61a86f2018-02-04 18:07:10 -0800870 Default: 4K
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800871
J. Bruce Fields53025f52008-07-10 16:47:41 -0700872 default: initial size of send buffer used by TCP sockets. This
873 value overrides net.core.wmem_default used by other protocols.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200874
J. Bruce Fields53025f52008-07-10 16:47:41 -0700875 It is usually lower than net.core.wmem_default.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200876
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800877 Default: 16K
878
J. Bruce Fields53025f52008-07-10 16:47:41 -0700879 max: Maximal amount of memory allowed for automatically tuned
880 send buffers for TCP sockets. This value does not override
881 net.core.wmem_max. Calling setsockopt() with SO_SNDBUF disables
882 automatic tuning of that socket's send buffer size, in which case
883 this value is ignored.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200884
J. Bruce Fields53025f52008-07-10 16:47:41 -0700885 Default: between 64K and 4MB, depending on RAM size.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800886
Eric Dumazetc9bee3b72013-07-22 20:27:07 -0700887tcp_notsent_lowat - UNSIGNED INTEGER
888 A TCP socket can control the amount of unsent bytes in its write queue,
889 thanks to TCP_NOTSENT_LOWAT socket option. poll()/select()/epoll()
890 reports POLLOUT events if the amount of unsent bytes is below a per
891 socket value, and if the write queue is not full. sendmsg() will
892 also not add new buffers if the limit is hit.
893
894 This global variable controls the amount of unsent data for
895 sockets not using TCP_NOTSENT_LOWAT. For these sockets, a change
896 to the global variable has immediate effect.
897
898 Default: UINT_MAX (0xFFFFFFFF)
899
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800900tcp_workaround_signed_windows - BOOLEAN
901 If set, assume no receipt of a window scaling option means the
902 remote TCP is broken and treats the window as a signed quantity.
903 If unset, assume the remote TCP is not broken even if we do
904 not receive a window scaling option from them.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200905
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800906 Default: 0
907
Andreas Petlund36e31b0a2010-02-18 02:47:01 +0000908tcp_thin_linear_timeouts - BOOLEAN
909 Enable dynamic triggering of linear timeouts for thin streams.
910 If set, a check is performed upon retransmission by timeout to
911 determine if the stream is thin (less than 4 packets in flight).
912 As long as the stream is found to be thin, up to 6 linear
913 timeouts may be performed before exponential backoff mode is
914 initiated. This improves retransmission latency for
915 non-aggressive thin streams, often found to be time-dependent.
916 For more information on thin streams, see
Mauro Carvalho Chehabff159f42020-04-30 18:04:29 +0200917 Documentation/networking/tcp-thin.rst
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200918
Andreas Petlund36e31b0a2010-02-18 02:47:01 +0000919 Default: 0
920
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000921tcp_limit_output_bytes - INTEGER
922 Controls TCP Small Queue limit per tcp socket.
923 TCP bulk sender tends to increase packets in flight until it
924 gets losses notifications. With SNDBUF autotuning, this can
Flavio Leitner9c4c3252018-06-27 10:34:26 -0300925 result in a large amount of packets queued on the local machine
926 (e.g.: qdiscs, CPU backlog, or device) hurting latency of other
927 flows, for typical pfifo_fast qdiscs. tcp_limit_output_bytes
928 limits the number of bytes on qdisc or device to reduce artificial
929 RTT/cwnd and reduce bufferbloat.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200930
Eric Dumazetc73e5802018-11-11 07:34:28 -0800931 Default: 1048576 (16 * 65536)
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000932
Eric Dumazet282f23c2012-07-17 10:13:05 +0200933tcp_challenge_ack_limit - INTEGER
934 Limits number of Challenge ACK sent per second, as recommended
935 in RFC 5961 (Improving TCP's Robustness to Blind In-Window Attacks)
Cambda Zhu53099602020-04-15 17:54:04 +0800936 Default: 1000
Eric Dumazet282f23c2012-07-17 10:13:05 +0200937
Eric Dumazetede61ca2019-06-14 16:22:19 -0700938tcp_rx_skb_cache - BOOLEAN
939 Controls a per TCP socket cache of one skb, that might help
940 performance of some workloads. This might be dangerous
941 on systems with a lot of TCP sockets, since it increases
942 memory usage.
943
944 Default: 0 (disabled)
945
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200946UDP variables
947=============
Hideo Aoki95766ff2007-12-31 00:29:24 -0800948
Robert Shearman63a6fff2017-01-26 18:02:24 +0000949udp_l3mdev_accept - BOOLEAN
950 Enabling this option allows a "global" bound socket to work
951 across L3 master domains (e.g., VRFs) with packets capable of
952 being received regardless of the L3 domain in which they
953 originated. Only valid when the kernel was compiled with
954 CONFIG_NET_L3_MASTER_DEV.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200955
956 Default: 0 (disabled)
Robert Shearman63a6fff2017-01-26 18:02:24 +0000957
Hideo Aoki95766ff2007-12-31 00:29:24 -0800958udp_mem - vector of 3 INTEGERs: min, pressure, max
959 Number of pages allowed for queueing by all UDP sockets.
960
961 min: Below this number of pages UDP is not bothered about its
962 memory appetite. When amount of memory allocated by UDP exceeds
963 this number, UDP starts to moderate memory usage.
964
965 pressure: This value was introduced to follow format of tcp_mem.
966
967 max: Number of pages allowed for queueing by all UDP sockets.
968
969 Default is calculated at boot time from amount of available memory.
970
971udp_rmem_min - INTEGER
972 Minimal size of receive buffer used by UDP sockets in moderation.
973 Each UDP socket is able to use the size for receiving data, even if
974 total pages of UDP sockets exceed udp_mem pressure. The unit is byte.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200975
Tonghao Zhang320bd6d2018-03-13 21:57:17 -0700976 Default: 4K
Hideo Aoki95766ff2007-12-31 00:29:24 -0800977
978udp_wmem_min - INTEGER
979 Minimal size of send buffer used by UDP sockets in moderation.
980 Each UDP socket is able to use the size for sending data, even if
981 total pages of UDP sockets exceed udp_mem pressure. The unit is byte.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200982
Tonghao Zhang320bd6d2018-03-13 21:57:17 -0700983 Default: 4K
Hideo Aoki95766ff2007-12-31 00:29:24 -0800984
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200985RAW variables
986=============
Mike Manning68974452018-11-07 15:36:05 +0000987
988raw_l3mdev_accept - BOOLEAN
989 Enabling this option allows a "global" bound socket to work
990 across L3 master domains (e.g., VRFs) with packets capable of
991 being received regardless of the L3 domain in which they
992 originated. Only valid when the kernel was compiled with
993 CONFIG_NET_L3_MASTER_DEV.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200994
Mike Manning68974452018-11-07 15:36:05 +0000995 Default: 1 (enabled)
996
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200997CIPSOv4 Variables
998=================
Paul Moore8802f612006-08-03 16:45:49 -0700999
1000cipso_cache_enable - BOOLEAN
1001 If set, enable additions to and lookups from the CIPSO label mapping
1002 cache. If unset, additions are ignored and lookups always result in a
1003 miss. However, regardless of the setting the cache is still
1004 invalidated when required when means you can safely toggle this on and
1005 off and the cache will always be "safe".
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001006
Paul Moore8802f612006-08-03 16:45:49 -07001007 Default: 1
1008
1009cipso_cache_bucket_size - INTEGER
1010 The CIPSO label cache consists of a fixed size hash table with each
1011 hash bucket containing a number of cache entries. This variable limits
1012 the number of entries in each hash bucket; the larger the value the
1013 more CIPSO label mappings that can be cached. When the number of
1014 entries in a given hash bucket reaches this limit adding new entries
1015 causes the oldest entry in the bucket to be removed to make room.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001016
Paul Moore8802f612006-08-03 16:45:49 -07001017 Default: 10
1018
1019cipso_rbm_optfmt - BOOLEAN
1020 Enable the "Optimized Tag 1 Format" as defined in section 3.4.2.6 of
1021 the CIPSO draft specification (see Documentation/netlabel for details).
1022 This means that when set the CIPSO tag will be padded with empty
1023 categories in order to make the packet data 32-bit aligned.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001024
Paul Moore8802f612006-08-03 16:45:49 -07001025 Default: 0
1026
1027cipso_rbm_structvalid - BOOLEAN
1028 If set, do a very strict check of the CIPSO option when
1029 ip_options_compile() is called. If unset, relax the checks done during
1030 ip_options_compile(). Either way is "safe" as errors are caught else
1031 where in the CIPSO processing code but setting this to 0 (False) should
1032 result in less work (i.e. it should be faster) but could cause problems
1033 with other implementations that require strict checking.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001034
Paul Moore8802f612006-08-03 16:45:49 -07001035 Default: 0
1036
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001037IP Variables
1038============
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039
1040ip_local_port_range - 2 INTEGERS
1041 Defines the local port range that is used by TCP and UDP to
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001042 choose the local port. The first number is the first, the
Eric Dumazet07f4c902015-05-24 14:49:35 -07001043 second the last local port number.
Maciej Żenczykowskiac716762019-11-25 14:48:00 -08001044 If possible, it is better these numbers have different parity
1045 (one even and one odd value).
1046 Must be greater than or equal to ip_unprivileged_port_start.
Eric Dumazet07f4c902015-05-24 14:49:35 -07001047 The default values are 32768 and 60999 respectively.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048
Amerigo Wange3826f12010-05-05 00:27:06 +00001049ip_local_reserved_ports - list of comma separated ranges
1050 Specify the ports which are reserved for known third-party
1051 applications. These ports will not be used by automatic port
1052 assignments (e.g. when calling connect() or bind() with port
1053 number 0). Explicit port allocation behavior is unchanged.
1054
1055 The format used for both input and output is a comma separated
1056 list of ranges (e.g. "1,2-4,10-10" for ports 1, 2, 3, 4 and
1057 10). Writing to the file will clear all previously reserved
1058 ports and update the current list with the one given in the
1059 input.
1060
1061 Note that ip_local_port_range and ip_local_reserved_ports
1062 settings are independent and both are considered by the kernel
1063 when determining which ports are available for automatic port
1064 assignments.
1065
1066 You can reserve ports which are not in the current
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001067 ip_local_port_range, e.g.::
Amerigo Wange3826f12010-05-05 00:27:06 +00001068
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001069 $ cat /proc/sys/net/ipv4/ip_local_port_range
1070 32000 60999
1071 $ cat /proc/sys/net/ipv4/ip_local_reserved_ports
1072 8080,9148
Amerigo Wange3826f12010-05-05 00:27:06 +00001073
1074 although this is redundant. However such a setting is useful
1075 if later the port range is changed to a value that will
1076 include the reserved ports.
1077
1078 Default: Empty
1079
Krister Johansen4548b682017-01-20 17:49:11 -08001080ip_unprivileged_port_start - INTEGER
1081 This is a per-namespace sysctl. It defines the first
1082 unprivileged port in the network namespace. Privileged ports
1083 require root or CAP_NET_BIND_SERVICE in order to bind to them.
Maciej Żenczykowskiac716762019-11-25 14:48:00 -08001084 To disable all privileged ports, set this to 0. They must not
1085 overlap with the ip_local_port_range.
Krister Johansen4548b682017-01-20 17:49:11 -08001086
1087 Default: 1024
1088
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089ip_nonlocal_bind - BOOLEAN
1090 If set, allows processes to bind() to non-local IP addresses,
1091 which can be quite useful - but may break some applications.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001092
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 Default: 0
1094
Kuniyuki Iwashima4b01a962020-03-10 17:05:25 +09001095ip_autobind_reuse - BOOLEAN
1096 By default, bind() does not select the ports automatically even if
1097 the new socket and all sockets bound to the port have SO_REUSEADDR.
1098 ip_autobind_reuse allows bind() to reuse the port and this is useful
1099 when you use bind()+connect(), but may break some applications.
1100 The preferred solution is to use IP_BIND_ADDRESS_NO_PORT and this
1101 option should only be set by experts.
1102 Default: 0
1103
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104ip_dynaddr - BOOLEAN
1105 If set non-zero, enables support for dynamic addresses.
1106 If set to a non-zero value larger than 1, a kernel log
1107 message will be printed when dynamic address rewriting
1108 occurs.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001109
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 Default: 0
1111
Cong Wange3d73bc2013-06-11 18:54:39 +08001112ip_early_demux - BOOLEAN
1113 Optimize input packet processing down to one demux for
1114 certain kinds of local sockets. Currently we only do this
subashab@codeaurora.orgdddb64b2017-03-23 13:34:16 -06001115 for established TCP and connected UDP sockets.
Cong Wange3d73bc2013-06-11 18:54:39 +08001116
1117 It may add an additional cost for pure routing workloads that
1118 reduces overall throughput, in such case you should disable it.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001119
Cong Wange3d73bc2013-06-11 18:54:39 +08001120 Default: 1
1121
Stephen Hemminger5cc4adb2020-04-21 13:34:48 -07001122ping_group_range - 2 INTEGERS
1123 Restrict ICMP_PROTO datagram sockets to users in the group range.
1124 The default is "1 0", meaning, that nobody (not even root) may
1125 create ping sockets. Setting it to "100 100" would grant permissions
1126 to the single group. "0 4294967295" would enable it for the world, "100
1127 4294967295" would enable it for the users, but not daemons.
1128
subashab@codeaurora.orgdddb64b2017-03-23 13:34:16 -06001129tcp_early_demux - BOOLEAN
1130 Enable early demux for established TCP sockets.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001131
subashab@codeaurora.orgdddb64b2017-03-23 13:34:16 -06001132 Default: 1
1133
1134udp_early_demux - BOOLEAN
1135 Enable early demux for connected UDP sockets. Disable this if
1136 your system could experience more unconnected load.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001137
subashab@codeaurora.orgdddb64b2017-03-23 13:34:16 -06001138 Default: 1
1139
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140icmp_echo_ignore_all - BOOLEAN
David S. Miller7ce312462005-10-03 16:07:30 -07001141 If set non-zero, then the kernel will ignore all ICMP ECHO
1142 requests sent to it.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001143
David S. Miller7ce312462005-10-03 16:07:30 -07001144 Default: 0
1145
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146icmp_echo_ignore_broadcasts - BOOLEAN
David S. Miller7ce312462005-10-03 16:07:30 -07001147 If set non-zero, then the kernel will ignore all ICMP ECHO and
1148 TIMESTAMP requests sent to it via broadcast/multicast.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001149
David S. Miller7ce312462005-10-03 16:07:30 -07001150 Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151
1152icmp_ratelimit - INTEGER
1153 Limit the maximal rates for sending ICMP packets whose type matches
1154 icmp_ratemask (see below) to specific targets.
Stephen Hemminger6dbf4bc2008-07-01 19:29:07 -07001155 0 to disable any limiting,
1156 otherwise the minimal space between responses in milliseconds.
Eric Dumazet4cdf5072014-09-19 07:38:40 -07001157 Note that another sysctl, icmp_msgs_per_sec limits the number
1158 of ICMP packets sent on all targets.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001159
Stephen Hemminger6dbf4bc2008-07-01 19:29:07 -07001160 Default: 1000
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161
Eric Dumazet4cdf5072014-09-19 07:38:40 -07001162icmp_msgs_per_sec - INTEGER
1163 Limit maximal number of ICMP packets sent per second from this host.
1164 Only messages whose type matches icmp_ratemask (see below) are
Eric Dumazetb38e7812020-10-15 11:42:00 -07001165 controlled by this limit. For security reasons, the precise count
1166 of messages per second is randomized.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001167
Eric Dumazet4cdf5072014-09-19 07:38:40 -07001168 Default: 1000
1169
1170icmp_msgs_burst - INTEGER
1171 icmp_msgs_per_sec controls number of ICMP packets sent per second,
1172 while icmp_msgs_burst controls the burst size of these packets.
Eric Dumazetb38e7812020-10-15 11:42:00 -07001173 For security reasons, the precise burst size is randomized.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001174
Eric Dumazet4cdf5072014-09-19 07:38:40 -07001175 Default: 50
1176
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177icmp_ratemask - INTEGER
1178 Mask made of ICMP types for which rates are being limited.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001179
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 Significant bits: IHGFEDCBA9876543210
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001181
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 Default mask: 0000001100000011000 (6168)
1183
1184 Bit definitions (see include/linux/icmp.h):
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001185
1186 = =========================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 0 Echo Reply
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001188 3 Destination Unreachable [1]_
1189 4 Source Quench [1]_
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190 5 Redirect
1191 8 Echo Request
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001192 B Time Exceeded [1]_
1193 C Parameter Problem [1]_
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 D Timestamp Request
1195 E Timestamp Reply
1196 F Info Request
1197 G Info Reply
1198 H Address Mask Request
1199 I Address Mask Reply
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001200 = =========================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001202 .. [1] These are rate limited by default (see default mask above)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203
1204icmp_ignore_bogus_error_responses - BOOLEAN
1205 Some routers violate RFC1122 by sending bogus responses to broadcast
1206 frames. Such violations are normally logged via a kernel warning.
1207 If this is set to TRUE, the kernel will not give such warnings, which
1208 will avoid log file clutter.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001209
Rami Rosene8b265e2013-06-07 20:16:19 +00001210 Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211
Horms95f7daf2006-02-02 17:02:25 -08001212icmp_errors_use_inbound_ifaddr - BOOLEAN
1213
Paolo Abeni02a6d612015-10-14 14:25:53 +02001214 If zero, icmp error messages are sent with the primary address of
1215 the exiting interface.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001216
Horms95f7daf2006-02-02 17:02:25 -08001217 If non-zero, the message will be sent with the primary address of
1218 the interface that received the packet that caused the icmp error.
Vincent Bernat31628202021-01-30 20:05:18 +01001219 This is the behaviour many network administrators will expect from
Horms95f7daf2006-02-02 17:02:25 -08001220 a router. And it can make debugging complicated network layouts
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001221 much easier.
Horms95f7daf2006-02-02 17:02:25 -08001222
1223 Note that if no primary address exists for the interface selected,
1224 then the primary address of the first non-loopback interface that
Matt LaPlanted6bc8ac2006-10-03 22:54:15 +02001225 has one will be used regardless of this setting.
Horms95f7daf2006-02-02 17:02:25 -08001226
1227 Default: 0
1228
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229igmp_max_memberships - INTEGER
1230 Change the maximum number of multicast groups we can subscribe to.
1231 Default: 20
1232
Jeremy Ederd67ef352010-11-15 05:41:31 +00001233 Theoretical maximum value is bounded by having to send a membership
1234 report in a single datagram (i.e. the report can't span multiple
1235 datagrams, or risk confusing the switch and leaving groups you don't
1236 intend to).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237
Jeremy Ederd67ef352010-11-15 05:41:31 +00001238 The number of supported groups 'M' is bounded by the number of group
1239 report entries you can fit into a single datagram of 65535 bytes.
1240
1241 M = 65536-sizeof (ip header)/(sizeof(Group record))
1242
1243 Group records are variable length, with a minimum of 12 bytes.
1244 So net.ipv4.igmp_max_memberships should not be set higher than:
1245
1246 (65536-24) / 12 = 5459
1247
1248 The value 5459 assumes no IP header options, so in practice
1249 this number may be lower.
1250
Benjamin Poirier537377d2016-03-21 13:21:40 -07001251igmp_max_msf - INTEGER
1252 Maximum number of addresses allowed in the source filter list for a
1253 multicast group.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001254
Benjamin Poirier537377d2016-03-21 13:21:40 -07001255 Default: 10
1256
Hannes Frederic Sowaa9fe8e22014-09-02 15:49:26 +02001257igmp_qrv - INTEGER
Benjamin Poirier537377d2016-03-21 13:21:40 -07001258 Controls the IGMP query robustness variable (see RFC2236 8.1).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001259
Benjamin Poirier537377d2016-03-21 13:21:40 -07001260 Default: 2 (as specified by RFC2236 8.1)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001261
Benjamin Poirier537377d2016-03-21 13:21:40 -07001262 Minimum: 1 (as specified by RFC6636 4.5)
Hannes Frederic Sowaa9fe8e22014-09-02 15:49:26 +02001263
Hangbin Liu1af92832016-11-07 14:51:23 +08001264force_igmp_version - INTEGER
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001265 - 0 - (default) No enforcement of a IGMP version, IGMPv1/v2 fallback
1266 allowed. Will back to IGMPv3 mode again if all IGMPv1/v2 Querier
1267 Present timer expires.
1268 - 1 - Enforce to use IGMP version 1. Will also reply IGMPv1 report if
1269 receive IGMPv2/v3 query.
1270 - 2 - Enforce to use IGMP version 2. Will fallback to IGMPv1 if receive
1271 IGMPv1 query message. Will reply report if receive IGMPv3 query.
1272 - 3 - Enforce to use IGMP version 3. The same react with default 0.
Hangbin Liu1af92832016-11-07 14:51:23 +08001273
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001274 .. note::
Hangbin Liu1af92832016-11-07 14:51:23 +08001275
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001276 this is not the same with force_mld_version because IGMPv3 RFC3376
1277 Security Considerations does not have clear description that we could
1278 ignore other version messages completely as MLDv2 RFC3810. So make
1279 this value as default 0 is recommended.
Benjamin Poirier6b226e22016-03-21 13:21:39 -07001280
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001281``conf/interface/*``
1282 changes special settings per interface (where
1283 interface" is the name of your network interface)
1284
1285``conf/all/*``
1286 is special, changes the settings for all interfaces
Benjamin Poirier6b226e22016-03-21 13:21:39 -07001287
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288log_martians - BOOLEAN
1289 Log packets with impossible addresses to kernel log.
1290 log_martians for the interface will be enabled if at least one of
1291 conf/{all,interface}/log_martians is set to TRUE,
1292 it will be disabled otherwise
1293
1294accept_redirects - BOOLEAN
1295 Accept ICMP redirect messages.
1296 accept_redirects for the interface will be enabled if:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001297
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001298 - both conf/{all,interface}/accept_redirects are TRUE in the case
1299 forwarding for the interface is enabled
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001300
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 or
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001302
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001303 - at least one of conf/{all,interface}/accept_redirects is TRUE in the
1304 case forwarding for the interface is disabled
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001305
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 accept_redirects for the interface will be disabled otherwise
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001307
1308 default:
1309
1310 - TRUE (host)
1311 - FALSE (router)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312
1313forwarding - BOOLEAN
Neil Jerram88a7cdd2017-03-10 12:24:57 +00001314 Enable IP forwarding on this interface. This controls whether packets
1315 received _on_ this interface can be forwarded.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316
1317mc_forwarding - BOOLEAN
1318 Do multicast routing. The kernel needs to be compiled with CONFIG_MROUTE
1319 and a multicast routing daemon is required.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001320 conf/all/mc_forwarding must also be set to TRUE to enable multicast
1321 routing for the interface
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322
1323medium_id - INTEGER
1324 Integer value used to differentiate the devices by the medium they
1325 are attached to. Two devices can have different id values when
1326 the broadcast packets are received only on one of them.
1327 The default value 0 means that the device is the only interface
1328 to its medium, value of -1 means that medium is not known.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001329
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 Currently, it is used to change the proxy_arp behavior:
1331 the proxy_arp feature is enabled for packets forwarded between
1332 two devices attached to different media.
1333
1334proxy_arp - BOOLEAN
1335 Do proxy arp.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001336
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 proxy_arp for the interface will be enabled if at least one of
1338 conf/{all,interface}/proxy_arp is set to TRUE,
1339 it will be disabled otherwise
1340
Jesper Dangaard Brouer65324142010-01-05 05:50:47 +00001341proxy_arp_pvlan - BOOLEAN
1342 Private VLAN proxy arp.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001343
Jesper Dangaard Brouer65324142010-01-05 05:50:47 +00001344 Basically allow proxy arp replies back to the same interface
1345 (from which the ARP request/solicitation was received).
1346
1347 This is done to support (ethernet) switch features, like RFC
1348 3069, where the individual ports are NOT allowed to
1349 communicate with each other, but they are allowed to talk to
1350 the upstream router. As described in RFC 3069, it is possible
1351 to allow these hosts to communicate through the upstream
1352 router by proxy_arp'ing. Don't need to be used together with
1353 proxy_arp.
1354
1355 This technology is known by different names:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001356
Jesper Dangaard Brouer65324142010-01-05 05:50:47 +00001357 In RFC 3069 it is called VLAN Aggregation.
1358 Cisco and Allied Telesyn call it Private VLAN.
1359 Hewlett-Packard call it Source-Port filtering or port-isolation.
1360 Ericsson call it MAC-Forced Forwarding (RFC Draft).
1361
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362shared_media - BOOLEAN
1363 Send(router) or accept(host) RFC1620 shared media redirects.
Eric Garver176b3462016-05-26 12:28:05 -04001364 Overrides secure_redirects.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001365
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 shared_media for the interface will be enabled if at least one of
1367 conf/{all,interface}/shared_media is set to TRUE,
1368 it will be disabled otherwise
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001369
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 default TRUE
1371
1372secure_redirects - BOOLEAN
Eric Garver176b3462016-05-26 12:28:05 -04001373 Accept ICMP redirect messages only to gateways listed in the
1374 interface's current gateway list. Even if disabled, RFC1122 redirect
1375 rules still apply.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001376
Eric Garver176b3462016-05-26 12:28:05 -04001377 Overridden by shared_media.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001378
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 secure_redirects for the interface will be enabled if at least one of
1380 conf/{all,interface}/secure_redirects is set to TRUE,
1381 it will be disabled otherwise
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001382
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 default TRUE
1384
1385send_redirects - BOOLEAN
1386 Send redirects, if router.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001387
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 send_redirects for the interface will be enabled if at least one of
1389 conf/{all,interface}/send_redirects is set to TRUE,
1390 it will be disabled otherwise
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001391
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392 Default: TRUE
1393
1394bootp_relay - BOOLEAN
1395 Accept packets with source address 0.b.c.d destined
1396 not to this host as local ones. It is supposed, that
1397 BOOTP relay daemon will catch and forward such packets.
1398 conf/all/bootp_relay must also be set to TRUE to enable BOOTP relay
1399 for the interface
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001400
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 default FALSE
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001402
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 Not Implemented Yet.
1404
1405accept_source_route - BOOLEAN
1406 Accept packets with SRR option.
1407 conf/all/accept_source_route must also be set to TRUE to accept packets
1408 with SRR option on the interface
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001409
1410 default
1411
1412 - TRUE (router)
1413 - FALSE (host)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414
Patrick McHardy8153a102009-12-03 01:25:58 +00001415accept_local - BOOLEAN
Sébastien Barré72b126a2014-09-10 18:20:23 +02001416 Accept packets with local source addresses. In combination with
1417 suitable routing, this can be used to direct packets between two
1418 local interfaces over the wire and have them accepted properly.
Patrick McHardy8153a102009-12-03 01:25:58 +00001419 default FALSE
1420
Thomas Grafd0daebc32012-06-12 00:44:01 +00001421route_localnet - BOOLEAN
1422 Do not consider loopback addresses as martian source or destination
1423 while routing. This enables the use of 127/8 for local routing purposes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001424
Thomas Grafd0daebc32012-06-12 00:44:01 +00001425 default FALSE
1426
Stephen Hemmingerc1cf8422009-02-20 08:25:36 +00001427rp_filter - INTEGER
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001428 - 0 - No source validation.
1429 - 1 - Strict mode as defined in RFC3704 Strict Reverse Path
1430 Each incoming packet is tested against the FIB and if the interface
1431 is not the best reverse path the packet check will fail.
1432 By default failed packets are discarded.
1433 - 2 - Loose mode as defined in RFC3704 Loose Reverse Path
1434 Each incoming packet's source address is also tested against the FIB
1435 and if the source address is not reachable via any interface
1436 the packet check will fail.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001438 Current recommended practice in RFC3704 is to enable strict mode
Jesper Dangaard Brouerbf869c32009-02-23 04:37:55 +00001439 to prevent IP spoofing from DDos attacks. If using asymmetric routing
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001440 or other complicated routing, then loose mode is recommended.
Stephen Hemmingerc1cf8422009-02-20 08:25:36 +00001441
Shan Wei1f5865e2009-12-02 15:39:04 -08001442 The max value from conf/{all,interface}/rp_filter is used
1443 when doing source validation on the {interface}.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444
1445 Default value is 0. Note that some distributions enable it
1446 in startup scripts.
1447
1448arp_filter - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001449 - 1 - Allows you to have multiple network interfaces on the same
1450 subnet, and have the ARPs for each interface be answered
1451 based on whether or not the kernel would route a packet from
1452 the ARP'd IP out that interface (therefore you must use source
1453 based routing for this to work). In other words it allows control
1454 of which cards (usually 1) will respond to an arp request.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001456 - 0 - (default) The kernel can respond to arp requests with addresses
1457 from other interfaces. This may seem wrong but it usually makes
1458 sense, because it increases the chance of successful communication.
1459 IP addresses are owned by the complete host on Linux, not by
1460 particular interfaces. Only for more complex setups like load-
1461 balancing, does this behaviour cause problems.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462
1463 arp_filter for the interface will be enabled if at least one of
1464 conf/{all,interface}/arp_filter is set to TRUE,
1465 it will be disabled otherwise
1466
1467arp_announce - INTEGER
1468 Define different restriction levels for announcing the local
1469 source IP address from IP packets in ARP requests sent on
1470 interface:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001471
1472 - 0 - (default) Use any local address, configured on any interface
1473 - 1 - Try to avoid local addresses that are not in the target's
1474 subnet for this interface. This mode is useful when target
1475 hosts reachable via this interface require the source IP
1476 address in ARP requests to be part of their logical network
1477 configured on the receiving interface. When we generate the
1478 request we will check all our subnets that include the
1479 target IP and will preserve the source address if it is from
1480 such subnet. If there is no such subnet we select source
1481 address according to the rules for level 2.
1482 - 2 - Always use the best local address for this target.
1483 In this mode we ignore the source address in the IP packet
1484 and try to select local address that we prefer for talks with
1485 the target host. Such local address is selected by looking
1486 for primary IP addresses on all our subnets on the outgoing
1487 interface that include the target IP address. If no suitable
1488 local address is found we select the first local address
1489 we have on the outgoing interface or on all other interfaces,
1490 with the hope we will receive reply for our request and
1491 even sometimes no matter the source IP address we announce.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492
1493 The max value from conf/{all,interface}/arp_announce is used.
1494
1495 Increasing the restriction level gives more chance for
1496 receiving answer from the resolved target while decreasing
1497 the level announces more valid sender's information.
1498
1499arp_ignore - INTEGER
1500 Define different modes for sending replies in response to
1501 received ARP requests that resolve local target IP addresses:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001502
1503 - 0 - (default): reply for any local target IP address, configured
1504 on any interface
1505 - 1 - reply only if the target IP address is local address
1506 configured on the incoming interface
1507 - 2 - reply only if the target IP address is local address
1508 configured on the incoming interface and both with the
1509 sender's IP address are part from same subnet on this interface
1510 - 3 - do not reply for local addresses configured with scope host,
1511 only resolutions for global and link addresses are replied
1512 - 4-7 - reserved
1513 - 8 - do not reply for all local addresses
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514
1515 The max value from conf/{all,interface}/arp_ignore is used
1516 when ARP request is received on the {interface}
1517
Stephen Hemmingereefef1c2009-02-01 01:04:33 -08001518arp_notify - BOOLEAN
1519 Define mode for notification of address and device changes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001520
1521 == ==========================================================
1522 0 (default): do nothing
1523 1 Generate gratuitous arp requests when device is brought up
1524 or hardware address changes.
1525 == ==========================================================
Stephen Hemmingereefef1c2009-02-01 01:04:33 -08001526
Neil Hormanc1b1bce2006-03-20 22:40:03 -08001527arp_accept - BOOLEAN
Octavian Purdila6d955182010-01-18 12:58:44 +00001528 Define behavior for gratuitous ARP frames who's IP is not
1529 already present in the ARP table:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001530
1531 - 0 - don't create new entries in the ARP table
1532 - 1 - create new entries in the ARP table
Octavian Purdila6d955182010-01-18 12:58:44 +00001533
1534 Both replies and requests type gratuitous arp will trigger the
1535 ARP table to be updated, if this setting is on.
1536
1537 If the ARP table already contains the IP address of the
1538 gratuitous arp frame, the arp table will be updated regardless
1539 if this setting is on or off.
1540
YOSHIFUJI Hideaki/吉藤英明89c69d32015-03-19 22:42:04 +09001541mcast_solicit - INTEGER
1542 The maximum number of multicast probes in INCOMPLETE state,
1543 when the associated hardware address is unknown. Defaults
1544 to 3.
1545
1546ucast_solicit - INTEGER
1547 The maximum number of unicast probes in PROBE state, when
1548 the hardware address is being reconfirmed. Defaults to 3.
Neil Hormanc1b1bce2006-03-20 22:40:03 -08001549
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550app_solicit - INTEGER
1551 The maximum number of probes to send to the user space ARP daemon
1552 via netlink before dropping back to multicast probes (see
YOSHIFUJI Hideaki/吉藤英明89c69d32015-03-19 22:42:04 +09001553 mcast_resolicit). Defaults to 0.
1554
1555mcast_resolicit - INTEGER
1556 The maximum number of multicast probes after unicast and
1557 app probes in PROBE state. Defaults to 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558
1559disable_policy - BOOLEAN
1560 Disable IPSEC policy (SPD) for this interface
1561
1562disable_xfrm - BOOLEAN
1563 Disable IPSEC encryption on this interface, whatever the policy
1564
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02001565igmpv2_unsolicited_report_interval - INTEGER
1566 The interval in milliseconds in which the next unsolicited
1567 IGMPv1 or IGMPv2 report retransmit will take place.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001568
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02001569 Default: 10000 (10 seconds)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02001571igmpv3_unsolicited_report_interval - INTEGER
1572 The interval in milliseconds in which the next unsolicited
1573 IGMPv3 report retransmit will take place.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001574
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02001575 Default: 1000 (1 seconds)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576
Vincent Bernatc0c5a602020-11-07 20:35:13 +01001577ignore_routes_with_linkdown - BOOLEAN
1578 Ignore routes whose link is down when performing a FIB lookup.
1579
Martin Schwenked922e1c2014-01-28 15:26:42 +11001580promote_secondaries - BOOLEAN
1581 When a primary IP address is removed from this interface
1582 promote a corresponding secondary IP address instead of
1583 removing all the corresponding secondary IP addresses.
1584
Johannes Berg12b74df2016-02-04 13:31:17 +01001585drop_unicast_in_l2_multicast - BOOLEAN
1586 Drop any unicast IP packets that are received in link-layer
1587 multicast (or broadcast) frames.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001588
Johannes Berg12b74df2016-02-04 13:31:17 +01001589 This behavior (for multicast) is actually a SHOULD in RFC
1590 1122, but is disabled by default for compatibility reasons.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001591
Johannes Berg12b74df2016-02-04 13:31:17 +01001592 Default: off (0)
1593
Johannes Berg97daf332016-02-04 13:31:18 +01001594drop_gratuitous_arp - BOOLEAN
1595 Drop all gratuitous ARP frames, for example if there's a known
1596 good ARP proxy on the network and such frames need not be used
1597 (or in the case of 802.11, must not be used to prevent attacks.)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001598
Johannes Berg97daf332016-02-04 13:31:18 +01001599 Default: off (0)
1600
Martin Schwenked922e1c2014-01-28 15:26:42 +11001601
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602tag - INTEGER
1603 Allows you to write a number, which can be used as required.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001604
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 Default value is 0.
1606
Alexander Duycke69948a2015-08-11 13:35:01 -07001607xfrm4_gc_thresh - INTEGER
Nicolas Dichtel837f7412019-04-09 17:16:59 +02001608 (Obsolete since linux-4.14)
Alexander Duycke69948a2015-08-11 13:35:01 -07001609 The threshold at which we will start garbage collecting for IPv4
1610 destination cache entries. At twice this value the system will
Florian Westphal3c2a89d2017-07-17 13:57:20 +02001611 refuse new allocations.
Alexander Duycke69948a2015-08-11 13:35:01 -07001612
Philip Downey87583eb2015-08-31 11:30:38 +01001613igmp_link_local_mcast_reports - BOOLEAN
1614 Enable IGMP reports for link local multicast groups in the
1615 224.0.0.X range.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001616
Philip Downey87583eb2015-08-31 11:30:38 +01001617 Default TRUE
1618
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619Alexey Kuznetsov.
1620kuznet@ms2.inr.ac.ru
1621
1622Updated by:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001623
1624- Andi Kleen
1625 ak@muc.de
1626- Nicolas Delon
1627 delon.nicolas@wanadoo.fr
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628
1629
1630
1631
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001632/proc/sys/net/ipv6/* Variables
1633==============================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634
1635IPv6 has no global variables such as tcp_*. tcp_* settings under ipv4/ also
1636apply to IPv6 [XXX?].
1637
1638bindv6only - BOOLEAN
1639 Default value for IPV6_V6ONLY socket option,
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001640 which restricts use of the IPv6 socket to IPv6 communication
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 only.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001642
1643 - TRUE: disable IPv4-mapped address feature
1644 - FALSE: enable IPv4-mapped address feature
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645
Geoffrey Thomasd5c073ca2011-08-22 11:28:57 -07001646 Default: FALSE (as specified in RFC3493)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647
Florent Fourcot6444f722014-01-17 17:15:05 +01001648flowlabel_consistency - BOOLEAN
1649 Protect the consistency (and unicity) of flow label.
1650 You have to disable it to use IPV6_FL_F_REFLECT flag on the
1651 flow label manager.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001652
1653 - TRUE: enabled
1654 - FALSE: disabled
1655
Florent Fourcot6444f722014-01-17 17:15:05 +01001656 Default: TRUE
1657
Tom Herbert42240902015-07-31 16:52:12 -07001658auto_flowlabels - INTEGER
1659 Automatically generate flow labels based on a flow hash of the
1660 packet. This allows intermediate devices, such as routers, to
1661 identify packet flows for mechanisms like Equal Cost Multipath
Tom Herbertcb1ce2e2014-07-01 21:33:10 -07001662 Routing (see RFC 6438).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001663
1664 = ===========================================================
1665 0 automatic flow labels are completely disabled
1666 1 automatic flow labels are enabled by default, they can be
Tom Herbert42240902015-07-31 16:52:12 -07001667 disabled on a per socket basis using the IPV6_AUTOFLOWLABEL
1668 socket option
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001669 2 automatic flow labels are allowed, they may be enabled on a
Tom Herbert42240902015-07-31 16:52:12 -07001670 per socket basis using the IPV6_AUTOFLOWLABEL socket option
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001671 3 automatic flow labels are enabled and enforced, they cannot
Tom Herbert42240902015-07-31 16:52:12 -07001672 be disabled by the socket option
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001673 = ===========================================================
1674
Tom Herbertb5677412015-07-31 16:52:14 -07001675 Default: 1
Tom Herbertcb1ce2e2014-07-01 21:33:10 -07001676
Tom Herbert82a584b2015-04-29 15:33:21 -07001677flowlabel_state_ranges - BOOLEAN
1678 Split the flow label number space into two ranges. 0-0x7FFFF is
1679 reserved for the IPv6 flow manager facility, 0x80000-0xFFFFF
1680 is reserved for stateless flow labels as described in RFC6437.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001681
1682 - TRUE: enabled
1683 - FALSE: disabled
1684
Tom Herbert82a584b2015-04-29 15:33:21 -07001685 Default: true
1686
Eric Dumazet323a53c2019-06-05 07:55:09 -07001687flowlabel_reflect - INTEGER
1688 Control flow label reflection. Needed for Path MTU
Jakub Sitnicki22b67222017-08-23 09:55:41 +02001689 Discovery to work with Equal Cost Multipath Routing in anycast
1690 environments. See RFC 7690 and:
1691 https://tools.ietf.org/html/draft-wang-6man-flow-label-reflection-01
Eric Dumazet323a53c2019-06-05 07:55:09 -07001692
Eric Dumazeta346abe2019-07-01 06:39:36 -07001693 This is a bitmask.
Eric Dumazet323a53c2019-06-05 07:55:09 -07001694
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001695 - 1: enabled for established flows
Eric Dumazet323a53c2019-06-05 07:55:09 -07001696
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001697 Note that this prevents automatic flowlabel changes, as done
1698 in "tcp: change IPv6 flow-label upon receiving spurious retransmission"
1699 and "tcp: Change txhash on every SYN and RTO retransmit"
Eric Dumazet323a53c2019-06-05 07:55:09 -07001700
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001701 - 2: enabled for TCP RESET packets (no active listener)
1702 If set, a RST packet sent in response to a SYN packet on a closed
1703 port will reflect the incoming flow label.
1704
1705 - 4: enabled for ICMPv6 echo reply messages.
Eric Dumazeta346abe2019-07-01 06:39:36 -07001706
Eric Dumazet323a53c2019-06-05 07:55:09 -07001707 Default: 0
Jakub Sitnicki22b67222017-08-23 09:55:41 +02001708
David Ahernb4bac172018-03-02 08:32:18 -08001709fib_multipath_hash_policy - INTEGER
1710 Controls which hash policy to use for multipath routes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001711
David Ahernb4bac172018-03-02 08:32:18 -08001712 Default: 0 (Layer 3)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001713
David Ahernb4bac172018-03-02 08:32:18 -08001714 Possible values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001715
1716 - 0 - Layer 3 (source and destination addresses plus flow label)
1717 - 1 - Layer 4 (standard 5-tuple)
1718 - 2 - Layer 3 or inner Layer 3 if present
David Ahernb4bac172018-03-02 08:32:18 -08001719
FX Le Bail509aba32014-01-07 14:57:27 +01001720anycast_src_echo_reply - BOOLEAN
1721 Controls the use of anycast addresses as source addresses for ICMPv6
1722 echo reply
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001723
1724 - TRUE: enabled
1725 - FALSE: disabled
1726
FX Le Bail509aba32014-01-07 14:57:27 +01001727 Default: FALSE
1728
Hannes Frederic Sowa9f0761c2015-03-23 23:36:06 +01001729idgen_delay - INTEGER
1730 Controls the delay in seconds after which time to retry
1731 privacy stable address generation if a DAD conflict is
1732 detected.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001733
Hannes Frederic Sowa9f0761c2015-03-23 23:36:06 +01001734 Default: 1 (as specified in RFC7217)
1735
1736idgen_retries - INTEGER
1737 Controls the number of retries to generate a stable privacy
1738 address if a DAD conflict is detected.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001739
Hannes Frederic Sowa9f0761c2015-03-23 23:36:06 +01001740 Default: 3 (as specified in RFC7217)
1741
Hannes Frederic Sowa2f711932014-09-02 15:49:25 +02001742mld_qrv - INTEGER
1743 Controls the MLD query robustness variable (see RFC3810 9.1).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001744
Hannes Frederic Sowa2f711932014-09-02 15:49:25 +02001745 Default: 2 (as specified by RFC3810 9.1)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001746
Hannes Frederic Sowa2f711932014-09-02 15:49:25 +02001747 Minimum: 1 (as specified by RFC6636 4.5)
1748
Olivier Gayotab913452018-04-18 22:03:06 +02001749max_dst_opts_number - INTEGER
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001750 Maximum number of non-padding TLVs allowed in a Destination
1751 options extension header. If this value is less than zero
1752 then unknown options are disallowed and the number of known
1753 TLVs allowed is the absolute value of this number.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001754
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001755 Default: 8
1756
Olivier Gayotab913452018-04-18 22:03:06 +02001757max_hbh_opts_number - INTEGER
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001758 Maximum number of non-padding TLVs allowed in a Hop-by-Hop
1759 options extension header. If this value is less than zero
1760 then unknown options are disallowed and the number of known
1761 TLVs allowed is the absolute value of this number.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001762
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001763 Default: 8
1764
Olivier Gayotab913452018-04-18 22:03:06 +02001765max_dst_opts_length - INTEGER
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001766 Maximum length allowed for a Destination options extension
1767 header.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001768
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001769 Default: INT_MAX (unlimited)
1770
Olivier Gayotab913452018-04-18 22:03:06 +02001771max_hbh_length - INTEGER
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001772 Maximum length allowed for a Hop-by-Hop options extension
1773 header.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001774
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001775 Default: INT_MAX (unlimited)
1776
David Ahern7c6bb7d2018-10-11 20:17:21 -07001777skip_notify_on_dev_down - BOOLEAN
1778 Controls whether an RTM_DELROUTE message is generated for routes
1779 removed when a device is taken down or deleted. IPv4 does not
1780 generate this message; IPv6 does by default. Setting this sysctl
1781 to true skips the message, making IPv4 and IPv6 on par in relying
1782 on userspace caches to track link events and evict routes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001783
David Ahern7c6bb7d2018-10-11 20:17:21 -07001784 Default: false (generate message)
1785
Roopa Prabhu4f801162020-04-27 13:56:46 -07001786nexthop_compat_mode - BOOLEAN
1787 New nexthop API provides a means for managing nexthops independent of
1788 prefixes. Backwards compatibilty with old route format is enabled by
1789 default which means route dumps and notifications contain the new
1790 nexthop attribute but also the full, expanded nexthop definition.
1791 Further, updates or deletes of a nexthop configuration generate route
1792 notifications for each fib entry using the nexthop. Once a system
1793 understands the new API, this sysctl can be disabled to achieve full
1794 performance benefits of the new API by disabling the nexthop expansion
1795 and extraneous notifications.
1796 Default: true (backward compat mode)
1797
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798IPv6 Fragmentation:
1799
1800ip6frag_high_thresh - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001801 Maximum memory used to reassemble IPv6 fragments. When
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 ip6frag_high_thresh bytes of memory is allocated for this purpose,
1803 the fragment handler will toss packets until ip6frag_low_thresh
1804 is reached.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001805
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806ip6frag_low_thresh - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001807 See ip6frag_high_thresh
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808
1809ip6frag_time - INTEGER
1810 Time in seconds to keep an IPv6 fragment in memory.
1811
Ahmed Abdelsalama6dc6672018-04-27 17:51:48 +02001812IPv6 Segment Routing:
1813
1814seg6_flowlabel - INTEGER
1815 Controls the behaviour of computing the flowlabel of outer
1816 IPv6 header in case of SR T.encaps
1817
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001818 == =======================================================
1819 -1 set flowlabel to zero.
1820 0 copy flowlabel from Inner packet in case of Inner IPv6
1821 (Set flowlabel to 0 in case IPv4/L2)
1822 1 Compute the flowlabel using seg6_make_flowlabel()
1823 == =======================================================
Ahmed Abdelsalama6dc6672018-04-27 17:51:48 +02001824
1825 Default is 0.
1826
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001827``conf/default/*``:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 Change the interface-specific default settings.
1829
Pali Rohárfc024c52021-01-21 16:02:44 +01001830 These settings would be used during creating new interfaces.
1831
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001833``conf/all/*``:
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001834 Change all the interface-specific settings.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835
1836 [XXX: Other special features than forwarding?]
1837
Pali Rohárfc024c52021-01-21 16:02:44 +01001838conf/all/disable_ipv6 - BOOLEAN
1839 Changing this value is same as changing ``conf/default/disable_ipv6``
1840 setting and also all per-interface ``disable_ipv6`` settings to the same
1841 value.
1842
1843 Reading this value does not have any particular meaning. It does not say
1844 whether IPv6 support is enabled or disabled. Returned value can be 1
1845 also in the case when some interface has ``disable_ipv6`` set to 0 and
1846 has configured IPv6 addresses.
1847
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848conf/all/forwarding - BOOLEAN
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001849 Enable global IPv6 forwarding between all interfaces.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001851 IPv4 and IPv6 work differently here; e.g. netfilter must be used
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852 to control which interfaces may forward packets and which not.
1853
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001854 This also sets all interfaces' Host/Router setting
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 'forwarding' to the specified value. See below for details.
1856
1857 This referred to as global forwarding.
1858
YOSHIFUJI Hideakifbea49e2006-09-22 14:43:49 -07001859proxy_ndp - BOOLEAN
1860 Do proxy ndp.
1861
Loganaden Velvindron219b5f22014-11-04 03:02:49 -08001862fwmark_reflect - BOOLEAN
1863 Controls the fwmark of kernel-generated IPv6 reply packets that are not
1864 associated with a socket for example, TCP RSTs or ICMPv6 echo replies).
1865 If unset, these packets have a fwmark of zero. If set, they have the
1866 fwmark of the packet they are replying to.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001867
Loganaden Velvindron219b5f22014-11-04 03:02:49 -08001868 Default: 0
1869
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001870``conf/interface/*``:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871 Change special settings per interface.
1872
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001873 The functional behaviour for certain settings is different
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874 depending on whether local forwarding is enabled or not.
1875
Roy.Li605b91c2011-09-28 19:51:54 +00001876accept_ra - INTEGER
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 Accept Router Advertisements; autoconfigure using them.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001878
Tore Anderson026359b2011-08-28 23:47:33 +00001879 It also determines whether or not to transmit Router
1880 Solicitations. If and only if the functional setting is to
1881 accept Router Advertisements, Router Solicitations will be
1882 transmitted.
1883
Thomas Grafae8abfa2010-09-03 05:47:30 +00001884 Possible values are:
Thomas Grafae8abfa2010-09-03 05:47:30 +00001885
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001886 == ===========================================================
1887 0 Do not accept Router Advertisements.
1888 1 Accept Router Advertisements if forwarding is disabled.
1889 2 Overrule forwarding behaviour. Accept Router Advertisements
1890 even if forwarding is enabled.
1891 == ===========================================================
1892
1893 Functional default:
1894
1895 - enabled if local forwarding is disabled.
1896 - disabled if local forwarding is enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897
YOSHIFUJI Hideaki65f5c7c2006-03-20 16:55:08 -08001898accept_ra_defrtr - BOOLEAN
1899 Learn default router in Router Advertisement.
1900
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001901 Functional default:
1902
1903 - enabled if accept_ra is enabled.
1904 - disabled if accept_ra is disabled.
YOSHIFUJI Hideaki65f5c7c2006-03-20 16:55:08 -08001905
Praveen Chaudhary6b2e04b2021-01-25 13:44:30 -08001906ra_defrtr_metric - UNSIGNED INTEGER
1907 Route metric for default route learned in Router Advertisement. This value
1908 will be assigned as metric for the default route learned via IPv6 Router
1909 Advertisement. Takes affect only if accept_ra_defrtr is enabled.
1910
1911 Possible values:
1912 1 to 0xFFFFFFFF
1913
1914 Default: IP6_RT_PRIO_USER i.e. 1024.
1915
Ben Greeard9333192014-06-25 14:44:53 -07001916accept_ra_from_local - BOOLEAN
1917 Accept RA with source-address that is found on local machine
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001918 if the RA is otherwise proper and able to be accepted.
1919
1920 Default is to NOT accept these as it may be an un-intended
1921 network loop.
Ben Greeard9333192014-06-25 14:44:53 -07001922
1923 Functional default:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001924
1925 - enabled if accept_ra_from_local is enabled
1926 on a specific interface.
1927 - disabled if accept_ra_from_local is disabled
1928 on a specific interface.
Ben Greeard9333192014-06-25 14:44:53 -07001929
Hangbin Liu8013d1d2015-07-30 14:28:42 +08001930accept_ra_min_hop_limit - INTEGER
1931 Minimum hop limit Information in Router Advertisement.
1932
1933 Hop limit Information in Router Advertisement less than this
1934 variable shall be ignored.
1935
1936 Default: 1
1937
YOSHIFUJI Hideakic4fd30e2006-03-20 16:55:26 -08001938accept_ra_pinfo - BOOLEAN
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02001939 Learn Prefix Information in Router Advertisement.
YOSHIFUJI Hideakic4fd30e2006-03-20 16:55:26 -08001940
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001941 Functional default:
1942
1943 - enabled if accept_ra is enabled.
1944 - disabled if accept_ra is disabled.
YOSHIFUJI Hideakic4fd30e2006-03-20 16:55:26 -08001945
Joel Scherpelzbbea1242017-03-22 18:19:04 +09001946accept_ra_rt_info_min_plen - INTEGER
1947 Minimum prefix length of Route Information in RA.
1948
1949 Route Information w/ prefix smaller than this variable shall
1950 be ignored.
1951
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001952 Functional default:
1953
1954 * 0 if accept_ra_rtr_pref is enabled.
1955 * -1 if accept_ra_rtr_pref is disabled.
Joel Scherpelzbbea1242017-03-22 18:19:04 +09001956
YOSHIFUJI Hideaki09c884d2006-03-20 17:07:03 -08001957accept_ra_rt_info_max_plen - INTEGER
1958 Maximum prefix length of Route Information in RA.
1959
Joel Scherpelzbbea1242017-03-22 18:19:04 +09001960 Route Information w/ prefix larger than this variable shall
1961 be ignored.
YOSHIFUJI Hideaki09c884d2006-03-20 17:07:03 -08001962
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001963 Functional default:
1964
1965 * 0 if accept_ra_rtr_pref is enabled.
1966 * -1 if accept_ra_rtr_pref is disabled.
YOSHIFUJI Hideaki09c884d2006-03-20 17:07:03 -08001967
YOSHIFUJI Hideaki930d6ff2006-03-20 17:05:30 -08001968accept_ra_rtr_pref - BOOLEAN
1969 Accept Router Preference in RA.
1970
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001971 Functional default:
1972
1973 - enabled if accept_ra is enabled.
1974 - disabled if accept_ra is disabled.
YOSHIFUJI Hideaki930d6ff2006-03-20 17:05:30 -08001975
Harout Hedeshianc2943f12015-01-20 10:06:05 -07001976accept_ra_mtu - BOOLEAN
1977 Apply the MTU value specified in RA option 5 (RFC4861). If
1978 disabled, the MTU specified in the RA will be ignored.
1979
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001980 Functional default:
1981
1982 - enabled if accept_ra is enabled.
1983 - disabled if accept_ra is disabled.
Harout Hedeshianc2943f12015-01-20 10:06:05 -07001984
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985accept_redirects - BOOLEAN
1986 Accept Redirects.
1987
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001988 Functional default:
1989
1990 - enabled if local forwarding is disabled.
1991 - disabled if local forwarding is enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992
YOSHIFUJI Hideaki0bcbc922007-04-24 14:58:30 -07001993accept_source_route - INTEGER
1994 Accept source routing (routing extension header).
1995
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001996 - >= 0: Accept only routing header type 2.
1997 - < 0: Do not accept routing header.
YOSHIFUJI Hideaki0bcbc922007-04-24 14:58:30 -07001998
1999 Default: 0
2000
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001autoconf - BOOLEAN
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002002 Autoconfigure addresses using Prefix Information in Router
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 Advertisements.
2004
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002005 Functional default:
2006
2007 - enabled if accept_ra_pinfo is enabled.
2008 - disabled if accept_ra_pinfo is disabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009
2010dad_transmits - INTEGER
2011 The amount of Duplicate Address Detection probes to send.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002012
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013 Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014
Roy.Li605b91c2011-09-28 19:51:54 +00002015forwarding - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002016 Configure interface-specific Host/Router behaviour.
2017
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002018 .. note::
2019
2020 It is recommended to have the same setting on all
2021 interfaces; mixed router/host scenarios are rather uncommon.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022
Thomas Grafae8abfa2010-09-03 05:47:30 +00002023 Possible values are:
Thomas Grafae8abfa2010-09-03 05:47:30 +00002024
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002025 - 0 Forwarding disabled
2026 - 1 Forwarding enabled
2027
2028 **FALSE (0)**:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029
2030 By default, Host behaviour is assumed. This means:
2031
2032 1. IsRouter flag is not set in Neighbour Advertisements.
Tore Anderson026359b2011-08-28 23:47:33 +00002033 2. If accept_ra is TRUE (default), transmit Router
2034 Solicitations.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002035 3. If accept_ra is TRUE (default), accept Router
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 Advertisements (and do autoconfiguration).
2037 4. If accept_redirects is TRUE (default), accept Redirects.
2038
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002039 **TRUE (1)**:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002041 If local forwarding is enabled, Router behaviour is assumed.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042 This means exactly the reverse from the above:
2043
2044 1. IsRouter flag is set in Neighbour Advertisements.
Tore Anderson026359b2011-08-28 23:47:33 +00002045 2. Router Solicitations are not sent unless accept_ra is 2.
Thomas Grafae8abfa2010-09-03 05:47:30 +00002046 3. Router Advertisements are ignored unless accept_ra is 2.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047 4. Redirects are ignored.
2048
Thomas Grafae8abfa2010-09-03 05:47:30 +00002049 Default: 0 (disabled) if global forwarding is disabled (default),
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002050 otherwise 1 (enabled).
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051
2052hop_limit - INTEGER
2053 Default Hop Limit to set.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002054
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 Default: 64
2056
2057mtu - INTEGER
2058 Default Maximum Transfer Unit
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002059
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 Default: 1280 (IPv6 required minimum)
2061
Tom Herbert35a256f2015-07-08 16:58:22 -07002062ip_nonlocal_bind - BOOLEAN
2063 If set, allows processes to bind() to non-local IPv6 addresses,
2064 which can be quite useful - but may break some applications.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002065
Tom Herbert35a256f2015-07-08 16:58:22 -07002066 Default: 0
2067
YOSHIFUJI Hideaki52e163562006-03-20 17:05:47 -08002068router_probe_interval - INTEGER
2069 Minimum interval (in seconds) between Router Probing described
2070 in RFC4191.
2071
2072 Default: 60
2073
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074router_solicitation_delay - INTEGER
2075 Number of seconds to wait after interface is brought up
2076 before sending Router Solicitations.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002077
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 Default: 1
2079
2080router_solicitation_interval - INTEGER
2081 Number of seconds to wait between Router Solicitations.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002082
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 Default: 4
2084
2085router_solicitations - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002086 Number of Router Solicitations to send until assuming no
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 routers are present.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002088
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 Default: 3
2090
Erik Kline3985e8a2015-07-22 16:38:25 +09002091use_oif_addrs_only - BOOLEAN
2092 When enabled, the candidate source addresses for destinations
2093 routed via this interface are restricted to the set of addresses
2094 configured on this interface (vis. RFC 6724, section 4).
2095
2096 Default: false
2097
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098use_tempaddr - INTEGER
2099 Preference for Privacy Extensions (RFC3041).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002100
2101 * <= 0 : disable Privacy Extensions
2102 * == 1 : enable Privacy Extensions, but prefer public
2103 addresses over temporary addresses.
2104 * > 1 : enable Privacy Extensions and prefer temporary
2105 addresses over public addresses.
2106
2107 Default:
2108
2109 * 0 (for most devices)
2110 * -1 (for point-to-point devices and loopback devices)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111
2112temp_valid_lft - INTEGER
2113 valid lifetime (in seconds) for temporary addresses.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002114
Fernando Gont969c5462020-05-01 00:51:47 -03002115 Default: 172800 (2 days)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116
2117temp_prefered_lft - INTEGER
2118 Preferred lifetime (in seconds) for temporary addresses.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002119
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 Default: 86400 (1 day)
2121
David Ahernf1705ec2016-02-24 09:25:37 -08002122keep_addr_on_down - INTEGER
2123 Keep all IPv6 addresses on an interface down event. If set static
2124 global addresses with no expiration time are not flushed.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002125
2126 * >0 : enabled
2127 * 0 : system default
2128 * <0 : disabled
David Ahernf1705ec2016-02-24 09:25:37 -08002129
2130 Default: 0 (addresses are removed)
2131
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132max_desync_factor - INTEGER
2133 Maximum value for DESYNC_FACTOR, which is a random value
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002134 that ensures that clients don't synchronize with each
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 other and generate new addresses at exactly the same time.
2136 value is in seconds.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002137
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 Default: 600
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002139
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140regen_max_retry - INTEGER
2141 Number of attempts before give up attempting to generate
2142 valid temporary addresses.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002143
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 Default: 5
2145
2146max_addresses - INTEGER
Brian Haleye79dc482010-02-22 12:27:21 +00002147 Maximum number of autoconfigured addresses per interface. Setting
2148 to zero disables the limitation. It is not recommended to set this
2149 value too large (or to zero) because it would be an easy way to
2150 crash the kernel by allowing too many addresses to be created.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002151
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 Default: 16
2153
YOSHIFUJI Hideaki778d80b2008-06-28 14:17:11 +09002154disable_ipv6 - BOOLEAN
Brian Haley9bdd8d42009-03-18 18:22:48 -07002155 Disable IPv6 operation. If accept_dad is set to 2, this value
2156 will be dynamically set to TRUE if DAD fails for the link-local
2157 address.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002158
YOSHIFUJI Hideaki778d80b2008-06-28 14:17:11 +09002159 Default: FALSE (enable IPv6 operation)
2160
Brian Haley56d417b2009-06-01 03:07:33 -07002161 When this value is changed from 1 to 0 (IPv6 is being enabled),
2162 it will dynamically create a link-local address on the given
2163 interface and start Duplicate Address Detection, if necessary.
2164
2165 When this value is changed from 0 to 1 (IPv6 is being disabled),
Lorenzo Bianconi2f0aaf72018-03-29 11:02:25 +02002166 it will dynamically delete all addresses and routes on the given
2167 interface. From now on it will not possible to add addresses/routes
2168 to the selected interface.
Brian Haley56d417b2009-06-01 03:07:33 -07002169
YOSHIFUJI Hideaki1b34be72008-06-28 14:18:38 +09002170accept_dad - INTEGER
2171 Whether to accept DAD (Duplicate Address Detection).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002172
2173 == ==============================================================
2174 0 Disable DAD
2175 1 Enable DAD (default)
2176 2 Enable DAD, and disable IPv6 operation if MAC-based duplicate
2177 link-local address has been found.
2178 == ==============================================================
YOSHIFUJI Hideaki1b34be72008-06-28 14:18:38 +09002179
Matteo Croce35e015e2017-09-12 17:46:37 +02002180 DAD operation and mode on a given interface will be selected according
2181 to the maximum value of conf/{all,interface}/accept_dad.
2182
Octavian Purdilaf7734fd2009-10-02 11:39:15 +00002183force_tllao - BOOLEAN
2184 Enable sending the target link-layer address option even when
2185 responding to a unicast neighbor solicitation.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002186
Octavian Purdilaf7734fd2009-10-02 11:39:15 +00002187 Default: FALSE
2188
2189 Quoting from RFC 2461, section 4.4, Target link-layer address:
2190
2191 "The option MUST be included for multicast solicitations in order to
2192 avoid infinite Neighbor Solicitation "recursion" when the peer node
2193 does not have a cache entry to return a Neighbor Advertisements
2194 message. When responding to unicast solicitations, the option can be
2195 omitted since the sender of the solicitation has the correct link-
2196 layer address; otherwise it would not have be able to send the unicast
2197 solicitation in the first place. However, including the link-layer
2198 address in this case adds little overhead and eliminates a potential
2199 race condition where the sender deletes the cached link-layer address
2200 prior to receiving a response to a previous solicitation."
2201
Hannes Frederic Sowadb2b6202013-01-01 00:35:31 +00002202ndisc_notify - BOOLEAN
2203 Define mode for notification of address and device changes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002204
2205 * 0 - (default): do nothing
2206 * 1 - Generate unsolicited neighbour advertisements when device is brought
2207 up or hardware address changes.
Hannes Frederic Sowadb2b6202013-01-01 00:35:31 +00002208
Maciej Żenczykowski2210d6b2017-11-07 21:52:09 -08002209ndisc_tclass - INTEGER
2210 The IPv6 Traffic Class to use by default when sending IPv6 Neighbor
2211 Discovery (Router Solicitation, Router Advertisement, Neighbor
2212 Solicitation, Neighbor Advertisement, Redirect) messages.
2213 These 8 bits can be interpreted as 6 high order bits holding the DSCP
2214 value and 2 low order bits representing ECN (which you probably want
2215 to leave cleared).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002216
2217 * 0 - (default)
Maciej Żenczykowski2210d6b2017-11-07 21:52:09 -08002218
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02002219mldv1_unsolicited_report_interval - INTEGER
2220 The interval in milliseconds in which the next unsolicited
2221 MLDv1 report retransmit will take place.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002222
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02002223 Default: 10000 (10 seconds)
2224
2225mldv2_unsolicited_report_interval - INTEGER
2226 The interval in milliseconds in which the next unsolicited
2227 MLDv2 report retransmit will take place.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002228
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02002229 Default: 1000 (1 second)
2230
Daniel Borkmannf2127812013-09-04 00:19:44 +02002231force_mld_version - INTEGER
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002232 * 0 - (default) No enforcement of a MLD version, MLDv1 fallback allowed
2233 * 1 - Enforce to use MLD version 1
2234 * 2 - Enforce to use MLD version 2
Daniel Borkmannf2127812013-09-04 00:19:44 +02002235
Hannes Frederic Sowab800c3b2013-08-27 01:36:51 +02002236suppress_frag_ndisc - INTEGER
2237 Control RFC 6980 (Security Implications of IPv6 Fragmentation
2238 with IPv6 Neighbor Discovery) behavior:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002239
2240 * 1 - (default) discard fragmented neighbor discovery packets
2241 * 0 - allow fragmented neighbor discovery packets
Hannes Frederic Sowab800c3b2013-08-27 01:36:51 +02002242
Erik Kline7fd25612014-10-28 18:11:14 +09002243optimistic_dad - BOOLEAN
2244 Whether to perform Optimistic Duplicate Address Detection (RFC 4429).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002245
2246 * 0: disabled (default)
2247 * 1: enabled
Matteo Croce35e015e2017-09-12 17:46:37 +02002248
2249 Optimistic Duplicate Address Detection for the interface will be enabled
2250 if at least one of conf/{all,interface}/optimistic_dad is set to 1,
2251 it will be disabled otherwise.
Erik Kline7fd25612014-10-28 18:11:14 +09002252
2253use_optimistic - BOOLEAN
2254 If enabled, do not classify optimistic addresses as deprecated during
2255 source address selection. Preferred addresses will still be chosen
2256 before optimistic addresses, subject to other ranking in the source
2257 address selection algorithm.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002258
2259 * 0: disabled (default)
2260 * 1: enabled
Matteo Croce35e015e2017-09-12 17:46:37 +02002261
2262 This will be enabled if at least one of
2263 conf/{all,interface}/use_optimistic is set to 1, disabled otherwise.
Erik Kline7fd25612014-10-28 18:11:14 +09002264
Hannes Frederic Sowa9f0761c2015-03-23 23:36:06 +01002265stable_secret - IPv6 address
2266 This IPv6 address will be used as a secret to generate IPv6
2267 addresses for link-local addresses and autoconfigured
2268 ones. All addresses generated after setting this secret will
2269 be stable privacy ones by default. This can be changed via the
2270 addrgenmode ip-link. conf/default/stable_secret is used as the
2271 secret for the namespace, the interface specific ones can
2272 overwrite that. Writes to conf/all/stable_secret are refused.
2273
2274 It is recommended to generate this secret during installation
2275 of a system and keep it stable after that.
2276
2277 By default the stable secret is unset.
2278
Sabrina Dubrocaf168db52018-07-09 12:25:18 +02002279addr_gen_mode - INTEGER
2280 Defines how link-local and autoconf addresses are generated.
2281
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002282 = =================================================================
2283 0 generate address based on EUI64 (default)
2284 1 do no generate a link-local address, use EUI64 for addresses
2285 generated from autoconf
2286 2 generate stable privacy addresses, using the secret from
Sabrina Dubrocaf168db52018-07-09 12:25:18 +02002287 stable_secret (RFC7217)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002288 3 generate stable privacy addresses, using a random secret if unset
2289 = =================================================================
Sabrina Dubrocaf168db52018-07-09 12:25:18 +02002290
Johannes Bergabbc3042016-02-04 13:31:19 +01002291drop_unicast_in_l2_multicast - BOOLEAN
2292 Drop any unicast IPv6 packets that are received in link-layer
2293 multicast (or broadcast) frames.
2294
2295 By default this is turned off.
2296
Johannes Berg7a02bf82016-02-04 13:31:20 +01002297drop_unsolicited_na - BOOLEAN
2298 Drop all unsolicited neighbor advertisements, for example if there's
2299 a known good NA proxy on the network and such frames need not be used
2300 (or in the case of 802.11, must not be used to prevent attacks.)
2301
2302 By default this is turned off.
2303
Erik Nordmarkadc176c2016-12-02 14:00:08 -08002304enhanced_dad - BOOLEAN
2305 Include a nonce option in the IPv6 neighbor solicitation messages used for
2306 duplicate address detection per RFC7527. A received DAD NS will only signal
2307 a duplicate address if the nonce is different. This avoids any false
2308 detection of duplicates due to loopback of the NS messages that we send.
2309 The nonce option will be sent on an interface unless both of
2310 conf/{all,interface}/enhanced_dad are set to FALSE.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002311
Erik Nordmarkadc176c2016-12-02 14:00:08 -08002312 Default: TRUE
2313
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002314``icmp/*``:
2315===========
2316
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317ratelimit - INTEGER
Stephen Suryaputra0bc19982019-04-17 16:35:49 -04002318 Limit the maximal rates for sending ICMPv6 messages.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002319
Stephen Hemminger6dbf4bc2008-07-01 19:29:07 -07002320 0 to disable any limiting,
2321 otherwise the minimal space between responses in milliseconds.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002322
Stephen Hemminger6dbf4bc2008-07-01 19:29:07 -07002323 Default: 1000
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324
Stephen Suryaputra0bc19982019-04-17 16:35:49 -04002325ratemask - list of comma separated ranges
2326 For ICMPv6 message types matching the ranges in the ratemask, limit
2327 the sending of the message according to ratelimit parameter.
2328
2329 The format used for both input and output is a comma separated
2330 list of ranges (e.g. "0-127,129" for ICMPv6 message type 0 to 127 and
2331 129). Writing to the file will clear all previous ranges of ICMPv6
2332 message types and update the current list with the input.
2333
2334 Refer to: https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml
2335 for numerical values of ICMPv6 message types, e.g. echo request is 128
2336 and echo reply is 129.
2337
2338 Default: 0-1,3-127 (rate limit ICMPv6 errors except Packet Too Big)
2339
Virgile Jarrye6f86b02018-08-10 17:48:15 +02002340echo_ignore_all - BOOLEAN
2341 If set non-zero, then the kernel will ignore all ICMP ECHO
2342 requests sent to it over the IPv6 protocol.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002343
Virgile Jarrye6f86b02018-08-10 17:48:15 +02002344 Default: 0
2345
Stephen Suryaputra03f1ecc2019-03-19 12:37:12 -04002346echo_ignore_multicast - BOOLEAN
2347 If set non-zero, then the kernel will ignore all ICMP ECHO
2348 requests sent to it over the IPv6 protocol via multicast.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002349
Stephen Suryaputra03f1ecc2019-03-19 12:37:12 -04002350 Default: 0
2351
Stephen Suryaputra0b03a5c2019-03-20 10:29:27 -04002352echo_ignore_anycast - BOOLEAN
2353 If set non-zero, then the kernel will ignore all ICMP ECHO
2354 requests sent to it over the IPv6 protocol destined to anycast address.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002355
Stephen Suryaputra0b03a5c2019-03-20 10:29:27 -04002356 Default: 0
2357
Alexander Duycke69948a2015-08-11 13:35:01 -07002358xfrm6_gc_thresh - INTEGER
Nicolas Dichtel837f7412019-04-09 17:16:59 +02002359 (Obsolete since linux-4.14)
Alexander Duycke69948a2015-08-11 13:35:01 -07002360 The threshold at which we will start garbage collecting for IPv6
2361 destination cache entries. At twice this value the system will
Florian Westphal3c2a89d2017-07-17 13:57:20 +02002362 refuse new allocations.
Alexander Duycke69948a2015-08-11 13:35:01 -07002363
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364
2365IPv6 Update by:
2366Pekka Savola <pekkas@netcore.fi>
2367YOSHIFUJI Hideaki / USAGI Project <yoshfuji@linux-ipv6.org>
2368
2369
2370/proc/sys/net/bridge/* Variables:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002371=================================
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372
2373bridge-nf-call-arptables - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002374 - 1 : pass bridged ARP traffic to arptables' FORWARD chain.
2375 - 0 : disable this.
2376
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 Default: 1
2378
2379bridge-nf-call-iptables - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002380 - 1 : pass bridged IPv4 traffic to iptables' chains.
2381 - 0 : disable this.
2382
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383 Default: 1
2384
2385bridge-nf-call-ip6tables - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002386 - 1 : pass bridged IPv6 traffic to ip6tables' chains.
2387 - 0 : disable this.
2388
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389 Default: 1
2390
2391bridge-nf-filter-vlan-tagged - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002392 - 1 : pass bridged vlan-tagged ARP/IP/IPv6 traffic to {arp,ip,ip6}tables.
2393 - 0 : disable this.
2394
Pablo Neira Ayuso49816822012-05-08 19:36:44 +02002395 Default: 0
Michael Milner516299d2007-04-12 22:14:23 -07002396
2397bridge-nf-filter-pppoe-tagged - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002398 - 1 : pass bridged pppoe-tagged IP/IPv6 traffic to {ip,ip6}tables.
2399 - 0 : disable this.
2400
Pablo Neira Ayuso49816822012-05-08 19:36:44 +02002401 Default: 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402
Pablo Neira Ayuso49816822012-05-08 19:36:44 +02002403bridge-nf-pass-vlan-input-dev - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002404 - 1: if bridge-nf-filter-vlan-tagged is enabled, try to find a vlan
2405 interface on the bridge and set the netfilter input device to the
2406 vlan. This allows use of e.g. "iptables -i br0.1" and makes the
2407 REDIRECT target work with vlan-on-top-of-bridge interfaces. When no
2408 matching vlan interface is found, or this switch is off, the input
2409 device is set to the bridge interface.
2410
2411 - 0: disable bridge netfilter vlan interface lookup.
2412
Pablo Neira Ayuso49816822012-05-08 19:36:44 +02002413 Default: 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002415``proc/sys/net/sctp/*`` Variables:
2416==================================
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002417
2418addip_enable - BOOLEAN
2419 Enable or disable extension of Dynamic Address Reconfiguration
2420 (ADD-IP) functionality specified in RFC5061. This extension provides
2421 the ability to dynamically add and remove new addresses for the SCTP
2422 associations.
2423
2424 1: Enable extension.
2425
2426 0: Disable extension.
2427
2428 Default: 0
2429
Zhu Yanjun566178f2015-12-16 13:55:04 +08002430pf_enable - INTEGER
2431 Enable or disable pf (pf is short for potentially failed) state. A value
2432 of pf_retrans > path_max_retrans also disables pf state. That is, one of
2433 both pf_enable and pf_retrans > path_max_retrans can disable pf state.
2434 Since pf_retrans and path_max_retrans can be changed by userspace
2435 application, sometimes user expects to disable pf state by the value of
2436 pf_retrans > path_max_retrans, but occasionally the value of pf_retrans
2437 or path_max_retrans is changed by the user application, this pf state is
2438 enabled. As such, it is necessary to add this to dynamically enable
2439 and disable pf state. See:
2440 https://datatracker.ietf.org/doc/draft-ietf-tsvwg-sctp-failover for
2441 details.
2442
2443 1: Enable pf.
2444
2445 0: Disable pf.
2446
2447 Default: 1
2448
Xin Longaef587b2019-11-08 13:20:32 +08002449pf_expose - INTEGER
2450 Unset or enable/disable pf (pf is short for potentially failed) state
2451 exposure. Applications can control the exposure of the PF path state
2452 in the SCTP_PEER_ADDR_CHANGE event and the SCTP_GET_PEER_ADDR_INFO
2453 sockopt. When it's unset, no SCTP_PEER_ADDR_CHANGE event with
2454 SCTP_ADDR_PF state will be sent and a SCTP_PF-state transport info
2455 can be got via SCTP_GET_PEER_ADDR_INFO sockopt; When it's enabled,
2456 a SCTP_PEER_ADDR_CHANGE event will be sent for a transport becoming
2457 SCTP_PF state and a SCTP_PF-state transport info can be got via
2458 SCTP_GET_PEER_ADDR_INFO sockopt; When it's diabled, no
2459 SCTP_PEER_ADDR_CHANGE event will be sent and it returns -EACCES when
2460 trying to get a SCTP_PF-state transport info via SCTP_GET_PEER_ADDR_INFO
2461 sockopt.
2462
2463 0: Unset pf state exposure, Compatible with old applications.
2464
2465 1: Disable pf state exposure.
2466
2467 2: Enable pf state exposure.
2468
2469 Default: 0
2470
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002471addip_noauth_enable - BOOLEAN
2472 Dynamic Address Reconfiguration (ADD-IP) requires the use of
2473 authentication to protect the operations of adding or removing new
2474 addresses. This requirement is mandated so that unauthorized hosts
2475 would not be able to hijack associations. However, older
2476 implementations may not have implemented this requirement while
2477 allowing the ADD-IP extension. For reasons of interoperability,
2478 we provide this variable to control the enforcement of the
2479 authentication requirement.
2480
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002481 == ===============================================================
2482 1 Allow ADD-IP extension to be used without authentication. This
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002483 should only be set in a closed environment for interoperability
2484 with older implementations.
2485
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002486 0 Enforce the authentication requirement
2487 == ===============================================================
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002488
2489 Default: 0
2490
2491auth_enable - BOOLEAN
2492 Enable or disable Authenticated Chunks extension. This extension
2493 provides the ability to send and receive authenticated chunks and is
2494 required for secure operation of Dynamic Address Reconfiguration
2495 (ADD-IP) extension.
2496
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002497 - 1: Enable this extension.
2498 - 0: Disable this extension.
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002499
2500 Default: 0
2501
2502prsctp_enable - BOOLEAN
2503 Enable or disable the Partial Reliability extension (RFC3758) which
2504 is used to notify peers that a given DATA should no longer be expected.
2505
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002506 - 1: Enable extension
2507 - 0: Disable
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002508
2509 Default: 1
2510
2511max_burst - INTEGER
2512 The limit of the number of new packets that can be initially sent. It
2513 controls how bursty the generated traffic can be.
2514
2515 Default: 4
2516
2517association_max_retrans - INTEGER
2518 Set the maximum number for retransmissions that an association can
2519 attempt deciding that the remote end is unreachable. If this value
2520 is exceeded, the association is terminated.
2521
2522 Default: 10
2523
2524max_init_retransmits - INTEGER
2525 The maximum number of retransmissions of INIT and COOKIE-ECHO chunks
2526 that an association will attempt before declaring the destination
2527 unreachable and terminating.
2528
2529 Default: 8
2530
2531path_max_retrans - INTEGER
2532 The maximum number of retransmissions that will be attempted on a given
2533 path. Once this threshold is exceeded, the path is considered
2534 unreachable, and new traffic will use a different path when the
2535 association is multihomed.
2536
2537 Default: 5
2538
Neil Horman5aa93bc2012-07-21 07:56:07 +00002539pf_retrans - INTEGER
2540 The number of retransmissions that will be attempted on a given path
2541 before traffic is redirected to an alternate transport (should one
2542 exist). Note this is distinct from path_max_retrans, as a path that
2543 passes the pf_retrans threshold can still be used. Its only
2544 deprioritized when a transmission path is selected by the stack. This
2545 setting is primarily used to enable fast failover mechanisms without
2546 having to reduce path_max_retrans to a very low value. See:
2547 http://www.ietf.org/id/draft-nishida-tsvwg-sctp-failover-05.txt
2548 for details. Note also that a value of pf_retrans > path_max_retrans
Zhu Yanjun566178f2015-12-16 13:55:04 +08002549 disables this feature. Since both pf_retrans and path_max_retrans can
2550 be changed by userspace application, a variable pf_enable is used to
2551 disable pf state.
Neil Horman5aa93bc2012-07-21 07:56:07 +00002552
2553 Default: 0
2554
Xin Long34515e92019-11-08 13:20:35 +08002555ps_retrans - INTEGER
2556 Primary.Switchover.Max.Retrans (PSMR), it's a tunable parameter coming
2557 from section-5 "Primary Path Switchover" in rfc7829. The primary path
2558 will be changed to another active path when the path error counter on
2559 the old primary path exceeds PSMR, so that "the SCTP sender is allowed
2560 to continue data transmission on a new working path even when the old
2561 primary destination address becomes active again". Note this feature
2562 is disabled by initializing 'ps_retrans' per netns as 0xffff by default,
2563 and its value can't be less than 'pf_retrans' when changing by sysctl.
2564
2565 Default: 0xffff
2566
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002567rto_initial - INTEGER
2568 The initial round trip timeout value in milliseconds that will be used
2569 in calculating round trip times. This is the initial time interval
2570 for retransmissions.
2571
2572 Default: 3000
2573
2574rto_max - INTEGER
2575 The maximum value (in milliseconds) of the round trip timeout. This
2576 is the largest time interval that can elapse between retransmissions.
2577
2578 Default: 60000
2579
2580rto_min - INTEGER
2581 The minimum value (in milliseconds) of the round trip timeout. This
2582 is the smallest time interval the can elapse between retransmissions.
2583
2584 Default: 1000
2585
2586hb_interval - INTEGER
2587 The interval (in milliseconds) between HEARTBEAT chunks. These chunks
2588 are sent at the specified interval on idle paths to probe the state of
2589 a given path between 2 associations.
2590
2591 Default: 30000
2592
2593sack_timeout - INTEGER
2594 The amount of time (in milliseconds) that the implementation will wait
2595 to send a SACK.
2596
2597 Default: 200
2598
2599valid_cookie_life - INTEGER
2600 The default lifetime of the SCTP cookie (in milliseconds). The cookie
2601 is used during association establishment.
2602
2603 Default: 60000
2604
2605cookie_preserve_enable - BOOLEAN
2606 Enable or disable the ability to extend the lifetime of the SCTP cookie
2607 that is used during the establishment phase of SCTP association
2608
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002609 - 1: Enable cookie lifetime extension.
2610 - 0: Disable
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002611
2612 Default: 1
2613
Neil Horman3c681982012-10-24 09:20:03 +00002614cookie_hmac_alg - STRING
2615 Select the hmac algorithm used when generating the cookie value sent by
2616 a listening sctp socket to a connecting client in the INIT-ACK chunk.
2617 Valid values are:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002618
Neil Horman3c681982012-10-24 09:20:03 +00002619 * md5
2620 * sha1
2621 * none
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002622
Neil Horman3c681982012-10-24 09:20:03 +00002623 Ability to assign md5 or sha1 as the selected alg is predicated on the
stephen hemminger3b09adc2013-01-03 07:50:29 +00002624 configuration of those algorithms at build time (CONFIG_CRYPTO_MD5 and
Neil Horman3c681982012-10-24 09:20:03 +00002625 CONFIG_CRYPTO_SHA1).
2626
2627 Default: Dependent on configuration. MD5 if available, else SHA1 if
2628 available, else none.
2629
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002630rcvbuf_policy - INTEGER
2631 Determines if the receive buffer is attributed to the socket or to
2632 association. SCTP supports the capability to create multiple
2633 associations on a single socket. When using this capability, it is
2634 possible that a single stalled association that's buffering a lot
2635 of data may block other associations from delivering their data by
2636 consuming all of the receive buffer space. To work around this,
2637 the rcvbuf_policy could be set to attribute the receiver buffer space
2638 to each association instead of the socket. This prevents the described
2639 blocking.
2640
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002641 - 1: rcvbuf space is per association
2642 - 0: rcvbuf space is per socket
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002643
2644 Default: 0
2645
2646sndbuf_policy - INTEGER
2647 Similar to rcvbuf_policy above, this applies to send buffer space.
2648
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002649 - 1: Send buffer is tracked per association
2650 - 0: Send buffer is tracked per socket.
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002651
2652 Default: 0
2653
2654sctp_mem - vector of 3 INTEGERs: min, pressure, max
2655 Number of pages allowed for queueing by all SCTP sockets.
2656
2657 min: Below this number of pages SCTP is not bothered about its
2658 memory appetite. When amount of memory allocated by SCTP exceeds
2659 this number, SCTP starts to moderate memory usage.
2660
2661 pressure: This value was introduced to follow format of tcp_mem.
2662
2663 max: Number of pages allowed for queueing by all SCTP sockets.
2664
2665 Default is calculated at boot time from amount of available memory.
2666
2667sctp_rmem - vector of 3 INTEGERs: min, default, max
Max Matveeva6e12042011-06-19 22:08:10 +00002668 Only the first value ("min") is used, "default" and "max" are
2669 ignored.
2670
2671 min: Minimal size of receive buffer used by SCTP socket.
2672 It is guaranteed to each SCTP socket (but not association) even
2673 under moderate memory pressure.
2674
Tonghao Zhang320bd6d2018-03-13 21:57:17 -07002675 Default: 4K
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002676
2677sctp_wmem - vector of 3 INTEGERs: min, default, max
Max Matveeva6e12042011-06-19 22:08:10 +00002678 Currently this tunable has no effect.
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002679
Bhaskar Dutta72388432009-09-03 17:25:47 +05302680addr_scope_policy - INTEGER
2681 Control IPv4 address scoping - draft-stewart-tsvwg-sctp-ipv4-00
2682
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002683 - 0 - Disable IPv4 address scoping
2684 - 1 - Enable IPv4 address scoping
2685 - 2 - Follow draft but allow IPv4 private addresses
2686 - 3 - Follow draft but allow IPv4 link local addresses
Bhaskar Dutta72388432009-09-03 17:25:47 +05302687
2688 Default: 1
2689
Xin Long046c0522020-10-29 15:05:10 +08002690udp_port - INTEGER
2691 The listening port for the local UDP tunneling sock. Normally it's
2692 using the IANA-assigned UDP port number 9899 (sctp-tunneling).
2693
2694 This UDP sock is used for processing the incoming UDP-encapsulated
2695 SCTP packets (from RFC6951), and shared by all applications in the
2696 same net namespace. This UDP sock will be closed when the value is
2697 set to 0.
2698
2699 The value will also be used to set the src port of the UDP header
2700 for the outgoing UDP-encapsulated SCTP packets. For the dest port,
2701 please refer to 'encap_port' below.
2702
2703 Default: 0
2704
Xin Longe8a30012020-10-29 15:05:01 +08002705encap_port - INTEGER
2706 The default remote UDP encapsulation port.
2707
2708 This value is used to set the dest port of the UDP header for the
2709 outgoing UDP-encapsulated SCTP packets by default. Users can also
2710 change the value for each sock/asoc/transport by using setsockopt.
2711 For further information, please refer to RFC6951.
2712
2713 Note that when connecting to a remote server, the client should set
2714 this to the port that the UDP tunneling sock on the peer server is
2715 listening to and the local UDP tunneling sock on the client also
2716 must be started. On the server, it would get the encap_port from
2717 the incoming packet's source port.
2718
2719 Default: 0
2720
Linus Torvalds1da177e2005-04-16 15:20:36 -07002721
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002722``/proc/sys/net/core/*``
2723========================
2724
Mauro Carvalho Chehab57043242019-04-22 16:48:00 -03002725 Please see: Documentation/admin-guide/sysctl/net.rst for descriptions of these entries.
Wang Tinggong705efc32009-05-14 22:49:36 +00002726
Linus Torvalds1da177e2005-04-16 15:20:36 -07002727
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002728``/proc/sys/net/unix/*``
2729========================
2730
Wang Tinggong705efc32009-05-14 22:49:36 +00002731max_dgram_qlen - INTEGER
2732 The maximum length of dgram socket receive queue
2733
2734 Default: 10
2735