Documentation: networking: correct spelling
[linux-block.git] / Documentation / networking / ip-sysctl.rst
CommitLineData
1cec2cac
MCC
1.. SPDX-License-Identifier: GPL-2.0
2
3=========
4IP Sysctl
5=========
6
7/proc/sys/net/ipv4/* Variables
8==============================
1da177e4
LT
9
10ip_forward - BOOLEAN
1cec2cac
MCC
11 - 0 - disabled (default)
12 - not 0 - enabled
1da177e4
LT
13
14 Forward Packets between interfaces.
15
16 This variable is special, its change resets all configuration
17 parameters to their default state (RFC1122 for hosts, RFC1812
18 for routers)
19
20ip_default_ttl - INTEGER
cc6f02dd
ED
21 Default value of TTL field (Time To Live) for outgoing (but not
22 forwarded) IP packets. Should be between 1 and 255 inclusive.
23 Default: 64 (as recommended by RFC1700)
1da177e4 24
cd174e67
HFS
25ip_no_pmtu_disc - INTEGER
26 Disable Path MTU Discovery. If enabled in mode 1 and a
188b04d5 27 fragmentation-required ICMP is received, the PMTU to this
be1c5b53 28 destination will be set to the smallest of the old MTU to
29 this destination and min_pmtu (see below). You will need
188b04d5
HFS
30 to raise min_pmtu to the smallest interface MTU on your system
31 manually if you want to avoid locally generated fragments.
cd174e67
HFS
32
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
bb38ccce 37 Mode 3 is a hardened pmtu discover mode. The kernel will only
8ed1dc44
HFS
38 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
1cec2cac 49
188b04d5 50 Default: FALSE
1da177e4
LT
51
52min_pmtu - INTEGER
a266ef69 53 default 552 - minimum Path MTU. Unless this is changed manually,
be1c5b53 54 each cached pmtu will never be lower than this setting.
1da177e4 55
f87c10a8
HFS
56ip_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.
1cec2cac 64
f87c10a8 65 Default: 0 (disabled)
1cec2cac 66
f87c10a8 67 Possible values:
1cec2cac
MCC
68
69 - 0 - disabled
70 - 1 - enabled
f87c10a8 71
219b5f29
LV
72fwmark_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.
1cec2cac 77
219b5f29
LV
78 Default: 0
79
a6db4494
DA
80fib_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.
1cec2cac 85
a6db4494 86 Default: 0 (disabled)
1cec2cac 87
a6db4494 88 Possible values:
1cec2cac
MCC
89
90 - 0 - disabled
91 - 1 - enabled
a6db4494 92
bf4e0a3d
NA
93fib_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.
1cec2cac 96
bf4e0a3d 97 Default: 0 (Layer 3)
1cec2cac 98
bf4e0a3d 99 Possible values:
1cec2cac
MCC
100
101 - 0 - Layer 3
102 - 1 - Layer 4
103 - 2 - Layer 3 or inner Layer 3 if present
4253b498
IS
104 - 3 - Custom multipath hash. Fields used for multipath hash calculation
105 are determined by fib_multipath_hash_fields sysctl
bf4e0a3d 106
ce5c9c20
IS
107fib_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
9ab948a9
DA
134fib_sync_mem - UNSIGNED INTEGER
135 Amount of dirty memory from fib entries that can be backlogged before
136 synchronize_rcu is forced.
1cec2cac
MCC
137
138 Default: 512kB Minimum: 64kB Maximum: 64MB
9ab948a9 139
432e05d3
PM
140ip_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).
1cec2cac 144
432e05d3 145 Default: 1 (Update priority.)
1cec2cac 146
432e05d3 147 Possible values:
1cec2cac
MCC
148
149 - 0 - Do not update priority.
150 - 1 - Update priority.
432e05d3 151
cbaf087a
BG
152route/max_size - INTEGER
153 Maximum number of routes allowed in the kernel. Increase
154 this when using large numbers of interfaces and/or routes.
1cec2cac 155
25050c63
AS
156 From linux kernel 3.6 onwards, this is deprecated for ipv4
157 as route cache is no longer used.
cbaf087a 158
695a376b
JM
159 From linux kernel 6.3 onwards, this is deprecated for ipv6
160 as garbage collection manages cached route entries.
161
2724680b
YH
162neigh/default/gc_thresh1 - INTEGER
163 Minimum number of entries to keep. Garbage collector will not
164 purge entries if there are fewer than this number.
1cec2cac 165
b66c66dc 166 Default: 128
2724680b 167
a3d12146 168neigh/default/gc_thresh2 - INTEGER
169 Threshold when garbage collector becomes more aggressive about
170 purging entries. Entries older than 5 seconds will be cleared
171 when over this number.
1cec2cac 172
a3d12146 173 Default: 512
174
cbaf087a 175neigh/default/gc_thresh3 - INTEGER
58956317
DA
176 Maximum number of non-PERMANENT neighbor entries allowed. Increase
177 this when using large numbers of interfaces and when communicating
cbaf087a 178 with large numbers of directly-connected peers.
1cec2cac 179
cc868028 180 Default: 1024
cbaf087a 181
8b5c171b
ED
182neigh/default/unres_qlen_bytes - INTEGER
183 The maximum number of bytes which may be used by packets
184 queued for each unresolved address by other network layers.
185 (added in linux 3.3)
1cec2cac 186
3b09adcb 187 Setting negative value is meaningless and will return error.
1cec2cac 188
eaa72dc4 189 Default: SK_WMEM_MAX, (same as net.core.wmem_default).
1cec2cac 190
eaa72dc4
ED
191 Exact value depends on architecture and kernel options,
192 but should be enough to allow queuing 256 packets
193 of medium size.
8b5c171b
ED
194
195neigh/default/unres_qlen - INTEGER
196 The maximum number of packets which may be queued for each
197 unresolved address by other network layers.
1cec2cac 198
8b5c171b 199 (deprecated in linux 3.3) : use unres_qlen_bytes instead.
1cec2cac 200
cc868028 201 Prior to linux 3.3, the default value is 3 which may cause
5d248c49 202 unexpected packet loss. The current default value is calculated
cc868028
SW
203 according to default value of unres_qlen_bytes and true size of
204 packet.
1cec2cac 205
eaa72dc4 206 Default: 101
8b5c171b 207
211da42e
YW
208neigh/default/interval_probe_time_ms - INTEGER
209 The probe interval for neighbor entries with NTF_MANAGED flag,
210 the min value is 1.
211
212 Default: 5000
213
1da177e4
LT
214mtu_expires - INTEGER
215 Time, in seconds, that cached PMTU information is kept.
216
217min_adv_mss - INTEGER
218 The advertised MSS depends on the first hop route MTU, but will
219 never be lower than this setting.
220
680aea08
AC
221fib_notify_on_flag_change - INTEGER
222 Whether to emit RTM_NEWROUTE notifications whenever RTM_F_OFFLOAD/
648106c3 223 RTM_F_TRAP/RTM_F_OFFLOAD_FAILED flags are changed.
680aea08
AC
224
225 After installing a route to the kernel, user space receives an
226 acknowledgment, which means the route was installed in the kernel,
227 but not necessarily in hardware.
228 It is also possible for a route already installed in hardware to change
229 its action and therefore its flags. For example, a host route that is
230 trapping packets can be "promoted" to perform decapsulation following
231 the installation of an IPinIP/VXLAN tunnel.
232 The notifications will indicate to user-space the state of the route.
233
234 Default: 0 (Do not emit notifications.)
235
236 Possible values:
237
238 - 0 - Do not emit notifications.
239 - 1 - Emit notifications.
648106c3 240 - 2 - Emit notifications only for RTM_F_OFFLOAD_FAILED flag change.
680aea08 241
1da177e4
LT
242IP Fragmentation:
243
3e67f106 244ipfrag_high_thresh - LONG INTEGER
648700f7 245 Maximum memory used to reassemble IP fragments.
e18f5feb 246
3e67f106 247ipfrag_low_thresh - LONG INTEGER
648700f7 248 (Obsolete since linux-4.17)
b13d3cbf
FW
249 Maximum memory used to reassemble IP fragments before the kernel
250 begins to remove incomplete fragment queues to free up resources.
251 The kernel still accepts new fragments for defragmentation.
1da177e4
LT
252
253ipfrag_time - INTEGER
e18f5feb 254 Time in seconds to keep an IP fragment in memory.
1da177e4 255
89cee8b1 256ipfrag_max_dist - INTEGER
e18f5feb
JDB
257 ipfrag_max_dist is a non-negative integer value which defines the
258 maximum "disorder" which is allowed among fragments which share a
259 common IP source address. Note that reordering of packets is
260 not unusual, but if a large number of fragments arrive from a source
261 IP address while a particular fragment queue remains incomplete, it
262 probably indicates that one or more fragments belonging to that queue
263 have been lost. When ipfrag_max_dist is positive, an additional check
264 is done on fragments before they are added to a reassembly queue - if
265 ipfrag_max_dist (or more) fragments have arrived from a particular IP
266 address between additions to any IP fragment queue using that source
267 address, it's presumed that one or more fragments in the queue are
268 lost. The existing fragment queue will be dropped, and a new one
89cee8b1
HX
269 started. An ipfrag_max_dist value of zero disables this check.
270
271 Using a very small value, e.g. 1 or 2, for ipfrag_max_dist can
272 result in unnecessarily dropping fragment queues when normal
e18f5feb
JDB
273 reordering of packets occurs, which could lead to poor application
274 performance. Using a very large value, e.g. 50000, increases the
275 likelihood of incorrectly reassembling IP fragments that originate
89cee8b1
HX
276 from different IP datagrams, which could result in data corruption.
277 Default: 64
278
c6a4254c
ND
279bc_forwarding - INTEGER
280 bc_forwarding enables the feature described in rfc1812#section-5.3.5.2
281 and rfc2644. It allows the router to forward directed broadcast.
282 To enable this feature, the 'all' entry and the input interface entry
283 should be set to 1.
284 Default: 0
285
1cec2cac
MCC
286INET peer storage
287=================
1da177e4
LT
288
289inet_peer_threshold - INTEGER
e18f5feb 290 The approximate size of the storage. Starting from this threshold
1da177e4
LT
291 entries will be thrown aggressively. This threshold also determines
292 entries' time-to-live and time intervals between garbage collection
293 passes. More entries, less time-to-live, less GC interval.
294
295inet_peer_minttl - INTEGER
296 Minimum time-to-live of entries. Should be enough to cover fragment
297 time-to-live on the reassembling side. This minimum time-to-live is
298 guaranteed if the pool size is less than inet_peer_threshold.
77a538d5 299 Measured in seconds.
1da177e4
LT
300
301inet_peer_maxttl - INTEGER
302 Maximum time-to-live of entries. Unused entries will expire after
303 this period of time if there is no memory pressure on the pool (i.e.
304 when the number of entries in the pool is very small).
77a538d5 305 Measured in seconds.
1da177e4 306
1cec2cac
MCC
307TCP variables
308=============
1da177e4 309
ef56e622
SH
310somaxconn - INTEGER
311 Limit of socket listen() backlog, known in userspace as SOMAXCONN.
19f92a03
ED
312 Defaults to 4096. (Was 128 before linux-5.4)
313 See also tcp_max_syn_backlog for additional tuning for TCP sockets.
ef56e622 314
ef56e622
SH
315tcp_abort_on_overflow - BOOLEAN
316 If listening service is too slow to accept new connections,
317 reset them. Default state is FALSE. It means that if overflow
318 occurred due to a burst, connection will recover. Enable this
319 option _only_ if you are really sure that listening daemon
320 cannot be tuned to accept connections faster. Enabling this
321 option can harm clients of your server.
1da177e4 322
ef56e622
SH
323tcp_adv_win_scale - INTEGER
324 Count buffering overhead as bytes/2^tcp_adv_win_scale
325 (if tcp_adv_win_scale > 0) or bytes-bytes/2^(-tcp_adv_win_scale),
326 if it is <= 0.
1cec2cac 327
0147fc05 328 Possible values are [-31, 31], inclusive.
1cec2cac 329
b49960a0 330 Default: 1
1da177e4 331
ef56e622
SH
332tcp_allowed_congestion_control - STRING
333 Show/set the congestion control choices available to non-privileged
334 processes. The list is a subset of those listed in
335 tcp_available_congestion_control.
1cec2cac 336
ef56e622 337 Default is "reno" and the default setting (tcp_congestion_control).
1da177e4 338
ef56e622
SH
339tcp_app_win - INTEGER
340 Reserve max(window/2^tcp_app_win, mss) of window for application
341 buffer. Value 0 is special, it means that nothing is reserved.
1cec2cac 342
ef56e622 343 Default: 31
1da177e4 344
f54b3111
ED
345tcp_autocorking - BOOLEAN
346 Enable TCP auto corking :
347 When applications do consecutive small write()/sendmsg() system calls,
348 we try to coalesce these small writes as much as possible, to lower
349 total amount of sent packets. This is done if at least one prior
350 packet for the flow is waiting in Qdisc queues or device transmit
351 queue. Applications can still use TCP_CORK for optimal behavior
352 when they know how/when to uncork their sockets.
1cec2cac 353
f54b3111
ED
354 Default : 1
355
ef56e622
SH
356tcp_available_congestion_control - STRING
357 Shows the available congestion control choices that are registered.
358 More congestion control algorithms may be available as modules,
359 but not loaded.
1da177e4 360
71599cd1 361tcp_base_mss - INTEGER
4edc2f34
SH
362 The initial value of search_low to be used by the packetization layer
363 Path MTU discovery (MTU probing). If MTU probing is enabled,
364 this is the initial MSS used by the connection.
71599cd1 365
c04b79b6
JH
366tcp_mtu_probe_floor - INTEGER
367 If MTU probing is enabled this caps the minimum MSS used for search_low
368 for the connection.
369
370 Default : 48
371
5f3e2bf0
ED
372tcp_min_snd_mss - INTEGER
373 TCP SYN and SYNACK messages usually advertise an ADVMSS option,
374 as described in RFC 1122 and RFC 6691.
1cec2cac 375
5f3e2bf0
ED
376 If this ADVMSS option is smaller than tcp_min_snd_mss,
377 it is silently capped to tcp_min_snd_mss.
378
379 Default : 48 (at least 8 bytes of payload per segment)
380
ef56e622
SH
381tcp_congestion_control - STRING
382 Set the congestion control algorithm to be used for new
383 connections. The algorithm "reno" is always available, but
384 additional choices may be available based on kernel configuration.
385 Default is set as part of kernel configuration.
d8a6e65f
ED
386 For passive connections, the listener congestion control choice
387 is inherited.
1cec2cac 388
d8a6e65f 389 [see setsockopt(listenfd, SOL_TCP, TCP_CONGESTION, "name" ...) ]
1da177e4 390
ef56e622
SH
391tcp_dsack - BOOLEAN
392 Allows TCP to send "duplicate" SACKs.
1da177e4 393
eed530b6 394tcp_early_retrans - INTEGER
bec41a11
YC
395 Tail loss probe (TLP) converts RTOs occurring due to tail
396 losses into fast recovery (draft-ietf-tcpm-rack). Note that
397 TLP requires RACK to function properly (see tcp_recovery below)
1cec2cac 398
eed530b6 399 Possible values:
1cec2cac
MCC
400
401 - 0 disables TLP
402 - 3 or 4 enables TLP
403
6ba8a3b1 404 Default: 3
eed530b6 405
34a6ef38 406tcp_ecn - INTEGER
7e3a2dc5
RJ
407 Control use of Explicit Congestion Notification (ECN) by TCP.
408 ECN is used only when both ends of the TCP connection indicate
409 support for it. This feature is useful in avoiding losses due
410 to congestion by allowing supporting routers to signal
411 congestion before having to drop packets.
1cec2cac 412
255cac91 413 Possible values are:
1cec2cac
MCC
414
415 = =====================================================
416 0 Disable ECN. Neither initiate nor accept ECN.
417 1 Enable ECN when requested by incoming connections and
418 also request ECN on outgoing connection attempts.
419 2 Enable ECN when requested by incoming connections
420 but do not request ECN on outgoing connections.
421 = =====================================================
422
255cac91 423 Default: 2
ef56e622 424
49213555
DB
425tcp_ecn_fallback - BOOLEAN
426 If the kernel detects that ECN connection misbehaves, enable fall
427 back to non-ECN. Currently, this knob implements the fallback
428 from RFC3168, section 6.1.1.1., but we reserve that in future,
429 additional detection mechanisms could be implemented under this
430 knob. The value is not used, if tcp_ecn or per route (or congestion
431 control) ECN settings are disabled.
1cec2cac 432
49213555
DB
433 Default: 1 (fallback enabled)
434
ef56e622 435tcp_fack - BOOLEAN
713bafea 436 This is a legacy option, it has no effect anymore.
1da177e4
LT
437
438tcp_fin_timeout - INTEGER
d825da2e
RJ
439 The length of time an orphaned (no longer referenced by any
440 application) connection will remain in the FIN_WAIT_2 state
441 before it is aborted at the local end. While a perfectly
442 valid "receive only" state for an un-orphaned connection, an
443 orphaned connection in FIN_WAIT_2 state could otherwise wait
444 forever for the remote to close its end of the connection.
1cec2cac 445
d825da2e 446 Cf. tcp_max_orphans
1cec2cac 447
d825da2e 448 Default: 60 seconds
1da177e4 449
89808060 450tcp_frto - INTEGER
e33099f9 451 Enables Forward RTO-Recovery (F-RTO) defined in RFC5682.
cd99889c 452 F-RTO is an enhanced recovery algorithm for TCP retransmission
e33099f9
YC
453 timeouts. It is particularly beneficial in networks where the
454 RTT fluctuates (e.g., wireless). F-RTO is sender-side only
455 modification. It does not require any support from the peer.
456
457 By default it's enabled with a non-zero value. 0 disables F-RTO.
1da177e4 458
e2d00e62
LC
459tcp_fwmark_accept - BOOLEAN
460 If set, incoming connections to listening sockets that do not have a
461 socket mark will set the mark of the accepting socket to the fwmark of
462 the incoming SYN packet. This will cause all packets on that connection
463 (starting from the first SYNACK) to be sent with that fwmark. The
464 listening socket's mark is unchanged. Listening sockets that already
465 have a fwmark set via setsockopt(SOL_SOCKET, SO_MARK, ...) are
466 unaffected.
467
468 Default: 0
469
032ee423
NC
470tcp_invalid_ratelimit - INTEGER
471 Limit the maximal rate for sending duplicate acknowledgments
472 in response to incoming TCP packets that are for an existing
473 connection but that are invalid due to any of these reasons:
474
475 (a) out-of-window sequence number,
476 (b) out-of-window acknowledgment number, or
477 (c) PAWS (Protection Against Wrapped Sequence numbers) check failure
478
479 This can help mitigate simple "ack loop" DoS attacks, wherein
480 a buggy or malicious middlebox or man-in-the-middle can
481 rewrite TCP header fields in manner that causes each endpoint
482 to think that the other is sending invalid TCP segments, thus
483 causing each side to send an unterminating stream of duplicate
484 acknowledgments for invalid segments.
485
486 Using 0 disables rate-limiting of dupacks in response to
487 invalid segments; otherwise this value specifies the minimal
488 space between sending such dupacks, in milliseconds.
489
490 Default: 500 (milliseconds).
491
ef56e622
SH
492tcp_keepalive_time - INTEGER
493 How often TCP sends out keepalive messages when keepalive is enabled.
494 Default: 2hours.
1da177e4 495
ef56e622
SH
496tcp_keepalive_probes - INTEGER
497 How many keepalive probes TCP sends out, until it decides that the
498 connection is broken. Default value: 9.
499
500tcp_keepalive_intvl - INTEGER
501 How frequently the probes are send out. Multiplied by
502 tcp_keepalive_probes it is time to kill not responding connection,
503 after probes started. Default value: 75sec i.e. connection
504 will be aborted after ~11 minutes of retries.
505
6dd9a14e
DA
506tcp_l3mdev_accept - BOOLEAN
507 Enables child sockets to inherit the L3 master device index.
508 Enabling this option allows a "global" listen socket to work
509 across L3 master domains (e.g., VRFs) with connected sockets
510 derived from the listen socket to be bound to the L3 domain in
511 which the packets originated. Only valid when the kernel was
512 compiled with CONFIG_NET_L3_MASTER_DEV.
1cec2cac
MCC
513
514 Default: 0 (disabled)
6dd9a14e 515
ef56e622 516tcp_low_latency - BOOLEAN
b6690b14 517 This is a legacy option, it has no effect anymore.
1da177e4
LT
518
519tcp_max_orphans - INTEGER
520 Maximal number of TCP sockets not attached to any user file handle,
521 held by system. If this number is exceeded orphaned connections are
522 reset immediately and warning is printed. This limit exists
523 only to prevent simple DoS attacks, you _must_ not rely on this
524 or lower the limit artificially, but rather increase it
525 (probably, after increasing installed memory),
526 if network conditions require more than default value,
527 and tune network services to linger and kill such states
528 more aggressively. Let me to remind again: each orphan eats
529 up to ~64K of unswappable memory.
530
1da177e4 531tcp_max_syn_backlog - INTEGER
623d0c2d
ED
532 Maximal number of remembered connection requests (SYN_RECV),
533 which have not received an acknowledgment from connecting client.
1cec2cac 534
623d0c2d 535 This is a per-listener limit.
1cec2cac 536
99b53bdd
PP
537 The minimal value is 128 for low memory machines, and it will
538 increase in proportion to the memory of machine.
1cec2cac 539
99b53bdd 540 If server suffers from overload, try increasing this number.
1cec2cac 541
623d0c2d
ED
542 Remember to also check /proc/sys/net/core/somaxconn
543 A SYN_RECV request socket consumes about 304 bytes of memory.
1da177e4 544
ef56e622
SH
545tcp_max_tw_buckets - INTEGER
546 Maximal number of timewait sockets held by system simultaneously.
547 If this number is exceeded time-wait socket is immediately destroyed
548 and warning is printed. This limit exists only to prevent
549 simple DoS attacks, you _must_ not lower the limit artificially,
550 but rather increase it (probably, after increasing installed memory),
551 if network conditions require more than default value.
1da177e4 552
ef56e622
SH
553tcp_mem - vector of 3 INTEGERs: min, pressure, max
554 min: below this number of pages TCP is not bothered about its
555 memory appetite.
1da177e4 556
ef56e622
SH
557 pressure: when amount of memory allocated by TCP exceeds this number
558 of pages, TCP moderates its memory consumption and enters memory
559 pressure mode, which is exited when memory consumption falls
560 under "min".
1da177e4 561
ef56e622 562 max: number of pages allowed for queueing by all TCP sockets.
1da177e4 563
ef56e622
SH
564 Defaults are calculated at boot time from amount of available
565 memory.
1da177e4 566
f6722583
YC
567tcp_min_rtt_wlen - INTEGER
568 The window length of the windowed min filter to track the minimum RTT.
569 A shorter window lets a flow more quickly pick up new (higher)
570 minimum RTT when it is moved to a longer path (e.g., due to traffic
571 engineering). A longer window makes the filter more resistant to RTT
572 inflations such as transient congestion. The unit is seconds.
1cec2cac 573
19fad20d 574 Possible values: 0 - 86400 (1 day)
1cec2cac 575
f6722583
YC
576 Default: 300
577
71599cd1 578tcp_moderate_rcvbuf - BOOLEAN
4edc2f34 579 If set, TCP performs receive buffer auto-tuning, attempting to
71599cd1
JH
580 automatically size the buffer (no greater than tcp_rmem[2]) to
581 match the size required by the path for full throughput. Enabled by
582 default.
583
584tcp_mtu_probing - INTEGER
585 Controls TCP Packetization-Layer Path MTU Discovery. Takes three
586 values:
1cec2cac
MCC
587
588 - 0 - Disabled
589 - 1 - Disabled by default, enabled when an ICMP black hole detected
590 - 2 - Always enabled, use initial MSS of tcp_base_mss.
71599cd1 591
d4ce5808 592tcp_probe_interval - UNSIGNED INTEGER
fab42760
FD
593 Controls how often to start TCP Packetization-Layer Path MTU
594 Discovery reprobe. The default is reprobing every 10 minutes as
595 per RFC4821.
596
597tcp_probe_threshold - INTEGER
598 Controls when TCP Packetization-Layer Path MTU Discovery probing
599 will stop in respect to the width of search range in bytes. Default
600 is 8 bytes.
601
71599cd1
JH
602tcp_no_metrics_save - BOOLEAN
603 By default, TCP saves various connection metrics in the route cache
604 when the connection closes, so that connections established in the
605 near future can use these to set initial conditions. Usually, this
606 increases overall performance, but may sometimes cause performance
0f035b8e 607 degradation. If set, TCP will not cache metrics on closing
71599cd1
JH
608 connections.
609
65e6d901
KYY
610tcp_no_ssthresh_metrics_save - BOOLEAN
611 Controls whether TCP saves ssthresh metrics in the route cache.
1cec2cac 612
65e6d901
KYY
613 Default is 1, which disables ssthresh metrics.
614
ef56e622 615tcp_orphan_retries - INTEGER
5d789229
DL
616 This value influences the timeout of a locally closed TCP connection,
617 when RTO retransmissions remain unacknowledged.
618 See tcp_retries2 for more details.
619
06b8fc5d 620 The default value is 8.
1cec2cac 621
5d789229 622 If your machine is a loaded WEB server,
ef56e622
SH
623 you should think about lowering this value, such sockets
624 may consume significant resources. Cf. tcp_max_orphans.
1da177e4 625
4f41b1c5
YC
626tcp_recovery - INTEGER
627 This value is a bitmap to enable various experimental loss recovery
628 features.
629
1cec2cac
MCC
630 ========= =============================================================
631 RACK: 0x1 enables the RACK loss detection for fast detection of lost
632 retransmissions and tail drops. It also subsumes and disables
633 RFC6675 recovery for SACK connections.
634
635 RACK: 0x2 makes RACK's reordering window static (min_rtt/4).
636
637 RACK: 0x4 disables RACK's DUPACK threshold heuristic
638 ========= =============================================================
4f41b1c5
YC
639
640 Default: 0x1
641
1c7249e4
GN
642tcp_reflect_tos - BOOLEAN
643 For listening sockets, reuse the DSCP value of the initial SYN message
644 for outgoing packets. This allows to have both directions of a TCP
645 stream to use the same DSCP value, assuming DSCP remains unchanged for
646 the lifetime of the connection.
647
648 This options affects both IPv4 and IPv6.
649
650 Default: 0 (disabled)
651
1da177e4 652tcp_reordering - INTEGER
dca145ff
ED
653 Initial reordering level of packets in a TCP stream.
654 TCP stack can then dynamically adjust flow reordering level
655 between this initial value and tcp_max_reordering
1cec2cac 656
e18f5feb 657 Default: 3
1da177e4 658
dca145ff
ED
659tcp_max_reordering - INTEGER
660 Maximal reordering level of packets in a TCP stream.
661 300 is a fairly conservative value, but you might increase it
662 if paths are using per packet load balancing (like bonding rr mode)
1cec2cac 663
dca145ff
ED
664 Default: 300
665
1da177e4
LT
666tcp_retrans_collapse - BOOLEAN
667 Bug-to-bug compatibility with some broken printers.
668 On retransmit try to send bigger packets to work around bugs in
669 certain TCP stacks.
670
ef56e622 671tcp_retries1 - INTEGER
5d789229
DL
672 This value influences the time, after which TCP decides, that
673 something is wrong due to unacknowledged RTO retransmissions,
674 and reports this suspicion to the network layer.
675 See tcp_retries2 for more details.
676
677 RFC 1122 recommends at least 3 retransmissions, which is the
678 default.
1da177e4 679
ef56e622 680tcp_retries2 - INTEGER
5d789229
DL
681 This value influences the timeout of an alive TCP connection,
682 when RTO retransmissions remain unacknowledged.
683 Given a value of N, a hypothetical TCP connection following
684 exponential backoff with an initial RTO of TCP_RTO_MIN would
685 retransmit N times before killing the connection at the (N+1)th RTO.
686
687 The default value of 15 yields a hypothetical timeout of 924.6
688 seconds and is a lower bound for the effective timeout.
689 TCP will effectively time out at the first RTO which exceeds the
690 hypothetical timeout.
691
692 RFC 1122 recommends at least 100 seconds for the timeout,
693 which corresponds to a value of at least 8.
1da177e4 694
ef56e622
SH
695tcp_rfc1337 - BOOLEAN
696 If set, the TCP stack behaves conforming to RFC1337. If unset,
697 we are not conforming to RFC, but prevent TCP TIME_WAIT
698 assassination.
1cec2cac 699
ef56e622 700 Default: 0
1da177e4
LT
701
702tcp_rmem - vector of 3 INTEGERs: min, default, max
703 min: Minimal size of receive buffer used by TCP sockets.
704 It is guaranteed to each TCP socket, even under moderate memory
705 pressure.
1cec2cac 706
a61a86f8 707 Default: 4K
1da177e4 708
53025f5e 709 default: initial size of receive buffer used by TCP sockets.
1da177e4 710 This value overrides net.core.rmem_default used by other protocols.
1d1be912
ED
711 Default: 131072 bytes.
712 This value results in initial window of 65535.
1da177e4
LT
713
714 max: maximal size of receive buffer allowed for automatically
715 selected receiver buffers for TCP socket. This value does not override
53025f5e
BF
716 net.core.rmem_max. Calling setsockopt() with SO_RCVBUF disables
717 automatic tuning of that socket's receive buffer size, in which
718 case this value is ignored.
1d1be912 719 Default: between 131072 and 6MB, depending on RAM size.
1da177e4 720
ef56e622
SH
721tcp_sack - BOOLEAN
722 Enable select acknowledgments (SACKS).
1da177e4 723
6d82aa24
ED
724tcp_comp_sack_delay_ns - LONG INTEGER
725 TCP tries to reduce number of SACK sent, using a timer
726 based on 5% of SRTT, capped by this sysctl, in nano seconds.
727 The default is 1ms, based on TSO autosizing period.
728
729 Default : 1,000,000 ns (1 ms)
730
a70437cc
ED
731tcp_comp_sack_slack_ns - LONG INTEGER
732 This sysctl control the slack used when arming the
733 timer used by SACK compression. This gives extra time
734 for small RTT flows, and reduces system overhead by allowing
735 opportunistic reduction of timer interrupts.
736
737 Default : 100,000 ns (100 us)
738
9c21d2fc 739tcp_comp_sack_nr - INTEGER
2bcd9d84 740 Max number of SACK that can be compressed.
9c21d2fc
ED
741 Using 0 disables SACK compression.
742
2bcd9d84 743 Default : 44
9c21d2fc 744
ef56e622
SH
745tcp_slow_start_after_idle - BOOLEAN
746 If set, provide RFC2861 behavior and time out the congestion
747 window after an idle period. An idle period is defined at
748 the current RTO. If unset, the congestion window will not
749 be timed out after an idle period.
1cec2cac 750
ef56e622 751 Default: 1
1da177e4 752
ef56e622 753tcp_stdurg - BOOLEAN
4edc2f34 754 Use the Host requirements interpretation of the TCP urgent pointer field.
ef56e622
SH
755 Most hosts use the older BSD interpretation, so if you turn this on
756 Linux might not communicate correctly with them.
1cec2cac 757
ef56e622 758 Default: FALSE
1da177e4 759
ef56e622
SH
760tcp_synack_retries - INTEGER
761 Number of times SYNACKs for a passive TCP connection attempt will
762 be retransmitted. Should not be higher than 255. Default value
6c9ff979
AB
763 is 5, which corresponds to 31seconds till the last retransmission
764 with the current initial RTO of 1second. With this the final timeout
765 for a passive TCP connection will happen after 63seconds.
1da177e4 766
d8513df2 767tcp_syncookies - INTEGER
a3c910d2 768 Only valid when the kernel was compiled with CONFIG_SYN_COOKIES
ef56e622 769 Send out syncookies when the syn backlog queue of a socket
4edc2f34 770 overflows. This is to prevent against the common 'SYN flood attack'
a3c910d2 771 Default: 1
1da177e4 772
ef56e622
SH
773 Note, that syncookies is fallback facility.
774 It MUST NOT be used to help highly loaded servers to stand
4edc2f34 775 against legal connection rate. If you see SYN flood warnings
ef56e622
SH
776 in your logs, but investigation shows that they occur
777 because of overload with legal connections, you should tune
778 another parameters until this warning disappear.
779 See: tcp_max_syn_backlog, tcp_synack_retries, tcp_abort_on_overflow.
1da177e4 780
ef56e622
SH
781 syncookies seriously violate TCP protocol, do not allow
782 to use TCP extensions, can result in serious degradation
783 of some services (f.e. SMTP relaying), visible not by you,
784 but your clients and relays, contacting you. While you see
4edc2f34 785 SYN flood warnings in logs not being really flooded, your server
ef56e622 786 is seriously misconfigured.
1da177e4 787
5ad37d5d
HFS
788 If you want to test which effects syncookies have to your
789 network connections you can set this knob to 2 to enable
790 unconditionally generation of syncookies.
791
f9ac779f
KI
792tcp_migrate_req - BOOLEAN
793 The incoming connection is tied to a specific listening socket when
794 the initial SYN packet is received during the three-way handshake.
795 When a listener is closed, in-flight request sockets during the
796 handshake and established sockets in the accept queue are aborted.
797
798 If the listener has SO_REUSEPORT enabled, other listeners on the
799 same port should have been able to accept such connections. This
800 option makes it possible to migrate such child sockets to another
801 listener after close() or shutdown().
802
803 The BPF_SK_REUSEPORT_SELECT_OR_MIGRATE type of eBPF program should
804 usually be used to define the policy to pick an alive listener.
805 Otherwise, the kernel will randomly pick an alive listener only if
806 this option is enabled.
807
808 Note that migration between listeners with different settings may
809 crash applications. Let's say migration happens from listener A to
810 B, and only B has TCP_SAVE_SYN enabled. B cannot read SYN data from
811 the requests migrated from A. To avoid such a situation, cancel
812 migration by returning SK_DROP in the type of eBPF program, or
813 disable this option.
814
815 Default: 0
816
cf60af03 817tcp_fastopen - INTEGER
cebc5cba
YC
818 Enable TCP Fast Open (RFC7413) to send and accept data in the opening
819 SYN packet.
10467163 820
cebc5cba
YC
821 The client support is enabled by flag 0x1 (on by default). The client
822 then must use sendmsg() or sendto() with the MSG_FASTOPEN flag,
823 rather than connect() to send data in SYN.
cf60af03 824
cebc5cba
YC
825 The server support is enabled by flag 0x2 (off by default). Then
826 either enable for all listeners with another flag (0x400) or
827 enable individual listeners via TCP_FASTOPEN socket option with
828 the option value being the length of the syn-data backlog.
cf60af03 829
cebc5cba 830 The values (bitmap) are
1cec2cac
MCC
831
832 ===== ======== ======================================================
833 0x1 (client) enables sending data in the opening SYN on the client.
834 0x2 (server) enables the server support, i.e., allowing data in
cebc5cba
YC
835 a SYN packet to be accepted and passed to the
836 application before 3-way handshake finishes.
1cec2cac 837 0x4 (client) send data in the opening SYN regardless of cookie
cebc5cba 838 availability and without a cookie option.
1cec2cac
MCC
839 0x200 (server) accept data-in-SYN w/o any cookie option present.
840 0x400 (server) enable all listeners to support Fast Open by
cebc5cba 841 default without explicit TCP_FASTOPEN socket option.
1cec2cac 842 ===== ======== ======================================================
cebc5cba
YC
843
844 Default: 0x1
10467163 845
a7db3c76 846 Note that additional client or server features are only
cebc5cba 847 effective if the basic support (0x1 and 0x2) are enabled respectively.
10467163 848
cf1ef3f0
WW
849tcp_fastopen_blackhole_timeout_sec - INTEGER
850 Initial time period in second to disable Fastopen on active TCP sockets
851 when a TFO firewall blackhole issue happens.
852 This time period will grow exponentially when more blackhole issues
853 get detected right after Fastopen is re-enabled and will reset to
854 initial value when the blackhole issue goes away.
7268586b 855 0 to disable the blackhole detection.
1cec2cac 856
213ad73d 857 By default, it is set to 0 (feature is disabled).
cf1ef3f0 858
2dc7e48d
JB
859tcp_fastopen_key - list of comma separated 32-digit hexadecimal INTEGERs
860 The list consists of a primary key and an optional backup key. The
861 primary key is used for both creating and validating cookies, while the
862 optional backup key is only used for validating cookies. The purpose of
863 the backup key is to maximize TFO validation when keys are rotated.
864
865 A randomly chosen primary key may be configured by the kernel if
866 the tcp_fastopen sysctl is set to 0x400 (see above), or if the
867 TCP_FASTOPEN setsockopt() optname is set and a key has not been
868 previously configured via sysctl. If keys are configured via
869 setsockopt() by using the TCP_FASTOPEN_KEY optname, then those
870 per-socket keys will be used instead of any keys that are specified via
871 sysctl.
872
873 A key is specified as 4 8-digit hexadecimal integers which are separated
874 by a '-' as: xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx. Leading zeros may be
875 omitted. A primary and a backup key may be specified by separating them
876 by a comma. If only one key is specified, it becomes the primary key and
877 any previously configured backup keys are removed.
878
ef56e622
SH
879tcp_syn_retries - INTEGER
880 Number of times initial SYNs for an active TCP connection attempt
bffae697 881 will be retransmitted. Should not be higher than 127. Default value
3b09adcb 882 is 6, which corresponds to 63seconds till the last retransmission
6c9ff979
AB
883 with the current initial RTO of 1second. With this the final timeout
884 for an active TCP connection attempt will happen after 127seconds.
ef56e622 885
25429d7b 886tcp_timestamps - INTEGER
1cec2cac
MCC
887 Enable timestamps as defined in RFC1323.
888
889 - 0: Disabled.
890 - 1: Enable timestamps as defined in RFC1323 and use random offset for
891 each connection rather than only using the current time.
892 - 2: Like 1, but without random offsets.
893
25429d7b 894 Default: 1
1da177e4 895
95bd09eb
ED
896tcp_min_tso_segs - INTEGER
897 Minimal number of segments per TSO frame.
1cec2cac 898
95bd09eb
ED
899 Since linux-3.12, TCP does an automatic sizing of TSO frames,
900 depending on flow rate, instead of filling 64Kbytes packets.
901 For specific usages, it's possible to force TCP to build big
902 TSO frames. Note that TCP stack might split too big TSO packets
903 if available window is too small.
1cec2cac 904
95bd09eb
ED
905 Default: 2
906
65466904
ED
907tcp_tso_rtt_log - INTEGER
908 Adjustment of TSO packet sizes based on min_rtt
909
910 Starting from linux-5.18, TCP autosizing can be tweaked
911 for flows having small RTT.
912
913 Old autosizing was splitting the pacing budget to send 1024 TSO
914 per second.
915
916 tso_packet_size = sk->sk_pacing_rate / 1024;
917
918 With the new mechanism, we increase this TSO sizing using:
919
920 distance = min_rtt_usec / (2^tcp_tso_rtt_log)
921 tso_packet_size += gso_max_size >> distance;
922
923 This means that flows between very close hosts can use bigger
924 TSO packets, reducing their cpu costs.
925
926 If you want to use the old autosizing, set this sysctl to 0.
927
928 Default: 9 (2^9 = 512 usec)
929
43e122b0
ED
930tcp_pacing_ss_ratio - INTEGER
931 sk->sk_pacing_rate is set by TCP stack using a ratio applied
932 to current rate. (current_rate = cwnd * mss / srtt)
933 If TCP is in slow start, tcp_pacing_ss_ratio is applied
934 to let TCP probe for bigger speeds, assuming cwnd can be
935 doubled every other RTT.
1cec2cac 936
43e122b0
ED
937 Default: 200
938
939tcp_pacing_ca_ratio - INTEGER
940 sk->sk_pacing_rate is set by TCP stack using a ratio applied
941 to current rate. (current_rate = cwnd * mss / srtt)
942 If TCP is in congestion avoidance phase, tcp_pacing_ca_ratio
943 is applied to conservatively probe for bigger throughput.
1cec2cac 944
43e122b0
ED
945 Default: 120
946
1da177e4 947tcp_tso_win_divisor - INTEGER
ef56e622
SH
948 This allows control over what percentage of the congestion window
949 can be consumed by a single TSO frame.
950 The setting of this parameter is a choice between burstiness and
951 building larger TSO frames.
1cec2cac 952
ef56e622 953 Default: 3
1da177e4 954
79e9fed4
955tcp_tw_reuse - INTEGER
956 Enable reuse of TIME-WAIT sockets for new connections when it is
957 safe from protocol viewpoint.
1cec2cac
MCC
958
959 - 0 - disable
960 - 1 - global enable
961 - 2 - enable for loopback traffic only
962
ef56e622
SH
963 It should not be changed without advice/request of technical
964 experts.
1cec2cac 965
79e9fed4 966 Default: 2
ce7bc3bf 967
ef56e622
SH
968tcp_window_scaling - BOOLEAN
969 Enable window scaling as defined in RFC1323.
3ff825b2 970
ef56e622 971tcp_wmem - vector of 3 INTEGERs: min, default, max
53025f5e 972 min: Amount of memory reserved for send buffers for TCP sockets.
ef56e622 973 Each TCP socket has rights to use it due to fact of its birth.
1cec2cac 974
a61a86f8 975 Default: 4K
9d7bcfc6 976
53025f5e
BF
977 default: initial size of send buffer used by TCP sockets. This
978 value overrides net.core.wmem_default used by other protocols.
1cec2cac 979
53025f5e 980 It is usually lower than net.core.wmem_default.
1cec2cac 981
ef56e622
SH
982 Default: 16K
983
53025f5e
BF
984 max: Maximal amount of memory allowed for automatically tuned
985 send buffers for TCP sockets. This value does not override
986 net.core.wmem_max. Calling setsockopt() with SO_SNDBUF disables
987 automatic tuning of that socket's send buffer size, in which case
988 this value is ignored.
1cec2cac 989
53025f5e 990 Default: between 64K and 4MB, depending on RAM size.
1da177e4 991
c9bee3b7
ED
992tcp_notsent_lowat - UNSIGNED INTEGER
993 A TCP socket can control the amount of unsent bytes in its write queue,
994 thanks to TCP_NOTSENT_LOWAT socket option. poll()/select()/epoll()
995 reports POLLOUT events if the amount of unsent bytes is below a per
996 socket value, and if the write queue is not full. sendmsg() will
997 also not add new buffers if the limit is hit.
998
999 This global variable controls the amount of unsent data for
1000 sockets not using TCP_NOTSENT_LOWAT. For these sockets, a change
1001 to the global variable has immediate effect.
1002
1003 Default: UINT_MAX (0xFFFFFFFF)
1004
15d99e02
RJ
1005tcp_workaround_signed_windows - BOOLEAN
1006 If set, assume no receipt of a window scaling option means the
1007 remote TCP is broken and treats the window as a signed quantity.
1008 If unset, assume the remote TCP is not broken even if we do
1009 not receive a window scaling option from them.
1cec2cac 1010
15d99e02
RJ
1011 Default: 0
1012
36e31b0a
AP
1013tcp_thin_linear_timeouts - BOOLEAN
1014 Enable dynamic triggering of linear timeouts for thin streams.
1015 If set, a check is performed upon retransmission by timeout to
1016 determine if the stream is thin (less than 4 packets in flight).
1017 As long as the stream is found to be thin, up to 6 linear
1018 timeouts may be performed before exponential backoff mode is
1019 initiated. This improves retransmission latency for
1020 non-aggressive thin streams, often found to be time-dependent.
1021 For more information on thin streams, see
ff159f4f 1022 Documentation/networking/tcp-thin.rst
1cec2cac 1023
36e31b0a
AP
1024 Default: 0
1025
46d3ceab
ED
1026tcp_limit_output_bytes - INTEGER
1027 Controls TCP Small Queue limit per tcp socket.
1028 TCP bulk sender tends to increase packets in flight until it
1029 gets losses notifications. With SNDBUF autotuning, this can
9c4c3252
FL
1030 result in a large amount of packets queued on the local machine
1031 (e.g.: qdiscs, CPU backlog, or device) hurting latency of other
1032 flows, for typical pfifo_fast qdiscs. tcp_limit_output_bytes
1033 limits the number of bytes on qdisc or device to reduce artificial
1034 RTT/cwnd and reduce bufferbloat.
1cec2cac 1035
c73e5807 1036 Default: 1048576 (16 * 65536)
46d3ceab 1037
282f23c6
ED
1038tcp_challenge_ack_limit - INTEGER
1039 Limits number of Challenge ACK sent per second, as recommended
1040 in RFC 5961 (Improving TCP's Robustness to Blind In-Window Attacks)
79e3602c
ED
1041 Note that this per netns rate limit can allow some side channel
1042 attacks and probably should not be enabled.
1043 TCP stack implements per TCP socket limits anyway.
1044 Default: INT_MAX (unlimited)
282f23c6 1045
d1e5e640
KI
1046tcp_ehash_entries - INTEGER
1047 Show the number of hash buckets for TCP sockets in the current
1048 networking namespace.
1049
1050 A negative value means the networking namespace does not own its
1051 hash buckets and shares the initial networking namespace's one.
1052
1053tcp_child_ehash_entries - INTEGER
1054 Control the number of hash buckets for TCP sockets in the child
1055 networking namespace, which must be set before clone() or unshare().
1056
1057 If the value is not 0, the kernel uses a value rounded up to 2^n
1058 as the actual hash bucket size. 0 is a special value, meaning
1059 the child networking namespace will share the initial networking
1060 namespace's hash buckets.
1061
1062 Note that the child will use the global one in case the kernel
1063 fails to allocate enough memory. In addition, the global hash
1064 buckets are spread over available NUMA nodes, but the allocation
1065 of the child hash table depends on the current process's NUMA
1066 policy, which could result in performance differences.
1067
1068 Note also that the default value of tcp_max_tw_buckets and
1069 tcp_max_syn_backlog depend on the hash bucket size.
1070
1071 Possible values: 0, 2^n (n: 0 - 24 (16Mi))
1072
1073 Default: 0
1074
bd456f28
MAQ
1075tcp_plb_enabled - BOOLEAN
1076 If set and the underlying congestion control (e.g. DCTCP) supports
1077 and enables PLB feature, TCP PLB (Protective Load Balancing) is
1078 enabled. PLB is described in the following paper:
1079 https://doi.org/10.1145/3544216.3544226. Based on PLB parameters,
1080 upon sensing sustained congestion, TCP triggers a change in
1081 flow label field for outgoing IPv6 packets. A change in flow label
1082 field potentially changes the path of outgoing packets for switches
1083 that use ECMP/WCMP for routing.
1084
1085 PLB changes socket txhash which results in a change in IPv6 Flow Label
1086 field, and currently no-op for IPv4 headers. It is possible
1087 to apply PLB for IPv4 with other network header fields (e.g. TCP
1088 or IPv4 options) or using encapsulation where outer header is used
1089 by switches to determine next hop. In either case, further host
1090 and switch side changes will be needed.
1091
1092 When set, PLB assumes that congestion signal (e.g. ECN) is made
1093 available and used by congestion control module to estimate a
1094 congestion measure (e.g. ce_ratio). PLB needs a congestion measure to
1095 make repathing decisions.
1096
1097 Default: FALSE
1098
1099tcp_plb_idle_rehash_rounds - INTEGER
1100 Number of consecutive congested rounds (RTT) seen after which
1101 a rehash can be performed, given there are no packets in flight.
1102 This is referred to as M in PLB paper:
1103 https://doi.org/10.1145/3544216.3544226.
1104
1105 Possible Values: 0 - 31
1106
1107 Default: 3
1108
1109tcp_plb_rehash_rounds - INTEGER
1110 Number of consecutive congested rounds (RTT) seen after which
1111 a forced rehash can be performed. Be careful when setting this
1112 parameter, as a small value increases the risk of retransmissions.
1113 This is referred to as N in PLB paper:
1114 https://doi.org/10.1145/3544216.3544226.
1115
1116 Possible Values: 0 - 31
1117
1118 Default: 12
1119
1120tcp_plb_suspend_rto_sec - INTEGER
1121 Time, in seconds, to suspend PLB in event of an RTO. In order to avoid
1122 having PLB repath onto a connectivity "black hole", after an RTO a TCP
1123 connection suspends PLB repathing for a random duration between 1x and
1124 2x of this parameter. Randomness is added to avoid concurrent rehashing
1125 of multiple TCP connections. This should be set corresponding to the
1126 amount of time it takes to repair a failed link.
1127
1128 Possible Values: 0 - 255
1129
1130 Default: 60
1131
1132tcp_plb_cong_thresh - INTEGER
1133 Fraction of packets marked with congestion over a round (RTT) to
1134 tag that round as congested. This is referred to as K in the PLB paper:
1135 https://doi.org/10.1145/3544216.3544226.
1136
1137 The 0-1 fraction range is mapped to 0-256 range to avoid floating
1138 point operations. For example, 128 means that if at least 50% of
1139 the packets in a round were marked as congested then the round
1140 will be tagged as congested.
1141
1142 Setting threshold to 0 means that PLB repaths every RTT regardless
1143 of congestion. This is not intended behavior for PLB and should be
1144 used only for experimentation purpose.
1145
1146 Possible Values: 0 - 256
1147
1148 Default: 128
1149
1cec2cac
MCC
1150UDP variables
1151=============
95766fff 1152
63a6fff3
RS
1153udp_l3mdev_accept - BOOLEAN
1154 Enabling this option allows a "global" bound socket to work
1155 across L3 master domains (e.g., VRFs) with packets capable of
1156 being received regardless of the L3 domain in which they
1157 originated. Only valid when the kernel was compiled with
1158 CONFIG_NET_L3_MASTER_DEV.
1cec2cac
MCC
1159
1160 Default: 0 (disabled)
63a6fff3 1161
95766fff
HA
1162udp_mem - vector of 3 INTEGERs: min, pressure, max
1163 Number of pages allowed for queueing by all UDP sockets.
1164
69dfccbc 1165 min: Number of pages allowed for queueing by all UDP sockets.
95766fff
HA
1166
1167 pressure: This value was introduced to follow format of tcp_mem.
1168
69dfccbc 1169 max: This value was introduced to follow format of tcp_mem.
95766fff
HA
1170
1171 Default is calculated at boot time from amount of available memory.
1172
1173udp_rmem_min - INTEGER
1174 Minimal size of receive buffer used by UDP sockets in moderation.
1175 Each UDP socket is able to use the size for receiving data, even if
1176 total pages of UDP sockets exceed udp_mem pressure. The unit is byte.
1cec2cac 1177
320bd6de 1178 Default: 4K
95766fff
HA
1179
1180udp_wmem_min - INTEGER
c6b10de5 1181 UDP does not have tx memory accounting and this tunable has no effect.
95766fff 1182
9804985b
KI
1183udp_hash_entries - INTEGER
1184 Show the number of hash buckets for UDP sockets in the current
1185 networking namespace.
1186
1187 A negative value means the networking namespace does not own its
1188 hash buckets and shares the initial networking namespace's one.
1189
1190udp_child_ehash_entries - INTEGER
1191 Control the number of hash buckets for UDP sockets in the child
1192 networking namespace, which must be set before clone() or unshare().
1193
1194 If the value is not 0, the kernel uses a value rounded up to 2^n
1195 as the actual hash bucket size. 0 is a special value, meaning
1196 the child networking namespace will share the initial networking
1197 namespace's hash buckets.
1198
1199 Note that the child will use the global one in case the kernel
1200 fails to allocate enough memory. In addition, the global hash
1201 buckets are spread over available NUMA nodes, but the allocation
1202 of the child hash table depends on the current process's NUMA
1203 policy, which could result in performance differences.
1204
1205 Possible values: 0, 2^n (n: 7 (128) - 16 (64K))
1206
1207 Default: 0
1208
1209
1cec2cac
MCC
1210RAW variables
1211=============
6897445f
MM
1212
1213raw_l3mdev_accept - BOOLEAN
1214 Enabling this option allows a "global" bound socket to work
1215 across L3 master domains (e.g., VRFs) with packets capable of
1216 being received regardless of the L3 domain in which they
1217 originated. Only valid when the kernel was compiled with
1218 CONFIG_NET_L3_MASTER_DEV.
1cec2cac 1219
6897445f
MM
1220 Default: 1 (enabled)
1221
1cec2cac
MCC
1222CIPSOv4 Variables
1223=================
8802f616
PM
1224
1225cipso_cache_enable - BOOLEAN
1226 If set, enable additions to and lookups from the CIPSO label mapping
1227 cache. If unset, additions are ignored and lookups always result in a
1228 miss. However, regardless of the setting the cache is still
1229 invalidated when required when means you can safely toggle this on and
1230 off and the cache will always be "safe".
1cec2cac 1231
8802f616
PM
1232 Default: 1
1233
1234cipso_cache_bucket_size - INTEGER
1235 The CIPSO label cache consists of a fixed size hash table with each
1236 hash bucket containing a number of cache entries. This variable limits
dd44f04b 1237 the number of entries in each hash bucket; the larger the value is, the
8802f616
PM
1238 more CIPSO label mappings that can be cached. When the number of
1239 entries in a given hash bucket reaches this limit adding new entries
1240 causes the oldest entry in the bucket to be removed to make room.
1cec2cac 1241
8802f616
PM
1242 Default: 10
1243
1244cipso_rbm_optfmt - BOOLEAN
1245 Enable the "Optimized Tag 1 Format" as defined in section 3.4.2.6 of
1246 the CIPSO draft specification (see Documentation/netlabel for details).
1247 This means that when set the CIPSO tag will be padded with empty
1248 categories in order to make the packet data 32-bit aligned.
1cec2cac 1249
8802f616
PM
1250 Default: 0
1251
1252cipso_rbm_structvalid - BOOLEAN
1253 If set, do a very strict check of the CIPSO option when
1254 ip_options_compile() is called. If unset, relax the checks done during
1255 ip_options_compile(). Either way is "safe" as errors are caught else
1256 where in the CIPSO processing code but setting this to 0 (False) should
1257 result in less work (i.e. it should be faster) but could cause problems
1258 with other implementations that require strict checking.
1cec2cac 1259
8802f616
PM
1260 Default: 0
1261
1cec2cac
MCC
1262IP Variables
1263============
1da177e4
LT
1264
1265ip_local_port_range - 2 INTEGERS
1266 Defines the local port range that is used by TCP and UDP to
e18f5feb 1267 choose the local port. The first number is the first, the
07f4c900 1268 second the last local port number.
ac71676c
1269 If possible, it is better these numbers have different parity
1270 (one even and one odd value).
1271 Must be greater than or equal to ip_unprivileged_port_start.
07f4c900 1272 The default values are 32768 and 60999 respectively.
1da177e4 1273
e3826f1e
AW
1274ip_local_reserved_ports - list of comma separated ranges
1275 Specify the ports which are reserved for known third-party
1276 applications. These ports will not be used by automatic port
1277 assignments (e.g. when calling connect() or bind() with port
1278 number 0). Explicit port allocation behavior is unchanged.
1279
1280 The format used for both input and output is a comma separated
1281 list of ranges (e.g. "1,2-4,10-10" for ports 1, 2, 3, 4 and
1282 10). Writing to the file will clear all previously reserved
1283 ports and update the current list with the one given in the
1284 input.
1285
1286 Note that ip_local_port_range and ip_local_reserved_ports
1287 settings are independent and both are considered by the kernel
1288 when determining which ports are available for automatic port
1289 assignments.
1290
1291 You can reserve ports which are not in the current
1cec2cac 1292 ip_local_port_range, e.g.::
e3826f1e 1293
1cec2cac
MCC
1294 $ cat /proc/sys/net/ipv4/ip_local_port_range
1295 32000 60999
1296 $ cat /proc/sys/net/ipv4/ip_local_reserved_ports
1297 8080,9148
e3826f1e
AW
1298
1299 although this is redundant. However such a setting is useful
1300 if later the port range is changed to a value that will
a7a80b17
OH
1301 include the reserved ports. Also keep in mind, that overlapping
1302 of these ranges may affect probability of selecting ephemeral
1303 ports which are right after block of reserved ports.
e3826f1e
AW
1304
1305 Default: Empty
1306
4548b683
KJ
1307ip_unprivileged_port_start - INTEGER
1308 This is a per-namespace sysctl. It defines the first
1309 unprivileged port in the network namespace. Privileged ports
1310 require root or CAP_NET_BIND_SERVICE in order to bind to them.
ac71676c
1311 To disable all privileged ports, set this to 0. They must not
1312 overlap with the ip_local_port_range.
4548b683
KJ
1313
1314 Default: 1024
1315
1da177e4
LT
1316ip_nonlocal_bind - BOOLEAN
1317 If set, allows processes to bind() to non-local IP addresses,
1318 which can be quite useful - but may break some applications.
1cec2cac 1319
1da177e4
LT
1320 Default: 0
1321
4b01a967
KI
1322ip_autobind_reuse - BOOLEAN
1323 By default, bind() does not select the ports automatically even if
1324 the new socket and all sockets bound to the port have SO_REUSEADDR.
1325 ip_autobind_reuse allows bind() to reuse the port and this is useful
1326 when you use bind()+connect(), but may break some applications.
1327 The preferred solution is to use IP_BIND_ADDRESS_NO_PORT and this
1328 option should only be set by experts.
1329 Default: 0
1330
e49e4aff 1331ip_dynaddr - INTEGER
1da177e4
LT
1332 If set non-zero, enables support for dynamic addresses.
1333 If set to a non-zero value larger than 1, a kernel log
1334 message will be printed when dynamic address rewriting
1335 occurs.
1cec2cac 1336
1da177e4
LT
1337 Default: 0
1338
e3d73bce
CW
1339ip_early_demux - BOOLEAN
1340 Optimize input packet processing down to one demux for
1341 certain kinds of local sockets. Currently we only do this
dddb64bc 1342 for established TCP and connected UDP sockets.
e3d73bce
CW
1343
1344 It may add an additional cost for pure routing workloads that
1345 reduces overall throughput, in such case you should disable it.
1cec2cac 1346
e3d73bce
CW
1347 Default: 1
1348
5cc4adbc
SH
1349ping_group_range - 2 INTEGERS
1350 Restrict ICMP_PROTO datagram sockets to users in the group range.
1351 The default is "1 0", meaning, that nobody (not even root) may
1352 create ping sockets. Setting it to "100 100" would grant permissions
1353 to the single group. "0 4294967295" would enable it for the world, "100
1354 4294967295" would enable it for the users, but not daemons.
1355
dddb64bc 1356tcp_early_demux - BOOLEAN
1357 Enable early demux for established TCP sockets.
1cec2cac 1358
dddb64bc 1359 Default: 1
1360
1361udp_early_demux - BOOLEAN
1362 Enable early demux for connected UDP sockets. Disable this if
1363 your system could experience more unconnected load.
1cec2cac 1364
dddb64bc 1365 Default: 1
1366
1da177e4 1367icmp_echo_ignore_all - BOOLEAN
7ce31246
DM
1368 If set non-zero, then the kernel will ignore all ICMP ECHO
1369 requests sent to it.
1cec2cac 1370
7ce31246
DM
1371 Default: 0
1372
f1b8fa9f
AR
1373icmp_echo_enable_probe - BOOLEAN
1374 If set to one, then the kernel will respond to RFC 8335 PROBE
1375 requests sent to it.
1376
1377 Default: 0
1378
1da177e4 1379icmp_echo_ignore_broadcasts - BOOLEAN
7ce31246
DM
1380 If set non-zero, then the kernel will ignore all ICMP ECHO and
1381 TIMESTAMP requests sent to it via broadcast/multicast.
1cec2cac 1382
7ce31246 1383 Default: 1
1da177e4
LT
1384
1385icmp_ratelimit - INTEGER
1386 Limit the maximal rates for sending ICMP packets whose type matches
1387 icmp_ratemask (see below) to specific targets.
6dbf4bca
SH
1388 0 to disable any limiting,
1389 otherwise the minimal space between responses in milliseconds.
4cdf507d
ED
1390 Note that another sysctl, icmp_msgs_per_sec limits the number
1391 of ICMP packets sent on all targets.
1cec2cac 1392
6dbf4bca 1393 Default: 1000
1da177e4 1394
4cdf507d
ED
1395icmp_msgs_per_sec - INTEGER
1396 Limit maximal number of ICMP packets sent per second from this host.
1397 Only messages whose type matches icmp_ratemask (see below) are
b38e7819
ED
1398 controlled by this limit. For security reasons, the precise count
1399 of messages per second is randomized.
1cec2cac 1400
6dbf4bca 1401 Default: 1000
1da177e4 1402
4cdf507d
ED
1403icmp_msgs_burst - INTEGER
1404 icmp_msgs_per_sec controls number of ICMP packets sent per second,
1405 while icmp_msgs_burst controls the burst size of these packets.
b38e7819 1406 For security reasons, the precise burst size is randomized.
1cec2cac 1407
4cdf507d
ED
1408 Default: 50
1409
1da177e4
LT
1410icmp_ratemask - INTEGER
1411 Mask made of ICMP types for which rates are being limited.
1cec2cac 1412
1da177e4 1413 Significant bits: IHGFEDCBA9876543210
1cec2cac 1414
1da177e4
LT
1415 Default mask: 0000001100000011000 (6168)
1416
1417 Bit definitions (see include/linux/icmp.h):
1cec2cac
MCC
1418
1419 = =========================
1da177e4 1420 0 Echo Reply
1cec2cac
MCC
1421 3 Destination Unreachable [1]_
1422 4 Source Quench [1]_
1da177e4
LT
1423 5 Redirect
1424 8 Echo Request
1cec2cac
MCC
1425 B Time Exceeded [1]_
1426 C Parameter Problem [1]_
1da177e4
LT
1427 D Timestamp Request
1428 E Timestamp Reply
1429 F Info Request
1430 G Info Reply
1431 H Address Mask Request
1432 I Address Mask Reply
1cec2cac 1433 = =========================
1da177e4 1434
1cec2cac 1435 .. [1] These are rate limited by default (see default mask above)
1da177e4
LT
1436
1437icmp_ignore_bogus_error_responses - BOOLEAN
1438 Some routers violate RFC1122 by sending bogus responses to broadcast
1439 frames. Such violations are normally logged via a kernel warning.
1440 If this is set to TRUE, the kernel will not give such warnings, which
1441 will avoid log file clutter.
1cec2cac 1442
e8b265e8 1443 Default: 1
1da177e4 1444
95f7daf1
H
1445icmp_errors_use_inbound_ifaddr - BOOLEAN
1446
02a6d613
PA
1447 If zero, icmp error messages are sent with the primary address of
1448 the exiting interface.
e18f5feb 1449
95f7daf1
H
1450 If non-zero, the message will be sent with the primary address of
1451 the interface that received the packet that caused the icmp error.
31628201 1452 This is the behaviour many network administrators will expect from
95f7daf1 1453 a router. And it can make debugging complicated network layouts
e18f5feb 1454 much easier.
95f7daf1
H
1455
1456 Note that if no primary address exists for the interface selected,
1457 then the primary address of the first non-loopback interface that
d6bc8ac9 1458 has one will be used regardless of this setting.
95f7daf1
H
1459
1460 Default: 0
1461
1da177e4
LT
1462igmp_max_memberships - INTEGER
1463 Change the maximum number of multicast groups we can subscribe to.
1464 Default: 20
1465
d67ef35f
JE
1466 Theoretical maximum value is bounded by having to send a membership
1467 report in a single datagram (i.e. the report can't span multiple
1468 datagrams, or risk confusing the switch and leaving groups you don't
1469 intend to).
1da177e4 1470
d67ef35f
JE
1471 The number of supported groups 'M' is bounded by the number of group
1472 report entries you can fit into a single datagram of 65535 bytes.
1473
1474 M = 65536-sizeof (ip header)/(sizeof(Group record))
1475
1476 Group records are variable length, with a minimum of 12 bytes.
1477 So net.ipv4.igmp_max_memberships should not be set higher than:
1478
1479 (65536-24) / 12 = 5459
1480
1481 The value 5459 assumes no IP header options, so in practice
1482 this number may be lower.
1483
537377d3
BP
1484igmp_max_msf - INTEGER
1485 Maximum number of addresses allowed in the source filter list for a
1486 multicast group.
1cec2cac 1487
537377d3
BP
1488 Default: 10
1489
a9fe8e29 1490igmp_qrv - INTEGER
537377d3 1491 Controls the IGMP query robustness variable (see RFC2236 8.1).
1cec2cac 1492
537377d3 1493 Default: 2 (as specified by RFC2236 8.1)
1cec2cac 1494
537377d3 1495 Minimum: 1 (as specified by RFC6636 4.5)
a9fe8e29 1496
1af92836 1497force_igmp_version - INTEGER
1cec2cac
MCC
1498 - 0 - (default) No enforcement of a IGMP version, IGMPv1/v2 fallback
1499 allowed. Will back to IGMPv3 mode again if all IGMPv1/v2 Querier
1500 Present timer expires.
1501 - 1 - Enforce to use IGMP version 1. Will also reply IGMPv1 report if
1502 receive IGMPv2/v3 query.
1503 - 2 - Enforce to use IGMP version 2. Will fallback to IGMPv1 if receive
1504 IGMPv1 query message. Will reply report if receive IGMPv3 query.
1505 - 3 - Enforce to use IGMP version 3. The same react with default 0.
1506
1507 .. note::
1af92836 1508
1cec2cac
MCC
1509 this is not the same with force_mld_version because IGMPv3 RFC3376
1510 Security Considerations does not have clear description that we could
1511 ignore other version messages completely as MLDv2 RFC3810. So make
1512 this value as default 0 is recommended.
1af92836 1513
1cec2cac
MCC
1514``conf/interface/*``
1515 changes special settings per interface (where
1516 interface" is the name of your network interface)
6b226e2f 1517
1cec2cac
MCC
1518``conf/all/*``
1519 is special, changes the settings for all interfaces
6b226e2f 1520
1da177e4
LT
1521log_martians - BOOLEAN
1522 Log packets with impossible addresses to kernel log.
1523 log_martians for the interface will be enabled if at least one of
1524 conf/{all,interface}/log_martians is set to TRUE,
1525 it will be disabled otherwise
1526
1527accept_redirects - BOOLEAN
1528 Accept ICMP redirect messages.
1529 accept_redirects for the interface will be enabled if:
1cec2cac 1530
e18f5feb
JDB
1531 - both conf/{all,interface}/accept_redirects are TRUE in the case
1532 forwarding for the interface is enabled
1cec2cac 1533
1da177e4 1534 or
1cec2cac 1535
e18f5feb
JDB
1536 - at least one of conf/{all,interface}/accept_redirects is TRUE in the
1537 case forwarding for the interface is disabled
1cec2cac 1538
1da177e4 1539 accept_redirects for the interface will be disabled otherwise
1cec2cac
MCC
1540
1541 default:
1542
1543 - TRUE (host)
1544 - FALSE (router)
1da177e4
LT
1545
1546forwarding - BOOLEAN
88a7cddc
NJ
1547 Enable IP forwarding on this interface. This controls whether packets
1548 received _on_ this interface can be forwarded.
1da177e4
LT
1549
1550mc_forwarding - BOOLEAN
1551 Do multicast routing. The kernel needs to be compiled with CONFIG_MROUTE
1552 and a multicast routing daemon is required.
e18f5feb
JDB
1553 conf/all/mc_forwarding must also be set to TRUE to enable multicast
1554 routing for the interface
1da177e4
LT
1555
1556medium_id - INTEGER
1557 Integer value used to differentiate the devices by the medium they
1558 are attached to. Two devices can have different id values when
1559 the broadcast packets are received only on one of them.
1560 The default value 0 means that the device is the only interface
1561 to its medium, value of -1 means that medium is not known.
e18f5feb 1562
1da177e4
LT
1563 Currently, it is used to change the proxy_arp behavior:
1564 the proxy_arp feature is enabled for packets forwarded between
1565 two devices attached to different media.
1566
1567proxy_arp - BOOLEAN
1568 Do proxy arp.
1cec2cac 1569
1da177e4
LT
1570 proxy_arp for the interface will be enabled if at least one of
1571 conf/{all,interface}/proxy_arp is set to TRUE,
1572 it will be disabled otherwise
1573
65324144
JDB
1574proxy_arp_pvlan - BOOLEAN
1575 Private VLAN proxy arp.
1cec2cac 1576
65324144
JDB
1577 Basically allow proxy arp replies back to the same interface
1578 (from which the ARP request/solicitation was received).
1579
1580 This is done to support (ethernet) switch features, like RFC
1581 3069, where the individual ports are NOT allowed to
1582 communicate with each other, but they are allowed to talk to
1583 the upstream router. As described in RFC 3069, it is possible
1584 to allow these hosts to communicate through the upstream
1585 router by proxy_arp'ing. Don't need to be used together with
1586 proxy_arp.
1587
1588 This technology is known by different names:
1cec2cac 1589
65324144
JDB
1590 In RFC 3069 it is called VLAN Aggregation.
1591 Cisco and Allied Telesyn call it Private VLAN.
1592 Hewlett-Packard call it Source-Port filtering or port-isolation.
1593 Ericsson call it MAC-Forced Forwarding (RFC Draft).
1594
1da177e4
LT
1595shared_media - BOOLEAN
1596 Send(router) or accept(host) RFC1620 shared media redirects.
176b346b 1597 Overrides secure_redirects.
1cec2cac 1598
1da177e4
LT
1599 shared_media for the interface will be enabled if at least one of
1600 conf/{all,interface}/shared_media is set to TRUE,
1601 it will be disabled otherwise
1cec2cac 1602
1da177e4
LT
1603 default TRUE
1604
1605secure_redirects - BOOLEAN
176b346b
EG
1606 Accept ICMP redirect messages only to gateways listed in the
1607 interface's current gateway list. Even if disabled, RFC1122 redirect
1608 rules still apply.
1cec2cac 1609
176b346b 1610 Overridden by shared_media.
1cec2cac 1611
1da177e4
LT
1612 secure_redirects for the interface will be enabled if at least one of
1613 conf/{all,interface}/secure_redirects is set to TRUE,
1614 it will be disabled otherwise
1cec2cac 1615
1da177e4
LT
1616 default TRUE
1617
1618send_redirects - BOOLEAN
1619 Send redirects, if router.
1cec2cac 1620
1da177e4
LT
1621 send_redirects for the interface will be enabled if at least one of
1622 conf/{all,interface}/send_redirects is set to TRUE,
1623 it will be disabled otherwise
1cec2cac 1624
1da177e4
LT
1625 Default: TRUE
1626
1627bootp_relay - BOOLEAN
1628 Accept packets with source address 0.b.c.d destined
1629 not to this host as local ones. It is supposed, that
1630 BOOTP relay daemon will catch and forward such packets.
1631 conf/all/bootp_relay must also be set to TRUE to enable BOOTP relay
1632 for the interface
1cec2cac 1633
1da177e4 1634 default FALSE
1cec2cac 1635
1da177e4
LT
1636 Not Implemented Yet.
1637
1638accept_source_route - BOOLEAN
1639 Accept packets with SRR option.
1640 conf/all/accept_source_route must also be set to TRUE to accept packets
1641 with SRR option on the interface
1cec2cac
MCC
1642
1643 default
1644
1645 - TRUE (router)
1646 - FALSE (host)
1da177e4 1647
8153a10c 1648accept_local - BOOLEAN
72b126a4
SB
1649 Accept packets with local source addresses. In combination with
1650 suitable routing, this can be used to direct packets between two
1651 local interfaces over the wire and have them accepted properly.
8153a10c
PM
1652 default FALSE
1653
d0daebc3
TG
1654route_localnet - BOOLEAN
1655 Do not consider loopback addresses as martian source or destination
1656 while routing. This enables the use of 127/8 for local routing purposes.
1cec2cac 1657
d0daebc3
TG
1658 default FALSE
1659
c1cf8422 1660rp_filter - INTEGER
1cec2cac
MCC
1661 - 0 - No source validation.
1662 - 1 - Strict mode as defined in RFC3704 Strict Reverse Path
1663 Each incoming packet is tested against the FIB and if the interface
1664 is not the best reverse path the packet check will fail.
1665 By default failed packets are discarded.
1666 - 2 - Loose mode as defined in RFC3704 Loose Reverse Path
1667 Each incoming packet's source address is also tested against the FIB
1668 and if the source address is not reachable via any interface
1669 the packet check will fail.
c1cf8422 1670
e18f5feb 1671 Current recommended practice in RFC3704 is to enable strict mode
bf869c30 1672 to prevent IP spoofing from DDos attacks. If using asymmetric routing
e18f5feb 1673 or other complicated routing, then loose mode is recommended.
c1cf8422 1674
1f5865e7
SW
1675 The max value from conf/{all,interface}/rp_filter is used
1676 when doing source validation on the {interface}.
1da177e4
LT
1677
1678 Default value is 0. Note that some distributions enable it
1679 in startup scripts.
1680
8cf5d8cc
JV
1681src_valid_mark - BOOLEAN
1682 - 0 - The fwmark of the packet is not included in reverse path
1683 route lookup. This allows for asymmetric routing configurations
1684 utilizing the fwmark in only one direction, e.g., transparent
1685 proxying.
1686
1687 - 1 - The fwmark of the packet is included in reverse path route
1688 lookup. This permits rp_filter to function when the fwmark is
1689 used for routing traffic in both directions.
1690
1691 This setting also affects the utilization of fmwark when
1692 performing source address selection for ICMP replies, or
1693 determining addresses stored for the IPOPT_TS_TSANDADDR and
1694 IPOPT_RR IP options.
1695
1696 The max value from conf/{all,interface}/src_valid_mark is used.
1697
1698 Default value is 0.
1699
1da177e4 1700arp_filter - BOOLEAN
1cec2cac
MCC
1701 - 1 - Allows you to have multiple network interfaces on the same
1702 subnet, and have the ARPs for each interface be answered
1703 based on whether or not the kernel would route a packet from
1704 the ARP'd IP out that interface (therefore you must use source
1705 based routing for this to work). In other words it allows control
1706 of which cards (usually 1) will respond to an arp request.
1707
1708 - 0 - (default) The kernel can respond to arp requests with addresses
1709 from other interfaces. This may seem wrong but it usually makes
1710 sense, because it increases the chance of successful communication.
1711 IP addresses are owned by the complete host on Linux, not by
1712 particular interfaces. Only for more complex setups like load-
1713 balancing, does this behaviour cause problems.
1da177e4
LT
1714
1715 arp_filter for the interface will be enabled if at least one of
1716 conf/{all,interface}/arp_filter is set to TRUE,
1717 it will be disabled otherwise
1718
1719arp_announce - INTEGER
1720 Define different restriction levels for announcing the local
1721 source IP address from IP packets in ARP requests sent on
1722 interface:
1cec2cac
MCC
1723
1724 - 0 - (default) Use any local address, configured on any interface
1725 - 1 - Try to avoid local addresses that are not in the target's
1726 subnet for this interface. This mode is useful when target
1727 hosts reachable via this interface require the source IP
1728 address in ARP requests to be part of their logical network
1729 configured on the receiving interface. When we generate the
1730 request we will check all our subnets that include the
1731 target IP and will preserve the source address if it is from
1732 such subnet. If there is no such subnet we select source
1733 address according to the rules for level 2.
1734 - 2 - Always use the best local address for this target.
1735 In this mode we ignore the source address in the IP packet
1736 and try to select local address that we prefer for talks with
1737 the target host. Such local address is selected by looking
1738 for primary IP addresses on all our subnets on the outgoing
1739 interface that include the target IP address. If no suitable
1740 local address is found we select the first local address
1741 we have on the outgoing interface or on all other interfaces,
1742 with the hope we will receive reply for our request and
1743 even sometimes no matter the source IP address we announce.
1da177e4
LT
1744
1745 The max value from conf/{all,interface}/arp_announce is used.
1746
1747 Increasing the restriction level gives more chance for
1748 receiving answer from the resolved target while decreasing
1749 the level announces more valid sender's information.
1750
1751arp_ignore - INTEGER
1752 Define different modes for sending replies in response to
1753 received ARP requests that resolve local target IP addresses:
1cec2cac
MCC
1754
1755 - 0 - (default): reply for any local target IP address, configured
1756 on any interface
1757 - 1 - reply only if the target IP address is local address
1758 configured on the incoming interface
1759 - 2 - reply only if the target IP address is local address
1760 configured on the incoming interface and both with the
1761 sender's IP address are part from same subnet on this interface
1762 - 3 - do not reply for local addresses configured with scope host,
1763 only resolutions for global and link addresses are replied
1764 - 4-7 - reserved
1765 - 8 - do not reply for all local addresses
1da177e4
LT
1766
1767 The max value from conf/{all,interface}/arp_ignore is used
1768 when ARP request is received on the {interface}
1769
eefef1cf
SH
1770arp_notify - BOOLEAN
1771 Define mode for notification of address and device changes.
1cec2cac
MCC
1772
1773 == ==========================================================
1774 0 (default): do nothing
1775 1 Generate gratuitous arp requests when device is brought up
1776 or hardware address changes.
1777 == ==========================================================
eefef1cf 1778
e68c5dcf
JP
1779arp_accept - INTEGER
1780 Define behavior for accepting gratuitous ARP (garp) frames from devices
1781 that are not already present in the ARP table:
1cec2cac
MCC
1782
1783 - 0 - don't create new entries in the ARP table
1784 - 1 - create new entries in the ARP table
e68c5dcf
JP
1785 - 2 - create new entries only if the source IP address is in the same
1786 subnet as an address configured on the interface that received the
1787 garp message.
6d955180
OP
1788
1789 Both replies and requests type gratuitous arp will trigger the
1790 ARP table to be updated, if this setting is on.
1791
1792 If the ARP table already contains the IP address of the
1793 gratuitous arp frame, the arp table will be updated regardless
1794 if this setting is on or off.
1795
fcdb44d0
JP
1796arp_evict_nocarrier - BOOLEAN
1797 Clears the ARP cache on NOCARRIER events. This option is important for
1798 wireless devices where the ARP cache should not be cleared when roaming
1799 between access points on the same network. In most cases this should
1800 remain as the default (1).
1801
1802 - 1 - (default): Clear the ARP cache on NOCARRIER events
1803 - 0 - Do not clear ARP cache on NOCARRIER events
1804
89c69d3c
YH
1805mcast_solicit - INTEGER
1806 The maximum number of multicast probes in INCOMPLETE state,
1807 when the associated hardware address is unknown. Defaults
1808 to 3.
1809
1810ucast_solicit - INTEGER
1811 The maximum number of unicast probes in PROBE state, when
1812 the hardware address is being reconfirmed. Defaults to 3.
c1b1bce8 1813
1da177e4
LT
1814app_solicit - INTEGER
1815 The maximum number of probes to send to the user space ARP daemon
1816 via netlink before dropping back to multicast probes (see
89c69d3c
YH
1817 mcast_resolicit). Defaults to 0.
1818
1819mcast_resolicit - INTEGER
1820 The maximum number of multicast probes after unicast and
1821 app probes in PROBE state. Defaults to 0.
1da177e4
LT
1822
1823disable_policy - BOOLEAN
1824 Disable IPSEC policy (SPD) for this interface
1825
1826disable_xfrm - BOOLEAN
1827 Disable IPSEC encryption on this interface, whatever the policy
1828
fc4eba58
HFS
1829igmpv2_unsolicited_report_interval - INTEGER
1830 The interval in milliseconds in which the next unsolicited
1831 IGMPv1 or IGMPv2 report retransmit will take place.
1cec2cac 1832
fc4eba58 1833 Default: 10000 (10 seconds)
1da177e4 1834
fc4eba58
HFS
1835igmpv3_unsolicited_report_interval - INTEGER
1836 The interval in milliseconds in which the next unsolicited
1837 IGMPv3 report retransmit will take place.
1cec2cac 1838
fc4eba58 1839 Default: 1000 (1 seconds)
1da177e4 1840
c0c5a60f
VB
1841ignore_routes_with_linkdown - BOOLEAN
1842 Ignore routes whose link is down when performing a FIB lookup.
1843
d922e1cb
MS
1844promote_secondaries - BOOLEAN
1845 When a primary IP address is removed from this interface
1846 promote a corresponding secondary IP address instead of
1847 removing all the corresponding secondary IP addresses.
1848
12b74dfa
JB
1849drop_unicast_in_l2_multicast - BOOLEAN
1850 Drop any unicast IP packets that are received in link-layer
1851 multicast (or broadcast) frames.
1cec2cac 1852
12b74dfa
JB
1853 This behavior (for multicast) is actually a SHOULD in RFC
1854 1122, but is disabled by default for compatibility reasons.
1cec2cac 1855
12b74dfa
JB
1856 Default: off (0)
1857
97daf331
JB
1858drop_gratuitous_arp - BOOLEAN
1859 Drop all gratuitous ARP frames, for example if there's a known
1860 good ARP proxy on the network and such frames need not be used
1861 (or in the case of 802.11, must not be used to prevent attacks.)
1cec2cac 1862
97daf331
JB
1863 Default: off (0)
1864
d922e1cb 1865
1da177e4
LT
1866tag - INTEGER
1867 Allows you to write a number, which can be used as required.
1cec2cac 1868
1da177e4
LT
1869 Default value is 0.
1870
e69948a0 1871xfrm4_gc_thresh - INTEGER
837f7411 1872 (Obsolete since linux-4.14)
e69948a0
AD
1873 The threshold at which we will start garbage collecting for IPv4
1874 destination cache entries. At twice this value the system will
3c2a89dd 1875 refuse new allocations.
e69948a0 1876
87583ebb
PD
1877igmp_link_local_mcast_reports - BOOLEAN
1878 Enable IGMP reports for link local multicast groups in the
1879 224.0.0.X range.
1cec2cac 1880
87583ebb
PD
1881 Default TRUE
1882
1da177e4
LT
1883Alexey Kuznetsov.
1884kuznet@ms2.inr.ac.ru
1885
1886Updated by:
1da177e4 1887
1cec2cac
MCC
1888- Andi Kleen
1889 ak@muc.de
1890- Nicolas Delon
1891 delon.nicolas@wanadoo.fr
1da177e4
LT
1892
1893
1894
1cec2cac
MCC
1895
1896/proc/sys/net/ipv6/* Variables
1897==============================
1da177e4
LT
1898
1899IPv6 has no global variables such as tcp_*. tcp_* settings under ipv4/ also
1900apply to IPv6 [XXX?].
1901
1902bindv6only - BOOLEAN
1903 Default value for IPV6_V6ONLY socket option,
e18f5feb 1904 which restricts use of the IPv6 socket to IPv6 communication
1da177e4 1905 only.
1cec2cac
MCC
1906
1907 - TRUE: disable IPv4-mapped address feature
1908 - FALSE: enable IPv4-mapped address feature
1da177e4 1909
d5c073ca 1910 Default: FALSE (as specified in RFC3493)
1da177e4 1911
6444f72b
FF
1912flowlabel_consistency - BOOLEAN
1913 Protect the consistency (and unicity) of flow label.
1914 You have to disable it to use IPV6_FL_F_REFLECT flag on the
1915 flow label manager.
1cec2cac
MCC
1916
1917 - TRUE: enabled
1918 - FALSE: disabled
1919
6444f72b
FF
1920 Default: TRUE
1921
42240901
TH
1922auto_flowlabels - INTEGER
1923 Automatically generate flow labels based on a flow hash of the
1924 packet. This allows intermediate devices, such as routers, to
1925 identify packet flows for mechanisms like Equal Cost Multipath
cb1ce2ef 1926 Routing (see RFC 6438).
1cec2cac
MCC
1927
1928 = ===========================================================
1929 0 automatic flow labels are completely disabled
1930 1 automatic flow labels are enabled by default, they can be
42240901
TH
1931 disabled on a per socket basis using the IPV6_AUTOFLOWLABEL
1932 socket option
1cec2cac 1933 2 automatic flow labels are allowed, they may be enabled on a
42240901 1934 per socket basis using the IPV6_AUTOFLOWLABEL socket option
1cec2cac 1935 3 automatic flow labels are enabled and enforced, they cannot
42240901 1936 be disabled by the socket option
1cec2cac
MCC
1937 = ===========================================================
1938
b5677416 1939 Default: 1
cb1ce2ef 1940
82a584b7
TH
1941flowlabel_state_ranges - BOOLEAN
1942 Split the flow label number space into two ranges. 0-0x7FFFF is
1943 reserved for the IPv6 flow manager facility, 0x80000-0xFFFFF
1944 is reserved for stateless flow labels as described in RFC6437.
1cec2cac
MCC
1945
1946 - TRUE: enabled
1947 - FALSE: disabled
1948
82a584b7
TH
1949 Default: true
1950
323a53c4
ED
1951flowlabel_reflect - INTEGER
1952 Control flow label reflection. Needed for Path MTU
22b6722b
JS
1953 Discovery to work with Equal Cost Multipath Routing in anycast
1954 environments. See RFC 7690 and:
1955 https://tools.ietf.org/html/draft-wang-6man-flow-label-reflection-01
323a53c4 1956
a346abe0 1957 This is a bitmask.
323a53c4 1958
1cec2cac
MCC
1959 - 1: enabled for established flows
1960
1961 Note that this prevents automatic flowlabel changes, as done
1962 in "tcp: change IPv6 flow-label upon receiving spurious retransmission"
1963 and "tcp: Change txhash on every SYN and RTO retransmit"
323a53c4 1964
1cec2cac
MCC
1965 - 2: enabled for TCP RESET packets (no active listener)
1966 If set, a RST packet sent in response to a SYN packet on a closed
1967 port will reflect the incoming flow label.
323a53c4 1968
1cec2cac 1969 - 4: enabled for ICMPv6 echo reply messages.
a346abe0 1970
323a53c4 1971 Default: 0
22b6722b 1972
b4bac172
DA
1973fib_multipath_hash_policy - INTEGER
1974 Controls which hash policy to use for multipath routes.
1cec2cac 1975
b4bac172 1976 Default: 0 (Layer 3)
1cec2cac 1977
b4bac172 1978 Possible values:
1cec2cac
MCC
1979
1980 - 0 - Layer 3 (source and destination addresses plus flow label)
1981 - 1 - Layer 4 (standard 5-tuple)
1982 - 2 - Layer 3 or inner Layer 3 if present
73c2c5cb
IS
1983 - 3 - Custom multipath hash. Fields used for multipath hash calculation
1984 are determined by fib_multipath_hash_fields sysctl
b4bac172 1985
ed13923f
IS
1986fib_multipath_hash_fields - UNSIGNED INTEGER
1987 When fib_multipath_hash_policy is set to 3 (custom multipath hash), the
1988 fields used for multipath hash calculation are determined by this
1989 sysctl.
1990
1991 This value is a bitmask which enables various fields for multipath hash
1992 calculation.
1993
1994 Possible fields are:
1995
1996 ====== ============================
1997 0x0001 Source IP address
1998 0x0002 Destination IP address
1999 0x0004 IP protocol
2000 0x0008 Flow Label
2001 0x0010 Source port
2002 0x0020 Destination port
2003 0x0040 Inner source IP address
2004 0x0080 Inner destination IP address
2005 0x0100 Inner IP protocol
2006 0x0200 Inner Flow Label
2007 0x0400 Inner source port
2008 0x0800 Inner destination port
2009 ====== ============================
2010
2011 Default: 0x0007 (source IP, destination IP and IP protocol)
2012
509aba3b
FLB
2013anycast_src_echo_reply - BOOLEAN
2014 Controls the use of anycast addresses as source addresses for ICMPv6
2015 echo reply
1cec2cac
MCC
2016
2017 - TRUE: enabled
2018 - FALSE: disabled
2019
509aba3b
FLB
2020 Default: FALSE
2021
9f0761c1
HFS
2022idgen_delay - INTEGER
2023 Controls the delay in seconds after which time to retry
2024 privacy stable address generation if a DAD conflict is
2025 detected.
1cec2cac 2026
9f0761c1
HFS
2027 Default: 1 (as specified in RFC7217)
2028
2029idgen_retries - INTEGER
2030 Controls the number of retries to generate a stable privacy
2031 address if a DAD conflict is detected.
1cec2cac 2032
9f0761c1
HFS
2033 Default: 3 (as specified in RFC7217)
2034
2f711939
HFS
2035mld_qrv - INTEGER
2036 Controls the MLD query robustness variable (see RFC3810 9.1).
1cec2cac 2037
2f711939 2038 Default: 2 (as specified by RFC3810 9.1)
1cec2cac 2039
2f711939
HFS
2040 Minimum: 1 (as specified by RFC6636 4.5)
2041
ab913455 2042max_dst_opts_number - INTEGER
47d3d7ac
TH
2043 Maximum number of non-padding TLVs allowed in a Destination
2044 options extension header. If this value is less than zero
2045 then unknown options are disallowed and the number of known
2046 TLVs allowed is the absolute value of this number.
1cec2cac 2047
47d3d7ac
TH
2048 Default: 8
2049
ab913455 2050max_hbh_opts_number - INTEGER
47d3d7ac
TH
2051 Maximum number of non-padding TLVs allowed in a Hop-by-Hop
2052 options extension header. If this value is less than zero
2053 then unknown options are disallowed and the number of known
2054 TLVs allowed is the absolute value of this number.
1cec2cac 2055
47d3d7ac
TH
2056 Default: 8
2057
ab913455 2058max_dst_opts_length - INTEGER
47d3d7ac
TH
2059 Maximum length allowed for a Destination options extension
2060 header.
1cec2cac 2061
47d3d7ac
TH
2062 Default: INT_MAX (unlimited)
2063
ab913455 2064max_hbh_length - INTEGER
47d3d7ac
TH
2065 Maximum length allowed for a Hop-by-Hop options extension
2066 header.
1cec2cac 2067
47d3d7ac
TH
2068 Default: INT_MAX (unlimited)
2069
7c6bb7d2
DA
2070skip_notify_on_dev_down - BOOLEAN
2071 Controls whether an RTM_DELROUTE message is generated for routes
2072 removed when a device is taken down or deleted. IPv4 does not
2073 generate this message; IPv6 does by default. Setting this sysctl
2074 to true skips the message, making IPv4 and IPv6 on par in relying
2075 on userspace caches to track link events and evict routes.
1cec2cac 2076
7c6bb7d2
DA
2077 Default: false (generate message)
2078
4f80116d
RP
2079nexthop_compat_mode - BOOLEAN
2080 New nexthop API provides a means for managing nexthops independent of
a266ef69 2081 prefixes. Backwards compatibility with old route format is enabled by
4f80116d
RP
2082 default which means route dumps and notifications contain the new
2083 nexthop attribute but also the full, expanded nexthop definition.
2084 Further, updates or deletes of a nexthop configuration generate route
2085 notifications for each fib entry using the nexthop. Once a system
2086 understands the new API, this sysctl can be disabled to achieve full
2087 performance benefits of the new API by disabling the nexthop expansion
2088 and extraneous notifications.
2089 Default: true (backward compat mode)
2090
907eea48
AC
2091fib_notify_on_flag_change - INTEGER
2092 Whether to emit RTM_NEWROUTE notifications whenever RTM_F_OFFLOAD/
6fad361a 2093 RTM_F_TRAP/RTM_F_OFFLOAD_FAILED flags are changed.
907eea48
AC
2094
2095 After installing a route to the kernel, user space receives an
2096 acknowledgment, which means the route was installed in the kernel,
2097 but not necessarily in hardware.
2098 It is also possible for a route already installed in hardware to change
2099 its action and therefore its flags. For example, a host route that is
2100 trapping packets can be "promoted" to perform decapsulation following
2101 the installation of an IPinIP/VXLAN tunnel.
2102 The notifications will indicate to user-space the state of the route.
2103
2104 Default: 0 (Do not emit notifications.)
2105
2106 Possible values:
2107
2108 - 0 - Do not emit notifications.
2109 - 1 - Emit notifications.
6fad361a 2110 - 2 - Emit notifications only for RTM_F_OFFLOAD_FAILED flag change.
907eea48 2111
de8e80a5
JI
2112ioam6_id - INTEGER
2113 Define the IOAM id of this node. Uses only 24 bits out of 32 in total.
2114
2115 Min: 0
2116 Max: 0xFFFFFF
2117
2118 Default: 0xFFFFFF
2119
2120ioam6_id_wide - LONG INTEGER
2121 Define the wide IOAM id of this node. Uses only 56 bits out of 64 in
2122 total. Can be different from ioam6_id.
2123
2124 Min: 0
2125 Max: 0xFFFFFFFFFFFFFF
2126
2127 Default: 0xFFFFFFFFFFFFFF
2128
1da177e4
LT
2129IPv6 Fragmentation:
2130
2131ip6frag_high_thresh - INTEGER
e18f5feb 2132 Maximum memory used to reassemble IPv6 fragments. When
1da177e4
LT
2133 ip6frag_high_thresh bytes of memory is allocated for this purpose,
2134 the fragment handler will toss packets until ip6frag_low_thresh
2135 is reached.
e18f5feb 2136
1da177e4 2137ip6frag_low_thresh - INTEGER
e18f5feb 2138 See ip6frag_high_thresh
1da177e4
LT
2139
2140ip6frag_time - INTEGER
2141 Time in seconds to keep an IPv6 fragment in memory.
2142
1cec2cac 2143``conf/default/*``:
1da177e4
LT
2144 Change the interface-specific default settings.
2145
fc024c5c
PR
2146 These settings would be used during creating new interfaces.
2147
1da177e4 2148
1cec2cac 2149``conf/all/*``:
e18f5feb 2150 Change all the interface-specific settings.
1da177e4
LT
2151
2152 [XXX: Other special features than forwarding?]
2153
fc024c5c
PR
2154conf/all/disable_ipv6 - BOOLEAN
2155 Changing this value is same as changing ``conf/default/disable_ipv6``
2156 setting and also all per-interface ``disable_ipv6`` settings to the same
2157 value.
2158
2159 Reading this value does not have any particular meaning. It does not say
2160 whether IPv6 support is enabled or disabled. Returned value can be 1
2161 also in the case when some interface has ``disable_ipv6`` set to 0 and
2162 has configured IPv6 addresses.
2163
1da177e4 2164conf/all/forwarding - BOOLEAN
e18f5feb 2165 Enable global IPv6 forwarding between all interfaces.
1da177e4 2166
e18f5feb 2167 IPv4 and IPv6 work differently here; e.g. netfilter must be used
1da177e4
LT
2168 to control which interfaces may forward packets and which not.
2169
e18f5feb 2170 This also sets all interfaces' Host/Router setting
1da177e4
LT
2171 'forwarding' to the specified value. See below for details.
2172
2173 This referred to as global forwarding.
2174
fbea49e1
YH
2175proxy_ndp - BOOLEAN
2176 Do proxy ndp.
2177
219b5f29
LV
2178fwmark_reflect - BOOLEAN
2179 Controls the fwmark of kernel-generated IPv6 reply packets that are not
2180 associated with a socket for example, TCP RSTs or ICMPv6 echo replies).
2181 If unset, these packets have a fwmark of zero. If set, they have the
2182 fwmark of the packet they are replying to.
1cec2cac 2183
219b5f29
LV
2184 Default: 0
2185
1cec2cac 2186``conf/interface/*``:
1da177e4
LT
2187 Change special settings per interface.
2188
e18f5feb 2189 The functional behaviour for certain settings is different
1da177e4
LT
2190 depending on whether local forwarding is enabled or not.
2191
605b91c8 2192accept_ra - INTEGER
1da177e4 2193 Accept Router Advertisements; autoconfigure using them.
e18f5feb 2194
026359bc
TA
2195 It also determines whether or not to transmit Router
2196 Solicitations. If and only if the functional setting is to
2197 accept Router Advertisements, Router Solicitations will be
2198 transmitted.
2199
ae8abfa0 2200 Possible values are:
ae8abfa0 2201
1cec2cac
MCC
2202 == ===========================================================
2203 0 Do not accept Router Advertisements.
2204 1 Accept Router Advertisements if forwarding is disabled.
2205 2 Overrule forwarding behaviour. Accept Router Advertisements
2206 even if forwarding is enabled.
2207 == ===========================================================
2208
2209 Functional default:
2210
2211 - enabled if local forwarding is disabled.
2212 - disabled if local forwarding is enabled.
1da177e4 2213
65f5c7c1
YH
2214accept_ra_defrtr - BOOLEAN
2215 Learn default router in Router Advertisement.
2216
1cec2cac
MCC
2217 Functional default:
2218
2219 - enabled if accept_ra is enabled.
2220 - disabled if accept_ra is disabled.
65f5c7c1 2221
6b2e04bc
PC
2222ra_defrtr_metric - UNSIGNED INTEGER
2223 Route metric for default route learned in Router Advertisement. This value
2224 will be assigned as metric for the default route learned via IPv6 Router
2225 Advertisement. Takes affect only if accept_ra_defrtr is enabled.
2226
2227 Possible values:
2228 1 to 0xFFFFFFFF
2229
2230 Default: IP6_RT_PRIO_USER i.e. 1024.
2231
d9333196
BG
2232accept_ra_from_local - BOOLEAN
2233 Accept RA with source-address that is found on local machine
1cec2cac
MCC
2234 if the RA is otherwise proper and able to be accepted.
2235
2236 Default is to NOT accept these as it may be an un-intended
2237 network loop.
d9333196
BG
2238
2239 Functional default:
1cec2cac
MCC
2240
2241 - enabled if accept_ra_from_local is enabled
2242 on a specific interface.
2243 - disabled if accept_ra_from_local is disabled
2244 on a specific interface.
d9333196 2245
8013d1d7
HL
2246accept_ra_min_hop_limit - INTEGER
2247 Minimum hop limit Information in Router Advertisement.
2248
2249 Hop limit Information in Router Advertisement less than this
2250 variable shall be ignored.
2251
2252 Default: 1
2253
c4fd30eb 2254accept_ra_pinfo - BOOLEAN
2fe0ae78 2255 Learn Prefix Information in Router Advertisement.
c4fd30eb 2256
1cec2cac
MCC
2257 Functional default:
2258
2259 - enabled if accept_ra is enabled.
2260 - disabled if accept_ra is disabled.
c4fd30eb 2261
bbea124b
JS
2262accept_ra_rt_info_min_plen - INTEGER
2263 Minimum prefix length of Route Information in RA.
2264
2265 Route Information w/ prefix smaller than this variable shall
2266 be ignored.
2267
1cec2cac
MCC
2268 Functional default:
2269
2270 * 0 if accept_ra_rtr_pref is enabled.
2271 * -1 if accept_ra_rtr_pref is disabled.
bbea124b 2272
09c884d4
YH
2273accept_ra_rt_info_max_plen - INTEGER
2274 Maximum prefix length of Route Information in RA.
2275
bbea124b
JS
2276 Route Information w/ prefix larger than this variable shall
2277 be ignored.
09c884d4 2278
1cec2cac
MCC
2279 Functional default:
2280
2281 * 0 if accept_ra_rtr_pref is enabled.
2282 * -1 if accept_ra_rtr_pref is disabled.
09c884d4 2283
930d6ff2
YH
2284accept_ra_rtr_pref - BOOLEAN
2285 Accept Router Preference in RA.
2286
1cec2cac
MCC
2287 Functional default:
2288
2289 - enabled if accept_ra is enabled.
2290 - disabled if accept_ra is disabled.
930d6ff2 2291
c2943f14
HH
2292accept_ra_mtu - BOOLEAN
2293 Apply the MTU value specified in RA option 5 (RFC4861). If
2294 disabled, the MTU specified in the RA will be ignored.
2295
1cec2cac
MCC
2296 Functional default:
2297
2298 - enabled if accept_ra is enabled.
2299 - disabled if accept_ra is disabled.
c2943f14 2300
1da177e4
LT
2301accept_redirects - BOOLEAN
2302 Accept Redirects.
2303
1cec2cac
MCC
2304 Functional default:
2305
2306 - enabled if local forwarding is disabled.
2307 - disabled if local forwarding is enabled.
1da177e4 2308
0bcbc926
YH
2309accept_source_route - INTEGER
2310 Accept source routing (routing extension header).
2311
1cec2cac
MCC
2312 - >= 0: Accept only routing header type 2.
2313 - < 0: Do not accept routing header.
0bcbc926
YH
2314
2315 Default: 0
2316
1da177e4 2317autoconf - BOOLEAN
e18f5feb 2318 Autoconfigure addresses using Prefix Information in Router
1da177e4
LT
2319 Advertisements.
2320
1cec2cac
MCC
2321 Functional default:
2322
2323 - enabled if accept_ra_pinfo is enabled.
2324 - disabled if accept_ra_pinfo is disabled.
1da177e4
LT
2325
2326dad_transmits - INTEGER
2327 The amount of Duplicate Address Detection probes to send.
1cec2cac 2328
1da177e4 2329 Default: 1
e18f5feb 2330
605b91c8 2331forwarding - INTEGER
e18f5feb 2332 Configure interface-specific Host/Router behaviour.
1da177e4 2333
1cec2cac
MCC
2334 .. note::
2335
2336 It is recommended to have the same setting on all
2337 interfaces; mixed router/host scenarios are rather uncommon.
1da177e4 2338
ae8abfa0 2339 Possible values are:
ae8abfa0 2340
1cec2cac
MCC
2341 - 0 Forwarding disabled
2342 - 1 Forwarding enabled
2343
2344 **FALSE (0)**:
1da177e4
LT
2345
2346 By default, Host behaviour is assumed. This means:
2347
2348 1. IsRouter flag is not set in Neighbour Advertisements.
026359bc
TA
2349 2. If accept_ra is TRUE (default), transmit Router
2350 Solicitations.
e18f5feb 2351 3. If accept_ra is TRUE (default), accept Router
1da177e4
LT
2352 Advertisements (and do autoconfiguration).
2353 4. If accept_redirects is TRUE (default), accept Redirects.
2354
1cec2cac 2355 **TRUE (1)**:
1da177e4 2356
e18f5feb 2357 If local forwarding is enabled, Router behaviour is assumed.
1da177e4
LT
2358 This means exactly the reverse from the above:
2359
2360 1. IsRouter flag is set in Neighbour Advertisements.
026359bc 2361 2. Router Solicitations are not sent unless accept_ra is 2.
ae8abfa0 2362 3. Router Advertisements are ignored unless accept_ra is 2.
1da177e4
LT
2363 4. Redirects are ignored.
2364
ae8abfa0 2365 Default: 0 (disabled) if global forwarding is disabled (default),
1cec2cac 2366 otherwise 1 (enabled).
1da177e4
LT
2367
2368hop_limit - INTEGER
2369 Default Hop Limit to set.
1cec2cac 2370
1da177e4
LT
2371 Default: 64
2372
2373mtu - INTEGER
2374 Default Maximum Transfer Unit
1cec2cac 2375
1da177e4
LT
2376 Default: 1280 (IPv6 required minimum)
2377
35a256fe
TH
2378ip_nonlocal_bind - BOOLEAN
2379 If set, allows processes to bind() to non-local IPv6 addresses,
2380 which can be quite useful - but may break some applications.
1cec2cac 2381
35a256fe
TH
2382 Default: 0
2383
52e16356
YH
2384router_probe_interval - INTEGER
2385 Minimum interval (in seconds) between Router Probing described
2386 in RFC4191.
2387
2388 Default: 60
2389
1da177e4
LT
2390router_solicitation_delay - INTEGER
2391 Number of seconds to wait after interface is brought up
2392 before sending Router Solicitations.
1cec2cac 2393
1da177e4
LT
2394 Default: 1
2395
2396router_solicitation_interval - INTEGER
2397 Number of seconds to wait between Router Solicitations.
1cec2cac 2398
1da177e4
LT
2399 Default: 4
2400
2401router_solicitations - INTEGER
e18f5feb 2402 Number of Router Solicitations to send until assuming no
1da177e4 2403 routers are present.
1cec2cac 2404
1da177e4
LT
2405 Default: 3
2406
3985e8a3
EK
2407use_oif_addrs_only - BOOLEAN
2408 When enabled, the candidate source addresses for destinations
2409 routed via this interface are restricted to the set of addresses
2410 configured on this interface (vis. RFC 6724, section 4).
2411
2412 Default: false
2413
1da177e4
LT
2414use_tempaddr - INTEGER
2415 Preference for Privacy Extensions (RFC3041).
1cec2cac
MCC
2416
2417 * <= 0 : disable Privacy Extensions
2418 * == 1 : enable Privacy Extensions, but prefer public
2419 addresses over temporary addresses.
2420 * > 1 : enable Privacy Extensions and prefer temporary
2421 addresses over public addresses.
2422
2423 Default:
2424
2425 * 0 (for most devices)
2426 * -1 (for point-to-point devices and loopback devices)
1da177e4
LT
2427
2428temp_valid_lft - INTEGER
2429 valid lifetime (in seconds) for temporary addresses.
1cec2cac 2430
969c5464 2431 Default: 172800 (2 days)
1da177e4
LT
2432
2433temp_prefered_lft - INTEGER
2434 Preferred lifetime (in seconds) for temporary addresses.
1cec2cac 2435
1da177e4
LT
2436 Default: 86400 (1 day)
2437
f1705ec1
DA
2438keep_addr_on_down - INTEGER
2439 Keep all IPv6 addresses on an interface down event. If set static
2440 global addresses with no expiration time are not flushed.
1cec2cac
MCC
2441
2442 * >0 : enabled
2443 * 0 : system default
2444 * <0 : disabled
f1705ec1
DA
2445
2446 Default: 0 (addresses are removed)
2447
1da177e4
LT
2448max_desync_factor - INTEGER
2449 Maximum value for DESYNC_FACTOR, which is a random value
e18f5feb 2450 that ensures that clients don't synchronize with each
1da177e4
LT
2451 other and generate new addresses at exactly the same time.
2452 value is in seconds.
1cec2cac 2453
1da177e4 2454 Default: 600
e18f5feb 2455
1da177e4
LT
2456regen_max_retry - INTEGER
2457 Number of attempts before give up attempting to generate
2458 valid temporary addresses.
1cec2cac 2459
1da177e4
LT
2460 Default: 5
2461
2462max_addresses - INTEGER
e79dc484
BH
2463 Maximum number of autoconfigured addresses per interface. Setting
2464 to zero disables the limitation. It is not recommended to set this
2465 value too large (or to zero) because it would be an easy way to
2466 crash the kernel by allowing too many addresses to be created.
1cec2cac 2467
1da177e4
LT
2468 Default: 16
2469
778d80be 2470disable_ipv6 - BOOLEAN
9bdd8d40
BH
2471 Disable IPv6 operation. If accept_dad is set to 2, this value
2472 will be dynamically set to TRUE if DAD fails for the link-local
2473 address.
1cec2cac 2474
778d80be
YH
2475 Default: FALSE (enable IPv6 operation)
2476
56d417b1
BH
2477 When this value is changed from 1 to 0 (IPv6 is being enabled),
2478 it will dynamically create a link-local address on the given
2479 interface and start Duplicate Address Detection, if necessary.
2480
2481 When this value is changed from 0 to 1 (IPv6 is being disabled),
2f0aaf7f
LB
2482 it will dynamically delete all addresses and routes on the given
2483 interface. From now on it will not possible to add addresses/routes
2484 to the selected interface.
56d417b1 2485
1b34be74
YH
2486accept_dad - INTEGER
2487 Whether to accept DAD (Duplicate Address Detection).
1cec2cac
MCC
2488
2489 == ==============================================================
2490 0 Disable DAD
2491 1 Enable DAD (default)
2492 2 Enable DAD, and disable IPv6 operation if MAC-based duplicate
2493 link-local address has been found.
2494 == ==============================================================
1b34be74 2495
35e015e1
MC
2496 DAD operation and mode on a given interface will be selected according
2497 to the maximum value of conf/{all,interface}/accept_dad.
2498
f7734fdf
OP
2499force_tllao - BOOLEAN
2500 Enable sending the target link-layer address option even when
2501 responding to a unicast neighbor solicitation.
1cec2cac 2502
f7734fdf
OP
2503 Default: FALSE
2504
2505 Quoting from RFC 2461, section 4.4, Target link-layer address:
2506
2507 "The option MUST be included for multicast solicitations in order to
2508 avoid infinite Neighbor Solicitation "recursion" when the peer node
2509 does not have a cache entry to return a Neighbor Advertisements
2510 message. When responding to unicast solicitations, the option can be
2511 omitted since the sender of the solicitation has the correct link-
2512 layer address; otherwise it would not have be able to send the unicast
2513 solicitation in the first place. However, including the link-layer
2514 address in this case adds little overhead and eliminates a potential
2515 race condition where the sender deletes the cached link-layer address
2516 prior to receiving a response to a previous solicitation."
2517
db2b620a
HFS
2518ndisc_notify - BOOLEAN
2519 Define mode for notification of address and device changes.
1cec2cac
MCC
2520
2521 * 0 - (default): do nothing
2522 * 1 - Generate unsolicited neighbour advertisements when device is brought
2523 up or hardware address changes.
db2b620a 2524
2210d6b2
2525ndisc_tclass - INTEGER
2526 The IPv6 Traffic Class to use by default when sending IPv6 Neighbor
2527 Discovery (Router Solicitation, Router Advertisement, Neighbor
2528 Solicitation, Neighbor Advertisement, Redirect) messages.
2529 These 8 bits can be interpreted as 6 high order bits holding the DSCP
2530 value and 2 low order bits representing ECN (which you probably want
2531 to leave cleared).
1cec2cac
MCC
2532
2533 * 0 - (default)
2210d6b2 2534
18ac597a
JP
2535ndisc_evict_nocarrier - BOOLEAN
2536 Clears the neighbor discovery table on NOCARRIER events. This option is
2537 important for wireless devices where the neighbor discovery cache should
2538 not be cleared when roaming between access points on the same network.
2539 In most cases this should remain as the default (1).
2540
2541 - 1 - (default): Clear neighbor discover cache on NOCARRIER events.
2542 - 0 - Do not clear neighbor discovery cache on NOCARRIER events.
2543
fc4eba58
HFS
2544mldv1_unsolicited_report_interval - INTEGER
2545 The interval in milliseconds in which the next unsolicited
2546 MLDv1 report retransmit will take place.
1cec2cac 2547
fc4eba58
HFS
2548 Default: 10000 (10 seconds)
2549
2550mldv2_unsolicited_report_interval - INTEGER
2551 The interval in milliseconds in which the next unsolicited
2552 MLDv2 report retransmit will take place.
1cec2cac 2553
fc4eba58
HFS
2554 Default: 1000 (1 second)
2555
f2127810 2556force_mld_version - INTEGER
1cec2cac
MCC
2557 * 0 - (default) No enforcement of a MLD version, MLDv1 fallback allowed
2558 * 1 - Enforce to use MLD version 1
2559 * 2 - Enforce to use MLD version 2
f2127810 2560
b800c3b9
HFS
2561suppress_frag_ndisc - INTEGER
2562 Control RFC 6980 (Security Implications of IPv6 Fragmentation
2563 with IPv6 Neighbor Discovery) behavior:
1cec2cac
MCC
2564
2565 * 1 - (default) discard fragmented neighbor discovery packets
2566 * 0 - allow fragmented neighbor discovery packets
b800c3b9 2567
7fd2561e
EK
2568optimistic_dad - BOOLEAN
2569 Whether to perform Optimistic Duplicate Address Detection (RFC 4429).
1cec2cac
MCC
2570
2571 * 0: disabled (default)
2572 * 1: enabled
35e015e1
MC
2573
2574 Optimistic Duplicate Address Detection for the interface will be enabled
2575 if at least one of conf/{all,interface}/optimistic_dad is set to 1,
2576 it will be disabled otherwise.
7fd2561e
EK
2577
2578use_optimistic - BOOLEAN
2579 If enabled, do not classify optimistic addresses as deprecated during
2580 source address selection. Preferred addresses will still be chosen
2581 before optimistic addresses, subject to other ranking in the source
2582 address selection algorithm.
1cec2cac
MCC
2583
2584 * 0: disabled (default)
2585 * 1: enabled
35e015e1
MC
2586
2587 This will be enabled if at least one of
2588 conf/{all,interface}/use_optimistic is set to 1, disabled otherwise.
7fd2561e 2589
9f0761c1
HFS
2590stable_secret - IPv6 address
2591 This IPv6 address will be used as a secret to generate IPv6
2592 addresses for link-local addresses and autoconfigured
2593 ones. All addresses generated after setting this secret will
2594 be stable privacy ones by default. This can be changed via the
2595 addrgenmode ip-link. conf/default/stable_secret is used as the
2596 secret for the namespace, the interface specific ones can
2597 overwrite that. Writes to conf/all/stable_secret are refused.
2598
2599 It is recommended to generate this secret during installation
2600 of a system and keep it stable after that.
2601
2602 By default the stable secret is unset.
2603
f168db5e
SD
2604addr_gen_mode - INTEGER
2605 Defines how link-local and autoconf addresses are generated.
2606
1cec2cac
MCC
2607 = =================================================================
2608 0 generate address based on EUI64 (default)
2609 1 do no generate a link-local address, use EUI64 for addresses
2610 generated from autoconf
2611 2 generate stable privacy addresses, using the secret from
f168db5e 2612 stable_secret (RFC7217)
1cec2cac
MCC
2613 3 generate stable privacy addresses, using a random secret if unset
2614 = =================================================================
f168db5e 2615
abbc3043
JB
2616drop_unicast_in_l2_multicast - BOOLEAN
2617 Drop any unicast IPv6 packets that are received in link-layer
2618 multicast (or broadcast) frames.
2619
2620 By default this is turned off.
2621
7a02bf89
JB
2622drop_unsolicited_na - BOOLEAN
2623 Drop all unsolicited neighbor advertisements, for example if there's
2624 a known good NA proxy on the network and such frames need not be used
2625 (or in the case of 802.11, must not be used to prevent attacks.)
2626
2627 By default this is turned off.
2628
aaa5f515
JP
2629accept_untracked_na - INTEGER
2630 Define behavior for accepting neighbor advertisements from devices that
2631 are absent in the neighbor cache:
2632
2633 - 0 - (default) Do not accept unsolicited and untracked neighbor
2634 advertisements.
2635
2636 - 1 - Add a new neighbor cache entry in STALE state for routers on
2637 receiving a neighbor advertisement (either solicited or unsolicited)
2638 with target link-layer address option specified if no neighbor entry
2639 is already present for the advertised IPv6 address. Without this knob,
2640 NAs received for untracked addresses (absent in neighbor cache) are
2641 silently ignored.
2642
2643 This is as per router-side behavior documented in RFC9131.
2644
2645 This has lower precedence than drop_unsolicited_na.
2646
2647 This will optimize the return path for the initial off-link
2648 communication that is initiated by a directly connected host, by
2649 ensuring that the first-hop router which turns on this setting doesn't
2650 have to buffer the initial return packets to do neighbor-solicitation.
2651 The prerequisite is that the host is configured to send unsolicited
2652 neighbor advertisements on interface bringup. This setting should be
2653 used in conjunction with the ndisc_notify setting on the host to
2654 satisfy this prerequisite.
2655
2656 - 2 - Extend option (1) to add a new neighbor cache entry only if the
2657 source IP address is in the same subnet as an address configured on
2658 the interface that received the neighbor advertisement.
f9a2fb73 2659
adc176c5
EN
2660enhanced_dad - BOOLEAN
2661 Include a nonce option in the IPv6 neighbor solicitation messages used for
2662 duplicate address detection per RFC7527. A received DAD NS will only signal
2663 a duplicate address if the nonce is different. This avoids any false
2664 detection of duplicates due to loopback of the NS messages that we send.
2665 The nonce option will be sent on an interface unless both of
2666 conf/{all,interface}/enhanced_dad are set to FALSE.
1cec2cac 2667
adc176c5
EN
2668 Default: TRUE
2669
1cec2cac
MCC
2670``icmp/*``:
2671===========
2672
1da177e4 2673ratelimit - INTEGER
0bc19985 2674 Limit the maximal rates for sending ICMPv6 messages.
1cec2cac 2675
6dbf4bca
SH
2676 0 to disable any limiting,
2677 otherwise the minimal space between responses in milliseconds.
1cec2cac 2678
6dbf4bca 2679 Default: 1000
1da177e4 2680
0bc19985
SS
2681ratemask - list of comma separated ranges
2682 For ICMPv6 message types matching the ranges in the ratemask, limit
2683 the sending of the message according to ratelimit parameter.
2684
2685 The format used for both input and output is a comma separated
2686 list of ranges (e.g. "0-127,129" for ICMPv6 message type 0 to 127 and
2687 129). Writing to the file will clear all previous ranges of ICMPv6
2688 message types and update the current list with the input.
2689
2690 Refer to: https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml
2691 for numerical values of ICMPv6 message types, e.g. echo request is 128
2692 and echo reply is 129.
2693
2694 Default: 0-1,3-127 (rate limit ICMPv6 errors except Packet Too Big)
2695
e6f86b0f
VJ
2696echo_ignore_all - BOOLEAN
2697 If set non-zero, then the kernel will ignore all ICMP ECHO
2698 requests sent to it over the IPv6 protocol.
1cec2cac 2699
e6f86b0f
VJ
2700 Default: 0
2701
03f1eccc
SS
2702echo_ignore_multicast - BOOLEAN
2703 If set non-zero, then the kernel will ignore all ICMP ECHO
2704 requests sent to it over the IPv6 protocol via multicast.
1cec2cac 2705
03f1eccc
SS
2706 Default: 0
2707
0b03a5ca
SS
2708echo_ignore_anycast - BOOLEAN
2709 If set non-zero, then the kernel will ignore all ICMP ECHO
2710 requests sent to it over the IPv6 protocol destined to anycast address.
1cec2cac 2711
0b03a5ca
SS
2712 Default: 0
2713
e69948a0 2714xfrm6_gc_thresh - INTEGER
837f7411 2715 (Obsolete since linux-4.14)
e69948a0
AD
2716 The threshold at which we will start garbage collecting for IPv6
2717 destination cache entries. At twice this value the system will
3c2a89dd 2718 refuse new allocations.
e69948a0 2719
1da177e4
LT
2720
2721IPv6 Update by:
2722Pekka Savola <pekkas@netcore.fi>
2723YOSHIFUJI Hideaki / USAGI Project <yoshfuji@linux-ipv6.org>
2724
2725
2726/proc/sys/net/bridge/* Variables:
1cec2cac 2727=================================
1da177e4
LT
2728
2729bridge-nf-call-arptables - BOOLEAN
1cec2cac
MCC
2730 - 1 : pass bridged ARP traffic to arptables' FORWARD chain.
2731 - 0 : disable this.
2732
1da177e4
LT
2733 Default: 1
2734
2735bridge-nf-call-iptables - BOOLEAN
1cec2cac
MCC
2736 - 1 : pass bridged IPv4 traffic to iptables' chains.
2737 - 0 : disable this.
2738
1da177e4
LT
2739 Default: 1
2740
2741bridge-nf-call-ip6tables - BOOLEAN
1cec2cac
MCC
2742 - 1 : pass bridged IPv6 traffic to ip6tables' chains.
2743 - 0 : disable this.
2744
1da177e4
LT
2745 Default: 1
2746
2747bridge-nf-filter-vlan-tagged - BOOLEAN
1cec2cac
MCC
2748 - 1 : pass bridged vlan-tagged ARP/IP/IPv6 traffic to {arp,ip,ip6}tables.
2749 - 0 : disable this.
2750
4981682c 2751 Default: 0
516299d2
MM
2752
2753bridge-nf-filter-pppoe-tagged - BOOLEAN
1cec2cac
MCC
2754 - 1 : pass bridged pppoe-tagged IP/IPv6 traffic to {ip,ip6}tables.
2755 - 0 : disable this.
2756
4981682c 2757 Default: 0
1da177e4 2758
4981682c 2759bridge-nf-pass-vlan-input-dev - BOOLEAN
1cec2cac
MCC
2760 - 1: if bridge-nf-filter-vlan-tagged is enabled, try to find a vlan
2761 interface on the bridge and set the netfilter input device to the
2762 vlan. This allows use of e.g. "iptables -i br0.1" and makes the
2763 REDIRECT target work with vlan-on-top-of-bridge interfaces. When no
2764 matching vlan interface is found, or this switch is off, the input
2765 device is set to the bridge interface.
2766
2767 - 0: disable bridge netfilter vlan interface lookup.
2768
4981682c 2769 Default: 0
1da177e4 2770
1cec2cac
MCC
2771``proc/sys/net/sctp/*`` Variables:
2772==================================
32e8d494
VY
2773
2774addip_enable - BOOLEAN
2775 Enable or disable extension of Dynamic Address Reconfiguration
2776 (ADD-IP) functionality specified in RFC5061. This extension provides
2777 the ability to dynamically add and remove new addresses for the SCTP
2778 associations.
2779
2780 1: Enable extension.
2781
2782 0: Disable extension.
2783
2784 Default: 0
2785
566178f8
ZY
2786pf_enable - INTEGER
2787 Enable or disable pf (pf is short for potentially failed) state. A value
2788 of pf_retrans > path_max_retrans also disables pf state. That is, one of
2789 both pf_enable and pf_retrans > path_max_retrans can disable pf state.
2790 Since pf_retrans and path_max_retrans can be changed by userspace
2791 application, sometimes user expects to disable pf state by the value of
2792 pf_retrans > path_max_retrans, but occasionally the value of pf_retrans
2793 or path_max_retrans is changed by the user application, this pf state is
2794 enabled. As such, it is necessary to add this to dynamically enable
2795 and disable pf state. See:
2796 https://datatracker.ietf.org/doc/draft-ietf-tsvwg-sctp-failover for
2797 details.
2798
2799 1: Enable pf.
2800
2801 0: Disable pf.
2802
2803 Default: 1
2804
aef587be
XL
2805pf_expose - INTEGER
2806 Unset or enable/disable pf (pf is short for potentially failed) state
2807 exposure. Applications can control the exposure of the PF path state
2808 in the SCTP_PEER_ADDR_CHANGE event and the SCTP_GET_PEER_ADDR_INFO
2809 sockopt. When it's unset, no SCTP_PEER_ADDR_CHANGE event with
2810 SCTP_ADDR_PF state will be sent and a SCTP_PF-state transport info
2811 can be got via SCTP_GET_PEER_ADDR_INFO sockopt; When it's enabled,
2812 a SCTP_PEER_ADDR_CHANGE event will be sent for a transport becoming
2813 SCTP_PF state and a SCTP_PF-state transport info can be got via
a266ef69 2814 SCTP_GET_PEER_ADDR_INFO sockopt; When it's disabled, no
aef587be
XL
2815 SCTP_PEER_ADDR_CHANGE event will be sent and it returns -EACCES when
2816 trying to get a SCTP_PF-state transport info via SCTP_GET_PEER_ADDR_INFO
2817 sockopt.
2818
2819 0: Unset pf state exposure, Compatible with old applications.
2820
2821 1: Disable pf state exposure.
2822
2823 2: Enable pf state exposure.
2824
2825 Default: 0
2826
32e8d494
VY
2827addip_noauth_enable - BOOLEAN
2828 Dynamic Address Reconfiguration (ADD-IP) requires the use of
2829 authentication to protect the operations of adding or removing new
2830 addresses. This requirement is mandated so that unauthorized hosts
2831 would not be able to hijack associations. However, older
2832 implementations may not have implemented this requirement while
2833 allowing the ADD-IP extension. For reasons of interoperability,
2834 we provide this variable to control the enforcement of the
2835 authentication requirement.
2836
1cec2cac
MCC
2837 == ===============================================================
2838 1 Allow ADD-IP extension to be used without authentication. This
32e8d494
VY
2839 should only be set in a closed environment for interoperability
2840 with older implementations.
2841
1cec2cac
MCC
2842 0 Enforce the authentication requirement
2843 == ===============================================================
32e8d494
VY
2844
2845 Default: 0
2846
2847auth_enable - BOOLEAN
2848 Enable or disable Authenticated Chunks extension. This extension
2849 provides the ability to send and receive authenticated chunks and is
2850 required for secure operation of Dynamic Address Reconfiguration
2851 (ADD-IP) extension.
2852
1cec2cac
MCC
2853 - 1: Enable this extension.
2854 - 0: Disable this extension.
32e8d494
VY
2855
2856 Default: 0
2857
2858prsctp_enable - BOOLEAN
2859 Enable or disable the Partial Reliability extension (RFC3758) which
2860 is used to notify peers that a given DATA should no longer be expected.
2861
1cec2cac
MCC
2862 - 1: Enable extension
2863 - 0: Disable
32e8d494
VY
2864
2865 Default: 1
2866
2867max_burst - INTEGER
2868 The limit of the number of new packets that can be initially sent. It
2869 controls how bursty the generated traffic can be.
2870
2871 Default: 4
2872
2873association_max_retrans - INTEGER
2874 Set the maximum number for retransmissions that an association can
2875 attempt deciding that the remote end is unreachable. If this value
2876 is exceeded, the association is terminated.
2877
2878 Default: 10
2879
2880max_init_retransmits - INTEGER
2881 The maximum number of retransmissions of INIT and COOKIE-ECHO chunks
2882 that an association will attempt before declaring the destination
2883 unreachable and terminating.
2884
2885 Default: 8
2886
2887path_max_retrans - INTEGER
2888 The maximum number of retransmissions that will be attempted on a given
2889 path. Once this threshold is exceeded, the path is considered
2890 unreachable, and new traffic will use a different path when the
2891 association is multihomed.
2892
2893 Default: 5
2894
5aa93bcf
NH
2895pf_retrans - INTEGER
2896 The number of retransmissions that will be attempted on a given path
2897 before traffic is redirected to an alternate transport (should one
2898 exist). Note this is distinct from path_max_retrans, as a path that
2899 passes the pf_retrans threshold can still be used. Its only
2900 deprioritized when a transmission path is selected by the stack. This
2901 setting is primarily used to enable fast failover mechanisms without
2902 having to reduce path_max_retrans to a very low value. See:
2903 http://www.ietf.org/id/draft-nishida-tsvwg-sctp-failover-05.txt
2904 for details. Note also that a value of pf_retrans > path_max_retrans
566178f8
ZY
2905 disables this feature. Since both pf_retrans and path_max_retrans can
2906 be changed by userspace application, a variable pf_enable is used to
2907 disable pf state.
5aa93bcf
NH
2908
2909 Default: 0
2910
34515e94
XL
2911ps_retrans - INTEGER
2912 Primary.Switchover.Max.Retrans (PSMR), it's a tunable parameter coming
2913 from section-5 "Primary Path Switchover" in rfc7829. The primary path
2914 will be changed to another active path when the path error counter on
2915 the old primary path exceeds PSMR, so that "the SCTP sender is allowed
2916 to continue data transmission on a new working path even when the old
2917 primary destination address becomes active again". Note this feature
2918 is disabled by initializing 'ps_retrans' per netns as 0xffff by default,
2919 and its value can't be less than 'pf_retrans' when changing by sysctl.
2920
2921 Default: 0xffff
2922
32e8d494
VY
2923rto_initial - INTEGER
2924 The initial round trip timeout value in milliseconds that will be used
2925 in calculating round trip times. This is the initial time interval
2926 for retransmissions.
2927
2928 Default: 3000
1da177e4 2929
32e8d494
VY
2930rto_max - INTEGER
2931 The maximum value (in milliseconds) of the round trip timeout. This
2932 is the largest time interval that can elapse between retransmissions.
2933
2934 Default: 60000
2935
2936rto_min - INTEGER
2937 The minimum value (in milliseconds) of the round trip timeout. This
2938 is the smallest time interval the can elapse between retransmissions.
2939
2940 Default: 1000
2941
2942hb_interval - INTEGER
2943 The interval (in milliseconds) between HEARTBEAT chunks. These chunks
2944 are sent at the specified interval on idle paths to probe the state of
2945 a given path between 2 associations.
2946
2947 Default: 30000
2948
2949sack_timeout - INTEGER
2950 The amount of time (in milliseconds) that the implementation will wait
2951 to send a SACK.
2952
2953 Default: 200
2954
2955valid_cookie_life - INTEGER
2956 The default lifetime of the SCTP cookie (in milliseconds). The cookie
2957 is used during association establishment.
2958
2959 Default: 60000
2960
2961cookie_preserve_enable - BOOLEAN
2962 Enable or disable the ability to extend the lifetime of the SCTP cookie
2963 that is used during the establishment phase of SCTP association
2964
1cec2cac
MCC
2965 - 1: Enable cookie lifetime extension.
2966 - 0: Disable
32e8d494
VY
2967
2968 Default: 1
2969
3c68198e
NH
2970cookie_hmac_alg - STRING
2971 Select the hmac algorithm used when generating the cookie value sent by
2972 a listening sctp socket to a connecting client in the INIT-ACK chunk.
2973 Valid values are:
1cec2cac 2974
3c68198e
NH
2975 * md5
2976 * sha1
2977 * none
1cec2cac 2978
3c68198e 2979 Ability to assign md5 or sha1 as the selected alg is predicated on the
3b09adcb 2980 configuration of those algorithms at build time (CONFIG_CRYPTO_MD5 and
3c68198e
NH
2981 CONFIG_CRYPTO_SHA1).
2982
2983 Default: Dependent on configuration. MD5 if available, else SHA1 if
2984 available, else none.
2985
32e8d494
VY
2986rcvbuf_policy - INTEGER
2987 Determines if the receive buffer is attributed to the socket or to
2988 association. SCTP supports the capability to create multiple
2989 associations on a single socket. When using this capability, it is
2990 possible that a single stalled association that's buffering a lot
2991 of data may block other associations from delivering their data by
2992 consuming all of the receive buffer space. To work around this,
2993 the rcvbuf_policy could be set to attribute the receiver buffer space
2994 to each association instead of the socket. This prevents the described
2995 blocking.
2996
1cec2cac
MCC
2997 - 1: rcvbuf space is per association
2998 - 0: rcvbuf space is per socket
32e8d494
VY
2999
3000 Default: 0
3001
3002sndbuf_policy - INTEGER
3003 Similar to rcvbuf_policy above, this applies to send buffer space.
3004
1cec2cac
MCC
3005 - 1: Send buffer is tracked per association
3006 - 0: Send buffer is tracked per socket.
32e8d494
VY
3007
3008 Default: 0
3009
3010sctp_mem - vector of 3 INTEGERs: min, pressure, max
3011 Number of pages allowed for queueing by all SCTP sockets.
3012
3013 min: Below this number of pages SCTP is not bothered about its
3014 memory appetite. When amount of memory allocated by SCTP exceeds
3015 this number, SCTP starts to moderate memory usage.
3016
3017 pressure: This value was introduced to follow format of tcp_mem.
3018
3019 max: Number of pages allowed for queueing by all SCTP sockets.
3020
3021 Default is calculated at boot time from amount of available memory.
3022
3023sctp_rmem - vector of 3 INTEGERs: min, default, max
a6e1204b
MM
3024 Only the first value ("min") is used, "default" and "max" are
3025 ignored.
3026
3027 min: Minimal size of receive buffer used by SCTP socket.
3028 It is guaranteed to each SCTP socket (but not association) even
3029 under moderate memory pressure.
3030
320bd6de 3031 Default: 4K
32e8d494
VY
3032
3033sctp_wmem - vector of 3 INTEGERs: min, default, max
aa709da0
XL
3034 Only the first value ("min") is used, "default" and "max" are
3035 ignored.
3036
3037 min: Minimum size of send buffer that can be used by SCTP sockets.
3038 It is guaranteed to each SCTP socket (but not association) even
3039 under moderate memory pressure.
3040
3041 Default: 4K
32e8d494 3042
72388433
BD
3043addr_scope_policy - INTEGER
3044 Control IPv4 address scoping - draft-stewart-tsvwg-sctp-ipv4-00
3045
1cec2cac
MCC
3046 - 0 - Disable IPv4 address scoping
3047 - 1 - Enable IPv4 address scoping
3048 - 2 - Follow draft but allow IPv4 private addresses
3049 - 3 - Follow draft but allow IPv4 link local addresses
72388433
BD
3050
3051 Default: 1
3052
046c052b
XL
3053udp_port - INTEGER
3054 The listening port for the local UDP tunneling sock. Normally it's
3055 using the IANA-assigned UDP port number 9899 (sctp-tunneling).
3056
3057 This UDP sock is used for processing the incoming UDP-encapsulated
3058 SCTP packets (from RFC6951), and shared by all applications in the
3059 same net namespace. This UDP sock will be closed when the value is
3060 set to 0.
3061
3062 The value will also be used to set the src port of the UDP header
3063 for the outgoing UDP-encapsulated SCTP packets. For the dest port,
3064 please refer to 'encap_port' below.
3065
3066 Default: 0
3067
e8a3001c
XL
3068encap_port - INTEGER
3069 The default remote UDP encapsulation port.
3070
3071 This value is used to set the dest port of the UDP header for the
3072 outgoing UDP-encapsulated SCTP packets by default. Users can also
3073 change the value for each sock/asoc/transport by using setsockopt.
3074 For further information, please refer to RFC6951.
3075
3076 Note that when connecting to a remote server, the client should set
3077 this to the port that the UDP tunneling sock on the peer server is
3078 listening to and the local UDP tunneling sock on the client also
3079 must be started. On the server, it would get the encap_port from
3080 the incoming packet's source port.
3081
3082 Default: 0
3083
d1e462a7 3084plpmtud_probe_interval - INTEGER
fea1d5b1
XL
3085 The time interval (in milliseconds) for the PLPMTUD probe timer,
3086 which is configured to expire after this period to receive an
3087 acknowledgment to a probe packet. This is also the time interval
3088 between the probes for the current pmtu when the probe search
3089 is done.
3090
3091 PLPMTUD will be disabled when 0 is set, and other values for it
3092 must be >= 5000.
d1e462a7
XL
3093
3094 Default: 0
3095
c349ae5f
XL
3096reconf_enable - BOOLEAN
3097 Enable or disable extension of Stream Reconfiguration functionality
3098 specified in RFC6525. This extension provides the ability to "reset"
3099 a stream, and it includes the Parameters of "Outgoing/Incoming SSN
3100 Reset", "SSN/TSN Reset" and "Add Outgoing/Incoming Streams".
3101
3102 - 1: Enable extension.
3103 - 0: Disable extension.
3104
3105 Default: 0
3106
e65775fd
XL
3107intl_enable - BOOLEAN
3108 Enable or disable extension of User Message Interleaving functionality
3109 specified in RFC8260. This extension allows the interleaving of user
3110 messages sent on different streams. With this feature enabled, I-DATA
3111 chunk will replace DATA chunk to carry user messages if also supported
3112 by the peer. Note that to use this feature, one needs to set this option
3113 to 1 and also needs to set socket options SCTP_FRAGMENT_INTERLEAVE to 2
3114 and SCTP_INTERLEAVING_SUPPORTED to 1.
3115
3116 - 1: Enable extension.
3117 - 0: Disable extension.
3118
3119 Default: 0
3120
249eddaf
XL
3121ecn_enable - BOOLEAN
3122 Control use of Explicit Congestion Notification (ECN) by SCTP.
3123 Like in TCP, ECN is used only when both ends of the SCTP connection
3124 indicate support for it. This feature is useful in avoiding losses
3125 due to congestion by allowing supporting routers to signal congestion
3126 before having to drop packets.
3127
3128 1: Enable ecn.
3129 0: Disable ecn.
3130
3131 Default: 1
3132
b712d032
XL
3133l3mdev_accept - BOOLEAN
3134 Enabling this option allows a "global" bound socket to work
3135 across L3 master domains (e.g., VRFs) with packets capable of
3136 being received regardless of the L3 domain in which they
3137 originated. Only valid when the kernel was compiled with
3138 CONFIG_NET_L3_MASTER_DEV.
3139
3140 Default: 1 (enabled)
3141
1da177e4 3142
1cec2cac
MCC
3143``/proc/sys/net/core/*``
3144========================
3145
57043247 3146 Please see: Documentation/admin-guide/sysctl/net.rst for descriptions of these entries.
705efc3b 3147
4edc2f34 3148
1cec2cac
MCC
3149``/proc/sys/net/unix/*``
3150========================
3151
705efc3b
WT
3152max_dgram_qlen - INTEGER
3153 The maximum length of dgram socket receive queue
3154
3155 Default: 10
3156