blob: 1b7f8debada6a96452625c8c63b950c094dd871e [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
181IP Fragmentation:
182
Eric Dumazet3e67f102018-03-31 12:58:53 -0700183ipfrag_high_thresh - LONG INTEGER
Eric Dumazet648700f2018-03-31 12:58:49 -0700184 Maximum memory used to reassemble IP fragments.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000185
Eric Dumazet3e67f102018-03-31 12:58:53 -0700186ipfrag_low_thresh - LONG INTEGER
Eric Dumazet648700f2018-03-31 12:58:49 -0700187 (Obsolete since linux-4.17)
Florian Westphalb13d3cb2014-07-24 16:50:32 +0200188 Maximum memory used to reassemble IP fragments before the kernel
189 begins to remove incomplete fragment queues to free up resources.
190 The kernel still accepts new fragments for defragmentation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192ipfrag_time - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000193 Time in seconds to keep an IP fragment in memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Herbert Xu89cee8b2005-12-13 23:14:27 -0800195ipfrag_max_dist - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000196 ipfrag_max_dist is a non-negative integer value which defines the
197 maximum "disorder" which is allowed among fragments which share a
198 common IP source address. Note that reordering of packets is
199 not unusual, but if a large number of fragments arrive from a source
200 IP address while a particular fragment queue remains incomplete, it
201 probably indicates that one or more fragments belonging to that queue
202 have been lost. When ipfrag_max_dist is positive, an additional check
203 is done on fragments before they are added to a reassembly queue - if
204 ipfrag_max_dist (or more) fragments have arrived from a particular IP
205 address between additions to any IP fragment queue using that source
206 address, it's presumed that one or more fragments in the queue are
207 lost. The existing fragment queue will be dropped, and a new one
Herbert Xu89cee8b2005-12-13 23:14:27 -0800208 started. An ipfrag_max_dist value of zero disables this check.
209
210 Using a very small value, e.g. 1 or 2, for ipfrag_max_dist can
211 result in unnecessarily dropping fragment queues when normal
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000212 reordering of packets occurs, which could lead to poor application
213 performance. Using a very large value, e.g. 50000, increases the
214 likelihood of incorrectly reassembling IP fragments that originate
Herbert Xu89cee8b2005-12-13 23:14:27 -0800215 from different IP datagrams, which could result in data corruption.
216 Default: 64
217
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200218INET peer storage
219=================
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
221inet_peer_threshold - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000222 The approximate size of the storage. Starting from this threshold
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 entries will be thrown aggressively. This threshold also determines
224 entries' time-to-live and time intervals between garbage collection
225 passes. More entries, less time-to-live, less GC interval.
226
227inet_peer_minttl - INTEGER
228 Minimum time-to-live of entries. Should be enough to cover fragment
229 time-to-live on the reassembling side. This minimum time-to-live is
230 guaranteed if the pool size is less than inet_peer_threshold.
Stephen Hemminger77a538d2008-07-01 17:22:48 -0700231 Measured in seconds.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
233inet_peer_maxttl - INTEGER
234 Maximum time-to-live of entries. Unused entries will expire after
235 this period of time if there is no memory pressure on the pool (i.e.
236 when the number of entries in the pool is very small).
Stephen Hemminger77a538d2008-07-01 17:22:48 -0700237 Measured in seconds.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200239TCP variables
240=============
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800242somaxconn - INTEGER
243 Limit of socket listen() backlog, known in userspace as SOMAXCONN.
Eric Dumazet19f92a02019-10-30 09:36:20 -0700244 Defaults to 4096. (Was 128 before linux-5.4)
245 See also tcp_max_syn_backlog for additional tuning for TCP sockets.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800246
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800247tcp_abort_on_overflow - BOOLEAN
248 If listening service is too slow to accept new connections,
249 reset them. Default state is FALSE. It means that if overflow
250 occurred due to a burst, connection will recover. Enable this
251 option _only_ if you are really sure that listening daemon
252 cannot be tuned to accept connections faster. Enabling this
253 option can harm clients of your server.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800255tcp_adv_win_scale - INTEGER
256 Count buffering overhead as bytes/2^tcp_adv_win_scale
257 (if tcp_adv_win_scale > 0) or bytes-bytes/2^(-tcp_adv_win_scale),
258 if it is <= 0.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200259
Alexey Dobriyan0147fc02010-11-22 12:54:21 +0000260 Possible values are [-31, 31], inclusive.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200261
Eric Dumazetb49960a2012-05-02 02:28:41 +0000262 Default: 1
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800263
264tcp_allowed_congestion_control - STRING
265 Show/set the congestion control choices available to non-privileged
266 processes. The list is a subset of those listed in
267 tcp_available_congestion_control.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200268
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800269 Default is "reno" and the default setting (tcp_congestion_control).
270
271tcp_app_win - INTEGER
272 Reserve max(window/2^tcp_app_win, mss) of window for application
273 buffer. Value 0 is special, it means that nothing is reserved.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200274
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800275 Default: 31
276
Eric Dumazetf54b3112013-12-05 22:36:05 -0800277tcp_autocorking - BOOLEAN
278 Enable TCP auto corking :
279 When applications do consecutive small write()/sendmsg() system calls,
280 we try to coalesce these small writes as much as possible, to lower
281 total amount of sent packets. This is done if at least one prior
282 packet for the flow is waiting in Qdisc queues or device transmit
283 queue. Applications can still use TCP_CORK for optimal behavior
284 when they know how/when to uncork their sockets.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200285
Eric Dumazetf54b3112013-12-05 22:36:05 -0800286 Default : 1
287
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800288tcp_available_congestion_control - STRING
289 Shows the available congestion control choices that are registered.
290 More congestion control algorithms may be available as modules,
291 but not loaded.
292
John Heffner71599cd2007-02-27 10:03:56 -0800293tcp_base_mss - INTEGER
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700294 The initial value of search_low to be used by the packetization layer
295 Path MTU discovery (MTU probing). If MTU probing is enabled,
296 this is the initial MSS used by the connection.
John Heffner71599cd2007-02-27 10:03:56 -0800297
Josh Huntc04b79b2019-08-07 19:52:29 -0400298tcp_mtu_probe_floor - INTEGER
299 If MTU probing is enabled this caps the minimum MSS used for search_low
300 for the connection.
301
302 Default : 48
303
Eric Dumazet5f3e2bf002019-06-06 09:15:31 -0700304tcp_min_snd_mss - INTEGER
305 TCP SYN and SYNACK messages usually advertise an ADVMSS option,
306 as described in RFC 1122 and RFC 6691.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200307
Eric Dumazet5f3e2bf002019-06-06 09:15:31 -0700308 If this ADVMSS option is smaller than tcp_min_snd_mss,
309 it is silently capped to tcp_min_snd_mss.
310
311 Default : 48 (at least 8 bytes of payload per segment)
312
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800313tcp_congestion_control - STRING
314 Set the congestion control algorithm to be used for new
315 connections. The algorithm "reno" is always available, but
316 additional choices may be available based on kernel configuration.
317 Default is set as part of kernel configuration.
Eric Dumazetd8a6e652011-11-30 01:02:41 +0000318 For passive connections, the listener congestion control choice
319 is inherited.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200320
Eric Dumazetd8a6e652011-11-30 01:02:41 +0000321 [see setsockopt(listenfd, SOL_TCP, TCP_CONGESTION, "name" ...) ]
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800322
323tcp_dsack - BOOLEAN
324 Allows TCP to send "duplicate" SACKs.
325
Yuchung Chengeed530b2012-05-02 13:30:03 +0000326tcp_early_retrans - INTEGER
Yuchung Chengbec41a12017-01-12 22:11:39 -0800327 Tail loss probe (TLP) converts RTOs occurring due to tail
328 losses into fast recovery (draft-ietf-tcpm-rack). Note that
329 TLP requires RACK to function properly (see tcp_recovery below)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200330
Yuchung Chengeed530b2012-05-02 13:30:03 +0000331 Possible values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200332
333 - 0 disables TLP
334 - 3 or 4 enables TLP
335
Nandita Dukkipati6ba8a3b2013-03-11 10:00:43 +0000336 Default: 3
Yuchung Chengeed530b2012-05-02 13:30:03 +0000337
Peter Chubb34a6ef32011-02-02 15:39:58 -0800338tcp_ecn - INTEGER
Rick Jones7e3a2dc2012-11-28 09:53:10 +0000339 Control use of Explicit Congestion Notification (ECN) by TCP.
340 ECN is used only when both ends of the TCP connection indicate
341 support for it. This feature is useful in avoiding losses due
342 to congestion by allowing supporting routers to signal
343 congestion before having to drop packets.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200344
Ilpo Järvinen255cac92009-05-04 11:07:36 -0700345 Possible values are:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200346
347 = =====================================================
348 0 Disable ECN. Neither initiate nor accept ECN.
349 1 Enable ECN when requested by incoming connections and
350 also request ECN on outgoing connection attempts.
351 2 Enable ECN when requested by incoming connections
352 but do not request ECN on outgoing connections.
353 = =====================================================
354
Ilpo Järvinen255cac92009-05-04 11:07:36 -0700355 Default: 2
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800356
Daniel Borkmann49213552015-05-19 21:04:22 +0200357tcp_ecn_fallback - BOOLEAN
358 If the kernel detects that ECN connection misbehaves, enable fall
359 back to non-ECN. Currently, this knob implements the fallback
360 from RFC3168, section 6.1.1.1., but we reserve that in future,
361 additional detection mechanisms could be implemented under this
362 knob. The value is not used, if tcp_ecn or per route (or congestion
363 control) ECN settings are disabled.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200364
Daniel Borkmann49213552015-05-19 21:04:22 +0200365 Default: 1 (fallback enabled)
366
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800367tcp_fack - BOOLEAN
Yuchung Cheng713bafe2017-11-08 13:01:26 -0800368 This is a legacy option, it has no effect anymore.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800369
370tcp_fin_timeout - INTEGER
Rick Jonesd825da22012-12-10 11:33:00 +0000371 The length of time an orphaned (no longer referenced by any
372 application) connection will remain in the FIN_WAIT_2 state
373 before it is aborted at the local end. While a perfectly
374 valid "receive only" state for an un-orphaned connection, an
375 orphaned connection in FIN_WAIT_2 state could otherwise wait
376 forever for the remote to close its end of the connection.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200377
Rick Jonesd825da22012-12-10 11:33:00 +0000378 Cf. tcp_max_orphans
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200379
Rick Jonesd825da22012-12-10 11:33:00 +0000380 Default: 60 seconds
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800381
Ilpo Järvinen89808062007-02-27 10:10:55 -0800382tcp_frto - INTEGER
Yuchung Chenge33099f2013-03-20 13:33:00 +0000383 Enables Forward RTO-Recovery (F-RTO) defined in RFC5682.
Ilpo Järvinencd998892007-09-20 11:35:26 -0700384 F-RTO is an enhanced recovery algorithm for TCP retransmission
Yuchung Chenge33099f2013-03-20 13:33:00 +0000385 timeouts. It is particularly beneficial in networks where the
386 RTT fluctuates (e.g., wireless). F-RTO is sender-side only
387 modification. It does not require any support from the peer.
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700388
Yuchung Chenge33099f2013-03-20 13:33:00 +0000389 By default it's enabled with a non-zero value. 0 disables F-RTO.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
Lorenzo Colittie2d00e62018-10-29 09:30:29 +0900391tcp_fwmark_accept - BOOLEAN
392 If set, incoming connections to listening sockets that do not have a
393 socket mark will set the mark of the accepting socket to the fwmark of
394 the incoming SYN packet. This will cause all packets on that connection
395 (starting from the first SYNACK) to be sent with that fwmark. The
396 listening socket's mark is unchanged. Listening sockets that already
397 have a fwmark set via setsockopt(SOL_SOCKET, SO_MARK, ...) are
398 unaffected.
399
400 Default: 0
401
Neal Cardwell032ee422015-02-06 16:04:38 -0500402tcp_invalid_ratelimit - INTEGER
403 Limit the maximal rate for sending duplicate acknowledgments
404 in response to incoming TCP packets that are for an existing
405 connection but that are invalid due to any of these reasons:
406
407 (a) out-of-window sequence number,
408 (b) out-of-window acknowledgment number, or
409 (c) PAWS (Protection Against Wrapped Sequence numbers) check failure
410
411 This can help mitigate simple "ack loop" DoS attacks, wherein
412 a buggy or malicious middlebox or man-in-the-middle can
413 rewrite TCP header fields in manner that causes each endpoint
414 to think that the other is sending invalid TCP segments, thus
415 causing each side to send an unterminating stream of duplicate
416 acknowledgments for invalid segments.
417
418 Using 0 disables rate-limiting of dupacks in response to
419 invalid segments; otherwise this value specifies the minimal
420 space between sending such dupacks, in milliseconds.
421
422 Default: 500 (milliseconds).
423
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424tcp_keepalive_time - INTEGER
425 How often TCP sends out keepalive messages when keepalive is enabled.
426 Default: 2hours.
427
428tcp_keepalive_probes - INTEGER
429 How many keepalive probes TCP sends out, until it decides that the
430 connection is broken. Default value: 9.
431
432tcp_keepalive_intvl - INTEGER
433 How frequently the probes are send out. Multiplied by
434 tcp_keepalive_probes it is time to kill not responding connection,
435 after probes started. Default value: 75sec i.e. connection
436 will be aborted after ~11 minutes of retries.
437
David Ahern6dd9a142015-12-16 13:20:44 -0800438tcp_l3mdev_accept - BOOLEAN
439 Enables child sockets to inherit the L3 master device index.
440 Enabling this option allows a "global" listen socket to work
441 across L3 master domains (e.g., VRFs) with connected sockets
442 derived from the listen socket to be bound to the L3 domain in
443 which the packets originated. Only valid when the kernel was
444 compiled with CONFIG_NET_L3_MASTER_DEV.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200445
446 Default: 0 (disabled)
David Ahern6dd9a142015-12-16 13:20:44 -0800447
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800448tcp_low_latency - BOOLEAN
Florian Westphalb6690b12017-07-30 03:57:20 +0200449 This is a legacy option, it has no effect anymore.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
451tcp_max_orphans - INTEGER
452 Maximal number of TCP sockets not attached to any user file handle,
453 held by system. If this number is exceeded orphaned connections are
454 reset immediately and warning is printed. This limit exists
455 only to prevent simple DoS attacks, you _must_ not rely on this
456 or lower the limit artificially, but rather increase it
457 (probably, after increasing installed memory),
458 if network conditions require more than default value,
459 and tune network services to linger and kill such states
460 more aggressively. Let me to remind again: each orphan eats
461 up to ~64K of unswappable memory.
462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463tcp_max_syn_backlog - INTEGER
Eric Dumazet623d0c22019-10-30 10:05:46 -0700464 Maximal number of remembered connection requests (SYN_RECV),
465 which have not received an acknowledgment from connecting client.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200466
Eric Dumazet623d0c22019-10-30 10:05:46 -0700467 This is a per-listener limit.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200468
Peter Pan(潘卫平)99b53bd2011-12-05 21:39:41 +0000469 The minimal value is 128 for low memory machines, and it will
470 increase in proportion to the memory of machine.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200471
Peter Pan(潘卫平)99b53bd2011-12-05 21:39:41 +0000472 If server suffers from overload, try increasing this number.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200473
Eric Dumazet623d0c22019-10-30 10:05:46 -0700474 Remember to also check /proc/sys/net/core/somaxconn
475 A SYN_RECV request socket consumes about 304 bytes of memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800477tcp_max_tw_buckets - INTEGER
478 Maximal number of timewait sockets held by system simultaneously.
479 If this number is exceeded time-wait socket is immediately destroyed
480 and warning is printed. This limit exists only to prevent
481 simple DoS attacks, you _must_ not lower the limit artificially,
482 but rather increase it (probably, after increasing installed memory),
483 if network conditions require more than default value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800485tcp_mem - vector of 3 INTEGERs: min, pressure, max
486 min: below this number of pages TCP is not bothered about its
487 memory appetite.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800489 pressure: when amount of memory allocated by TCP exceeds this number
490 of pages, TCP moderates its memory consumption and enters memory
491 pressure mode, which is exited when memory consumption falls
492 under "min".
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800494 max: number of pages allowed for queueing by all TCP sockets.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800496 Defaults are calculated at boot time from amount of available
497 memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
Yuchung Chengf6722582015-10-16 21:57:42 -0700499tcp_min_rtt_wlen - INTEGER
500 The window length of the windowed min filter to track the minimum RTT.
501 A shorter window lets a flow more quickly pick up new (higher)
502 minimum RTT when it is moved to a longer path (e.g., due to traffic
503 engineering). A longer window makes the filter more resistant to RTT
504 inflations such as transient congestion. The unit is seconds.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200505
ZhangXiaoxu19fad202019-04-16 09:47:24 +0800506 Possible values: 0 - 86400 (1 day)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200507
Yuchung Chengf6722582015-10-16 21:57:42 -0700508 Default: 300
509
John Heffner71599cd2007-02-27 10:03:56 -0800510tcp_moderate_rcvbuf - BOOLEAN
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700511 If set, TCP performs receive buffer auto-tuning, attempting to
John Heffner71599cd2007-02-27 10:03:56 -0800512 automatically size the buffer (no greater than tcp_rmem[2]) to
513 match the size required by the path for full throughput. Enabled by
514 default.
515
516tcp_mtu_probing - INTEGER
517 Controls TCP Packetization-Layer Path MTU Discovery. Takes three
518 values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200519
520 - 0 - Disabled
521 - 1 - Disabled by default, enabled when an ICMP black hole detected
522 - 2 - Always enabled, use initial MSS of tcp_base_mss.
John Heffner71599cd2007-02-27 10:03:56 -0800523
Maciej Żenczykowskid4ce5802018-09-25 21:59:28 -0700524tcp_probe_interval - UNSIGNED INTEGER
Fan Dufab42762015-03-06 11:18:25 +0800525 Controls how often to start TCP Packetization-Layer Path MTU
526 Discovery reprobe. The default is reprobing every 10 minutes as
527 per RFC4821.
528
529tcp_probe_threshold - INTEGER
530 Controls when TCP Packetization-Layer Path MTU Discovery probing
531 will stop in respect to the width of search range in bytes. Default
532 is 8 bytes.
533
John Heffner71599cd2007-02-27 10:03:56 -0800534tcp_no_metrics_save - BOOLEAN
535 By default, TCP saves various connection metrics in the route cache
536 when the connection closes, so that connections established in the
537 near future can use these to set initial conditions. Usually, this
538 increases overall performance, but may sometimes cause performance
Simon Arlott0f035b82007-10-20 01:30:25 +0200539 degradation. If set, TCP will not cache metrics on closing
John Heffner71599cd2007-02-27 10:03:56 -0800540 connections.
541
Kevin(Yudong) Yang65e6d902019-12-09 14:19:59 -0500542tcp_no_ssthresh_metrics_save - BOOLEAN
543 Controls whether TCP saves ssthresh metrics in the route cache.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200544
Kevin(Yudong) Yang65e6d902019-12-09 14:19:59 -0500545 Default is 1, which disables ssthresh metrics.
546
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800547tcp_orphan_retries - INTEGER
Damian Lukowski5d789222009-09-01 10:24:04 +0000548 This value influences the timeout of a locally closed TCP connection,
549 when RTO retransmissions remain unacknowledged.
550 See tcp_retries2 for more details.
551
David S. Miller06b8fc52011-07-08 09:31:31 -0700552 The default value is 8.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200553
Damian Lukowski5d789222009-09-01 10:24:04 +0000554 If your machine is a loaded WEB server,
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800555 you should think about lowering this value, such sockets
556 may consume significant resources. Cf. tcp_max_orphans.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
Yuchung Cheng4f41b1c2015-10-16 21:57:47 -0700558tcp_recovery - INTEGER
559 This value is a bitmap to enable various experimental loss recovery
560 features.
561
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200562 ========= =============================================================
563 RACK: 0x1 enables the RACK loss detection for fast detection of lost
564 retransmissions and tail drops. It also subsumes and disables
565 RFC6675 recovery for SACK connections.
566
567 RACK: 0x2 makes RACK's reordering window static (min_rtt/4).
568
569 RACK: 0x4 disables RACK's DUPACK threshold heuristic
570 ========= =============================================================
Yuchung Cheng4f41b1c2015-10-16 21:57:47 -0700571
572 Default: 0x1
573
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574tcp_reordering - INTEGER
Eric Dumazetdca145f2014-10-27 21:45:24 -0700575 Initial reordering level of packets in a TCP stream.
576 TCP stack can then dynamically adjust flow reordering level
577 between this initial value and tcp_max_reordering
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200578
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000579 Default: 3
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
Eric Dumazetdca145f2014-10-27 21:45:24 -0700581tcp_max_reordering - INTEGER
582 Maximal reordering level of packets in a TCP stream.
583 300 is a fairly conservative value, but you might increase it
584 if paths are using per packet load balancing (like bonding rr mode)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200585
Eric Dumazetdca145f2014-10-27 21:45:24 -0700586 Default: 300
587
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588tcp_retrans_collapse - BOOLEAN
589 Bug-to-bug compatibility with some broken printers.
590 On retransmit try to send bigger packets to work around bugs in
591 certain TCP stacks.
592
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800593tcp_retries1 - INTEGER
Damian Lukowski5d789222009-09-01 10:24:04 +0000594 This value influences the time, after which TCP decides, that
595 something is wrong due to unacknowledged RTO retransmissions,
596 and reports this suspicion to the network layer.
597 See tcp_retries2 for more details.
598
599 RFC 1122 recommends at least 3 retransmissions, which is the
600 default.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800602tcp_retries2 - INTEGER
Damian Lukowski5d789222009-09-01 10:24:04 +0000603 This value influences the timeout of an alive TCP connection,
604 when RTO retransmissions remain unacknowledged.
605 Given a value of N, a hypothetical TCP connection following
606 exponential backoff with an initial RTO of TCP_RTO_MIN would
607 retransmit N times before killing the connection at the (N+1)th RTO.
608
609 The default value of 15 yields a hypothetical timeout of 924.6
610 seconds and is a lower bound for the effective timeout.
611 TCP will effectively time out at the first RTO which exceeds the
612 hypothetical timeout.
613
614 RFC 1122 recommends at least 100 seconds for the timeout,
615 which corresponds to a value of at least 8.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800617tcp_rfc1337 - BOOLEAN
618 If set, the TCP stack behaves conforming to RFC1337. If unset,
619 we are not conforming to RFC, but prevent TCP TIME_WAIT
620 assassination.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200621
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800622 Default: 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
624tcp_rmem - vector of 3 INTEGERs: min, default, max
625 min: Minimal size of receive buffer used by TCP sockets.
626 It is guaranteed to each TCP socket, even under moderate memory
627 pressure.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200628
Tonghao Zhanga61a86f2018-02-04 18:07:10 -0800629 Default: 4K
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
J. Bruce Fields53025f52008-07-10 16:47:41 -0700631 default: initial size of receive buffer used by TCP sockets.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 This value overrides net.core.rmem_default used by other protocols.
Eric Dumazet1d1be912021-02-10 09:13:33 -0800633 Default: 131072 bytes.
634 This value results in initial window of 65535.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
636 max: maximal size of receive buffer allowed for automatically
637 selected receiver buffers for TCP socket. This value does not override
J. Bruce Fields53025f52008-07-10 16:47:41 -0700638 net.core.rmem_max. Calling setsockopt() with SO_RCVBUF disables
639 automatic tuning of that socket's receive buffer size, in which
640 case this value is ignored.
Eric Dumazet1d1be912021-02-10 09:13:33 -0800641 Default: between 131072 and 6MB, depending on RAM size.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800643tcp_sack - BOOLEAN
644 Enable select acknowledgments (SACKS).
Rick Jones15d99e02006-03-20 22:40:29 -0800645
Eric Dumazet6d82aa22018-05-17 14:47:28 -0700646tcp_comp_sack_delay_ns - LONG INTEGER
647 TCP tries to reduce number of SACK sent, using a timer
648 based on 5% of SRTT, capped by this sysctl, in nano seconds.
649 The default is 1ms, based on TSO autosizing period.
650
651 Default : 1,000,000 ns (1 ms)
652
Eric Dumazeta70437c2020-04-30 10:35:43 -0700653tcp_comp_sack_slack_ns - LONG INTEGER
654 This sysctl control the slack used when arming the
655 timer used by SACK compression. This gives extra time
656 for small RTT flows, and reduces system overhead by allowing
657 opportunistic reduction of timer interrupts.
658
659 Default : 100,000 ns (100 us)
660
Eric Dumazet9c21d2f2018-05-17 14:47:29 -0700661tcp_comp_sack_nr - INTEGER
Masanari Iida2bcd9d82019-05-21 12:41:15 +0900662 Max number of SACK that can be compressed.
Eric Dumazet9c21d2f2018-05-17 14:47:29 -0700663 Using 0 disables SACK compression.
664
Masanari Iida2bcd9d82019-05-21 12:41:15 +0900665 Default : 44
Eric Dumazet9c21d2f2018-05-17 14:47:29 -0700666
David S. Miller35089bb2006-06-13 22:33:04 -0700667tcp_slow_start_after_idle - BOOLEAN
668 If set, provide RFC2861 behavior and time out the congestion
669 window after an idle period. An idle period is defined at
670 the current RTO. If unset, the congestion window will not
671 be timed out after an idle period.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200672
David S. Miller35089bb2006-06-13 22:33:04 -0700673 Default: 1
674
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800675tcp_stdurg - BOOLEAN
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700676 Use the Host requirements interpretation of the TCP urgent pointer field.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800677 Most hosts use the older BSD interpretation, so if you turn this on
678 Linux might not communicate correctly with them.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200679
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800680 Default: FALSE
681
682tcp_synack_retries - INTEGER
683 Number of times SYNACKs for a passive TCP connection attempt will
684 be retransmitted. Should not be higher than 255. Default value
Alex Bergmann6c9ff972012-08-31 02:48:31 +0000685 is 5, which corresponds to 31seconds till the last retransmission
686 with the current initial RTO of 1second. With this the final timeout
687 for a passive TCP connection will happen after 63seconds.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800688
David S. Millerd8513df2020-01-02 16:07:38 -0800689tcp_syncookies - INTEGER
Shan Weia3c910d2013-06-21 15:18:32 +0800690 Only valid when the kernel was compiled with CONFIG_SYN_COOKIES
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800691 Send out syncookies when the syn backlog queue of a socket
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700692 overflows. This is to prevent against the common 'SYN flood attack'
Shan Weia3c910d2013-06-21 15:18:32 +0800693 Default: 1
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800694
695 Note, that syncookies is fallback facility.
696 It MUST NOT be used to help highly loaded servers to stand
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700697 against legal connection rate. If you see SYN flood warnings
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800698 in your logs, but investigation shows that they occur
699 because of overload with legal connections, you should tune
700 another parameters until this warning disappear.
701 See: tcp_max_syn_backlog, tcp_synack_retries, tcp_abort_on_overflow.
702
703 syncookies seriously violate TCP protocol, do not allow
704 to use TCP extensions, can result in serious degradation
705 of some services (f.e. SMTP relaying), visible not by you,
706 but your clients and relays, contacting you. While you see
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700707 SYN flood warnings in logs not being really flooded, your server
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800708 is seriously misconfigured.
709
Hannes Frederic Sowa5ad37d52013-07-26 17:43:23 +0200710 If you want to test which effects syncookies have to your
711 network connections you can set this knob to 2 to enable
712 unconditionally generation of syncookies.
713
Yuchung Chengcf60af02012-07-19 06:43:09 +0000714tcp_fastopen - INTEGER
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700715 Enable TCP Fast Open (RFC7413) to send and accept data in the opening
716 SYN packet.
717
718 The client support is enabled by flag 0x1 (on by default). The client
719 then must use sendmsg() or sendto() with the MSG_FASTOPEN flag,
720 rather than connect() to send data in SYN.
721
722 The server support is enabled by flag 0x2 (off by default). Then
723 either enable for all listeners with another flag (0x400) or
724 enable individual listeners via TCP_FASTOPEN socket option with
725 the option value being the length of the syn-data backlog.
Yuchung Chengcf60af02012-07-19 06:43:09 +0000726
Jerry Chu10467162012-08-31 12:29:11 +0000727 The values (bitmap) are
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200728
729 ===== ======== ======================================================
730 0x1 (client) enables sending data in the opening SYN on the client.
731 0x2 (server) enables the server support, i.e., allowing data in
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700732 a SYN packet to be accepted and passed to the
733 application before 3-way handshake finishes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200734 0x4 (client) send data in the opening SYN regardless of cookie
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700735 availability and without a cookie option.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200736 0x200 (server) accept data-in-SYN w/o any cookie option present.
737 0x400 (server) enable all listeners to support Fast Open by
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700738 default without explicit TCP_FASTOPEN socket option.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200739 ===== ======== ======================================================
Yuchung Chengcf60af02012-07-19 06:43:09 +0000740
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700741 Default: 0x1
Yuchung Chengcf60af02012-07-19 06:43:09 +0000742
Randy Dunlapa7db3c72020-07-03 15:41:13 -0700743 Note that additional client or server features are only
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700744 effective if the basic support (0x1 and 0x2) are enabled respectively.
Jerry Chu10467162012-08-31 12:29:11 +0000745
Wei Wangcf1ef3f2017-04-20 14:45:46 -0700746tcp_fastopen_blackhole_timeout_sec - INTEGER
747 Initial time period in second to disable Fastopen on active TCP sockets
748 when a TFO firewall blackhole issue happens.
749 This time period will grow exponentially when more blackhole issues
750 get detected right after Fastopen is re-enabled and will reset to
751 initial value when the blackhole issue goes away.
Yuchung Cheng72685862017-12-12 13:10:40 -0800752 0 to disable the blackhole detection.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200753
Wei Wangcf1ef3f2017-04-20 14:45:46 -0700754 By default, it is set to 1hr.
755
Jason Baron2dc7e482019-05-29 12:34:00 -0400756tcp_fastopen_key - list of comma separated 32-digit hexadecimal INTEGERs
757 The list consists of a primary key and an optional backup key. The
758 primary key is used for both creating and validating cookies, while the
759 optional backup key is only used for validating cookies. The purpose of
760 the backup key is to maximize TFO validation when keys are rotated.
761
762 A randomly chosen primary key may be configured by the kernel if
763 the tcp_fastopen sysctl is set to 0x400 (see above), or if the
764 TCP_FASTOPEN setsockopt() optname is set and a key has not been
765 previously configured via sysctl. If keys are configured via
766 setsockopt() by using the TCP_FASTOPEN_KEY optname, then those
767 per-socket keys will be used instead of any keys that are specified via
768 sysctl.
769
770 A key is specified as 4 8-digit hexadecimal integers which are separated
771 by a '-' as: xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx. Leading zeros may be
772 omitted. A primary and a backup key may be specified by separating them
773 by a comma. If only one key is specified, it becomes the primary key and
774 any previously configured backup keys are removed.
775
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800776tcp_syn_retries - INTEGER
777 Number of times initial SYNs for an active TCP connection attempt
Xin Longbffae692016-01-20 16:12:33 +0800778 will be retransmitted. Should not be higher than 127. Default value
stephen hemminger3b09adc2013-01-03 07:50:29 +0000779 is 6, which corresponds to 63seconds till the last retransmission
Alex Bergmann6c9ff972012-08-31 02:48:31 +0000780 with the current initial RTO of 1second. With this the final timeout
781 for an active TCP connection attempt will happen after 127seconds.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800782
Florian Westphal25429d72016-12-01 11:32:07 +0100783tcp_timestamps - INTEGER
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200784 Enable timestamps as defined in RFC1323.
785
786 - 0: Disabled.
787 - 1: Enable timestamps as defined in RFC1323 and use random offset for
788 each connection rather than only using the current time.
789 - 2: Like 1, but without random offsets.
790
Florian Westphal25429d72016-12-01 11:32:07 +0100791 Default: 1
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800792
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700793tcp_min_tso_segs - INTEGER
794 Minimal number of segments per TSO frame.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200795
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700796 Since linux-3.12, TCP does an automatic sizing of TSO frames,
797 depending on flow rate, instead of filling 64Kbytes packets.
798 For specific usages, it's possible to force TCP to build big
799 TSO frames. Note that TCP stack might split too big TSO packets
800 if available window is too small.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200801
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700802 Default: 2
803
Eric Dumazet43e122b2015-08-21 17:38:02 -0700804tcp_pacing_ss_ratio - INTEGER
805 sk->sk_pacing_rate is set by TCP stack using a ratio applied
806 to current rate. (current_rate = cwnd * mss / srtt)
807 If TCP is in slow start, tcp_pacing_ss_ratio is applied
808 to let TCP probe for bigger speeds, assuming cwnd can be
809 doubled every other RTT.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200810
Eric Dumazet43e122b2015-08-21 17:38:02 -0700811 Default: 200
812
813tcp_pacing_ca_ratio - INTEGER
814 sk->sk_pacing_rate is set by TCP stack using a ratio applied
815 to current rate. (current_rate = cwnd * mss / srtt)
816 If TCP is in congestion avoidance phase, tcp_pacing_ca_ratio
817 is applied to conservatively probe for bigger throughput.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200818
Eric Dumazet43e122b2015-08-21 17:38:02 -0700819 Default: 120
820
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800821tcp_tso_win_divisor - INTEGER
822 This allows control over what percentage of the congestion window
823 can be consumed by a single TSO frame.
824 The setting of this parameter is a choice between burstiness and
825 building larger TSO frames.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200826
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800827 Default: 3
828
Maciej Żenczykowski79e9fed2018-06-03 10:41:17 -0700829tcp_tw_reuse - INTEGER
830 Enable reuse of TIME-WAIT sockets for new connections when it is
831 safe from protocol viewpoint.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200832
833 - 0 - disable
834 - 1 - global enable
835 - 2 - enable for loopback traffic only
836
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800837 It should not be changed without advice/request of technical
838 experts.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200839
Maciej Żenczykowski79e9fed2018-06-03 10:41:17 -0700840 Default: 2
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800841
842tcp_window_scaling - BOOLEAN
843 Enable window scaling as defined in RFC1323.
844
845tcp_wmem - vector of 3 INTEGERs: min, default, max
J. Bruce Fields53025f52008-07-10 16:47:41 -0700846 min: Amount of memory reserved for send buffers for TCP sockets.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800847 Each TCP socket has rights to use it due to fact of its birth.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200848
Tonghao Zhanga61a86f2018-02-04 18:07:10 -0800849 Default: 4K
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800850
J. Bruce Fields53025f52008-07-10 16:47:41 -0700851 default: initial size of send buffer used by TCP sockets. This
852 value overrides net.core.wmem_default used by other protocols.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200853
J. Bruce Fields53025f52008-07-10 16:47:41 -0700854 It is usually lower than net.core.wmem_default.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200855
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800856 Default: 16K
857
J. Bruce Fields53025f52008-07-10 16:47:41 -0700858 max: Maximal amount of memory allowed for automatically tuned
859 send buffers for TCP sockets. This value does not override
860 net.core.wmem_max. Calling setsockopt() with SO_SNDBUF disables
861 automatic tuning of that socket's send buffer size, in which case
862 this value is ignored.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200863
J. Bruce Fields53025f52008-07-10 16:47:41 -0700864 Default: between 64K and 4MB, depending on RAM size.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800865
Eric Dumazetc9bee3b72013-07-22 20:27:07 -0700866tcp_notsent_lowat - UNSIGNED INTEGER
867 A TCP socket can control the amount of unsent bytes in its write queue,
868 thanks to TCP_NOTSENT_LOWAT socket option. poll()/select()/epoll()
869 reports POLLOUT events if the amount of unsent bytes is below a per
870 socket value, and if the write queue is not full. sendmsg() will
871 also not add new buffers if the limit is hit.
872
873 This global variable controls the amount of unsent data for
874 sockets not using TCP_NOTSENT_LOWAT. For these sockets, a change
875 to the global variable has immediate effect.
876
877 Default: UINT_MAX (0xFFFFFFFF)
878
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800879tcp_workaround_signed_windows - BOOLEAN
880 If set, assume no receipt of a window scaling option means the
881 remote TCP is broken and treats the window as a signed quantity.
882 If unset, assume the remote TCP is not broken even if we do
883 not receive a window scaling option from them.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200884
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800885 Default: 0
886
Andreas Petlund36e31b0a2010-02-18 02:47:01 +0000887tcp_thin_linear_timeouts - BOOLEAN
888 Enable dynamic triggering of linear timeouts for thin streams.
889 If set, a check is performed upon retransmission by timeout to
890 determine if the stream is thin (less than 4 packets in flight).
891 As long as the stream is found to be thin, up to 6 linear
892 timeouts may be performed before exponential backoff mode is
893 initiated. This improves retransmission latency for
894 non-aggressive thin streams, often found to be time-dependent.
895 For more information on thin streams, see
Mauro Carvalho Chehabff159f42020-04-30 18:04:29 +0200896 Documentation/networking/tcp-thin.rst
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200897
Andreas Petlund36e31b0a2010-02-18 02:47:01 +0000898 Default: 0
899
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000900tcp_limit_output_bytes - INTEGER
901 Controls TCP Small Queue limit per tcp socket.
902 TCP bulk sender tends to increase packets in flight until it
903 gets losses notifications. With SNDBUF autotuning, this can
Flavio Leitner9c4c3252018-06-27 10:34:26 -0300904 result in a large amount of packets queued on the local machine
905 (e.g.: qdiscs, CPU backlog, or device) hurting latency of other
906 flows, for typical pfifo_fast qdiscs. tcp_limit_output_bytes
907 limits the number of bytes on qdisc or device to reduce artificial
908 RTT/cwnd and reduce bufferbloat.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200909
Eric Dumazetc73e5802018-11-11 07:34:28 -0800910 Default: 1048576 (16 * 65536)
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000911
Eric Dumazet282f23c2012-07-17 10:13:05 +0200912tcp_challenge_ack_limit - INTEGER
913 Limits number of Challenge ACK sent per second, as recommended
914 in RFC 5961 (Improving TCP's Robustness to Blind In-Window Attacks)
Cambda Zhu53099602020-04-15 17:54:04 +0800915 Default: 1000
Eric Dumazet282f23c2012-07-17 10:13:05 +0200916
Eric Dumazetede61ca2019-06-14 16:22:19 -0700917tcp_rx_skb_cache - BOOLEAN
918 Controls a per TCP socket cache of one skb, that might help
919 performance of some workloads. This might be dangerous
920 on systems with a lot of TCP sockets, since it increases
921 memory usage.
922
923 Default: 0 (disabled)
924
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200925UDP variables
926=============
Hideo Aoki95766ff2007-12-31 00:29:24 -0800927
Robert Shearman63a6fff2017-01-26 18:02:24 +0000928udp_l3mdev_accept - BOOLEAN
929 Enabling this option allows a "global" bound socket to work
930 across L3 master domains (e.g., VRFs) with packets capable of
931 being received regardless of the L3 domain in which they
932 originated. Only valid when the kernel was compiled with
933 CONFIG_NET_L3_MASTER_DEV.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200934
935 Default: 0 (disabled)
Robert Shearman63a6fff2017-01-26 18:02:24 +0000936
Hideo Aoki95766ff2007-12-31 00:29:24 -0800937udp_mem - vector of 3 INTEGERs: min, pressure, max
938 Number of pages allowed for queueing by all UDP sockets.
939
940 min: Below this number of pages UDP is not bothered about its
941 memory appetite. When amount of memory allocated by UDP exceeds
942 this number, UDP starts to moderate memory usage.
943
944 pressure: This value was introduced to follow format of tcp_mem.
945
946 max: Number of pages allowed for queueing by all UDP sockets.
947
948 Default is calculated at boot time from amount of available memory.
949
950udp_rmem_min - INTEGER
951 Minimal size of receive buffer used by UDP sockets in moderation.
952 Each UDP socket is able to use the size for receiving data, even if
953 total pages of UDP sockets exceed udp_mem pressure. The unit is byte.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200954
Tonghao Zhang320bd6d2018-03-13 21:57:17 -0700955 Default: 4K
Hideo Aoki95766ff2007-12-31 00:29:24 -0800956
957udp_wmem_min - INTEGER
958 Minimal size of send buffer used by UDP sockets in moderation.
959 Each UDP socket is able to use the size for sending data, even if
960 total pages of UDP sockets exceed udp_mem pressure. The unit is byte.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200961
Tonghao Zhang320bd6d2018-03-13 21:57:17 -0700962 Default: 4K
Hideo Aoki95766ff2007-12-31 00:29:24 -0800963
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200964RAW variables
965=============
Mike Manning68974452018-11-07 15:36:05 +0000966
967raw_l3mdev_accept - BOOLEAN
968 Enabling this option allows a "global" bound socket to work
969 across L3 master domains (e.g., VRFs) with packets capable of
970 being received regardless of the L3 domain in which they
971 originated. Only valid when the kernel was compiled with
972 CONFIG_NET_L3_MASTER_DEV.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200973
Mike Manning68974452018-11-07 15:36:05 +0000974 Default: 1 (enabled)
975
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200976CIPSOv4 Variables
977=================
Paul Moore8802f612006-08-03 16:45:49 -0700978
979cipso_cache_enable - BOOLEAN
980 If set, enable additions to and lookups from the CIPSO label mapping
981 cache. If unset, additions are ignored and lookups always result in a
982 miss. However, regardless of the setting the cache is still
983 invalidated when required when means you can safely toggle this on and
984 off and the cache will always be "safe".
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200985
Paul Moore8802f612006-08-03 16:45:49 -0700986 Default: 1
987
988cipso_cache_bucket_size - INTEGER
989 The CIPSO label cache consists of a fixed size hash table with each
990 hash bucket containing a number of cache entries. This variable limits
991 the number of entries in each hash bucket; the larger the value the
992 more CIPSO label mappings that can be cached. When the number of
993 entries in a given hash bucket reaches this limit adding new entries
994 causes the oldest entry in the bucket to be removed to make room.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200995
Paul Moore8802f612006-08-03 16:45:49 -0700996 Default: 10
997
998cipso_rbm_optfmt - BOOLEAN
999 Enable the "Optimized Tag 1 Format" as defined in section 3.4.2.6 of
1000 the CIPSO draft specification (see Documentation/netlabel for details).
1001 This means that when set the CIPSO tag will be padded with empty
1002 categories in order to make the packet data 32-bit aligned.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001003
Paul Moore8802f612006-08-03 16:45:49 -07001004 Default: 0
1005
1006cipso_rbm_structvalid - BOOLEAN
1007 If set, do a very strict check of the CIPSO option when
1008 ip_options_compile() is called. If unset, relax the checks done during
1009 ip_options_compile(). Either way is "safe" as errors are caught else
1010 where in the CIPSO processing code but setting this to 0 (False) should
1011 result in less work (i.e. it should be faster) but could cause problems
1012 with other implementations that require strict checking.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001013
Paul Moore8802f612006-08-03 16:45:49 -07001014 Default: 0
1015
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001016IP Variables
1017============
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018
1019ip_local_port_range - 2 INTEGERS
1020 Defines the local port range that is used by TCP and UDP to
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001021 choose the local port. The first number is the first, the
Eric Dumazet07f4c902015-05-24 14:49:35 -07001022 second the last local port number.
Maciej Żenczykowskiac716762019-11-25 14:48:00 -08001023 If possible, it is better these numbers have different parity
1024 (one even and one odd value).
1025 Must be greater than or equal to ip_unprivileged_port_start.
Eric Dumazet07f4c902015-05-24 14:49:35 -07001026 The default values are 32768 and 60999 respectively.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027
Amerigo Wange3826f12010-05-05 00:27:06 +00001028ip_local_reserved_ports - list of comma separated ranges
1029 Specify the ports which are reserved for known third-party
1030 applications. These ports will not be used by automatic port
1031 assignments (e.g. when calling connect() or bind() with port
1032 number 0). Explicit port allocation behavior is unchanged.
1033
1034 The format used for both input and output is a comma separated
1035 list of ranges (e.g. "1,2-4,10-10" for ports 1, 2, 3, 4 and
1036 10). Writing to the file will clear all previously reserved
1037 ports and update the current list with the one given in the
1038 input.
1039
1040 Note that ip_local_port_range and ip_local_reserved_ports
1041 settings are independent and both are considered by the kernel
1042 when determining which ports are available for automatic port
1043 assignments.
1044
1045 You can reserve ports which are not in the current
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001046 ip_local_port_range, e.g.::
Amerigo Wange3826f12010-05-05 00:27:06 +00001047
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001048 $ cat /proc/sys/net/ipv4/ip_local_port_range
1049 32000 60999
1050 $ cat /proc/sys/net/ipv4/ip_local_reserved_ports
1051 8080,9148
Amerigo Wange3826f12010-05-05 00:27:06 +00001052
1053 although this is redundant. However such a setting is useful
1054 if later the port range is changed to a value that will
1055 include the reserved ports.
1056
1057 Default: Empty
1058
Krister Johansen4548b682017-01-20 17:49:11 -08001059ip_unprivileged_port_start - INTEGER
1060 This is a per-namespace sysctl. It defines the first
1061 unprivileged port in the network namespace. Privileged ports
1062 require root or CAP_NET_BIND_SERVICE in order to bind to them.
Maciej Żenczykowskiac716762019-11-25 14:48:00 -08001063 To disable all privileged ports, set this to 0. They must not
1064 overlap with the ip_local_port_range.
Krister Johansen4548b682017-01-20 17:49:11 -08001065
1066 Default: 1024
1067
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068ip_nonlocal_bind - BOOLEAN
1069 If set, allows processes to bind() to non-local IP addresses,
1070 which can be quite useful - but may break some applications.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001071
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 Default: 0
1073
Kuniyuki Iwashima4b01a962020-03-10 17:05:25 +09001074ip_autobind_reuse - BOOLEAN
1075 By default, bind() does not select the ports automatically even if
1076 the new socket and all sockets bound to the port have SO_REUSEADDR.
1077 ip_autobind_reuse allows bind() to reuse the port and this is useful
1078 when you use bind()+connect(), but may break some applications.
1079 The preferred solution is to use IP_BIND_ADDRESS_NO_PORT and this
1080 option should only be set by experts.
1081 Default: 0
1082
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083ip_dynaddr - BOOLEAN
1084 If set non-zero, enables support for dynamic addresses.
1085 If set to a non-zero value larger than 1, a kernel log
1086 message will be printed when dynamic address rewriting
1087 occurs.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001088
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 Default: 0
1090
Cong Wange3d73bc2013-06-11 18:54:39 +08001091ip_early_demux - BOOLEAN
1092 Optimize input packet processing down to one demux for
1093 certain kinds of local sockets. Currently we only do this
subashab@codeaurora.orgdddb64b2017-03-23 13:34:16 -06001094 for established TCP and connected UDP sockets.
Cong Wange3d73bc2013-06-11 18:54:39 +08001095
1096 It may add an additional cost for pure routing workloads that
1097 reduces overall throughput, in such case you should disable it.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001098
Cong Wange3d73bc2013-06-11 18:54:39 +08001099 Default: 1
1100
Stephen Hemminger5cc4adb2020-04-21 13:34:48 -07001101ping_group_range - 2 INTEGERS
1102 Restrict ICMP_PROTO datagram sockets to users in the group range.
1103 The default is "1 0", meaning, that nobody (not even root) may
1104 create ping sockets. Setting it to "100 100" would grant permissions
1105 to the single group. "0 4294967295" would enable it for the world, "100
1106 4294967295" would enable it for the users, but not daemons.
1107
subashab@codeaurora.orgdddb64b2017-03-23 13:34:16 -06001108tcp_early_demux - BOOLEAN
1109 Enable early demux for established TCP sockets.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001110
subashab@codeaurora.orgdddb64b2017-03-23 13:34:16 -06001111 Default: 1
1112
1113udp_early_demux - BOOLEAN
1114 Enable early demux for connected UDP sockets. Disable this if
1115 your system could experience more unconnected load.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001116
subashab@codeaurora.orgdddb64b2017-03-23 13:34:16 -06001117 Default: 1
1118
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119icmp_echo_ignore_all - BOOLEAN
David S. Miller7ce312462005-10-03 16:07:30 -07001120 If set non-zero, then the kernel will ignore all ICMP ECHO
1121 requests sent to it.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001122
David S. Miller7ce312462005-10-03 16:07:30 -07001123 Default: 0
1124
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125icmp_echo_ignore_broadcasts - BOOLEAN
David S. Miller7ce312462005-10-03 16:07:30 -07001126 If set non-zero, then the kernel will ignore all ICMP ECHO and
1127 TIMESTAMP requests sent to it via broadcast/multicast.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001128
David S. Miller7ce312462005-10-03 16:07:30 -07001129 Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130
1131icmp_ratelimit - INTEGER
1132 Limit the maximal rates for sending ICMP packets whose type matches
1133 icmp_ratemask (see below) to specific targets.
Stephen Hemminger6dbf4bc2008-07-01 19:29:07 -07001134 0 to disable any limiting,
1135 otherwise the minimal space between responses in milliseconds.
Eric Dumazet4cdf5072014-09-19 07:38:40 -07001136 Note that another sysctl, icmp_msgs_per_sec limits the number
1137 of ICMP packets sent on all targets.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001138
Stephen Hemminger6dbf4bc2008-07-01 19:29:07 -07001139 Default: 1000
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140
Eric Dumazet4cdf5072014-09-19 07:38:40 -07001141icmp_msgs_per_sec - INTEGER
1142 Limit maximal number of ICMP packets sent per second from this host.
1143 Only messages whose type matches icmp_ratemask (see below) are
Eric Dumazetb38e7812020-10-15 11:42:00 -07001144 controlled by this limit. For security reasons, the precise count
1145 of messages per second is randomized.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001146
Eric Dumazet4cdf5072014-09-19 07:38:40 -07001147 Default: 1000
1148
1149icmp_msgs_burst - INTEGER
1150 icmp_msgs_per_sec controls number of ICMP packets sent per second,
1151 while icmp_msgs_burst controls the burst size of these packets.
Eric Dumazetb38e7812020-10-15 11:42:00 -07001152 For security reasons, the precise burst size is randomized.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001153
Eric Dumazet4cdf5072014-09-19 07:38:40 -07001154 Default: 50
1155
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156icmp_ratemask - INTEGER
1157 Mask made of ICMP types for which rates are being limited.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001158
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 Significant bits: IHGFEDCBA9876543210
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001160
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 Default mask: 0000001100000011000 (6168)
1162
1163 Bit definitions (see include/linux/icmp.h):
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001164
1165 = =========================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 0 Echo Reply
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001167 3 Destination Unreachable [1]_
1168 4 Source Quench [1]_
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169 5 Redirect
1170 8 Echo Request
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001171 B Time Exceeded [1]_
1172 C Parameter Problem [1]_
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 D Timestamp Request
1174 E Timestamp Reply
1175 F Info Request
1176 G Info Reply
1177 H Address Mask Request
1178 I Address Mask Reply
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001179 = =========================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001181 .. [1] These are rate limited by default (see default mask above)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182
1183icmp_ignore_bogus_error_responses - BOOLEAN
1184 Some routers violate RFC1122 by sending bogus responses to broadcast
1185 frames. Such violations are normally logged via a kernel warning.
1186 If this is set to TRUE, the kernel will not give such warnings, which
1187 will avoid log file clutter.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001188
Rami Rosene8b265e2013-06-07 20:16:19 +00001189 Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190
Horms95f7daf2006-02-02 17:02:25 -08001191icmp_errors_use_inbound_ifaddr - BOOLEAN
1192
Paolo Abeni02a6d612015-10-14 14:25:53 +02001193 If zero, icmp error messages are sent with the primary address of
1194 the exiting interface.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001195
Horms95f7daf2006-02-02 17:02:25 -08001196 If non-zero, the message will be sent with the primary address of
1197 the interface that received the packet that caused the icmp error.
Vincent Bernat31628202021-01-30 20:05:18 +01001198 This is the behaviour many network administrators will expect from
Horms95f7daf2006-02-02 17:02:25 -08001199 a router. And it can make debugging complicated network layouts
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001200 much easier.
Horms95f7daf2006-02-02 17:02:25 -08001201
1202 Note that if no primary address exists for the interface selected,
1203 then the primary address of the first non-loopback interface that
Matt LaPlanted6bc8ac2006-10-03 22:54:15 +02001204 has one will be used regardless of this setting.
Horms95f7daf2006-02-02 17:02:25 -08001205
1206 Default: 0
1207
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208igmp_max_memberships - INTEGER
1209 Change the maximum number of multicast groups we can subscribe to.
1210 Default: 20
1211
Jeremy Ederd67ef352010-11-15 05:41:31 +00001212 Theoretical maximum value is bounded by having to send a membership
1213 report in a single datagram (i.e. the report can't span multiple
1214 datagrams, or risk confusing the switch and leaving groups you don't
1215 intend to).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216
Jeremy Ederd67ef352010-11-15 05:41:31 +00001217 The number of supported groups 'M' is bounded by the number of group
1218 report entries you can fit into a single datagram of 65535 bytes.
1219
1220 M = 65536-sizeof (ip header)/(sizeof(Group record))
1221
1222 Group records are variable length, with a minimum of 12 bytes.
1223 So net.ipv4.igmp_max_memberships should not be set higher than:
1224
1225 (65536-24) / 12 = 5459
1226
1227 The value 5459 assumes no IP header options, so in practice
1228 this number may be lower.
1229
Benjamin Poirier537377d2016-03-21 13:21:40 -07001230igmp_max_msf - INTEGER
1231 Maximum number of addresses allowed in the source filter list for a
1232 multicast group.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001233
Benjamin Poirier537377d2016-03-21 13:21:40 -07001234 Default: 10
1235
Hannes Frederic Sowaa9fe8e22014-09-02 15:49:26 +02001236igmp_qrv - INTEGER
Benjamin Poirier537377d2016-03-21 13:21:40 -07001237 Controls the IGMP query robustness variable (see RFC2236 8.1).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001238
Benjamin Poirier537377d2016-03-21 13:21:40 -07001239 Default: 2 (as specified by RFC2236 8.1)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001240
Benjamin Poirier537377d2016-03-21 13:21:40 -07001241 Minimum: 1 (as specified by RFC6636 4.5)
Hannes Frederic Sowaa9fe8e22014-09-02 15:49:26 +02001242
Hangbin Liu1af92832016-11-07 14:51:23 +08001243force_igmp_version - INTEGER
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001244 - 0 - (default) No enforcement of a IGMP version, IGMPv1/v2 fallback
1245 allowed. Will back to IGMPv3 mode again if all IGMPv1/v2 Querier
1246 Present timer expires.
1247 - 1 - Enforce to use IGMP version 1. Will also reply IGMPv1 report if
1248 receive IGMPv2/v3 query.
1249 - 2 - Enforce to use IGMP version 2. Will fallback to IGMPv1 if receive
1250 IGMPv1 query message. Will reply report if receive IGMPv3 query.
1251 - 3 - Enforce to use IGMP version 3. The same react with default 0.
Hangbin Liu1af92832016-11-07 14:51:23 +08001252
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001253 .. note::
Hangbin Liu1af92832016-11-07 14:51:23 +08001254
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001255 this is not the same with force_mld_version because IGMPv3 RFC3376
1256 Security Considerations does not have clear description that we could
1257 ignore other version messages completely as MLDv2 RFC3810. So make
1258 this value as default 0 is recommended.
Benjamin Poirier6b226e22016-03-21 13:21:39 -07001259
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001260``conf/interface/*``
1261 changes special settings per interface (where
1262 interface" is the name of your network interface)
1263
1264``conf/all/*``
1265 is special, changes the settings for all interfaces
Benjamin Poirier6b226e22016-03-21 13:21:39 -07001266
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267log_martians - BOOLEAN
1268 Log packets with impossible addresses to kernel log.
1269 log_martians for the interface will be enabled if at least one of
1270 conf/{all,interface}/log_martians is set to TRUE,
1271 it will be disabled otherwise
1272
1273accept_redirects - BOOLEAN
1274 Accept ICMP redirect messages.
1275 accept_redirects for the interface will be enabled if:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001276
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001277 - both conf/{all,interface}/accept_redirects are TRUE in the case
1278 forwarding for the interface is enabled
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001279
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 or
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001281
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001282 - at least one of conf/{all,interface}/accept_redirects is TRUE in the
1283 case forwarding for the interface is disabled
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001284
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 accept_redirects for the interface will be disabled otherwise
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001286
1287 default:
1288
1289 - TRUE (host)
1290 - FALSE (router)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291
1292forwarding - BOOLEAN
Neil Jerram88a7cdd2017-03-10 12:24:57 +00001293 Enable IP forwarding on this interface. This controls whether packets
1294 received _on_ this interface can be forwarded.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295
1296mc_forwarding - BOOLEAN
1297 Do multicast routing. The kernel needs to be compiled with CONFIG_MROUTE
1298 and a multicast routing daemon is required.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001299 conf/all/mc_forwarding must also be set to TRUE to enable multicast
1300 routing for the interface
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301
1302medium_id - INTEGER
1303 Integer value used to differentiate the devices by the medium they
1304 are attached to. Two devices can have different id values when
1305 the broadcast packets are received only on one of them.
1306 The default value 0 means that the device is the only interface
1307 to its medium, value of -1 means that medium is not known.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001308
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 Currently, it is used to change the proxy_arp behavior:
1310 the proxy_arp feature is enabled for packets forwarded between
1311 two devices attached to different media.
1312
1313proxy_arp - BOOLEAN
1314 Do proxy arp.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001315
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 proxy_arp for the interface will be enabled if at least one of
1317 conf/{all,interface}/proxy_arp is set to TRUE,
1318 it will be disabled otherwise
1319
Jesper Dangaard Brouer65324142010-01-05 05:50:47 +00001320proxy_arp_pvlan - BOOLEAN
1321 Private VLAN proxy arp.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001322
Jesper Dangaard Brouer65324142010-01-05 05:50:47 +00001323 Basically allow proxy arp replies back to the same interface
1324 (from which the ARP request/solicitation was received).
1325
1326 This is done to support (ethernet) switch features, like RFC
1327 3069, where the individual ports are NOT allowed to
1328 communicate with each other, but they are allowed to talk to
1329 the upstream router. As described in RFC 3069, it is possible
1330 to allow these hosts to communicate through the upstream
1331 router by proxy_arp'ing. Don't need to be used together with
1332 proxy_arp.
1333
1334 This technology is known by different names:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001335
Jesper Dangaard Brouer65324142010-01-05 05:50:47 +00001336 In RFC 3069 it is called VLAN Aggregation.
1337 Cisco and Allied Telesyn call it Private VLAN.
1338 Hewlett-Packard call it Source-Port filtering or port-isolation.
1339 Ericsson call it MAC-Forced Forwarding (RFC Draft).
1340
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341shared_media - BOOLEAN
1342 Send(router) or accept(host) RFC1620 shared media redirects.
Eric Garver176b3462016-05-26 12:28:05 -04001343 Overrides secure_redirects.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001344
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 shared_media for the interface will be enabled if at least one of
1346 conf/{all,interface}/shared_media is set to TRUE,
1347 it will be disabled otherwise
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001348
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 default TRUE
1350
1351secure_redirects - BOOLEAN
Eric Garver176b3462016-05-26 12:28:05 -04001352 Accept ICMP redirect messages only to gateways listed in the
1353 interface's current gateway list. Even if disabled, RFC1122 redirect
1354 rules still apply.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001355
Eric Garver176b3462016-05-26 12:28:05 -04001356 Overridden by shared_media.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001357
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 secure_redirects for the interface will be enabled if at least one of
1359 conf/{all,interface}/secure_redirects is set to TRUE,
1360 it will be disabled otherwise
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001361
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 default TRUE
1363
1364send_redirects - BOOLEAN
1365 Send redirects, if router.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001366
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 send_redirects for the interface will be enabled if at least one of
1368 conf/{all,interface}/send_redirects is set to TRUE,
1369 it will be disabled otherwise
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001370
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 Default: TRUE
1372
1373bootp_relay - BOOLEAN
1374 Accept packets with source address 0.b.c.d destined
1375 not to this host as local ones. It is supposed, that
1376 BOOTP relay daemon will catch and forward such packets.
1377 conf/all/bootp_relay must also be set to TRUE to enable BOOTP relay
1378 for the interface
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001379
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 default FALSE
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001381
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 Not Implemented Yet.
1383
1384accept_source_route - BOOLEAN
1385 Accept packets with SRR option.
1386 conf/all/accept_source_route must also be set to TRUE to accept packets
1387 with SRR option on the interface
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001388
1389 default
1390
1391 - TRUE (router)
1392 - FALSE (host)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393
Patrick McHardy8153a102009-12-03 01:25:58 +00001394accept_local - BOOLEAN
Sébastien Barré72b126a2014-09-10 18:20:23 +02001395 Accept packets with local source addresses. In combination with
1396 suitable routing, this can be used to direct packets between two
1397 local interfaces over the wire and have them accepted properly.
Patrick McHardy8153a102009-12-03 01:25:58 +00001398 default FALSE
1399
Thomas Grafd0daebc32012-06-12 00:44:01 +00001400route_localnet - BOOLEAN
1401 Do not consider loopback addresses as martian source or destination
1402 while routing. This enables the use of 127/8 for local routing purposes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001403
Thomas Grafd0daebc32012-06-12 00:44:01 +00001404 default FALSE
1405
Stephen Hemmingerc1cf8422009-02-20 08:25:36 +00001406rp_filter - INTEGER
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001407 - 0 - No source validation.
1408 - 1 - Strict mode as defined in RFC3704 Strict Reverse Path
1409 Each incoming packet is tested against the FIB and if the interface
1410 is not the best reverse path the packet check will fail.
1411 By default failed packets are discarded.
1412 - 2 - Loose mode as defined in RFC3704 Loose Reverse Path
1413 Each incoming packet's source address is also tested against the FIB
1414 and if the source address is not reachable via any interface
1415 the packet check will fail.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001417 Current recommended practice in RFC3704 is to enable strict mode
Jesper Dangaard Brouerbf869c32009-02-23 04:37:55 +00001418 to prevent IP spoofing from DDos attacks. If using asymmetric routing
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001419 or other complicated routing, then loose mode is recommended.
Stephen Hemmingerc1cf8422009-02-20 08:25:36 +00001420
Shan Wei1f5865e2009-12-02 15:39:04 -08001421 The max value from conf/{all,interface}/rp_filter is used
1422 when doing source validation on the {interface}.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423
1424 Default value is 0. Note that some distributions enable it
1425 in startup scripts.
1426
1427arp_filter - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001428 - 1 - Allows you to have multiple network interfaces on the same
1429 subnet, and have the ARPs for each interface be answered
1430 based on whether or not the kernel would route a packet from
1431 the ARP'd IP out that interface (therefore you must use source
1432 based routing for this to work). In other words it allows control
1433 of which cards (usually 1) will respond to an arp request.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001435 - 0 - (default) The kernel can respond to arp requests with addresses
1436 from other interfaces. This may seem wrong but it usually makes
1437 sense, because it increases the chance of successful communication.
1438 IP addresses are owned by the complete host on Linux, not by
1439 particular interfaces. Only for more complex setups like load-
1440 balancing, does this behaviour cause problems.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441
1442 arp_filter for the interface will be enabled if at least one of
1443 conf/{all,interface}/arp_filter is set to TRUE,
1444 it will be disabled otherwise
1445
1446arp_announce - INTEGER
1447 Define different restriction levels for announcing the local
1448 source IP address from IP packets in ARP requests sent on
1449 interface:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001450
1451 - 0 - (default) Use any local address, configured on any interface
1452 - 1 - Try to avoid local addresses that are not in the target's
1453 subnet for this interface. This mode is useful when target
1454 hosts reachable via this interface require the source IP
1455 address in ARP requests to be part of their logical network
1456 configured on the receiving interface. When we generate the
1457 request we will check all our subnets that include the
1458 target IP and will preserve the source address if it is from
1459 such subnet. If there is no such subnet we select source
1460 address according to the rules for level 2.
1461 - 2 - Always use the best local address for this target.
1462 In this mode we ignore the source address in the IP packet
1463 and try to select local address that we prefer for talks with
1464 the target host. Such local address is selected by looking
1465 for primary IP addresses on all our subnets on the outgoing
1466 interface that include the target IP address. If no suitable
1467 local address is found we select the first local address
1468 we have on the outgoing interface or on all other interfaces,
1469 with the hope we will receive reply for our request and
1470 even sometimes no matter the source IP address we announce.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471
1472 The max value from conf/{all,interface}/arp_announce is used.
1473
1474 Increasing the restriction level gives more chance for
1475 receiving answer from the resolved target while decreasing
1476 the level announces more valid sender's information.
1477
1478arp_ignore - INTEGER
1479 Define different modes for sending replies in response to
1480 received ARP requests that resolve local target IP addresses:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001481
1482 - 0 - (default): reply for any local target IP address, configured
1483 on any interface
1484 - 1 - reply only if the target IP address is local address
1485 configured on the incoming interface
1486 - 2 - reply only if the target IP address is local address
1487 configured on the incoming interface and both with the
1488 sender's IP address are part from same subnet on this interface
1489 - 3 - do not reply for local addresses configured with scope host,
1490 only resolutions for global and link addresses are replied
1491 - 4-7 - reserved
1492 - 8 - do not reply for all local addresses
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493
1494 The max value from conf/{all,interface}/arp_ignore is used
1495 when ARP request is received on the {interface}
1496
Stephen Hemmingereefef1c2009-02-01 01:04:33 -08001497arp_notify - BOOLEAN
1498 Define mode for notification of address and device changes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001499
1500 == ==========================================================
1501 0 (default): do nothing
1502 1 Generate gratuitous arp requests when device is brought up
1503 or hardware address changes.
1504 == ==========================================================
Stephen Hemmingereefef1c2009-02-01 01:04:33 -08001505
Neil Hormanc1b1bce2006-03-20 22:40:03 -08001506arp_accept - BOOLEAN
Octavian Purdila6d955182010-01-18 12:58:44 +00001507 Define behavior for gratuitous ARP frames who's IP is not
1508 already present in the ARP table:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001509
1510 - 0 - don't create new entries in the ARP table
1511 - 1 - create new entries in the ARP table
Octavian Purdila6d955182010-01-18 12:58:44 +00001512
1513 Both replies and requests type gratuitous arp will trigger the
1514 ARP table to be updated, if this setting is on.
1515
1516 If the ARP table already contains the IP address of the
1517 gratuitous arp frame, the arp table will be updated regardless
1518 if this setting is on or off.
1519
YOSHIFUJI Hideaki/吉藤英明89c69d32015-03-19 22:42:04 +09001520mcast_solicit - INTEGER
1521 The maximum number of multicast probes in INCOMPLETE state,
1522 when the associated hardware address is unknown. Defaults
1523 to 3.
1524
1525ucast_solicit - INTEGER
1526 The maximum number of unicast probes in PROBE state, when
1527 the hardware address is being reconfirmed. Defaults to 3.
Neil Hormanc1b1bce2006-03-20 22:40:03 -08001528
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529app_solicit - INTEGER
1530 The maximum number of probes to send to the user space ARP daemon
1531 via netlink before dropping back to multicast probes (see
YOSHIFUJI Hideaki/吉藤英明89c69d32015-03-19 22:42:04 +09001532 mcast_resolicit). Defaults to 0.
1533
1534mcast_resolicit - INTEGER
1535 The maximum number of multicast probes after unicast and
1536 app probes in PROBE state. Defaults to 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537
1538disable_policy - BOOLEAN
1539 Disable IPSEC policy (SPD) for this interface
1540
1541disable_xfrm - BOOLEAN
1542 Disable IPSEC encryption on this interface, whatever the policy
1543
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02001544igmpv2_unsolicited_report_interval - INTEGER
1545 The interval in milliseconds in which the next unsolicited
1546 IGMPv1 or IGMPv2 report retransmit will take place.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001547
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02001548 Default: 10000 (10 seconds)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02001550igmpv3_unsolicited_report_interval - INTEGER
1551 The interval in milliseconds in which the next unsolicited
1552 IGMPv3 report retransmit will take place.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001553
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02001554 Default: 1000 (1 seconds)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555
Vincent Bernatc0c5a602020-11-07 20:35:13 +01001556ignore_routes_with_linkdown - BOOLEAN
1557 Ignore routes whose link is down when performing a FIB lookup.
1558
Martin Schwenked922e1c2014-01-28 15:26:42 +11001559promote_secondaries - BOOLEAN
1560 When a primary IP address is removed from this interface
1561 promote a corresponding secondary IP address instead of
1562 removing all the corresponding secondary IP addresses.
1563
Johannes Berg12b74df2016-02-04 13:31:17 +01001564drop_unicast_in_l2_multicast - BOOLEAN
1565 Drop any unicast IP packets that are received in link-layer
1566 multicast (or broadcast) frames.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001567
Johannes Berg12b74df2016-02-04 13:31:17 +01001568 This behavior (for multicast) is actually a SHOULD in RFC
1569 1122, but is disabled by default for compatibility reasons.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001570
Johannes Berg12b74df2016-02-04 13:31:17 +01001571 Default: off (0)
1572
Johannes Berg97daf332016-02-04 13:31:18 +01001573drop_gratuitous_arp - BOOLEAN
1574 Drop all gratuitous ARP frames, for example if there's a known
1575 good ARP proxy on the network and such frames need not be used
1576 (or in the case of 802.11, must not be used to prevent attacks.)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001577
Johannes Berg97daf332016-02-04 13:31:18 +01001578 Default: off (0)
1579
Martin Schwenked922e1c2014-01-28 15:26:42 +11001580
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581tag - INTEGER
1582 Allows you to write a number, which can be used as required.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001583
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 Default value is 0.
1585
Alexander Duycke69948a2015-08-11 13:35:01 -07001586xfrm4_gc_thresh - INTEGER
Nicolas Dichtel837f7412019-04-09 17:16:59 +02001587 (Obsolete since linux-4.14)
Alexander Duycke69948a2015-08-11 13:35:01 -07001588 The threshold at which we will start garbage collecting for IPv4
1589 destination cache entries. At twice this value the system will
Florian Westphal3c2a89d2017-07-17 13:57:20 +02001590 refuse new allocations.
Alexander Duycke69948a2015-08-11 13:35:01 -07001591
Philip Downey87583eb2015-08-31 11:30:38 +01001592igmp_link_local_mcast_reports - BOOLEAN
1593 Enable IGMP reports for link local multicast groups in the
1594 224.0.0.X range.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001595
Philip Downey87583eb2015-08-31 11:30:38 +01001596 Default TRUE
1597
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598Alexey Kuznetsov.
1599kuznet@ms2.inr.ac.ru
1600
1601Updated by:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001602
1603- Andi Kleen
1604 ak@muc.de
1605- Nicolas Delon
1606 delon.nicolas@wanadoo.fr
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607
1608
1609
1610
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001611/proc/sys/net/ipv6/* Variables
1612==============================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613
1614IPv6 has no global variables such as tcp_*. tcp_* settings under ipv4/ also
1615apply to IPv6 [XXX?].
1616
1617bindv6only - BOOLEAN
1618 Default value for IPV6_V6ONLY socket option,
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001619 which restricts use of the IPv6 socket to IPv6 communication
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 only.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001621
1622 - TRUE: disable IPv4-mapped address feature
1623 - FALSE: enable IPv4-mapped address feature
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624
Geoffrey Thomasd5c073ca2011-08-22 11:28:57 -07001625 Default: FALSE (as specified in RFC3493)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626
Florent Fourcot6444f722014-01-17 17:15:05 +01001627flowlabel_consistency - BOOLEAN
1628 Protect the consistency (and unicity) of flow label.
1629 You have to disable it to use IPV6_FL_F_REFLECT flag on the
1630 flow label manager.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001631
1632 - TRUE: enabled
1633 - FALSE: disabled
1634
Florent Fourcot6444f722014-01-17 17:15:05 +01001635 Default: TRUE
1636
Tom Herbert42240902015-07-31 16:52:12 -07001637auto_flowlabels - INTEGER
1638 Automatically generate flow labels based on a flow hash of the
1639 packet. This allows intermediate devices, such as routers, to
1640 identify packet flows for mechanisms like Equal Cost Multipath
Tom Herbertcb1ce2e2014-07-01 21:33:10 -07001641 Routing (see RFC 6438).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001642
1643 = ===========================================================
1644 0 automatic flow labels are completely disabled
1645 1 automatic flow labels are enabled by default, they can be
Tom Herbert42240902015-07-31 16:52:12 -07001646 disabled on a per socket basis using the IPV6_AUTOFLOWLABEL
1647 socket option
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001648 2 automatic flow labels are allowed, they may be enabled on a
Tom Herbert42240902015-07-31 16:52:12 -07001649 per socket basis using the IPV6_AUTOFLOWLABEL socket option
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001650 3 automatic flow labels are enabled and enforced, they cannot
Tom Herbert42240902015-07-31 16:52:12 -07001651 be disabled by the socket option
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001652 = ===========================================================
1653
Tom Herbertb5677412015-07-31 16:52:14 -07001654 Default: 1
Tom Herbertcb1ce2e2014-07-01 21:33:10 -07001655
Tom Herbert82a584b2015-04-29 15:33:21 -07001656flowlabel_state_ranges - BOOLEAN
1657 Split the flow label number space into two ranges. 0-0x7FFFF is
1658 reserved for the IPv6 flow manager facility, 0x80000-0xFFFFF
1659 is reserved for stateless flow labels as described in RFC6437.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001660
1661 - TRUE: enabled
1662 - FALSE: disabled
1663
Tom Herbert82a584b2015-04-29 15:33:21 -07001664 Default: true
1665
Eric Dumazet323a53c2019-06-05 07:55:09 -07001666flowlabel_reflect - INTEGER
1667 Control flow label reflection. Needed for Path MTU
Jakub Sitnicki22b67222017-08-23 09:55:41 +02001668 Discovery to work with Equal Cost Multipath Routing in anycast
1669 environments. See RFC 7690 and:
1670 https://tools.ietf.org/html/draft-wang-6man-flow-label-reflection-01
Eric Dumazet323a53c2019-06-05 07:55:09 -07001671
Eric Dumazeta346abe2019-07-01 06:39:36 -07001672 This is a bitmask.
Eric Dumazet323a53c2019-06-05 07:55:09 -07001673
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001674 - 1: enabled for established flows
Eric Dumazet323a53c2019-06-05 07:55:09 -07001675
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001676 Note that this prevents automatic flowlabel changes, as done
1677 in "tcp: change IPv6 flow-label upon receiving spurious retransmission"
1678 and "tcp: Change txhash on every SYN and RTO retransmit"
Eric Dumazet323a53c2019-06-05 07:55:09 -07001679
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001680 - 2: enabled for TCP RESET packets (no active listener)
1681 If set, a RST packet sent in response to a SYN packet on a closed
1682 port will reflect the incoming flow label.
1683
1684 - 4: enabled for ICMPv6 echo reply messages.
Eric Dumazeta346abe2019-07-01 06:39:36 -07001685
Eric Dumazet323a53c2019-06-05 07:55:09 -07001686 Default: 0
Jakub Sitnicki22b67222017-08-23 09:55:41 +02001687
David Ahernb4bac172018-03-02 08:32:18 -08001688fib_multipath_hash_policy - INTEGER
1689 Controls which hash policy to use for multipath routes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001690
David Ahernb4bac172018-03-02 08:32:18 -08001691 Default: 0 (Layer 3)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001692
David Ahernb4bac172018-03-02 08:32:18 -08001693 Possible values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001694
1695 - 0 - Layer 3 (source and destination addresses plus flow label)
1696 - 1 - Layer 4 (standard 5-tuple)
1697 - 2 - Layer 3 or inner Layer 3 if present
David Ahernb4bac172018-03-02 08:32:18 -08001698
FX Le Bail509aba32014-01-07 14:57:27 +01001699anycast_src_echo_reply - BOOLEAN
1700 Controls the use of anycast addresses as source addresses for ICMPv6
1701 echo reply
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001702
1703 - TRUE: enabled
1704 - FALSE: disabled
1705
FX Le Bail509aba32014-01-07 14:57:27 +01001706 Default: FALSE
1707
Hannes Frederic Sowa9f0761c2015-03-23 23:36:06 +01001708idgen_delay - INTEGER
1709 Controls the delay in seconds after which time to retry
1710 privacy stable address generation if a DAD conflict is
1711 detected.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001712
Hannes Frederic Sowa9f0761c2015-03-23 23:36:06 +01001713 Default: 1 (as specified in RFC7217)
1714
1715idgen_retries - INTEGER
1716 Controls the number of retries to generate a stable privacy
1717 address if a DAD conflict is detected.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001718
Hannes Frederic Sowa9f0761c2015-03-23 23:36:06 +01001719 Default: 3 (as specified in RFC7217)
1720
Hannes Frederic Sowa2f711932014-09-02 15:49:25 +02001721mld_qrv - INTEGER
1722 Controls the MLD query robustness variable (see RFC3810 9.1).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001723
Hannes Frederic Sowa2f711932014-09-02 15:49:25 +02001724 Default: 2 (as specified by RFC3810 9.1)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001725
Hannes Frederic Sowa2f711932014-09-02 15:49:25 +02001726 Minimum: 1 (as specified by RFC6636 4.5)
1727
Olivier Gayotab913452018-04-18 22:03:06 +02001728max_dst_opts_number - INTEGER
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001729 Maximum number of non-padding TLVs allowed in a Destination
1730 options extension header. If this value is less than zero
1731 then unknown options are disallowed and the number of known
1732 TLVs allowed is the absolute value of this number.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001733
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001734 Default: 8
1735
Olivier Gayotab913452018-04-18 22:03:06 +02001736max_hbh_opts_number - INTEGER
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001737 Maximum number of non-padding TLVs allowed in a Hop-by-Hop
1738 options extension header. If this value is less than zero
1739 then unknown options are disallowed and the number of known
1740 TLVs allowed is the absolute value of this number.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001741
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001742 Default: 8
1743
Olivier Gayotab913452018-04-18 22:03:06 +02001744max_dst_opts_length - INTEGER
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001745 Maximum length allowed for a Destination options extension
1746 header.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001747
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001748 Default: INT_MAX (unlimited)
1749
Olivier Gayotab913452018-04-18 22:03:06 +02001750max_hbh_length - INTEGER
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001751 Maximum length allowed for a Hop-by-Hop options extension
1752 header.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001753
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001754 Default: INT_MAX (unlimited)
1755
David Ahern7c6bb7d2018-10-11 20:17:21 -07001756skip_notify_on_dev_down - BOOLEAN
1757 Controls whether an RTM_DELROUTE message is generated for routes
1758 removed when a device is taken down or deleted. IPv4 does not
1759 generate this message; IPv6 does by default. Setting this sysctl
1760 to true skips the message, making IPv4 and IPv6 on par in relying
1761 on userspace caches to track link events and evict routes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001762
David Ahern7c6bb7d2018-10-11 20:17:21 -07001763 Default: false (generate message)
1764
Roopa Prabhu4f801162020-04-27 13:56:46 -07001765nexthop_compat_mode - BOOLEAN
1766 New nexthop API provides a means for managing nexthops independent of
1767 prefixes. Backwards compatibilty with old route format is enabled by
1768 default which means route dumps and notifications contain the new
1769 nexthop attribute but also the full, expanded nexthop definition.
1770 Further, updates or deletes of a nexthop configuration generate route
1771 notifications for each fib entry using the nexthop. Once a system
1772 understands the new API, this sysctl can be disabled to achieve full
1773 performance benefits of the new API by disabling the nexthop expansion
1774 and extraneous notifications.
1775 Default: true (backward compat mode)
1776
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777IPv6 Fragmentation:
1778
1779ip6frag_high_thresh - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001780 Maximum memory used to reassemble IPv6 fragments. When
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781 ip6frag_high_thresh bytes of memory is allocated for this purpose,
1782 the fragment handler will toss packets until ip6frag_low_thresh
1783 is reached.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001784
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785ip6frag_low_thresh - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001786 See ip6frag_high_thresh
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787
1788ip6frag_time - INTEGER
1789 Time in seconds to keep an IPv6 fragment in memory.
1790
Ahmed Abdelsalama6dc6672018-04-27 17:51:48 +02001791IPv6 Segment Routing:
1792
1793seg6_flowlabel - INTEGER
1794 Controls the behaviour of computing the flowlabel of outer
1795 IPv6 header in case of SR T.encaps
1796
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001797 == =======================================================
1798 -1 set flowlabel to zero.
1799 0 copy flowlabel from Inner packet in case of Inner IPv6
1800 (Set flowlabel to 0 in case IPv4/L2)
1801 1 Compute the flowlabel using seg6_make_flowlabel()
1802 == =======================================================
Ahmed Abdelsalama6dc6672018-04-27 17:51:48 +02001803
1804 Default is 0.
1805
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001806``conf/default/*``:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807 Change the interface-specific default settings.
1808
Pali Rohárfc024c52021-01-21 16:02:44 +01001809 These settings would be used during creating new interfaces.
1810
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001812``conf/all/*``:
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001813 Change all the interface-specific settings.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814
1815 [XXX: Other special features than forwarding?]
1816
Pali Rohárfc024c52021-01-21 16:02:44 +01001817conf/all/disable_ipv6 - BOOLEAN
1818 Changing this value is same as changing ``conf/default/disable_ipv6``
1819 setting and also all per-interface ``disable_ipv6`` settings to the same
1820 value.
1821
1822 Reading this value does not have any particular meaning. It does not say
1823 whether IPv6 support is enabled or disabled. Returned value can be 1
1824 also in the case when some interface has ``disable_ipv6`` set to 0 and
1825 has configured IPv6 addresses.
1826
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827conf/all/forwarding - BOOLEAN
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001828 Enable global IPv6 forwarding between all interfaces.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001830 IPv4 and IPv6 work differently here; e.g. netfilter must be used
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 to control which interfaces may forward packets and which not.
1832
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001833 This also sets all interfaces' Host/Router setting
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 'forwarding' to the specified value. See below for details.
1835
1836 This referred to as global forwarding.
1837
YOSHIFUJI Hideakifbea49e2006-09-22 14:43:49 -07001838proxy_ndp - BOOLEAN
1839 Do proxy ndp.
1840
Loganaden Velvindron219b5f22014-11-04 03:02:49 -08001841fwmark_reflect - BOOLEAN
1842 Controls the fwmark of kernel-generated IPv6 reply packets that are not
1843 associated with a socket for example, TCP RSTs or ICMPv6 echo replies).
1844 If unset, these packets have a fwmark of zero. If set, they have the
1845 fwmark of the packet they are replying to.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001846
Loganaden Velvindron219b5f22014-11-04 03:02:49 -08001847 Default: 0
1848
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001849``conf/interface/*``:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850 Change special settings per interface.
1851
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001852 The functional behaviour for certain settings is different
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853 depending on whether local forwarding is enabled or not.
1854
Roy.Li605b91c2011-09-28 19:51:54 +00001855accept_ra - INTEGER
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 Accept Router Advertisements; autoconfigure using them.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001857
Tore Anderson026359b2011-08-28 23:47:33 +00001858 It also determines whether or not to transmit Router
1859 Solicitations. If and only if the functional setting is to
1860 accept Router Advertisements, Router Solicitations will be
1861 transmitted.
1862
Thomas Grafae8abfa2010-09-03 05:47:30 +00001863 Possible values are:
Thomas Grafae8abfa2010-09-03 05:47:30 +00001864
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001865 == ===========================================================
1866 0 Do not accept Router Advertisements.
1867 1 Accept Router Advertisements if forwarding is disabled.
1868 2 Overrule forwarding behaviour. Accept Router Advertisements
1869 even if forwarding is enabled.
1870 == ===========================================================
1871
1872 Functional default:
1873
1874 - enabled if local forwarding is disabled.
1875 - disabled if local forwarding is enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876
YOSHIFUJI Hideaki65f5c7c2006-03-20 16:55:08 -08001877accept_ra_defrtr - BOOLEAN
1878 Learn default router in Router Advertisement.
1879
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001880 Functional default:
1881
1882 - enabled if accept_ra is enabled.
1883 - disabled if accept_ra is disabled.
YOSHIFUJI Hideaki65f5c7c2006-03-20 16:55:08 -08001884
Ben Greeard9333192014-06-25 14:44:53 -07001885accept_ra_from_local - BOOLEAN
1886 Accept RA with source-address that is found on local machine
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001887 if the RA is otherwise proper and able to be accepted.
1888
1889 Default is to NOT accept these as it may be an un-intended
1890 network loop.
Ben Greeard9333192014-06-25 14:44:53 -07001891
1892 Functional default:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001893
1894 - enabled if accept_ra_from_local is enabled
1895 on a specific interface.
1896 - disabled if accept_ra_from_local is disabled
1897 on a specific interface.
Ben Greeard9333192014-06-25 14:44:53 -07001898
Hangbin Liu8013d1d2015-07-30 14:28:42 +08001899accept_ra_min_hop_limit - INTEGER
1900 Minimum hop limit Information in Router Advertisement.
1901
1902 Hop limit Information in Router Advertisement less than this
1903 variable shall be ignored.
1904
1905 Default: 1
1906
YOSHIFUJI Hideakic4fd30e2006-03-20 16:55:26 -08001907accept_ra_pinfo - BOOLEAN
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02001908 Learn Prefix Information in Router Advertisement.
YOSHIFUJI Hideakic4fd30e2006-03-20 16:55:26 -08001909
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001910 Functional default:
1911
1912 - enabled if accept_ra is enabled.
1913 - disabled if accept_ra is disabled.
YOSHIFUJI Hideakic4fd30e2006-03-20 16:55:26 -08001914
Joel Scherpelzbbea1242017-03-22 18:19:04 +09001915accept_ra_rt_info_min_plen - INTEGER
1916 Minimum prefix length of Route Information in RA.
1917
1918 Route Information w/ prefix smaller than this variable shall
1919 be ignored.
1920
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001921 Functional default:
1922
1923 * 0 if accept_ra_rtr_pref is enabled.
1924 * -1 if accept_ra_rtr_pref is disabled.
Joel Scherpelzbbea1242017-03-22 18:19:04 +09001925
YOSHIFUJI Hideaki09c884d2006-03-20 17:07:03 -08001926accept_ra_rt_info_max_plen - INTEGER
1927 Maximum prefix length of Route Information in RA.
1928
Joel Scherpelzbbea1242017-03-22 18:19:04 +09001929 Route Information w/ prefix larger than this variable shall
1930 be ignored.
YOSHIFUJI Hideaki09c884d2006-03-20 17:07:03 -08001931
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001932 Functional default:
1933
1934 * 0 if accept_ra_rtr_pref is enabled.
1935 * -1 if accept_ra_rtr_pref is disabled.
YOSHIFUJI Hideaki09c884d2006-03-20 17:07:03 -08001936
YOSHIFUJI Hideaki930d6ff2006-03-20 17:05:30 -08001937accept_ra_rtr_pref - BOOLEAN
1938 Accept Router Preference in RA.
1939
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001940 Functional default:
1941
1942 - enabled if accept_ra is enabled.
1943 - disabled if accept_ra is disabled.
YOSHIFUJI Hideaki930d6ff2006-03-20 17:05:30 -08001944
Harout Hedeshianc2943f12015-01-20 10:06:05 -07001945accept_ra_mtu - BOOLEAN
1946 Apply the MTU value specified in RA option 5 (RFC4861). If
1947 disabled, the MTU specified in the RA will be ignored.
1948
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001949 Functional default:
1950
1951 - enabled if accept_ra is enabled.
1952 - disabled if accept_ra is disabled.
Harout Hedeshianc2943f12015-01-20 10:06:05 -07001953
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954accept_redirects - BOOLEAN
1955 Accept Redirects.
1956
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001957 Functional default:
1958
1959 - enabled if local forwarding is disabled.
1960 - disabled if local forwarding is enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961
YOSHIFUJI Hideaki0bcbc922007-04-24 14:58:30 -07001962accept_source_route - INTEGER
1963 Accept source routing (routing extension header).
1964
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001965 - >= 0: Accept only routing header type 2.
1966 - < 0: Do not accept routing header.
YOSHIFUJI Hideaki0bcbc922007-04-24 14:58:30 -07001967
1968 Default: 0
1969
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970autoconf - BOOLEAN
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001971 Autoconfigure addresses using Prefix Information in Router
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972 Advertisements.
1973
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001974 Functional default:
1975
1976 - enabled if accept_ra_pinfo is enabled.
1977 - disabled if accept_ra_pinfo is disabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978
1979dad_transmits - INTEGER
1980 The amount of Duplicate Address Detection probes to send.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001981
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983
Roy.Li605b91c2011-09-28 19:51:54 +00001984forwarding - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001985 Configure interface-specific Host/Router behaviour.
1986
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001987 .. note::
1988
1989 It is recommended to have the same setting on all
1990 interfaces; mixed router/host scenarios are rather uncommon.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991
Thomas Grafae8abfa2010-09-03 05:47:30 +00001992 Possible values are:
Thomas Grafae8abfa2010-09-03 05:47:30 +00001993
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001994 - 0 Forwarding disabled
1995 - 1 Forwarding enabled
1996
1997 **FALSE (0)**:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998
1999 By default, Host behaviour is assumed. This means:
2000
2001 1. IsRouter flag is not set in Neighbour Advertisements.
Tore Anderson026359b2011-08-28 23:47:33 +00002002 2. If accept_ra is TRUE (default), transmit Router
2003 Solicitations.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002004 3. If accept_ra is TRUE (default), accept Router
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 Advertisements (and do autoconfiguration).
2006 4. If accept_redirects is TRUE (default), accept Redirects.
2007
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002008 **TRUE (1)**:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002010 If local forwarding is enabled, Router behaviour is assumed.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011 This means exactly the reverse from the above:
2012
2013 1. IsRouter flag is set in Neighbour Advertisements.
Tore Anderson026359b2011-08-28 23:47:33 +00002014 2. Router Solicitations are not sent unless accept_ra is 2.
Thomas Grafae8abfa2010-09-03 05:47:30 +00002015 3. Router Advertisements are ignored unless accept_ra is 2.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 4. Redirects are ignored.
2017
Thomas Grafae8abfa2010-09-03 05:47:30 +00002018 Default: 0 (disabled) if global forwarding is disabled (default),
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002019 otherwise 1 (enabled).
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020
2021hop_limit - INTEGER
2022 Default Hop Limit to set.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002023
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 Default: 64
2025
2026mtu - INTEGER
2027 Default Maximum Transfer Unit
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002028
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 Default: 1280 (IPv6 required minimum)
2030
Tom Herbert35a256f2015-07-08 16:58:22 -07002031ip_nonlocal_bind - BOOLEAN
2032 If set, allows processes to bind() to non-local IPv6 addresses,
2033 which can be quite useful - but may break some applications.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002034
Tom Herbert35a256f2015-07-08 16:58:22 -07002035 Default: 0
2036
YOSHIFUJI Hideaki52e163562006-03-20 17:05:47 -08002037router_probe_interval - INTEGER
2038 Minimum interval (in seconds) between Router Probing described
2039 in RFC4191.
2040
2041 Default: 60
2042
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043router_solicitation_delay - INTEGER
2044 Number of seconds to wait after interface is brought up
2045 before sending Router Solicitations.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002046
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047 Default: 1
2048
2049router_solicitation_interval - INTEGER
2050 Number of seconds to wait between Router Solicitations.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002051
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052 Default: 4
2053
2054router_solicitations - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002055 Number of Router Solicitations to send until assuming no
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056 routers are present.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002057
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 Default: 3
2059
Erik Kline3985e8a2015-07-22 16:38:25 +09002060use_oif_addrs_only - BOOLEAN
2061 When enabled, the candidate source addresses for destinations
2062 routed via this interface are restricted to the set of addresses
2063 configured on this interface (vis. RFC 6724, section 4).
2064
2065 Default: false
2066
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067use_tempaddr - INTEGER
2068 Preference for Privacy Extensions (RFC3041).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002069
2070 * <= 0 : disable Privacy Extensions
2071 * == 1 : enable Privacy Extensions, but prefer public
2072 addresses over temporary addresses.
2073 * > 1 : enable Privacy Extensions and prefer temporary
2074 addresses over public addresses.
2075
2076 Default:
2077
2078 * 0 (for most devices)
2079 * -1 (for point-to-point devices and loopback devices)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080
2081temp_valid_lft - INTEGER
2082 valid lifetime (in seconds) for temporary addresses.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002083
Fernando Gont969c5462020-05-01 00:51:47 -03002084 Default: 172800 (2 days)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085
2086temp_prefered_lft - INTEGER
2087 Preferred lifetime (in seconds) for temporary addresses.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002088
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 Default: 86400 (1 day)
2090
David Ahernf1705ec2016-02-24 09:25:37 -08002091keep_addr_on_down - INTEGER
2092 Keep all IPv6 addresses on an interface down event. If set static
2093 global addresses with no expiration time are not flushed.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002094
2095 * >0 : enabled
2096 * 0 : system default
2097 * <0 : disabled
David Ahernf1705ec2016-02-24 09:25:37 -08002098
2099 Default: 0 (addresses are removed)
2100
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101max_desync_factor - INTEGER
2102 Maximum value for DESYNC_FACTOR, which is a random value
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002103 that ensures that clients don't synchronize with each
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 other and generate new addresses at exactly the same time.
2105 value is in seconds.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002106
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 Default: 600
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002108
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109regen_max_retry - INTEGER
2110 Number of attempts before give up attempting to generate
2111 valid temporary addresses.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002112
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 Default: 5
2114
2115max_addresses - INTEGER
Brian Haleye79dc482010-02-22 12:27:21 +00002116 Maximum number of autoconfigured addresses per interface. Setting
2117 to zero disables the limitation. It is not recommended to set this
2118 value too large (or to zero) because it would be an easy way to
2119 crash the kernel by allowing too many addresses to be created.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002120
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 Default: 16
2122
YOSHIFUJI Hideaki778d80b2008-06-28 14:17:11 +09002123disable_ipv6 - BOOLEAN
Brian Haley9bdd8d42009-03-18 18:22:48 -07002124 Disable IPv6 operation. If accept_dad is set to 2, this value
2125 will be dynamically set to TRUE if DAD fails for the link-local
2126 address.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002127
YOSHIFUJI Hideaki778d80b2008-06-28 14:17:11 +09002128 Default: FALSE (enable IPv6 operation)
2129
Brian Haley56d417b2009-06-01 03:07:33 -07002130 When this value is changed from 1 to 0 (IPv6 is being enabled),
2131 it will dynamically create a link-local address on the given
2132 interface and start Duplicate Address Detection, if necessary.
2133
2134 When this value is changed from 0 to 1 (IPv6 is being disabled),
Lorenzo Bianconi2f0aaf72018-03-29 11:02:25 +02002135 it will dynamically delete all addresses and routes on the given
2136 interface. From now on it will not possible to add addresses/routes
2137 to the selected interface.
Brian Haley56d417b2009-06-01 03:07:33 -07002138
YOSHIFUJI Hideaki1b34be72008-06-28 14:18:38 +09002139accept_dad - INTEGER
2140 Whether to accept DAD (Duplicate Address Detection).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002141
2142 == ==============================================================
2143 0 Disable DAD
2144 1 Enable DAD (default)
2145 2 Enable DAD, and disable IPv6 operation if MAC-based duplicate
2146 link-local address has been found.
2147 == ==============================================================
YOSHIFUJI Hideaki1b34be72008-06-28 14:18:38 +09002148
Matteo Croce35e015e2017-09-12 17:46:37 +02002149 DAD operation and mode on a given interface will be selected according
2150 to the maximum value of conf/{all,interface}/accept_dad.
2151
Octavian Purdilaf7734fd2009-10-02 11:39:15 +00002152force_tllao - BOOLEAN
2153 Enable sending the target link-layer address option even when
2154 responding to a unicast neighbor solicitation.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002155
Octavian Purdilaf7734fd2009-10-02 11:39:15 +00002156 Default: FALSE
2157
2158 Quoting from RFC 2461, section 4.4, Target link-layer address:
2159
2160 "The option MUST be included for multicast solicitations in order to
2161 avoid infinite Neighbor Solicitation "recursion" when the peer node
2162 does not have a cache entry to return a Neighbor Advertisements
2163 message. When responding to unicast solicitations, the option can be
2164 omitted since the sender of the solicitation has the correct link-
2165 layer address; otherwise it would not have be able to send the unicast
2166 solicitation in the first place. However, including the link-layer
2167 address in this case adds little overhead and eliminates a potential
2168 race condition where the sender deletes the cached link-layer address
2169 prior to receiving a response to a previous solicitation."
2170
Hannes Frederic Sowadb2b6202013-01-01 00:35:31 +00002171ndisc_notify - BOOLEAN
2172 Define mode for notification of address and device changes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002173
2174 * 0 - (default): do nothing
2175 * 1 - Generate unsolicited neighbour advertisements when device is brought
2176 up or hardware address changes.
Hannes Frederic Sowadb2b6202013-01-01 00:35:31 +00002177
Maciej Żenczykowski2210d6b2017-11-07 21:52:09 -08002178ndisc_tclass - INTEGER
2179 The IPv6 Traffic Class to use by default when sending IPv6 Neighbor
2180 Discovery (Router Solicitation, Router Advertisement, Neighbor
2181 Solicitation, Neighbor Advertisement, Redirect) messages.
2182 These 8 bits can be interpreted as 6 high order bits holding the DSCP
2183 value and 2 low order bits representing ECN (which you probably want
2184 to leave cleared).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002185
2186 * 0 - (default)
Maciej Żenczykowski2210d6b2017-11-07 21:52:09 -08002187
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02002188mldv1_unsolicited_report_interval - INTEGER
2189 The interval in milliseconds in which the next unsolicited
2190 MLDv1 report retransmit will take place.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002191
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02002192 Default: 10000 (10 seconds)
2193
2194mldv2_unsolicited_report_interval - INTEGER
2195 The interval in milliseconds in which the next unsolicited
2196 MLDv2 report retransmit will take place.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002197
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02002198 Default: 1000 (1 second)
2199
Daniel Borkmannf2127812013-09-04 00:19:44 +02002200force_mld_version - INTEGER
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002201 * 0 - (default) No enforcement of a MLD version, MLDv1 fallback allowed
2202 * 1 - Enforce to use MLD version 1
2203 * 2 - Enforce to use MLD version 2
Daniel Borkmannf2127812013-09-04 00:19:44 +02002204
Hannes Frederic Sowab800c3b2013-08-27 01:36:51 +02002205suppress_frag_ndisc - INTEGER
2206 Control RFC 6980 (Security Implications of IPv6 Fragmentation
2207 with IPv6 Neighbor Discovery) behavior:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002208
2209 * 1 - (default) discard fragmented neighbor discovery packets
2210 * 0 - allow fragmented neighbor discovery packets
Hannes Frederic Sowab800c3b2013-08-27 01:36:51 +02002211
Erik Kline7fd25612014-10-28 18:11:14 +09002212optimistic_dad - BOOLEAN
2213 Whether to perform Optimistic Duplicate Address Detection (RFC 4429).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002214
2215 * 0: disabled (default)
2216 * 1: enabled
Matteo Croce35e015e2017-09-12 17:46:37 +02002217
2218 Optimistic Duplicate Address Detection for the interface will be enabled
2219 if at least one of conf/{all,interface}/optimistic_dad is set to 1,
2220 it will be disabled otherwise.
Erik Kline7fd25612014-10-28 18:11:14 +09002221
2222use_optimistic - BOOLEAN
2223 If enabled, do not classify optimistic addresses as deprecated during
2224 source address selection. Preferred addresses will still be chosen
2225 before optimistic addresses, subject to other ranking in the source
2226 address selection algorithm.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002227
2228 * 0: disabled (default)
2229 * 1: enabled
Matteo Croce35e015e2017-09-12 17:46:37 +02002230
2231 This will be enabled if at least one of
2232 conf/{all,interface}/use_optimistic is set to 1, disabled otherwise.
Erik Kline7fd25612014-10-28 18:11:14 +09002233
Hannes Frederic Sowa9f0761c2015-03-23 23:36:06 +01002234stable_secret - IPv6 address
2235 This IPv6 address will be used as a secret to generate IPv6
2236 addresses for link-local addresses and autoconfigured
2237 ones. All addresses generated after setting this secret will
2238 be stable privacy ones by default. This can be changed via the
2239 addrgenmode ip-link. conf/default/stable_secret is used as the
2240 secret for the namespace, the interface specific ones can
2241 overwrite that. Writes to conf/all/stable_secret are refused.
2242
2243 It is recommended to generate this secret during installation
2244 of a system and keep it stable after that.
2245
2246 By default the stable secret is unset.
2247
Sabrina Dubrocaf168db52018-07-09 12:25:18 +02002248addr_gen_mode - INTEGER
2249 Defines how link-local and autoconf addresses are generated.
2250
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002251 = =================================================================
2252 0 generate address based on EUI64 (default)
2253 1 do no generate a link-local address, use EUI64 for addresses
2254 generated from autoconf
2255 2 generate stable privacy addresses, using the secret from
Sabrina Dubrocaf168db52018-07-09 12:25:18 +02002256 stable_secret (RFC7217)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002257 3 generate stable privacy addresses, using a random secret if unset
2258 = =================================================================
Sabrina Dubrocaf168db52018-07-09 12:25:18 +02002259
Johannes Bergabbc3042016-02-04 13:31:19 +01002260drop_unicast_in_l2_multicast - BOOLEAN
2261 Drop any unicast IPv6 packets that are received in link-layer
2262 multicast (or broadcast) frames.
2263
2264 By default this is turned off.
2265
Johannes Berg7a02bf82016-02-04 13:31:20 +01002266drop_unsolicited_na - BOOLEAN
2267 Drop all unsolicited neighbor advertisements, for example if there's
2268 a known good NA proxy on the network and such frames need not be used
2269 (or in the case of 802.11, must not be used to prevent attacks.)
2270
2271 By default this is turned off.
2272
Erik Nordmarkadc176c2016-12-02 14:00:08 -08002273enhanced_dad - BOOLEAN
2274 Include a nonce option in the IPv6 neighbor solicitation messages used for
2275 duplicate address detection per RFC7527. A received DAD NS will only signal
2276 a duplicate address if the nonce is different. This avoids any false
2277 detection of duplicates due to loopback of the NS messages that we send.
2278 The nonce option will be sent on an interface unless both of
2279 conf/{all,interface}/enhanced_dad are set to FALSE.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002280
Erik Nordmarkadc176c2016-12-02 14:00:08 -08002281 Default: TRUE
2282
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002283``icmp/*``:
2284===========
2285
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286ratelimit - INTEGER
Stephen Suryaputra0bc19982019-04-17 16:35:49 -04002287 Limit the maximal rates for sending ICMPv6 messages.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002288
Stephen Hemminger6dbf4bc2008-07-01 19:29:07 -07002289 0 to disable any limiting,
2290 otherwise the minimal space between responses in milliseconds.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002291
Stephen Hemminger6dbf4bc2008-07-01 19:29:07 -07002292 Default: 1000
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293
Stephen Suryaputra0bc19982019-04-17 16:35:49 -04002294ratemask - list of comma separated ranges
2295 For ICMPv6 message types matching the ranges in the ratemask, limit
2296 the sending of the message according to ratelimit parameter.
2297
2298 The format used for both input and output is a comma separated
2299 list of ranges (e.g. "0-127,129" for ICMPv6 message type 0 to 127 and
2300 129). Writing to the file will clear all previous ranges of ICMPv6
2301 message types and update the current list with the input.
2302
2303 Refer to: https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml
2304 for numerical values of ICMPv6 message types, e.g. echo request is 128
2305 and echo reply is 129.
2306
2307 Default: 0-1,3-127 (rate limit ICMPv6 errors except Packet Too Big)
2308
Virgile Jarrye6f86b02018-08-10 17:48:15 +02002309echo_ignore_all - BOOLEAN
2310 If set non-zero, then the kernel will ignore all ICMP ECHO
2311 requests sent to it over the IPv6 protocol.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002312
Virgile Jarrye6f86b02018-08-10 17:48:15 +02002313 Default: 0
2314
Stephen Suryaputra03f1ecc2019-03-19 12:37:12 -04002315echo_ignore_multicast - BOOLEAN
2316 If set non-zero, then the kernel will ignore all ICMP ECHO
2317 requests sent to it over the IPv6 protocol via multicast.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002318
Stephen Suryaputra03f1ecc2019-03-19 12:37:12 -04002319 Default: 0
2320
Stephen Suryaputra0b03a5c2019-03-20 10:29:27 -04002321echo_ignore_anycast - BOOLEAN
2322 If set non-zero, then the kernel will ignore all ICMP ECHO
2323 requests sent to it over the IPv6 protocol destined to anycast address.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002324
Stephen Suryaputra0b03a5c2019-03-20 10:29:27 -04002325 Default: 0
2326
Alexander Duycke69948a2015-08-11 13:35:01 -07002327xfrm6_gc_thresh - INTEGER
Nicolas Dichtel837f7412019-04-09 17:16:59 +02002328 (Obsolete since linux-4.14)
Alexander Duycke69948a2015-08-11 13:35:01 -07002329 The threshold at which we will start garbage collecting for IPv6
2330 destination cache entries. At twice this value the system will
Florian Westphal3c2a89d2017-07-17 13:57:20 +02002331 refuse new allocations.
Alexander Duycke69948a2015-08-11 13:35:01 -07002332
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333
2334IPv6 Update by:
2335Pekka Savola <pekkas@netcore.fi>
2336YOSHIFUJI Hideaki / USAGI Project <yoshfuji@linux-ipv6.org>
2337
2338
2339/proc/sys/net/bridge/* Variables:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002340=================================
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341
2342bridge-nf-call-arptables - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002343 - 1 : pass bridged ARP traffic to arptables' FORWARD chain.
2344 - 0 : disable this.
2345
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346 Default: 1
2347
2348bridge-nf-call-iptables - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002349 - 1 : pass bridged IPv4 traffic to iptables' chains.
2350 - 0 : disable this.
2351
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352 Default: 1
2353
2354bridge-nf-call-ip6tables - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002355 - 1 : pass bridged IPv6 traffic to ip6tables' chains.
2356 - 0 : disable this.
2357
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358 Default: 1
2359
2360bridge-nf-filter-vlan-tagged - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002361 - 1 : pass bridged vlan-tagged ARP/IP/IPv6 traffic to {arp,ip,ip6}tables.
2362 - 0 : disable this.
2363
Pablo Neira Ayuso49816822012-05-08 19:36:44 +02002364 Default: 0
Michael Milner516299d2007-04-12 22:14:23 -07002365
2366bridge-nf-filter-pppoe-tagged - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002367 - 1 : pass bridged pppoe-tagged IP/IPv6 traffic to {ip,ip6}tables.
2368 - 0 : disable this.
2369
Pablo Neira Ayuso49816822012-05-08 19:36:44 +02002370 Default: 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371
Pablo Neira Ayuso49816822012-05-08 19:36:44 +02002372bridge-nf-pass-vlan-input-dev - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002373 - 1: if bridge-nf-filter-vlan-tagged is enabled, try to find a vlan
2374 interface on the bridge and set the netfilter input device to the
2375 vlan. This allows use of e.g. "iptables -i br0.1" and makes the
2376 REDIRECT target work with vlan-on-top-of-bridge interfaces. When no
2377 matching vlan interface is found, or this switch is off, the input
2378 device is set to the bridge interface.
2379
2380 - 0: disable bridge netfilter vlan interface lookup.
2381
Pablo Neira Ayuso49816822012-05-08 19:36:44 +02002382 Default: 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002384``proc/sys/net/sctp/*`` Variables:
2385==================================
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002386
2387addip_enable - BOOLEAN
2388 Enable or disable extension of Dynamic Address Reconfiguration
2389 (ADD-IP) functionality specified in RFC5061. This extension provides
2390 the ability to dynamically add and remove new addresses for the SCTP
2391 associations.
2392
2393 1: Enable extension.
2394
2395 0: Disable extension.
2396
2397 Default: 0
2398
Zhu Yanjun566178f2015-12-16 13:55:04 +08002399pf_enable - INTEGER
2400 Enable or disable pf (pf is short for potentially failed) state. A value
2401 of pf_retrans > path_max_retrans also disables pf state. That is, one of
2402 both pf_enable and pf_retrans > path_max_retrans can disable pf state.
2403 Since pf_retrans and path_max_retrans can be changed by userspace
2404 application, sometimes user expects to disable pf state by the value of
2405 pf_retrans > path_max_retrans, but occasionally the value of pf_retrans
2406 or path_max_retrans is changed by the user application, this pf state is
2407 enabled. As such, it is necessary to add this to dynamically enable
2408 and disable pf state. See:
2409 https://datatracker.ietf.org/doc/draft-ietf-tsvwg-sctp-failover for
2410 details.
2411
2412 1: Enable pf.
2413
2414 0: Disable pf.
2415
2416 Default: 1
2417
Xin Longaef587b2019-11-08 13:20:32 +08002418pf_expose - INTEGER
2419 Unset or enable/disable pf (pf is short for potentially failed) state
2420 exposure. Applications can control the exposure of the PF path state
2421 in the SCTP_PEER_ADDR_CHANGE event and the SCTP_GET_PEER_ADDR_INFO
2422 sockopt. When it's unset, no SCTP_PEER_ADDR_CHANGE event with
2423 SCTP_ADDR_PF state will be sent and a SCTP_PF-state transport info
2424 can be got via SCTP_GET_PEER_ADDR_INFO sockopt; When it's enabled,
2425 a SCTP_PEER_ADDR_CHANGE event will be sent for a transport becoming
2426 SCTP_PF state and a SCTP_PF-state transport info can be got via
2427 SCTP_GET_PEER_ADDR_INFO sockopt; When it's diabled, no
2428 SCTP_PEER_ADDR_CHANGE event will be sent and it returns -EACCES when
2429 trying to get a SCTP_PF-state transport info via SCTP_GET_PEER_ADDR_INFO
2430 sockopt.
2431
2432 0: Unset pf state exposure, Compatible with old applications.
2433
2434 1: Disable pf state exposure.
2435
2436 2: Enable pf state exposure.
2437
2438 Default: 0
2439
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002440addip_noauth_enable - BOOLEAN
2441 Dynamic Address Reconfiguration (ADD-IP) requires the use of
2442 authentication to protect the operations of adding or removing new
2443 addresses. This requirement is mandated so that unauthorized hosts
2444 would not be able to hijack associations. However, older
2445 implementations may not have implemented this requirement while
2446 allowing the ADD-IP extension. For reasons of interoperability,
2447 we provide this variable to control the enforcement of the
2448 authentication requirement.
2449
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002450 == ===============================================================
2451 1 Allow ADD-IP extension to be used without authentication. This
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002452 should only be set in a closed environment for interoperability
2453 with older implementations.
2454
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002455 0 Enforce the authentication requirement
2456 == ===============================================================
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002457
2458 Default: 0
2459
2460auth_enable - BOOLEAN
2461 Enable or disable Authenticated Chunks extension. This extension
2462 provides the ability to send and receive authenticated chunks and is
2463 required for secure operation of Dynamic Address Reconfiguration
2464 (ADD-IP) extension.
2465
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002466 - 1: Enable this extension.
2467 - 0: Disable this extension.
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002468
2469 Default: 0
2470
2471prsctp_enable - BOOLEAN
2472 Enable or disable the Partial Reliability extension (RFC3758) which
2473 is used to notify peers that a given DATA should no longer be expected.
2474
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002475 - 1: Enable extension
2476 - 0: Disable
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002477
2478 Default: 1
2479
2480max_burst - INTEGER
2481 The limit of the number of new packets that can be initially sent. It
2482 controls how bursty the generated traffic can be.
2483
2484 Default: 4
2485
2486association_max_retrans - INTEGER
2487 Set the maximum number for retransmissions that an association can
2488 attempt deciding that the remote end is unreachable. If this value
2489 is exceeded, the association is terminated.
2490
2491 Default: 10
2492
2493max_init_retransmits - INTEGER
2494 The maximum number of retransmissions of INIT and COOKIE-ECHO chunks
2495 that an association will attempt before declaring the destination
2496 unreachable and terminating.
2497
2498 Default: 8
2499
2500path_max_retrans - INTEGER
2501 The maximum number of retransmissions that will be attempted on a given
2502 path. Once this threshold is exceeded, the path is considered
2503 unreachable, and new traffic will use a different path when the
2504 association is multihomed.
2505
2506 Default: 5
2507
Neil Horman5aa93bc2012-07-21 07:56:07 +00002508pf_retrans - INTEGER
2509 The number of retransmissions that will be attempted on a given path
2510 before traffic is redirected to an alternate transport (should one
2511 exist). Note this is distinct from path_max_retrans, as a path that
2512 passes the pf_retrans threshold can still be used. Its only
2513 deprioritized when a transmission path is selected by the stack. This
2514 setting is primarily used to enable fast failover mechanisms without
2515 having to reduce path_max_retrans to a very low value. See:
2516 http://www.ietf.org/id/draft-nishida-tsvwg-sctp-failover-05.txt
2517 for details. Note also that a value of pf_retrans > path_max_retrans
Zhu Yanjun566178f2015-12-16 13:55:04 +08002518 disables this feature. Since both pf_retrans and path_max_retrans can
2519 be changed by userspace application, a variable pf_enable is used to
2520 disable pf state.
Neil Horman5aa93bc2012-07-21 07:56:07 +00002521
2522 Default: 0
2523
Xin Long34515e92019-11-08 13:20:35 +08002524ps_retrans - INTEGER
2525 Primary.Switchover.Max.Retrans (PSMR), it's a tunable parameter coming
2526 from section-5 "Primary Path Switchover" in rfc7829. The primary path
2527 will be changed to another active path when the path error counter on
2528 the old primary path exceeds PSMR, so that "the SCTP sender is allowed
2529 to continue data transmission on a new working path even when the old
2530 primary destination address becomes active again". Note this feature
2531 is disabled by initializing 'ps_retrans' per netns as 0xffff by default,
2532 and its value can't be less than 'pf_retrans' when changing by sysctl.
2533
2534 Default: 0xffff
2535
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002536rto_initial - INTEGER
2537 The initial round trip timeout value in milliseconds that will be used
2538 in calculating round trip times. This is the initial time interval
2539 for retransmissions.
2540
2541 Default: 3000
2542
2543rto_max - INTEGER
2544 The maximum value (in milliseconds) of the round trip timeout. This
2545 is the largest time interval that can elapse between retransmissions.
2546
2547 Default: 60000
2548
2549rto_min - INTEGER
2550 The minimum value (in milliseconds) of the round trip timeout. This
2551 is the smallest time interval the can elapse between retransmissions.
2552
2553 Default: 1000
2554
2555hb_interval - INTEGER
2556 The interval (in milliseconds) between HEARTBEAT chunks. These chunks
2557 are sent at the specified interval on idle paths to probe the state of
2558 a given path between 2 associations.
2559
2560 Default: 30000
2561
2562sack_timeout - INTEGER
2563 The amount of time (in milliseconds) that the implementation will wait
2564 to send a SACK.
2565
2566 Default: 200
2567
2568valid_cookie_life - INTEGER
2569 The default lifetime of the SCTP cookie (in milliseconds). The cookie
2570 is used during association establishment.
2571
2572 Default: 60000
2573
2574cookie_preserve_enable - BOOLEAN
2575 Enable or disable the ability to extend the lifetime of the SCTP cookie
2576 that is used during the establishment phase of SCTP association
2577
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002578 - 1: Enable cookie lifetime extension.
2579 - 0: Disable
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002580
2581 Default: 1
2582
Neil Horman3c681982012-10-24 09:20:03 +00002583cookie_hmac_alg - STRING
2584 Select the hmac algorithm used when generating the cookie value sent by
2585 a listening sctp socket to a connecting client in the INIT-ACK chunk.
2586 Valid values are:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002587
Neil Horman3c681982012-10-24 09:20:03 +00002588 * md5
2589 * sha1
2590 * none
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002591
Neil Horman3c681982012-10-24 09:20:03 +00002592 Ability to assign md5 or sha1 as the selected alg is predicated on the
stephen hemminger3b09adc2013-01-03 07:50:29 +00002593 configuration of those algorithms at build time (CONFIG_CRYPTO_MD5 and
Neil Horman3c681982012-10-24 09:20:03 +00002594 CONFIG_CRYPTO_SHA1).
2595
2596 Default: Dependent on configuration. MD5 if available, else SHA1 if
2597 available, else none.
2598
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002599rcvbuf_policy - INTEGER
2600 Determines if the receive buffer is attributed to the socket or to
2601 association. SCTP supports the capability to create multiple
2602 associations on a single socket. When using this capability, it is
2603 possible that a single stalled association that's buffering a lot
2604 of data may block other associations from delivering their data by
2605 consuming all of the receive buffer space. To work around this,
2606 the rcvbuf_policy could be set to attribute the receiver buffer space
2607 to each association instead of the socket. This prevents the described
2608 blocking.
2609
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002610 - 1: rcvbuf space is per association
2611 - 0: rcvbuf space is per socket
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002612
2613 Default: 0
2614
2615sndbuf_policy - INTEGER
2616 Similar to rcvbuf_policy above, this applies to send buffer space.
2617
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002618 - 1: Send buffer is tracked per association
2619 - 0: Send buffer is tracked per socket.
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002620
2621 Default: 0
2622
2623sctp_mem - vector of 3 INTEGERs: min, pressure, max
2624 Number of pages allowed for queueing by all SCTP sockets.
2625
2626 min: Below this number of pages SCTP is not bothered about its
2627 memory appetite. When amount of memory allocated by SCTP exceeds
2628 this number, SCTP starts to moderate memory usage.
2629
2630 pressure: This value was introduced to follow format of tcp_mem.
2631
2632 max: Number of pages allowed for queueing by all SCTP sockets.
2633
2634 Default is calculated at boot time from amount of available memory.
2635
2636sctp_rmem - vector of 3 INTEGERs: min, default, max
Max Matveeva6e12042011-06-19 22:08:10 +00002637 Only the first value ("min") is used, "default" and "max" are
2638 ignored.
2639
2640 min: Minimal size of receive buffer used by SCTP socket.
2641 It is guaranteed to each SCTP socket (but not association) even
2642 under moderate memory pressure.
2643
Tonghao Zhang320bd6d2018-03-13 21:57:17 -07002644 Default: 4K
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002645
2646sctp_wmem - vector of 3 INTEGERs: min, default, max
Max Matveeva6e12042011-06-19 22:08:10 +00002647 Currently this tunable has no effect.
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002648
Bhaskar Dutta72388432009-09-03 17:25:47 +05302649addr_scope_policy - INTEGER
2650 Control IPv4 address scoping - draft-stewart-tsvwg-sctp-ipv4-00
2651
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002652 - 0 - Disable IPv4 address scoping
2653 - 1 - Enable IPv4 address scoping
2654 - 2 - Follow draft but allow IPv4 private addresses
2655 - 3 - Follow draft but allow IPv4 link local addresses
Bhaskar Dutta72388432009-09-03 17:25:47 +05302656
2657 Default: 1
2658
Xin Long046c0522020-10-29 15:05:10 +08002659udp_port - INTEGER
2660 The listening port for the local UDP tunneling sock. Normally it's
2661 using the IANA-assigned UDP port number 9899 (sctp-tunneling).
2662
2663 This UDP sock is used for processing the incoming UDP-encapsulated
2664 SCTP packets (from RFC6951), and shared by all applications in the
2665 same net namespace. This UDP sock will be closed when the value is
2666 set to 0.
2667
2668 The value will also be used to set the src port of the UDP header
2669 for the outgoing UDP-encapsulated SCTP packets. For the dest port,
2670 please refer to 'encap_port' below.
2671
2672 Default: 0
2673
Xin Longe8a30012020-10-29 15:05:01 +08002674encap_port - INTEGER
2675 The default remote UDP encapsulation port.
2676
2677 This value is used to set the dest port of the UDP header for the
2678 outgoing UDP-encapsulated SCTP packets by default. Users can also
2679 change the value for each sock/asoc/transport by using setsockopt.
2680 For further information, please refer to RFC6951.
2681
2682 Note that when connecting to a remote server, the client should set
2683 this to the port that the UDP tunneling sock on the peer server is
2684 listening to and the local UDP tunneling sock on the client also
2685 must be started. On the server, it would get the encap_port from
2686 the incoming packet's source port.
2687
2688 Default: 0
2689
Linus Torvalds1da177e2005-04-16 15:20:36 -07002690
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002691``/proc/sys/net/core/*``
2692========================
2693
Mauro Carvalho Chehab57043242019-04-22 16:48:00 -03002694 Please see: Documentation/admin-guide/sysctl/net.rst for descriptions of these entries.
Wang Tinggong705efc32009-05-14 22:49:36 +00002695
Linus Torvalds1da177e2005-04-16 15:20:36 -07002696
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002697``/proc/sys/net/unix/*``
2698========================
2699
Wang Tinggong705efc32009-05-14 22:49:36 +00002700max_dgram_qlen - INTEGER
2701 The maximum length of dgram socket receive queue
2702
2703 Default: 10
2704