ip-sysctl.rst 88.5 KB
Newer Older
1 2 3 4 5 6 7 8
.. SPDX-License-Identifier: GPL-2.0

=========
IP Sysctl
=========

/proc/sys/net/ipv4/* Variables
==============================
L
Linus Torvalds 已提交
9 10

ip_forward - BOOLEAN
11 12
	- 0 - disabled (default)
	- not 0 - enabled
L
Linus Torvalds 已提交
13 14 15 16 17 18 19 20

	Forward Packets between interfaces.

	This variable is special, its change resets all configuration
	parameters to their default state (RFC1122 for hosts, RFC1812
	for routers)

ip_default_ttl - INTEGER
21 22 23
	Default value of TTL field (Time To Live) for outgoing (but not
	forwarded) IP packets. Should be between 1 and 255 inclusive.
	Default: 64 (as recommended by RFC1700)
L
Linus Torvalds 已提交
24

25 26
ip_no_pmtu_disc - INTEGER
	Disable Path MTU Discovery. If enabled in mode 1 and a
27 28 29 30
	fragmentation-required ICMP is received, the PMTU to this
	destination will be set to min_pmtu (see below). You will need
	to raise min_pmtu to the smallest interface MTU on your system
	manually if you want to avoid locally generated fragments.
31 32 33 34 35

	In mode 2 incoming Path MTU Discovery messages will be
	discarded. Outgoing frames are handled the same as in mode 1,
	implicitly setting IP_PMTUDISC_DONT on every created socket.

36
	Mode 3 is a hardened pmtu discover mode. The kernel will only
37 38 39 40 41 42 43 44 45 46 47
	accept fragmentation-needed errors if the underlying protocol
	can verify them besides a plain socket lookup. Current
	protocols for which pmtu events will be honored are TCP, SCTP
	and DCCP as they verify e.g. the sequence number or the
	association. This mode should not be enabled globally but is
	only intended to secure e.g. name servers in namespaces where
	TCP path mtu must still work but path MTU information of other
	protocols should be discarded. If enabled globally this mode
	could break other protocols.

	Possible values: 0-3
48

49
	Default: FALSE
L
Linus Torvalds 已提交
50 51

min_pmtu - INTEGER
E
Eric Dumazet 已提交
52
	default 552 - minimum discovered Path MTU
L
Linus Torvalds 已提交
53

54 55 56 57 58 59 60 61
ip_forward_use_pmtu - BOOLEAN
	By default we don't trust protocol path MTUs while forwarding
	because they could be easily forged and can lead to unwanted
	fragmentation by the router.
	You only need to enable this if you have user-space software
	which tries to discover path mtus by itself and depends on the
	kernel honoring this information. This is normally not the
	case.
62

63
	Default: 0 (disabled)
64

65
	Possible values:
66 67 68

	- 0 - disabled
	- 1 - enabled
69

70 71 72 73 74
fwmark_reflect - BOOLEAN
	Controls the fwmark of kernel-generated IPv4 reply packets that are not
	associated with a socket for example, TCP RSTs or ICMP echo replies).
	If unset, these packets have a fwmark of zero. If set, they have the
	fwmark of the packet they are replying to.
75

76 77
	Default: 0

78 79 80 81 82
fib_multipath_use_neigh - BOOLEAN
	Use status of existing neighbor entry when determining nexthop for
	multipath routes. If disabled, neighbor information is not used and
	packets could be directed to a failed nexthop. Only valid for kernels
	built with CONFIG_IP_ROUTE_MULTIPATH enabled.
83

84
	Default: 0 (disabled)
85

86
	Possible values:
87 88 89

	- 0 - disabled
	- 1 - enabled
90

91 92 93
fib_multipath_hash_policy - INTEGER
	Controls which hash policy to use for multipath routes. Only valid
	for kernels built with CONFIG_IP_ROUTE_MULTIPATH enabled.
94

95
	Default: 0 (Layer 3)
96

97
	Possible values:
98 99 100 101

	- 0 - Layer 3
	- 1 - Layer 4
	- 2 - Layer 3 or inner Layer 3 if present
102

103 104 105
fib_sync_mem - UNSIGNED INTEGER
	Amount of dirty memory from fib entries that can be backlogged before
	synchronize_rcu is forced.
106 107

	Default: 512kB   Minimum: 64kB   Maximum: 64MB
108

109 110 111 112
ip_forward_update_priority - INTEGER
	Whether to update SKB priority from "TOS" field in IPv4 header after it
	is forwarded. The new SKB priority is mapped from TOS field value
	according to an rt_tos2priority table (see e.g. man tc-prio).
113

114
	Default: 1 (Update priority.)
115

116
	Possible values:
117 118 119

	- 0 - Do not update priority.
	- 1 - Update priority.
120

121 122 123
route/max_size - INTEGER
	Maximum number of routes allowed in the kernel.  Increase
	this when using large numbers of interfaces and/or routes.
124

125 126
	From linux kernel 3.6 onwards, this is deprecated for ipv4
	as route cache is no longer used.
127

128 129 130
neigh/default/gc_thresh1 - INTEGER
	Minimum number of entries to keep.  Garbage collector will not
	purge entries if there are fewer than this number.
131

132
	Default: 128
133

S
stephen hemminger 已提交
134 135 136 137
neigh/default/gc_thresh2 - INTEGER
	Threshold when garbage collector becomes more aggressive about
	purging entries. Entries older than 5 seconds will be cleared
	when over this number.
138

S
stephen hemminger 已提交
139 140
	Default: 512

141
neigh/default/gc_thresh3 - INTEGER
D
David Ahern 已提交
142 143
	Maximum number of non-PERMANENT neighbor entries allowed.  Increase
	this when using large numbers of interfaces and when communicating
144
	with large numbers of directly-connected peers.
145

146
	Default: 1024
147

E
Eric Dumazet 已提交
148 149 150 151
neigh/default/unres_qlen_bytes - INTEGER
	The maximum number of bytes which may be used by packets
	queued for each	unresolved address by other network layers.
	(added in linux 3.3)
152

153
	Setting negative value is meaningless and will return error.
154

155
	Default: SK_WMEM_MAX, (same as net.core.wmem_default).
156

157 158 159
		Exact value depends on architecture and kernel options,
		but should be enough to allow queuing 256 packets
		of medium size.
E
Eric Dumazet 已提交
160 161 162 163

neigh/default/unres_qlen - INTEGER
	The maximum number of packets which may be queued for each
	unresolved address by other network layers.
164

E
Eric Dumazet 已提交
165
	(deprecated in linux 3.3) : use unres_qlen_bytes instead.
166

167
	Prior to linux 3.3, the default value is 3 which may cause
168
	unexpected packet loss. The current default value is calculated
169 170
	according to default value of unres_qlen_bytes and true size of
	packet.
171

172
	Default: 101
E
Eric Dumazet 已提交
173

L
Linus Torvalds 已提交
174 175 176 177 178 179 180 181 182
mtu_expires - INTEGER
	Time, in seconds, that cached PMTU information is kept.

min_adv_mss - INTEGER
	The advertised MSS depends on the first hop route MTU, but will
	never be lower than this setting.

IP Fragmentation:

183
ipfrag_high_thresh - LONG INTEGER
184
	Maximum memory used to reassemble IP fragments.
185

186
ipfrag_low_thresh - LONG INTEGER
187
	(Obsolete since linux-4.17)
188 189 190
	Maximum memory used to reassemble IP fragments before the kernel
	begins to remove incomplete fragment queues to free up resources.
	The kernel still accepts new fragments for defragmentation.
L
Linus Torvalds 已提交
191 192

ipfrag_time - INTEGER
193
	Time in seconds to keep an IP fragment in memory.
L
Linus Torvalds 已提交
194

H
Herbert Xu 已提交
195
ipfrag_max_dist - INTEGER
196 197 198 199 200 201 202 203 204 205 206 207
	ipfrag_max_dist is a non-negative integer value which defines the
	maximum "disorder" which is allowed among fragments which share a
	common IP source address. Note that reordering of packets is
	not unusual, but if a large number of fragments arrive from a source
	IP address while a particular fragment queue remains incomplete, it
	probably indicates that one or more fragments belonging to that queue
	have been lost. When ipfrag_max_dist is positive, an additional check
	is done on fragments before they are added to a reassembly queue - if
	ipfrag_max_dist (or more) fragments have arrived from a particular IP
	address between additions to any IP fragment queue using that source
	address, it's presumed that one or more fragments in the queue are
	lost. The existing fragment queue will be dropped, and a new one
H
Herbert Xu 已提交
208 209 210 211
	started. An ipfrag_max_dist value of zero disables this check.

	Using a very small value, e.g. 1 or 2, for ipfrag_max_dist can
	result in unnecessarily dropping fragment queues when normal
212 213 214
	reordering of packets occurs, which could lead to poor application
	performance. Using a very large value, e.g. 50000, increases the
	likelihood of incorrectly reassembling IP fragments that originate
H
Herbert Xu 已提交
215 216 217
	from different IP datagrams, which could result in data corruption.
	Default: 64

218 219
INET peer storage
=================
L
Linus Torvalds 已提交
220 221

inet_peer_threshold - INTEGER
222
	The approximate size of the storage.  Starting from this threshold
L
Linus Torvalds 已提交
223 224 225 226 227 228 229 230
	entries will be thrown aggressively.  This threshold also determines
	entries' time-to-live and time intervals between garbage collection
	passes.  More entries, less time-to-live, less GC interval.

inet_peer_minttl - INTEGER
	Minimum time-to-live of entries.  Should be enough to cover fragment
	time-to-live on the reassembling side.  This minimum time-to-live  is
	guaranteed if the pool size is less than inet_peer_threshold.
231
	Measured in seconds.
L
Linus Torvalds 已提交
232 233 234 235 236

inet_peer_maxttl - INTEGER
	Maximum time-to-live of entries.  Unused entries will expire after
	this period of time if there is no memory pressure on the pool (i.e.
	when the number of entries in the pool is very small).
237
	Measured in seconds.
L
Linus Torvalds 已提交
238

239 240
TCP variables
=============
L
Linus Torvalds 已提交
241

242 243
somaxconn - INTEGER
	Limit of socket listen() backlog, known in userspace as SOMAXCONN.
E
Eric Dumazet 已提交
244 245
	Defaults to 4096. (Was 128 before linux-5.4)
	See also tcp_max_syn_backlog for additional tuning for TCP sockets.
246 247 248 249 250 251 252 253

tcp_abort_on_overflow - BOOLEAN
	If listening service is too slow to accept new connections,
	reset them. Default state is FALSE. It means that if overflow
	occurred due to a burst, connection will recover. Enable this
	option _only_ if you are really sure that listening daemon
	cannot be tuned to accept connections faster. Enabling this
	option can harm clients of your server.
L
Linus Torvalds 已提交
254

255 256 257 258
tcp_adv_win_scale - INTEGER
	Count buffering overhead as bytes/2^tcp_adv_win_scale
	(if tcp_adv_win_scale > 0) or bytes-bytes/2^(-tcp_adv_win_scale),
	if it is <= 0.
259

260
	Possible values are [-31, 31], inclusive.
261

262
	Default: 1
L
Linus Torvalds 已提交
263

264 265 266 267
tcp_allowed_congestion_control - STRING
	Show/set the congestion control choices available to non-privileged
	processes. The list is a subset of those listed in
	tcp_available_congestion_control.
268

269
	Default is "reno" and the default setting (tcp_congestion_control).
L
Linus Torvalds 已提交
270

271 272 273
tcp_app_win - INTEGER
	Reserve max(window/2^tcp_app_win, mss) of window for application
	buffer. Value 0 is special, it means that nothing is reserved.
274

275
	Default: 31
L
Linus Torvalds 已提交
276

E
Eric Dumazet 已提交
277 278 279 280 281 282 283 284
tcp_autocorking - BOOLEAN
	Enable TCP auto corking :
	When applications do consecutive small write()/sendmsg() system calls,
	we try to coalesce these small writes as much as possible, to lower
	total amount of sent packets. This is done if at least one prior
	packet for the flow is waiting in Qdisc queues or device transmit
	queue. Applications can still use TCP_CORK for optimal behavior
	when they know how/when to uncork their sockets.
285

E
Eric Dumazet 已提交
286 287
	Default : 1

288 289 290 291
tcp_available_congestion_control - STRING
	Shows the available congestion control choices that are registered.
	More congestion control algorithms may be available as modules,
	but not loaded.
L
Linus Torvalds 已提交
292

J
John Heffner 已提交
293
tcp_base_mss - INTEGER
294 295 296
	The initial value of search_low to be used by the packetization layer
	Path MTU discovery (MTU probing).  If MTU probing is enabled,
	this is the initial MSS used by the connection.
J
John Heffner 已提交
297

298 299 300 301 302 303
tcp_mtu_probe_floor - INTEGER
	If MTU probing is enabled this caps the minimum MSS used for search_low
	for the connection.

	Default : 48

E
Eric Dumazet 已提交
304 305 306
tcp_min_snd_mss - INTEGER
	TCP SYN and SYNACK messages usually advertise an ADVMSS option,
	as described in RFC 1122 and RFC 6691.
307

E
Eric Dumazet 已提交
308 309 310 311 312
	If this ADVMSS option is smaller than tcp_min_snd_mss,
	it is silently capped to tcp_min_snd_mss.

	Default : 48 (at least 8 bytes of payload per segment)

313 314 315 316 317
tcp_congestion_control - STRING
	Set the congestion control algorithm to be used for new
	connections. The algorithm "reno" is always available, but
	additional choices may be available based on kernel configuration.
	Default is set as part of kernel configuration.
318 319
	For passive connections, the listener congestion control choice
	is inherited.
320

321
	[see setsockopt(listenfd, SOL_TCP, TCP_CONGESTION, "name" ...) ]
L
Linus Torvalds 已提交
322

323 324
tcp_dsack - BOOLEAN
	Allows TCP to send "duplicate" SACKs.
L
Linus Torvalds 已提交
325

Y
Yuchung Cheng 已提交
326
tcp_early_retrans - INTEGER
Y
Yuchung Cheng 已提交
327 328 329
	Tail loss probe (TLP) converts RTOs occurring due to tail
	losses into fast recovery (draft-ietf-tcpm-rack). Note that
	TLP requires RACK to function properly (see tcp_recovery below)
330

Y
Yuchung Cheng 已提交
331
	Possible values:
332 333 334 335

		- 0 disables TLP
		- 3 or 4 enables TLP

N
Nandita Dukkipati 已提交
336
	Default: 3
Y
Yuchung Cheng 已提交
337

338
tcp_ecn - INTEGER
339 340 341 342 343
	Control use of Explicit Congestion Notification (ECN) by TCP.
	ECN is used only when both ends of the TCP connection indicate
	support for it.  This feature is useful in avoiding losses due
	to congestion by allowing supporting routers to signal
	congestion before having to drop packets.
344

345
	Possible values are:
346 347 348 349 350 351 352 353 354

		=  =====================================================
		0  Disable ECN.  Neither initiate nor accept ECN.
		1  Enable ECN when requested by incoming connections and
		   also request ECN on outgoing connection attempts.
		2  Enable ECN when requested by incoming connections
		   but do not request ECN on outgoing connections.
		=  =====================================================

355
	Default: 2
356

357 358 359 360 361 362 363
tcp_ecn_fallback - BOOLEAN
	If the kernel detects that ECN connection misbehaves, enable fall
	back to non-ECN. Currently, this knob implements the fallback
	from RFC3168, section 6.1.1.1., but we reserve that in future,
	additional detection mechanisms could be implemented under this
	knob. The value	is not used, if tcp_ecn or per route (or congestion
	control) ECN settings are disabled.
364

365 366
	Default: 1 (fallback enabled)

367
tcp_fack - BOOLEAN
Y
Yuchung Cheng 已提交
368
	This is a legacy option, it has no effect anymore.
L
Linus Torvalds 已提交
369 370

tcp_fin_timeout - INTEGER
371 372 373 374 375 376
	The length of time an orphaned (no longer referenced by any
	application) connection will remain in the FIN_WAIT_2 state
	before it is aborted at the local end.  While a perfectly
	valid "receive only" state for an un-orphaned connection, an
	orphaned connection in FIN_WAIT_2 state could otherwise wait
	forever for the remote to close its end of the connection.
377

378
	Cf. tcp_max_orphans
379

380
	Default: 60 seconds
L
Linus Torvalds 已提交
381

382
tcp_frto - INTEGER
Y
Yuchung Cheng 已提交
383
	Enables Forward RTO-Recovery (F-RTO) defined in RFC5682.
384
	F-RTO is an enhanced recovery algorithm for TCP retransmission
Y
Yuchung Cheng 已提交
385 386 387 388 389
	timeouts.  It is particularly beneficial in networks where the
	RTT fluctuates (e.g., wireless). F-RTO is sender-side only
	modification. It does not require any support from the peer.

	By default it's enabled with a non-zero value. 0 disables F-RTO.
L
Linus Torvalds 已提交
390

391 392 393 394 395 396 397 398 399 400 401
tcp_fwmark_accept - BOOLEAN
	If set, incoming connections to listening sockets that do not have a
	socket mark will set the mark of the accepting socket to the fwmark of
	the incoming SYN packet. This will cause all packets on that connection
	(starting from the first SYNACK) to be sent with that fwmark. The
	listening socket's mark is unchanged. Listening sockets that already
	have a fwmark set via setsockopt(SOL_SOCKET, SO_MARK, ...) are
	unaffected.

	Default: 0

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
tcp_invalid_ratelimit - INTEGER
	Limit the maximal rate for sending duplicate acknowledgments
	in response to incoming TCP packets that are for an existing
	connection but that are invalid due to any of these reasons:

	  (a) out-of-window sequence number,
	  (b) out-of-window acknowledgment number, or
	  (c) PAWS (Protection Against Wrapped Sequence numbers) check failure

	This can help mitigate simple "ack loop" DoS attacks, wherein
	a buggy or malicious middlebox or man-in-the-middle can
	rewrite TCP header fields in manner that causes each endpoint
	to think that the other is sending invalid TCP segments, thus
	causing each side to send an unterminating stream of duplicate
	acknowledgments for invalid segments.

	Using 0 disables rate-limiting of dupacks in response to
	invalid segments; otherwise this value specifies the minimal
	space between sending such dupacks, in milliseconds.

	Default: 500 (milliseconds).

424 425 426
tcp_keepalive_time - INTEGER
	How often TCP sends out keepalive messages when keepalive is enabled.
	Default: 2hours.
L
Linus Torvalds 已提交
427

428 429 430 431 432 433 434 435 436 437
tcp_keepalive_probes - INTEGER
	How many keepalive probes TCP sends out, until it decides that the
	connection is broken. Default value: 9.

tcp_keepalive_intvl - INTEGER
	How frequently the probes are send out. Multiplied by
	tcp_keepalive_probes it is time to kill not responding connection,
	after probes started. Default value: 75sec i.e. connection
	will be aborted after ~11 minutes of retries.

438 439 440 441 442 443 444
tcp_l3mdev_accept - BOOLEAN
	Enables child sockets to inherit the L3 master device index.
	Enabling this option allows a "global" listen socket to work
	across L3 master domains (e.g., VRFs) with connected sockets
	derived from the listen socket to be bound to the L3 domain in
	which the packets originated. Only valid when the kernel was
	compiled with CONFIG_NET_L3_MASTER_DEV.
445 446

	Default: 0 (disabled)
447

448
tcp_low_latency - BOOLEAN
449
	This is a legacy option, it has no effect anymore.
L
Linus Torvalds 已提交
450 451 452 453 454 455 456 457 458 459 460 461 462 463

tcp_max_orphans - INTEGER
	Maximal number of TCP sockets not attached to any user file handle,
	held by system.	If this number is exceeded orphaned connections are
	reset immediately and warning is printed. This limit exists
	only to prevent simple DoS attacks, you _must_ not rely on this
	or lower the limit artificially, but rather increase it
	(probably, after increasing installed memory),
	if network conditions require more than default value,
	and tune network services to linger and kill such states
	more aggressively. Let me to remind again: each orphan eats
	up to ~64K of unswappable memory.

tcp_max_syn_backlog - INTEGER
464 465
	Maximal number of remembered connection requests (SYN_RECV),
	which have not received an acknowledgment from connecting client.
466

467
	This is a per-listener limit.
468

469 470
	The minimal value is 128 for low memory machines, and it will
	increase in proportion to the memory of machine.
471

472
	If server suffers from overload, try increasing this number.
473

474 475
	Remember to also check /proc/sys/net/core/somaxconn
	A SYN_RECV request socket consumes about 304 bytes of memory.
L
Linus Torvalds 已提交
476

477 478 479 480 481 482 483
tcp_max_tw_buckets - INTEGER
	Maximal number of timewait sockets held by system simultaneously.
	If this number is exceeded time-wait socket is immediately destroyed
	and warning is printed. This limit exists only to prevent
	simple DoS attacks, you _must_ not lower the limit artificially,
	but rather increase it (probably, after increasing installed memory),
	if network conditions require more than default value.
L
Linus Torvalds 已提交
484

485 486 487
tcp_mem - vector of 3 INTEGERs: min, pressure, max
	min: below this number of pages TCP is not bothered about its
	memory appetite.
L
Linus Torvalds 已提交
488

489 490 491 492
	pressure: when amount of memory allocated by TCP exceeds this number
	of pages, TCP moderates its memory consumption and enters memory
	pressure mode, which is exited when memory consumption falls
	under "min".
L
Linus Torvalds 已提交
493

494
	max: number of pages allowed for queueing by all TCP sockets.
L
Linus Torvalds 已提交
495

496 497
	Defaults are calculated at boot time from amount of available
	memory.
L
Linus Torvalds 已提交
498

499 500 501 502 503 504
tcp_min_rtt_wlen - INTEGER
	The window length of the windowed min filter to track the minimum RTT.
	A shorter window lets a flow more quickly pick up new (higher)
	minimum RTT when it is moved to a longer path (e.g., due to traffic
	engineering). A longer window makes the filter more resistant to RTT
	inflations such as transient congestion. The unit is seconds.
505

506
	Possible values: 0 - 86400 (1 day)
507

508 509
	Default: 300

J
John Heffner 已提交
510
tcp_moderate_rcvbuf - BOOLEAN
511
	If set, TCP performs receive buffer auto-tuning, attempting to
J
John Heffner 已提交
512 513 514 515 516 517 518
	automatically size the buffer (no greater than tcp_rmem[2]) to
	match the size required by the path for full throughput.  Enabled by
	default.

tcp_mtu_probing - INTEGER
	Controls TCP Packetization-Layer Path MTU Discovery.  Takes three
	values:
519 520 521 522

	- 0 - Disabled
	- 1 - Disabled by default, enabled when an ICMP black hole detected
	- 2 - Always enabled, use initial MSS of tcp_base_mss.
J
John Heffner 已提交
523

524
tcp_probe_interval - UNSIGNED INTEGER
525 526 527 528 529 530 531 532 533
	Controls how often to start TCP Packetization-Layer Path MTU
	Discovery reprobe. The default is reprobing every 10 minutes as
	per RFC4821.

tcp_probe_threshold - INTEGER
	Controls when TCP Packetization-Layer Path MTU Discovery probing
	will stop in respect to the width of search range in bytes. Default
	is 8 bytes.

J
John Heffner 已提交
534 535 536 537 538
tcp_no_metrics_save - BOOLEAN
	By default, TCP saves various connection metrics in the route cache
	when the connection closes, so that connections established in the
	near future can use these to set initial conditions.  Usually, this
	increases overall performance, but may sometimes cause performance
S
Simon Arlott 已提交
539
	degradation.  If set, TCP will not cache metrics on closing
J
John Heffner 已提交
540 541
	connections.

542 543
tcp_no_ssthresh_metrics_save - BOOLEAN
	Controls whether TCP saves ssthresh metrics in the route cache.
544

545 546
	Default is 1, which disables ssthresh metrics.

547
tcp_orphan_retries - INTEGER
548 549 550 551
	This value influences the timeout of a locally closed TCP connection,
	when RTO retransmissions remain unacknowledged.
	See tcp_retries2 for more details.

552
	The default value is 8.
553

554
	If your machine is a loaded WEB server,
555 556
	you should think about lowering this value, such sockets
	may consume significant resources. Cf. tcp_max_orphans.
L
Linus Torvalds 已提交
557

Y
Yuchung Cheng 已提交
558 559 560 561
tcp_recovery - INTEGER
	This value is a bitmap to enable various experimental loss recovery
	features.

562 563 564 565 566 567 568 569 570
	=========   =============================================================
	RACK: 0x1   enables the RACK loss detection for fast detection of lost
		    retransmissions and tail drops. It also subsumes and disables
		    RFC6675 recovery for SACK connections.

	RACK: 0x2   makes RACK's reordering window static (min_rtt/4).

	RACK: 0x4   disables RACK's DUPACK threshold heuristic
	=========   =============================================================
Y
Yuchung Cheng 已提交
571 572 573

	Default: 0x1

L
Linus Torvalds 已提交
574
tcp_reordering - INTEGER
575 576 577
	Initial reordering level of packets in a TCP stream.
	TCP stack can then dynamically adjust flow reordering level
	between this initial value and tcp_max_reordering
578

579
	Default: 3
L
Linus Torvalds 已提交
580

581 582 583 584
tcp_max_reordering - INTEGER
	Maximal reordering level of packets in a TCP stream.
	300 is a fairly conservative value, but you might increase it
	if paths are using per packet load balancing (like bonding rr mode)
585

586 587
	Default: 300

L
Linus Torvalds 已提交
588 589 590 591 592
tcp_retrans_collapse - BOOLEAN
	Bug-to-bug compatibility with some broken printers.
	On retransmit try to send bigger packets to work around bugs in
	certain TCP stacks.

593
tcp_retries1 - INTEGER
594 595 596 597 598 599 600
	This value influences the time, after which TCP decides, that
	something is wrong due to unacknowledged RTO retransmissions,
	and reports this suspicion to the network layer.
	See tcp_retries2 for more details.

	RFC 1122 recommends at least 3 retransmissions, which is the
	default.
L
Linus Torvalds 已提交
601

602
tcp_retries2 - INTEGER
603 604 605 606 607 608 609 610 611 612 613 614 615
	This value influences the timeout of an alive TCP connection,
	when RTO retransmissions remain unacknowledged.
	Given a value of N, a hypothetical TCP connection following
	exponential backoff with an initial RTO of TCP_RTO_MIN would
	retransmit N times before killing the connection at the (N+1)th RTO.

	The default value of 15 yields a hypothetical timeout of 924.6
	seconds and is a lower bound for the effective timeout.
	TCP will effectively time out at the first RTO which exceeds the
	hypothetical timeout.

	RFC 1122 recommends at least 100 seconds for the timeout,
	which corresponds to a value of at least 8.
L
Linus Torvalds 已提交
616

617 618 619 620
tcp_rfc1337 - BOOLEAN
	If set, the TCP stack behaves conforming to RFC1337. If unset,
	we are not conforming to RFC, but prevent TCP TIME_WAIT
	assassination.
621

622
	Default: 0
L
Linus Torvalds 已提交
623 624 625 626 627

tcp_rmem - vector of 3 INTEGERs: min, default, max
	min: Minimal size of receive buffer used by TCP sockets.
	It is guaranteed to each TCP socket, even under moderate memory
	pressure.
628

629
	Default: 4K
L
Linus Torvalds 已提交
630

631
	default: initial size of receive buffer used by TCP sockets.
L
Linus Torvalds 已提交
632 633 634 635 636 637 638
	This value overrides net.core.rmem_default used by other protocols.
	Default: 87380 bytes. This value results in window of 65535 with
	default setting of tcp_adv_win_scale and tcp_app_win:0 and a bit
	less for default tcp_app_win. See below about these variables.

	max: maximal size of receive buffer allowed for automatically
	selected receiver buffers for TCP socket. This value does not override
639 640 641
	net.core.rmem_max.  Calling setsockopt() with SO_RCVBUF disables
	automatic tuning of that socket's receive buffer size, in which
	case this value is ignored.
642
	Default: between 87380B and 6MB, depending on RAM size.
L
Linus Torvalds 已提交
643

644 645
tcp_sack - BOOLEAN
	Enable select acknowledgments (SACKS).
L
Linus Torvalds 已提交
646

647 648 649 650 651 652 653
tcp_comp_sack_delay_ns - LONG INTEGER
	TCP tries to reduce number of SACK sent, using a timer
	based on 5% of SRTT, capped by this sysctl, in nano seconds.
	The default is 1ms, based on TSO autosizing period.

	Default : 1,000,000 ns (1 ms)

E
Eric Dumazet 已提交
654
tcp_comp_sack_nr - INTEGER
655
	Max number of SACK that can be compressed.
E
Eric Dumazet 已提交
656 657
	Using 0 disables SACK compression.

658
	Default : 44
E
Eric Dumazet 已提交
659

660 661 662 663 664
tcp_slow_start_after_idle - BOOLEAN
	If set, provide RFC2861 behavior and time out the congestion
	window after an idle period.  An idle period is defined at
	the current RTO.  If unset, the congestion window will not
	be timed out after an idle period.
665

666
	Default: 1
L
Linus Torvalds 已提交
667

668
tcp_stdurg - BOOLEAN
669
	Use the Host requirements interpretation of the TCP urgent pointer field.
670 671
	Most hosts use the older BSD interpretation, so if you turn this on
	Linux might not communicate correctly with them.
672

673
	Default: FALSE
L
Linus Torvalds 已提交
674

675 676 677
tcp_synack_retries - INTEGER
	Number of times SYNACKs for a passive TCP connection attempt will
	be retransmitted. Should not be higher than 255. Default value
678 679 680
	is 5, which corresponds to 31seconds till the last retransmission
	with the current initial RTO of 1second. With this the final timeout
	for a passive TCP connection will happen after 63seconds.
L
Linus Torvalds 已提交
681

682
tcp_syncookies - INTEGER
683
	Only valid when the kernel was compiled with CONFIG_SYN_COOKIES
684
	Send out syncookies when the syn backlog queue of a socket
685
	overflows. This is to prevent against the common 'SYN flood attack'
686
	Default: 1
L
Linus Torvalds 已提交
687

688 689
	Note, that syncookies is fallback facility.
	It MUST NOT be used to help highly loaded servers to stand
690
	against legal connection rate. If you see SYN flood warnings
691 692 693 694
	in your logs, but investigation	shows that they occur
	because of overload with legal connections, you should tune
	another parameters until this warning disappear.
	See: tcp_max_syn_backlog, tcp_synack_retries, tcp_abort_on_overflow.
L
Linus Torvalds 已提交
695

696 697 698 699
	syncookies seriously violate TCP protocol, do not allow
	to use TCP extensions, can result in serious degradation
	of some services (f.e. SMTP relaying), visible not by you,
	but your clients and relays, contacting you. While you see
700
	SYN flood warnings in logs not being really flooded, your server
701
	is seriously misconfigured.
L
Linus Torvalds 已提交
702

703 704 705 706
	If you want to test which effects syncookies have to your
	network connections you can set this knob to 2 to enable
	unconditionally generation of syncookies.

707
tcp_fastopen - INTEGER
708 709
	Enable TCP Fast Open (RFC7413) to send and accept data in the opening
	SYN packet.
710

711 712 713
	The client support is enabled by flag 0x1 (on by default). The client
	then must use sendmsg() or sendto() with the MSG_FASTOPEN flag,
	rather than connect() to send data in SYN.
714

715 716 717 718
	The server support is enabled by flag 0x2 (off by default). Then
	either enable for all listeners with another flag (0x400) or
	enable individual listeners via TCP_FASTOPEN socket option with
	the option value being the length of the syn-data backlog.
719

720
	The values (bitmap) are
721 722 723 724

	=====  ======== ======================================================
	  0x1  (client) enables sending data in the opening SYN on the client.
	  0x2  (server) enables the server support, i.e., allowing data in
725 726
			a SYN packet to be accepted and passed to the
			application before 3-way handshake finishes.
727
	  0x4  (client) send data in the opening SYN regardless of cookie
728
			availability and without a cookie option.
729 730
	0x200  (server) accept data-in-SYN w/o any cookie option present.
	0x400  (server) enable all listeners to support Fast Open by
731
			default without explicit TCP_FASTOPEN socket option.
732
	=====  ======== ======================================================
733 734

	Default: 0x1
735

736 737
	Note that that additional client or server features are only
	effective if the basic support (0x1 and 0x2) are enabled respectively.
738

739 740 741 742 743 744
tcp_fastopen_blackhole_timeout_sec - INTEGER
	Initial time period in second to disable Fastopen on active TCP sockets
	when a TFO firewall blackhole issue happens.
	This time period will grow exponentially when more blackhole issues
	get detected right after Fastopen is re-enabled and will reset to
	initial value when the blackhole issue goes away.
745
	0 to disable the blackhole detection.
746

747 748
	By default, it is set to 1hr.

749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
tcp_fastopen_key - list of comma separated 32-digit hexadecimal INTEGERs
	The list consists of a primary key and an optional backup key. The
	primary key is used for both creating and validating cookies, while the
	optional backup key is only used for validating cookies. The purpose of
	the backup key is to maximize TFO validation when keys are rotated.

	A randomly chosen primary key may be configured by the kernel if
	the tcp_fastopen sysctl is set to 0x400 (see above), or if the
	TCP_FASTOPEN setsockopt() optname is set and a key has not been
	previously configured via sysctl. If keys are configured via
	setsockopt() by using the TCP_FASTOPEN_KEY optname, then those
	per-socket keys will be used instead of any keys that are specified via
	sysctl.

	A key is specified as 4 8-digit hexadecimal integers which are separated
	by a '-' as: xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx. Leading zeros may be
	omitted. A primary and a backup key may be specified by separating them
	by a comma. If only one key is specified, it becomes the primary key and
	any previously configured backup keys are removed.

769 770
tcp_syn_retries - INTEGER
	Number of times initial SYNs for an active TCP connection attempt
771
	will be retransmitted. Should not be higher than 127. Default value
772
	is 6, which corresponds to 63seconds till the last retransmission
773 774
	with the current initial RTO of 1second. With this the final timeout
	for an active TCP connection attempt will happen after 127seconds.
775

776
tcp_timestamps - INTEGER
777 778 779 780 781 782 783
	Enable timestamps as defined in RFC1323.

	- 0: Disabled.
	- 1: Enable timestamps as defined in RFC1323 and use random offset for
	  each connection rather than only using the current time.
	- 2: Like 1, but without random offsets.

784
	Default: 1
L
Linus Torvalds 已提交
785

E
Eric Dumazet 已提交
786 787
tcp_min_tso_segs - INTEGER
	Minimal number of segments per TSO frame.
788

E
Eric Dumazet 已提交
789 790 791 792 793
	Since linux-3.12, TCP does an automatic sizing of TSO frames,
	depending on flow rate, instead of filling 64Kbytes packets.
	For specific usages, it's possible to force TCP to build big
	TSO frames. Note that TCP stack might split too big TSO packets
	if available window is too small.
794

E
Eric Dumazet 已提交
795 796
	Default: 2

797 798 799 800 801 802
tcp_pacing_ss_ratio - INTEGER
	sk->sk_pacing_rate is set by TCP stack using a ratio applied
	to current rate. (current_rate = cwnd * mss / srtt)
	If TCP is in slow start, tcp_pacing_ss_ratio is applied
	to let TCP probe for bigger speeds, assuming cwnd can be
	doubled every other RTT.
803

804 805 806 807 808 809 810
	Default: 200

tcp_pacing_ca_ratio - INTEGER
	sk->sk_pacing_rate is set by TCP stack using a ratio applied
	to current rate. (current_rate = cwnd * mss / srtt)
	If TCP is in congestion avoidance phase, tcp_pacing_ca_ratio
	is applied to conservatively probe for bigger throughput.
811

812 813
	Default: 120

L
Linus Torvalds 已提交
814
tcp_tso_win_divisor - INTEGER
815 816 817 818
	This allows control over what percentage of the congestion window
	can be consumed by a single TSO frame.
	The setting of this parameter is a choice between burstiness and
	building larger TSO frames.
819

820
	Default: 3
L
Linus Torvalds 已提交
821

822 823 824
tcp_tw_reuse - INTEGER
	Enable reuse of TIME-WAIT sockets for new connections when it is
	safe from protocol viewpoint.
825 826 827 828 829

	- 0 - disable
	- 1 - global enable
	- 2 - enable for loopback traffic only

830 831
	It should not be changed without advice/request of technical
	experts.
832

833
	Default: 2
834

835 836
tcp_window_scaling - BOOLEAN
	Enable window scaling as defined in RFC1323.
837

838
tcp_wmem - vector of 3 INTEGERs: min, default, max
839
	min: Amount of memory reserved for send buffers for TCP sockets.
840
	Each TCP socket has rights to use it due to fact of its birth.
841

842
	Default: 4K
843

844 845
	default: initial size of send buffer used by TCP sockets.  This
	value overrides net.core.wmem_default used by other protocols.
846

847
	It is usually lower than net.core.wmem_default.
848

849 850
	Default: 16K

851 852 853 854 855
	max: Maximal amount of memory allowed for automatically tuned
	send buffers for TCP sockets. This value does not override
	net.core.wmem_max.  Calling setsockopt() with SO_SNDBUF disables
	automatic tuning of that socket's send buffer size, in which case
	this value is ignored.
856

857
	Default: between 64K and 4MB, depending on RAM size.
L
Linus Torvalds 已提交
858

859 860 861 862 863 864 865 866 867 868 869 870 871
tcp_notsent_lowat - UNSIGNED INTEGER
	A TCP socket can control the amount of unsent bytes in its write queue,
	thanks to TCP_NOTSENT_LOWAT socket option. poll()/select()/epoll()
	reports POLLOUT events if the amount of unsent bytes is below a per
	socket value, and if the write queue is not full. sendmsg() will
	also not add new buffers if the limit is hit.

	This global variable controls the amount of unsent data for
	sockets not using TCP_NOTSENT_LOWAT. For these sockets, a change
	to the global variable has immediate effect.

	Default: UINT_MAX (0xFFFFFFFF)

872 873 874 875 876
tcp_workaround_signed_windows - BOOLEAN
	If set, assume no receipt of a window scaling option means the
	remote TCP is broken and treats the window as a signed quantity.
	If unset, assume the remote TCP is not broken even if we do
	not receive a window scaling option from them.
877

878 879
	Default: 0

A
Andreas Petlund 已提交
880 881 882 883 884 885 886 887 888
tcp_thin_linear_timeouts - BOOLEAN
	Enable dynamic triggering of linear timeouts for thin streams.
	If set, a check is performed upon retransmission by timeout to
	determine if the stream is thin (less than 4 packets in flight).
	As long as the stream is found to be thin, up to 6 linear
	timeouts may be performed before exponential backoff mode is
	initiated. This improves retransmission latency for
	non-aggressive thin streams, often found to be time-dependent.
	For more information on thin streams, see
889
	Documentation/networking/tcp-thin.rst
890

A
Andreas Petlund 已提交
891 892
	Default: 0

E
Eric Dumazet 已提交
893 894 895 896
tcp_limit_output_bytes - INTEGER
	Controls TCP Small Queue limit per tcp socket.
	TCP bulk sender tends to increase packets in flight until it
	gets losses notifications. With SNDBUF autotuning, this can
897 898 899 900 901
	result in a large amount of packets queued on the local machine
	(e.g.: qdiscs, CPU backlog, or device) hurting latency of other
	flows, for typical pfifo_fast qdiscs.  tcp_limit_output_bytes
	limits the number of bytes on qdisc or device to reduce artificial
	RTT/cwnd and reduce bufferbloat.
902

903
	Default: 1048576 (16 * 65536)
E
Eric Dumazet 已提交
904

E
Eric Dumazet 已提交
905 906 907
tcp_challenge_ack_limit - INTEGER
	Limits number of Challenge ACK sent per second, as recommended
	in RFC 5961 (Improving TCP's Robustness to Blind In-Window Attacks)
908
	Default: 1000
E
Eric Dumazet 已提交
909

E
Eric Dumazet 已提交
910 911 912 913 914 915 916 917
tcp_rx_skb_cache - BOOLEAN
	Controls a per TCP socket cache of one skb, that might help
	performance of some workloads. This might be dangerous
	on systems with a lot of TCP sockets, since it increases
	memory usage.

	Default: 0 (disabled)

918 919
UDP variables
=============
H
Hideo Aoki 已提交
920

921 922 923 924 925 926
udp_l3mdev_accept - BOOLEAN
	Enabling this option allows a "global" bound socket to work
	across L3 master domains (e.g., VRFs) with packets capable of
	being received regardless of the L3 domain in which they
	originated. Only valid when the kernel was compiled with
	CONFIG_NET_L3_MASTER_DEV.
927 928

	Default: 0 (disabled)
929

H
Hideo Aoki 已提交
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
udp_mem - vector of 3 INTEGERs: min, pressure, max
	Number of pages allowed for queueing by all UDP sockets.

	min: Below this number of pages UDP is not bothered about its
	memory appetite. When amount of memory allocated by UDP exceeds
	this number, UDP starts to moderate memory usage.

	pressure: This value was introduced to follow format of tcp_mem.

	max: Number of pages allowed for queueing by all UDP sockets.

	Default is calculated at boot time from amount of available memory.

udp_rmem_min - INTEGER
	Minimal size of receive buffer used by UDP sockets in moderation.
	Each UDP socket is able to use the size for receiving data, even if
	total pages of UDP sockets exceed udp_mem pressure. The unit is byte.
947

948
	Default: 4K
H
Hideo Aoki 已提交
949 950 951 952 953

udp_wmem_min - INTEGER
	Minimal size of send buffer used by UDP sockets in moderation.
	Each UDP socket is able to use the size for sending data, even if
	total pages of UDP sockets exceed udp_mem pressure. The unit is byte.
954

955
	Default: 4K
H
Hideo Aoki 已提交
956

957 958
RAW variables
=============
959 960 961 962 963 964 965

raw_l3mdev_accept - BOOLEAN
	Enabling this option allows a "global" bound socket to work
	across L3 master domains (e.g., VRFs) with packets capable of
	being received regardless of the L3 domain in which they
	originated. Only valid when the kernel was compiled with
	CONFIG_NET_L3_MASTER_DEV.
966

967 968
	Default: 1 (enabled)

969 970
CIPSOv4 Variables
=================
P
Paul Moore 已提交
971 972 973 974 975 976 977

cipso_cache_enable - BOOLEAN
	If set, enable additions to and lookups from the CIPSO label mapping
	cache.  If unset, additions are ignored and lookups always result in a
	miss.  However, regardless of the setting the cache is still
	invalidated when required when means you can safely toggle this on and
	off and the cache will always be "safe".
978

P
Paul Moore 已提交
979 980 981 982 983 984 985 986 987
	Default: 1

cipso_cache_bucket_size - INTEGER
	The CIPSO label cache consists of a fixed size hash table with each
	hash bucket containing a number of cache entries.  This variable limits
	the number of entries in each hash bucket; the larger the value the
	more CIPSO label mappings that can be cached.  When the number of
	entries in a given hash bucket reaches this limit adding new entries
	causes the oldest entry in the bucket to be removed to make room.
988

P
Paul Moore 已提交
989 990 991 992 993 994 995
	Default: 10

cipso_rbm_optfmt - BOOLEAN
	Enable the "Optimized Tag 1 Format" as defined in section 3.4.2.6 of
	the CIPSO draft specification (see Documentation/netlabel for details).
	This means that when set the CIPSO tag will be padded with empty
	categories in order to make the packet data 32-bit aligned.
996

P
Paul Moore 已提交
997 998 999 1000 1001 1002 1003 1004 1005
	Default: 0

cipso_rbm_structvalid - BOOLEAN
	If set, do a very strict check of the CIPSO option when
	ip_options_compile() is called.  If unset, relax the checks done during
	ip_options_compile().  Either way is "safe" as errors are caught else
	where in the CIPSO processing code but setting this to 0 (False) should
	result in less work (i.e. it should be faster) but could cause problems
	with other implementations that require strict checking.
1006

P
Paul Moore 已提交
1007 1008
	Default: 0

1009 1010
IP Variables
============
L
Linus Torvalds 已提交
1011 1012 1013

ip_local_port_range - 2 INTEGERS
	Defines the local port range that is used by TCP and UDP to
1014
	choose the local port. The first number is the first, the
1015
	second the last local port number.
1016 1017 1018
	If possible, it is better these numbers have different parity
	(one even and one odd value).
	Must be greater than or equal to ip_unprivileged_port_start.
1019
	The default values are 32768 and 60999 respectively.
L
Linus Torvalds 已提交
1020

1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
ip_local_reserved_ports - list of comma separated ranges
	Specify the ports which are reserved for known third-party
	applications. These ports will not be used by automatic port
	assignments (e.g. when calling connect() or bind() with port
	number 0). Explicit port allocation behavior is unchanged.

	The format used for both input and output is a comma separated
	list of ranges (e.g. "1,2-4,10-10" for ports 1, 2, 3, 4 and
	10). Writing to the file will clear all previously reserved
	ports and update the current list with the one given in the
	input.

	Note that ip_local_port_range and ip_local_reserved_ports
	settings are independent and both are considered by the kernel
	when determining which ports are available for automatic port
	assignments.

	You can reserve ports which are not in the current
1039
	ip_local_port_range, e.g.::
1040

1041 1042 1043 1044
	    $ cat /proc/sys/net/ipv4/ip_local_port_range
	    32000	60999
	    $ cat /proc/sys/net/ipv4/ip_local_reserved_ports
	    8080,9148
1045 1046 1047 1048 1049 1050 1051

	although this is redundant. However such a setting is useful
	if later the port range is changed to a value that will
	include the reserved ports.

	Default: Empty

1052 1053 1054 1055
ip_unprivileged_port_start - INTEGER
	This is a per-namespace sysctl.  It defines the first
	unprivileged port in the network namespace.  Privileged ports
	require root or CAP_NET_BIND_SERVICE in order to bind to them.
1056 1057
	To disable all privileged ports, set this to 0.  They must not
	overlap with the ip_local_port_range.
1058 1059 1060

	Default: 1024

L
Linus Torvalds 已提交
1061 1062 1063
ip_nonlocal_bind - BOOLEAN
	If set, allows processes to bind() to non-local IP addresses,
	which can be quite useful - but may break some applications.
1064

L
Linus Torvalds 已提交
1065 1066
	Default: 0

1067 1068 1069 1070 1071 1072 1073 1074 1075
ip_autobind_reuse - BOOLEAN
	By default, bind() does not select the ports automatically even if
	the new socket and all sockets bound to the port have SO_REUSEADDR.
	ip_autobind_reuse allows bind() to reuse the port and this is useful
	when you use bind()+connect(), but may break some applications.
	The preferred solution is to use IP_BIND_ADDRESS_NO_PORT and this
	option should only be set by experts.
	Default: 0

L
Linus Torvalds 已提交
1076 1077 1078 1079 1080
ip_dynaddr - BOOLEAN
	If set non-zero, enables support for dynamic addresses.
	If set to a non-zero value larger than 1, a kernel log
	message will be printed when dynamic address rewriting
	occurs.
1081

L
Linus Torvalds 已提交
1082 1083
	Default: 0

1084 1085 1086
ip_early_demux - BOOLEAN
	Optimize input packet processing down to one demux for
	certain kinds of local sockets.  Currently we only do this
1087
	for established TCP and connected UDP sockets.
1088 1089 1090

	It may add an additional cost for pure routing workloads that
	reduces overall throughput, in such case you should disable it.
1091

1092 1093
	Default: 1

1094 1095 1096 1097 1098 1099 1100
ping_group_range - 2 INTEGERS
	Restrict ICMP_PROTO datagram sockets to users in the group range.
	The default is "1 0", meaning, that nobody (not even root) may
	create ping sockets.  Setting it to "100 100" would grant permissions
	to the single group. "0 4294967295" would enable it for the world, "100
	4294967295" would enable it for the users, but not daemons.

1101 1102
tcp_early_demux - BOOLEAN
	Enable early demux for established TCP sockets.
1103

1104 1105 1106 1107 1108
	Default: 1

udp_early_demux - BOOLEAN
	Enable early demux for connected UDP sockets. Disable this if
	your system could experience more unconnected load.
1109

1110 1111
	Default: 1

L
Linus Torvalds 已提交
1112
icmp_echo_ignore_all - BOOLEAN
1113 1114
	If set non-zero, then the kernel will ignore all ICMP ECHO
	requests sent to it.
1115

1116 1117
	Default: 0

L
Linus Torvalds 已提交
1118
icmp_echo_ignore_broadcasts - BOOLEAN
1119 1120
	If set non-zero, then the kernel will ignore all ICMP ECHO and
	TIMESTAMP requests sent to it via broadcast/multicast.
1121

1122
	Default: 1
L
Linus Torvalds 已提交
1123 1124 1125 1126

icmp_ratelimit - INTEGER
	Limit the maximal rates for sending ICMP packets whose type matches
	icmp_ratemask (see below) to specific targets.
1127 1128
	0 to disable any limiting,
	otherwise the minimal space between responses in milliseconds.
1129 1130
	Note that another sysctl, icmp_msgs_per_sec limits the number
	of ICMP packets	sent on all targets.
1131

1132
	Default: 1000
L
Linus Torvalds 已提交
1133

1134 1135 1136 1137
icmp_msgs_per_sec - INTEGER
	Limit maximal number of ICMP packets sent per second from this host.
	Only messages whose type matches icmp_ratemask (see below) are
	controlled by this limit.
1138

1139
	Default: 1000
L
Linus Torvalds 已提交
1140

1141 1142 1143
icmp_msgs_burst - INTEGER
	icmp_msgs_per_sec controls number of ICMP packets sent per second,
	while icmp_msgs_burst controls the burst size of these packets.
1144

1145 1146
	Default: 50

L
Linus Torvalds 已提交
1147 1148
icmp_ratemask - INTEGER
	Mask made of ICMP types for which rates are being limited.
1149

L
Linus Torvalds 已提交
1150
	Significant bits: IHGFEDCBA9876543210
1151

L
Linus Torvalds 已提交
1152 1153 1154
	Default mask:     0000001100000011000 (6168)

	Bit definitions (see include/linux/icmp.h):
1155 1156

		= =========================
L
Linus Torvalds 已提交
1157
		0 Echo Reply
1158 1159
		3 Destination Unreachable [1]_
		4 Source Quench [1]_
L
Linus Torvalds 已提交
1160 1161
		5 Redirect
		8 Echo Request
1162 1163
		B Time Exceeded [1]_
		C Parameter Problem [1]_
L
Linus Torvalds 已提交
1164 1165 1166 1167 1168 1169
		D Timestamp Request
		E Timestamp Reply
		F Info Request
		G Info Reply
		H Address Mask Request
		I Address Mask Reply
1170
		= =========================
L
Linus Torvalds 已提交
1171

1172
	.. [1] These are rate limited by default (see default mask above)
L
Linus Torvalds 已提交
1173 1174 1175 1176 1177 1178

icmp_ignore_bogus_error_responses - BOOLEAN
	Some routers violate RFC1122 by sending bogus responses to broadcast
	frames.  Such violations are normally logged via a kernel warning.
	If this is set to TRUE, the kernel will not give such warnings, which
	will avoid log file clutter.
1179

1180
	Default: 1
L
Linus Torvalds 已提交
1181

1182 1183
icmp_errors_use_inbound_ifaddr - BOOLEAN

1184 1185
	If zero, icmp error messages are sent with the primary address of
	the exiting interface.
1186

1187 1188 1189 1190
	If non-zero, the message will be sent with the primary address of
	the interface that received the packet that caused the icmp error.
	This is the behaviour network many administrators will expect from
	a router. And it can make debugging complicated network layouts
1191
	much easier.
1192 1193 1194

	Note that if no primary address exists for the interface selected,
	then the primary address of the first non-loopback interface that
1195
	has one will be used regardless of this setting.
1196 1197 1198

	Default: 0

L
Linus Torvalds 已提交
1199 1200 1201 1202
igmp_max_memberships - INTEGER
	Change the maximum number of multicast groups we can subscribe to.
	Default: 20

1203 1204 1205 1206
	Theoretical maximum value is bounded by having to send a membership
	report in a single datagram (i.e. the report can't span multiple
	datagrams, or risk confusing the switch and leaving groups you don't
	intend to).
L
Linus Torvalds 已提交
1207

1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
	The number of supported groups 'M' is bounded by the number of group
	report entries you can fit into a single datagram of 65535 bytes.

	M = 65536-sizeof (ip header)/(sizeof(Group record))

	Group records are variable length, with a minimum of 12 bytes.
	So net.ipv4.igmp_max_memberships should not be set higher than:

	(65536-24) / 12 = 5459

	The value 5459 assumes no IP header options, so in practice
	this number may be lower.

1221 1222 1223
igmp_max_msf - INTEGER
	Maximum number of addresses allowed in the source filter list for a
	multicast group.
1224

1225 1226
	Default: 10

1227
igmp_qrv - INTEGER
1228
	Controls the IGMP query robustness variable (see RFC2236 8.1).
1229

1230
	Default: 2 (as specified by RFC2236 8.1)
1231

1232
	Minimum: 1 (as specified by RFC6636 4.5)
1233

1234
force_igmp_version - INTEGER
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
	- 0 - (default) No enforcement of a IGMP version, IGMPv1/v2 fallback
	  allowed. Will back to IGMPv3 mode again if all IGMPv1/v2 Querier
	  Present timer expires.
	- 1 - Enforce to use IGMP version 1. Will also reply IGMPv1 report if
	  receive IGMPv2/v3 query.
	- 2 - Enforce to use IGMP version 2. Will fallback to IGMPv1 if receive
	  IGMPv1 query message. Will reply report if receive IGMPv3 query.
	- 3 - Enforce to use IGMP version 3. The same react with default 0.

	.. note::
1245

1246 1247 1248 1249
	   this is not the same with force_mld_version because IGMPv3 RFC3376
	   Security Considerations does not have clear description that we could
	   ignore other version messages completely as MLDv2 RFC3810. So make
	   this value as default 0 is recommended.
1250

1251 1252 1253
``conf/interface/*``
	changes special settings per interface (where
	interface" is the name of your network interface)
1254

1255 1256
``conf/all/*``
	  is special, changes the settings for all interfaces
1257

L
Linus Torvalds 已提交
1258 1259 1260 1261 1262 1263 1264 1265 1266
log_martians - BOOLEAN
	Log packets with impossible addresses to kernel log.
	log_martians for the interface will be enabled if at least one of
	conf/{all,interface}/log_martians is set to TRUE,
	it will be disabled otherwise

accept_redirects - BOOLEAN
	Accept ICMP redirect messages.
	accept_redirects for the interface will be enabled if:
1267

1268 1269
	- both conf/{all,interface}/accept_redirects are TRUE in the case
	  forwarding for the interface is enabled
1270

L
Linus Torvalds 已提交
1271
	or
1272

1273 1274
	- at least one of conf/{all,interface}/accept_redirects is TRUE in the
	  case forwarding for the interface is disabled
1275

L
Linus Torvalds 已提交
1276
	accept_redirects for the interface will be disabled otherwise
1277 1278 1279 1280 1281

	default:

		- TRUE (host)
		- FALSE (router)
L
Linus Torvalds 已提交
1282 1283

forwarding - BOOLEAN
1284 1285
	Enable IP forwarding on this interface.  This controls whether packets
	received _on_ this interface can be forwarded.
L
Linus Torvalds 已提交
1286 1287 1288 1289

mc_forwarding - BOOLEAN
	Do multicast routing. The kernel needs to be compiled with CONFIG_MROUTE
	and a multicast routing daemon is required.
1290 1291
	conf/all/mc_forwarding must also be set to TRUE to enable multicast
	routing	for the interface
L
Linus Torvalds 已提交
1292 1293 1294 1295 1296 1297 1298

medium_id - INTEGER
	Integer value used to differentiate the devices by the medium they
	are attached to. Two devices can have different id values when
	the broadcast packets are received only on one of them.
	The default value 0 means that the device is the only interface
	to its medium, value of -1 means that medium is not known.
1299

L
Linus Torvalds 已提交
1300 1301 1302 1303 1304 1305
	Currently, it is used to change the proxy_arp behavior:
	the proxy_arp feature is enabled for packets forwarded between
	two devices attached to different media.

proxy_arp - BOOLEAN
	Do proxy arp.
1306

L
Linus Torvalds 已提交
1307 1308 1309 1310
	proxy_arp for the interface will be enabled if at least one of
	conf/{all,interface}/proxy_arp is set to TRUE,
	it will be disabled otherwise

1311 1312
proxy_arp_pvlan - BOOLEAN
	Private VLAN proxy arp.
1313

1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
	Basically allow proxy arp replies back to the same interface
	(from which the ARP request/solicitation was received).

	This is done to support (ethernet) switch features, like RFC
	3069, where the individual ports are NOT allowed to
	communicate with each other, but they are allowed to talk to
	the upstream router.  As described in RFC 3069, it is possible
	to allow these hosts to communicate through the upstream
	router by proxy_arp'ing. Don't need to be used together with
	proxy_arp.

	This technology is known by different names:
1326

1327 1328 1329 1330 1331
	  In RFC 3069 it is called VLAN Aggregation.
	  Cisco and Allied Telesyn call it Private VLAN.
	  Hewlett-Packard call it Source-Port filtering or port-isolation.
	  Ericsson call it MAC-Forced Forwarding (RFC Draft).

L
Linus Torvalds 已提交
1332 1333
shared_media - BOOLEAN
	Send(router) or accept(host) RFC1620 shared media redirects.
1334
	Overrides secure_redirects.
1335

L
Linus Torvalds 已提交
1336 1337 1338
	shared_media for the interface will be enabled if at least one of
	conf/{all,interface}/shared_media is set to TRUE,
	it will be disabled otherwise
1339

L
Linus Torvalds 已提交
1340 1341 1342
	default TRUE

secure_redirects - BOOLEAN
1343 1344 1345
	Accept ICMP redirect messages only to gateways listed in the
	interface's current gateway list. Even if disabled, RFC1122 redirect
	rules still apply.
1346

1347
	Overridden by shared_media.
1348

L
Linus Torvalds 已提交
1349 1350 1351
	secure_redirects for the interface will be enabled if at least one of
	conf/{all,interface}/secure_redirects is set to TRUE,
	it will be disabled otherwise
1352

L
Linus Torvalds 已提交
1353 1354 1355 1356
	default TRUE

send_redirects - BOOLEAN
	Send redirects, if router.
1357

L
Linus Torvalds 已提交
1358 1359 1360
	send_redirects for the interface will be enabled if at least one of
	conf/{all,interface}/send_redirects is set to TRUE,
	it will be disabled otherwise
1361

L
Linus Torvalds 已提交
1362 1363 1364 1365 1366 1367 1368 1369
	Default: TRUE

bootp_relay - BOOLEAN
	Accept packets with source address 0.b.c.d destined
	not to this host as local ones. It is supposed, that
	BOOTP relay daemon will catch and forward such packets.
	conf/all/bootp_relay must also be set to TRUE to enable BOOTP relay
	for the interface
1370

L
Linus Torvalds 已提交
1371
	default FALSE
1372

L
Linus Torvalds 已提交
1373 1374 1375 1376 1377 1378
	Not Implemented Yet.

accept_source_route - BOOLEAN
	Accept packets with SRR option.
	conf/all/accept_source_route must also be set to TRUE to accept packets
	with SRR option on the interface
1379 1380 1381 1382 1383

	default

		- TRUE (router)
		- FALSE (host)
L
Linus Torvalds 已提交
1384

1385
accept_local - BOOLEAN
1386 1387 1388
	Accept packets with local source addresses. In combination with
	suitable routing, this can be used to direct packets between two
	local interfaces over the wire and have them accepted properly.
1389 1390
	default FALSE

1391 1392 1393
route_localnet - BOOLEAN
	Do not consider loopback addresses as martian source or destination
	while routing. This enables the use of 127/8 for local routing purposes.
1394

1395 1396
	default FALSE

1397
rp_filter - INTEGER
1398 1399 1400 1401 1402 1403 1404 1405 1406
	- 0 - No source validation.
	- 1 - Strict mode as defined in RFC3704 Strict Reverse Path
	  Each incoming packet is tested against the FIB and if the interface
	  is not the best reverse path the packet check will fail.
	  By default failed packets are discarded.
	- 2 - Loose mode as defined in RFC3704 Loose Reverse Path
	  Each incoming packet's source address is also tested against the FIB
	  and if the source address is not reachable via any interface
	  the packet check will fail.
1407

1408
	Current recommended practice in RFC3704 is to enable strict mode
1409
	to prevent IP spoofing from DDos attacks. If using asymmetric routing
1410
	or other complicated routing, then loose mode is recommended.
1411

1412 1413
	The max value from conf/{all,interface}/rp_filter is used
	when doing source validation on the {interface}.
L
Linus Torvalds 已提交
1414 1415 1416 1417 1418

	Default value is 0. Note that some distributions enable it
	in startup scripts.

arp_filter - BOOLEAN
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431
	- 1 - Allows you to have multiple network interfaces on the same
	  subnet, and have the ARPs for each interface be answered
	  based on whether or not the kernel would route a packet from
	  the ARP'd IP out that interface (therefore you must use source
	  based routing for this to work). In other words it allows control
	  of which cards (usually 1) will respond to an arp request.

	- 0 - (default) The kernel can respond to arp requests with addresses
	  from other interfaces. This may seem wrong but it usually makes
	  sense, because it increases the chance of successful communication.
	  IP addresses are owned by the complete host on Linux, not by
	  particular interfaces. Only for more complex setups like load-
	  balancing, does this behaviour cause problems.
L
Linus Torvalds 已提交
1432 1433 1434 1435 1436 1437 1438 1439 1440

	arp_filter for the interface will be enabled if at least one of
	conf/{all,interface}/arp_filter is set to TRUE,
	it will be disabled otherwise

arp_announce - INTEGER
	Define different restriction levels for announcing the local
	source IP address from IP packets in ARP requests sent on
	interface:
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461

	- 0 - (default) Use any local address, configured on any interface
	- 1 - Try to avoid local addresses that are not in the target's
	  subnet for this interface. This mode is useful when target
	  hosts reachable via this interface require the source IP
	  address in ARP requests to be part of their logical network
	  configured on the receiving interface. When we generate the
	  request we will check all our subnets that include the
	  target IP and will preserve the source address if it is from
	  such subnet. If there is no such subnet we select source
	  address according to the rules for level 2.
	- 2 - Always use the best local address for this target.
	  In this mode we ignore the source address in the IP packet
	  and try to select local address that we prefer for talks with
	  the target host. Such local address is selected by looking
	  for primary IP addresses on all our subnets on the outgoing
	  interface that include the target IP address. If no suitable
	  local address is found we select the first local address
	  we have on the outgoing interface or on all other interfaces,
	  with the hope we will receive reply for our request and
	  even sometimes no matter the source IP address we announce.
L
Linus Torvalds 已提交
1462 1463 1464 1465 1466 1467 1468 1469 1470 1471

	The max value from conf/{all,interface}/arp_announce is used.

	Increasing the restriction level gives more chance for
	receiving answer from the resolved target while decreasing
	the level announces more valid sender's information.

arp_ignore - INTEGER
	Define different modes for sending replies in response to
	received ARP requests that resolve local target IP addresses:
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483

	- 0 - (default): reply for any local target IP address, configured
	  on any interface
	- 1 - reply only if the target IP address is local address
	  configured on the incoming interface
	- 2 - reply only if the target IP address is local address
	  configured on the incoming interface and both with the
	  sender's IP address are part from same subnet on this interface
	- 3 - do not reply for local addresses configured with scope host,
	  only resolutions for global and link addresses are replied
	- 4-7 - reserved
	- 8 - do not reply for all local addresses
L
Linus Torvalds 已提交
1484 1485 1486 1487

	The max value from conf/{all,interface}/arp_ignore is used
	when ARP request is received on the {interface}

1488 1489
arp_notify - BOOLEAN
	Define mode for notification of address and device changes.
1490 1491 1492 1493 1494 1495

	 ==  ==========================================================
	  0  (default): do nothing
	  1  Generate gratuitous arp requests when device is brought up
	     or hardware address changes.
	 ==  ==========================================================
1496

1497
arp_accept - BOOLEAN
1498 1499
	Define behavior for gratuitous ARP frames who's IP is not
	already present in the ARP table:
1500 1501 1502

	- 0 - don't create new entries in the ARP table
	- 1 - create new entries in the ARP table
1503 1504 1505 1506 1507 1508 1509 1510

	Both replies and requests type gratuitous arp will trigger the
	ARP table to be updated, if this setting is on.

	If the ARP table already contains the IP address of the
	gratuitous arp frame, the arp table will be updated regardless
	if this setting is on or off.

1511 1512 1513 1514 1515 1516 1517 1518
mcast_solicit - INTEGER
	The maximum number of multicast probes in INCOMPLETE state,
	when the associated hardware address is unknown.  Defaults
	to 3.

ucast_solicit - INTEGER
	The maximum number of unicast probes in PROBE state, when
	the hardware address is being reconfirmed.  Defaults to 3.
1519

L
Linus Torvalds 已提交
1520 1521 1522
app_solicit - INTEGER
	The maximum number of probes to send to the user space ARP daemon
	via netlink before dropping back to multicast probes (see
1523 1524 1525 1526 1527
	mcast_resolicit).  Defaults to 0.

mcast_resolicit - INTEGER
	The maximum number of multicast probes after unicast and
	app probes in PROBE state.  Defaults to 0.
L
Linus Torvalds 已提交
1528 1529 1530 1531 1532 1533 1534

disable_policy - BOOLEAN
	Disable IPSEC policy (SPD) for this interface

disable_xfrm - BOOLEAN
	Disable IPSEC encryption on this interface, whatever the policy

1535 1536 1537
igmpv2_unsolicited_report_interval - INTEGER
	The interval in milliseconds in which the next unsolicited
	IGMPv1 or IGMPv2 report retransmit will take place.
1538

1539
	Default: 10000 (10 seconds)
L
Linus Torvalds 已提交
1540

1541 1542 1543
igmpv3_unsolicited_report_interval - INTEGER
	The interval in milliseconds in which the next unsolicited
	IGMPv3 report retransmit will take place.
1544

1545
	Default: 1000 (1 seconds)
L
Linus Torvalds 已提交
1546

1547 1548 1549 1550 1551
promote_secondaries - BOOLEAN
	When a primary IP address is removed from this interface
	promote a corresponding secondary IP address instead of
	removing all the corresponding secondary IP addresses.

1552 1553 1554
drop_unicast_in_l2_multicast - BOOLEAN
	Drop any unicast IP packets that are received in link-layer
	multicast (or broadcast) frames.
1555

1556 1557
	This behavior (for multicast) is actually a SHOULD in RFC
	1122, but is disabled by default for compatibility reasons.
1558

1559 1560
	Default: off (0)

1561 1562 1563 1564
drop_gratuitous_arp - BOOLEAN
	Drop all gratuitous ARP frames, for example if there's a known
	good ARP proxy on the network and such frames need not be used
	(or in the case of 802.11, must not be used to prevent attacks.)
1565

1566 1567
	Default: off (0)

1568

L
Linus Torvalds 已提交
1569 1570
tag - INTEGER
	Allows you to write a number, which can be used as required.
1571

L
Linus Torvalds 已提交
1572 1573
	Default value is 0.

1574
xfrm4_gc_thresh - INTEGER
1575
	(Obsolete since linux-4.14)
1576 1577
	The threshold at which we will start garbage collecting for IPv4
	destination cache entries.  At twice this value the system will
1578
	refuse new allocations.
1579

1580 1581 1582
igmp_link_local_mcast_reports - BOOLEAN
	Enable IGMP reports for link local multicast groups in the
	224.0.0.X range.
1583

1584 1585
	Default TRUE

L
Linus Torvalds 已提交
1586 1587 1588 1589 1590
Alexey Kuznetsov.
kuznet@ms2.inr.ac.ru

Updated by:

1591 1592 1593 1594
- Andi Kleen
  ak@muc.de
- Nicolas Delon
  delon.nicolas@wanadoo.fr
L
Linus Torvalds 已提交
1595 1596 1597



1598 1599 1600

/proc/sys/net/ipv6/* Variables
==============================
L
Linus Torvalds 已提交
1601 1602 1603 1604 1605 1606

IPv6 has no global variables such as tcp_*.  tcp_* settings under ipv4/ also
apply to IPv6 [XXX?].

bindv6only - BOOLEAN
	Default value for IPV6_V6ONLY socket option,
1607
	which restricts use of the IPv6 socket to IPv6 communication
L
Linus Torvalds 已提交
1608
	only.
1609 1610 1611

		- TRUE: disable IPv4-mapped address feature
		- FALSE: enable IPv4-mapped address feature
L
Linus Torvalds 已提交
1612

1613
	Default: FALSE (as specified in RFC3493)
L
Linus Torvalds 已提交
1614

1615 1616 1617 1618
flowlabel_consistency - BOOLEAN
	Protect the consistency (and unicity) of flow label.
	You have to disable it to use IPV6_FL_F_REFLECT flag on the
	flow label manager.
1619 1620 1621 1622

	- TRUE: enabled
	- FALSE: disabled

1623 1624
	Default: TRUE

1625 1626 1627 1628
auto_flowlabels - INTEGER
	Automatically generate flow labels based on a flow hash of the
	packet. This allows intermediate devices, such as routers, to
	identify packet flows for mechanisms like Equal Cost Multipath
1629
	Routing (see RFC 6438).
1630 1631 1632 1633

	=  ===========================================================
	0  automatic flow labels are completely disabled
	1  automatic flow labels are enabled by default, they can be
1634 1635
	   disabled on a per socket basis using the IPV6_AUTOFLOWLABEL
	   socket option
1636
	2  automatic flow labels are allowed, they may be enabled on a
1637
	   per socket basis using the IPV6_AUTOFLOWLABEL socket option
1638
	3  automatic flow labels are enabled and enforced, they cannot
1639
	   be disabled by the socket option
1640 1641
	=  ===========================================================

1642
	Default: 1
1643

T
Tom Herbert 已提交
1644 1645 1646 1647
flowlabel_state_ranges - BOOLEAN
	Split the flow label number space into two ranges. 0-0x7FFFF is
	reserved for the IPv6 flow manager facility, 0x80000-0xFFFFF
	is reserved for stateless flow labels as described in RFC6437.
1648 1649 1650 1651

	- TRUE: enabled
	- FALSE: disabled

T
Tom Herbert 已提交
1652 1653
	Default: true

1654 1655
flowlabel_reflect - INTEGER
	Control flow label reflection. Needed for Path MTU
1656 1657 1658
	Discovery to work with Equal Cost Multipath Routing in anycast
	environments. See RFC 7690 and:
	https://tools.ietf.org/html/draft-wang-6man-flow-label-reflection-01
1659

1660
	This is a bitmask.
1661

1662 1663 1664 1665 1666
	- 1: enabled for established flows

	  Note that this prevents automatic flowlabel changes, as done
	  in "tcp: change IPv6 flow-label upon receiving spurious retransmission"
	  and "tcp: Change txhash on every SYN and RTO retransmit"
1667

1668 1669 1670
	- 2: enabled for TCP RESET packets (no active listener)
	  If set, a RST packet sent in response to a SYN packet on a closed
	  port will reflect the incoming flow label.
1671

1672
	- 4: enabled for ICMPv6 echo reply messages.
1673

1674
	Default: 0
1675

1676 1677
fib_multipath_hash_policy - INTEGER
	Controls which hash policy to use for multipath routes.
1678

1679
	Default: 0 (Layer 3)
1680

1681
	Possible values:
1682 1683 1684 1685

	- 0 - Layer 3 (source and destination addresses plus flow label)
	- 1 - Layer 4 (standard 5-tuple)
	- 2 - Layer 3 or inner Layer 3 if present
1686

1687 1688 1689
anycast_src_echo_reply - BOOLEAN
	Controls the use of anycast addresses as source addresses for ICMPv6
	echo reply
1690 1691 1692 1693

	- TRUE:  enabled
	- FALSE: disabled

1694 1695
	Default: FALSE

1696 1697 1698 1699
idgen_delay - INTEGER
	Controls the delay in seconds after which time to retry
	privacy stable address generation if a DAD conflict is
	detected.
1700

1701 1702 1703 1704 1705
	Default: 1 (as specified in RFC7217)

idgen_retries - INTEGER
	Controls the number of retries to generate a stable privacy
	address if a DAD conflict is detected.
1706

1707 1708
	Default: 3 (as specified in RFC7217)

1709 1710
mld_qrv - INTEGER
	Controls the MLD query robustness variable (see RFC3810 9.1).
1711

1712
	Default: 2 (as specified by RFC3810 9.1)
1713

1714 1715
	Minimum: 1 (as specified by RFC6636 4.5)

1716
max_dst_opts_number - INTEGER
1717 1718 1719 1720
	Maximum number of non-padding TLVs allowed in a Destination
	options extension header. If this value is less than zero
	then unknown options are disallowed and the number of known
	TLVs allowed is the absolute value of this number.
1721

1722 1723
	Default: 8

1724
max_hbh_opts_number - INTEGER
1725 1726 1727 1728
	Maximum number of non-padding TLVs allowed in a Hop-by-Hop
	options extension header. If this value is less than zero
	then unknown options are disallowed and the number of known
	TLVs allowed is the absolute value of this number.
1729

1730 1731
	Default: 8

1732
max_dst_opts_length - INTEGER
1733 1734
	Maximum length allowed for a Destination options extension
	header.
1735

1736 1737
	Default: INT_MAX (unlimited)

1738
max_hbh_length - INTEGER
1739 1740
	Maximum length allowed for a Hop-by-Hop options extension
	header.
1741

1742 1743
	Default: INT_MAX (unlimited)

1744 1745 1746 1747 1748 1749
skip_notify_on_dev_down - BOOLEAN
	Controls whether an RTM_DELROUTE message is generated for routes
	removed when a device is taken down or deleted. IPv4 does not
	generate this message; IPv6 does by default. Setting this sysctl
	to true skips the message, making IPv4 and IPv6 on par in relying
	on userspace caches to track link events and evict routes.
1750

1751 1752
	Default: false (generate message)

1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764
nexthop_compat_mode - BOOLEAN
	New nexthop API provides a means for managing nexthops independent of
	prefixes. Backwards compatibilty with old route format is enabled by
	default which means route dumps and notifications contain the new
	nexthop attribute but also the full, expanded nexthop definition.
	Further, updates or deletes of a nexthop configuration generate route
	notifications for each fib entry using the nexthop. Once a system
	understands the new API, this sysctl can be disabled to achieve full
	performance benefits of the new API by disabling the nexthop expansion
	and extraneous notifications.
	Default: true (backward compat mode)

L
Linus Torvalds 已提交
1765 1766 1767
IPv6 Fragmentation:

ip6frag_high_thresh - INTEGER
1768
	Maximum memory used to reassemble IPv6 fragments. When
L
Linus Torvalds 已提交
1769 1770 1771
	ip6frag_high_thresh bytes of memory is allocated for this purpose,
	the fragment handler will toss packets until ip6frag_low_thresh
	is reached.
1772

L
Linus Torvalds 已提交
1773
ip6frag_low_thresh - INTEGER
1774
	See ip6frag_high_thresh
L
Linus Torvalds 已提交
1775 1776 1777 1778

ip6frag_time - INTEGER
	Time in seconds to keep an IPv6 fragment in memory.

1779 1780 1781 1782 1783 1784
IPv6 Segment Routing:

seg6_flowlabel - INTEGER
	Controls the behaviour of computing the flowlabel of outer
	IPv6 header in case of SR T.encaps

1785 1786 1787 1788 1789 1790
	 == =======================================================
	 -1  set flowlabel to zero.
	  0  copy flowlabel from Inner packet in case of Inner IPv6
	     (Set flowlabel to 0 in case IPv4/L2)
	  1  Compute the flowlabel using seg6_make_flowlabel()
	 == =======================================================
1791 1792 1793

	Default is 0.

1794
``conf/default/*``:
L
Linus Torvalds 已提交
1795 1796 1797
	Change the interface-specific default settings.


1798
``conf/all/*``:
1799
	Change all the interface-specific settings.
L
Linus Torvalds 已提交
1800 1801 1802 1803

	[XXX:  Other special features than forwarding?]

conf/all/forwarding - BOOLEAN
1804
	Enable global IPv6 forwarding between all interfaces.
L
Linus Torvalds 已提交
1805

1806
	IPv4 and IPv6 work differently here; e.g. netfilter must be used
L
Linus Torvalds 已提交
1807 1808
	to control which interfaces may forward packets and which not.

1809
	This also sets all interfaces' Host/Router setting
L
Linus Torvalds 已提交
1810 1811 1812 1813
	'forwarding' to the specified value.  See below for details.

	This referred to as global forwarding.

1814 1815 1816
proxy_ndp - BOOLEAN
	Do proxy ndp.

1817 1818 1819 1820 1821
fwmark_reflect - BOOLEAN
	Controls the fwmark of kernel-generated IPv6 reply packets that are not
	associated with a socket for example, TCP RSTs or ICMPv6 echo replies).
	If unset, these packets have a fwmark of zero. If set, they have the
	fwmark of the packet they are replying to.
1822

1823 1824
	Default: 0

1825
``conf/interface/*``:
L
Linus Torvalds 已提交
1826 1827
	Change special settings per interface.

1828
	The functional behaviour for certain settings is different
L
Linus Torvalds 已提交
1829 1830
	depending on whether local forwarding is enabled or not.

1831
accept_ra - INTEGER
L
Linus Torvalds 已提交
1832
	Accept Router Advertisements; autoconfigure using them.
1833

1834 1835 1836 1837 1838
	It also determines whether or not to transmit Router
	Solicitations. If and only if the functional setting is to
	accept Router Advertisements, Router Solicitations will be
	transmitted.

1839 1840
	Possible values are:

1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851
		==  ===========================================================
		 0  Do not accept Router Advertisements.
		 1  Accept Router Advertisements if forwarding is disabled.
		 2  Overrule forwarding behaviour. Accept Router Advertisements
		    even if forwarding is enabled.
		==  ===========================================================

	Functional default:

		- enabled if local forwarding is disabled.
		- disabled if local forwarding is enabled.
L
Linus Torvalds 已提交
1852

1853 1854 1855
accept_ra_defrtr - BOOLEAN
	Learn default router in Router Advertisement.

1856 1857 1858 1859
	Functional default:

		- enabled if accept_ra is enabled.
		- disabled if accept_ra is disabled.
1860

1861 1862
accept_ra_from_local - BOOLEAN
	Accept RA with source-address that is found on local machine
1863 1864 1865 1866
	if the RA is otherwise proper and able to be accepted.

	Default is to NOT accept these as it may be an un-intended
	network loop.
1867 1868

	Functional default:
1869 1870 1871 1872 1873

	   - enabled if accept_ra_from_local is enabled
	     on a specific interface.
	   - disabled if accept_ra_from_local is disabled
	     on a specific interface.
1874

1875 1876 1877 1878 1879 1880 1881 1882
accept_ra_min_hop_limit - INTEGER
	Minimum hop limit Information in Router Advertisement.

	Hop limit Information in Router Advertisement less than this
	variable shall be ignored.

	Default: 1

1883
accept_ra_pinfo - BOOLEAN
1884
	Learn Prefix Information in Router Advertisement.
1885

1886 1887 1888 1889
	Functional default:

		- enabled if accept_ra is enabled.
		- disabled if accept_ra is disabled.
1890

1891 1892 1893 1894 1895 1896
accept_ra_rt_info_min_plen - INTEGER
	Minimum prefix length of Route Information in RA.

	Route Information w/ prefix smaller than this variable shall
	be ignored.

1897 1898 1899 1900
	Functional default:

		* 0 if accept_ra_rtr_pref is enabled.
		* -1 if accept_ra_rtr_pref is disabled.
1901

1902 1903 1904
accept_ra_rt_info_max_plen - INTEGER
	Maximum prefix length of Route Information in RA.

1905 1906
	Route Information w/ prefix larger than this variable shall
	be ignored.
1907

1908 1909 1910 1911
	Functional default:

		* 0 if accept_ra_rtr_pref is enabled.
		* -1 if accept_ra_rtr_pref is disabled.
1912

1913 1914 1915
accept_ra_rtr_pref - BOOLEAN
	Accept Router Preference in RA.

1916 1917 1918 1919
	Functional default:

		- enabled if accept_ra is enabled.
		- disabled if accept_ra is disabled.
1920

1921 1922 1923 1924
accept_ra_mtu - BOOLEAN
	Apply the MTU value specified in RA option 5 (RFC4861). If
	disabled, the MTU specified in the RA will be ignored.

1925 1926 1927 1928
	Functional default:

		- enabled if accept_ra is enabled.
		- disabled if accept_ra is disabled.
1929

L
Linus Torvalds 已提交
1930 1931 1932
accept_redirects - BOOLEAN
	Accept Redirects.

1933 1934 1935 1936
	Functional default:

		- enabled if local forwarding is disabled.
		- disabled if local forwarding is enabled.
L
Linus Torvalds 已提交
1937

1938 1939 1940
accept_source_route - INTEGER
	Accept source routing (routing extension header).

1941 1942
	- >= 0: Accept only routing header type 2.
	- < 0: Do not accept routing header.
1943 1944 1945

	Default: 0

L
Linus Torvalds 已提交
1946
autoconf - BOOLEAN
1947
	Autoconfigure addresses using Prefix Information in Router
L
Linus Torvalds 已提交
1948 1949
	Advertisements.

1950 1951 1952 1953
	Functional default:

		- enabled if accept_ra_pinfo is enabled.
		- disabled if accept_ra_pinfo is disabled.
L
Linus Torvalds 已提交
1954 1955 1956

dad_transmits - INTEGER
	The amount of Duplicate Address Detection probes to send.
1957

L
Linus Torvalds 已提交
1958
	Default: 1
1959

1960
forwarding - INTEGER
1961
	Configure interface-specific Host/Router behaviour.
L
Linus Torvalds 已提交
1962

1963 1964 1965 1966
	.. note::

	   It is recommended to have the same setting on all
	   interfaces; mixed router/host scenarios are rather uncommon.
L
Linus Torvalds 已提交
1967

1968 1969
	Possible values are:

1970 1971 1972 1973
		- 0 Forwarding disabled
		- 1 Forwarding enabled

	**FALSE (0)**:
L
Linus Torvalds 已提交
1974 1975 1976 1977

	By default, Host behaviour is assumed.  This means:

	1. IsRouter flag is not set in Neighbour Advertisements.
1978 1979
	2. If accept_ra is TRUE (default), transmit Router
	   Solicitations.
1980
	3. If accept_ra is TRUE (default), accept Router
L
Linus Torvalds 已提交
1981 1982 1983
	   Advertisements (and do autoconfiguration).
	4. If accept_redirects is TRUE (default), accept Redirects.

1984
	**TRUE (1)**:
L
Linus Torvalds 已提交
1985

1986
	If local forwarding is enabled, Router behaviour is assumed.
L
Linus Torvalds 已提交
1987 1988 1989
	This means exactly the reverse from the above:

	1. IsRouter flag is set in Neighbour Advertisements.
1990
	2. Router Solicitations are not sent unless accept_ra is 2.
1991
	3. Router Advertisements are ignored unless accept_ra is 2.
L
Linus Torvalds 已提交
1992 1993
	4. Redirects are ignored.

1994
	Default: 0 (disabled) if global forwarding is disabled (default),
1995
	otherwise 1 (enabled).
L
Linus Torvalds 已提交
1996 1997 1998

hop_limit - INTEGER
	Default Hop Limit to set.
1999

L
Linus Torvalds 已提交
2000 2001 2002 2003
	Default: 64

mtu - INTEGER
	Default Maximum Transfer Unit
2004

L
Linus Torvalds 已提交
2005 2006
	Default: 1280 (IPv6 required minimum)

T
Tom Herbert 已提交
2007 2008 2009
ip_nonlocal_bind - BOOLEAN
	If set, allows processes to bind() to non-local IPv6 addresses,
	which can be quite useful - but may break some applications.
2010

T
Tom Herbert 已提交
2011 2012
	Default: 0

2013 2014 2015 2016 2017 2018
router_probe_interval - INTEGER
	Minimum interval (in seconds) between Router Probing described
	in RFC4191.

	Default: 60

L
Linus Torvalds 已提交
2019 2020 2021
router_solicitation_delay - INTEGER
	Number of seconds to wait after interface is brought up
	before sending Router Solicitations.
2022

L
Linus Torvalds 已提交
2023 2024 2025 2026
	Default: 1

router_solicitation_interval - INTEGER
	Number of seconds to wait between Router Solicitations.
2027

L
Linus Torvalds 已提交
2028 2029 2030
	Default: 4

router_solicitations - INTEGER
2031
	Number of Router Solicitations to send until assuming no
L
Linus Torvalds 已提交
2032
	routers are present.
2033

L
Linus Torvalds 已提交
2034 2035
	Default: 3

2036 2037 2038 2039 2040 2041 2042
use_oif_addrs_only - BOOLEAN
	When enabled, the candidate source addresses for destinations
	routed via this interface are restricted to the set of addresses
	configured on this interface (vis. RFC 6724, section 4).

	Default: false

L
Linus Torvalds 已提交
2043 2044
use_tempaddr - INTEGER
	Preference for Privacy Extensions (RFC3041).
2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055

	  * <= 0 : disable Privacy Extensions
	  * == 1 : enable Privacy Extensions, but prefer public
	    addresses over temporary addresses.
	  * >  1 : enable Privacy Extensions and prefer temporary
	    addresses over public addresses.

	Default:

		* 0 (for most devices)
		* -1 (for point-to-point devices and loopback devices)
L
Linus Torvalds 已提交
2056 2057 2058

temp_valid_lft - INTEGER
	valid lifetime (in seconds) for temporary addresses.
2059

L
Linus Torvalds 已提交
2060 2061 2062 2063
	Default: 604800 (7 days)

temp_prefered_lft - INTEGER
	Preferred lifetime (in seconds) for temporary addresses.
2064

L
Linus Torvalds 已提交
2065 2066
	Default: 86400 (1 day)

2067 2068 2069
keep_addr_on_down - INTEGER
	Keep all IPv6 addresses on an interface down event. If set static
	global addresses with no expiration time are not flushed.
2070 2071 2072 2073

	*   >0 : enabled
	*    0 : system default
	*   <0 : disabled
2074 2075 2076

	Default: 0 (addresses are removed)

L
Linus Torvalds 已提交
2077 2078
max_desync_factor - INTEGER
	Maximum value for DESYNC_FACTOR, which is a random value
2079
	that ensures that clients don't synchronize with each
L
Linus Torvalds 已提交
2080 2081
	other and generate new addresses at exactly the same time.
	value is in seconds.
2082

L
Linus Torvalds 已提交
2083
	Default: 600
2084

L
Linus Torvalds 已提交
2085 2086 2087
regen_max_retry - INTEGER
	Number of attempts before give up attempting to generate
	valid temporary addresses.
2088

L
Linus Torvalds 已提交
2089 2090 2091
	Default: 5

max_addresses - INTEGER
2092 2093 2094 2095
	Maximum number of autoconfigured addresses per interface.  Setting
	to zero disables the limitation.  It is not recommended to set this
	value too large (or to zero) because it would be an easy way to
	crash the kernel by allowing too many addresses to be created.
2096

L
Linus Torvalds 已提交
2097 2098
	Default: 16

2099
disable_ipv6 - BOOLEAN
2100 2101 2102
	Disable IPv6 operation.  If accept_dad is set to 2, this value
	will be dynamically set to TRUE if DAD fails for the link-local
	address.
2103

2104 2105
	Default: FALSE (enable IPv6 operation)

2106 2107 2108 2109 2110
	When this value is changed from 1 to 0 (IPv6 is being enabled),
	it will dynamically create a link-local address on the given
	interface and start Duplicate Address Detection, if necessary.

	When this value is changed from 0 to 1 (IPv6 is being disabled),
2111 2112 2113
	it will dynamically delete all addresses and routes on the given
	interface. From now on it will not possible to add addresses/routes
	to the selected interface.
2114

2115 2116
accept_dad - INTEGER
	Whether to accept DAD (Duplicate Address Detection).
2117 2118 2119 2120 2121 2122 2123

	 == ==============================================================
	  0  Disable DAD
	  1  Enable DAD (default)
	  2  Enable DAD, and disable IPv6 operation if MAC-based duplicate
	     link-local address has been found.
	 == ==============================================================
2124

2125 2126 2127
	DAD operation and mode on a given interface will be selected according
	to the maximum value of conf/{all,interface}/accept_dad.

2128 2129 2130
force_tllao - BOOLEAN
	Enable sending the target link-layer address option even when
	responding to a unicast neighbor solicitation.
2131

2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146
	Default: FALSE

	Quoting from RFC 2461, section 4.4, Target link-layer address:

	"The option MUST be included for multicast solicitations in order to
	avoid infinite Neighbor Solicitation "recursion" when the peer node
	does not have a cache entry to return a Neighbor Advertisements
	message.  When responding to unicast solicitations, the option can be
	omitted since the sender of the solicitation has the correct link-
	layer address; otherwise it would not have be able to send the unicast
	solicitation in the first place. However, including the link-layer
	address in this case adds little overhead and eliminates a potential
	race condition where the sender deletes the cached link-layer address
	prior to receiving a response to a previous solicitation."

2147 2148
ndisc_notify - BOOLEAN
	Define mode for notification of address and device changes.
2149 2150 2151 2152

	* 0 - (default): do nothing
	* 1 - Generate unsolicited neighbour advertisements when device is brought
	  up or hardware address changes.
2153

2154 2155 2156 2157 2158 2159 2160
ndisc_tclass - INTEGER
	The IPv6 Traffic Class to use by default when sending IPv6 Neighbor
	Discovery (Router Solicitation, Router Advertisement, Neighbor
	Solicitation, Neighbor Advertisement, Redirect) messages.
	These 8 bits can be interpreted as 6 high order bits holding the DSCP
	value and 2 low order bits representing ECN (which you probably want
	to leave cleared).
2161 2162

	* 0 - (default)
2163

2164 2165 2166
mldv1_unsolicited_report_interval - INTEGER
	The interval in milliseconds in which the next unsolicited
	MLDv1 report retransmit will take place.
2167

2168 2169 2170 2171 2172
	Default: 10000 (10 seconds)

mldv2_unsolicited_report_interval - INTEGER
	The interval in milliseconds in which the next unsolicited
	MLDv2 report retransmit will take place.
2173

2174 2175
	Default: 1000 (1 second)

2176
force_mld_version - INTEGER
2177 2178 2179
	* 0 - (default) No enforcement of a MLD version, MLDv1 fallback allowed
	* 1 - Enforce to use MLD version 1
	* 2 - Enforce to use MLD version 2
2180

2181 2182 2183
suppress_frag_ndisc - INTEGER
	Control RFC 6980 (Security Implications of IPv6 Fragmentation
	with IPv6 Neighbor Discovery) behavior:
2184 2185 2186

	* 1 - (default) discard fragmented neighbor discovery packets
	* 0 - allow fragmented neighbor discovery packets
2187

2188 2189
optimistic_dad - BOOLEAN
	Whether to perform Optimistic Duplicate Address Detection (RFC 4429).
2190 2191 2192

	* 0: disabled (default)
	* 1: enabled
2193 2194 2195 2196

	Optimistic Duplicate Address Detection for the interface will be enabled
	if at least one of conf/{all,interface}/optimistic_dad is set to 1,
	it will be disabled otherwise.
2197 2198 2199 2200 2201 2202

use_optimistic - BOOLEAN
	If enabled, do not classify optimistic addresses as deprecated during
	source address selection.  Preferred addresses will still be chosen
	before optimistic addresses, subject to other ranking in the source
	address selection algorithm.
2203 2204 2205

	* 0: disabled (default)
	* 1: enabled
2206 2207 2208

	This will be enabled if at least one of
	conf/{all,interface}/use_optimistic is set to 1, disabled otherwise.
2209

2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223
stable_secret - IPv6 address
	This IPv6 address will be used as a secret to generate IPv6
	addresses for link-local addresses and autoconfigured
	ones. All addresses generated after setting this secret will
	be stable privacy ones by default. This can be changed via the
	addrgenmode ip-link. conf/default/stable_secret is used as the
	secret for the namespace, the interface specific ones can
	overwrite that. Writes to conf/all/stable_secret are refused.

	It is recommended to generate this secret during installation
	of a system and keep it stable after that.

	By default the stable secret is unset.

2224 2225 2226
addr_gen_mode - INTEGER
	Defines how link-local and autoconf addresses are generated.

2227 2228 2229 2230 2231
	=  =================================================================
	0  generate address based on EUI64 (default)
	1  do no generate a link-local address, use EUI64 for addresses
	   generated from autoconf
	2  generate stable privacy addresses, using the secret from
2232
	   stable_secret (RFC7217)
2233 2234
	3  generate stable privacy addresses, using a random secret if unset
	=  =================================================================
2235

2236 2237 2238 2239 2240 2241
drop_unicast_in_l2_multicast - BOOLEAN
	Drop any unicast IPv6 packets that are received in link-layer
	multicast (or broadcast) frames.

	By default this is turned off.

2242 2243 2244 2245 2246 2247 2248
drop_unsolicited_na - BOOLEAN
	Drop all unsolicited neighbor advertisements, for example if there's
	a known good NA proxy on the network and such frames need not be used
	(or in the case of 802.11, must not be used to prevent attacks.)

	By default this is turned off.

2249 2250 2251 2252 2253 2254 2255
enhanced_dad - BOOLEAN
	Include a nonce option in the IPv6 neighbor solicitation messages used for
	duplicate address detection per RFC7527. A received DAD NS will only signal
	a duplicate address if the nonce is different. This avoids any false
	detection of duplicates due to loopback of the NS messages that we send.
	The nonce option will be sent on an interface unless both of
	conf/{all,interface}/enhanced_dad are set to FALSE.
2256

2257 2258
	Default: TRUE

2259 2260 2261
``icmp/*``:
===========

L
Linus Torvalds 已提交
2262
ratelimit - INTEGER
2263
	Limit the maximal rates for sending ICMPv6 messages.
2264

2265 2266
	0 to disable any limiting,
	otherwise the minimal space between responses in milliseconds.
2267

2268
	Default: 1000
L
Linus Torvalds 已提交
2269

2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284
ratemask - list of comma separated ranges
	For ICMPv6 message types matching the ranges in the ratemask, limit
	the sending of the message according to ratelimit parameter.

	The format used for both input and output is a comma separated
	list of ranges (e.g. "0-127,129" for ICMPv6 message type 0 to 127 and
	129). Writing to the file will clear all previous ranges of ICMPv6
	message types and update the current list with the input.

	Refer to: https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml
	for numerical values of ICMPv6 message types, e.g. echo request is 128
	and echo reply is 129.

	Default: 0-1,3-127 (rate limit ICMPv6 errors except Packet Too Big)

2285 2286 2287
echo_ignore_all - BOOLEAN
	If set non-zero, then the kernel will ignore all ICMP ECHO
	requests sent to it over the IPv6 protocol.
2288

2289 2290
	Default: 0

2291 2292 2293
echo_ignore_multicast - BOOLEAN
	If set non-zero, then the kernel will ignore all ICMP ECHO
	requests sent to it over the IPv6 protocol via multicast.
2294

2295 2296
	Default: 0

2297 2298 2299
echo_ignore_anycast - BOOLEAN
	If set non-zero, then the kernel will ignore all ICMP ECHO
	requests sent to it over the IPv6 protocol destined to anycast address.
2300

2301 2302
	Default: 0

2303
xfrm6_gc_thresh - INTEGER
2304
	(Obsolete since linux-4.14)
2305 2306
	The threshold at which we will start garbage collecting for IPv6
	destination cache entries.  At twice this value the system will
2307
	refuse new allocations.
2308

L
Linus Torvalds 已提交
2309 2310 2311 2312 2313 2314 2315

IPv6 Update by:
Pekka Savola <pekkas@netcore.fi>
YOSHIFUJI Hideaki / USAGI Project <yoshfuji@linux-ipv6.org>


/proc/sys/net/bridge/* Variables:
2316
=================================
L
Linus Torvalds 已提交
2317 2318

bridge-nf-call-arptables - BOOLEAN
2319 2320 2321
	- 1 : pass bridged ARP traffic to arptables' FORWARD chain.
	- 0 : disable this.

L
Linus Torvalds 已提交
2322 2323 2324
	Default: 1

bridge-nf-call-iptables - BOOLEAN
2325 2326 2327
	- 1 : pass bridged IPv4 traffic to iptables' chains.
	- 0 : disable this.

L
Linus Torvalds 已提交
2328 2329 2330
	Default: 1

bridge-nf-call-ip6tables - BOOLEAN
2331 2332 2333
	- 1 : pass bridged IPv6 traffic to ip6tables' chains.
	- 0 : disable this.

L
Linus Torvalds 已提交
2334 2335 2336
	Default: 1

bridge-nf-filter-vlan-tagged - BOOLEAN
2337 2338 2339
	- 1 : pass bridged vlan-tagged ARP/IP/IPv6 traffic to {arp,ip,ip6}tables.
	- 0 : disable this.

2340
	Default: 0
2341 2342

bridge-nf-filter-pppoe-tagged - BOOLEAN
2343 2344 2345
	- 1 : pass bridged pppoe-tagged IP/IPv6 traffic to {ip,ip6}tables.
	- 0 : disable this.

2346
	Default: 0
L
Linus Torvalds 已提交
2347

2348
bridge-nf-pass-vlan-input-dev - BOOLEAN
2349 2350 2351 2352 2353 2354 2355 2356 2357
	- 1: if bridge-nf-filter-vlan-tagged is enabled, try to find a vlan
	  interface on the bridge and set the netfilter input device to the
	  vlan. This allows use of e.g. "iptables -i br0.1" and makes the
	  REDIRECT target work with vlan-on-top-of-bridge interfaces.  When no
	  matching vlan interface is found, or this switch is off, the input
	  device is set to the bridge interface.

	- 0: disable bridge netfilter vlan interface lookup.

2358
	Default: 0
L
Linus Torvalds 已提交
2359

2360 2361
``proc/sys/net/sctp/*`` Variables:
==================================
2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374

addip_enable - BOOLEAN
	Enable or disable extension of  Dynamic Address Reconfiguration
	(ADD-IP) functionality specified in RFC5061.  This extension provides
	the ability to dynamically add and remove new addresses for the SCTP
	associations.

	1: Enable extension.

	0: Disable extension.

	Default: 0

2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393
pf_enable - INTEGER
	Enable or disable pf (pf is short for potentially failed) state. A value
	of pf_retrans > path_max_retrans also disables pf state. That is, one of
	both pf_enable and pf_retrans > path_max_retrans can disable pf state.
	Since pf_retrans and path_max_retrans can be changed by userspace
	application, sometimes user expects to disable pf state by the value of
	pf_retrans > path_max_retrans, but occasionally the value of pf_retrans
	or path_max_retrans is changed by the user application, this pf state is
	enabled. As such, it is necessary to add this to dynamically enable
	and disable pf state. See:
	https://datatracker.ietf.org/doc/draft-ietf-tsvwg-sctp-failover for
	details.

	1: Enable pf.

	0: Disable pf.

	Default: 1

2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415
pf_expose - INTEGER
	Unset or enable/disable pf (pf is short for potentially failed) state
	exposure.  Applications can control the exposure of the PF path state
	in the SCTP_PEER_ADDR_CHANGE event and the SCTP_GET_PEER_ADDR_INFO
	sockopt.   When it's unset, no SCTP_PEER_ADDR_CHANGE event with
	SCTP_ADDR_PF state will be sent and a SCTP_PF-state transport info
	can be got via SCTP_GET_PEER_ADDR_INFO sockopt;  When it's enabled,
	a SCTP_PEER_ADDR_CHANGE event will be sent for a transport becoming
	SCTP_PF state and a SCTP_PF-state transport info can be got via
	SCTP_GET_PEER_ADDR_INFO sockopt;  When it's diabled, no
	SCTP_PEER_ADDR_CHANGE event will be sent and it returns -EACCES when
	trying to get a SCTP_PF-state transport info via SCTP_GET_PEER_ADDR_INFO
	sockopt.

	0: Unset pf state exposure, Compatible with old applications.

	1: Disable pf state exposure.

	2: Enable pf state exposure.

	Default: 0

2416 2417 2418 2419 2420 2421 2422 2423 2424 2425
addip_noauth_enable - BOOLEAN
	Dynamic Address Reconfiguration (ADD-IP) requires the use of
	authentication to protect the operations of adding or removing new
	addresses.  This requirement is mandated so that unauthorized hosts
	would not be able to hijack associations.  However, older
	implementations may not have implemented this requirement while
	allowing the ADD-IP extension.  For reasons of interoperability,
	we provide this variable to control the enforcement of the
	authentication requirement.

2426 2427
	== ===============================================================
	1  Allow ADD-IP extension to be used without authentication.  This
2428 2429 2430
	   should only be set in a closed environment for interoperability
	   with older implementations.

2431 2432
	0  Enforce the authentication requirement
	== ===============================================================
2433 2434 2435 2436 2437 2438 2439 2440 2441

	Default: 0

auth_enable - BOOLEAN
	Enable or disable Authenticated Chunks extension.  This extension
	provides the ability to send and receive authenticated chunks and is
	required for secure operation of Dynamic Address Reconfiguration
	(ADD-IP) extension.

2442 2443
	- 1: Enable this extension.
	- 0: Disable this extension.
2444 2445 2446 2447 2448 2449 2450

	Default: 0

prsctp_enable - BOOLEAN
	Enable or disable the Partial Reliability extension (RFC3758) which
	is used to notify peers that a given DATA should no longer be expected.

2451 2452
	- 1: Enable extension
	- 0: Disable
2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483

	Default: 1

max_burst - INTEGER
	The limit of the number of new packets that can be initially sent.  It
	controls how bursty the generated traffic can be.

	Default: 4

association_max_retrans - INTEGER
	Set the maximum number for retransmissions that an association can
	attempt deciding that the remote end is unreachable.  If this value
	is exceeded, the association is terminated.

	Default: 10

max_init_retransmits - INTEGER
	The maximum number of retransmissions of INIT and COOKIE-ECHO chunks
	that an association will attempt before declaring the destination
	unreachable and terminating.

	Default: 8

path_max_retrans - INTEGER
	The maximum number of retransmissions that will be attempted on a given
	path.  Once this threshold is exceeded, the path is considered
	unreachable, and new traffic will use a different path when the
	association is multihomed.

	Default: 5

2484 2485 2486 2487 2488 2489 2490 2491 2492 2493
pf_retrans - INTEGER
	The number of retransmissions that will be attempted on a given path
	before traffic is redirected to an alternate transport (should one
	exist).  Note this is distinct from path_max_retrans, as a path that
	passes the pf_retrans threshold can still be used.  Its only
	deprioritized when a transmission path is selected by the stack.  This
	setting is primarily used to enable fast failover mechanisms without
	having to reduce path_max_retrans to a very low value.  See:
	http://www.ietf.org/id/draft-nishida-tsvwg-sctp-failover-05.txt
	for details.  Note also that a value of pf_retrans > path_max_retrans
2494 2495 2496
	disables this feature. Since both pf_retrans and path_max_retrans can
	be changed by userspace application, a variable pf_enable is used to
	disable pf state.
2497 2498 2499

	Default: 0

2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511
ps_retrans - INTEGER
	Primary.Switchover.Max.Retrans (PSMR), it's a tunable parameter coming
	from section-5 "Primary Path Switchover" in rfc7829.  The primary path
	will be changed to another active path when the path error counter on
	the old primary path exceeds PSMR, so that "the SCTP sender is allowed
	to continue data transmission on a new working path even when the old
	primary destination address becomes active again".   Note this feature
	is disabled by initializing 'ps_retrans' per netns as 0xffff by default,
	and its value can't be less than 'pf_retrans' when changing by sysctl.

	Default: 0xffff

2512 2513 2514 2515 2516 2517
rto_initial - INTEGER
	The initial round trip timeout value in milliseconds that will be used
	in calculating round trip times.  This is the initial time interval
	for retransmissions.

	Default: 3000
L
Linus Torvalds 已提交
2518

2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553
rto_max - INTEGER
	The maximum value (in milliseconds) of the round trip timeout.  This
	is the largest time interval that can elapse between retransmissions.

	Default: 60000

rto_min - INTEGER
	The minimum value (in milliseconds) of the round trip timeout.  This
	is the smallest time interval the can elapse between retransmissions.

	Default: 1000

hb_interval - INTEGER
	The interval (in milliseconds) between HEARTBEAT chunks.  These chunks
	are sent at the specified interval on idle paths to probe the state of
	a given path between 2 associations.

	Default: 30000

sack_timeout - INTEGER
	The amount of time (in milliseconds) that the implementation will wait
	to send a SACK.

	Default: 200

valid_cookie_life - INTEGER
	The default lifetime of the SCTP cookie (in milliseconds).  The cookie
	is used during association establishment.

	Default: 60000

cookie_preserve_enable - BOOLEAN
	Enable or disable the ability to extend the lifetime of the SCTP cookie
	that is used during the establishment phase of SCTP association

2554 2555
	- 1: Enable cookie lifetime extension.
	- 0: Disable
2556 2557 2558

	Default: 1

2559 2560 2561 2562
cookie_hmac_alg - STRING
	Select the hmac algorithm used when generating the cookie value sent by
	a listening sctp socket to a connecting client in the INIT-ACK chunk.
	Valid values are:
2563

2564 2565 2566
	* md5
	* sha1
	* none
2567

2568
	Ability to assign md5 or sha1 as the selected alg is predicated on the
2569
	configuration of those algorithms at build time (CONFIG_CRYPTO_MD5 and
2570 2571 2572 2573 2574
	CONFIG_CRYPTO_SHA1).

	Default: Dependent on configuration.  MD5 if available, else SHA1 if
	available, else none.

2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585
rcvbuf_policy - INTEGER
	Determines if the receive buffer is attributed to the socket or to
	association.   SCTP supports the capability to create multiple
	associations on a single socket.  When using this capability, it is
	possible that a single stalled association that's buffering a lot
	of data may block other associations from delivering their data by
	consuming all of the receive buffer space.  To work around this,
	the rcvbuf_policy could be set to attribute the receiver buffer space
	to each association instead of the socket.  This prevents the described
	blocking.

2586 2587
	- 1: rcvbuf space is per association
	- 0: rcvbuf space is per socket
2588 2589 2590 2591 2592 2593

	Default: 0

sndbuf_policy - INTEGER
	Similar to rcvbuf_policy above, this applies to send buffer space.

2594 2595
	- 1: Send buffer is tracked per association
	- 0: Send buffer is tracked per socket.
2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612

	Default: 0

sctp_mem - vector of 3 INTEGERs: min, pressure, max
	Number of pages allowed for queueing by all SCTP sockets.

	min: Below this number of pages SCTP is not bothered about its
	memory appetite. When amount of memory allocated by SCTP exceeds
	this number, SCTP starts to moderate memory usage.

	pressure: This value was introduced to follow format of tcp_mem.

	max: Number of pages allowed for queueing by all SCTP sockets.

	Default is calculated at boot time from amount of available memory.

sctp_rmem - vector of 3 INTEGERs: min, default, max
2613 2614 2615 2616 2617 2618 2619
	Only the first value ("min") is used, "default" and "max" are
	ignored.

	min: Minimal size of receive buffer used by SCTP socket.
	It is guaranteed to each SCTP socket (but not association) even
	under moderate memory pressure.

2620
	Default: 4K
2621 2622

sctp_wmem  - vector of 3 INTEGERs: min, default, max
2623
	Currently this tunable has no effect.
2624

2625 2626 2627
addr_scope_policy - INTEGER
	Control IPv4 address scoping - draft-stewart-tsvwg-sctp-ipv4-00

2628 2629 2630 2631
	- 0   - Disable IPv4 address scoping
	- 1   - Enable IPv4 address scoping
	- 2   - Follow draft but allow IPv4 private addresses
	- 3   - Follow draft but allow IPv4 link local addresses
2632 2633 2634

	Default: 1

L
Linus Torvalds 已提交
2635

2636 2637 2638
``/proc/sys/net/core/*``
========================

2639
	Please see: Documentation/admin-guide/sysctl/net.rst for descriptions of these entries.
2640

2641

2642 2643 2644
``/proc/sys/net/unix/*``
========================

2645 2646 2647 2648 2649
max_dgram_qlen - INTEGER
	The maximum length of dgram socket receive queue

	Default: 10