blob: dbdc4130e1491ef7033114153f0fb2eff826461c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/proc/sys/net/ipv4/* Variables:
2
3ip_forward - BOOLEAN
4 0 - disabled (default)
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00005 not 0 - enabled
Linus Torvalds1da177e2005-04-16 15:20:36 -07006
7 Forward Packets between interfaces.
8
9 This variable is special, its change resets all configuration
10 parameters to their default state (RFC1122 for hosts, RFC1812
11 for routers)
12
13ip_default_ttl - INTEGER
Eric Dumazetcc6f02d2010-12-13 12:50:49 -080014 Default value of TTL field (Time To Live) for outgoing (but not
15 forwarded) IP packets. Should be between 1 and 255 inclusive.
16 Default: 64 (as recommended by RFC1700)
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
Hannes Frederic Sowacd174e62013-12-14 05:13:45 +010018ip_no_pmtu_disc - INTEGER
19 Disable Path MTU Discovery. If enabled in mode 1 and a
Hannes Frederic Sowa188b04d2013-12-14 04:42:13 +010020 fragmentation-required ICMP is received, the PMTU to this
21 destination will be set to min_pmtu (see below). You will need
22 to raise min_pmtu to the smallest interface MTU on your system
23 manually if you want to avoid locally generated fragments.
Hannes Frederic Sowacd174e62013-12-14 05:13:45 +010024
25 In mode 2 incoming Path MTU Discovery messages will be
26 discarded. Outgoing frames are handled the same as in mode 1,
27 implicitly setting IP_PMTUDISC_DONT on every created socket.
28
Hannes Frederic Sowa8ed1dc42014-01-09 10:01:17 +010029 Mode 3 is a hardend pmtu discover mode. The kernel will only
30 accept fragmentation-needed errors if the underlying protocol
31 can verify them besides a plain socket lookup. Current
32 protocols for which pmtu events will be honored are TCP, SCTP
33 and DCCP as they verify e.g. the sequence number or the
34 association. This mode should not be enabled globally but is
35 only intended to secure e.g. name servers in namespaces where
36 TCP path mtu must still work but path MTU information of other
37 protocols should be discarded. If enabled globally this mode
38 could break other protocols.
39
40 Possible values: 0-3
Hannes Frederic Sowa188b04d2013-12-14 04:42:13 +010041 Default: FALSE
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
43min_pmtu - INTEGER
Eric Dumazet20db93c2011-11-08 14:21:44 -050044 default 552 - minimum discovered Path MTU
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Hannes Frederic Sowaf87c10a2014-01-09 10:01:15 +010046ip_forward_use_pmtu - BOOLEAN
47 By default we don't trust protocol path MTUs while forwarding
48 because they could be easily forged and can lead to unwanted
49 fragmentation by the router.
50 You only need to enable this if you have user-space software
51 which tries to discover path mtus by itself and depends on the
52 kernel honoring this information. This is normally not the
53 case.
54 Default: 0 (disabled)
55 Possible values:
56 0 - disabled
57 1 - enabled
58
Loganaden Velvindron219b5f22014-11-04 03:02:49 -080059fwmark_reflect - BOOLEAN
60 Controls the fwmark of kernel-generated IPv4 reply packets that are not
61 associated with a socket for example, TCP RSTs or ICMP echo replies).
62 If unset, these packets have a fwmark of zero. If set, they have the
63 fwmark of the packet they are replying to.
64 Default: 0
65
David Aherna6db4492016-04-07 07:21:00 -070066fib_multipath_use_neigh - BOOLEAN
67 Use status of existing neighbor entry when determining nexthop for
68 multipath routes. If disabled, neighbor information is not used and
69 packets could be directed to a failed nexthop. Only valid for kernels
70 built with CONFIG_IP_ROUTE_MULTIPATH enabled.
71 Default: 0 (disabled)
72 Possible values:
73 0 - disabled
74 1 - enabled
75
Ben Greearcbaf0872010-11-08 09:13:48 +000076route/max_size - INTEGER
77 Maximum number of routes allowed in the kernel. Increase
78 this when using large numbers of interfaces and/or routes.
Ani Sinha25050c62015-01-07 15:45:56 -080079 From linux kernel 3.6 onwards, this is deprecated for ipv4
80 as route cache is no longer used.
Ben Greearcbaf0872010-11-08 09:13:48 +000081
YOSHIFUJI Hideaki / 吉藤英明27246802013-01-22 05:20:05 +000082neigh/default/gc_thresh1 - INTEGER
83 Minimum number of entries to keep. Garbage collector will not
84 purge entries if there are fewer than this number.
Li RongQingb66c66d2013-03-14 22:49:47 +000085 Default: 128
YOSHIFUJI Hideaki / 吉藤英明27246802013-01-22 05:20:05 +000086
stephen hemmingera3d12142014-08-25 15:05:30 -070087neigh/default/gc_thresh2 - INTEGER
88 Threshold when garbage collector becomes more aggressive about
89 purging entries. Entries older than 5 seconds will be cleared
90 when over this number.
91 Default: 512
92
Ben Greearcbaf0872010-11-08 09:13:48 +000093neigh/default/gc_thresh3 - INTEGER
94 Maximum number of neighbor entries allowed. Increase this
95 when using large numbers of interfaces and when communicating
96 with large numbers of directly-connected peers.
Shan Weicc868022012-12-04 18:50:35 +000097 Default: 1024
Ben Greearcbaf0872010-11-08 09:13:48 +000098
Eric Dumazet8b5c1712011-11-09 12:07:14 +000099neigh/default/unres_qlen_bytes - INTEGER
100 The maximum number of bytes which may be used by packets
101 queued for each unresolved address by other network layers.
102 (added in linux 3.3)
stephen hemminger3b09adc2013-01-03 07:50:29 +0000103 Setting negative value is meaningless and will return error.
Shan Weicc868022012-12-04 18:50:35 +0000104 Default: 65536 Bytes(64KB)
Eric Dumazet8b5c1712011-11-09 12:07:14 +0000105
106neigh/default/unres_qlen - INTEGER
107 The maximum number of packets which may be queued for each
108 unresolved address by other network layers.
109 (deprecated in linux 3.3) : use unres_qlen_bytes instead.
Shan Weicc868022012-12-04 18:50:35 +0000110 Prior to linux 3.3, the default value is 3 which may cause
Shan Wei5d248c42012-12-06 16:27:51 +0000111 unexpected packet loss. The current default value is calculated
Shan Weicc868022012-12-04 18:50:35 +0000112 according to default value of unres_qlen_bytes and true size of
113 packet.
114 Default: 31
Eric Dumazet8b5c1712011-11-09 12:07:14 +0000115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116mtu_expires - INTEGER
117 Time, in seconds, that cached PMTU information is kept.
118
119min_adv_mss - INTEGER
120 The advertised MSS depends on the first hop route MTU, but will
121 never be lower than this setting.
122
123IP Fragmentation:
124
Eric Dumazet7f617062018-10-10 12:30:00 -0700125ipfrag_high_thresh - LONG INTEGER
Eric Dumazet23ce9c52018-10-10 12:29:56 -0700126 Maximum memory used to reassemble IP fragments.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000127
Eric Dumazet7f617062018-10-10 12:30:00 -0700128ipfrag_low_thresh - LONG INTEGER
Eric Dumazet23ce9c52018-10-10 12:29:56 -0700129 (Obsolete since linux-4.17)
Florian Westphalb13d3cb2014-07-24 16:50:32 +0200130 Maximum memory used to reassemble IP fragments before the kernel
131 begins to remove incomplete fragment queues to free up resources.
132 The kernel still accepts new fragments for defragmentation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134ipfrag_time - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000135 Time in seconds to keep an IP fragment in memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Herbert Xu89cee8b2005-12-13 23:14:27 -0800137ipfrag_max_dist - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000138 ipfrag_max_dist is a non-negative integer value which defines the
139 maximum "disorder" which is allowed among fragments which share a
140 common IP source address. Note that reordering of packets is
141 not unusual, but if a large number of fragments arrive from a source
142 IP address while a particular fragment queue remains incomplete, it
143 probably indicates that one or more fragments belonging to that queue
144 have been lost. When ipfrag_max_dist is positive, an additional check
145 is done on fragments before they are added to a reassembly queue - if
146 ipfrag_max_dist (or more) fragments have arrived from a particular IP
147 address between additions to any IP fragment queue using that source
148 address, it's presumed that one or more fragments in the queue are
149 lost. The existing fragment queue will be dropped, and a new one
Herbert Xu89cee8b2005-12-13 23:14:27 -0800150 started. An ipfrag_max_dist value of zero disables this check.
151
152 Using a very small value, e.g. 1 or 2, for ipfrag_max_dist can
153 result in unnecessarily dropping fragment queues when normal
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000154 reordering of packets occurs, which could lead to poor application
155 performance. Using a very large value, e.g. 50000, increases the
156 likelihood of incorrectly reassembling IP fragments that originate
Herbert Xu89cee8b2005-12-13 23:14:27 -0800157 from different IP datagrams, which could result in data corruption.
158 Default: 64
159
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160INET peer storage:
161
162inet_peer_threshold - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000163 The approximate size of the storage. Starting from this threshold
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 entries will be thrown aggressively. This threshold also determines
165 entries' time-to-live and time intervals between garbage collection
166 passes. More entries, less time-to-live, less GC interval.
167
168inet_peer_minttl - INTEGER
169 Minimum time-to-live of entries. Should be enough to cover fragment
170 time-to-live on the reassembling side. This minimum time-to-live is
171 guaranteed if the pool size is less than inet_peer_threshold.
Stephen Hemminger77a538d2008-07-01 17:22:48 -0700172 Measured in seconds.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174inet_peer_maxttl - INTEGER
175 Maximum time-to-live of entries. Unused entries will expire after
176 this period of time if there is no memory pressure on the pool (i.e.
177 when the number of entries in the pool is very small).
Stephen Hemminger77a538d2008-07-01 17:22:48 -0700178 Measured in seconds.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000180TCP variables:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800182somaxconn - INTEGER
183 Limit of socket listen() backlog, known in userspace as SOMAXCONN.
184 Defaults to 128. See also tcp_max_syn_backlog for additional tuning
185 for TCP sockets.
186
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800187tcp_abort_on_overflow - BOOLEAN
188 If listening service is too slow to accept new connections,
189 reset them. Default state is FALSE. It means that if overflow
190 occurred due to a burst, connection will recover. Enable this
191 option _only_ if you are really sure that listening daemon
192 cannot be tuned to accept connections faster. Enabling this
193 option can harm clients of your server.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800195tcp_adv_win_scale - INTEGER
196 Count buffering overhead as bytes/2^tcp_adv_win_scale
197 (if tcp_adv_win_scale > 0) or bytes-bytes/2^(-tcp_adv_win_scale),
198 if it is <= 0.
Alexey Dobriyan0147fc02010-11-22 12:54:21 +0000199 Possible values are [-31, 31], inclusive.
Eric Dumazetb49960a2012-05-02 02:28:41 +0000200 Default: 1
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800201
202tcp_allowed_congestion_control - STRING
203 Show/set the congestion control choices available to non-privileged
204 processes. The list is a subset of those listed in
205 tcp_available_congestion_control.
206 Default is "reno" and the default setting (tcp_congestion_control).
207
208tcp_app_win - INTEGER
209 Reserve max(window/2^tcp_app_win, mss) of window for application
210 buffer. Value 0 is special, it means that nothing is reserved.
211 Default: 31
212
Eric Dumazetf54b3112013-12-05 22:36:05 -0800213tcp_autocorking - BOOLEAN
214 Enable TCP auto corking :
215 When applications do consecutive small write()/sendmsg() system calls,
216 we try to coalesce these small writes as much as possible, to lower
217 total amount of sent packets. This is done if at least one prior
218 packet for the flow is waiting in Qdisc queues or device transmit
219 queue. Applications can still use TCP_CORK for optimal behavior
220 when they know how/when to uncork their sockets.
221 Default : 1
222
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800223tcp_available_congestion_control - STRING
224 Shows the available congestion control choices that are registered.
225 More congestion control algorithms may be available as modules,
226 but not loaded.
227
John Heffner71599cd2007-02-27 10:03:56 -0800228tcp_base_mss - INTEGER
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700229 The initial value of search_low to be used by the packetization layer
230 Path MTU discovery (MTU probing). If MTU probing is enabled,
231 this is the initial MSS used by the connection.
John Heffner71599cd2007-02-27 10:03:56 -0800232
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800233tcp_congestion_control - STRING
234 Set the congestion control algorithm to be used for new
235 connections. The algorithm "reno" is always available, but
236 additional choices may be available based on kernel configuration.
237 Default is set as part of kernel configuration.
Eric Dumazetd8a6e652011-11-30 01:02:41 +0000238 For passive connections, the listener congestion control choice
239 is inherited.
240 [see setsockopt(listenfd, SOL_TCP, TCP_CONGESTION, "name" ...) ]
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800241
242tcp_dsack - BOOLEAN
243 Allows TCP to send "duplicate" SACKs.
244
Yuchung Chengeed530b2012-05-02 13:30:03 +0000245tcp_early_retrans - INTEGER
246 Enable Early Retransmit (ER), per RFC 5827. ER lowers the threshold
247 for triggering fast retransmit when the amount of outstanding data is
248 small and when no previously unsent data can be transmitted (such
Nandita Dukkipati6ba8a3b2013-03-11 10:00:43 +0000249 that limited transmit could be used). Also controls the use of
Masanari Iida3dd17ed2013-05-24 07:05:59 +0000250 Tail loss probe (TLP) that converts RTOs occurring due to tail
Nandita Dukkipati6ba8a3b2013-03-11 10:00:43 +0000251 losses into fast recovery (draft-dukkipati-tcpm-tcp-loss-probe-01).
Yuchung Chengeed530b2012-05-02 13:30:03 +0000252 Possible values:
253 0 disables ER
254 1 enables ER
255 2 enables ER but delays fast recovery and fast retransmit
256 by a fourth of RTT. This mitigates connection falsely
257 recovers when network has a small degree of reordering
258 (less than 3 packets).
Nandita Dukkipati6ba8a3b2013-03-11 10:00:43 +0000259 3 enables delayed ER and TLP.
260 4 enables TLP only.
261 Default: 3
Yuchung Chengeed530b2012-05-02 13:30:03 +0000262
Peter Chubb34a6ef32011-02-02 15:39:58 -0800263tcp_ecn - INTEGER
Rick Jones7e3a2dc2012-11-28 09:53:10 +0000264 Control use of Explicit Congestion Notification (ECN) by TCP.
265 ECN is used only when both ends of the TCP connection indicate
266 support for it. This feature is useful in avoiding losses due
267 to congestion by allowing supporting routers to signal
268 congestion before having to drop packets.
Ilpo Järvinen255cac92009-05-04 11:07:36 -0700269 Possible values are:
Rick Jones7e3a2dc2012-11-28 09:53:10 +0000270 0 Disable ECN. Neither initiate nor accept ECN.
Vijay Subramanian3d55b322013-01-09 12:21:30 +0000271 1 Enable ECN when requested by incoming connections and
272 also request ECN on outgoing connection attempts.
273 2 Enable ECN when requested by incoming connections
Rick Jones7e3a2dc2012-11-28 09:53:10 +0000274 but do not request ECN on outgoing connections.
Ilpo Järvinen255cac92009-05-04 11:07:36 -0700275 Default: 2
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800276
Daniel Borkmann49213552015-05-19 21:04:22 +0200277tcp_ecn_fallback - BOOLEAN
278 If the kernel detects that ECN connection misbehaves, enable fall
279 back to non-ECN. Currently, this knob implements the fallback
280 from RFC3168, section 6.1.1.1., but we reserve that in future,
281 additional detection mechanisms could be implemented under this
282 knob. The value is not used, if tcp_ecn or per route (or congestion
283 control) ECN settings are disabled.
284 Default: 1 (fallback enabled)
285
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800286tcp_fack - BOOLEAN
287 Enable FACK congestion avoidance and fast retransmission.
288 The value is not used, if tcp_sack is not enabled.
289
290tcp_fin_timeout - INTEGER
Rick Jonesd825da22012-12-10 11:33:00 +0000291 The length of time an orphaned (no longer referenced by any
292 application) connection will remain in the FIN_WAIT_2 state
293 before it is aborted at the local end. While a perfectly
294 valid "receive only" state for an un-orphaned connection, an
295 orphaned connection in FIN_WAIT_2 state could otherwise wait
296 forever for the remote to close its end of the connection.
297 Cf. tcp_max_orphans
298 Default: 60 seconds
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800299
Ilpo Järvinen89808062007-02-27 10:10:55 -0800300tcp_frto - INTEGER
Yuchung Chenge33099f2013-03-20 13:33:00 +0000301 Enables Forward RTO-Recovery (F-RTO) defined in RFC5682.
Ilpo Järvinencd998892007-09-20 11:35:26 -0700302 F-RTO is an enhanced recovery algorithm for TCP retransmission
Yuchung Chenge33099f2013-03-20 13:33:00 +0000303 timeouts. It is particularly beneficial in networks where the
304 RTT fluctuates (e.g., wireless). F-RTO is sender-side only
305 modification. It does not require any support from the peer.
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700306
Yuchung Chenge33099f2013-03-20 13:33:00 +0000307 By default it's enabled with a non-zero value. 0 disables F-RTO.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
Neal Cardwell032ee422015-02-06 16:04:38 -0500309tcp_invalid_ratelimit - INTEGER
310 Limit the maximal rate for sending duplicate acknowledgments
311 in response to incoming TCP packets that are for an existing
312 connection but that are invalid due to any of these reasons:
313
314 (a) out-of-window sequence number,
315 (b) out-of-window acknowledgment number, or
316 (c) PAWS (Protection Against Wrapped Sequence numbers) check failure
317
318 This can help mitigate simple "ack loop" DoS attacks, wherein
319 a buggy or malicious middlebox or man-in-the-middle can
320 rewrite TCP header fields in manner that causes each endpoint
321 to think that the other is sending invalid TCP segments, thus
322 causing each side to send an unterminating stream of duplicate
323 acknowledgments for invalid segments.
324
325 Using 0 disables rate-limiting of dupacks in response to
326 invalid segments; otherwise this value specifies the minimal
327 space between sending such dupacks, in milliseconds.
328
329 Default: 500 (milliseconds).
330
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331tcp_keepalive_time - INTEGER
332 How often TCP sends out keepalive messages when keepalive is enabled.
333 Default: 2hours.
334
335tcp_keepalive_probes - INTEGER
336 How many keepalive probes TCP sends out, until it decides that the
337 connection is broken. Default value: 9.
338
339tcp_keepalive_intvl - INTEGER
340 How frequently the probes are send out. Multiplied by
341 tcp_keepalive_probes it is time to kill not responding connection,
342 after probes started. Default value: 75sec i.e. connection
343 will be aborted after ~11 minutes of retries.
344
David Ahern6dd9a142015-12-16 13:20:44 -0800345tcp_l3mdev_accept - BOOLEAN
346 Enables child sockets to inherit the L3 master device index.
347 Enabling this option allows a "global" listen socket to work
348 across L3 master domains (e.g., VRFs) with connected sockets
349 derived from the listen socket to be bound to the L3 domain in
350 which the packets originated. Only valid when the kernel was
351 compiled with CONFIG_NET_L3_MASTER_DEV.
352
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800353tcp_low_latency - BOOLEAN
354 If set, the TCP stack makes decisions that prefer lower
355 latency as opposed to higher throughput. By default, this
356 option is not set meaning that higher throughput is preferred.
357 An example of an application where this default should be
358 changed would be a Beowulf compute cluster.
359 Default: 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
361tcp_max_orphans - INTEGER
362 Maximal number of TCP sockets not attached to any user file handle,
363 held by system. If this number is exceeded orphaned connections are
364 reset immediately and warning is printed. This limit exists
365 only to prevent simple DoS attacks, you _must_ not rely on this
366 or lower the limit artificially, but rather increase it
367 (probably, after increasing installed memory),
368 if network conditions require more than default value,
369 and tune network services to linger and kill such states
370 more aggressively. Let me to remind again: each orphan eats
371 up to ~64K of unswappable memory.
372
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373tcp_max_syn_backlog - INTEGER
Peter Pan(潘卫平)99b53bd2011-12-05 21:39:41 +0000374 Maximal number of remembered connection requests, which have not
375 received an acknowledgment from connecting client.
376 The minimal value is 128 for low memory machines, and it will
377 increase in proportion to the memory of machine.
378 If server suffers from overload, try increasing this number.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800380tcp_max_tw_buckets - INTEGER
381 Maximal number of timewait sockets held by system simultaneously.
382 If this number is exceeded time-wait socket is immediately destroyed
383 and warning is printed. This limit exists only to prevent
384 simple DoS attacks, you _must_ not lower the limit artificially,
385 but rather increase it (probably, after increasing installed memory),
386 if network conditions require more than default value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800388tcp_mem - vector of 3 INTEGERs: min, pressure, max
389 min: below this number of pages TCP is not bothered about its
390 memory appetite.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800392 pressure: when amount of memory allocated by TCP exceeds this number
393 of pages, TCP moderates its memory consumption and enters memory
394 pressure mode, which is exited when memory consumption falls
395 under "min".
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800397 max: number of pages allowed for queueing by all TCP sockets.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800399 Defaults are calculated at boot time from amount of available
400 memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
Yuchung Chengf6722582015-10-16 21:57:42 -0700402tcp_min_rtt_wlen - INTEGER
403 The window length of the windowed min filter to track the minimum RTT.
404 A shorter window lets a flow more quickly pick up new (higher)
405 minimum RTT when it is moved to a longer path (e.g., due to traffic
406 engineering). A longer window makes the filter more resistant to RTT
407 inflations such as transient congestion. The unit is seconds.
408 Default: 300
409
John Heffner71599cd2007-02-27 10:03:56 -0800410tcp_moderate_rcvbuf - BOOLEAN
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700411 If set, TCP performs receive buffer auto-tuning, attempting to
John Heffner71599cd2007-02-27 10:03:56 -0800412 automatically size the buffer (no greater than tcp_rmem[2]) to
413 match the size required by the path for full throughput. Enabled by
414 default.
415
416tcp_mtu_probing - INTEGER
417 Controls TCP Packetization-Layer Path MTU Discovery. Takes three
418 values:
419 0 - Disabled
420 1 - Disabled by default, enabled when an ICMP black hole detected
421 2 - Always enabled, use initial MSS of tcp_base_mss.
422
Fan Dufab42762015-03-06 11:18:25 +0800423tcp_probe_interval - INTEGER
424 Controls how often to start TCP Packetization-Layer Path MTU
425 Discovery reprobe. The default is reprobing every 10 minutes as
426 per RFC4821.
427
428tcp_probe_threshold - INTEGER
429 Controls when TCP Packetization-Layer Path MTU Discovery probing
430 will stop in respect to the width of search range in bytes. Default
431 is 8 bytes.
432
John Heffner71599cd2007-02-27 10:03:56 -0800433tcp_no_metrics_save - BOOLEAN
434 By default, TCP saves various connection metrics in the route cache
435 when the connection closes, so that connections established in the
436 near future can use these to set initial conditions. Usually, this
437 increases overall performance, but may sometimes cause performance
Simon Arlott0f035b82007-10-20 01:30:25 +0200438 degradation. If set, TCP will not cache metrics on closing
John Heffner71599cd2007-02-27 10:03:56 -0800439 connections.
440
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800441tcp_orphan_retries - INTEGER
Damian Lukowski5d789222009-09-01 10:24:04 +0000442 This value influences the timeout of a locally closed TCP connection,
443 when RTO retransmissions remain unacknowledged.
444 See tcp_retries2 for more details.
445
David S. Miller06b8fc52011-07-08 09:31:31 -0700446 The default value is 8.
Damian Lukowski5d789222009-09-01 10:24:04 +0000447 If your machine is a loaded WEB server,
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800448 you should think about lowering this value, such sockets
449 may consume significant resources. Cf. tcp_max_orphans.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
Yuchung Cheng4f41b1c2015-10-16 21:57:47 -0700451tcp_recovery - INTEGER
452 This value is a bitmap to enable various experimental loss recovery
453 features.
454
455 RACK: 0x1 enables the RACK loss detection for fast detection of lost
456 retransmissions and tail drops.
457
458 Default: 0x1
459
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460tcp_reordering - INTEGER
Eric Dumazetdca145f2014-10-27 21:45:24 -0700461 Initial reordering level of packets in a TCP stream.
462 TCP stack can then dynamically adjust flow reordering level
463 between this initial value and tcp_max_reordering
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000464 Default: 3
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
Eric Dumazetdca145f2014-10-27 21:45:24 -0700466tcp_max_reordering - INTEGER
467 Maximal reordering level of packets in a TCP stream.
468 300 is a fairly conservative value, but you might increase it
469 if paths are using per packet load balancing (like bonding rr mode)
470 Default: 300
471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472tcp_retrans_collapse - BOOLEAN
473 Bug-to-bug compatibility with some broken printers.
474 On retransmit try to send bigger packets to work around bugs in
475 certain TCP stacks.
476
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800477tcp_retries1 - INTEGER
Damian Lukowski5d789222009-09-01 10:24:04 +0000478 This value influences the time, after which TCP decides, that
479 something is wrong due to unacknowledged RTO retransmissions,
480 and reports this suspicion to the network layer.
481 See tcp_retries2 for more details.
482
483 RFC 1122 recommends at least 3 retransmissions, which is the
484 default.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800486tcp_retries2 - INTEGER
Damian Lukowski5d789222009-09-01 10:24:04 +0000487 This value influences the timeout of an alive TCP connection,
488 when RTO retransmissions remain unacknowledged.
489 Given a value of N, a hypothetical TCP connection following
490 exponential backoff with an initial RTO of TCP_RTO_MIN would
491 retransmit N times before killing the connection at the (N+1)th RTO.
492
493 The default value of 15 yields a hypothetical timeout of 924.6
494 seconds and is a lower bound for the effective timeout.
495 TCP will effectively time out at the first RTO which exceeds the
496 hypothetical timeout.
497
498 RFC 1122 recommends at least 100 seconds for the timeout,
499 which corresponds to a value of at least 8.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800501tcp_rfc1337 - BOOLEAN
502 If set, the TCP stack behaves conforming to RFC1337. If unset,
503 we are not conforming to RFC, but prevent TCP TIME_WAIT
504 assassination.
505 Default: 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
507tcp_rmem - vector of 3 INTEGERs: min, default, max
508 min: Minimal size of receive buffer used by TCP sockets.
509 It is guaranteed to each TCP socket, even under moderate memory
510 pressure.
Max Matveev6539fef2011-06-21 21:18:13 +0000511 Default: 1 page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
J. Bruce Fields53025f52008-07-10 16:47:41 -0700513 default: initial size of receive buffer used by TCP sockets.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 This value overrides net.core.rmem_default used by other protocols.
515 Default: 87380 bytes. This value results in window of 65535 with
516 default setting of tcp_adv_win_scale and tcp_app_win:0 and a bit
517 less for default tcp_app_win. See below about these variables.
518
519 max: maximal size of receive buffer allowed for automatically
520 selected receiver buffers for TCP socket. This value does not override
J. Bruce Fields53025f52008-07-10 16:47:41 -0700521 net.core.rmem_max. Calling setsockopt() with SO_RCVBUF disables
522 automatic tuning of that socket's receive buffer size, in which
523 case this value is ignored.
Eric Dumazetb49960a2012-05-02 02:28:41 +0000524 Default: between 87380B and 6MB, depending on RAM size.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800526tcp_sack - BOOLEAN
527 Enable select acknowledgments (SACKS).
Rick Jones15d99e02006-03-20 22:40:29 -0800528
David S. Miller35089bb2006-06-13 22:33:04 -0700529tcp_slow_start_after_idle - BOOLEAN
530 If set, provide RFC2861 behavior and time out the congestion
531 window after an idle period. An idle period is defined at
532 the current RTO. If unset, the congestion window will not
533 be timed out after an idle period.
534 Default: 1
535
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800536tcp_stdurg - BOOLEAN
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700537 Use the Host requirements interpretation of the TCP urgent pointer field.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800538 Most hosts use the older BSD interpretation, so if you turn this on
539 Linux might not communicate correctly with them.
540 Default: FALSE
541
542tcp_synack_retries - INTEGER
543 Number of times SYNACKs for a passive TCP connection attempt will
544 be retransmitted. Should not be higher than 255. Default value
Alex Bergmann6c9ff972012-08-31 02:48:31 +0000545 is 5, which corresponds to 31seconds till the last retransmission
546 with the current initial RTO of 1second. With this the final timeout
547 for a passive TCP connection will happen after 63seconds.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800548
549tcp_syncookies - BOOLEAN
Shan Weia3c910d2013-06-21 15:18:32 +0800550 Only valid when the kernel was compiled with CONFIG_SYN_COOKIES
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800551 Send out syncookies when the syn backlog queue of a socket
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700552 overflows. This is to prevent against the common 'SYN flood attack'
Shan Weia3c910d2013-06-21 15:18:32 +0800553 Default: 1
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800554
555 Note, that syncookies is fallback facility.
556 It MUST NOT be used to help highly loaded servers to stand
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700557 against legal connection rate. If you see SYN flood warnings
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800558 in your logs, but investigation shows that they occur
559 because of overload with legal connections, you should tune
560 another parameters until this warning disappear.
561 See: tcp_max_syn_backlog, tcp_synack_retries, tcp_abort_on_overflow.
562
563 syncookies seriously violate TCP protocol, do not allow
564 to use TCP extensions, can result in serious degradation
565 of some services (f.e. SMTP relaying), visible not by you,
566 but your clients and relays, contacting you. While you see
Stephen Hemminger4edc2f32008-07-10 16:50:26 -0700567 SYN flood warnings in logs not being really flooded, your server
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800568 is seriously misconfigured.
569
Hannes Frederic Sowa5ad37d52013-07-26 17:43:23 +0200570 If you want to test which effects syncookies have to your
571 network connections you can set this knob to 2 to enable
572 unconditionally generation of syncookies.
573
Yuchung Chengcf60af02012-07-19 06:43:09 +0000574tcp_fastopen - INTEGER
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700575 Enable TCP Fast Open (RFC7413) to send and accept data in the opening
576 SYN packet.
577
578 The client support is enabled by flag 0x1 (on by default). The client
579 then must use sendmsg() or sendto() with the MSG_FASTOPEN flag,
580 rather than connect() to send data in SYN.
581
582 The server support is enabled by flag 0x2 (off by default). Then
583 either enable for all listeners with another flag (0x400) or
584 enable individual listeners via TCP_FASTOPEN socket option with
585 the option value being the length of the syn-data backlog.
Yuchung Chengcf60af02012-07-19 06:43:09 +0000586
Jerry Chu10467162012-08-31 12:29:11 +0000587 The values (bitmap) are
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700588 0x1: (client) enables sending data in the opening SYN on the client.
589 0x2: (server) enables the server support, i.e., allowing data in
590 a SYN packet to be accepted and passed to the
591 application before 3-way handshake finishes.
592 0x4: (client) send data in the opening SYN regardless of cookie
593 availability and without a cookie option.
594 0x200: (server) accept data-in-SYN w/o any cookie option present.
595 0x400: (server) enable all listeners to support Fast Open by
596 default without explicit TCP_FASTOPEN socket option.
Yuchung Chengcf60af02012-07-19 06:43:09 +0000597
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700598 Default: 0x1
Yuchung Chengcf60af02012-07-19 06:43:09 +0000599
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700600 Note that that additional client or server features are only
601 effective if the basic support (0x1 and 0x2) are enabled respectively.
Jerry Chu10467162012-08-31 12:29:11 +0000602
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800603tcp_syn_retries - INTEGER
604 Number of times initial SYNs for an active TCP connection attempt
Xin Longbffae692016-01-20 16:12:33 +0800605 will be retransmitted. Should not be higher than 127. Default value
stephen hemminger3b09adc2013-01-03 07:50:29 +0000606 is 6, which corresponds to 63seconds till the last retransmission
Alex Bergmann6c9ff972012-08-31 02:48:31 +0000607 with the current initial RTO of 1second. With this the final timeout
608 for an active TCP connection attempt will happen after 127seconds.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800609
610tcp_timestamps - BOOLEAN
611 Enable timestamps as defined in RFC1323.
612
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700613tcp_min_tso_segs - INTEGER
614 Minimal number of segments per TSO frame.
615 Since linux-3.12, TCP does an automatic sizing of TSO frames,
616 depending on flow rate, instead of filling 64Kbytes packets.
617 For specific usages, it's possible to force TCP to build big
618 TSO frames. Note that TCP stack might split too big TSO packets
619 if available window is too small.
620 Default: 2
621
Eric Dumazet43e122b2015-08-21 17:38:02 -0700622tcp_pacing_ss_ratio - INTEGER
623 sk->sk_pacing_rate is set by TCP stack using a ratio applied
624 to current rate. (current_rate = cwnd * mss / srtt)
625 If TCP is in slow start, tcp_pacing_ss_ratio is applied
626 to let TCP probe for bigger speeds, assuming cwnd can be
627 doubled every other RTT.
628 Default: 200
629
630tcp_pacing_ca_ratio - INTEGER
631 sk->sk_pacing_rate is set by TCP stack using a ratio applied
632 to current rate. (current_rate = cwnd * mss / srtt)
633 If TCP is in congestion avoidance phase, tcp_pacing_ca_ratio
634 is applied to conservatively probe for bigger throughput.
635 Default: 120
636
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800637tcp_tso_win_divisor - INTEGER
638 This allows control over what percentage of the congestion window
639 can be consumed by a single TSO frame.
640 The setting of this parameter is a choice between burstiness and
641 building larger TSO frames.
642 Default: 3
643
644tcp_tw_recycle - BOOLEAN
645 Enable fast recycling TIME-WAIT sockets. Default value is 0.
646 It should not be changed without advice/request of technical
647 experts.
648
649tcp_tw_reuse - BOOLEAN
650 Allow to reuse TIME-WAIT sockets for new connections when it is
651 safe from protocol viewpoint. Default value is 0.
652 It should not be changed without advice/request of technical
653 experts.
654
655tcp_window_scaling - BOOLEAN
656 Enable window scaling as defined in RFC1323.
657
658tcp_wmem - vector of 3 INTEGERs: min, default, max
J. Bruce Fields53025f52008-07-10 16:47:41 -0700659 min: Amount of memory reserved for send buffers for TCP sockets.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800660 Each TCP socket has rights to use it due to fact of its birth.
Max Matveev6539fef2011-06-21 21:18:13 +0000661 Default: 1 page
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800662
J. Bruce Fields53025f52008-07-10 16:47:41 -0700663 default: initial size of send buffer used by TCP sockets. This
664 value overrides net.core.wmem_default used by other protocols.
665 It is usually lower than net.core.wmem_default.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800666 Default: 16K
667
J. Bruce Fields53025f52008-07-10 16:47:41 -0700668 max: Maximal amount of memory allowed for automatically tuned
669 send buffers for TCP sockets. This value does not override
670 net.core.wmem_max. Calling setsockopt() with SO_SNDBUF disables
671 automatic tuning of that socket's send buffer size, in which case
672 this value is ignored.
673 Default: between 64K and 4MB, depending on RAM size.
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800674
Eric Dumazetc9bee3b72013-07-22 20:27:07 -0700675tcp_notsent_lowat - UNSIGNED INTEGER
676 A TCP socket can control the amount of unsent bytes in its write queue,
677 thanks to TCP_NOTSENT_LOWAT socket option. poll()/select()/epoll()
678 reports POLLOUT events if the amount of unsent bytes is below a per
679 socket value, and if the write queue is not full. sendmsg() will
680 also not add new buffers if the limit is hit.
681
682 This global variable controls the amount of unsent data for
683 sockets not using TCP_NOTSENT_LOWAT. For these sockets, a change
684 to the global variable has immediate effect.
685
686 Default: UINT_MAX (0xFFFFFFFF)
687
Stephen Hemmingeref56e622006-11-09 16:37:26 -0800688tcp_workaround_signed_windows - BOOLEAN
689 If set, assume no receipt of a window scaling option means the
690 remote TCP is broken and treats the window as a signed quantity.
691 If unset, assume the remote TCP is not broken even if we do
692 not receive a window scaling option from them.
693 Default: 0
694
Andreas Petlund36e31b0a2010-02-18 02:47:01 +0000695tcp_thin_linear_timeouts - BOOLEAN
696 Enable dynamic triggering of linear timeouts for thin streams.
697 If set, a check is performed upon retransmission by timeout to
698 determine if the stream is thin (less than 4 packets in flight).
699 As long as the stream is found to be thin, up to 6 linear
700 timeouts may be performed before exponential backoff mode is
701 initiated. This improves retransmission latency for
702 non-aggressive thin streams, often found to be time-dependent.
703 For more information on thin streams, see
704 Documentation/networking/tcp-thin.txt
705 Default: 0
706
Andreas Petlund7e380172010-02-18 04:48:19 +0000707tcp_thin_dupack - BOOLEAN
708 Enable dynamic triggering of retransmissions after one dupACK
709 for thin streams. If set, a check is performed upon reception
710 of a dupACK to determine if the stream is thin (less than 4
711 packets in flight). As long as the stream is found to be thin,
712 data is retransmitted on the first received dupACK. This
713 improves retransmission latency for non-aggressive thin
714 streams, often found to be time-dependent.
715 For more information on thin streams, see
716 Documentation/networking/tcp-thin.txt
717 Default: 0
718
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000719tcp_limit_output_bytes - INTEGER
720 Controls TCP Small Queue limit per tcp socket.
721 TCP bulk sender tends to increase packets in flight until it
722 gets losses notifications. With SNDBUF autotuning, this can
723 result in a large amount of packets queued in qdisc/device
724 on the local machine, hurting latency of other flows, for
725 typical pfifo_fast qdiscs.
726 tcp_limit_output_bytes limits the number of bytes on qdisc
727 or device to reduce artificial RTT/cwnd and reduce bufferbloat.
Niklas Cassel821b4142015-11-09 15:59:00 +0100728 Default: 262144
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000729
Eric Dumazet282f23c2012-07-17 10:13:05 +0200730tcp_challenge_ack_limit - INTEGER
731 Limits number of Challenge ACK sent per second, as recommended
732 in RFC 5961 (Improving TCP's Robustness to Blind In-Window Attacks)
733 Default: 100
734
Hideo Aoki95766ff2007-12-31 00:29:24 -0800735UDP variables:
736
737udp_mem - vector of 3 INTEGERs: min, pressure, max
738 Number of pages allowed for queueing by all UDP sockets.
739
740 min: Below this number of pages UDP is not bothered about its
741 memory appetite. When amount of memory allocated by UDP exceeds
742 this number, UDP starts to moderate memory usage.
743
744 pressure: This value was introduced to follow format of tcp_mem.
745
746 max: Number of pages allowed for queueing by all UDP sockets.
747
748 Default is calculated at boot time from amount of available memory.
749
750udp_rmem_min - INTEGER
751 Minimal size of receive buffer used by UDP sockets in moderation.
752 Each UDP socket is able to use the size for receiving data, even if
753 total pages of UDP sockets exceed udp_mem pressure. The unit is byte.
Max Matveev6539fef2011-06-21 21:18:13 +0000754 Default: 1 page
Hideo Aoki95766ff2007-12-31 00:29:24 -0800755
756udp_wmem_min - INTEGER
757 Minimal size of send buffer used by UDP sockets in moderation.
758 Each UDP socket is able to use the size for sending data, even if
759 total pages of UDP sockets exceed udp_mem pressure. The unit is byte.
Max Matveev6539fef2011-06-21 21:18:13 +0000760 Default: 1 page
Hideo Aoki95766ff2007-12-31 00:29:24 -0800761
Paul Moore8802f612006-08-03 16:45:49 -0700762CIPSOv4 Variables:
763
764cipso_cache_enable - BOOLEAN
765 If set, enable additions to and lookups from the CIPSO label mapping
766 cache. If unset, additions are ignored and lookups always result in a
767 miss. However, regardless of the setting the cache is still
768 invalidated when required when means you can safely toggle this on and
769 off and the cache will always be "safe".
770 Default: 1
771
772cipso_cache_bucket_size - INTEGER
773 The CIPSO label cache consists of a fixed size hash table with each
774 hash bucket containing a number of cache entries. This variable limits
775 the number of entries in each hash bucket; the larger the value the
776 more CIPSO label mappings that can be cached. When the number of
777 entries in a given hash bucket reaches this limit adding new entries
778 causes the oldest entry in the bucket to be removed to make room.
779 Default: 10
780
781cipso_rbm_optfmt - BOOLEAN
782 Enable the "Optimized Tag 1 Format" as defined in section 3.4.2.6 of
783 the CIPSO draft specification (see Documentation/netlabel for details).
784 This means that when set the CIPSO tag will be padded with empty
785 categories in order to make the packet data 32-bit aligned.
786 Default: 0
787
788cipso_rbm_structvalid - BOOLEAN
789 If set, do a very strict check of the CIPSO option when
790 ip_options_compile() is called. If unset, relax the checks done during
791 ip_options_compile(). Either way is "safe" as errors are caught else
792 where in the CIPSO processing code but setting this to 0 (False) should
793 result in less work (i.e. it should be faster) but could cause problems
794 with other implementations that require strict checking.
795 Default: 0
796
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797IP Variables:
798
799ip_local_port_range - 2 INTEGERS
800 Defines the local port range that is used by TCP and UDP to
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000801 choose the local port. The first number is the first, the
Eric Dumazet07f4c902015-05-24 14:49:35 -0700802 second the last local port number.
803 If possible, it is better these numbers have different parity.
804 (one even and one odd values)
805 The default values are 32768 and 60999 respectively.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806
Amerigo Wange3826f12010-05-05 00:27:06 +0000807ip_local_reserved_ports - list of comma separated ranges
808 Specify the ports which are reserved for known third-party
809 applications. These ports will not be used by automatic port
810 assignments (e.g. when calling connect() or bind() with port
811 number 0). Explicit port allocation behavior is unchanged.
812
813 The format used for both input and output is a comma separated
814 list of ranges (e.g. "1,2-4,10-10" for ports 1, 2, 3, 4 and
815 10). Writing to the file will clear all previously reserved
816 ports and update the current list with the one given in the
817 input.
818
819 Note that ip_local_port_range and ip_local_reserved_ports
820 settings are independent and both are considered by the kernel
821 when determining which ports are available for automatic port
822 assignments.
823
824 You can reserve ports which are not in the current
825 ip_local_port_range, e.g.:
826
827 $ cat /proc/sys/net/ipv4/ip_local_port_range
Eric Dumazet07f4c902015-05-24 14:49:35 -0700828 32000 60999
Amerigo Wange3826f12010-05-05 00:27:06 +0000829 $ cat /proc/sys/net/ipv4/ip_local_reserved_ports
830 8080,9148
831
832 although this is redundant. However such a setting is useful
833 if later the port range is changed to a value that will
834 include the reserved ports.
835
836 Default: Empty
837
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838ip_nonlocal_bind - BOOLEAN
839 If set, allows processes to bind() to non-local IP addresses,
840 which can be quite useful - but may break some applications.
841 Default: 0
842
843ip_dynaddr - BOOLEAN
844 If set non-zero, enables support for dynamic addresses.
845 If set to a non-zero value larger than 1, a kernel log
846 message will be printed when dynamic address rewriting
847 occurs.
848 Default: 0
849
Cong Wange3d73bc2013-06-11 18:54:39 +0800850ip_early_demux - BOOLEAN
851 Optimize input packet processing down to one demux for
852 certain kinds of local sockets. Currently we only do this
853 for established TCP sockets.
854
855 It may add an additional cost for pure routing workloads that
856 reduces overall throughput, in such case you should disable it.
857 Default: 1
858
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859icmp_echo_ignore_all - BOOLEAN
David S. Miller7ce312462005-10-03 16:07:30 -0700860 If set non-zero, then the kernel will ignore all ICMP ECHO
861 requests sent to it.
862 Default: 0
863
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864icmp_echo_ignore_broadcasts - BOOLEAN
David S. Miller7ce312462005-10-03 16:07:30 -0700865 If set non-zero, then the kernel will ignore all ICMP ECHO and
866 TIMESTAMP requests sent to it via broadcast/multicast.
867 Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868
869icmp_ratelimit - INTEGER
870 Limit the maximal rates for sending ICMP packets whose type matches
871 icmp_ratemask (see below) to specific targets.
Stephen Hemminger6dbf4bc2008-07-01 19:29:07 -0700872 0 to disable any limiting,
873 otherwise the minimal space between responses in milliseconds.
Eric Dumazet4cdf5072014-09-19 07:38:40 -0700874 Note that another sysctl, icmp_msgs_per_sec limits the number
875 of ICMP packets sent on all targets.
Stephen Hemminger6dbf4bc2008-07-01 19:29:07 -0700876 Default: 1000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877
Eric Dumazet4cdf5072014-09-19 07:38:40 -0700878icmp_msgs_per_sec - INTEGER
879 Limit maximal number of ICMP packets sent per second from this host.
880 Only messages whose type matches icmp_ratemask (see below) are
881 controlled by this limit.
882 Default: 1000
883
884icmp_msgs_burst - INTEGER
885 icmp_msgs_per_sec controls number of ICMP packets sent per second,
886 while icmp_msgs_burst controls the burst size of these packets.
887 Default: 50
888
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889icmp_ratemask - INTEGER
890 Mask made of ICMP types for which rates are being limited.
891 Significant bits: IHGFEDCBA9876543210
892 Default mask: 0000001100000011000 (6168)
893
894 Bit definitions (see include/linux/icmp.h):
895 0 Echo Reply
896 3 Destination Unreachable *
897 4 Source Quench *
898 5 Redirect
899 8 Echo Request
900 B Time Exceeded *
901 C Parameter Problem *
902 D Timestamp Request
903 E Timestamp Reply
904 F Info Request
905 G Info Reply
906 H Address Mask Request
907 I Address Mask Reply
908
909 * These are rate limited by default (see default mask above)
910
911icmp_ignore_bogus_error_responses - BOOLEAN
912 Some routers violate RFC1122 by sending bogus responses to broadcast
913 frames. Such violations are normally logged via a kernel warning.
914 If this is set to TRUE, the kernel will not give such warnings, which
915 will avoid log file clutter.
Rami Rosene8b265e2013-06-07 20:16:19 +0000916 Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
Horms95f7daf2006-02-02 17:02:25 -0800918icmp_errors_use_inbound_ifaddr - BOOLEAN
919
Paolo Abeni02a6d612015-10-14 14:25:53 +0200920 If zero, icmp error messages are sent with the primary address of
921 the exiting interface.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000922
Horms95f7daf2006-02-02 17:02:25 -0800923 If non-zero, the message will be sent with the primary address of
924 the interface that received the packet that caused the icmp error.
925 This is the behaviour network many administrators will expect from
926 a router. And it can make debugging complicated network layouts
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000927 much easier.
Horms95f7daf2006-02-02 17:02:25 -0800928
929 Note that if no primary address exists for the interface selected,
930 then the primary address of the first non-loopback interface that
Matt LaPlanted6bc8ac2006-10-03 22:54:15 +0200931 has one will be used regardless of this setting.
Horms95f7daf2006-02-02 17:02:25 -0800932
933 Default: 0
934
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935igmp_max_memberships - INTEGER
936 Change the maximum number of multicast groups we can subscribe to.
937 Default: 20
938
Jeremy Ederd67ef352010-11-15 05:41:31 +0000939 Theoretical maximum value is bounded by having to send a membership
940 report in a single datagram (i.e. the report can't span multiple
941 datagrams, or risk confusing the switch and leaving groups you don't
942 intend to).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943
Jeremy Ederd67ef352010-11-15 05:41:31 +0000944 The number of supported groups 'M' is bounded by the number of group
945 report entries you can fit into a single datagram of 65535 bytes.
946
947 M = 65536-sizeof (ip header)/(sizeof(Group record))
948
949 Group records are variable length, with a minimum of 12 bytes.
950 So net.ipv4.igmp_max_memberships should not be set higher than:
951
952 (65536-24) / 12 = 5459
953
954 The value 5459 assumes no IP header options, so in practice
955 this number may be lower.
956
Benjamin Poirier537377d2016-03-21 13:21:40 -0700957igmp_max_msf - INTEGER
958 Maximum number of addresses allowed in the source filter list for a
959 multicast group.
960 Default: 10
961
Hannes Frederic Sowaa9fe8e22014-09-02 15:49:26 +0200962igmp_qrv - INTEGER
Benjamin Poirier537377d2016-03-21 13:21:40 -0700963 Controls the IGMP query robustness variable (see RFC2236 8.1).
964 Default: 2 (as specified by RFC2236 8.1)
965 Minimum: 1 (as specified by RFC6636 4.5)
Hannes Frederic Sowaa9fe8e22014-09-02 15:49:26 +0200966
Benjamin Poirier6b226e22016-03-21 13:21:39 -0700967conf/interface/* changes special settings per interface (where
968"interface" is the name of your network interface)
969
970conf/all/* is special, changes the settings for all interfaces
971
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972log_martians - BOOLEAN
973 Log packets with impossible addresses to kernel log.
974 log_martians for the interface will be enabled if at least one of
975 conf/{all,interface}/log_martians is set to TRUE,
976 it will be disabled otherwise
977
978accept_redirects - BOOLEAN
979 Accept ICMP redirect messages.
980 accept_redirects for the interface will be enabled if:
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000981 - both conf/{all,interface}/accept_redirects are TRUE in the case
982 forwarding for the interface is enabled
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 or
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000984 - at least one of conf/{all,interface}/accept_redirects is TRUE in the
985 case forwarding for the interface is disabled
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 accept_redirects for the interface will be disabled otherwise
987 default TRUE (host)
988 FALSE (router)
989
990forwarding - BOOLEAN
991 Enable IP forwarding on this interface.
992
993mc_forwarding - BOOLEAN
994 Do multicast routing. The kernel needs to be compiled with CONFIG_MROUTE
995 and a multicast routing daemon is required.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +0000996 conf/all/mc_forwarding must also be set to TRUE to enable multicast
997 routing for the interface
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
999medium_id - INTEGER
1000 Integer value used to differentiate the devices by the medium they
1001 are attached to. Two devices can have different id values when
1002 the broadcast packets are received only on one of them.
1003 The default value 0 means that the device is the only interface
1004 to its medium, value of -1 means that medium is not known.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001005
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 Currently, it is used to change the proxy_arp behavior:
1007 the proxy_arp feature is enabled for packets forwarded between
1008 two devices attached to different media.
1009
1010proxy_arp - BOOLEAN
1011 Do proxy arp.
1012 proxy_arp for the interface will be enabled if at least one of
1013 conf/{all,interface}/proxy_arp is set to TRUE,
1014 it will be disabled otherwise
1015
Jesper Dangaard Brouer65324142010-01-05 05:50:47 +00001016proxy_arp_pvlan - BOOLEAN
1017 Private VLAN proxy arp.
1018 Basically allow proxy arp replies back to the same interface
1019 (from which the ARP request/solicitation was received).
1020
1021 This is done to support (ethernet) switch features, like RFC
1022 3069, where the individual ports are NOT allowed to
1023 communicate with each other, but they are allowed to talk to
1024 the upstream router. As described in RFC 3069, it is possible
1025 to allow these hosts to communicate through the upstream
1026 router by proxy_arp'ing. Don't need to be used together with
1027 proxy_arp.
1028
1029 This technology is known by different names:
1030 In RFC 3069 it is called VLAN Aggregation.
1031 Cisco and Allied Telesyn call it Private VLAN.
1032 Hewlett-Packard call it Source-Port filtering or port-isolation.
1033 Ericsson call it MAC-Forced Forwarding (RFC Draft).
1034
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035shared_media - BOOLEAN
1036 Send(router) or accept(host) RFC1620 shared media redirects.
Eric Garver176b3462016-05-26 12:28:05 -04001037 Overrides secure_redirects.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 shared_media for the interface will be enabled if at least one of
1039 conf/{all,interface}/shared_media is set to TRUE,
1040 it will be disabled otherwise
1041 default TRUE
1042
1043secure_redirects - BOOLEAN
Eric Garver176b3462016-05-26 12:28:05 -04001044 Accept ICMP redirect messages only to gateways listed in the
1045 interface's current gateway list. Even if disabled, RFC1122 redirect
1046 rules still apply.
1047 Overridden by shared_media.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 secure_redirects for the interface will be enabled if at least one of
1049 conf/{all,interface}/secure_redirects is set to TRUE,
1050 it will be disabled otherwise
1051 default TRUE
1052
1053send_redirects - BOOLEAN
1054 Send redirects, if router.
1055 send_redirects for the interface will be enabled if at least one of
1056 conf/{all,interface}/send_redirects is set to TRUE,
1057 it will be disabled otherwise
1058 Default: TRUE
1059
1060bootp_relay - BOOLEAN
1061 Accept packets with source address 0.b.c.d destined
1062 not to this host as local ones. It is supposed, that
1063 BOOTP relay daemon will catch and forward such packets.
1064 conf/all/bootp_relay must also be set to TRUE to enable BOOTP relay
1065 for the interface
1066 default FALSE
1067 Not Implemented Yet.
1068
1069accept_source_route - BOOLEAN
1070 Accept packets with SRR option.
1071 conf/all/accept_source_route must also be set to TRUE to accept packets
1072 with SRR option on the interface
1073 default TRUE (router)
1074 FALSE (host)
1075
Patrick McHardy8153a102009-12-03 01:25:58 +00001076accept_local - BOOLEAN
Sébastien Barré72b126a2014-09-10 18:20:23 +02001077 Accept packets with local source addresses. In combination with
1078 suitable routing, this can be used to direct packets between two
1079 local interfaces over the wire and have them accepted properly.
Patrick McHardy8153a102009-12-03 01:25:58 +00001080 default FALSE
1081
Thomas Grafd0daebc32012-06-12 00:44:01 +00001082route_localnet - BOOLEAN
1083 Do not consider loopback addresses as martian source or destination
1084 while routing. This enables the use of 127/8 for local routing purposes.
1085 default FALSE
1086
Stephen Hemmingerc1cf8422009-02-20 08:25:36 +00001087rp_filter - INTEGER
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 0 - No source validation.
Stephen Hemmingerc1cf8422009-02-20 08:25:36 +00001089 1 - Strict mode as defined in RFC3704 Strict Reverse Path
1090 Each incoming packet is tested against the FIB and if the interface
1091 is not the best reverse path the packet check will fail.
1092 By default failed packets are discarded.
1093 2 - Loose mode as defined in RFC3704 Loose Reverse Path
1094 Each incoming packet's source address is also tested against the FIB
1095 and if the source address is not reachable via any interface
1096 the packet check will fail.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001098 Current recommended practice in RFC3704 is to enable strict mode
Jesper Dangaard Brouerbf869c32009-02-23 04:37:55 +00001099 to prevent IP spoofing from DDos attacks. If using asymmetric routing
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001100 or other complicated routing, then loose mode is recommended.
Stephen Hemmingerc1cf8422009-02-20 08:25:36 +00001101
Shan Wei1f5865e2009-12-02 15:39:04 -08001102 The max value from conf/{all,interface}/rp_filter is used
1103 when doing source validation on the {interface}.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104
1105 Default value is 0. Note that some distributions enable it
1106 in startup scripts.
1107
1108arp_filter - BOOLEAN
1109 1 - Allows you to have multiple network interfaces on the same
1110 subnet, and have the ARPs for each interface be answered
1111 based on whether or not the kernel would route a packet from
1112 the ARP'd IP out that interface (therefore you must use source
1113 based routing for this to work). In other words it allows control
1114 of which cards (usually 1) will respond to an arp request.
1115
1116 0 - (default) The kernel can respond to arp requests with addresses
1117 from other interfaces. This may seem wrong but it usually makes
1118 sense, because it increases the chance of successful communication.
1119 IP addresses are owned by the complete host on Linux, not by
1120 particular interfaces. Only for more complex setups like load-
1121 balancing, does this behaviour cause problems.
1122
1123 arp_filter for the interface will be enabled if at least one of
1124 conf/{all,interface}/arp_filter is set to TRUE,
1125 it will be disabled otherwise
1126
1127arp_announce - INTEGER
1128 Define different restriction levels for announcing the local
1129 source IP address from IP packets in ARP requests sent on
1130 interface:
1131 0 - (default) Use any local address, configured on any interface
1132 1 - Try to avoid local addresses that are not in the target's
1133 subnet for this interface. This mode is useful when target
1134 hosts reachable via this interface require the source IP
1135 address in ARP requests to be part of their logical network
1136 configured on the receiving interface. When we generate the
1137 request we will check all our subnets that include the
1138 target IP and will preserve the source address if it is from
1139 such subnet. If there is no such subnet we select source
1140 address according to the rules for level 2.
1141 2 - Always use the best local address for this target.
1142 In this mode we ignore the source address in the IP packet
1143 and try to select local address that we prefer for talks with
1144 the target host. Such local address is selected by looking
1145 for primary IP addresses on all our subnets on the outgoing
1146 interface that include the target IP address. If no suitable
1147 local address is found we select the first local address
1148 we have on the outgoing interface or on all other interfaces,
1149 with the hope we will receive reply for our request and
1150 even sometimes no matter the source IP address we announce.
1151
1152 The max value from conf/{all,interface}/arp_announce is used.
1153
1154 Increasing the restriction level gives more chance for
1155 receiving answer from the resolved target while decreasing
1156 the level announces more valid sender's information.
1157
1158arp_ignore - INTEGER
1159 Define different modes for sending replies in response to
1160 received ARP requests that resolve local target IP addresses:
1161 0 - (default): reply for any local target IP address, configured
1162 on any interface
1163 1 - reply only if the target IP address is local address
1164 configured on the incoming interface
1165 2 - reply only if the target IP address is local address
1166 configured on the incoming interface and both with the
1167 sender's IP address are part from same subnet on this interface
1168 3 - do not reply for local addresses configured with scope host,
1169 only resolutions for global and link addresses are replied
1170 4-7 - reserved
1171 8 - do not reply for all local addresses
1172
1173 The max value from conf/{all,interface}/arp_ignore is used
1174 when ARP request is received on the {interface}
1175
Stephen Hemmingereefef1c2009-02-01 01:04:33 -08001176arp_notify - BOOLEAN
1177 Define mode for notification of address and device changes.
1178 0 - (default): do nothing
Ian Campbell3f8dc232010-05-26 00:09:41 +00001179 1 - Generate gratuitous arp requests when device is brought up
Stephen Hemmingereefef1c2009-02-01 01:04:33 -08001180 or hardware address changes.
1181
Neil Hormanc1b1bce2006-03-20 22:40:03 -08001182arp_accept - BOOLEAN
Octavian Purdila6d955182010-01-18 12:58:44 +00001183 Define behavior for gratuitous ARP frames who's IP is not
1184 already present in the ARP table:
1185 0 - don't create new entries in the ARP table
1186 1 - create new entries in the ARP table
1187
1188 Both replies and requests type gratuitous arp will trigger the
1189 ARP table to be updated, if this setting is on.
1190
1191 If the ARP table already contains the IP address of the
1192 gratuitous arp frame, the arp table will be updated regardless
1193 if this setting is on or off.
1194
YOSHIFUJI Hideaki/吉藤英明89c69d32015-03-19 22:42:04 +09001195mcast_solicit - INTEGER
1196 The maximum number of multicast probes in INCOMPLETE state,
1197 when the associated hardware address is unknown. Defaults
1198 to 3.
1199
1200ucast_solicit - INTEGER
1201 The maximum number of unicast probes in PROBE state, when
1202 the hardware address is being reconfirmed. Defaults to 3.
Neil Hormanc1b1bce2006-03-20 22:40:03 -08001203
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204app_solicit - INTEGER
1205 The maximum number of probes to send to the user space ARP daemon
1206 via netlink before dropping back to multicast probes (see
YOSHIFUJI Hideaki/吉藤英明89c69d32015-03-19 22:42:04 +09001207 mcast_resolicit). Defaults to 0.
1208
1209mcast_resolicit - INTEGER
1210 The maximum number of multicast probes after unicast and
1211 app probes in PROBE state. Defaults to 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212
1213disable_policy - BOOLEAN
1214 Disable IPSEC policy (SPD) for this interface
1215
1216disable_xfrm - BOOLEAN
1217 Disable IPSEC encryption on this interface, whatever the policy
1218
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02001219igmpv2_unsolicited_report_interval - INTEGER
1220 The interval in milliseconds in which the next unsolicited
1221 IGMPv1 or IGMPv2 report retransmit will take place.
1222 Default: 10000 (10 seconds)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02001224igmpv3_unsolicited_report_interval - INTEGER
1225 The interval in milliseconds in which the next unsolicited
1226 IGMPv3 report retransmit will take place.
1227 Default: 1000 (1 seconds)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228
Martin Schwenked922e1c2014-01-28 15:26:42 +11001229promote_secondaries - BOOLEAN
1230 When a primary IP address is removed from this interface
1231 promote a corresponding secondary IP address instead of
1232 removing all the corresponding secondary IP addresses.
1233
Johannes Berg12b74df2016-02-04 13:31:17 +01001234drop_unicast_in_l2_multicast - BOOLEAN
1235 Drop any unicast IP packets that are received in link-layer
1236 multicast (or broadcast) frames.
1237 This behavior (for multicast) is actually a SHOULD in RFC
1238 1122, but is disabled by default for compatibility reasons.
1239 Default: off (0)
1240
Johannes Berg97daf332016-02-04 13:31:18 +01001241drop_gratuitous_arp - BOOLEAN
1242 Drop all gratuitous ARP frames, for example if there's a known
1243 good ARP proxy on the network and such frames need not be used
1244 (or in the case of 802.11, must not be used to prevent attacks.)
1245 Default: off (0)
1246
Martin Schwenked922e1c2014-01-28 15:26:42 +11001247
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248tag - INTEGER
1249 Allows you to write a number, which can be used as required.
1250 Default value is 0.
1251
Alexander Duycke69948a2015-08-11 13:35:01 -07001252xfrm4_gc_thresh - INTEGER
1253 The threshold at which we will start garbage collecting for IPv4
1254 destination cache entries. At twice this value the system will
Steffen Klassertc3865782015-09-29 11:40:49 +02001255 refuse new allocations. The value must be set below the flowcache
1256 limit (4096 * number of online cpus) to take effect.
Alexander Duycke69948a2015-08-11 13:35:01 -07001257
Philip Downey87583eb2015-08-31 11:30:38 +01001258igmp_link_local_mcast_reports - BOOLEAN
1259 Enable IGMP reports for link local multicast groups in the
1260 224.0.0.X range.
1261 Default TRUE
1262
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263Alexey Kuznetsov.
1264kuznet@ms2.inr.ac.ru
1265
1266Updated by:
1267Andi Kleen
1268ak@muc.de
1269Nicolas Delon
1270delon.nicolas@wanadoo.fr
1271
1272
1273
1274
1275/proc/sys/net/ipv6/* Variables:
1276
1277IPv6 has no global variables such as tcp_*. tcp_* settings under ipv4/ also
1278apply to IPv6 [XXX?].
1279
1280bindv6only - BOOLEAN
1281 Default value for IPV6_V6ONLY socket option,
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001282 which restricts use of the IPv6 socket to IPv6 communication
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 only.
1284 TRUE: disable IPv4-mapped address feature
1285 FALSE: enable IPv4-mapped address feature
1286
Geoffrey Thomasd5c073ca2011-08-22 11:28:57 -07001287 Default: FALSE (as specified in RFC3493)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288
Florent Fourcot6444f722014-01-17 17:15:05 +01001289flowlabel_consistency - BOOLEAN
1290 Protect the consistency (and unicity) of flow label.
1291 You have to disable it to use IPV6_FL_F_REFLECT flag on the
1292 flow label manager.
1293 TRUE: enabled
1294 FALSE: disabled
1295 Default: TRUE
1296
Tom Herbert42240902015-07-31 16:52:12 -07001297auto_flowlabels - INTEGER
1298 Automatically generate flow labels based on a flow hash of the
1299 packet. This allows intermediate devices, such as routers, to
1300 identify packet flows for mechanisms like Equal Cost Multipath
Tom Herbertcb1ce2e2014-07-01 21:33:10 -07001301 Routing (see RFC 6438).
Tom Herbert42240902015-07-31 16:52:12 -07001302 0: automatic flow labels are completely disabled
1303 1: automatic flow labels are enabled by default, they can be
1304 disabled on a per socket basis using the IPV6_AUTOFLOWLABEL
1305 socket option
1306 2: automatic flow labels are allowed, they may be enabled on a
1307 per socket basis using the IPV6_AUTOFLOWLABEL socket option
1308 3: automatic flow labels are enabled and enforced, they cannot
1309 be disabled by the socket option
Tom Herbertb5677412015-07-31 16:52:14 -07001310 Default: 1
Tom Herbertcb1ce2e2014-07-01 21:33:10 -07001311
Tom Herbert82a584b2015-04-29 15:33:21 -07001312flowlabel_state_ranges - BOOLEAN
1313 Split the flow label number space into two ranges. 0-0x7FFFF is
1314 reserved for the IPv6 flow manager facility, 0x80000-0xFFFFF
1315 is reserved for stateless flow labels as described in RFC6437.
1316 TRUE: enabled
1317 FALSE: disabled
1318 Default: true
1319
FX Le Bail509aba32014-01-07 14:57:27 +01001320anycast_src_echo_reply - BOOLEAN
1321 Controls the use of anycast addresses as source addresses for ICMPv6
1322 echo reply
1323 TRUE: enabled
1324 FALSE: disabled
1325 Default: FALSE
1326
Hannes Frederic Sowa9f0761c2015-03-23 23:36:06 +01001327idgen_delay - INTEGER
1328 Controls the delay in seconds after which time to retry
1329 privacy stable address generation if a DAD conflict is
1330 detected.
1331 Default: 1 (as specified in RFC7217)
1332
1333idgen_retries - INTEGER
1334 Controls the number of retries to generate a stable privacy
1335 address if a DAD conflict is detected.
1336 Default: 3 (as specified in RFC7217)
1337
Hannes Frederic Sowa2f711932014-09-02 15:49:25 +02001338mld_qrv - INTEGER
1339 Controls the MLD query robustness variable (see RFC3810 9.1).
1340 Default: 2 (as specified by RFC3810 9.1)
1341 Minimum: 1 (as specified by RFC6636 4.5)
1342
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343IPv6 Fragmentation:
1344
1345ip6frag_high_thresh - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001346 Maximum memory used to reassemble IPv6 fragments. When
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 ip6frag_high_thresh bytes of memory is allocated for this purpose,
1348 the fragment handler will toss packets until ip6frag_low_thresh
1349 is reached.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001350
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351ip6frag_low_thresh - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001352 See ip6frag_high_thresh
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353
1354ip6frag_time - INTEGER
1355 Time in seconds to keep an IPv6 fragment in memory.
1356
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357conf/default/*:
1358 Change the interface-specific default settings.
1359
1360
1361conf/all/*:
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001362 Change all the interface-specific settings.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363
1364 [XXX: Other special features than forwarding?]
1365
1366conf/all/forwarding - BOOLEAN
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001367 Enable global IPv6 forwarding between all interfaces.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001369 IPv4 and IPv6 work differently here; e.g. netfilter must be used
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 to control which interfaces may forward packets and which not.
1371
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001372 This also sets all interfaces' Host/Router setting
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 'forwarding' to the specified value. See below for details.
1374
1375 This referred to as global forwarding.
1376
YOSHIFUJI Hideakifbea49e2006-09-22 14:43:49 -07001377proxy_ndp - BOOLEAN
1378 Do proxy ndp.
1379
Loganaden Velvindron219b5f22014-11-04 03:02:49 -08001380fwmark_reflect - BOOLEAN
1381 Controls the fwmark of kernel-generated IPv6 reply packets that are not
1382 associated with a socket for example, TCP RSTs or ICMPv6 echo replies).
1383 If unset, these packets have a fwmark of zero. If set, they have the
1384 fwmark of the packet they are replying to.
1385 Default: 0
1386
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387conf/interface/*:
1388 Change special settings per interface.
1389
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001390 The functional behaviour for certain settings is different
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 depending on whether local forwarding is enabled or not.
1392
Roy.Li605b91c2011-09-28 19:51:54 +00001393accept_ra - INTEGER
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 Accept Router Advertisements; autoconfigure using them.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001395
Tore Anderson026359b2011-08-28 23:47:33 +00001396 It also determines whether or not to transmit Router
1397 Solicitations. If and only if the functional setting is to
1398 accept Router Advertisements, Router Solicitations will be
1399 transmitted.
1400
Thomas Grafae8abfa2010-09-03 05:47:30 +00001401 Possible values are:
1402 0 Do not accept Router Advertisements.
1403 1 Accept Router Advertisements if forwarding is disabled.
1404 2 Overrule forwarding behaviour. Accept Router Advertisements
1405 even if forwarding is enabled.
1406
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 Functional default: enabled if local forwarding is disabled.
1408 disabled if local forwarding is enabled.
1409
YOSHIFUJI Hideaki65f5c7c2006-03-20 16:55:08 -08001410accept_ra_defrtr - BOOLEAN
1411 Learn default router in Router Advertisement.
1412
1413 Functional default: enabled if accept_ra is enabled.
1414 disabled if accept_ra is disabled.
1415
Ben Greeard9333192014-06-25 14:44:53 -07001416accept_ra_from_local - BOOLEAN
1417 Accept RA with source-address that is found on local machine
1418 if the RA is otherwise proper and able to be accepted.
1419 Default is to NOT accept these as it may be an un-intended
1420 network loop.
1421
1422 Functional default:
1423 enabled if accept_ra_from_local is enabled
1424 on a specific interface.
1425 disabled if accept_ra_from_local is disabled
1426 on a specific interface.
1427
Hangbin Liu8013d1d2015-07-30 14:28:42 +08001428accept_ra_min_hop_limit - INTEGER
1429 Minimum hop limit Information in Router Advertisement.
1430
1431 Hop limit Information in Router Advertisement less than this
1432 variable shall be ignored.
1433
1434 Default: 1
1435
YOSHIFUJI Hideakic4fd30e2006-03-20 16:55:26 -08001436accept_ra_pinfo - BOOLEAN
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02001437 Learn Prefix Information in Router Advertisement.
YOSHIFUJI Hideakic4fd30e2006-03-20 16:55:26 -08001438
1439 Functional default: enabled if accept_ra is enabled.
1440 disabled if accept_ra is disabled.
1441
YOSHIFUJI Hideaki09c884d2006-03-20 17:07:03 -08001442accept_ra_rt_info_max_plen - INTEGER
1443 Maximum prefix length of Route Information in RA.
1444
1445 Route Information w/ prefix larger than or equal to this
1446 variable shall be ignored.
1447
1448 Functional default: 0 if accept_ra_rtr_pref is enabled.
1449 -1 if accept_ra_rtr_pref is disabled.
1450
YOSHIFUJI Hideaki930d6ff2006-03-20 17:05:30 -08001451accept_ra_rtr_pref - BOOLEAN
1452 Accept Router Preference in RA.
1453
1454 Functional default: enabled if accept_ra is enabled.
1455 disabled if accept_ra is disabled.
1456
Harout Hedeshianc2943f12015-01-20 10:06:05 -07001457accept_ra_mtu - BOOLEAN
1458 Apply the MTU value specified in RA option 5 (RFC4861). If
1459 disabled, the MTU specified in the RA will be ignored.
1460
1461 Functional default: enabled if accept_ra is enabled.
1462 disabled if accept_ra is disabled.
1463
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464accept_redirects - BOOLEAN
1465 Accept Redirects.
1466
1467 Functional default: enabled if local forwarding is disabled.
1468 disabled if local forwarding is enabled.
1469
YOSHIFUJI Hideaki0bcbc922007-04-24 14:58:30 -07001470accept_source_route - INTEGER
1471 Accept source routing (routing extension header).
1472
YOSHIFUJI Hideakibb4dbf92007-07-10 22:55:49 -07001473 >= 0: Accept only routing header type 2.
YOSHIFUJI Hideaki0bcbc922007-04-24 14:58:30 -07001474 < 0: Do not accept routing header.
1475
1476 Default: 0
1477
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478autoconf - BOOLEAN
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001479 Autoconfigure addresses using Prefix Information in Router
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 Advertisements.
1481
YOSHIFUJI Hideakic4fd30e2006-03-20 16:55:26 -08001482 Functional default: enabled if accept_ra_pinfo is enabled.
1483 disabled if accept_ra_pinfo is disabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484
1485dad_transmits - INTEGER
1486 The amount of Duplicate Address Detection probes to send.
1487 Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488
Roy.Li605b91c2011-09-28 19:51:54 +00001489forwarding - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001490 Configure interface-specific Host/Router behaviour.
1491
1492 Note: It is recommended to have the same setting on all
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 interfaces; mixed router/host scenarios are rather uncommon.
1494
Thomas Grafae8abfa2010-09-03 05:47:30 +00001495 Possible values are:
1496 0 Forwarding disabled
1497 1 Forwarding enabled
Thomas Grafae8abfa2010-09-03 05:47:30 +00001498
1499 FALSE (0):
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500
1501 By default, Host behaviour is assumed. This means:
1502
1503 1. IsRouter flag is not set in Neighbour Advertisements.
Tore Anderson026359b2011-08-28 23:47:33 +00001504 2. If accept_ra is TRUE (default), transmit Router
1505 Solicitations.
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001506 3. If accept_ra is TRUE (default), accept Router
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 Advertisements (and do autoconfiguration).
1508 4. If accept_redirects is TRUE (default), accept Redirects.
1509
Thomas Grafae8abfa2010-09-03 05:47:30 +00001510 TRUE (1):
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001512 If local forwarding is enabled, Router behaviour is assumed.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 This means exactly the reverse from the above:
1514
1515 1. IsRouter flag is set in Neighbour Advertisements.
Tore Anderson026359b2011-08-28 23:47:33 +00001516 2. Router Solicitations are not sent unless accept_ra is 2.
Thomas Grafae8abfa2010-09-03 05:47:30 +00001517 3. Router Advertisements are ignored unless accept_ra is 2.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 4. Redirects are ignored.
1519
Thomas Grafae8abfa2010-09-03 05:47:30 +00001520 Default: 0 (disabled) if global forwarding is disabled (default),
1521 otherwise 1 (enabled).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522
1523hop_limit - INTEGER
1524 Default Hop Limit to set.
1525 Default: 64
1526
1527mtu - INTEGER
1528 Default Maximum Transfer Unit
1529 Default: 1280 (IPv6 required minimum)
1530
Tom Herbert35a256f2015-07-08 16:58:22 -07001531ip_nonlocal_bind - BOOLEAN
1532 If set, allows processes to bind() to non-local IPv6 addresses,
1533 which can be quite useful - but may break some applications.
1534 Default: 0
1535
YOSHIFUJI Hideaki52e16352006-03-20 17:05:47 -08001536router_probe_interval - INTEGER
1537 Minimum interval (in seconds) between Router Probing described
1538 in RFC4191.
1539
1540 Default: 60
1541
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542router_solicitation_delay - INTEGER
1543 Number of seconds to wait after interface is brought up
1544 before sending Router Solicitations.
1545 Default: 1
1546
1547router_solicitation_interval - INTEGER
1548 Number of seconds to wait between Router Solicitations.
1549 Default: 4
1550
1551router_solicitations - INTEGER
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001552 Number of Router Solicitations to send until assuming no
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553 routers are present.
1554 Default: 3
1555
Erik Kline3985e8a2015-07-22 16:38:25 +09001556use_oif_addrs_only - BOOLEAN
1557 When enabled, the candidate source addresses for destinations
1558 routed via this interface are restricted to the set of addresses
1559 configured on this interface (vis. RFC 6724, section 4).
1560
1561 Default: false
1562
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563use_tempaddr - INTEGER
1564 Preference for Privacy Extensions (RFC3041).
1565 <= 0 : disable Privacy Extensions
1566 == 1 : enable Privacy Extensions, but prefer public
1567 addresses over temporary addresses.
1568 > 1 : enable Privacy Extensions and prefer temporary
1569 addresses over public addresses.
1570 Default: 0 (for most devices)
1571 -1 (for point-to-point devices and loopback devices)
1572
1573temp_valid_lft - INTEGER
1574 valid lifetime (in seconds) for temporary addresses.
1575 Default: 604800 (7 days)
1576
1577temp_prefered_lft - INTEGER
1578 Preferred lifetime (in seconds) for temporary addresses.
1579 Default: 86400 (1 day)
1580
David Ahernf1705ec2016-02-24 09:25:37 -08001581keep_addr_on_down - INTEGER
1582 Keep all IPv6 addresses on an interface down event. If set static
1583 global addresses with no expiration time are not flushed.
1584 >0 : enabled
1585 0 : system default
1586 <0 : disabled
1587
1588 Default: 0 (addresses are removed)
1589
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590max_desync_factor - INTEGER
1591 Maximum value for DESYNC_FACTOR, which is a random value
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001592 that ensures that clients don't synchronize with each
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 other and generate new addresses at exactly the same time.
1594 value is in seconds.
1595 Default: 600
Jesper Dangaard Brouere18f5fe2009-02-23 04:39:04 +00001596
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597regen_max_retry - INTEGER
1598 Number of attempts before give up attempting to generate
1599 valid temporary addresses.
1600 Default: 5
1601
1602max_addresses - INTEGER
Brian Haleye79dc482010-02-22 12:27:21 +00001603 Maximum number of autoconfigured addresses per interface. Setting
1604 to zero disables the limitation. It is not recommended to set this
1605 value too large (or to zero) because it would be an easy way to
1606 crash the kernel by allowing too many addresses to be created.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 Default: 16
1608
YOSHIFUJI Hideaki778d80b2008-06-28 14:17:11 +09001609disable_ipv6 - BOOLEAN
Brian Haley9bdd8d42009-03-18 18:22:48 -07001610 Disable IPv6 operation. If accept_dad is set to 2, this value
1611 will be dynamically set to TRUE if DAD fails for the link-local
1612 address.
YOSHIFUJI Hideaki778d80b2008-06-28 14:17:11 +09001613 Default: FALSE (enable IPv6 operation)
1614
Brian Haley56d417b2009-06-01 03:07:33 -07001615 When this value is changed from 1 to 0 (IPv6 is being enabled),
1616 it will dynamically create a link-local address on the given
1617 interface and start Duplicate Address Detection, if necessary.
1618
1619 When this value is changed from 0 to 1 (IPv6 is being disabled),
1620 it will dynamically delete all address on the given interface.
1621
YOSHIFUJI Hideaki1b34be72008-06-28 14:18:38 +09001622accept_dad - INTEGER
1623 Whether to accept DAD (Duplicate Address Detection).
1624 0: Disable DAD
1625 1: Enable DAD (default)
1626 2: Enable DAD, and disable IPv6 operation if MAC-based duplicate
1627 link-local address has been found.
1628
Octavian Purdilaf7734fd2009-10-02 11:39:15 +00001629force_tllao - BOOLEAN
1630 Enable sending the target link-layer address option even when
1631 responding to a unicast neighbor solicitation.
1632 Default: FALSE
1633
1634 Quoting from RFC 2461, section 4.4, Target link-layer address:
1635
1636 "The option MUST be included for multicast solicitations in order to
1637 avoid infinite Neighbor Solicitation "recursion" when the peer node
1638 does not have a cache entry to return a Neighbor Advertisements
1639 message. When responding to unicast solicitations, the option can be
1640 omitted since the sender of the solicitation has the correct link-
1641 layer address; otherwise it would not have be able to send the unicast
1642 solicitation in the first place. However, including the link-layer
1643 address in this case adds little overhead and eliminates a potential
1644 race condition where the sender deletes the cached link-layer address
1645 prior to receiving a response to a previous solicitation."
1646
Hannes Frederic Sowadb2b6202013-01-01 00:35:31 +00001647ndisc_notify - BOOLEAN
1648 Define mode for notification of address and device changes.
1649 0 - (default): do nothing
1650 1 - Generate unsolicited neighbour advertisements when device is brought
1651 up or hardware address changes.
1652
Hannes Frederic Sowafc4eba52013-08-14 01:03:46 +02001653mldv1_unsolicited_report_interval - INTEGER
1654 The interval in milliseconds in which the next unsolicited
1655 MLDv1 report retransmit will take place.
1656 Default: 10000 (10 seconds)
1657
1658mldv2_unsolicited_report_interval - INTEGER
1659 The interval in milliseconds in which the next unsolicited
1660 MLDv2 report retransmit will take place.
1661 Default: 1000 (1 second)
1662
Daniel Borkmannf2127812013-09-04 00:19:44 +02001663force_mld_version - INTEGER
1664 0 - (default) No enforcement of a MLD version, MLDv1 fallback allowed
1665 1 - Enforce to use MLD version 1
1666 2 - Enforce to use MLD version 2
1667
Hannes Frederic Sowab800c3b2013-08-27 01:36:51 +02001668suppress_frag_ndisc - INTEGER
1669 Control RFC 6980 (Security Implications of IPv6 Fragmentation
1670 with IPv6 Neighbor Discovery) behavior:
1671 1 - (default) discard fragmented neighbor discovery packets
1672 0 - allow fragmented neighbor discovery packets
1673
Erik Kline7fd25612014-10-28 18:11:14 +09001674optimistic_dad - BOOLEAN
1675 Whether to perform Optimistic Duplicate Address Detection (RFC 4429).
1676 0: disabled (default)
1677 1: enabled
1678
1679use_optimistic - BOOLEAN
1680 If enabled, do not classify optimistic addresses as deprecated during
1681 source address selection. Preferred addresses will still be chosen
1682 before optimistic addresses, subject to other ranking in the source
1683 address selection algorithm.
1684 0: disabled (default)
1685 1: enabled
1686
Hannes Frederic Sowa9f0761c2015-03-23 23:36:06 +01001687stable_secret - IPv6 address
1688 This IPv6 address will be used as a secret to generate IPv6
1689 addresses for link-local addresses and autoconfigured
1690 ones. All addresses generated after setting this secret will
1691 be stable privacy ones by default. This can be changed via the
1692 addrgenmode ip-link. conf/default/stable_secret is used as the
1693 secret for the namespace, the interface specific ones can
1694 overwrite that. Writes to conf/all/stable_secret are refused.
1695
1696 It is recommended to generate this secret during installation
1697 of a system and keep it stable after that.
1698
1699 By default the stable secret is unset.
1700
Johannes Bergabbc3042016-02-04 13:31:19 +01001701drop_unicast_in_l2_multicast - BOOLEAN
1702 Drop any unicast IPv6 packets that are received in link-layer
1703 multicast (or broadcast) frames.
1704
1705 By default this is turned off.
1706
Johannes Berg7a02bf82016-02-04 13:31:20 +01001707drop_unsolicited_na - BOOLEAN
1708 Drop all unsolicited neighbor advertisements, for example if there's
1709 a known good NA proxy on the network and such frames need not be used
1710 (or in the case of 802.11, must not be used to prevent attacks.)
1711
1712 By default this is turned off.
1713
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714icmp/*:
1715ratelimit - INTEGER
1716 Limit the maximal rates for sending ICMPv6 packets.
Stephen Hemminger6dbf4bc2008-07-01 19:29:07 -07001717 0 to disable any limiting,
1718 otherwise the minimal space between responses in milliseconds.
1719 Default: 1000
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720
Alexander Duycke69948a2015-08-11 13:35:01 -07001721xfrm6_gc_thresh - INTEGER
1722 The threshold at which we will start garbage collecting for IPv6
1723 destination cache entries. At twice this value the system will
Steffen Klassertc3865782015-09-29 11:40:49 +02001724 refuse new allocations. The value must be set below the flowcache
1725 limit (4096 * number of online cpus) to take effect.
Alexander Duycke69948a2015-08-11 13:35:01 -07001726
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727
1728IPv6 Update by:
1729Pekka Savola <pekkas@netcore.fi>
1730YOSHIFUJI Hideaki / USAGI Project <yoshfuji@linux-ipv6.org>
1731
1732
1733/proc/sys/net/bridge/* Variables:
1734
1735bridge-nf-call-arptables - BOOLEAN
1736 1 : pass bridged ARP traffic to arptables' FORWARD chain.
1737 0 : disable this.
1738 Default: 1
1739
1740bridge-nf-call-iptables - BOOLEAN
1741 1 : pass bridged IPv4 traffic to iptables' chains.
1742 0 : disable this.
1743 Default: 1
1744
1745bridge-nf-call-ip6tables - BOOLEAN
1746 1 : pass bridged IPv6 traffic to ip6tables' chains.
1747 0 : disable this.
1748 Default: 1
1749
1750bridge-nf-filter-vlan-tagged - BOOLEAN
Michael Milner516299d2007-04-12 22:14:23 -07001751 1 : pass bridged vlan-tagged ARP/IP/IPv6 traffic to {arp,ip,ip6}tables.
1752 0 : disable this.
Pablo Neira Ayuso49816822012-05-08 19:36:44 +02001753 Default: 0
Michael Milner516299d2007-04-12 22:14:23 -07001754
1755bridge-nf-filter-pppoe-tagged - BOOLEAN
1756 1 : pass bridged pppoe-tagged IP/IPv6 traffic to {ip,ip6}tables.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 0 : disable this.
Pablo Neira Ayuso49816822012-05-08 19:36:44 +02001758 Default: 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759
Pablo Neira Ayuso49816822012-05-08 19:36:44 +02001760bridge-nf-pass-vlan-input-dev - BOOLEAN
1761 1: if bridge-nf-filter-vlan-tagged is enabled, try to find a vlan
1762 interface on the bridge and set the netfilter input device to the vlan.
1763 This allows use of e.g. "iptables -i br0.1" and makes the REDIRECT
1764 target work with vlan-on-top-of-bridge interfaces. When no matching
1765 vlan interface is found, or this switch is off, the input device is
1766 set to the bridge interface.
1767 0: disable bridge netfilter vlan interface lookup.
1768 Default: 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769
Vlad Yasevich32e8d492008-07-08 16:43:29 -07001770proc/sys/net/sctp/* Variables:
1771
1772addip_enable - BOOLEAN
1773 Enable or disable extension of Dynamic Address Reconfiguration
1774 (ADD-IP) functionality specified in RFC5061. This extension provides
1775 the ability to dynamically add and remove new addresses for the SCTP
1776 associations.
1777
1778 1: Enable extension.
1779
1780 0: Disable extension.
1781
1782 Default: 0
1783
Zhu Yanjun566178f2015-12-16 13:55:04 +08001784pf_enable - INTEGER
1785 Enable or disable pf (pf is short for potentially failed) state. A value
1786 of pf_retrans > path_max_retrans also disables pf state. That is, one of
1787 both pf_enable and pf_retrans > path_max_retrans can disable pf state.
1788 Since pf_retrans and path_max_retrans can be changed by userspace
1789 application, sometimes user expects to disable pf state by the value of
1790 pf_retrans > path_max_retrans, but occasionally the value of pf_retrans
1791 or path_max_retrans is changed by the user application, this pf state is
1792 enabled. As such, it is necessary to add this to dynamically enable
1793 and disable pf state. See:
1794 https://datatracker.ietf.org/doc/draft-ietf-tsvwg-sctp-failover for
1795 details.
1796
1797 1: Enable pf.
1798
1799 0: Disable pf.
1800
1801 Default: 1
1802
Vlad Yasevich32e8d492008-07-08 16:43:29 -07001803addip_noauth_enable - BOOLEAN
1804 Dynamic Address Reconfiguration (ADD-IP) requires the use of
1805 authentication to protect the operations of adding or removing new
1806 addresses. This requirement is mandated so that unauthorized hosts
1807 would not be able to hijack associations. However, older
1808 implementations may not have implemented this requirement while
1809 allowing the ADD-IP extension. For reasons of interoperability,
1810 we provide this variable to control the enforcement of the
1811 authentication requirement.
1812
1813 1: Allow ADD-IP extension to be used without authentication. This
1814 should only be set in a closed environment for interoperability
1815 with older implementations.
1816
1817 0: Enforce the authentication requirement
1818
1819 Default: 0
1820
1821auth_enable - BOOLEAN
1822 Enable or disable Authenticated Chunks extension. This extension
1823 provides the ability to send and receive authenticated chunks and is
1824 required for secure operation of Dynamic Address Reconfiguration
1825 (ADD-IP) extension.
1826
1827 1: Enable this extension.
1828 0: Disable this extension.
1829
1830 Default: 0
1831
1832prsctp_enable - BOOLEAN
1833 Enable or disable the Partial Reliability extension (RFC3758) which
1834 is used to notify peers that a given DATA should no longer be expected.
1835
1836 1: Enable extension
1837 0: Disable
1838
1839 Default: 1
1840
1841max_burst - INTEGER
1842 The limit of the number of new packets that can be initially sent. It
1843 controls how bursty the generated traffic can be.
1844
1845 Default: 4
1846
1847association_max_retrans - INTEGER
1848 Set the maximum number for retransmissions that an association can
1849 attempt deciding that the remote end is unreachable. If this value
1850 is exceeded, the association is terminated.
1851
1852 Default: 10
1853
1854max_init_retransmits - INTEGER
1855 The maximum number of retransmissions of INIT and COOKIE-ECHO chunks
1856 that an association will attempt before declaring the destination
1857 unreachable and terminating.
1858
1859 Default: 8
1860
1861path_max_retrans - INTEGER
1862 The maximum number of retransmissions that will be attempted on a given
1863 path. Once this threshold is exceeded, the path is considered
1864 unreachable, and new traffic will use a different path when the
1865 association is multihomed.
1866
1867 Default: 5
1868
Neil Horman5aa93bc2012-07-21 07:56:07 +00001869pf_retrans - INTEGER
1870 The number of retransmissions that will be attempted on a given path
1871 before traffic is redirected to an alternate transport (should one
1872 exist). Note this is distinct from path_max_retrans, as a path that
1873 passes the pf_retrans threshold can still be used. Its only
1874 deprioritized when a transmission path is selected by the stack. This
1875 setting is primarily used to enable fast failover mechanisms without
1876 having to reduce path_max_retrans to a very low value. See:
1877 http://www.ietf.org/id/draft-nishida-tsvwg-sctp-failover-05.txt
1878 for details. Note also that a value of pf_retrans > path_max_retrans
Zhu Yanjun566178f2015-12-16 13:55:04 +08001879 disables this feature. Since both pf_retrans and path_max_retrans can
1880 be changed by userspace application, a variable pf_enable is used to
1881 disable pf state.
Neil Horman5aa93bc2012-07-21 07:56:07 +00001882
1883 Default: 0
1884
Vlad Yasevich32e8d492008-07-08 16:43:29 -07001885rto_initial - INTEGER
1886 The initial round trip timeout value in milliseconds that will be used
1887 in calculating round trip times. This is the initial time interval
1888 for retransmissions.
1889
1890 Default: 3000
1891
1892rto_max - INTEGER
1893 The maximum value (in milliseconds) of the round trip timeout. This
1894 is the largest time interval that can elapse between retransmissions.
1895
1896 Default: 60000
1897
1898rto_min - INTEGER
1899 The minimum value (in milliseconds) of the round trip timeout. This
1900 is the smallest time interval the can elapse between retransmissions.
1901
1902 Default: 1000
1903
1904hb_interval - INTEGER
1905 The interval (in milliseconds) between HEARTBEAT chunks. These chunks
1906 are sent at the specified interval on idle paths to probe the state of
1907 a given path between 2 associations.
1908
1909 Default: 30000
1910
1911sack_timeout - INTEGER
1912 The amount of time (in milliseconds) that the implementation will wait
1913 to send a SACK.
1914
1915 Default: 200
1916
1917valid_cookie_life - INTEGER
1918 The default lifetime of the SCTP cookie (in milliseconds). The cookie
1919 is used during association establishment.
1920
1921 Default: 60000
1922
1923cookie_preserve_enable - BOOLEAN
1924 Enable or disable the ability to extend the lifetime of the SCTP cookie
1925 that is used during the establishment phase of SCTP association
1926
1927 1: Enable cookie lifetime extension.
1928 0: Disable
1929
1930 Default: 1
1931
Neil Horman3c681982012-10-24 09:20:03 +00001932cookie_hmac_alg - STRING
1933 Select the hmac algorithm used when generating the cookie value sent by
1934 a listening sctp socket to a connecting client in the INIT-ACK chunk.
1935 Valid values are:
1936 * md5
1937 * sha1
1938 * none
1939 Ability to assign md5 or sha1 as the selected alg is predicated on the
stephen hemminger3b09adc2013-01-03 07:50:29 +00001940 configuration of those algorithms at build time (CONFIG_CRYPTO_MD5 and
Neil Horman3c681982012-10-24 09:20:03 +00001941 CONFIG_CRYPTO_SHA1).
1942
1943 Default: Dependent on configuration. MD5 if available, else SHA1 if
1944 available, else none.
1945
Vlad Yasevich32e8d492008-07-08 16:43:29 -07001946rcvbuf_policy - INTEGER
1947 Determines if the receive buffer is attributed to the socket or to
1948 association. SCTP supports the capability to create multiple
1949 associations on a single socket. When using this capability, it is
1950 possible that a single stalled association that's buffering a lot
1951 of data may block other associations from delivering their data by
1952 consuming all of the receive buffer space. To work around this,
1953 the rcvbuf_policy could be set to attribute the receiver buffer space
1954 to each association instead of the socket. This prevents the described
1955 blocking.
1956
1957 1: rcvbuf space is per association
stephen hemminger3b09adc2013-01-03 07:50:29 +00001958 0: rcvbuf space is per socket
Vlad Yasevich32e8d492008-07-08 16:43:29 -07001959
1960 Default: 0
1961
1962sndbuf_policy - INTEGER
1963 Similar to rcvbuf_policy above, this applies to send buffer space.
1964
1965 1: Send buffer is tracked per association
1966 0: Send buffer is tracked per socket.
1967
1968 Default: 0
1969
1970sctp_mem - vector of 3 INTEGERs: min, pressure, max
1971 Number of pages allowed for queueing by all SCTP sockets.
1972
1973 min: Below this number of pages SCTP is not bothered about its
1974 memory appetite. When amount of memory allocated by SCTP exceeds
1975 this number, SCTP starts to moderate memory usage.
1976
1977 pressure: This value was introduced to follow format of tcp_mem.
1978
1979 max: Number of pages allowed for queueing by all SCTP sockets.
1980
1981 Default is calculated at boot time from amount of available memory.
1982
1983sctp_rmem - vector of 3 INTEGERs: min, default, max
Max Matveeva6e12042011-06-19 22:08:10 +00001984 Only the first value ("min") is used, "default" and "max" are
1985 ignored.
1986
1987 min: Minimal size of receive buffer used by SCTP socket.
1988 It is guaranteed to each SCTP socket (but not association) even
1989 under moderate memory pressure.
1990
1991 Default: 1 page
Vlad Yasevich32e8d492008-07-08 16:43:29 -07001992
1993sctp_wmem - vector of 3 INTEGERs: min, default, max
Max Matveeva6e12042011-06-19 22:08:10 +00001994 Currently this tunable has no effect.
Vlad Yasevich32e8d492008-07-08 16:43:29 -07001995
Bhaskar Dutta72388432009-09-03 17:25:47 +05301996addr_scope_policy - INTEGER
1997 Control IPv4 address scoping - draft-stewart-tsvwg-sctp-ipv4-00
1998
1999 0 - Disable IPv4 address scoping
2000 1 - Enable IPv4 address scoping
2001 2 - Follow draft but allow IPv4 private addresses
2002 3 - Follow draft but allow IPv4 link local addresses
2003
2004 Default: 1
2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006
Stephen Hemminger4edc2f32008-07-10 16:50:26 -07002007/proc/sys/net/core/*
Shan Weic60f6aa2012-04-26 16:52:52 +00002008 Please see: Documentation/sysctl/net.txt for descriptions of these entries.
Wang Tinggong705efc32009-05-14 22:49:36 +00002009
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010
Stephen Hemminger4edc2f32008-07-10 16:50:26 -07002011/proc/sys/net/unix/*
Wang Tinggong705efc32009-05-14 22:49:36 +00002012max_dgram_qlen - INTEGER
2013 The maximum length of dgram socket receive queue
2014
2015 Default: 10
2016
2017
2018UNDOCUMENTED:
Stephen Hemminger4edc2f32008-07-10 16:50:26 -07002019
2020/proc/sys/net/irda/*
2021 fast_poll_increase FIXME
2022 warn_noreply_time FIXME
2023 discovery_slots FIXME
2024 slot_timeout FIXME
2025 max_baud_rate FIXME
2026 discovery_timeout FIXME
2027 lap_keepalive_time FIXME
2028 max_noreply_time FIXME
2029 max_tx_data_size FIXME
2030 max_tx_window FIXME
2031 min_tx_turn_time FIXME