blob: 2572eecc3e86a1eb8cbb96fb47c94a014186e7af [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
xu xinbe1c5b52021-12-30 03:28:56 +000028 destination will be set to the smallest of the old MTU to
29 this destination and min_pmtu (see below). You will need
Hannes Frederic Sowa188b04d2013-12-14 04:42:13 +010030 to raise min_pmtu to the smallest interface MTU on your system
31 manually if you want to avoid locally generated fragments.
Hannes Frederic Sowacd174e62013-12-14 05:13:45 +010032
33 In mode 2 incoming Path MTU Discovery messages will be
34 discarded. Outgoing frames are handled the same as in mode 1,
35 implicitly setting IP_PMTUDISC_DONT on every created socket.
36
Olivier Gayotbb38ccc2018-06-04 12:07:37 +020037 Mode 3 is a hardened pmtu discover mode. The kernel will only
Hannes Frederic Sowa8ed1dc42014-01-09 10:01:17 +010038 accept fragmentation-needed errors if the underlying protocol
39 can verify them besides a plain socket lookup. Current
40 protocols for which pmtu events will be honored are TCP, SCTP
41 and DCCP as they verify e.g. the sequence number or the
42 association. This mode should not be enabled globally but is
43 only intended to secure e.g. name servers in namespaces where
44 TCP path mtu must still work but path MTU information of other
45 protocols should be discarded. If enabled globally this mode
46 could break other protocols.
47
48 Possible values: 0-3
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020049
Hannes Frederic Sowa188b04d2013-12-14 04:42:13 +010050 Default: FALSE
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
52min_pmtu - INTEGER
xu xinbe1c5b52021-12-30 03:28:56 +000053 default 552 - minimum Path MTU. Unless this is changed mannually,
54 each cached pmtu will never be lower than this setting.
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Hannes Frederic Sowaf87c10a2014-01-09 10:01:15 +010056ip_forward_use_pmtu - BOOLEAN
57 By default we don't trust protocol path MTUs while forwarding
58 because they could be easily forged and can lead to unwanted
59 fragmentation by the router.
60 You only need to enable this if you have user-space software
61 which tries to discover path mtus by itself and depends on the
62 kernel honoring this information. This is normally not the
63 case.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020064
Hannes Frederic Sowaf87c10a2014-01-09 10:01:15 +010065 Default: 0 (disabled)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020066
Hannes Frederic Sowaf87c10a2014-01-09 10:01:15 +010067 Possible values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020068
69 - 0 - disabled
70 - 1 - enabled
Hannes Frederic Sowaf87c10a2014-01-09 10:01:15 +010071
Loganaden Velvindron219b5f22014-11-04 03:02:49 -080072fwmark_reflect - BOOLEAN
73 Controls the fwmark of kernel-generated IPv4 reply packets that are not
74 associated with a socket for example, TCP RSTs or ICMP echo replies).
75 If unset, these packets have a fwmark of zero. If set, they have the
76 fwmark of the packet they are replying to.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020077
Loganaden Velvindron219b5f22014-11-04 03:02:49 -080078 Default: 0
79
David Aherna6db4492016-04-07 07:21:00 -070080fib_multipath_use_neigh - BOOLEAN
81 Use status of existing neighbor entry when determining nexthop for
82 multipath routes. If disabled, neighbor information is not used and
83 packets could be directed to a failed nexthop. Only valid for kernels
84 built with CONFIG_IP_ROUTE_MULTIPATH enabled.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020085
David Aherna6db4492016-04-07 07:21:00 -070086 Default: 0 (disabled)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020087
David Aherna6db4492016-04-07 07:21:00 -070088 Possible values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020089
90 - 0 - disabled
91 - 1 - enabled
David Aherna6db4492016-04-07 07:21:00 -070092
Nikolay Aleksandrovbf4e0a32017-03-16 15:28:00 +020093fib_multipath_hash_policy - INTEGER
94 Controls which hash policy to use for multipath routes. Only valid
95 for kernels built with CONFIG_IP_ROUTE_MULTIPATH enabled.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020096
Nikolay Aleksandrovbf4e0a32017-03-16 15:28:00 +020097 Default: 0 (Layer 3)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +020098
Nikolay Aleksandrovbf4e0a32017-03-16 15:28:00 +020099 Possible values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200100
101 - 0 - Layer 3
102 - 1 - Layer 4
103 - 2 - Layer 3 or inner Layer 3 if present
Ido Schimmel4253b492021-05-17 21:15:19 +0300104 - 3 - Custom multipath hash. Fields used for multipath hash calculation
105 are determined by fib_multipath_hash_fields sysctl
Nikolay Aleksandrovbf4e0a32017-03-16 15:28:00 +0200106
Ido Schimmelce5c9c22021-05-17 21:15:18 +0300107fib_multipath_hash_fields - UNSIGNED INTEGER
108 When fib_multipath_hash_policy is set to 3 (custom multipath hash), the
109 fields used for multipath hash calculation are determined by this
110 sysctl.
111
112 This value is a bitmask which enables various fields for multipath hash
113 calculation.
114
115 Possible fields are:
116
117 ====== ============================
118 0x0001 Source IP address
119 0x0002 Destination IP address
120 0x0004 IP protocol
121 0x0008 Unused (Flow Label)
122 0x0010 Source port
123 0x0020 Destination port
124 0x0040 Inner source IP address
125 0x0080 Inner destination IP address
126 0x0100 Inner IP protocol
127 0x0200 Inner Flow Label
128 0x0400 Inner source port
129 0x0800 Inner destination port
130 ====== ============================
131
132 Default: 0x0007 (source IP, destination IP and IP protocol)
133
David Ahern9ab948a2019-03-20 09:18:59 -0700134fib_sync_mem - UNSIGNED INTEGER
135 Amount of dirty memory from fib entries that can be backlogged before
136 synchronize_rcu is forced.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200137
138 Default: 512kB Minimum: 64kB Maximum: 64MB
David Ahern9ab948a2019-03-20 09:18:59 -0700139
Petr Machata432e05d2018-08-01 00:36:03 +0200140ip_forward_update_priority - INTEGER
141 Whether to update SKB priority from "TOS" field in IPv4 header after it
142 is forwarded. The new SKB priority is mapped from TOS field value
143 according to an rt_tos2priority table (see e.g. man tc-prio).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200144
Petr Machata432e05d2018-08-01 00:36:03 +0200145 Default: 1 (Update priority.)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200146
Petr Machata432e05d2018-08-01 00:36:03 +0200147 Possible values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200148
149 - 0 - Do not update priority.
150 - 1 - Update priority.
Petr Machata432e05d2018-08-01 00:36:03 +0200151
Ben Greearcbaf0872010-11-08 09:13:48 +0000152route/max_size - INTEGER
153 Maximum number of routes allowed in the kernel. Increase
154 this when using large numbers of interfaces and/or routes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200155
Ani Sinha25050c62015-01-07 15:45:56 -0800156 From linux kernel 3.6 onwards, this is deprecated for ipv4
157 as route cache is no longer used.
Ben Greearcbaf0872010-11-08 09:13:48 +0000158
YOSHIFUJI Hideaki / 吉藤英明27246802013-01-22 05:20:05 +0000159neigh/default/gc_thresh1 - INTEGER
160 Minimum number of entries to keep. Garbage collector will not
161 purge entries if there are fewer than this number.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200162
Li RongQingb66c66d2013-03-14 22:49:47 +0000163 Default: 128
YOSHIFUJI Hideaki / 吉藤英明27246802013-01-22 05:20:05 +0000164
stephen hemmingera3d12142014-08-25 15:05:30 -0700165neigh/default/gc_thresh2 - INTEGER
166 Threshold when garbage collector becomes more aggressive about
167 purging entries. Entries older than 5 seconds will be cleared
168 when over this number.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200169
stephen hemmingera3d12142014-08-25 15:05:30 -0700170 Default: 512
171
Ben Greearcbaf0872010-11-08 09:13:48 +0000172neigh/default/gc_thresh3 - INTEGER
David Ahern58956312018-12-07 12:24:57 -0800173 Maximum number of non-PERMANENT neighbor entries allowed. Increase
174 this when using large numbers of interfaces and when communicating
Ben Greearcbaf0872010-11-08 09:13:48 +0000175 with large numbers of directly-connected peers.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200176
Shan Weicc868022012-12-04 18:50:35 +0000177 Default: 1024
Ben Greearcbaf0872010-11-08 09:13:48 +0000178
Eric Dumazet8b5c1712011-11-09 12:07:14 +0000179neigh/default/unres_qlen_bytes - INTEGER
180 The maximum number of bytes which may be used by packets
181 queued for each unresolved address by other network layers.
182 (added in linux 3.3)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200183
stephen hemminger3b09adc2013-01-03 07:50:29 +0000184 Setting negative value is meaningless and will return error.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200185
Eric Dumazeteaa72dc2017-08-29 15:16:01 -0700186 Default: SK_WMEM_MAX, (same as net.core.wmem_default).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200187
Eric Dumazeteaa72dc2017-08-29 15:16:01 -0700188 Exact value depends on architecture and kernel options,
189 but should be enough to allow queuing 256 packets
190 of medium size.
Eric Dumazet8b5c1712011-11-09 12:07:14 +0000191
192neigh/default/unres_qlen - INTEGER
193 The maximum number of packets which may be queued for each
194 unresolved address by other network layers.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200195
Eric Dumazet8b5c1712011-11-09 12:07:14 +0000196 (deprecated in linux 3.3) : use unres_qlen_bytes instead.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200197
Shan Weicc868022012-12-04 18:50:35 +0000198 Prior to linux 3.3, the default value is 3 which may cause
Shan Wei5d248c42012-12-06 16:27:51 +0000199 unexpected packet loss. The current default value is calculated
Shan Weicc868022012-12-04 18:50:35 +0000200 according to default value of unres_qlen_bytes and true size of
201 packet.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200202
Eric Dumazeteaa72dc2017-08-29 15:16:01 -0700203 Default: 101
Eric Dumazet8b5c1712011-11-09 12:07:14 +0000204
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205mtu_expires - INTEGER
206 Time, in seconds, that cached PMTU information is kept.
207
208min_adv_mss - INTEGER
209 The advertised MSS depends on the first hop route MTU, but will
210 never be lower than this setting.
211
Amit Cohen680aea02021-02-01 21:47:52 +0200212fib_notify_on_flag_change - INTEGER
213 Whether to emit RTM_NEWROUTE notifications whenever RTM_F_OFFLOAD/
Amit Cohen648106c2021-02-07 10:22:51 +0200214 RTM_F_TRAP/RTM_F_OFFLOAD_FAILED flags are changed.
Amit Cohen680aea02021-02-01 21:47:52 +0200215
216 After installing a route to the kernel, user space receives an
217 acknowledgment, which means the route was installed in the kernel,
218 but not necessarily in hardware.
219 It is also possible for a route already installed in hardware to change
220 its action and therefore its flags. For example, a host route that is
221 trapping packets can be "promoted" to perform decapsulation following
222 the installation of an IPinIP/VXLAN tunnel.
223 The notifications will indicate to user-space the state of the route.
224
225 Default: 0 (Do not emit notifications.)
226
227 Possible values:
228
229 - 0 - Do not emit notifications.
230 - 1 - Emit notifications.
Amit Cohen648106c2021-02-07 10:22:51 +0200231 - 2 - Emit notifications only for RTM_F_OFFLOAD_FAILED flag change.
Amit Cohen680aea02021-02-01 21:47:52 +0200232
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233IP Fragmentation:
234
Eric Dumazet3e67f102018-03-31 12:58:53 -0700235ipfrag_high_thresh - LONG INTEGER
Eric Dumazet648700f2018-03-31 12:58:49 -0700236 Maximum memory used to reassemble IP fragments.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000237
Eric Dumazet3e67f102018-03-31 12:58:53 -0700238ipfrag_low_thresh - LONG INTEGER
Eric Dumazet648700f2018-03-31 12:58:49 -0700239 (Obsolete since linux-4.17)
Florian Westphalb13d3cb2014-07-24 16:50:32 +0200240 Maximum memory used to reassemble IP fragments before the kernel
241 begins to remove incomplete fragment queues to free up resources.
242 The kernel still accepts new fragments for defragmentation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
244ipfrag_time - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000245 Time in seconds to keep an IP fragment in memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
Herbert Xu89cee8b2005-12-13 23:14:27 -0800247ipfrag_max_dist - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000248 ipfrag_max_dist is a non-negative integer value which defines the
249 maximum "disorder" which is allowed among fragments which share a
250 common IP source address. Note that reordering of packets is
251 not unusual, but if a large number of fragments arrive from a source
252 IP address while a particular fragment queue remains incomplete, it
253 probably indicates that one or more fragments belonging to that queue
254 have been lost. When ipfrag_max_dist is positive, an additional check
255 is done on fragments before they are added to a reassembly queue - if
256 ipfrag_max_dist (or more) fragments have arrived from a particular IP
257 address between additions to any IP fragment queue using that source
258 address, it's presumed that one or more fragments in the queue are
259 lost. The existing fragment queue will be dropped, and a new one
Herbert Xu89cee8b2005-12-13 23:14:27 -0800260 started. An ipfrag_max_dist value of zero disables this check.
261
262 Using a very small value, e.g. 1 or 2, for ipfrag_max_dist can
263 result in unnecessarily dropping fragment queues when normal
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000264 reordering of packets occurs, which could lead to poor application
265 performance. Using a very large value, e.g. 50000, increases the
266 likelihood of incorrectly reassembling IP fragments that originate
Herbert Xu89cee8b2005-12-13 23:14:27 -0800267 from different IP datagrams, which could result in data corruption.
268 Default: 64
269
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200270INET peer storage
271=================
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
273inet_peer_threshold - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000274 The approximate size of the storage. Starting from this threshold
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 entries will be thrown aggressively. This threshold also determines
276 entries' time-to-live and time intervals between garbage collection
277 passes. More entries, less time-to-live, less GC interval.
278
279inet_peer_minttl - INTEGER
280 Minimum time-to-live of entries. Should be enough to cover fragment
281 time-to-live on the reassembling side. This minimum time-to-live is
282 guaranteed if the pool size is less than inet_peer_threshold.
Stephen Hemminger77a538d2008-07-01 17:22:48 -0700283 Measured in seconds.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
285inet_peer_maxttl - INTEGER
286 Maximum time-to-live of entries. Unused entries will expire after
287 this period of time if there is no memory pressure on the pool (i.e.
288 when the number of entries in the pool is very small).
Stephen Hemminger77a538d2008-07-01 17:22:48 -0700289 Measured in seconds.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200291TCP variables
292=============
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800294somaxconn - INTEGER
295 Limit of socket listen() backlog, known in userspace as SOMAXCONN.
Eric Dumazet19f92a02019-10-30 09:36:20 -0700296 Defaults to 4096. (Was 128 before linux-5.4)
297 See also tcp_max_syn_backlog for additional tuning for TCP sockets.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800298
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800299tcp_abort_on_overflow - BOOLEAN
300 If listening service is too slow to accept new connections,
301 reset them. Default state is FALSE. It means that if overflow
302 occurred due to a burst, connection will recover. Enable this
303 option _only_ if you are really sure that listening daemon
304 cannot be tuned to accept connections faster. Enabling this
305 option can harm clients of your server.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800307tcp_adv_win_scale - INTEGER
308 Count buffering overhead as bytes/2^tcp_adv_win_scale
309 (if tcp_adv_win_scale > 0) or bytes-bytes/2^(-tcp_adv_win_scale),
310 if it is <= 0.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200311
Alexey Dobriyan0147fc02010-11-22 12:54:21 +0000312 Possible values are [-31, 31], inclusive.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200313
Eric Dumazetb49960a2012-05-02 02:28:41 +0000314 Default: 1
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800315
316tcp_allowed_congestion_control - STRING
317 Show/set the congestion control choices available to non-privileged
318 processes. The list is a subset of those listed in
319 tcp_available_congestion_control.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200320
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800321 Default is "reno" and the default setting (tcp_congestion_control).
322
323tcp_app_win - INTEGER
324 Reserve max(window/2^tcp_app_win, mss) of window for application
325 buffer. Value 0 is special, it means that nothing is reserved.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200326
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800327 Default: 31
328
Eric Dumazetf54b3112013-12-05 22:36:05 -0800329tcp_autocorking - BOOLEAN
330 Enable TCP auto corking :
331 When applications do consecutive small write()/sendmsg() system calls,
332 we try to coalesce these small writes as much as possible, to lower
333 total amount of sent packets. This is done if at least one prior
334 packet for the flow is waiting in Qdisc queues or device transmit
335 queue. Applications can still use TCP_CORK for optimal behavior
336 when they know how/when to uncork their sockets.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200337
Eric Dumazetf54b3112013-12-05 22:36:05 -0800338 Default : 1
339
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800340tcp_available_congestion_control - STRING
341 Shows the available congestion control choices that are registered.
342 More congestion control algorithms may be available as modules,
343 but not loaded.
344
John Heffner71599cd2007-02-27 10:03:56 -0800345tcp_base_mss - INTEGER
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700346 The initial value of search_low to be used by the packetization layer
347 Path MTU discovery (MTU probing). If MTU probing is enabled,
348 this is the initial MSS used by the connection.
John Heffner71599cd2007-02-27 10:03:56 -0800349
Josh Huntc04b79b2019-08-07 19:52:29 -0400350tcp_mtu_probe_floor - INTEGER
351 If MTU probing is enabled this caps the minimum MSS used for search_low
352 for the connection.
353
354 Default : 48
355
Eric Dumazet5f3e2bf002019-06-06 09:15:31 -0700356tcp_min_snd_mss - INTEGER
357 TCP SYN and SYNACK messages usually advertise an ADVMSS option,
358 as described in RFC 1122 and RFC 6691.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200359
Eric Dumazet5f3e2bf002019-06-06 09:15:31 -0700360 If this ADVMSS option is smaller than tcp_min_snd_mss,
361 it is silently capped to tcp_min_snd_mss.
362
363 Default : 48 (at least 8 bytes of payload per segment)
364
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800365tcp_congestion_control - STRING
366 Set the congestion control algorithm to be used for new
367 connections. The algorithm "reno" is always available, but
368 additional choices may be available based on kernel configuration.
369 Default is set as part of kernel configuration.
Eric Dumazetd8a6e652011-11-30 01:02:41 +0000370 For passive connections, the listener congestion control choice
371 is inherited.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200372
Eric Dumazetd8a6e652011-11-30 01:02:41 +0000373 [see setsockopt(listenfd, SOL_TCP, TCP_CONGESTION, "name" ...) ]
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800374
375tcp_dsack - BOOLEAN
376 Allows TCP to send "duplicate" SACKs.
377
Yuchung Chengeed530b2012-05-02 13:30:03 +0000378tcp_early_retrans - INTEGER
Yuchung Chengbec41a12017-01-12 22:11:39 -0800379 Tail loss probe (TLP) converts RTOs occurring due to tail
380 losses into fast recovery (draft-ietf-tcpm-rack). Note that
381 TLP requires RACK to function properly (see tcp_recovery below)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200382
Yuchung Chengeed530b2012-05-02 13:30:03 +0000383 Possible values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200384
385 - 0 disables TLP
386 - 3 or 4 enables TLP
387
Nandita Dukkipati6ba8a3b2013-03-11 10:00:43 +0000388 Default: 3
Yuchung Chengeed530b2012-05-02 13:30:03 +0000389
Peter Chubb34a6ef32011-02-02 15:39:58 -0800390tcp_ecn - INTEGER
Rick Jones7e3a2dc2012-11-28 09:53:10 +0000391 Control use of Explicit Congestion Notification (ECN) by TCP.
392 ECN is used only when both ends of the TCP connection indicate
393 support for it. This feature is useful in avoiding losses due
394 to congestion by allowing supporting routers to signal
395 congestion before having to drop packets.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200396
Ilpo Järvinen255cac92009-05-04 11:07:36 -0700397 Possible values are:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200398
399 = =====================================================
400 0 Disable ECN. Neither initiate nor accept ECN.
401 1 Enable ECN when requested by incoming connections and
402 also request ECN on outgoing connection attempts.
403 2 Enable ECN when requested by incoming connections
404 but do not request ECN on outgoing connections.
405 = =====================================================
406
Ilpo Järvinen255cac92009-05-04 11:07:36 -0700407 Default: 2
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800408
Daniel Borkmann49213552015-05-19 21:04:22 +0200409tcp_ecn_fallback - BOOLEAN
410 If the kernel detects that ECN connection misbehaves, enable fall
411 back to non-ECN. Currently, this knob implements the fallback
412 from RFC3168, section 6.1.1.1., but we reserve that in future,
413 additional detection mechanisms could be implemented under this
414 knob. The value is not used, if tcp_ecn or per route (or congestion
415 control) ECN settings are disabled.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200416
Daniel Borkmann49213552015-05-19 21:04:22 +0200417 Default: 1 (fallback enabled)
418
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800419tcp_fack - BOOLEAN
Yuchung Cheng713bafe2017-11-08 13:01:26 -0800420 This is a legacy option, it has no effect anymore.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800421
422tcp_fin_timeout - INTEGER
Rick Jonesd825da22012-12-10 11:33:00 +0000423 The length of time an orphaned (no longer referenced by any
424 application) connection will remain in the FIN_WAIT_2 state
425 before it is aborted at the local end. While a perfectly
426 valid "receive only" state for an un-orphaned connection, an
427 orphaned connection in FIN_WAIT_2 state could otherwise wait
428 forever for the remote to close its end of the connection.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200429
Rick Jonesd825da22012-12-10 11:33:00 +0000430 Cf. tcp_max_orphans
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200431
Rick Jonesd825da22012-12-10 11:33:00 +0000432 Default: 60 seconds
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800433
Ilpo Järvinen89808062007-02-27 10:10:55 -0800434tcp_frto - INTEGER
Yuchung Chenge33099f2013-03-20 13:33:00 +0000435 Enables Forward RTO-Recovery (F-RTO) defined in RFC5682.
Ilpo Järvinencd998892007-09-20 11:35:26 -0700436 F-RTO is an enhanced recovery algorithm for TCP retransmission
Yuchung Chenge33099f2013-03-20 13:33:00 +0000437 timeouts. It is particularly beneficial in networks where the
438 RTT fluctuates (e.g., wireless). F-RTO is sender-side only
439 modification. It does not require any support from the peer.
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700440
Yuchung Chenge33099f2013-03-20 13:33:00 +0000441 By default it's enabled with a non-zero value. 0 disables F-RTO.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
Lorenzo Colittie2d00e62018-10-29 09:30:29 +0900443tcp_fwmark_accept - BOOLEAN
444 If set, incoming connections to listening sockets that do not have a
445 socket mark will set the mark of the accepting socket to the fwmark of
446 the incoming SYN packet. This will cause all packets on that connection
447 (starting from the first SYNACK) to be sent with that fwmark. The
448 listening socket's mark is unchanged. Listening sockets that already
449 have a fwmark set via setsockopt(SOL_SOCKET, SO_MARK, ...) are
450 unaffected.
451
452 Default: 0
453
Neal Cardwell032ee422015-02-06 16:04:38 -0500454tcp_invalid_ratelimit - INTEGER
455 Limit the maximal rate for sending duplicate acknowledgments
456 in response to incoming TCP packets that are for an existing
457 connection but that are invalid due to any of these reasons:
458
459 (a) out-of-window sequence number,
460 (b) out-of-window acknowledgment number, or
461 (c) PAWS (Protection Against Wrapped Sequence numbers) check failure
462
463 This can help mitigate simple "ack loop" DoS attacks, wherein
464 a buggy or malicious middlebox or man-in-the-middle can
465 rewrite TCP header fields in manner that causes each endpoint
466 to think that the other is sending invalid TCP segments, thus
467 causing each side to send an unterminating stream of duplicate
468 acknowledgments for invalid segments.
469
470 Using 0 disables rate-limiting of dupacks in response to
471 invalid segments; otherwise this value specifies the minimal
472 space between sending such dupacks, in milliseconds.
473
474 Default: 500 (milliseconds).
475
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476tcp_keepalive_time - INTEGER
477 How often TCP sends out keepalive messages when keepalive is enabled.
478 Default: 2hours.
479
480tcp_keepalive_probes - INTEGER
481 How many keepalive probes TCP sends out, until it decides that the
482 connection is broken. Default value: 9.
483
484tcp_keepalive_intvl - INTEGER
485 How frequently the probes are send out. Multiplied by
486 tcp_keepalive_probes it is time to kill not responding connection,
487 after probes started. Default value: 75sec i.e. connection
488 will be aborted after ~11 minutes of retries.
489
David Ahern6dd9a142015-12-16 13:20:44 -0800490tcp_l3mdev_accept - BOOLEAN
491 Enables child sockets to inherit the L3 master device index.
492 Enabling this option allows a "global" listen socket to work
493 across L3 master domains (e.g., VRFs) with connected sockets
494 derived from the listen socket to be bound to the L3 domain in
495 which the packets originated. Only valid when the kernel was
496 compiled with CONFIG_NET_L3_MASTER_DEV.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200497
498 Default: 0 (disabled)
David Ahern6dd9a142015-12-16 13:20:44 -0800499
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800500tcp_low_latency - BOOLEAN
Florian Westphalb6690b12017-07-30 03:57:20 +0200501 This is a legacy option, it has no effect anymore.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
503tcp_max_orphans - INTEGER
504 Maximal number of TCP sockets not attached to any user file handle,
505 held by system. If this number is exceeded orphaned connections are
506 reset immediately and warning is printed. This limit exists
507 only to prevent simple DoS attacks, you _must_ not rely on this
508 or lower the limit artificially, but rather increase it
509 (probably, after increasing installed memory),
510 if network conditions require more than default value,
511 and tune network services to linger and kill such states
512 more aggressively. Let me to remind again: each orphan eats
513 up to ~64K of unswappable memory.
514
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515tcp_max_syn_backlog - INTEGER
Eric Dumazet623d0c22019-10-30 10:05:46 -0700516 Maximal number of remembered connection requests (SYN_RECV),
517 which have not received an acknowledgment from connecting client.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200518
Eric Dumazet623d0c22019-10-30 10:05:46 -0700519 This is a per-listener limit.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200520
Peter Pan(潘卫平)99b53bd2011-12-05 21:39:41 +0000521 The minimal value is 128 for low memory machines, and it will
522 increase in proportion to the memory of machine.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200523
Peter Pan(潘卫平)99b53bd2011-12-05 21:39:41 +0000524 If server suffers from overload, try increasing this number.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200525
Eric Dumazet623d0c22019-10-30 10:05:46 -0700526 Remember to also check /proc/sys/net/core/somaxconn
527 A SYN_RECV request socket consumes about 304 bytes of memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800529tcp_max_tw_buckets - INTEGER
530 Maximal number of timewait sockets held by system simultaneously.
531 If this number is exceeded time-wait socket is immediately destroyed
532 and warning is printed. This limit exists only to prevent
533 simple DoS attacks, you _must_ not lower the limit artificially,
534 but rather increase it (probably, after increasing installed memory),
535 if network conditions require more than default value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800537tcp_mem - vector of 3 INTEGERs: min, pressure, max
538 min: below this number of pages TCP is not bothered about its
539 memory appetite.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800541 pressure: when amount of memory allocated by TCP exceeds this number
542 of pages, TCP moderates its memory consumption and enters memory
543 pressure mode, which is exited when memory consumption falls
544 under "min".
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800546 max: number of pages allowed for queueing by all TCP sockets.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800548 Defaults are calculated at boot time from amount of available
549 memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
Yuchung Chengf6722582015-10-16 21:57:42 -0700551tcp_min_rtt_wlen - INTEGER
552 The window length of the windowed min filter to track the minimum RTT.
553 A shorter window lets a flow more quickly pick up new (higher)
554 minimum RTT when it is moved to a longer path (e.g., due to traffic
555 engineering). A longer window makes the filter more resistant to RTT
556 inflations such as transient congestion. The unit is seconds.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200557
ZhangXiaoxu19fad202019-04-16 09:47:24 +0800558 Possible values: 0 - 86400 (1 day)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200559
Yuchung Chengf6722582015-10-16 21:57:42 -0700560 Default: 300
561
John Heffner71599cd2007-02-27 10:03:56 -0800562tcp_moderate_rcvbuf - BOOLEAN
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700563 If set, TCP performs receive buffer auto-tuning, attempting to
John Heffner71599cd2007-02-27 10:03:56 -0800564 automatically size the buffer (no greater than tcp_rmem[2]) to
565 match the size required by the path for full throughput. Enabled by
566 default.
567
568tcp_mtu_probing - INTEGER
569 Controls TCP Packetization-Layer Path MTU Discovery. Takes three
570 values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200571
572 - 0 - Disabled
573 - 1 - Disabled by default, enabled when an ICMP black hole detected
574 - 2 - Always enabled, use initial MSS of tcp_base_mss.
John Heffner71599cd2007-02-27 10:03:56 -0800575
Maciej Żenczykowskid4ce5802018-09-25 21:59:28 -0700576tcp_probe_interval - UNSIGNED INTEGER
Fan Dufab42762015-03-06 11:18:25 +0800577 Controls how often to start TCP Packetization-Layer Path MTU
578 Discovery reprobe. The default is reprobing every 10 minutes as
579 per RFC4821.
580
581tcp_probe_threshold - INTEGER
582 Controls when TCP Packetization-Layer Path MTU Discovery probing
583 will stop in respect to the width of search range in bytes. Default
584 is 8 bytes.
585
John Heffner71599cd2007-02-27 10:03:56 -0800586tcp_no_metrics_save - BOOLEAN
587 By default, TCP saves various connection metrics in the route cache
588 when the connection closes, so that connections established in the
589 near future can use these to set initial conditions. Usually, this
590 increases overall performance, but may sometimes cause performance
Simon Arlott0f035b82007-10-20 01:30:25 +0200591 degradation. If set, TCP will not cache metrics on closing
John Heffner71599cd2007-02-27 10:03:56 -0800592 connections.
593
Kevin(Yudong) Yang65e6d902019-12-09 14:19:59 -0500594tcp_no_ssthresh_metrics_save - BOOLEAN
595 Controls whether TCP saves ssthresh metrics in the route cache.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200596
Kevin(Yudong) Yang65e6d902019-12-09 14:19:59 -0500597 Default is 1, which disables ssthresh metrics.
598
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800599tcp_orphan_retries - INTEGER
Damian Lukowski5d789222009-09-01 10:24:04 +0000600 This value influences the timeout of a locally closed TCP connection,
601 when RTO retransmissions remain unacknowledged.
602 See tcp_retries2 for more details.
603
David S. Miller06b8fc52011-07-08 09:31:31 -0700604 The default value is 8.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200605
Damian Lukowski5d789222009-09-01 10:24:04 +0000606 If your machine is a loaded WEB server,
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800607 you should think about lowering this value, such sockets
608 may consume significant resources. Cf. tcp_max_orphans.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
Yuchung Cheng4f41b1c2015-10-16 21:57:47 -0700610tcp_recovery - INTEGER
611 This value is a bitmap to enable various experimental loss recovery
612 features.
613
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200614 ========= =============================================================
615 RACK: 0x1 enables the RACK loss detection for fast detection of lost
616 retransmissions and tail drops. It also subsumes and disables
617 RFC6675 recovery for SACK connections.
618
619 RACK: 0x2 makes RACK's reordering window static (min_rtt/4).
620
621 RACK: 0x4 disables RACK's DUPACK threshold heuristic
622 ========= =============================================================
Yuchung Cheng4f41b1c2015-10-16 21:57:47 -0700623
624 Default: 0x1
625
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626tcp_reordering - INTEGER
Eric Dumazetdca145f2014-10-27 21:45:24 -0700627 Initial reordering level of packets in a TCP stream.
628 TCP stack can then dynamically adjust flow reordering level
629 between this initial value and tcp_max_reordering
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200630
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000631 Default: 3
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
Eric Dumazetdca145f2014-10-27 21:45:24 -0700633tcp_max_reordering - INTEGER
634 Maximal reordering level of packets in a TCP stream.
635 300 is a fairly conservative value, but you might increase it
636 if paths are using per packet load balancing (like bonding rr mode)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200637
Eric Dumazetdca145f2014-10-27 21:45:24 -0700638 Default: 300
639
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640tcp_retrans_collapse - BOOLEAN
641 Bug-to-bug compatibility with some broken printers.
642 On retransmit try to send bigger packets to work around bugs in
643 certain TCP stacks.
644
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800645tcp_retries1 - INTEGER
Damian Lukowski5d789222009-09-01 10:24:04 +0000646 This value influences the time, after which TCP decides, that
647 something is wrong due to unacknowledged RTO retransmissions,
648 and reports this suspicion to the network layer.
649 See tcp_retries2 for more details.
650
651 RFC 1122 recommends at least 3 retransmissions, which is the
652 default.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800654tcp_retries2 - INTEGER
Damian Lukowski5d789222009-09-01 10:24:04 +0000655 This value influences the timeout of an alive TCP connection,
656 when RTO retransmissions remain unacknowledged.
657 Given a value of N, a hypothetical TCP connection following
658 exponential backoff with an initial RTO of TCP_RTO_MIN would
659 retransmit N times before killing the connection at the (N+1)th RTO.
660
661 The default value of 15 yields a hypothetical timeout of 924.6
662 seconds and is a lower bound for the effective timeout.
663 TCP will effectively time out at the first RTO which exceeds the
664 hypothetical timeout.
665
666 RFC 1122 recommends at least 100 seconds for the timeout,
667 which corresponds to a value of at least 8.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800669tcp_rfc1337 - BOOLEAN
670 If set, the TCP stack behaves conforming to RFC1337. If unset,
671 we are not conforming to RFC, but prevent TCP TIME_WAIT
672 assassination.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200673
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800674 Default: 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675
676tcp_rmem - vector of 3 INTEGERs: min, default, max
677 min: Minimal size of receive buffer used by TCP sockets.
678 It is guaranteed to each TCP socket, even under moderate memory
679 pressure.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200680
Tonghao Zhanga61a86f2018-02-04 18:07:10 -0800681 Default: 4K
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
J. Bruce Fields53025f52008-07-10 16:47:41 -0700683 default: initial size of receive buffer used by TCP sockets.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 This value overrides net.core.rmem_default used by other protocols.
Eric Dumazet1d1be912021-02-10 09:13:33 -0800685 Default: 131072 bytes.
686 This value results in initial window of 65535.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
688 max: maximal size of receive buffer allowed for automatically
689 selected receiver buffers for TCP socket. This value does not override
J. Bruce Fields53025f52008-07-10 16:47:41 -0700690 net.core.rmem_max. Calling setsockopt() with SO_RCVBUF disables
691 automatic tuning of that socket's receive buffer size, in which
692 case this value is ignored.
Eric Dumazet1d1be912021-02-10 09:13:33 -0800693 Default: between 131072 and 6MB, depending on RAM size.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800695tcp_sack - BOOLEAN
696 Enable select acknowledgments (SACKS).
Rick Jones15d99e02006-03-20 22:40:29 -0800697
Eric Dumazet6d82aa22018-05-17 14:47:28 -0700698tcp_comp_sack_delay_ns - LONG INTEGER
699 TCP tries to reduce number of SACK sent, using a timer
700 based on 5% of SRTT, capped by this sysctl, in nano seconds.
701 The default is 1ms, based on TSO autosizing period.
702
703 Default : 1,000,000 ns (1 ms)
704
Eric Dumazeta70437c2020-04-30 10:35:43 -0700705tcp_comp_sack_slack_ns - LONG INTEGER
706 This sysctl control the slack used when arming the
707 timer used by SACK compression. This gives extra time
708 for small RTT flows, and reduces system overhead by allowing
709 opportunistic reduction of timer interrupts.
710
711 Default : 100,000 ns (100 us)
712
Eric Dumazet9c21d2f2018-05-17 14:47:29 -0700713tcp_comp_sack_nr - INTEGER
Masanari Iida2bcd9d82019-05-21 12:41:15 +0900714 Max number of SACK that can be compressed.
Eric Dumazet9c21d2f2018-05-17 14:47:29 -0700715 Using 0 disables SACK compression.
716
Masanari Iida2bcd9d82019-05-21 12:41:15 +0900717 Default : 44
Eric Dumazet9c21d2f2018-05-17 14:47:29 -0700718
David S. Miller35089bb2006-06-13 22:33:04 -0700719tcp_slow_start_after_idle - BOOLEAN
720 If set, provide RFC2861 behavior and time out the congestion
721 window after an idle period. An idle period is defined at
722 the current RTO. If unset, the congestion window will not
723 be timed out after an idle period.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200724
David S. Miller35089bb2006-06-13 22:33:04 -0700725 Default: 1
726
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800727tcp_stdurg - BOOLEAN
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700728 Use the Host requirements interpretation of the TCP urgent pointer field.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800729 Most hosts use the older BSD interpretation, so if you turn this on
730 Linux might not communicate correctly with them.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200731
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800732 Default: FALSE
733
734tcp_synack_retries - INTEGER
735 Number of times SYNACKs for a passive TCP connection attempt will
736 be retransmitted. Should not be higher than 255. Default value
Alex Bergmann6c9ff972012-08-31 02:48:31 +0000737 is 5, which corresponds to 31seconds till the last retransmission
738 with the current initial RTO of 1second. With this the final timeout
739 for a passive TCP connection will happen after 63seconds.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800740
David S. Millerd8513df2020-01-02 16:07:38 -0800741tcp_syncookies - INTEGER
Shan Weia3c910d2013-06-21 15:18:32 +0800742 Only valid when the kernel was compiled with CONFIG_SYN_COOKIES
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800743 Send out syncookies when the syn backlog queue of a socket
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700744 overflows. This is to prevent against the common 'SYN flood attack'
Shan Weia3c910d2013-06-21 15:18:32 +0800745 Default: 1
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800746
747 Note, that syncookies is fallback facility.
748 It MUST NOT be used to help highly loaded servers to stand
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700749 against legal connection rate. If you see SYN flood warnings
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800750 in your logs, but investigation shows that they occur
751 because of overload with legal connections, you should tune
752 another parameters until this warning disappear.
753 See: tcp_max_syn_backlog, tcp_synack_retries, tcp_abort_on_overflow.
754
755 syncookies seriously violate TCP protocol, do not allow
756 to use TCP extensions, can result in serious degradation
757 of some services (f.e. SMTP relaying), visible not by you,
758 but your clients and relays, contacting you. While you see
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700759 SYN flood warnings in logs not being really flooded, your server
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800760 is seriously misconfigured.
761
Hannes Frederic Sowa5ad37d52013-07-26 17:43:23 +0200762 If you want to test which effects syncookies have to your
763 network connections you can set this knob to 2 to enable
764 unconditionally generation of syncookies.
765
Kuniyuki Iwashimaf9ac7792021-06-12 21:32:14 +0900766tcp_migrate_req - BOOLEAN
767 The incoming connection is tied to a specific listening socket when
768 the initial SYN packet is received during the three-way handshake.
769 When a listener is closed, in-flight request sockets during the
770 handshake and established sockets in the accept queue are aborted.
771
772 If the listener has SO_REUSEPORT enabled, other listeners on the
773 same port should have been able to accept such connections. This
774 option makes it possible to migrate such child sockets to another
775 listener after close() or shutdown().
776
777 The BPF_SK_REUSEPORT_SELECT_OR_MIGRATE type of eBPF program should
778 usually be used to define the policy to pick an alive listener.
779 Otherwise, the kernel will randomly pick an alive listener only if
780 this option is enabled.
781
782 Note that migration between listeners with different settings may
783 crash applications. Let's say migration happens from listener A to
784 B, and only B has TCP_SAVE_SYN enabled. B cannot read SYN data from
785 the requests migrated from A. To avoid such a situation, cancel
786 migration by returning SK_DROP in the type of eBPF program, or
787 disable this option.
788
789 Default: 0
790
Yuchung Chengcf60af02012-07-19 06:43:09 +0000791tcp_fastopen - INTEGER
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700792 Enable TCP Fast Open (RFC7413) to send and accept data in the opening
793 SYN packet.
794
795 The client support is enabled by flag 0x1 (on by default). The client
796 then must use sendmsg() or sendto() with the MSG_FASTOPEN flag,
797 rather than connect() to send data in SYN.
798
799 The server support is enabled by flag 0x2 (off by default). Then
800 either enable for all listeners with another flag (0x400) or
801 enable individual listeners via TCP_FASTOPEN socket option with
802 the option value being the length of the syn-data backlog.
Yuchung Chengcf60af02012-07-19 06:43:09 +0000803
Jerry Chu10467162012-08-31 12:29:11 +0000804 The values (bitmap) are
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200805
806 ===== ======== ======================================================
807 0x1 (client) enables sending data in the opening SYN on the client.
808 0x2 (server) enables the server support, i.e., allowing data in
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700809 a SYN packet to be accepted and passed to the
810 application before 3-way handshake finishes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200811 0x4 (client) send data in the opening SYN regardless of cookie
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700812 availability and without a cookie option.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200813 0x200 (server) accept data-in-SYN w/o any cookie option present.
814 0x400 (server) enable all listeners to support Fast Open by
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700815 default without explicit TCP_FASTOPEN socket option.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200816 ===== ======== ======================================================
Yuchung Chengcf60af02012-07-19 06:43:09 +0000817
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700818 Default: 0x1
Yuchung Chengcf60af02012-07-19 06:43:09 +0000819
Randy Dunlapa7db3c72020-07-03 15:41:13 -0700820 Note that additional client or server features are only
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700821 effective if the basic support (0x1 and 0x2) are enabled respectively.
Jerry Chu10467162012-08-31 12:29:11 +0000822
Wei Wangcf1ef3f2017-04-20 14:45:46 -0700823tcp_fastopen_blackhole_timeout_sec - INTEGER
824 Initial time period in second to disable Fastopen on active TCP sockets
825 when a TFO firewall blackhole issue happens.
826 This time period will grow exponentially when more blackhole issues
827 get detected right after Fastopen is re-enabled and will reset to
828 initial value when the blackhole issue goes away.
Yuchung Cheng72685862017-12-12 13:10:40 -0800829 0 to disable the blackhole detection.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200830
Wei Wang213ad732021-07-21 10:27:38 -0700831 By default, it is set to 0 (feature is disabled).
Wei Wangcf1ef3f2017-04-20 14:45:46 -0700832
Jason Baron2dc7e482019-05-29 12:34:00 -0400833tcp_fastopen_key - list of comma separated 32-digit hexadecimal INTEGERs
834 The list consists of a primary key and an optional backup key. The
835 primary key is used for both creating and validating cookies, while the
836 optional backup key is only used for validating cookies. The purpose of
837 the backup key is to maximize TFO validation when keys are rotated.
838
839 A randomly chosen primary key may be configured by the kernel if
840 the tcp_fastopen sysctl is set to 0x400 (see above), or if the
841 TCP_FASTOPEN setsockopt() optname is set and a key has not been
842 previously configured via sysctl. If keys are configured via
843 setsockopt() by using the TCP_FASTOPEN_KEY optname, then those
844 per-socket keys will be used instead of any keys that are specified via
845 sysctl.
846
847 A key is specified as 4 8-digit hexadecimal integers which are separated
848 by a '-' as: xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx. Leading zeros may be
849 omitted. A primary and a backup key may be specified by separating them
850 by a comma. If only one key is specified, it becomes the primary key and
851 any previously configured backup keys are removed.
852
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800853tcp_syn_retries - INTEGER
854 Number of times initial SYNs for an active TCP connection attempt
Xin Longbffae692016-01-20 16:12:33 +0800855 will be retransmitted. Should not be higher than 127. Default value
stephen hemminger3b09adc2013-01-03 07:50:29 +0000856 is 6, which corresponds to 63seconds till the last retransmission
Alex Bergmann6c9ff972012-08-31 02:48:31 +0000857 with the current initial RTO of 1second. With this the final timeout
858 for an active TCP connection attempt will happen after 127seconds.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800859
Florian Westphal25429d72016-12-01 11:32:07 +0100860tcp_timestamps - INTEGER
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200861 Enable timestamps as defined in RFC1323.
862
863 - 0: Disabled.
864 - 1: Enable timestamps as defined in RFC1323 and use random offset for
865 each connection rather than only using the current time.
866 - 2: Like 1, but without random offsets.
867
Florian Westphal25429d72016-12-01 11:32:07 +0100868 Default: 1
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800869
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700870tcp_min_tso_segs - INTEGER
871 Minimal number of segments per TSO frame.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200872
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700873 Since linux-3.12, TCP does an automatic sizing of TSO frames,
874 depending on flow rate, instead of filling 64Kbytes packets.
875 For specific usages, it's possible to force TCP to build big
876 TSO frames. Note that TCP stack might split too big TSO packets
877 if available window is too small.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200878
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700879 Default: 2
880
Eric Dumazet43e122b2015-08-21 17:38:02 -0700881tcp_pacing_ss_ratio - INTEGER
882 sk->sk_pacing_rate is set by TCP stack using a ratio applied
883 to current rate. (current_rate = cwnd * mss / srtt)
884 If TCP is in slow start, tcp_pacing_ss_ratio is applied
885 to let TCP probe for bigger speeds, assuming cwnd can be
886 doubled every other RTT.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200887
Eric Dumazet43e122b2015-08-21 17:38:02 -0700888 Default: 200
889
890tcp_pacing_ca_ratio - INTEGER
891 sk->sk_pacing_rate is set by TCP stack using a ratio applied
892 to current rate. (current_rate = cwnd * mss / srtt)
893 If TCP is in congestion avoidance phase, tcp_pacing_ca_ratio
894 is applied to conservatively probe for bigger throughput.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200895
Eric Dumazet43e122b2015-08-21 17:38:02 -0700896 Default: 120
897
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800898tcp_tso_win_divisor - INTEGER
899 This allows control over what percentage of the congestion window
900 can be consumed by a single TSO frame.
901 The setting of this parameter is a choice between burstiness and
902 building larger TSO frames.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200903
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800904 Default: 3
905
Maciej Żenczykowski79e9fed2018-06-03 10:41:17 -0700906tcp_tw_reuse - INTEGER
907 Enable reuse of TIME-WAIT sockets for new connections when it is
908 safe from protocol viewpoint.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200909
910 - 0 - disable
911 - 1 - global enable
912 - 2 - enable for loopback traffic only
913
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800914 It should not be changed without advice/request of technical
915 experts.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200916
Maciej Żenczykowski79e9fed2018-06-03 10:41:17 -0700917 Default: 2
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800918
919tcp_window_scaling - BOOLEAN
920 Enable window scaling as defined in RFC1323.
921
922tcp_wmem - vector of 3 INTEGERs: min, default, max
J. Bruce Fields53025f52008-07-10 16:47:41 -0700923 min: Amount of memory reserved for send buffers for TCP sockets.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800924 Each TCP socket has rights to use it due to fact of its birth.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200925
Tonghao Zhanga61a86f2018-02-04 18:07:10 -0800926 Default: 4K
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800927
J. Bruce Fields53025f52008-07-10 16:47:41 -0700928 default: initial size of send buffer used by TCP sockets. This
929 value overrides net.core.wmem_default used by other protocols.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200930
J. Bruce Fields53025f52008-07-10 16:47:41 -0700931 It is usually lower than net.core.wmem_default.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200932
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800933 Default: 16K
934
J. Bruce Fields53025f52008-07-10 16:47:41 -0700935 max: Maximal amount of memory allowed for automatically tuned
936 send buffers for TCP sockets. This value does not override
937 net.core.wmem_max. Calling setsockopt() with SO_SNDBUF disables
938 automatic tuning of that socket's send buffer size, in which case
939 this value is ignored.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200940
J. Bruce Fields53025f52008-07-10 16:47:41 -0700941 Default: between 64K and 4MB, depending on RAM size.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800942
Eric Dumazetc9bee3b72013-07-22 20:27:07 -0700943tcp_notsent_lowat - UNSIGNED INTEGER
944 A TCP socket can control the amount of unsent bytes in its write queue,
945 thanks to TCP_NOTSENT_LOWAT socket option. poll()/select()/epoll()
946 reports POLLOUT events if the amount of unsent bytes is below a per
947 socket value, and if the write queue is not full. sendmsg() will
948 also not add new buffers if the limit is hit.
949
950 This global variable controls the amount of unsent data for
951 sockets not using TCP_NOTSENT_LOWAT. For these sockets, a change
952 to the global variable has immediate effect.
953
954 Default: UINT_MAX (0xFFFFFFFF)
955
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800956tcp_workaround_signed_windows - BOOLEAN
957 If set, assume no receipt of a window scaling option means the
958 remote TCP is broken and treats the window as a signed quantity.
959 If unset, assume the remote TCP is not broken even if we do
960 not receive a window scaling option from them.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200961
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800962 Default: 0
963
Andreas Petlund36e31b0a2010-02-18 02:47:01 +0000964tcp_thin_linear_timeouts - BOOLEAN
965 Enable dynamic triggering of linear timeouts for thin streams.
966 If set, a check is performed upon retransmission by timeout to
967 determine if the stream is thin (less than 4 packets in flight).
968 As long as the stream is found to be thin, up to 6 linear
969 timeouts may be performed before exponential backoff mode is
970 initiated. This improves retransmission latency for
971 non-aggressive thin streams, often found to be time-dependent.
972 For more information on thin streams, see
Mauro Carvalho Chehabff159f42020-04-30 18:04:29 +0200973 Documentation/networking/tcp-thin.rst
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200974
Andreas Petlund36e31b0a2010-02-18 02:47:01 +0000975 Default: 0
976
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000977tcp_limit_output_bytes - INTEGER
978 Controls TCP Small Queue limit per tcp socket.
979 TCP bulk sender tends to increase packets in flight until it
980 gets losses notifications. With SNDBUF autotuning, this can
Flavio Leitner9c4c3252018-06-27 10:34:26 -0300981 result in a large amount of packets queued on the local machine
982 (e.g.: qdiscs, CPU backlog, or device) hurting latency of other
983 flows, for typical pfifo_fast qdiscs. tcp_limit_output_bytes
984 limits the number of bytes on qdisc or device to reduce artificial
985 RTT/cwnd and reduce bufferbloat.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200986
Eric Dumazetc73e5802018-11-11 07:34:28 -0800987 Default: 1048576 (16 * 65536)
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000988
Eric Dumazet282f23c2012-07-17 10:13:05 +0200989tcp_challenge_ack_limit - INTEGER
990 Limits number of Challenge ACK sent per second, as recommended
991 in RFC 5961 (Improving TCP's Robustness to Blind In-Window Attacks)
Cambda Zhu53099602020-04-15 17:54:04 +0800992 Default: 1000
Eric Dumazet282f23c2012-07-17 10:13:05 +0200993
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +0200994UDP variables
995=============
Hideo Aoki95766ff2007-12-31 00:29:24 -0800996
Robert Shearman63a6fff2017-01-26 18:02:24 +0000997udp_l3mdev_accept - BOOLEAN
998 Enabling this option allows a "global" bound socket to work
999 across L3 master domains (e.g., VRFs) with packets capable of
1000 being received regardless of the L3 domain in which they
1001 originated. Only valid when the kernel was compiled with
1002 CONFIG_NET_L3_MASTER_DEV.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001003
1004 Default: 0 (disabled)
Robert Shearman63a6fff2017-01-26 18:02:24 +00001005
Hideo Aoki95766ff2007-12-31 00:29:24 -08001006udp_mem - vector of 3 INTEGERs: min, pressure, max
1007 Number of pages allowed for queueing by all UDP sockets.
1008
Menglong Dong69dfccb2021-11-05 15:35:41 +08001009 min: Number of pages allowed for queueing by all UDP sockets.
Hideo Aoki95766ff2007-12-31 00:29:24 -08001010
1011 pressure: This value was introduced to follow format of tcp_mem.
1012
Menglong Dong69dfccb2021-11-05 15:35:41 +08001013 max: This value was introduced to follow format of tcp_mem.
Hideo Aoki95766ff2007-12-31 00:29:24 -08001014
1015 Default is calculated at boot time from amount of available memory.
1016
1017udp_rmem_min - INTEGER
1018 Minimal size of receive buffer used by UDP sockets in moderation.
1019 Each UDP socket is able to use the size for receiving data, even if
1020 total pages of UDP sockets exceed udp_mem pressure. The unit is byte.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001021
Tonghao Zhang320bd6d2018-03-13 21:57:17 -07001022 Default: 4K
Hideo Aoki95766ff2007-12-31 00:29:24 -08001023
1024udp_wmem_min - INTEGER
1025 Minimal size of send buffer used by UDP sockets in moderation.
1026 Each UDP socket is able to use the size for sending data, even if
1027 total pages of UDP sockets exceed udp_mem pressure. The unit is byte.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001028
Tonghao Zhang320bd6d2018-03-13 21:57:17 -07001029 Default: 4K
Hideo Aoki95766ff2007-12-31 00:29:24 -08001030
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001031RAW variables
1032=============
Mike Manning68974452018-11-07 15:36:05 +00001033
1034raw_l3mdev_accept - BOOLEAN
1035 Enabling this option allows a "global" bound socket to work
1036 across L3 master domains (e.g., VRFs) with packets capable of
1037 being received regardless of the L3 domain in which they
1038 originated. Only valid when the kernel was compiled with
1039 CONFIG_NET_L3_MASTER_DEV.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001040
Mike Manning68974452018-11-07 15:36:05 +00001041 Default: 1 (enabled)
1042
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001043CIPSOv4 Variables
1044=================
Paul Moore8802f612006-08-03 16:45:49 -07001045
1046cipso_cache_enable - BOOLEAN
1047 If set, enable additions to and lookups from the CIPSO label mapping
1048 cache. If unset, additions are ignored and lookups always result in a
1049 miss. However, regardless of the setting the cache is still
1050 invalidated when required when means you can safely toggle this on and
1051 off and the cache will always be "safe".
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001052
Paul Moore8802f612006-08-03 16:45:49 -07001053 Default: 1
1054
1055cipso_cache_bucket_size - INTEGER
1056 The CIPSO label cache consists of a fixed size hash table with each
1057 hash bucket containing a number of cache entries. This variable limits
1058 the number of entries in each hash bucket; the larger the value the
1059 more CIPSO label mappings that can be cached. When the number of
1060 entries in a given hash bucket reaches this limit adding new entries
1061 causes the oldest entry in the bucket to be removed to make room.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001062
Paul Moore8802f612006-08-03 16:45:49 -07001063 Default: 10
1064
1065cipso_rbm_optfmt - BOOLEAN
1066 Enable the "Optimized Tag 1 Format" as defined in section 3.4.2.6 of
1067 the CIPSO draft specification (see Documentation/netlabel for details).
1068 This means that when set the CIPSO tag will be padded with empty
1069 categories in order to make the packet data 32-bit aligned.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001070
Paul Moore8802f612006-08-03 16:45:49 -07001071 Default: 0
1072
1073cipso_rbm_structvalid - BOOLEAN
1074 If set, do a very strict check of the CIPSO option when
1075 ip_options_compile() is called. If unset, relax the checks done during
1076 ip_options_compile(). Either way is "safe" as errors are caught else
1077 where in the CIPSO processing code but setting this to 0 (False) should
1078 result in less work (i.e. it should be faster) but could cause problems
1079 with other implementations that require strict checking.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001080
Paul Moore8802f612006-08-03 16:45:49 -07001081 Default: 0
1082
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001083IP Variables
1084============
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085
1086ip_local_port_range - 2 INTEGERS
1087 Defines the local port range that is used by TCP and UDP to
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001088 choose the local port. The first number is the first, the
Eric Dumazet07f4c902015-05-24 14:49:35 -07001089 second the last local port number.
Maciej Żenczykowskiac716762019-11-25 14:48:00 -08001090 If possible, it is better these numbers have different parity
1091 (one even and one odd value).
1092 Must be greater than or equal to ip_unprivileged_port_start.
Eric Dumazet07f4c902015-05-24 14:49:35 -07001093 The default values are 32768 and 60999 respectively.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094
Amerigo Wange3826f12010-05-05 00:27:06 +00001095ip_local_reserved_ports - list of comma separated ranges
1096 Specify the ports which are reserved for known third-party
1097 applications. These ports will not be used by automatic port
1098 assignments (e.g. when calling connect() or bind() with port
1099 number 0). Explicit port allocation behavior is unchanged.
1100
1101 The format used for both input and output is a comma separated
1102 list of ranges (e.g. "1,2-4,10-10" for ports 1, 2, 3, 4 and
1103 10). Writing to the file will clear all previously reserved
1104 ports and update the current list with the one given in the
1105 input.
1106
1107 Note that ip_local_port_range and ip_local_reserved_ports
1108 settings are independent and both are considered by the kernel
1109 when determining which ports are available for automatic port
1110 assignments.
1111
1112 You can reserve ports which are not in the current
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001113 ip_local_port_range, e.g.::
Amerigo Wange3826f12010-05-05 00:27:06 +00001114
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001115 $ cat /proc/sys/net/ipv4/ip_local_port_range
1116 32000 60999
1117 $ cat /proc/sys/net/ipv4/ip_local_reserved_ports
1118 8080,9148
Amerigo Wange3826f12010-05-05 00:27:06 +00001119
1120 although this is redundant. However such a setting is useful
1121 if later the port range is changed to a value that will
Otto Hollmanna7a80b12021-04-01 17:57:05 +02001122 include the reserved ports. Also keep in mind, that overlapping
1123 of these ranges may affect probability of selecting ephemeral
1124 ports which are right after block of reserved ports.
Amerigo Wange3826f12010-05-05 00:27:06 +00001125
1126 Default: Empty
1127
Krister Johansen4548b682017-01-20 17:49:11 -08001128ip_unprivileged_port_start - INTEGER
1129 This is a per-namespace sysctl. It defines the first
1130 unprivileged port in the network namespace. Privileged ports
1131 require root or CAP_NET_BIND_SERVICE in order to bind to them.
Maciej Żenczykowskiac716762019-11-25 14:48:00 -08001132 To disable all privileged ports, set this to 0. They must not
1133 overlap with the ip_local_port_range.
Krister Johansen4548b682017-01-20 17:49:11 -08001134
1135 Default: 1024
1136
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137ip_nonlocal_bind - BOOLEAN
1138 If set, allows processes to bind() to non-local IP addresses,
1139 which can be quite useful - but may break some applications.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001140
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 Default: 0
1142
Kuniyuki Iwashima4b01a962020-03-10 17:05:25 +09001143ip_autobind_reuse - BOOLEAN
1144 By default, bind() does not select the ports automatically even if
1145 the new socket and all sockets bound to the port have SO_REUSEADDR.
1146 ip_autobind_reuse allows bind() to reuse the port and this is useful
1147 when you use bind()+connect(), but may break some applications.
1148 The preferred solution is to use IP_BIND_ADDRESS_NO_PORT and this
1149 option should only be set by experts.
1150 Default: 0
1151
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152ip_dynaddr - BOOLEAN
1153 If set non-zero, enables support for dynamic addresses.
1154 If set to a non-zero value larger than 1, a kernel log
1155 message will be printed when dynamic address rewriting
1156 occurs.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001157
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 Default: 0
1159
Cong Wange3d73bc2013-06-11 18:54:39 +08001160ip_early_demux - BOOLEAN
1161 Optimize input packet processing down to one demux for
1162 certain kinds of local sockets. Currently we only do this
subashab@codeaurora.orgdddb64b2017-03-23 13:34:16 -06001163 for established TCP and connected UDP sockets.
Cong Wange3d73bc2013-06-11 18:54:39 +08001164
1165 It may add an additional cost for pure routing workloads that
1166 reduces overall throughput, in such case you should disable it.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001167
Cong Wange3d73bc2013-06-11 18:54:39 +08001168 Default: 1
1169
Stephen Hemminger5cc4adb2020-04-21 13:34:48 -07001170ping_group_range - 2 INTEGERS
1171 Restrict ICMP_PROTO datagram sockets to users in the group range.
1172 The default is "1 0", meaning, that nobody (not even root) may
1173 create ping sockets. Setting it to "100 100" would grant permissions
1174 to the single group. "0 4294967295" would enable it for the world, "100
1175 4294967295" would enable it for the users, but not daemons.
1176
subashab@codeaurora.orgdddb64b2017-03-23 13:34:16 -06001177tcp_early_demux - BOOLEAN
1178 Enable early demux for established TCP sockets.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001179
subashab@codeaurora.orgdddb64b2017-03-23 13:34:16 -06001180 Default: 1
1181
1182udp_early_demux - BOOLEAN
1183 Enable early demux for connected UDP sockets. Disable this if
1184 your system could experience more unconnected load.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001185
subashab@codeaurora.orgdddb64b2017-03-23 13:34:16 -06001186 Default: 1
1187
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188icmp_echo_ignore_all - BOOLEAN
David S. Miller7ce312462005-10-03 16:07:30 -07001189 If set non-zero, then the kernel will ignore all ICMP ECHO
1190 requests sent to it.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001191
David S. Miller7ce312462005-10-03 16:07:30 -07001192 Default: 0
1193
Andreas Roeselerf1b8fa92021-03-29 18:45:29 -07001194icmp_echo_enable_probe - BOOLEAN
1195 If set to one, then the kernel will respond to RFC 8335 PROBE
1196 requests sent to it.
1197
1198 Default: 0
1199
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200icmp_echo_ignore_broadcasts - BOOLEAN
David S. Miller7ce312462005-10-03 16:07:30 -07001201 If set non-zero, then the kernel will ignore all ICMP ECHO and
1202 TIMESTAMP requests sent to it via broadcast/multicast.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001203
David S. Miller7ce312462005-10-03 16:07:30 -07001204 Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205
1206icmp_ratelimit - INTEGER
1207 Limit the maximal rates for sending ICMP packets whose type matches
1208 icmp_ratemask (see below) to specific targets.
Stephen Hemminger6dbf4bc2008-07-01 19:29:07 -07001209 0 to disable any limiting,
1210 otherwise the minimal space between responses in milliseconds.
Eric Dumazet4cdf5072014-09-19 07:38:40 -07001211 Note that another sysctl, icmp_msgs_per_sec limits the number
1212 of ICMP packets sent on all targets.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001213
Stephen Hemminger6dbf4bc2008-07-01 19:29:07 -07001214 Default: 1000
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215
Eric Dumazet4cdf5072014-09-19 07:38:40 -07001216icmp_msgs_per_sec - INTEGER
1217 Limit maximal number of ICMP packets sent per second from this host.
1218 Only messages whose type matches icmp_ratemask (see below) are
Eric Dumazetb38e7812020-10-15 11:42:00 -07001219 controlled by this limit. For security reasons, the precise count
1220 of messages per second is randomized.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001221
Eric Dumazet4cdf5072014-09-19 07:38:40 -07001222 Default: 1000
1223
1224icmp_msgs_burst - INTEGER
1225 icmp_msgs_per_sec controls number of ICMP packets sent per second,
1226 while icmp_msgs_burst controls the burst size of these packets.
Eric Dumazetb38e7812020-10-15 11:42:00 -07001227 For security reasons, the precise burst size is randomized.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001228
Eric Dumazet4cdf5072014-09-19 07:38:40 -07001229 Default: 50
1230
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231icmp_ratemask - INTEGER
1232 Mask made of ICMP types for which rates are being limited.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001233
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 Significant bits: IHGFEDCBA9876543210
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001235
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 Default mask: 0000001100000011000 (6168)
1237
1238 Bit definitions (see include/linux/icmp.h):
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001239
1240 = =========================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 0 Echo Reply
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001242 3 Destination Unreachable [1]_
1243 4 Source Quench [1]_
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 5 Redirect
1245 8 Echo Request
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001246 B Time Exceeded [1]_
1247 C Parameter Problem [1]_
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 D Timestamp Request
1249 E Timestamp Reply
1250 F Info Request
1251 G Info Reply
1252 H Address Mask Request
1253 I Address Mask Reply
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001254 = =========================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001256 .. [1] These are rate limited by default (see default mask above)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257
1258icmp_ignore_bogus_error_responses - BOOLEAN
1259 Some routers violate RFC1122 by sending bogus responses to broadcast
1260 frames. Such violations are normally logged via a kernel warning.
1261 If this is set to TRUE, the kernel will not give such warnings, which
1262 will avoid log file clutter.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001263
Rami Rosene8b265e2013-06-07 20:16:19 +00001264 Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265
Horms95f7daf2006-02-02 17:02:25 -08001266icmp_errors_use_inbound_ifaddr - BOOLEAN
1267
Paolo Abeni02a6d612015-10-14 14:25:53 +02001268 If zero, icmp error messages are sent with the primary address of
1269 the exiting interface.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001270
Horms95f7daf2006-02-02 17:02:25 -08001271 If non-zero, the message will be sent with the primary address of
1272 the interface that received the packet that caused the icmp error.
Vincent Bernat31628202021-01-30 20:05:18 +01001273 This is the behaviour many network administrators will expect from
Horms95f7daf2006-02-02 17:02:25 -08001274 a router. And it can make debugging complicated network layouts
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001275 much easier.
Horms95f7daf2006-02-02 17:02:25 -08001276
1277 Note that if no primary address exists for the interface selected,
1278 then the primary address of the first non-loopback interface that
Matt LaPlanted6bc8ac2006-10-03 22:54:15 +02001279 has one will be used regardless of this setting.
Horms95f7daf2006-02-02 17:02:25 -08001280
1281 Default: 0
1282
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283igmp_max_memberships - INTEGER
1284 Change the maximum number of multicast groups we can subscribe to.
1285 Default: 20
1286
Jeremy Ederd67ef352010-11-15 05:41:31 +00001287 Theoretical maximum value is bounded by having to send a membership
1288 report in a single datagram (i.e. the report can't span multiple
1289 datagrams, or risk confusing the switch and leaving groups you don't
1290 intend to).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291
Jeremy Ederd67ef352010-11-15 05:41:31 +00001292 The number of supported groups 'M' is bounded by the number of group
1293 report entries you can fit into a single datagram of 65535 bytes.
1294
1295 M = 65536-sizeof (ip header)/(sizeof(Group record))
1296
1297 Group records are variable length, with a minimum of 12 bytes.
1298 So net.ipv4.igmp_max_memberships should not be set higher than:
1299
1300 (65536-24) / 12 = 5459
1301
1302 The value 5459 assumes no IP header options, so in practice
1303 this number may be lower.
1304
Benjamin Poirier537377d2016-03-21 13:21:40 -07001305igmp_max_msf - INTEGER
1306 Maximum number of addresses allowed in the source filter list for a
1307 multicast group.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001308
Benjamin Poirier537377d2016-03-21 13:21:40 -07001309 Default: 10
1310
Hannes Frederic Sowaa9fe8e22014-09-02 15:49:26 +02001311igmp_qrv - INTEGER
Benjamin Poirier537377d2016-03-21 13:21:40 -07001312 Controls the IGMP query robustness variable (see RFC2236 8.1).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001313
Benjamin Poirier537377d2016-03-21 13:21:40 -07001314 Default: 2 (as specified by RFC2236 8.1)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001315
Benjamin Poirier537377d2016-03-21 13:21:40 -07001316 Minimum: 1 (as specified by RFC6636 4.5)
Hannes Frederic Sowaa9fe8e22014-09-02 15:49:26 +02001317
Hangbin Liu1af92832016-11-07 14:51:23 +08001318force_igmp_version - INTEGER
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001319 - 0 - (default) No enforcement of a IGMP version, IGMPv1/v2 fallback
1320 allowed. Will back to IGMPv3 mode again if all IGMPv1/v2 Querier
1321 Present timer expires.
1322 - 1 - Enforce to use IGMP version 1. Will also reply IGMPv1 report if
1323 receive IGMPv2/v3 query.
1324 - 2 - Enforce to use IGMP version 2. Will fallback to IGMPv1 if receive
1325 IGMPv1 query message. Will reply report if receive IGMPv3 query.
1326 - 3 - Enforce to use IGMP version 3. The same react with default 0.
Hangbin Liu1af92832016-11-07 14:51:23 +08001327
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001328 .. note::
Hangbin Liu1af92832016-11-07 14:51:23 +08001329
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001330 this is not the same with force_mld_version because IGMPv3 RFC3376
1331 Security Considerations does not have clear description that we could
1332 ignore other version messages completely as MLDv2 RFC3810. So make
1333 this value as default 0 is recommended.
Benjamin Poirier6b226e22016-03-21 13:21:39 -07001334
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001335``conf/interface/*``
1336 changes special settings per interface (where
1337 interface" is the name of your network interface)
1338
1339``conf/all/*``
1340 is special, changes the settings for all interfaces
Benjamin Poirier6b226e22016-03-21 13:21:39 -07001341
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342log_martians - BOOLEAN
1343 Log packets with impossible addresses to kernel log.
1344 log_martians for the interface will be enabled if at least one of
1345 conf/{all,interface}/log_martians is set to TRUE,
1346 it will be disabled otherwise
1347
1348accept_redirects - BOOLEAN
1349 Accept ICMP redirect messages.
1350 accept_redirects for the interface will be enabled if:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001351
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001352 - both conf/{all,interface}/accept_redirects are TRUE in the case
1353 forwarding for the interface is enabled
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001354
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 or
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001356
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001357 - at least one of conf/{all,interface}/accept_redirects is TRUE in the
1358 case forwarding for the interface is disabled
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001359
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 accept_redirects for the interface will be disabled otherwise
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001361
1362 default:
1363
1364 - TRUE (host)
1365 - FALSE (router)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366
1367forwarding - BOOLEAN
Neil Jerram88a7cdd2017-03-10 12:24:57 +00001368 Enable IP forwarding on this interface. This controls whether packets
1369 received _on_ this interface can be forwarded.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370
1371mc_forwarding - BOOLEAN
1372 Do multicast routing. The kernel needs to be compiled with CONFIG_MROUTE
1373 and a multicast routing daemon is required.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001374 conf/all/mc_forwarding must also be set to TRUE to enable multicast
1375 routing for the interface
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376
1377medium_id - INTEGER
1378 Integer value used to differentiate the devices by the medium they
1379 are attached to. Two devices can have different id values when
1380 the broadcast packets are received only on one of them.
1381 The default value 0 means that the device is the only interface
1382 to its medium, value of -1 means that medium is not known.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001383
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 Currently, it is used to change the proxy_arp behavior:
1385 the proxy_arp feature is enabled for packets forwarded between
1386 two devices attached to different media.
1387
1388proxy_arp - BOOLEAN
1389 Do proxy arp.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001390
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 proxy_arp for the interface will be enabled if at least one of
1392 conf/{all,interface}/proxy_arp is set to TRUE,
1393 it will be disabled otherwise
1394
Jesper Dangaard Brouer65324142010-01-05 05:50:47 +00001395proxy_arp_pvlan - BOOLEAN
1396 Private VLAN proxy arp.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001397
Jesper Dangaard Brouer65324142010-01-05 05:50:47 +00001398 Basically allow proxy arp replies back to the same interface
1399 (from which the ARP request/solicitation was received).
1400
1401 This is done to support (ethernet) switch features, like RFC
1402 3069, where the individual ports are NOT allowed to
1403 communicate with each other, but they are allowed to talk to
1404 the upstream router. As described in RFC 3069, it is possible
1405 to allow these hosts to communicate through the upstream
1406 router by proxy_arp'ing. Don't need to be used together with
1407 proxy_arp.
1408
1409 This technology is known by different names:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001410
Jesper Dangaard Brouer65324142010-01-05 05:50:47 +00001411 In RFC 3069 it is called VLAN Aggregation.
1412 Cisco and Allied Telesyn call it Private VLAN.
1413 Hewlett-Packard call it Source-Port filtering or port-isolation.
1414 Ericsson call it MAC-Forced Forwarding (RFC Draft).
1415
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416shared_media - BOOLEAN
1417 Send(router) or accept(host) RFC1620 shared media redirects.
Eric Garver176b3462016-05-26 12:28:05 -04001418 Overrides secure_redirects.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001419
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420 shared_media for the interface will be enabled if at least one of
1421 conf/{all,interface}/shared_media is set to TRUE,
1422 it will be disabled otherwise
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001423
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 default TRUE
1425
1426secure_redirects - BOOLEAN
Eric Garver176b3462016-05-26 12:28:05 -04001427 Accept ICMP redirect messages only to gateways listed in the
1428 interface's current gateway list. Even if disabled, RFC1122 redirect
1429 rules still apply.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001430
Eric Garver176b3462016-05-26 12:28:05 -04001431 Overridden by shared_media.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001432
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 secure_redirects for the interface will be enabled if at least one of
1434 conf/{all,interface}/secure_redirects is set to TRUE,
1435 it will be disabled otherwise
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001436
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 default TRUE
1438
1439send_redirects - BOOLEAN
1440 Send redirects, if router.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001441
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 send_redirects for the interface will be enabled if at least one of
1443 conf/{all,interface}/send_redirects is set to TRUE,
1444 it will be disabled otherwise
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001445
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 Default: TRUE
1447
1448bootp_relay - BOOLEAN
1449 Accept packets with source address 0.b.c.d destined
1450 not to this host as local ones. It is supposed, that
1451 BOOTP relay daemon will catch and forward such packets.
1452 conf/all/bootp_relay must also be set to TRUE to enable BOOTP relay
1453 for the interface
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001454
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 default FALSE
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001456
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 Not Implemented Yet.
1458
1459accept_source_route - BOOLEAN
1460 Accept packets with SRR option.
1461 conf/all/accept_source_route must also be set to TRUE to accept packets
1462 with SRR option on the interface
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001463
1464 default
1465
1466 - TRUE (router)
1467 - FALSE (host)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468
Patrick McHardy8153a102009-12-03 01:25:58 +00001469accept_local - BOOLEAN
Sébastien Barré72b126a2014-09-10 18:20:23 +02001470 Accept packets with local source addresses. In combination with
1471 suitable routing, this can be used to direct packets between two
1472 local interfaces over the wire and have them accepted properly.
Patrick McHardy8153a102009-12-03 01:25:58 +00001473 default FALSE
1474
Thomas Grafd0daebc32012-06-12 00:44:01 +00001475route_localnet - BOOLEAN
1476 Do not consider loopback addresses as martian source or destination
1477 while routing. This enables the use of 127/8 for local routing purposes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001478
Thomas Grafd0daebc32012-06-12 00:44:01 +00001479 default FALSE
1480
Stephen Hemmingerc1cf8422009-02-20 08:25:36 +00001481rp_filter - INTEGER
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001482 - 0 - No source validation.
1483 - 1 - Strict mode as defined in RFC3704 Strict Reverse Path
1484 Each incoming packet is tested against the FIB and if the interface
1485 is not the best reverse path the packet check will fail.
1486 By default failed packets are discarded.
1487 - 2 - Loose mode as defined in RFC3704 Loose Reverse Path
1488 Each incoming packet's source address is also tested against the FIB
1489 and if the source address is not reachable via any interface
1490 the packet check will fail.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001492 Current recommended practice in RFC3704 is to enable strict mode
Jesper Dangaard Brouerbf869c32009-02-23 04:37:55 +00001493 to prevent IP spoofing from DDos attacks. If using asymmetric routing
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001494 or other complicated routing, then loose mode is recommended.
Stephen Hemmingerc1cf8422009-02-20 08:25:36 +00001495
Shan Wei1f5865e2009-12-02 15:39:04 -08001496 The max value from conf/{all,interface}/rp_filter is used
1497 when doing source validation on the {interface}.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498
1499 Default value is 0. Note that some distributions enable it
1500 in startup scripts.
1501
Jay Vosburgh8cf5d8c2021-02-08 17:37:01 -08001502src_valid_mark - BOOLEAN
1503 - 0 - The fwmark of the packet is not included in reverse path
1504 route lookup. This allows for asymmetric routing configurations
1505 utilizing the fwmark in only one direction, e.g., transparent
1506 proxying.
1507
1508 - 1 - The fwmark of the packet is included in reverse path route
1509 lookup. This permits rp_filter to function when the fwmark is
1510 used for routing traffic in both directions.
1511
1512 This setting also affects the utilization of fmwark when
1513 performing source address selection for ICMP replies, or
1514 determining addresses stored for the IPOPT_TS_TSANDADDR and
1515 IPOPT_RR IP options.
1516
1517 The max value from conf/{all,interface}/src_valid_mark is used.
1518
1519 Default value is 0.
1520
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521arp_filter - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001522 - 1 - Allows you to have multiple network interfaces on the same
1523 subnet, and have the ARPs for each interface be answered
1524 based on whether or not the kernel would route a packet from
1525 the ARP'd IP out that interface (therefore you must use source
1526 based routing for this to work). In other words it allows control
1527 of which cards (usually 1) will respond to an arp request.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001529 - 0 - (default) The kernel can respond to arp requests with addresses
1530 from other interfaces. This may seem wrong but it usually makes
1531 sense, because it increases the chance of successful communication.
1532 IP addresses are owned by the complete host on Linux, not by
1533 particular interfaces. Only for more complex setups like load-
1534 balancing, does this behaviour cause problems.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535
1536 arp_filter for the interface will be enabled if at least one of
1537 conf/{all,interface}/arp_filter is set to TRUE,
1538 it will be disabled otherwise
1539
1540arp_announce - INTEGER
1541 Define different restriction levels for announcing the local
1542 source IP address from IP packets in ARP requests sent on
1543 interface:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001544
1545 - 0 - (default) Use any local address, configured on any interface
1546 - 1 - Try to avoid local addresses that are not in the target's
1547 subnet for this interface. This mode is useful when target
1548 hosts reachable via this interface require the source IP
1549 address in ARP requests to be part of their logical network
1550 configured on the receiving interface. When we generate the
1551 request we will check all our subnets that include the
1552 target IP and will preserve the source address if it is from
1553 such subnet. If there is no such subnet we select source
1554 address according to the rules for level 2.
1555 - 2 - Always use the best local address for this target.
1556 In this mode we ignore the source address in the IP packet
1557 and try to select local address that we prefer for talks with
1558 the target host. Such local address is selected by looking
1559 for primary IP addresses on all our subnets on the outgoing
1560 interface that include the target IP address. If no suitable
1561 local address is found we select the first local address
1562 we have on the outgoing interface or on all other interfaces,
1563 with the hope we will receive reply for our request and
1564 even sometimes no matter the source IP address we announce.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565
1566 The max value from conf/{all,interface}/arp_announce is used.
1567
1568 Increasing the restriction level gives more chance for
1569 receiving answer from the resolved target while decreasing
1570 the level announces more valid sender's information.
1571
1572arp_ignore - INTEGER
1573 Define different modes for sending replies in response to
1574 received ARP requests that resolve local target IP addresses:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001575
1576 - 0 - (default): reply for any local target IP address, configured
1577 on any interface
1578 - 1 - reply only if the target IP address is local address
1579 configured on the incoming interface
1580 - 2 - reply only if the target IP address is local address
1581 configured on the incoming interface and both with the
1582 sender's IP address are part from same subnet on this interface
1583 - 3 - do not reply for local addresses configured with scope host,
1584 only resolutions for global and link addresses are replied
1585 - 4-7 - reserved
1586 - 8 - do not reply for all local addresses
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587
1588 The max value from conf/{all,interface}/arp_ignore is used
1589 when ARP request is received on the {interface}
1590
Stephen Hemmingereefef1c2009-02-01 01:04:33 -08001591arp_notify - BOOLEAN
1592 Define mode for notification of address and device changes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001593
1594 == ==========================================================
1595 0 (default): do nothing
1596 1 Generate gratuitous arp requests when device is brought up
1597 or hardware address changes.
1598 == ==========================================================
Stephen Hemmingereefef1c2009-02-01 01:04:33 -08001599
Neil Hormanc1b1bce2006-03-20 22:40:03 -08001600arp_accept - BOOLEAN
Octavian Purdila6d955182010-01-18 12:58:44 +00001601 Define behavior for gratuitous ARP frames who's IP is not
1602 already present in the ARP table:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001603
1604 - 0 - don't create new entries in the ARP table
1605 - 1 - create new entries in the ARP table
Octavian Purdila6d955182010-01-18 12:58:44 +00001606
1607 Both replies and requests type gratuitous arp will trigger the
1608 ARP table to be updated, if this setting is on.
1609
1610 If the ARP table already contains the IP address of the
1611 gratuitous arp frame, the arp table will be updated regardless
1612 if this setting is on or off.
1613
James Prestwoodfcdb44d2021-11-01 10:36:28 -07001614arp_evict_nocarrier - BOOLEAN
1615 Clears the ARP cache on NOCARRIER events. This option is important for
1616 wireless devices where the ARP cache should not be cleared when roaming
1617 between access points on the same network. In most cases this should
1618 remain as the default (1).
1619
1620 - 1 - (default): Clear the ARP cache on NOCARRIER events
1621 - 0 - Do not clear ARP cache on NOCARRIER events
1622
YOSHIFUJI Hideaki/吉藤英明89c69d32015-03-19 22:42:04 +09001623mcast_solicit - INTEGER
1624 The maximum number of multicast probes in INCOMPLETE state,
1625 when the associated hardware address is unknown. Defaults
1626 to 3.
1627
1628ucast_solicit - INTEGER
1629 The maximum number of unicast probes in PROBE state, when
1630 the hardware address is being reconfirmed. Defaults to 3.
Neil Hormanc1b1bce2006-03-20 22:40:03 -08001631
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632app_solicit - INTEGER
1633 The maximum number of probes to send to the user space ARP daemon
1634 via netlink before dropping back to multicast probes (see
YOSHIFUJI Hideaki/吉藤英明89c69d32015-03-19 22:42:04 +09001635 mcast_resolicit). Defaults to 0.
1636
1637mcast_resolicit - INTEGER
1638 The maximum number of multicast probes after unicast and
1639 app probes in PROBE state. Defaults to 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640
1641disable_policy - BOOLEAN
1642 Disable IPSEC policy (SPD) for this interface
1643
1644disable_xfrm - BOOLEAN
1645 Disable IPSEC encryption on this interface, whatever the policy
1646
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02001647igmpv2_unsolicited_report_interval - INTEGER
1648 The interval in milliseconds in which the next unsolicited
1649 IGMPv1 or IGMPv2 report retransmit will take place.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001650
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02001651 Default: 10000 (10 seconds)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02001653igmpv3_unsolicited_report_interval - INTEGER
1654 The interval in milliseconds in which the next unsolicited
1655 IGMPv3 report retransmit will take place.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001656
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02001657 Default: 1000 (1 seconds)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658
Vincent Bernatc0c5a602020-11-07 20:35:13 +01001659ignore_routes_with_linkdown - BOOLEAN
1660 Ignore routes whose link is down when performing a FIB lookup.
1661
Martin Schwenked922e1c2014-01-28 15:26:42 +11001662promote_secondaries - BOOLEAN
1663 When a primary IP address is removed from this interface
1664 promote a corresponding secondary IP address instead of
1665 removing all the corresponding secondary IP addresses.
1666
Johannes Berg12b74df2016-02-04 13:31:17 +01001667drop_unicast_in_l2_multicast - BOOLEAN
1668 Drop any unicast IP packets that are received in link-layer
1669 multicast (or broadcast) frames.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001670
Johannes Berg12b74df2016-02-04 13:31:17 +01001671 This behavior (for multicast) is actually a SHOULD in RFC
1672 1122, but is disabled by default for compatibility reasons.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001673
Johannes Berg12b74df2016-02-04 13:31:17 +01001674 Default: off (0)
1675
Johannes Berg97daf332016-02-04 13:31:18 +01001676drop_gratuitous_arp - BOOLEAN
1677 Drop all gratuitous ARP frames, for example if there's a known
1678 good ARP proxy on the network and such frames need not be used
1679 (or in the case of 802.11, must not be used to prevent attacks.)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001680
Johannes Berg97daf332016-02-04 13:31:18 +01001681 Default: off (0)
1682
Martin Schwenked922e1c2014-01-28 15:26:42 +11001683
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684tag - INTEGER
1685 Allows you to write a number, which can be used as required.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001686
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 Default value is 0.
1688
Alexander Duycke69948a2015-08-11 13:35:01 -07001689xfrm4_gc_thresh - INTEGER
Nicolas Dichtel837f7412019-04-09 17:16:59 +02001690 (Obsolete since linux-4.14)
Alexander Duycke69948a2015-08-11 13:35:01 -07001691 The threshold at which we will start garbage collecting for IPv4
1692 destination cache entries. At twice this value the system will
Florian Westphal3c2a89d2017-07-17 13:57:20 +02001693 refuse new allocations.
Alexander Duycke69948a2015-08-11 13:35:01 -07001694
Philip Downey87583eb2015-08-31 11:30:38 +01001695igmp_link_local_mcast_reports - BOOLEAN
1696 Enable IGMP reports for link local multicast groups in the
1697 224.0.0.X range.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001698
Philip Downey87583eb2015-08-31 11:30:38 +01001699 Default TRUE
1700
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701Alexey Kuznetsov.
1702kuznet@ms2.inr.ac.ru
1703
1704Updated by:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001705
1706- Andi Kleen
1707 ak@muc.de
1708- Nicolas Delon
1709 delon.nicolas@wanadoo.fr
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
1711
1712
1713
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001714/proc/sys/net/ipv6/* Variables
1715==============================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716
1717IPv6 has no global variables such as tcp_*. tcp_* settings under ipv4/ also
1718apply to IPv6 [XXX?].
1719
1720bindv6only - BOOLEAN
1721 Default value for IPV6_V6ONLY socket option,
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001722 which restricts use of the IPv6 socket to IPv6 communication
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 only.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001724
1725 - TRUE: disable IPv4-mapped address feature
1726 - FALSE: enable IPv4-mapped address feature
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727
Geoffrey Thomasd5c073ca2011-08-22 11:28:57 -07001728 Default: FALSE (as specified in RFC3493)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729
Florent Fourcot6444f722014-01-17 17:15:05 +01001730flowlabel_consistency - BOOLEAN
1731 Protect the consistency (and unicity) of flow label.
1732 You have to disable it to use IPV6_FL_F_REFLECT flag on the
1733 flow label manager.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001734
1735 - TRUE: enabled
1736 - FALSE: disabled
1737
Florent Fourcot6444f722014-01-17 17:15:05 +01001738 Default: TRUE
1739
Tom Herbert42240902015-07-31 16:52:12 -07001740auto_flowlabels - INTEGER
1741 Automatically generate flow labels based on a flow hash of the
1742 packet. This allows intermediate devices, such as routers, to
1743 identify packet flows for mechanisms like Equal Cost Multipath
Tom Herbertcb1ce2e2014-07-01 21:33:10 -07001744 Routing (see RFC 6438).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001745
1746 = ===========================================================
1747 0 automatic flow labels are completely disabled
1748 1 automatic flow labels are enabled by default, they can be
Tom Herbert42240902015-07-31 16:52:12 -07001749 disabled on a per socket basis using the IPV6_AUTOFLOWLABEL
1750 socket option
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001751 2 automatic flow labels are allowed, they may be enabled on a
Tom Herbert42240902015-07-31 16:52:12 -07001752 per socket basis using the IPV6_AUTOFLOWLABEL socket option
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001753 3 automatic flow labels are enabled and enforced, they cannot
Tom Herbert42240902015-07-31 16:52:12 -07001754 be disabled by the socket option
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001755 = ===========================================================
1756
Tom Herbertb5677412015-07-31 16:52:14 -07001757 Default: 1
Tom Herbertcb1ce2e2014-07-01 21:33:10 -07001758
Tom Herbert82a584b2015-04-29 15:33:21 -07001759flowlabel_state_ranges - BOOLEAN
1760 Split the flow label number space into two ranges. 0-0x7FFFF is
1761 reserved for the IPv6 flow manager facility, 0x80000-0xFFFFF
1762 is reserved for stateless flow labels as described in RFC6437.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001763
1764 - TRUE: enabled
1765 - FALSE: disabled
1766
Tom Herbert82a584b2015-04-29 15:33:21 -07001767 Default: true
1768
Eric Dumazet323a53c2019-06-05 07:55:09 -07001769flowlabel_reflect - INTEGER
1770 Control flow label reflection. Needed for Path MTU
Jakub Sitnicki22b67222017-08-23 09:55:41 +02001771 Discovery to work with Equal Cost Multipath Routing in anycast
1772 environments. See RFC 7690 and:
1773 https://tools.ietf.org/html/draft-wang-6man-flow-label-reflection-01
Eric Dumazet323a53c2019-06-05 07:55:09 -07001774
Eric Dumazeta346abe2019-07-01 06:39:36 -07001775 This is a bitmask.
Eric Dumazet323a53c2019-06-05 07:55:09 -07001776
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001777 - 1: enabled for established flows
Eric Dumazet323a53c2019-06-05 07:55:09 -07001778
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001779 Note that this prevents automatic flowlabel changes, as done
1780 in "tcp: change IPv6 flow-label upon receiving spurious retransmission"
1781 and "tcp: Change txhash on every SYN and RTO retransmit"
Eric Dumazet323a53c2019-06-05 07:55:09 -07001782
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001783 - 2: enabled for TCP RESET packets (no active listener)
1784 If set, a RST packet sent in response to a SYN packet on a closed
1785 port will reflect the incoming flow label.
1786
1787 - 4: enabled for ICMPv6 echo reply messages.
Eric Dumazeta346abe2019-07-01 06:39:36 -07001788
Eric Dumazet323a53c2019-06-05 07:55:09 -07001789 Default: 0
Jakub Sitnicki22b67222017-08-23 09:55:41 +02001790
David Ahernb4bac172018-03-02 08:32:18 -08001791fib_multipath_hash_policy - INTEGER
1792 Controls which hash policy to use for multipath routes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001793
David Ahernb4bac172018-03-02 08:32:18 -08001794 Default: 0 (Layer 3)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001795
David Ahernb4bac172018-03-02 08:32:18 -08001796 Possible values:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001797
1798 - 0 - Layer 3 (source and destination addresses plus flow label)
1799 - 1 - Layer 4 (standard 5-tuple)
1800 - 2 - Layer 3 or inner Layer 3 if present
Ido Schimmel73c2c5c2021-05-17 21:15:23 +03001801 - 3 - Custom multipath hash. Fields used for multipath hash calculation
1802 are determined by fib_multipath_hash_fields sysctl
David Ahernb4bac172018-03-02 08:32:18 -08001803
Ido Schimmeled139232021-05-17 21:15:22 +03001804fib_multipath_hash_fields - UNSIGNED INTEGER
1805 When fib_multipath_hash_policy is set to 3 (custom multipath hash), the
1806 fields used for multipath hash calculation are determined by this
1807 sysctl.
1808
1809 This value is a bitmask which enables various fields for multipath hash
1810 calculation.
1811
1812 Possible fields are:
1813
1814 ====== ============================
1815 0x0001 Source IP address
1816 0x0002 Destination IP address
1817 0x0004 IP protocol
1818 0x0008 Flow Label
1819 0x0010 Source port
1820 0x0020 Destination port
1821 0x0040 Inner source IP address
1822 0x0080 Inner destination IP address
1823 0x0100 Inner IP protocol
1824 0x0200 Inner Flow Label
1825 0x0400 Inner source port
1826 0x0800 Inner destination port
1827 ====== ============================
1828
1829 Default: 0x0007 (source IP, destination IP and IP protocol)
1830
FX Le Bail509aba32014-01-07 14:57:27 +01001831anycast_src_echo_reply - BOOLEAN
1832 Controls the use of anycast addresses as source addresses for ICMPv6
1833 echo reply
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001834
1835 - TRUE: enabled
1836 - FALSE: disabled
1837
FX Le Bail509aba32014-01-07 14:57:27 +01001838 Default: FALSE
1839
Hannes Frederic Sowa9f0761c2015-03-23 23:36:06 +01001840idgen_delay - INTEGER
1841 Controls the delay in seconds after which time to retry
1842 privacy stable address generation if a DAD conflict is
1843 detected.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001844
Hannes Frederic Sowa9f0761c2015-03-23 23:36:06 +01001845 Default: 1 (as specified in RFC7217)
1846
1847idgen_retries - INTEGER
1848 Controls the number of retries to generate a stable privacy
1849 address if a DAD conflict is detected.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001850
Hannes Frederic Sowa9f0761c2015-03-23 23:36:06 +01001851 Default: 3 (as specified in RFC7217)
1852
Hannes Frederic Sowa2f711932014-09-02 15:49:25 +02001853mld_qrv - INTEGER
1854 Controls the MLD query robustness variable (see RFC3810 9.1).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001855
Hannes Frederic Sowa2f711932014-09-02 15:49:25 +02001856 Default: 2 (as specified by RFC3810 9.1)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001857
Hannes Frederic Sowa2f711932014-09-02 15:49:25 +02001858 Minimum: 1 (as specified by RFC6636 4.5)
1859
Olivier Gayotab913452018-04-18 22:03:06 +02001860max_dst_opts_number - INTEGER
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001861 Maximum number of non-padding TLVs allowed in a Destination
1862 options extension header. If this value is less than zero
1863 then unknown options are disallowed and the number of known
1864 TLVs allowed is the absolute value of this number.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001865
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001866 Default: 8
1867
Olivier Gayotab913452018-04-18 22:03:06 +02001868max_hbh_opts_number - INTEGER
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001869 Maximum number of non-padding TLVs allowed in a Hop-by-Hop
1870 options extension header. If this value is less than zero
1871 then unknown options are disallowed and the number of known
1872 TLVs allowed is the absolute value of this number.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001873
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001874 Default: 8
1875
Olivier Gayotab913452018-04-18 22:03:06 +02001876max_dst_opts_length - INTEGER
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001877 Maximum length allowed for a Destination options extension
1878 header.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001879
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001880 Default: INT_MAX (unlimited)
1881
Olivier Gayotab913452018-04-18 22:03:06 +02001882max_hbh_length - INTEGER
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001883 Maximum length allowed for a Hop-by-Hop options extension
1884 header.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001885
Tom Herbert47d3d7a2017-10-30 14:16:00 -07001886 Default: INT_MAX (unlimited)
1887
David Ahern7c6bb7d2018-10-11 20:17:21 -07001888skip_notify_on_dev_down - BOOLEAN
1889 Controls whether an RTM_DELROUTE message is generated for routes
1890 removed when a device is taken down or deleted. IPv4 does not
1891 generate this message; IPv6 does by default. Setting this sysctl
1892 to true skips the message, making IPv4 and IPv6 on par in relying
1893 on userspace caches to track link events and evict routes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001894
David Ahern7c6bb7d2018-10-11 20:17:21 -07001895 Default: false (generate message)
1896
Roopa Prabhu4f801162020-04-27 13:56:46 -07001897nexthop_compat_mode - BOOLEAN
1898 New nexthop API provides a means for managing nexthops independent of
1899 prefixes. Backwards compatibilty with old route format is enabled by
1900 default which means route dumps and notifications contain the new
1901 nexthop attribute but also the full, expanded nexthop definition.
1902 Further, updates or deletes of a nexthop configuration generate route
1903 notifications for each fib entry using the nexthop. Once a system
1904 understands the new API, this sysctl can be disabled to achieve full
1905 performance benefits of the new API by disabling the nexthop expansion
1906 and extraneous notifications.
1907 Default: true (backward compat mode)
1908
Amit Cohen907eea42021-02-01 21:47:55 +02001909fib_notify_on_flag_change - INTEGER
1910 Whether to emit RTM_NEWROUTE notifications whenever RTM_F_OFFLOAD/
Amit Cohen6fad3612021-02-07 10:22:53 +02001911 RTM_F_TRAP/RTM_F_OFFLOAD_FAILED flags are changed.
Amit Cohen907eea42021-02-01 21:47:55 +02001912
1913 After installing a route to the kernel, user space receives an
1914 acknowledgment, which means the route was installed in the kernel,
1915 but not necessarily in hardware.
1916 It is also possible for a route already installed in hardware to change
1917 its action and therefore its flags. For example, a host route that is
1918 trapping packets can be "promoted" to perform decapsulation following
1919 the installation of an IPinIP/VXLAN tunnel.
1920 The notifications will indicate to user-space the state of the route.
1921
1922 Default: 0 (Do not emit notifications.)
1923
1924 Possible values:
1925
1926 - 0 - Do not emit notifications.
1927 - 1 - Emit notifications.
Amit Cohen6fad3612021-02-07 10:22:53 +02001928 - 2 - Emit notifications only for RTM_F_OFFLOAD_FAILED flag change.
Amit Cohen907eea42021-02-01 21:47:55 +02001929
Justin Iurmande8e80a2021-07-20 21:43:00 +02001930ioam6_id - INTEGER
1931 Define the IOAM id of this node. Uses only 24 bits out of 32 in total.
1932
1933 Min: 0
1934 Max: 0xFFFFFF
1935
1936 Default: 0xFFFFFF
1937
1938ioam6_id_wide - LONG INTEGER
1939 Define the wide IOAM id of this node. Uses only 56 bits out of 64 in
1940 total. Can be different from ioam6_id.
1941
1942 Min: 0
1943 Max: 0xFFFFFFFFFFFFFF
1944
1945 Default: 0xFFFFFFFFFFFFFF
1946
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947IPv6 Fragmentation:
1948
1949ip6frag_high_thresh - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001950 Maximum memory used to reassemble IPv6 fragments. When
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951 ip6frag_high_thresh bytes of memory is allocated for this purpose,
1952 the fragment handler will toss packets until ip6frag_low_thresh
1953 is reached.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001954
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955ip6frag_low_thresh - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001956 See ip6frag_high_thresh
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957
1958ip6frag_time - INTEGER
1959 Time in seconds to keep an IPv6 fragment in memory.
1960
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001961``conf/default/*``:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962 Change the interface-specific default settings.
1963
Pali Rohárfc024c52021-01-21 16:02:44 +01001964 These settings would be used during creating new interfaces.
1965
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02001967``conf/all/*``:
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001968 Change all the interface-specific settings.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969
1970 [XXX: Other special features than forwarding?]
1971
Pali Rohárfc024c52021-01-21 16:02:44 +01001972conf/all/disable_ipv6 - BOOLEAN
1973 Changing this value is same as changing ``conf/default/disable_ipv6``
1974 setting and also all per-interface ``disable_ipv6`` settings to the same
1975 value.
1976
1977 Reading this value does not have any particular meaning. It does not say
1978 whether IPv6 support is enabled or disabled. Returned value can be 1
1979 also in the case when some interface has ``disable_ipv6`` set to 0 and
1980 has configured IPv6 addresses.
1981
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982conf/all/forwarding - BOOLEAN
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001983 Enable global IPv6 forwarding between all interfaces.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001985 IPv4 and IPv6 work differently here; e.g. netfilter must be used
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986 to control which interfaces may forward packets and which not.
1987
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001988 This also sets all interfaces' Host/Router setting
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 'forwarding' to the specified value. See below for details.
1990
1991 This referred to as global forwarding.
1992
YOSHIFUJI Hideakifbea49e2006-09-22 14:43:49 -07001993proxy_ndp - BOOLEAN
1994 Do proxy ndp.
1995
Loganaden Velvindron219b5f22014-11-04 03:02:49 -08001996fwmark_reflect - BOOLEAN
1997 Controls the fwmark of kernel-generated IPv6 reply packets that are not
1998 associated with a socket for example, TCP RSTs or ICMPv6 echo replies).
1999 If unset, these packets have a fwmark of zero. If set, they have the
2000 fwmark of the packet they are replying to.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002001
Loganaden Velvindron219b5f22014-11-04 03:02:49 -08002002 Default: 0
2003
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002004``conf/interface/*``:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 Change special settings per interface.
2006
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002007 The functional behaviour for certain settings is different
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 depending on whether local forwarding is enabled or not.
2009
Roy.Li605b91c2011-09-28 19:51:54 +00002010accept_ra - INTEGER
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011 Accept Router Advertisements; autoconfigure using them.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002012
Tore Anderson026359b2011-08-28 23:47:33 +00002013 It also determines whether or not to transmit Router
2014 Solicitations. If and only if the functional setting is to
2015 accept Router Advertisements, Router Solicitations will be
2016 transmitted.
2017
Thomas Grafae8abfa2010-09-03 05:47:30 +00002018 Possible values are:
Thomas Grafae8abfa2010-09-03 05:47:30 +00002019
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002020 == ===========================================================
2021 0 Do not accept Router Advertisements.
2022 1 Accept Router Advertisements if forwarding is disabled.
2023 2 Overrule forwarding behaviour. Accept Router Advertisements
2024 even if forwarding is enabled.
2025 == ===========================================================
2026
2027 Functional default:
2028
2029 - enabled if local forwarding is disabled.
2030 - disabled if local forwarding is enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031
YOSHIFUJI Hideaki65f5c7c2006-03-20 16:55:08 -08002032accept_ra_defrtr - BOOLEAN
2033 Learn default router in Router Advertisement.
2034
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002035 Functional default:
2036
2037 - enabled if accept_ra is enabled.
2038 - disabled if accept_ra is disabled.
YOSHIFUJI Hideaki65f5c7c2006-03-20 16:55:08 -08002039
Praveen Chaudhary6b2e04b2021-01-25 13:44:30 -08002040ra_defrtr_metric - UNSIGNED INTEGER
2041 Route metric for default route learned in Router Advertisement. This value
2042 will be assigned as metric for the default route learned via IPv6 Router
2043 Advertisement. Takes affect only if accept_ra_defrtr is enabled.
2044
2045 Possible values:
2046 1 to 0xFFFFFFFF
2047
2048 Default: IP6_RT_PRIO_USER i.e. 1024.
2049
Ben Greeard9333192014-06-25 14:44:53 -07002050accept_ra_from_local - BOOLEAN
2051 Accept RA with source-address that is found on local machine
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002052 if the RA is otherwise proper and able to be accepted.
2053
2054 Default is to NOT accept these as it may be an un-intended
2055 network loop.
Ben Greeard9333192014-06-25 14:44:53 -07002056
2057 Functional default:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002058
2059 - enabled if accept_ra_from_local is enabled
2060 on a specific interface.
2061 - disabled if accept_ra_from_local is disabled
2062 on a specific interface.
Ben Greeard9333192014-06-25 14:44:53 -07002063
Hangbin Liu8013d1d2015-07-30 14:28:42 +08002064accept_ra_min_hop_limit - INTEGER
2065 Minimum hop limit Information in Router Advertisement.
2066
2067 Hop limit Information in Router Advertisement less than this
2068 variable shall be ignored.
2069
2070 Default: 1
2071
YOSHIFUJI Hideakic4fd30e2006-03-20 16:55:26 -08002072accept_ra_pinfo - BOOLEAN
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02002073 Learn Prefix Information in Router Advertisement.
YOSHIFUJI Hideakic4fd30e2006-03-20 16:55:26 -08002074
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002075 Functional default:
2076
2077 - enabled if accept_ra is enabled.
2078 - disabled if accept_ra is disabled.
YOSHIFUJI Hideakic4fd30e2006-03-20 16:55:26 -08002079
Joel Scherpelzbbea1242017-03-22 18:19:04 +09002080accept_ra_rt_info_min_plen - INTEGER
2081 Minimum prefix length of Route Information in RA.
2082
2083 Route Information w/ prefix smaller than this variable shall
2084 be ignored.
2085
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002086 Functional default:
2087
2088 * 0 if accept_ra_rtr_pref is enabled.
2089 * -1 if accept_ra_rtr_pref is disabled.
Joel Scherpelzbbea1242017-03-22 18:19:04 +09002090
YOSHIFUJI Hideaki09c884d2006-03-20 17:07:03 -08002091accept_ra_rt_info_max_plen - INTEGER
2092 Maximum prefix length of Route Information in RA.
2093
Joel Scherpelzbbea1242017-03-22 18:19:04 +09002094 Route Information w/ prefix larger than this variable shall
2095 be ignored.
YOSHIFUJI Hideaki09c884d2006-03-20 17:07:03 -08002096
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002097 Functional default:
2098
2099 * 0 if accept_ra_rtr_pref is enabled.
2100 * -1 if accept_ra_rtr_pref is disabled.
YOSHIFUJI Hideaki09c884d2006-03-20 17:07:03 -08002101
YOSHIFUJI Hideaki930d6ff2006-03-20 17:05:30 -08002102accept_ra_rtr_pref - BOOLEAN
2103 Accept Router Preference in RA.
2104
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002105 Functional default:
2106
2107 - enabled if accept_ra is enabled.
2108 - disabled if accept_ra is disabled.
YOSHIFUJI Hideaki930d6ff2006-03-20 17:05:30 -08002109
Harout Hedeshianc2943f12015-01-20 10:06:05 -07002110accept_ra_mtu - BOOLEAN
2111 Apply the MTU value specified in RA option 5 (RFC4861). If
2112 disabled, the MTU specified in the RA will be ignored.
2113
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002114 Functional default:
2115
2116 - enabled if accept_ra is enabled.
2117 - disabled if accept_ra is disabled.
Harout Hedeshianc2943f12015-01-20 10:06:05 -07002118
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119accept_redirects - BOOLEAN
2120 Accept Redirects.
2121
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002122 Functional default:
2123
2124 - enabled if local forwarding is disabled.
2125 - disabled if local forwarding is enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126
YOSHIFUJI Hideaki0bcbc922007-04-24 14:58:30 -07002127accept_source_route - INTEGER
2128 Accept source routing (routing extension header).
2129
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002130 - >= 0: Accept only routing header type 2.
2131 - < 0: Do not accept routing header.
YOSHIFUJI Hideaki0bcbc922007-04-24 14:58:30 -07002132
2133 Default: 0
2134
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135autoconf - BOOLEAN
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002136 Autoconfigure addresses using Prefix Information in Router
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 Advertisements.
2138
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002139 Functional default:
2140
2141 - enabled if accept_ra_pinfo is enabled.
2142 - disabled if accept_ra_pinfo is disabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143
2144dad_transmits - INTEGER
2145 The amount of Duplicate Address Detection probes to send.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002146
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148
Roy.Li605b91c2011-09-28 19:51:54 +00002149forwarding - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002150 Configure interface-specific Host/Router behaviour.
2151
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002152 .. note::
2153
2154 It is recommended to have the same setting on all
2155 interfaces; mixed router/host scenarios are rather uncommon.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156
Thomas Grafae8abfa2010-09-03 05:47:30 +00002157 Possible values are:
Thomas Grafae8abfa2010-09-03 05:47:30 +00002158
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002159 - 0 Forwarding disabled
2160 - 1 Forwarding enabled
2161
2162 **FALSE (0)**:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163
2164 By default, Host behaviour is assumed. This means:
2165
2166 1. IsRouter flag is not set in Neighbour Advertisements.
Tore Anderson026359b2011-08-28 23:47:33 +00002167 2. If accept_ra is TRUE (default), transmit Router
2168 Solicitations.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002169 3. If accept_ra is TRUE (default), accept Router
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 Advertisements (and do autoconfiguration).
2171 4. If accept_redirects is TRUE (default), accept Redirects.
2172
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002173 **TRUE (1)**:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002175 If local forwarding is enabled, Router behaviour is assumed.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176 This means exactly the reverse from the above:
2177
2178 1. IsRouter flag is set in Neighbour Advertisements.
Tore Anderson026359b2011-08-28 23:47:33 +00002179 2. Router Solicitations are not sent unless accept_ra is 2.
Thomas Grafae8abfa2010-09-03 05:47:30 +00002180 3. Router Advertisements are ignored unless accept_ra is 2.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 4. Redirects are ignored.
2182
Thomas Grafae8abfa2010-09-03 05:47:30 +00002183 Default: 0 (disabled) if global forwarding is disabled (default),
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002184 otherwise 1 (enabled).
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185
2186hop_limit - INTEGER
2187 Default Hop Limit to set.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002188
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 Default: 64
2190
2191mtu - INTEGER
2192 Default Maximum Transfer Unit
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002193
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 Default: 1280 (IPv6 required minimum)
2195
Tom Herbert35a256f2015-07-08 16:58:22 -07002196ip_nonlocal_bind - BOOLEAN
2197 If set, allows processes to bind() to non-local IPv6 addresses,
2198 which can be quite useful - but may break some applications.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002199
Tom Herbert35a256f2015-07-08 16:58:22 -07002200 Default: 0
2201
YOSHIFUJI Hideaki52e163562006-03-20 17:05:47 -08002202router_probe_interval - INTEGER
2203 Minimum interval (in seconds) between Router Probing described
2204 in RFC4191.
2205
2206 Default: 60
2207
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208router_solicitation_delay - INTEGER
2209 Number of seconds to wait after interface is brought up
2210 before sending Router Solicitations.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002211
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 Default: 1
2213
2214router_solicitation_interval - INTEGER
2215 Number of seconds to wait between Router Solicitations.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002216
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 Default: 4
2218
2219router_solicitations - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002220 Number of Router Solicitations to send until assuming no
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 routers are present.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002222
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 Default: 3
2224
Erik Kline3985e8a2015-07-22 16:38:25 +09002225use_oif_addrs_only - BOOLEAN
2226 When enabled, the candidate source addresses for destinations
2227 routed via this interface are restricted to the set of addresses
2228 configured on this interface (vis. RFC 6724, section 4).
2229
2230 Default: false
2231
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232use_tempaddr - INTEGER
2233 Preference for Privacy Extensions (RFC3041).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002234
2235 * <= 0 : disable Privacy Extensions
2236 * == 1 : enable Privacy Extensions, but prefer public
2237 addresses over temporary addresses.
2238 * > 1 : enable Privacy Extensions and prefer temporary
2239 addresses over public addresses.
2240
2241 Default:
2242
2243 * 0 (for most devices)
2244 * -1 (for point-to-point devices and loopback devices)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245
2246temp_valid_lft - INTEGER
2247 valid lifetime (in seconds) for temporary addresses.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002248
Fernando Gont969c5462020-05-01 00:51:47 -03002249 Default: 172800 (2 days)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250
2251temp_prefered_lft - INTEGER
2252 Preferred lifetime (in seconds) for temporary addresses.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002253
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 Default: 86400 (1 day)
2255
David Ahernf1705ec2016-02-24 09:25:37 -08002256keep_addr_on_down - INTEGER
2257 Keep all IPv6 addresses on an interface down event. If set static
2258 global addresses with no expiration time are not flushed.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002259
2260 * >0 : enabled
2261 * 0 : system default
2262 * <0 : disabled
David Ahernf1705ec2016-02-24 09:25:37 -08002263
2264 Default: 0 (addresses are removed)
2265
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266max_desync_factor - INTEGER
2267 Maximum value for DESYNC_FACTOR, which is a random value
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002268 that ensures that clients don't synchronize with each
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269 other and generate new addresses at exactly the same time.
2270 value is in seconds.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002271
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272 Default: 600
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00002273
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274regen_max_retry - INTEGER
2275 Number of attempts before give up attempting to generate
2276 valid temporary addresses.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002277
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 Default: 5
2279
2280max_addresses - INTEGER
Brian Haleye79dc482010-02-22 12:27:21 +00002281 Maximum number of autoconfigured addresses per interface. Setting
2282 to zero disables the limitation. It is not recommended to set this
2283 value too large (or to zero) because it would be an easy way to
2284 crash the kernel by allowing too many addresses to be created.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002285
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 Default: 16
2287
YOSHIFUJI Hideaki778d80b2008-06-28 14:17:11 +09002288disable_ipv6 - BOOLEAN
Brian Haley9bdd8d42009-03-18 18:22:48 -07002289 Disable IPv6 operation. If accept_dad is set to 2, this value
2290 will be dynamically set to TRUE if DAD fails for the link-local
2291 address.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002292
YOSHIFUJI Hideaki778d80b2008-06-28 14:17:11 +09002293 Default: FALSE (enable IPv6 operation)
2294
Brian Haley56d417b2009-06-01 03:07:33 -07002295 When this value is changed from 1 to 0 (IPv6 is being enabled),
2296 it will dynamically create a link-local address on the given
2297 interface and start Duplicate Address Detection, if necessary.
2298
2299 When this value is changed from 0 to 1 (IPv6 is being disabled),
Lorenzo Bianconi2f0aaf72018-03-29 11:02:25 +02002300 it will dynamically delete all addresses and routes on the given
2301 interface. From now on it will not possible to add addresses/routes
2302 to the selected interface.
Brian Haley56d417b2009-06-01 03:07:33 -07002303
YOSHIFUJI Hideaki1b34be72008-06-28 14:18:38 +09002304accept_dad - INTEGER
2305 Whether to accept DAD (Duplicate Address Detection).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002306
2307 == ==============================================================
2308 0 Disable DAD
2309 1 Enable DAD (default)
2310 2 Enable DAD, and disable IPv6 operation if MAC-based duplicate
2311 link-local address has been found.
2312 == ==============================================================
YOSHIFUJI Hideaki1b34be72008-06-28 14:18:38 +09002313
Matteo Croce35e015e2017-09-12 17:46:37 +02002314 DAD operation and mode on a given interface will be selected according
2315 to the maximum value of conf/{all,interface}/accept_dad.
2316
Octavian Purdilaf7734fd2009-10-02 11:39:15 +00002317force_tllao - BOOLEAN
2318 Enable sending the target link-layer address option even when
2319 responding to a unicast neighbor solicitation.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002320
Octavian Purdilaf7734fd2009-10-02 11:39:15 +00002321 Default: FALSE
2322
2323 Quoting from RFC 2461, section 4.4, Target link-layer address:
2324
2325 "The option MUST be included for multicast solicitations in order to
2326 avoid infinite Neighbor Solicitation "recursion" when the peer node
2327 does not have a cache entry to return a Neighbor Advertisements
2328 message. When responding to unicast solicitations, the option can be
2329 omitted since the sender of the solicitation has the correct link-
2330 layer address; otherwise it would not have be able to send the unicast
2331 solicitation in the first place. However, including the link-layer
2332 address in this case adds little overhead and eliminates a potential
2333 race condition where the sender deletes the cached link-layer address
2334 prior to receiving a response to a previous solicitation."
2335
Hannes Frederic Sowadb2b6202013-01-01 00:35:31 +00002336ndisc_notify - BOOLEAN
2337 Define mode for notification of address and device changes.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002338
2339 * 0 - (default): do nothing
2340 * 1 - Generate unsolicited neighbour advertisements when device is brought
2341 up or hardware address changes.
Hannes Frederic Sowadb2b6202013-01-01 00:35:31 +00002342
Maciej Żenczykowski2210d6b2017-11-07 21:52:09 -08002343ndisc_tclass - INTEGER
2344 The IPv6 Traffic Class to use by default when sending IPv6 Neighbor
2345 Discovery (Router Solicitation, Router Advertisement, Neighbor
2346 Solicitation, Neighbor Advertisement, Redirect) messages.
2347 These 8 bits can be interpreted as 6 high order bits holding the DSCP
2348 value and 2 low order bits representing ECN (which you probably want
2349 to leave cleared).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002350
2351 * 0 - (default)
Maciej Żenczykowski2210d6b2017-11-07 21:52:09 -08002352
James Prestwood18ac5972021-11-01 10:36:29 -07002353ndisc_evict_nocarrier - BOOLEAN
2354 Clears the neighbor discovery table on NOCARRIER events. This option is
2355 important for wireless devices where the neighbor discovery cache should
2356 not be cleared when roaming between access points on the same network.
2357 In most cases this should remain as the default (1).
2358
2359 - 1 - (default): Clear neighbor discover cache on NOCARRIER events.
2360 - 0 - Do not clear neighbor discovery cache on NOCARRIER events.
2361
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02002362mldv1_unsolicited_report_interval - INTEGER
2363 The interval in milliseconds in which the next unsolicited
2364 MLDv1 report retransmit will take place.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002365
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02002366 Default: 10000 (10 seconds)
2367
2368mldv2_unsolicited_report_interval - INTEGER
2369 The interval in milliseconds in which the next unsolicited
2370 MLDv2 report retransmit will take place.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002371
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02002372 Default: 1000 (1 second)
2373
Daniel Borkmannf2127812013-09-04 00:19:44 +02002374force_mld_version - INTEGER
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002375 * 0 - (default) No enforcement of a MLD version, MLDv1 fallback allowed
2376 * 1 - Enforce to use MLD version 1
2377 * 2 - Enforce to use MLD version 2
Daniel Borkmannf2127812013-09-04 00:19:44 +02002378
Hannes Frederic Sowab800c3b2013-08-27 01:36:51 +02002379suppress_frag_ndisc - INTEGER
2380 Control RFC 6980 (Security Implications of IPv6 Fragmentation
2381 with IPv6 Neighbor Discovery) behavior:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002382
2383 * 1 - (default) discard fragmented neighbor discovery packets
2384 * 0 - allow fragmented neighbor discovery packets
Hannes Frederic Sowab800c3b2013-08-27 01:36:51 +02002385
Erik Kline7fd25612014-10-28 18:11:14 +09002386optimistic_dad - BOOLEAN
2387 Whether to perform Optimistic Duplicate Address Detection (RFC 4429).
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002388
2389 * 0: disabled (default)
2390 * 1: enabled
Matteo Croce35e015e2017-09-12 17:46:37 +02002391
2392 Optimistic Duplicate Address Detection for the interface will be enabled
2393 if at least one of conf/{all,interface}/optimistic_dad is set to 1,
2394 it will be disabled otherwise.
Erik Kline7fd25612014-10-28 18:11:14 +09002395
2396use_optimistic - BOOLEAN
2397 If enabled, do not classify optimistic addresses as deprecated during
2398 source address selection. Preferred addresses will still be chosen
2399 before optimistic addresses, subject to other ranking in the source
2400 address selection algorithm.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002401
2402 * 0: disabled (default)
2403 * 1: enabled
Matteo Croce35e015e2017-09-12 17:46:37 +02002404
2405 This will be enabled if at least one of
2406 conf/{all,interface}/use_optimistic is set to 1, disabled otherwise.
Erik Kline7fd25612014-10-28 18:11:14 +09002407
Hannes Frederic Sowa9f0761c2015-03-23 23:36:06 +01002408stable_secret - IPv6 address
2409 This IPv6 address will be used as a secret to generate IPv6
2410 addresses for link-local addresses and autoconfigured
2411 ones. All addresses generated after setting this secret will
2412 be stable privacy ones by default. This can be changed via the
2413 addrgenmode ip-link. conf/default/stable_secret is used as the
2414 secret for the namespace, the interface specific ones can
2415 overwrite that. Writes to conf/all/stable_secret are refused.
2416
2417 It is recommended to generate this secret during installation
2418 of a system and keep it stable after that.
2419
2420 By default the stable secret is unset.
2421
Sabrina Dubrocaf168db52018-07-09 12:25:18 +02002422addr_gen_mode - INTEGER
2423 Defines how link-local and autoconf addresses are generated.
2424
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002425 = =================================================================
2426 0 generate address based on EUI64 (default)
2427 1 do no generate a link-local address, use EUI64 for addresses
2428 generated from autoconf
2429 2 generate stable privacy addresses, using the secret from
Sabrina Dubrocaf168db52018-07-09 12:25:18 +02002430 stable_secret (RFC7217)
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002431 3 generate stable privacy addresses, using a random secret if unset
2432 = =================================================================
Sabrina Dubrocaf168db52018-07-09 12:25:18 +02002433
Johannes Bergabbc3042016-02-04 13:31:19 +01002434drop_unicast_in_l2_multicast - BOOLEAN
2435 Drop any unicast IPv6 packets that are received in link-layer
2436 multicast (or broadcast) frames.
2437
2438 By default this is turned off.
2439
Johannes Berg7a02bf82016-02-04 13:31:20 +01002440drop_unsolicited_na - BOOLEAN
2441 Drop all unsolicited neighbor advertisements, for example if there's
2442 a known good NA proxy on the network and such frames need not be used
2443 (or in the case of 802.11, must not be used to prevent attacks.)
2444
2445 By default this is turned off.
2446
Erik Nordmarkadc176c2016-12-02 14:00:08 -08002447enhanced_dad - BOOLEAN
2448 Include a nonce option in the IPv6 neighbor solicitation messages used for
2449 duplicate address detection per RFC7527. A received DAD NS will only signal
2450 a duplicate address if the nonce is different. This avoids any false
2451 detection of duplicates due to loopback of the NS messages that we send.
2452 The nonce option will be sent on an interface unless both of
2453 conf/{all,interface}/enhanced_dad are set to FALSE.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002454
Erik Nordmarkadc176c2016-12-02 14:00:08 -08002455 Default: TRUE
2456
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002457``icmp/*``:
2458===========
2459
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460ratelimit - INTEGER
Stephen Suryaputra0bc19982019-04-17 16:35:49 -04002461 Limit the maximal rates for sending ICMPv6 messages.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002462
Stephen Hemminger6dbf4bc2008-07-01 19:29:07 -07002463 0 to disable any limiting,
2464 otherwise the minimal space between responses in milliseconds.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002465
Stephen Hemminger6dbf4bc2008-07-01 19:29:07 -07002466 Default: 1000
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467
Stephen Suryaputra0bc19982019-04-17 16:35:49 -04002468ratemask - list of comma separated ranges
2469 For ICMPv6 message types matching the ranges in the ratemask, limit
2470 the sending of the message according to ratelimit parameter.
2471
2472 The format used for both input and output is a comma separated
2473 list of ranges (e.g. "0-127,129" for ICMPv6 message type 0 to 127 and
2474 129). Writing to the file will clear all previous ranges of ICMPv6
2475 message types and update the current list with the input.
2476
2477 Refer to: https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml
2478 for numerical values of ICMPv6 message types, e.g. echo request is 128
2479 and echo reply is 129.
2480
2481 Default: 0-1,3-127 (rate limit ICMPv6 errors except Packet Too Big)
2482
Virgile Jarrye6f86b02018-08-10 17:48:15 +02002483echo_ignore_all - BOOLEAN
2484 If set non-zero, then the kernel will ignore all ICMP ECHO
2485 requests sent to it over the IPv6 protocol.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002486
Virgile Jarrye6f86b02018-08-10 17:48:15 +02002487 Default: 0
2488
Stephen Suryaputra03f1ecc2019-03-19 12:37:12 -04002489echo_ignore_multicast - BOOLEAN
2490 If set non-zero, then the kernel will ignore all ICMP ECHO
2491 requests sent to it over the IPv6 protocol via multicast.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002492
Stephen Suryaputra03f1ecc2019-03-19 12:37:12 -04002493 Default: 0
2494
Stephen Suryaputra0b03a5c2019-03-20 10:29:27 -04002495echo_ignore_anycast - BOOLEAN
2496 If set non-zero, then the kernel will ignore all ICMP ECHO
2497 requests sent to it over the IPv6 protocol destined to anycast address.
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002498
Stephen Suryaputra0b03a5c2019-03-20 10:29:27 -04002499 Default: 0
2500
Alexander Duycke69948a2015-08-11 13:35:01 -07002501xfrm6_gc_thresh - INTEGER
Nicolas Dichtel837f7412019-04-09 17:16:59 +02002502 (Obsolete since linux-4.14)
Alexander Duycke69948a2015-08-11 13:35:01 -07002503 The threshold at which we will start garbage collecting for IPv6
2504 destination cache entries. At twice this value the system will
Florian Westphal3c2a89d2017-07-17 13:57:20 +02002505 refuse new allocations.
Alexander Duycke69948a2015-08-11 13:35:01 -07002506
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507
2508IPv6 Update by:
2509Pekka Savola <pekkas@netcore.fi>
2510YOSHIFUJI Hideaki / USAGI Project <yoshfuji@linux-ipv6.org>
2511
2512
2513/proc/sys/net/bridge/* Variables:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002514=================================
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515
2516bridge-nf-call-arptables - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002517 - 1 : pass bridged ARP traffic to arptables' FORWARD chain.
2518 - 0 : disable this.
2519
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520 Default: 1
2521
2522bridge-nf-call-iptables - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002523 - 1 : pass bridged IPv4 traffic to iptables' chains.
2524 - 0 : disable this.
2525
Linus Torvalds1da177e2005-04-16 15:20:36 -07002526 Default: 1
2527
2528bridge-nf-call-ip6tables - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002529 - 1 : pass bridged IPv6 traffic to ip6tables' chains.
2530 - 0 : disable this.
2531
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532 Default: 1
2533
2534bridge-nf-filter-vlan-tagged - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002535 - 1 : pass bridged vlan-tagged ARP/IP/IPv6 traffic to {arp,ip,ip6}tables.
2536 - 0 : disable this.
2537
Pablo Neira Ayuso49816822012-05-08 19:36:44 +02002538 Default: 0
Michael Milner516299d2007-04-12 22:14:23 -07002539
2540bridge-nf-filter-pppoe-tagged - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002541 - 1 : pass bridged pppoe-tagged IP/IPv6 traffic to {ip,ip6}tables.
2542 - 0 : disable this.
2543
Pablo Neira Ayuso49816822012-05-08 19:36:44 +02002544 Default: 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545
Pablo Neira Ayuso49816822012-05-08 19:36:44 +02002546bridge-nf-pass-vlan-input-dev - BOOLEAN
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002547 - 1: if bridge-nf-filter-vlan-tagged is enabled, try to find a vlan
2548 interface on the bridge and set the netfilter input device to the
2549 vlan. This allows use of e.g. "iptables -i br0.1" and makes the
2550 REDIRECT target work with vlan-on-top-of-bridge interfaces. When no
2551 matching vlan interface is found, or this switch is off, the input
2552 device is set to the bridge interface.
2553
2554 - 0: disable bridge netfilter vlan interface lookup.
2555
Pablo Neira Ayuso49816822012-05-08 19:36:44 +02002556 Default: 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002558``proc/sys/net/sctp/*`` Variables:
2559==================================
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002560
2561addip_enable - BOOLEAN
2562 Enable or disable extension of Dynamic Address Reconfiguration
2563 (ADD-IP) functionality specified in RFC5061. This extension provides
2564 the ability to dynamically add and remove new addresses for the SCTP
2565 associations.
2566
2567 1: Enable extension.
2568
2569 0: Disable extension.
2570
2571 Default: 0
2572
Zhu Yanjun566178f2015-12-16 13:55:04 +08002573pf_enable - INTEGER
2574 Enable or disable pf (pf is short for potentially failed) state. A value
2575 of pf_retrans > path_max_retrans also disables pf state. That is, one of
2576 both pf_enable and pf_retrans > path_max_retrans can disable pf state.
2577 Since pf_retrans and path_max_retrans can be changed by userspace
2578 application, sometimes user expects to disable pf state by the value of
2579 pf_retrans > path_max_retrans, but occasionally the value of pf_retrans
2580 or path_max_retrans is changed by the user application, this pf state is
2581 enabled. As such, it is necessary to add this to dynamically enable
2582 and disable pf state. See:
2583 https://datatracker.ietf.org/doc/draft-ietf-tsvwg-sctp-failover for
2584 details.
2585
2586 1: Enable pf.
2587
2588 0: Disable pf.
2589
2590 Default: 1
2591
Xin Longaef587b2019-11-08 13:20:32 +08002592pf_expose - INTEGER
2593 Unset or enable/disable pf (pf is short for potentially failed) state
2594 exposure. Applications can control the exposure of the PF path state
2595 in the SCTP_PEER_ADDR_CHANGE event and the SCTP_GET_PEER_ADDR_INFO
2596 sockopt. When it's unset, no SCTP_PEER_ADDR_CHANGE event with
2597 SCTP_ADDR_PF state will be sent and a SCTP_PF-state transport info
2598 can be got via SCTP_GET_PEER_ADDR_INFO sockopt; When it's enabled,
2599 a SCTP_PEER_ADDR_CHANGE event will be sent for a transport becoming
2600 SCTP_PF state and a SCTP_PF-state transport info can be got via
2601 SCTP_GET_PEER_ADDR_INFO sockopt; When it's diabled, no
2602 SCTP_PEER_ADDR_CHANGE event will be sent and it returns -EACCES when
2603 trying to get a SCTP_PF-state transport info via SCTP_GET_PEER_ADDR_INFO
2604 sockopt.
2605
2606 0: Unset pf state exposure, Compatible with old applications.
2607
2608 1: Disable pf state exposure.
2609
2610 2: Enable pf state exposure.
2611
2612 Default: 0
2613
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002614addip_noauth_enable - BOOLEAN
2615 Dynamic Address Reconfiguration (ADD-IP) requires the use of
2616 authentication to protect the operations of adding or removing new
2617 addresses. This requirement is mandated so that unauthorized hosts
2618 would not be able to hijack associations. However, older
2619 implementations may not have implemented this requirement while
2620 allowing the ADD-IP extension. For reasons of interoperability,
2621 we provide this variable to control the enforcement of the
2622 authentication requirement.
2623
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002624 == ===============================================================
2625 1 Allow ADD-IP extension to be used without authentication. This
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002626 should only be set in a closed environment for interoperability
2627 with older implementations.
2628
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002629 0 Enforce the authentication requirement
2630 == ===============================================================
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002631
2632 Default: 0
2633
2634auth_enable - BOOLEAN
2635 Enable or disable Authenticated Chunks extension. This extension
2636 provides the ability to send and receive authenticated chunks and is
2637 required for secure operation of Dynamic Address Reconfiguration
2638 (ADD-IP) extension.
2639
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002640 - 1: Enable this extension.
2641 - 0: Disable this extension.
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002642
2643 Default: 0
2644
2645prsctp_enable - BOOLEAN
2646 Enable or disable the Partial Reliability extension (RFC3758) which
2647 is used to notify peers that a given DATA should no longer be expected.
2648
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002649 - 1: Enable extension
2650 - 0: Disable
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002651
2652 Default: 1
2653
2654max_burst - INTEGER
2655 The limit of the number of new packets that can be initially sent. It
2656 controls how bursty the generated traffic can be.
2657
2658 Default: 4
2659
2660association_max_retrans - INTEGER
2661 Set the maximum number for retransmissions that an association can
2662 attempt deciding that the remote end is unreachable. If this value
2663 is exceeded, the association is terminated.
2664
2665 Default: 10
2666
2667max_init_retransmits - INTEGER
2668 The maximum number of retransmissions of INIT and COOKIE-ECHO chunks
2669 that an association will attempt before declaring the destination
2670 unreachable and terminating.
2671
2672 Default: 8
2673
2674path_max_retrans - INTEGER
2675 The maximum number of retransmissions that will be attempted on a given
2676 path. Once this threshold is exceeded, the path is considered
2677 unreachable, and new traffic will use a different path when the
2678 association is multihomed.
2679
2680 Default: 5
2681
Neil Horman5aa93bc2012-07-21 07:56:07 +00002682pf_retrans - INTEGER
2683 The number of retransmissions that will be attempted on a given path
2684 before traffic is redirected to an alternate transport (should one
2685 exist). Note this is distinct from path_max_retrans, as a path that
2686 passes the pf_retrans threshold can still be used. Its only
2687 deprioritized when a transmission path is selected by the stack. This
2688 setting is primarily used to enable fast failover mechanisms without
2689 having to reduce path_max_retrans to a very low value. See:
2690 http://www.ietf.org/id/draft-nishida-tsvwg-sctp-failover-05.txt
2691 for details. Note also that a value of pf_retrans > path_max_retrans
Zhu Yanjun566178f2015-12-16 13:55:04 +08002692 disables this feature. Since both pf_retrans and path_max_retrans can
2693 be changed by userspace application, a variable pf_enable is used to
2694 disable pf state.
Neil Horman5aa93bc2012-07-21 07:56:07 +00002695
2696 Default: 0
2697
Xin Long34515e92019-11-08 13:20:35 +08002698ps_retrans - INTEGER
2699 Primary.Switchover.Max.Retrans (PSMR), it's a tunable parameter coming
2700 from section-5 "Primary Path Switchover" in rfc7829. The primary path
2701 will be changed to another active path when the path error counter on
2702 the old primary path exceeds PSMR, so that "the SCTP sender is allowed
2703 to continue data transmission on a new working path even when the old
2704 primary destination address becomes active again". Note this feature
2705 is disabled by initializing 'ps_retrans' per netns as 0xffff by default,
2706 and its value can't be less than 'pf_retrans' when changing by sysctl.
2707
2708 Default: 0xffff
2709
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002710rto_initial - INTEGER
2711 The initial round trip timeout value in milliseconds that will be used
2712 in calculating round trip times. This is the initial time interval
2713 for retransmissions.
2714
2715 Default: 3000
2716
2717rto_max - INTEGER
2718 The maximum value (in milliseconds) of the round trip timeout. This
2719 is the largest time interval that can elapse between retransmissions.
2720
2721 Default: 60000
2722
2723rto_min - INTEGER
2724 The minimum value (in milliseconds) of the round trip timeout. This
2725 is the smallest time interval the can elapse between retransmissions.
2726
2727 Default: 1000
2728
2729hb_interval - INTEGER
2730 The interval (in milliseconds) between HEARTBEAT chunks. These chunks
2731 are sent at the specified interval on idle paths to probe the state of
2732 a given path between 2 associations.
2733
2734 Default: 30000
2735
2736sack_timeout - INTEGER
2737 The amount of time (in milliseconds) that the implementation will wait
2738 to send a SACK.
2739
2740 Default: 200
2741
2742valid_cookie_life - INTEGER
2743 The default lifetime of the SCTP cookie (in milliseconds). The cookie
2744 is used during association establishment.
2745
2746 Default: 60000
2747
2748cookie_preserve_enable - BOOLEAN
2749 Enable or disable the ability to extend the lifetime of the SCTP cookie
2750 that is used during the establishment phase of SCTP association
2751
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002752 - 1: Enable cookie lifetime extension.
2753 - 0: Disable
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002754
2755 Default: 1
2756
Neil Horman3c681982012-10-24 09:20:03 +00002757cookie_hmac_alg - STRING
2758 Select the hmac algorithm used when generating the cookie value sent by
2759 a listening sctp socket to a connecting client in the INIT-ACK chunk.
2760 Valid values are:
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002761
Neil Horman3c681982012-10-24 09:20:03 +00002762 * md5
2763 * sha1
2764 * none
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002765
Neil Horman3c681982012-10-24 09:20:03 +00002766 Ability to assign md5 or sha1 as the selected alg is predicated on the
stephen hemminger3b09adc2013-01-03 07:50:29 +00002767 configuration of those algorithms at build time (CONFIG_CRYPTO_MD5 and
Neil Horman3c681982012-10-24 09:20:03 +00002768 CONFIG_CRYPTO_SHA1).
2769
2770 Default: Dependent on configuration. MD5 if available, else SHA1 if
2771 available, else none.
2772
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002773rcvbuf_policy - INTEGER
2774 Determines if the receive buffer is attributed to the socket or to
2775 association. SCTP supports the capability to create multiple
2776 associations on a single socket. When using this capability, it is
2777 possible that a single stalled association that's buffering a lot
2778 of data may block other associations from delivering their data by
2779 consuming all of the receive buffer space. To work around this,
2780 the rcvbuf_policy could be set to attribute the receiver buffer space
2781 to each association instead of the socket. This prevents the described
2782 blocking.
2783
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002784 - 1: rcvbuf space is per association
2785 - 0: rcvbuf space is per socket
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002786
2787 Default: 0
2788
2789sndbuf_policy - INTEGER
2790 Similar to rcvbuf_policy above, this applies to send buffer space.
2791
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002792 - 1: Send buffer is tracked per association
2793 - 0: Send buffer is tracked per socket.
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002794
2795 Default: 0
2796
2797sctp_mem - vector of 3 INTEGERs: min, pressure, max
2798 Number of pages allowed for queueing by all SCTP sockets.
2799
2800 min: Below this number of pages SCTP is not bothered about its
2801 memory appetite. When amount of memory allocated by SCTP exceeds
2802 this number, SCTP starts to moderate memory usage.
2803
2804 pressure: This value was introduced to follow format of tcp_mem.
2805
2806 max: Number of pages allowed for queueing by all SCTP sockets.
2807
2808 Default is calculated at boot time from amount of available memory.
2809
2810sctp_rmem - vector of 3 INTEGERs: min, default, max
Max Matveeva6e12042011-06-19 22:08:10 +00002811 Only the first value ("min") is used, "default" and "max" are
2812 ignored.
2813
2814 min: Minimal size of receive buffer used by SCTP socket.
2815 It is guaranteed to each SCTP socket (but not association) even
2816 under moderate memory pressure.
2817
Tonghao Zhang320bd6d2018-03-13 21:57:17 -07002818 Default: 4K
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002819
2820sctp_wmem - vector of 3 INTEGERs: min, default, max
Max Matveeva6e12042011-06-19 22:08:10 +00002821 Currently this tunable has no effect.
Vlad Yasevich32e8d492008-07-08 16:43:29 -07002822
Bhaskar Dutta72388432009-09-03 17:25:47 +05302823addr_scope_policy - INTEGER
2824 Control IPv4 address scoping - draft-stewart-tsvwg-sctp-ipv4-00
2825
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002826 - 0 - Disable IPv4 address scoping
2827 - 1 - Enable IPv4 address scoping
2828 - 2 - Follow draft but allow IPv4 private addresses
2829 - 3 - Follow draft but allow IPv4 link local addresses
Bhaskar Dutta72388432009-09-03 17:25:47 +05302830
2831 Default: 1
2832
Xin Long046c0522020-10-29 15:05:10 +08002833udp_port - INTEGER
2834 The listening port for the local UDP tunneling sock. Normally it's
2835 using the IANA-assigned UDP port number 9899 (sctp-tunneling).
2836
2837 This UDP sock is used for processing the incoming UDP-encapsulated
2838 SCTP packets (from RFC6951), and shared by all applications in the
2839 same net namespace. This UDP sock will be closed when the value is
2840 set to 0.
2841
2842 The value will also be used to set the src port of the UDP header
2843 for the outgoing UDP-encapsulated SCTP packets. For the dest port,
2844 please refer to 'encap_port' below.
2845
2846 Default: 0
2847
Xin Longe8a30012020-10-29 15:05:01 +08002848encap_port - INTEGER
2849 The default remote UDP encapsulation port.
2850
2851 This value is used to set the dest port of the UDP header for the
2852 outgoing UDP-encapsulated SCTP packets by default. Users can also
2853 change the value for each sock/asoc/transport by using setsockopt.
2854 For further information, please refer to RFC6951.
2855
2856 Note that when connecting to a remote server, the client should set
2857 this to the port that the UDP tunneling sock on the peer server is
2858 listening to and the local UDP tunneling sock on the client also
2859 must be started. On the server, it would get the encap_port from
2860 the incoming packet's source port.
2861
2862 Default: 0
2863
Xin Longd1e462a2021-06-22 14:04:48 -04002864plpmtud_probe_interval - INTEGER
Xin Longfea1d5b2021-06-24 11:48:09 -04002865 The time interval (in milliseconds) for the PLPMTUD probe timer,
2866 which is configured to expire after this period to receive an
2867 acknowledgment to a probe packet. This is also the time interval
2868 between the probes for the current pmtu when the probe search
2869 is done.
2870
2871 PLPMTUD will be disabled when 0 is set, and other values for it
2872 must be >= 5000.
Xin Longd1e462a2021-06-22 14:04:48 -04002873
2874 Default: 0
2875
Linus Torvalds1da177e2005-04-16 15:20:36 -07002876
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002877``/proc/sys/net/core/*``
2878========================
2879
Mauro Carvalho Chehab57043242019-04-22 16:48:00 -03002880 Please see: Documentation/admin-guide/sysctl/net.rst for descriptions of these entries.
Wang Tinggong705efc32009-05-14 22:49:36 +00002881
Linus Torvalds1da177e2005-04-16 15:20:36 -07002882
Mauro Carvalho Chehab1cec2ca2020-04-28 00:01:49 +02002883``/proc/sys/net/unix/*``
2884========================
2885
Wang Tinggong705efc32009-05-14 22:49:36 +00002886max_dgram_qlen - INTEGER
2887 The maximum length of dgram socket receive queue
2888
2889 Default: 10
2890